From 95f4a3a8a3e87118f250607d1d29cfd47459d1a3 Mon Sep 17 00:00:00 2001 From: "manu.k.m" Date: Fri, 15 Sep 2023 23:53:34 +0530 Subject: [PATCH] parent 0a7ebd95bd60daadb9efa217942dea75337a94cc author manu.k.m 1694802214 +0530 committer manu.k.m 1697119063 +0530 parent 0a7ebd95bd60daadb9efa217942dea75337a94cc author manu.k.m 1694802214 +0530 committer manu.k.m 1697118987 +0530 parent 0a7ebd95bd60daadb9efa217942dea75337a94cc author manu.k.m 1694802214 +0530 committer manu.k.m 1697118762 +0530 parent 0a7ebd95bd60daadb9efa217942dea75337a94cc author manu.k.m 1694802214 +0530 committer manu.k.m 1697118385 +0530 parent 0a7ebd95bd60daadb9efa217942dea75337a94cc author manu.k.m 1694802214 +0530 committer manu.k.m 1697117979 +0530 Billing Snapshot Config APIs introduced in Usage Reports Add example for html Set account id from the token add support for endpoint parameter in cluster_config (#4793) * add support for endpoint parameter in cluster_config * adding unit tests for endpoint_type parameter * remove default value "true" as the would be invalid * update documentation remove bluemix-go replace * update bluemix-go + run go mod tidy fix(share-iops): Share Iops range fix for dp2 update metadata update CHANGELOG Bump up version to 1.58.0-beta0 Update examples minor fixes dependabot: bump github.com/hashicorp/vault from 1.13.5 to 1.13.7 Bumps [github.com/hashicorp/vault](https://github.com/hashicorp/vault) from 1.13.5 to 1.13.7. - [Release notes](https://github.com/hashicorp/vault/releases) - [Changelog](https://github.com/hashicorp/vault/blob/main/CHANGELOG.md) - [Commits](https://github.com/hashicorp/vault/compare/v1.13.5...v1.13.7) --- updated-dependencies: - dependency-name: github.com/hashicorp/vault dependency-type: indirect ... Signed-off-by: dependabot[bot] New CD Toolchains datasource (#4779) * New CD Toolchains datasource * Update secrets baseline * Use latest CD sdk * Fixed acceptance test support for vpc dns resolution binding (#4816) * support for vpc dns resolution binding * Update vpc_v1.go dependabot: bump actions/checkout from 4.0.0 to 4.1.0 Bumps [actions/checkout](https://github.com/actions/checkout) from 4.0.0 to 4.1.0. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v4.0.0...v4.1.0) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] fix(IAM Policy Management): allow sourceServiceName to be optional for authorization policy (#4804) * fix(IAM Policy Management): allow sourceServiceName to be optional for authorization policy Signed-off-by: Shaun Colley * fix(IAM Policy Management): minor update to test case and fmt Signed-off-by: Shaun Colley * fix(IAM Policy Management): allow targetServiceName to be optional for authorization policy Signed-off-by: Shaun Colley * fix(IAM Policy Management): allow targetServiceName to be optional for authorization policy Signed-off-by: Shaun Colley * fix(IAM Policy Management): update based on feedback Signed-off-by: Shaun Colley * fix(IAM Access Management): update schema for feedback Signed-off-by: Shaun Colley * re-ran fmt Signed-off-by: Shaun Colley * Update documentation to say which attributes are minimally required Signed-off-by: Shaun Colley * fix(IAM Policy Management): updating datasource changes Signed-off-by: Shaun Colley * fix(IAM Policy Management): fix data source doc to not include unnecessary info Signed-off-by: Shaun Colley --------- Signed-off-by: Shaun Colley Update bluemix-go (#4822) * update bluemix-go * update doc based on the latest changes Fix document category feat: adding the fields region and instance_id in the service scc (#4823) * adding the utility file for generic use * adding the usage of instanceID to control library, profile, profile attachment, rule * updated all testing * Adding the ability to change the URL from provider field, and updated resource docs * updated the docs with the usage of instance_id * added instance_id to the examples * Using the new version of scc-go-sdk * Formatting the docs and added the warn in acctest Signed-off-by: Timothy-Yao * modifying the PreCheck for Tests * adding the additional line for accPreCheck * Took out os from the testing packages. * Upgrading scc-go-sdk to 5.1.2 and updated functions --------- Signed-off-by: Timothy-Yao Co-authored-by: Timothy-Yao documents update and test case update for ibm_is_vpc fix(VSI-Profile-patch): Remove validation for VSI profile patching Documentation update for COS static webhosting. (#4827) * Updating the COS static webhosting documentation * Documentation update * Removing documentation error * Addressing the review comments update metadata update CHANGELOG Bump up version to 1.58.0 update bluemix-go to get latest changes Metrics router and atracker: Updated platform-services-go-sdk to fetch Madrid endpoint (#4830) * fix(Metrics router) Updated platform-services-go-sdk to fetch Madrid endpoint Signed-off-by: ADYA NAND JHA * fix(atracker) Help Message changes Signed-off-by: ADYA NAND JHA --------- Signed-off-by: ADYA NAND JHA Fix for issue 4838 (#4840) resilence 409 and update docs to include force_delete flag and force_delete=true in examples update CHANGELOG Bump up version to 1.58.1 fmt fixes Region update Get secret by name (#4825) * Get secret by name * Applying review comments * Added test cases for get secret by name * Added test cases for get secret by name * Updated documentation --------- Co-authored-by: Avi Ribchinsky dependabot: bump golang.org/x/net from 0.12.0 to 0.17.0 Bumps [golang.org/x/net](https://github.com/golang/net) from 0.12.0 to 0.17.0. - [Commits](https://github.com/golang/net/compare/v0.12.0...v0.17.0) --- updated-dependencies: - dependency-name: golang.org/x/net dependency-type: indirect ... Signed-off-by: dependabot[bot] add support for endpoint parameter in cluster_config (#4793) * add support for endpoint parameter in cluster_config * adding unit tests for endpoint_type parameter * remove default value "true" as the would be invalid * update documentation remove bluemix-go replace * update bluemix-go + run go mod tidy fix(share-iops): Share Iops range fix for dp2 New CD Toolchains datasource (#4779) * New CD Toolchains datasource * Update secrets baseline * Use latest CD sdk * Fixed acceptance test support for vpc dns resolution binding (#4816) * support for vpc dns resolution binding * Update vpc_v1.go dependabot: bump actions/checkout from 4.0.0 to 4.1.0 Bumps [actions/checkout](https://github.com/actions/checkout) from 4.0.0 to 4.1.0. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v4.0.0...v4.1.0) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] fix(IAM Policy Management): allow sourceServiceName to be optional for authorization policy (#4804) * fix(IAM Policy Management): allow sourceServiceName to be optional for authorization policy Signed-off-by: Shaun Colley * fix(IAM Policy Management): minor update to test case and fmt Signed-off-by: Shaun Colley * fix(IAM Policy Management): allow targetServiceName to be optional for authorization policy Signed-off-by: Shaun Colley * fix(IAM Policy Management): allow targetServiceName to be optional for authorization policy Signed-off-by: Shaun Colley * fix(IAM Policy Management): update based on feedback Signed-off-by: Shaun Colley * fix(IAM Access Management): update schema for feedback Signed-off-by: Shaun Colley * re-ran fmt Signed-off-by: Shaun Colley * Update documentation to say which attributes are minimally required Signed-off-by: Shaun Colley * fix(IAM Policy Management): updating datasource changes Signed-off-by: Shaun Colley * fix(IAM Policy Management): fix data source doc to not include unnecessary info Signed-off-by: Shaun Colley --------- Signed-off-by: Shaun Colley Update bluemix-go (#4822) * update bluemix-go * update doc based on the latest changes Fix document category feat: adding the fields region and instance_id in the service scc (#4823) * adding the utility file for generic use * adding the usage of instanceID to control library, profile, profile attachment, rule * updated all testing * Adding the ability to change the URL from provider field, and updated resource docs * updated the docs with the usage of instance_id * added instance_id to the examples * Using the new version of scc-go-sdk * Formatting the docs and added the warn in acctest Signed-off-by: Timothy-Yao * modifying the PreCheck for Tests * adding the additional line for accPreCheck * Took out os from the testing packages. * Upgrading scc-go-sdk to 5.1.2 and updated functions --------- Signed-off-by: Timothy-Yao Co-authored-by: Timothy-Yao documents update and test case update for ibm_is_vpc fix(VSI-Profile-patch): Remove validation for VSI profile patching Documentation update for COS static webhosting. (#4827) * Updating the COS static webhosting documentation * Documentation update * Removing documentation error * Addressing the review comments update metadata Metrics router and atracker: Updated platform-services-go-sdk to fetch Madrid endpoint (#4830) * fix(Metrics router) Updated platform-services-go-sdk to fetch Madrid endpoint Signed-off-by: ADYA NAND JHA * fix(atracker) Help Message changes Signed-off-by: ADYA NAND JHA --------- Signed-off-by: ADYA NAND JHA Fix for issue 4838 (#4840) resilence 409 and update docs to include force_delete flag and force_delete=true in examples update CHANGELOG Bump up version to 1.58.1 Get secret by name (#4825) * Get secret by name * Applying review comments * Added test cases for get secret by name * Added test cases for get secret by name * Updated documentation --------- Co-authored-by: Avi Ribchinsky dependabot: bump golang.org/x/net from 0.12.0 to 0.17.0 Bumps [golang.org/x/net](https://github.com/golang/net) from 0.12.0 to 0.17.0. - [Commits](https://github.com/golang/net/compare/v0.12.0...v0.17.0) --- updated-dependencies: - dependency-name: golang.org/x/net dependency-type: indirect ... Signed-off-by: dependabot[bot] Fix handling of bundle_certs in Secrets Manager public cert add support for endpoint parameter in cluster_config (#4793) * add support for endpoint parameter in cluster_config * adding unit tests for endpoint_type parameter * remove default value "true" as the would be invalid * update documentation remove bluemix-go replace * update bluemix-go + run go mod tidy fix(share-iops): Share Iops range fix for dp2 New CD Toolchains datasource (#4779) * New CD Toolchains datasource * Update secrets baseline * Use latest CD sdk * Fixed acceptance test dependabot: bump actions/checkout from 4.0.0 to 4.1.0 Bumps [actions/checkout](https://github.com/actions/checkout) from 4.0.0 to 4.1.0. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v4.0.0...v4.1.0) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] fix(IAM Policy Management): allow sourceServiceName to be optional for authorization policy (#4804) * fix(IAM Policy Management): allow sourceServiceName to be optional for authorization policy Signed-off-by: Shaun Colley * fix(IAM Policy Management): minor update to test case and fmt Signed-off-by: Shaun Colley * fix(IAM Policy Management): allow targetServiceName to be optional for authorization policy Signed-off-by: Shaun Colley * fix(IAM Policy Management): allow targetServiceName to be optional for authorization policy Signed-off-by: Shaun Colley * fix(IAM Policy Management): update based on feedback Signed-off-by: Shaun Colley * fix(IAM Access Management): update schema for feedback Signed-off-by: Shaun Colley * re-ran fmt Signed-off-by: Shaun Colley * Update documentation to say which attributes are minimally required Signed-off-by: Shaun Colley * fix(IAM Policy Management): updating datasource changes Signed-off-by: Shaun Colley * fix(IAM Policy Management): fix data source doc to not include unnecessary info Signed-off-by: Shaun Colley --------- Signed-off-by: Shaun Colley Update bluemix-go (#4822) * update bluemix-go * update doc based on the latest changes Fix document category documents update and test case update for ibm_is_vpc fix(VSI-Profile-patch): Remove validation for VSI profile patching Documentation update for COS static webhosting. (#4827) * Updating the COS static webhosting documentation * Documentation update * Removing documentation error * Addressing the review comments update metadata Metrics router and atracker: Updated platform-services-go-sdk to fetch Madrid endpoint (#4830) * fix(Metrics router) Updated platform-services-go-sdk to fetch Madrid endpoint Signed-off-by: ADYA NAND JHA * fix(atracker) Help Message changes Signed-off-by: ADYA NAND JHA --------- Signed-off-by: ADYA NAND JHA Fix for issue 4838 (#4840) resilence 409 and update docs to include force_delete flag and force_delete=true in examples update CHANGELOG Bump up version to 1.58.1 Get secret by name (#4825) * Get secret by name * Applying review comments * Added test cases for get secret by name * Added test cases for get secret by name * Updated documentation --------- Co-authored-by: Avi Ribchinsky dependabot: bump golang.org/x/net from 0.12.0 to 0.17.0 Bumps [golang.org/x/net](https://github.com/golang/net) from 0.12.0 to 0.17.0. - [Commits](https://github.com/golang/net/compare/v0.12.0...v0.17.0) --- updated-dependencies: - dependency-name: golang.org/x/net dependency-type: indirect ... Signed-off-by: dependabot[bot] Fix handling of bundle_certs in Secrets Manager public cert --- .github/workflows/go.yml | 2 +- .github/workflows/issues.yml | 2 +- .github/workflows/release.yml | 2 +- .secrets.baseline | 522 +- CHANGELOG.md | 129 + .../IBM/vpc-go-sdk/.bumpversion.cfg | 13 + .../github.com/IBM/vpc-go-sdk/.gitattributes | 1 + common/github.com/IBM/vpc-go-sdk/.gitignore | 18 + common/github.com/IBM/vpc-go-sdk/.releaserc | 21 + common/github.com/IBM/vpc-go-sdk/.travis.yml | 39 + common/github.com/IBM/vpc-go-sdk/CHANGELOG.md | 96 + .../IBM/vpc-go-sdk/CODE_OF_CONDUCT.md | 76 + .../github.com/IBM/vpc-go-sdk/CONTRIBUTING.md | 14 + common/github.com/IBM/vpc-go-sdk/LICENSE | 201 + common/github.com/IBM/vpc-go-sdk/Makefile | 23 + .../IBM/vpc-go-sdk/common/headers.go | 67 + .../IBM/vpc-go-sdk/common/headers_test.go | 30 + .../IBM/vpc-go-sdk/common/version.go | 4 + common/github.com/IBM/vpc-go-sdk/go.mod | 18 + common/github.com/IBM/vpc-go-sdk/go.sum | 143 + .../github.com/IBM/vpc-go-sdk/vpcv1/vpc_v1.go | 102829 +++++++++++++++ examples/ibm-atracker/README.md | 18 +- examples/ibm-atracker/main.tf | 6 +- examples/ibm-atracker/variables.tf | 7 +- examples/ibm-atracker/versions.tf | 8 +- examples/ibm-cos-bucket/main.tf | 9 +- examples/ibm-is-ng/main.tf | 105 + examples/ibm-metrics-router/README.md | 2 +- examples/ibm-metrics-router/variables.tf | 2 +- examples/ibm-scc/control_library/main.tf | 1 + examples/ibm-scc/integration/main.tf | 1 + examples/ibm-scc/profile/main.tf | 2 + examples/ibm-scc/report/main.tf | 8 + examples/ibm-scc/rule/main.tf | 1 + examples/ibm-usage-reports/README.md | 93 + examples/ibm-usage-reports/main.tf | 20 + examples/ibm-usage-reports/outputs.tf | 6 + examples/ibm-usage-reports/variables.tf | 58 + examples/ibm-usage-reports/versions.tf | 9 + go.mod | 61 +- go.sum | 209 +- ibm/acctest/acctest.go | 581 +- ibm/conns/config.go | 56 +- ibm/flex/structures.go | 141 - ibm/provider/provider.go | 18 +- .../data_source_ibm_cd_toolchains.go | 170 + .../data_source_ibm_cd_toolchains_test.go | 55 + ibm/service/cos/data_source_ibm_cos_bucket.go | 15 +- .../resource_ibm_iam_authorization_policy.go | 42 +- ...ource_ibm_iam_authorization_policy_test.go | 170 +- ibm/service/kms/resource_ibm_kms_key_rings.go | 4 +- ...ata_source_ibm_container_cluster_config.go | 16 +- ...ource_ibm_container_cluster_config_test.go | 5 + .../data_source_ibm_metrics_router_targets.go | 2 +- .../resource_ibm_metrics_router_target.go | 2 +- .../data_source_ibm_scc_control_library.go | 95 +- ...ata_source_ibm_scc_control_library_test.go | 25 +- .../data_source_ibm_scc_instance_settings.go | 5 +- ...a_source_ibm_scc_instance_settings_test.go | 11 +- .../scc/data_source_ibm_scc_latest_reports.go | 5 +- ...data_source_ibm_scc_latest_reports_test.go | 9 +- .../scc/data_source_ibm_scc_profile.go | 9 +- .../data_source_ibm_scc_profile_attachment.go | 5 +- ..._source_ibm_scc_profile_attachment_test.go | 36 +- .../scc/data_source_ibm_scc_profile_test.go | 32 +- ...e_ibm_scc_provider_type_collection_test.go | 2 +- ...a_source_ibm_scc_provider_type_instance.go | 5 +- ...rce_ibm_scc_provider_type_instance_test.go | 24 +- .../data_source_ibm_scc_provider_type_test.go | 2 +- ibm/service/scc/data_source_ibm_scc_report.go | 5 +- .../data_source_ibm_scc_report_controls.go | 5 +- ...ata_source_ibm_scc_report_controls_test.go | 12 +- .../data_source_ibm_scc_report_evaluations.go | 5 +- ..._source_ibm_scc_report_evaluations_test.go | 11 +- .../data_source_ibm_scc_report_resources.go | 5 +- ...ta_source_ibm_scc_report_resources_test.go | 11 +- .../scc/data_source_ibm_scc_report_rule.go | 5 +- .../data_source_ibm_scc_report_rule_test.go | 14 +- .../scc/data_source_ibm_scc_report_summary.go | 5 +- ...data_source_ibm_scc_report_summary_test.go | 11 +- .../scc/data_source_ibm_scc_report_tags.go | 5 +- .../data_source_ibm_scc_report_tags_test.go | 13 +- .../scc/data_source_ibm_scc_report_test.go | 11 +- ...a_source_ibm_scc_report_violation_drift.go | 5 +- ...rce_ibm_scc_report_violation_drift_test.go | 11 +- ibm/service/scc/data_source_ibm_scc_rule.go | 5 +- .../scc/data_source_ibm_scc_rule_test.go | 24 +- ibm/service/scc/ibm_scc_utilities.go | 43 + .../scc/resource_ibm_scc_control_library.go | 44 +- .../resource_ibm_scc_control_library_test.go | 31 +- ibm/service/scc/resource_ibm_scc_profile.go | 40 +- .../resource_ibm_scc_profile_attachment.go | 48 +- ...esource_ibm_scc_profile_attachment_test.go | 45 +- .../scc/resource_ibm_scc_profile_test.go | 37 +- ...resource_ibm_scc_provider_type_instance.go | 32 +- ...rce_ibm_scc_provider_type_instance_test.go | 35 +- ibm/service/scc/resource_ibm_scc_rule.go | 42 +- ibm/service/scc/resource_ibm_scc_rule_test.go | 33 +- .../data_source_ibm_sm_arbitrary_secret.go | 51 +- ...ata_source_ibm_sm_arbitrary_secret_test.go | 11 +- ...ta_source_ibm_sm_iam_credentials_secret.go | 49 +- ...data_source_ibm_sm_imported_certificate.go | 50 +- ...source_ibm_sm_imported_certificate_test.go | 11 +- .../data_source_ibm_sm_kv_secret.go | 51 +- .../data_source_ibm_sm_kv_secret_test.go | 11 +- .../data_source_ibm_sm_private_certificate.go | 50 +- ..._source_ibm_sm_private_certificate_test.go | 11 +- .../data_source_ibm_sm_public_certificate.go | 51 +- ...a_source_ibm_sm_public_certificate_test.go | 11 +- ..._source_ibm_sm_username_password_secret.go | 51 +- ...ce_ibm_sm_username_password_secret_test.go | 11 +- .../resource_ibm_sm_public_certificate.go | 5 +- ibm/service/secretsmanager/utils.go | 65 + ibm/service/usagereports/README.md | 11 + .../data_source_ibm_billing_snapshot_list.go | 413 + ...a_source_ibm_billing_snapshot_list_test.go | 45 + .../resource_ibm_billing_report_snapshot.go | 475 + ...source_ibm_billing_report_snapshot_test.go | 116 + .../data_source_ibm_is_instance_template.go | 7 +- .../vpc/data_source_ibm_is_lb_profile.go | 4 +- ..._source_ibm_is_virtual_endpoint_gateway.go | 6 + ...ce_ibm_is_virtual_endpoint_gateway_test.go | 30 + ...source_ibm_is_virtual_endpoint_gateways.go | 6 + ...e_ibm_is_virtual_endpoint_gateways_test.go | 30 + ibm/service/vpc/data_source_ibm_is_vpc.go | 411 +- ...ource_ibm_is_vpc_dns_resolution_binding.go | 376 + ..._ibm_is_vpc_dns_resolution_binding_test.go | 50 + ...urce_ibm_is_vpc_dns_resolution_bindings.go | 324 + ...ibm_is_vpc_dns_resolution_bindings_test.go | 49 + .../vpc/data_source_ibm_is_vpc_test.go | 40 + ibm/service/vpc/data_source_ibm_is_vpcs.go | 216 + ibm/service/vpc/resource_ibm_is_instance.go | 4 - .../vpc/resource_ibm_is_instance_template.go | 4 +- ibm/service/vpc/resource_ibm_is_share.go | 6 +- ...esource_ibm_is_virtual_endpoint_gateway.go | 86 +- ...ce_ibm_is_virtual_endpoint_gateway_test.go | 51 + ibm/service/vpc/resource_ibm_is_vpc.go | 703 +- ...ource_ibm_is_vpc_dns_resolution_binding.go | 432 + ..._ibm_is_vpc_dns_resolution_binding_test.go | 65 + ibm/service/vpc/resource_ibm_is_vpc_test.go | 586 + metadata/provider_metadata.json | 88987 +++++++------ version/version.go | 2 +- website/allowed-subcategories.txt | 1 + website/docs/d/atracker_routes.html.markdown | 2 +- website/docs/d/atracker_targets.html.markdown | 2 +- .../d/billing_snapshot_list.html.markdown | 79 + website/docs/d/cd_toolchains.html.markdown | 55 + .../d/container_cluster_config.html.markdown | 15 +- .../iam_authorization_policies.html.markdown | 18 +- .../is_virtual_endpoint_gateway.html.markdown | 3 + ...is_virtual_endpoint_gateways.html.markdown | 3 + website/docs/d/is_vpc.html.markdown | 19 + ...s_vpc_dns_resolution_binding.html.markdown | 85 + ..._vpc_dns_resolution_bindings.html.markdown | 87 + website/docs/d/is_vpcs.html.markdown | 20 + .../d/metrics_router_targets.html.markdown | 2 +- .../docs/d/scc_control_library.html.markdown | 6 +- .../d/scc_instance_settings.html.markdown | 3 + .../docs/d/scc_latest_reports.html.markdown | 6 +- website/docs/d/scc_profile.html.markdown | 6 +- .../d/scc_profile_attachment.html.markdown | 8 +- .../docs/d/scc_provider_type.html.markdown | 4 +- ...scc_provider_type_collection.html.markdown | 2 + .../scc_provider_type_instance.html.markdown | 10 +- website/docs/d/scc_report.html.markdown | 6 +- .../docs/d/scc_report_controls.html.markdown | 8 +- .../d/scc_report_evaluations.html.markdown | 8 +- .../docs/d/scc_report_resources.html.markdown | 8 +- website/docs/d/scc_report_rule.html.markdown | 8 +- .../docs/d/scc_report_summary.html.markdown | 4 + website/docs/d/scc_report_tags.html.markdown | 6 +- .../scc_report_violation_drift.html.markdown | 6 +- website/docs/d/scc_rule.html.markdown | 6 +- .../docs/d/sm_arbitrary_secret.html.markdown | 18 +- .../d/sm_iam_credentials_secret.html.markdown | 21 +- .../d/sm_imported_certificate.html.markdown | 19 +- website/docs/d/sm_kv_secret.html.markdown | 19 +- .../d/sm_private_certificate.html.markdown | 87 +- .../d/sm_public_certificate.html.markdown | 20 +- .../sm_username_password_secret.html.markdown | 20 +- .../r/billing_report_snapshot.html.markdown | 113 + ...bucket_website_configuration.html.markdown | 9 +- .../r/iam_authorization_policy.html.markdown | 112 +- website/docs/r/is_instance.html.markdown | 4 +- website/docs/r/is_share.html.markdown | 2 +- .../is_virtual_endpoint_gateway.html.markdown | 3 + website/docs/r/is_vpc.html.markdown | 106 + ...s_vpc_dns_resolution_binding.html.markdown | 126 + website/docs/r/kms_key_rings.html.markdown | 4 +- .../docs/r/scc_control_library.html.markdown | 18 +- website/docs/r/scc_profile.html.markdown | 16 +- .../r/scc_profile_attachment.html.markdown | 45 +- .../scc_provider_type_instance.html.markdown | 10 +- website/docs/r/scc_rule.html.markdown | 14 +- 194 files changed, 159086 insertions(+), 43231 deletions(-) create mode 100644 common/github.com/IBM/vpc-go-sdk/.bumpversion.cfg create mode 100644 common/github.com/IBM/vpc-go-sdk/.gitattributes create mode 100644 common/github.com/IBM/vpc-go-sdk/.gitignore create mode 100644 common/github.com/IBM/vpc-go-sdk/.releaserc create mode 100644 common/github.com/IBM/vpc-go-sdk/.travis.yml create mode 100644 common/github.com/IBM/vpc-go-sdk/CHANGELOG.md create mode 100644 common/github.com/IBM/vpc-go-sdk/CODE_OF_CONDUCT.md create mode 100644 common/github.com/IBM/vpc-go-sdk/CONTRIBUTING.md create mode 100644 common/github.com/IBM/vpc-go-sdk/LICENSE create mode 100644 common/github.com/IBM/vpc-go-sdk/Makefile create mode 100644 common/github.com/IBM/vpc-go-sdk/common/headers.go create mode 100644 common/github.com/IBM/vpc-go-sdk/common/headers_test.go create mode 100644 common/github.com/IBM/vpc-go-sdk/common/version.go create mode 100644 common/github.com/IBM/vpc-go-sdk/go.mod create mode 100644 common/github.com/IBM/vpc-go-sdk/go.sum create mode 100644 common/github.com/IBM/vpc-go-sdk/vpcv1/vpc_v1.go create mode 100644 examples/ibm-usage-reports/README.md create mode 100644 examples/ibm-usage-reports/main.tf create mode 100644 examples/ibm-usage-reports/outputs.tf create mode 100644 examples/ibm-usage-reports/variables.tf create mode 100644 examples/ibm-usage-reports/versions.tf create mode 100644 ibm/service/cdtoolchain/data_source_ibm_cd_toolchains.go create mode 100644 ibm/service/cdtoolchain/data_source_ibm_cd_toolchains_test.go create mode 100644 ibm/service/scc/ibm_scc_utilities.go create mode 100644 ibm/service/usagereports/README.md create mode 100644 ibm/service/usagereports/data_source_ibm_billing_snapshot_list.go create mode 100644 ibm/service/usagereports/data_source_ibm_billing_snapshot_list_test.go create mode 100644 ibm/service/usagereports/resource_ibm_billing_report_snapshot.go create mode 100644 ibm/service/usagereports/resource_ibm_billing_report_snapshot_test.go create mode 100644 ibm/service/vpc/data_source_ibm_is_vpc_dns_resolution_binding.go create mode 100644 ibm/service/vpc/data_source_ibm_is_vpc_dns_resolution_binding_test.go create mode 100644 ibm/service/vpc/data_source_ibm_is_vpc_dns_resolution_bindings.go create mode 100644 ibm/service/vpc/data_source_ibm_is_vpc_dns_resolution_bindings_test.go create mode 100644 ibm/service/vpc/resource_ibm_is_vpc_dns_resolution_binding.go create mode 100644 ibm/service/vpc/resource_ibm_is_vpc_dns_resolution_binding_test.go create mode 100644 website/docs/d/billing_snapshot_list.html.markdown create mode 100644 website/docs/d/cd_toolchains.html.markdown create mode 100644 website/docs/d/is_vpc_dns_resolution_binding.html.markdown create mode 100644 website/docs/d/is_vpc_dns_resolution_bindings.html.markdown create mode 100644 website/docs/r/billing_report_snapshot.html.markdown create mode 100644 website/docs/r/is_vpc_dns_resolution_binding.html.markdown diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml index c720c50fb1..6d600c9bad 100644 --- a/.github/workflows/go.yml +++ b/.github/workflows/go.yml @@ -20,7 +20,7 @@ jobs: id: go - name: Check out code into the Go module directory - uses: actions/checkout@v4.0.0 + uses: actions/checkout@v4.1.0 - name: Get dependencies run: | diff --git a/.github/workflows/issues.yml b/.github/workflows/issues.yml index 6dcc0a8023..0d6ce9eea1 100644 --- a/.github/workflows/issues.yml +++ b/.github/workflows/issues.yml @@ -6,7 +6,7 @@ jobs: labelIssues: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4.0.0 + - uses: actions/checkout@v4.1.0 - name: Apply Issue Labels uses: github/issue-labeler@v3.2 with: diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 73c3a35868..2acc15555e 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -20,7 +20,7 @@ jobs: steps: - name: Checkout - uses: actions/checkout@v4.0.0 + uses: actions/checkout@v4.1.0 - name: Unshallow run: git fetch --prune --unshallow diff --git a/.secrets.baseline b/.secrets.baseline index 618f58d428..5289119a2f 100644 --- a/.secrets.baseline +++ b/.secrets.baseline @@ -3,11 +3,8 @@ "files": "go.mod|go.sum|.*.map|^.secrets.baseline$", "lines": null }, - "generated_at": "2023-09-14T15:01:09Z", + "generated_at": "2023-09-27T10:48:50Z", "plugins_used": [ - { - "name": "AWSKeyDetector" - }, { "name": "ArtifactoryDetector" }, @@ -21,12 +18,6 @@ { "name": "BasicAuthDetector" }, - { - "name": "BoxDetector" - }, - { - "name": "CloudantDetector" - }, { "ghe_instance": "github.ibm.com", "name": "GheDetector" @@ -51,9 +42,6 @@ "keyword_exclude": null, "name": "KeywordDetector" }, - { - "name": "MailchimpDetector" - }, { "name": "NpmDetector" }, @@ -68,12 +56,6 @@ }, { "name": "SquareOAuthDetector" - }, - { - "name": "StripeDetector" - }, - { - "name": "TwilioKeyDetector" } ], "results": { @@ -742,7 +724,7 @@ "hashed_secret": "731438016c5ab94431f61820f35e3ae5f8ad6004", "is_secret": false, "is_verified": false, - "line_number": 353, + "line_number": 355, "type": "Secret Keyword", "verified_result": null }, @@ -750,7 +732,7 @@ "hashed_secret": "12da2e35d6b50c902c014f1ab9e3032650368df7", "is_secret": false, "is_verified": false, - "line_number": 359, + "line_number": 361, "type": "Secret Keyword", "verified_result": null }, @@ -758,7 +740,7 @@ "hashed_secret": "813274ccae5b6b509379ab56982d862f7b5969b6", "is_secret": false, "is_verified": false, - "line_number": 1065, + "line_number": 1072, "type": "Base64 High Entropy String", "verified_result": null } @@ -828,7 +810,7 @@ "hashed_secret": "da8cae6284528565678de15e03d461e23fe22538", "is_secret": false, "is_verified": false, - "line_number": 1714, + "line_number": 1845, "type": "Secret Keyword", "verified_result": null }, @@ -836,7 +818,7 @@ "hashed_secret": "1a0334cfa65f4be58b9d914b8e96e9d9478bfbac", "is_secret": false, "is_verified": false, - "line_number": 3236, + "line_number": 3242, "type": "Secret Keyword", "verified_result": null } @@ -846,7 +828,7 @@ "hashed_secret": "c8b6f5ef11b9223ac35a5663975a466ebe7ebba9", "is_secret": false, "is_verified": false, - "line_number": 1757, + "line_number": 1766, "type": "Secret Keyword", "verified_result": null }, @@ -854,7 +836,7 @@ "hashed_secret": "8abf4899c01104241510ba87685ad4de76b0c437", "is_secret": false, "is_verified": false, - "line_number": 1763, + "line_number": 1772, "type": "Secret Keyword", "verified_result": null } @@ -1288,7 +1270,7 @@ "hashed_secret": "3046d9f6cfaaeea6eed9bb7a4ab010fe49b0cfd4", "is_secret": false, "is_verified": false, - "line_number": 105, + "line_number": 114, "type": "Secret Keyword", "verified_result": null } @@ -1318,7 +1300,7 @@ "hashed_secret": "3046d9f6cfaaeea6eed9bb7a4ab010fe49b0cfd4", "is_secret": false, "is_verified": false, - "line_number": 49, + "line_number": 58, "type": "Secret Keyword", "verified_result": null }, @@ -1326,7 +1308,7 @@ "hashed_secret": "90a487e543acb2a46de4f28f6012de33bb854568", "is_secret": false, "is_verified": false, - "line_number": 283, + "line_number": 307, "type": "Secret Keyword", "verified_result": null } @@ -1346,7 +1328,7 @@ "hashed_secret": "3046d9f6cfaaeea6eed9bb7a4ab010fe49b0cfd4", "is_secret": false, "is_verified": false, - "line_number": 85, + "line_number": 94, "type": "Secret Keyword", "verified_result": null }, @@ -1354,7 +1336,7 @@ "hashed_secret": "505032eaf8a3acf9b094a326dfb1cd0537c75a0d", "is_secret": false, "is_verified": false, - "line_number": 340, + "line_number": 364, "type": "Secret Keyword", "verified_result": null } @@ -1364,7 +1346,7 @@ "hashed_secret": "3046d9f6cfaaeea6eed9bb7a4ab010fe49b0cfd4", "is_secret": false, "is_verified": false, - "line_number": 54, + "line_number": 63, "type": "Secret Keyword", "verified_result": null } @@ -2002,7 +1984,7 @@ "hashed_secret": "884a58e4c2c5d195d3876787bdc63af6c5af2924", "is_secret": false, "is_verified": false, - "line_number": 508, + "line_number": 633, "type": "Secret Keyword", "verified_result": null } @@ -2022,7 +2004,7 @@ "hashed_secret": "b02fa7fd7ca08b5dc86c2548e40f8a21171ef977", "is_secret": false, "is_verified": false, - "line_number": 492, + "line_number": 509, "type": "Secret Keyword", "verified_result": null } @@ -2885,6 +2867,16 @@ "verified_result": null } ], + "ibm/service/satellite/resource_ibm_satellite_storage_configuration_test.go": [ + { + "hashed_secret": "f32b67c7e26342af42efabc674d441dca0a281c5", + "is_secret": false, + "is_verified": false, + "line_number": 118, + "type": "Secret Keyword", + "verified_result": null + } + ], "ibm/service/scc/data_source_ibm_scc_provider_type_instance_test.go": [ { "hashed_secret": "83747cea2b26d7652ed39218ddcdb1461c570535", @@ -2915,16 +2907,6 @@ "verified_result": null } ], - "ibm/service/satellite/resource_ibm_satellite_storage_configuration_test.go": [ - { - "hashed_secret": "f32b67c7e26342af42efabc674d441dca0a281c5", - "is_secret": false, - "is_verified": false, - "line_number": 118, - "type": "Secret Keyword", - "verified_result": null - } - ], "ibm/service/schematics/data_source_ibm_schematics_action.go": [ { "hashed_secret": "49f3bb8f759241df51c899d3725d877bad58f66e", @@ -3014,7 +2996,7 @@ "hashed_secret": "3046d9f6cfaaeea6eed9bb7a4ab010fe49b0cfd4", "is_secret": false, "is_verified": false, - "line_number": 177, + "line_number": 181, "type": "Secret Keyword", "verified_result": null }, @@ -3022,7 +3004,7 @@ "hashed_secret": "b732fb611fd46a38e8667f9972e0cde777fbe37f", "is_secret": false, "is_verified": false, - "line_number": 317, + "line_number": 308, "type": "Secret Keyword", "verified_result": null } @@ -3070,7 +3052,7 @@ "hashed_secret": "3046d9f6cfaaeea6eed9bb7a4ab010fe49b0cfd4", "is_secret": false, "is_verified": false, - "line_number": 189, + "line_number": 193, "type": "Secret Keyword", "verified_result": null }, @@ -3078,7 +3060,7 @@ "hashed_secret": "b732fb611fd46a38e8667f9972e0cde777fbe37f", "is_secret": false, "is_verified": false, - "line_number": 345, + "line_number": 335, "type": "Secret Keyword", "verified_result": null } @@ -3088,7 +3070,7 @@ "hashed_secret": "3046d9f6cfaaeea6eed9bb7a4ab010fe49b0cfd4", "is_secret": false, "is_verified": false, - "line_number": 227, + "line_number": 231, "type": "Secret Keyword", "verified_result": null }, @@ -3096,7 +3078,7 @@ "hashed_secret": "b732fb611fd46a38e8667f9972e0cde777fbe37f", "is_secret": false, "is_verified": false, - "line_number": 420, + "line_number": 410, "type": "Secret Keyword", "verified_result": null } @@ -3142,7 +3124,7 @@ "hashed_secret": "3046d9f6cfaaeea6eed9bb7a4ab010fe49b0cfd4", "is_secret": false, "is_verified": false, - "line_number": 292, + "line_number": 296, "type": "Secret Keyword", "verified_result": null }, @@ -3150,7 +3132,7 @@ "hashed_secret": "b732fb611fd46a38e8667f9972e0cde777fbe37f", "is_secret": false, "is_verified": false, - "line_number": 489, + "line_number": 479, "type": "Secret Keyword", "verified_result": null } @@ -3272,7 +3254,7 @@ "hashed_secret": "3046d9f6cfaaeea6eed9bb7a4ab010fe49b0cfd4", "is_secret": false, "is_verified": false, - "line_number": 154, + "line_number": 158, "type": "Secret Keyword", "verified_result": null }, @@ -3280,7 +3262,7 @@ "hashed_secret": "b732fb611fd46a38e8667f9972e0cde777fbe37f", "is_secret": false, "is_verified": false, - "line_number": 283, + "line_number": 274, "type": "Secret Keyword", "verified_result": null } @@ -3646,7 +3628,7 @@ "hashed_secret": "f855f5027fd8fdb2df3f6a6f1cf858fffcbedb0c", "is_secret": false, "is_verified": false, - "line_number": 89080, + "line_number": 92841, "type": "Secret Keyword", "verified_result": null }, @@ -3654,7 +3636,7 @@ "hashed_secret": "5fb0fa884132a8724a8d7cba55853737e442adbd", "is_secret": false, "is_verified": false, - "line_number": 111658, + "line_number": 115304, "type": "Secret Keyword", "verified_result": null }, @@ -3662,11 +3644,21 @@ "hashed_secret": "1e5c2f367f02e47a8c160cda1cd9d91decbac441", "is_secret": false, "is_verified": false, - "line_number": 141194, + "line_number": 145758, "type": "Secret Keyword", "verified_result": null } ], + "website/docs/d/cd_toolchains.html.markdown": [ + { + "hashed_secret": "8d204a8e6f883c0691207b5eed52ab2889568f71", + "is_secret": false, + "is_verified": false, + "line_number": 18, + "type": "Hex High Entropy String", + "verified_result": null + } + ], "website/docs/d/cis_waf_groups.html.markdown": [ { "hashed_secret": "ece6e4a51cf5a18845f07c95832586a96d5fcf4c", @@ -3961,310 +3953,6 @@ "line_number": 19, "type": "Hex High Entropy String", "verified_result": null - }, - { - "hashed_secret": "d47dcacc720a39e236679ac3e311a0d58bb6519e", - "is_secret": false, - "is_verified": false, - "line_number": 83, - "type": "Secret Keyword", - "verified_result": null - }, - { - "hashed_secret": "e66e7d67fdf3c596c435fc7828b13205e4950a0f", - "is_secret": false, - "is_verified": false, - "line_number": 85, - "type": "Secret Keyword", - "verified_result": null - } - ], - "website/docs/r/cd_toolchain_tool_appconfig.html.markdown": [ - { - "hashed_secret": "d47dcacc720a39e236679ac3e311a0d58bb6519e", - "is_secret": false, - "is_verified": false, - "line_number": 102, - "type": "Secret Keyword", - "verified_result": null - }, - { - "hashed_secret": "e66e7d67fdf3c596c435fc7828b13205e4950a0f", - "is_secret": false, - "is_verified": false, - "line_number": 104, - "type": "Secret Keyword", - "verified_result": null - } - ], - "website/docs/r/cd_toolchain_tool_artifactory.html.markdown": [ - { - "hashed_secret": "d47dcacc720a39e236679ac3e311a0d58bb6519e", - "is_secret": false, - "is_verified": false, - "line_number": 105, - "type": "Secret Keyword", - "verified_result": null - }, - { - "hashed_secret": "e66e7d67fdf3c596c435fc7828b13205e4950a0f", - "is_secret": false, - "is_verified": false, - "line_number": 107, - "type": "Secret Keyword", - "verified_result": null - } - ], - "website/docs/r/cd_toolchain_tool_bitbucketgit.html.markdown": [ - { - "hashed_secret": "d47dcacc720a39e236679ac3e311a0d58bb6519e", - "is_secret": false, - "is_verified": false, - "line_number": 127, - "type": "Secret Keyword", - "verified_result": null - }, - { - "hashed_secret": "e66e7d67fdf3c596c435fc7828b13205e4950a0f", - "is_secret": false, - "is_verified": false, - "line_number": 129, - "type": "Secret Keyword", - "verified_result": null - } - ], - "website/docs/r/cd_toolchain_tool_custom.html.markdown": [ - { - "hashed_secret": "d47dcacc720a39e236679ac3e311a0d58bb6519e", - "is_secret": false, - "is_verified": false, - "line_number": 100, - "type": "Secret Keyword", - "verified_result": null - }, - { - "hashed_secret": "e66e7d67fdf3c596c435fc7828b13205e4950a0f", - "is_secret": false, - "is_verified": false, - "line_number": 102, - "type": "Secret Keyword", - "verified_result": null - } - ], - "website/docs/r/cd_toolchain_tool_devopsinsights.html.markdown": [ - { - "hashed_secret": "d47dcacc720a39e236679ac3e311a0d58bb6519e", - "is_secret": false, - "is_verified": false, - "line_number": 83, - "type": "Secret Keyword", - "verified_result": null - }, - { - "hashed_secret": "e66e7d67fdf3c596c435fc7828b13205e4950a0f", - "is_secret": false, - "is_verified": false, - "line_number": 85, - "type": "Secret Keyword", - "verified_result": null - } - ], - "website/docs/r/cd_toolchain_tool_eventnotifications.html.markdown": [ - { - "hashed_secret": "d47dcacc720a39e236679ac3e311a0d58bb6519e", - "is_secret": false, - "is_verified": false, - "line_number": 92, - "type": "Secret Keyword", - "verified_result": null - }, - { - "hashed_secret": "e66e7d67fdf3c596c435fc7828b13205e4950a0f", - "is_secret": false, - "is_verified": false, - "line_number": 94, - "type": "Secret Keyword", - "verified_result": null - } - ], - "website/docs/r/cd_toolchain_tool_githubconsolidated.html.markdown": [ - { - "hashed_secret": "d47dcacc720a39e236679ac3e311a0d58bb6519e", - "is_secret": false, - "is_verified": false, - "line_number": 143, - "type": "Secret Keyword", - "verified_result": null - }, - { - "hashed_secret": "e66e7d67fdf3c596c435fc7828b13205e4950a0f", - "is_secret": false, - "is_verified": false, - "line_number": 145, - "type": "Secret Keyword", - "verified_result": null - } - ], - "website/docs/r/cd_toolchain_tool_gitlab.html.markdown": [ - { - "hashed_secret": "d47dcacc720a39e236679ac3e311a0d58bb6519e", - "is_secret": false, - "is_verified": false, - "line_number": 139, - "type": "Secret Keyword", - "verified_result": null - }, - { - "hashed_secret": "e66e7d67fdf3c596c435fc7828b13205e4950a0f", - "is_secret": false, - "is_verified": false, - "line_number": 141, - "type": "Secret Keyword", - "verified_result": null - } - ], - "website/docs/r/cd_toolchain_tool_hashicorpvault.html.markdown": [ - { - "hashed_secret": "d47dcacc720a39e236679ac3e311a0d58bb6519e", - "is_secret": false, - "is_verified": false, - "line_number": 107, - "type": "Secret Keyword", - "verified_result": null - }, - { - "hashed_secret": "e66e7d67fdf3c596c435fc7828b13205e4950a0f", - "is_secret": false, - "is_verified": false, - "line_number": 109, - "type": "Secret Keyword", - "verified_result": null - } - ], - "website/docs/r/cd_toolchain_tool_hostedgit.html.markdown": [ - { - "hashed_secret": "d47dcacc720a39e236679ac3e311a0d58bb6519e", - "is_secret": false, - "is_verified": false, - "line_number": 132, - "type": "Secret Keyword", - "verified_result": null - }, - { - "hashed_secret": "e66e7d67fdf3c596c435fc7828b13205e4950a0f", - "is_secret": false, - "is_verified": false, - "line_number": 134, - "type": "Secret Keyword", - "verified_result": null - } - ], - "website/docs/r/cd_toolchain_tool_jenkins.html.markdown": [ - { - "hashed_secret": "d47dcacc720a39e236679ac3e311a0d58bb6519e", - "is_secret": false, - "is_verified": false, - "line_number": 96, - "type": "Secret Keyword", - "verified_result": null - }, - { - "hashed_secret": "e66e7d67fdf3c596c435fc7828b13205e4950a0f", - "is_secret": false, - "is_verified": false, - "line_number": 98, - "type": "Secret Keyword", - "verified_result": null - } - ], - "website/docs/r/cd_toolchain_tool_jira.html.markdown": [ - { - "hashed_secret": "d47dcacc720a39e236679ac3e311a0d58bb6519e", - "is_secret": false, - "is_verified": false, - "line_number": 98, - "type": "Secret Keyword", - "verified_result": null - }, - { - "hashed_secret": "e66e7d67fdf3c596c435fc7828b13205e4950a0f", - "is_secret": false, - "is_verified": false, - "line_number": 100, - "type": "Secret Keyword", - "verified_result": null - } - ], - "website/docs/r/cd_toolchain_tool_keyprotect.html.markdown": [ - { - "hashed_secret": "d47dcacc720a39e236679ac3e311a0d58bb6519e", - "is_secret": false, - "is_verified": false, - "line_number": 96, - "type": "Secret Keyword", - "verified_result": null - }, - { - "hashed_secret": "e66e7d67fdf3c596c435fc7828b13205e4950a0f", - "is_secret": false, - "is_verified": false, - "line_number": 98, - "type": "Secret Keyword", - "verified_result": null - } - ], - "website/docs/r/cd_toolchain_tool_nexus.html.markdown": [ - { - "hashed_secret": "d47dcacc720a39e236679ac3e311a0d58bb6519e", - "is_secret": false, - "is_verified": false, - "line_number": 101, - "type": "Secret Keyword", - "verified_result": null - }, - { - "hashed_secret": "e66e7d67fdf3c596c435fc7828b13205e4950a0f", - "is_secret": false, - "is_verified": false, - "line_number": 103, - "type": "Secret Keyword", - "verified_result": null - } - ], - "website/docs/r/cd_toolchain_tool_pagerduty.html.markdown": [ - { - "hashed_secret": "d47dcacc720a39e236679ac3e311a0d58bb6519e", - "is_secret": false, - "is_verified": false, - "line_number": 92, - "type": "Secret Keyword", - "verified_result": null - }, - { - "hashed_secret": "e66e7d67fdf3c596c435fc7828b13205e4950a0f", - "is_secret": false, - "is_verified": false, - "line_number": 94, - "type": "Secret Keyword", - "verified_result": null - } - ], - "website/docs/r/cd_toolchain_tool_pipeline.html.markdown": [ - { - "hashed_secret": "d47dcacc720a39e236679ac3e311a0d58bb6519e", - "is_secret": false, - "is_verified": false, - "line_number": 89, - "type": "Secret Keyword", - "verified_result": null - }, - { - "hashed_secret": "e66e7d67fdf3c596c435fc7828b13205e4950a0f", - "is_secret": false, - "is_verified": false, - "line_number": 91, - "type": "Secret Keyword", - "verified_result": null } ], "website/docs/r/cd_toolchain_tool_privateworker.html.markdown": [ @@ -4275,94 +3963,6 @@ "line_number": 21, "type": "Secret Keyword", "verified_result": null - }, - { - "hashed_secret": "d47dcacc720a39e236679ac3e311a0d58bb6519e", - "is_secret": false, - "is_verified": false, - "line_number": 92, - "type": "Secret Keyword", - "verified_result": null - }, - { - "hashed_secret": "e66e7d67fdf3c596c435fc7828b13205e4950a0f", - "is_secret": false, - "is_verified": false, - "line_number": 94, - "type": "Secret Keyword", - "verified_result": null - } - ], - "website/docs/r/cd_toolchain_tool_saucelabs.html.markdown": [ - { - "hashed_secret": "d47dcacc720a39e236679ac3e311a0d58bb6519e", - "is_secret": false, - "is_verified": false, - "line_number": 91, - "type": "Secret Keyword", - "verified_result": null - }, - { - "hashed_secret": "e66e7d67fdf3c596c435fc7828b13205e4950a0f", - "is_secret": false, - "is_verified": false, - "line_number": 93, - "type": "Secret Keyword", - "verified_result": null - } - ], - "website/docs/r/cd_toolchain_tool_secretsmanager.html.markdown": [ - { - "hashed_secret": "d47dcacc720a39e236679ac3e311a0d58bb6519e", - "is_secret": false, - "is_verified": false, - "line_number": 99, - "type": "Secret Keyword", - "verified_result": null - }, - { - "hashed_secret": "e66e7d67fdf3c596c435fc7828b13205e4950a0f", - "is_secret": false, - "is_verified": false, - "line_number": 101, - "type": "Secret Keyword", - "verified_result": null - } - ], - "website/docs/r/cd_toolchain_tool_securitycompliance.html.markdown": [ - { - "hashed_secret": "d47dcacc720a39e236679ac3e311a0d58bb6519e", - "is_secret": false, - "is_verified": false, - "line_number": 109, - "type": "Secret Keyword", - "verified_result": null - }, - { - "hashed_secret": "e66e7d67fdf3c596c435fc7828b13205e4950a0f", - "is_secret": false, - "is_verified": false, - "line_number": 111, - "type": "Secret Keyword", - "verified_result": null - } - ], - "website/docs/r/cd_toolchain_tool_slack.html.markdown": [ - { - "hashed_secret": "d47dcacc720a39e236679ac3e311a0d58bb6519e", - "is_secret": false, - "is_verified": false, - "line_number": 108, - "type": "Secret Keyword", - "verified_result": null - }, - { - "hashed_secret": "e66e7d67fdf3c596c435fc7828b13205e4950a0f", - "is_secret": false, - "is_verified": false, - "line_number": 110, - "type": "Secret Keyword", - "verified_result": null } ], "website/docs/r/cd_toolchain_tool_sonarqube.html.markdown": [ @@ -4373,22 +3973,6 @@ "line_number": 22, "type": "Secret Keyword", "verified_result": null - }, - { - "hashed_secret": "d47dcacc720a39e236679ac3e311a0d58bb6519e", - "is_secret": false, - "is_verified": false, - "line_number": 98, - "type": "Secret Keyword", - "verified_result": null - }, - { - "hashed_secret": "e66e7d67fdf3c596c435fc7828b13205e4950a0f", - "is_secret": false, - "is_verified": false, - "line_number": 100, - "type": "Secret Keyword", - "verified_result": null } ], "website/docs/r/cis_alert.html.markdown": [ @@ -4599,14 +4183,6 @@ "line_number": 24, "type": "Secret Keyword", "verified_result": null - }, - { - "hashed_secret": "69d7a780b792608707bd8579c295cb5028505f0b", - "is_secret": false, - "is_verified": false, - "line_number": 24, - "type": "Box Credentials", - "verified_result": null } ], "website/docs/r/en_destination_ios.html.markdown": [ diff --git a/CHANGELOG.md b/CHANGELOG.md index 2a0d507b94..35deeb797a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,132 @@ +# 1.58.1 (Oct 04, 2023) + +Bug Fixes +* Timing issue while destroying Key Protect resources ([4837](https://github.com/IBM-Cloud/terraform-provider-ibm/issues/4837)) +* ibm_cos_bucket data lookup is throwing NoSuchWebsiteConfiguration in new version 1.58.0 ([4838](https://github.com/IBM-Cloud/terraform-provider-ibm/issues/4838)) +* Metrics router and atracker: Updated platform-services-go-sdk to fetch Madrid endpoint ([4830](https://github.com/IBM-Cloud/terraform-provider-ibm/pull/4830)) +# 1.58.0 (Sep 29, 2023) + +Features +* Support Satellite Cluster + - **Resources** + - ibm_satellite_storage_configuration + - ibm_satellite_storage_assignment + - **Datasources** + - ibm_satellite_storage_configuration + - ibm_satellite_storage_assignment +* Support Security and Compliance + - **Resources** + - ibm_scc_rule + - ibm_scc_control_library + - ibm_scc_profile + - ibm_scc_profile_attachment + - ibm_scc_provider_type_instance + - **Datasources** + - ibm_scc_instance_settings + - ibm_scc_control_library + - ibm_scc_profile + - ibm_scc_profile_attachment + - ibm_scc_provider_type + - ibm_scc_provider_type_collection + - ibm_scc_provider_type_instance + - ibm_scc_latest_reports + - ibm_scc_report + - ibm_scc_report_controls + - ibm_scc_report_evaluations + - ibm_scc_report_resources + - ibm_scc_report_rule + - ibm_scc_report_summary + - ibm_scc_report_tags + - ibm_scc_report_violation_drift + - ibm_scc_rule + +* Support CD Toolchain + - **Datasources** + - ibm_cd_toolchains +* Support Virtual Private Cloud + - **Resources** + - ibm_is_vpc_dns_resolution_binding + - **Datasources** + - ibm_is_vpc_dns_resolution_binding + - ibm_is_vpc_dns_resolution_bindings + + +Enhancements +* Added retry mechanism and new SDK generator 3.78 ([4776](https://github.com/IBM-Cloud/terraform-provider-ibm/pull/4776)) +* Add default cluster versions to cluster versions data source ([4799](https://github.com/IBM-Cloud/terraform-provider-ibm/pull/4799)) +* Add description for keys and force_delete for deleteKeyRings for IBM ([4767](https://github.com/IBM-Cloud/terraform-provider-ibm/pull/4767)) +* Retry cloud connection create/update when vpc is unavailable ([4766](https://github.com/IBM-Cloud/terraform-provider-ibm/pull/4766)) +* Adding support for COS Static Web hosting ([4766](https://github.com/IBM-Cloud/terraform-provider-ibm/pull/4766)) +* add support for endpoint parameter in cluster_config ([4793](https://github.com/IBM-Cloud/terraform-provider-ibm/pull/4793)) +* fix(IAM Policy Management): allow sourceServiceName to be optional for authorizational policies ([4804](https://github.com/IBM-Cloud/terraform-provider-ibm/pull/4804)) + +BugFixes +* ops_manager User Creation ([4755](https://github.com/IBM-Cloud/terraform-provider-ibm/pull/4755)) +* fix(share-iops): Share Iops range fix for dp2 ([4807](https://github.com/IBM-Cloud/terraform-provider-ibm/pull/4807)) +* fix(VSI-Profile-patch): Remove validation for VSI profile patching ([4824](https://github.com/IBM-Cloud/terraform-provider-ibm/pull/4824)) + + +# 1.58.0-beta1 (Sep 25, 2023) +Features +* Support CD Toolchain + - **Datasources** + - ibm_cd_toolchains +* Support Virtual Private Cloud + - **Resources** + - ibm_is_vpc_dns_resolution_binding + - **Datasources** + - ibm_is_vpc_dns_resolution_binding + - ibm_is_vpc_dns_resolution_bindings + +# 1.58.0-beta0 (Sep 10, 2023) + +Features +* Support Satellite Cluster + - **Resources** + - ibm_satellite_storage_configuration + - ibm_satellite_storage_assignment + - **Datasources** + - ibm_satellite_storage_configuration + - ibm_satellite_storage_assignment +* Support Security and Compliance + - **Resources** + - ibm_scc_rule + - ibm_scc_control_library + - ibm_scc_profile + - ibm_scc_profile_attachment + - ibm_scc_provider_type_instance + - **Datasources** + - ibm_scc_instance_settings + - ibm_scc_control_library + - ibm_scc_profile + - ibm_scc_profile_attachment + - ibm_scc_provider_type + - ibm_scc_provider_type_collection + - ibm_scc_provider_type_instance + - ibm_scc_latest_reports + - ibm_scc_report + - ibm_scc_report_controls + - ibm_scc_report_evaluations + - ibm_scc_report_resources + - ibm_scc_report_rule + - ibm_scc_report_summary + - ibm_scc_report_tags + - ibm_scc_report_violation_drift + - ibm_scc_rule + +Enhancements +* Added retry mechanism and new SDK generator 3.78 ([4776](https://github.com/IBM-Cloud/terraform-provider-ibm/pull/4776)) +* Add default cluster versions to cluster versions data source ([4799](https://github.com/IBM-Cloud/terraform-provider-ibm/pull/4799)) +* Add description for keys and force_delete for deleteKeyRings for IBM ([4767](https://github.com/IBM-Cloud/terraform-provider-ibm/pull/4767)) +* Retry cloud connection create/update when vpc is unavailable ([4766](https://github.com/IBM-Cloud/terraform-provider-ibm/pull/4766)) +* Adding support for COS Static Web hosting ([4766](https://github.com/IBM-Cloud/terraform-provider-ibm/pull/4766)) +* add support for endpoint parameter in cluster_config ([4793](https://github.com/IBM-Cloud/terraform-provider-ibm/pull/4793)) + +BugFixes +* ops_manager User Creation ([4755](https://github.com/IBM-Cloud/terraform-provider-ibm/pull/4755)) +* fix(share-iops): Share Iops range fix for dp2 ([4807](https://github.com/IBM-Cloud/terraform-provider-ibm/pull/4807)) + + # 1.57.0 (Sep 13, 2023) Features diff --git a/common/github.com/IBM/vpc-go-sdk/.bumpversion.cfg b/common/github.com/IBM/vpc-go-sdk/.bumpversion.cfg new file mode 100644 index 0000000000..75285ab0b2 --- /dev/null +++ b/common/github.com/IBM/vpc-go-sdk/.bumpversion.cfg @@ -0,0 +1,13 @@ +[bumpversion] +current_version = 0.6.0 +commit = True +message = Update version {current_version} -> {new_version} [skip ci] + +[bumpversion:file:common/version.go] +search = const Version = "{current_version}" +replace = const Version = "{new_version}" + +[bumpversion:file:README.md] +search = {current_version} +replace = {new_version} + diff --git a/common/github.com/IBM/vpc-go-sdk/.gitattributes b/common/github.com/IBM/vpc-go-sdk/.gitattributes new file mode 100644 index 0000000000..3bfcae65ad --- /dev/null +++ b/common/github.com/IBM/vpc-go-sdk/.gitattributes @@ -0,0 +1 @@ +*.enc binary \ No newline at end of file diff --git a/common/github.com/IBM/vpc-go-sdk/.gitignore b/common/github.com/IBM/vpc-go-sdk/.gitignore new file mode 100644 index 0000000000..2be5a24d4d --- /dev/null +++ b/common/github.com/IBM/vpc-go-sdk/.gitignore @@ -0,0 +1,18 @@ +# OS stuff +.DS_Store + +# generator files +.openapi-generator-ignore +.openapi-generator/VERSION + +# credentials +.env +*.env + +# ignore vendor/ +vendor/ + +/.project +/.openapi-generator/ + +main/ \ No newline at end of file diff --git a/common/github.com/IBM/vpc-go-sdk/.releaserc b/common/github.com/IBM/vpc-go-sdk/.releaserc new file mode 100644 index 0000000000..a746388363 --- /dev/null +++ b/common/github.com/IBM/vpc-go-sdk/.releaserc @@ -0,0 +1,21 @@ +{ + "debug": true, + "plugins": [ + "@semantic-release/commit-analyzer", + "@semantic-release/release-notes-generator", + "@semantic-release/changelog", + [ + "@semantic-release/exec", + { + "prepareCmd": "bump2version --allow-dirty --current-version ${lastRelease.version} --new-version ${nextRelease.version} patch" + } + ], + [ + "@semantic-release/git", + { + "message": "chore(release): ${nextRelease.version} release notes [skip ci]\n\n${nextRelease.notes}" + } + ], + "@semantic-release/github" + ] +} diff --git a/common/github.com/IBM/vpc-go-sdk/.travis.yml b/common/github.com/IBM/vpc-go-sdk/.travis.yml new file mode 100644 index 0000000000..464cdde97c --- /dev/null +++ b/common/github.com/IBM/vpc-go-sdk/.travis.yml @@ -0,0 +1,39 @@ +language: go + +dist: xenial + +notifications: + email: true + +go: +- 1.14.x + +env: + global: + - GO111MODULE=on + +before_install: +- sudo apt-get update +- sudo apt-get install python +- nvm install 12 +- npm install -g npm@6.x + +install: +- curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh| sh -s -- -b $(go env GOPATH)/bin v1.37.1 + +script: +- make travis-ci + +# before_deploy: +# - pip install --user bump2version +# - npm install @semantic-release/changelog +# - npm install @semantic-release/exec +# - npm install @semantic-release/git +# - npm install @semantic-release/github + +# deploy: +# - provider: script +# script: npx semantic-release +# skip_cleanup: true +# on: +# branch: master diff --git a/common/github.com/IBM/vpc-go-sdk/CHANGELOG.md b/common/github.com/IBM/vpc-go-sdk/CHANGELOG.md new file mode 100644 index 0000000000..37bf62185e --- /dev/null +++ b/common/github.com/IBM/vpc-go-sdk/CHANGELOG.md @@ -0,0 +1,96 @@ +## [1.0.1](https://github.com/IBM/vpc-go-sdk/compare/v1.0.0...v1.0.1) (2021-04-07) + + +### Bug Fixes + +* **release:** Update SDKs to use API version 2021-03-30 ([#27](https://github.com/IBM/vpc-go-sdk/issues/27)) ([ba27a36](https://github.com/IBM/vpc-go-sdk/commit/ba27a36f743d07a1cae4fb45f83478adf4d33d79)) + +# [1.0.0](https://github.com/IBM/vpc-go-sdk/compare/v0.4.2...v1.0.0) (2021-03-16) + + +### Performance Improvements + +* **Instance-groups:** Update VPC SDK with API version 2021-03-09 ([#23](https://github.com/IBM/vpc-go-sdk/issues/23)) ([d6dc319](https://github.com/IBM/vpc-go-sdk/commit/d6dc319bb5aa19aff4fd89872198b6e573545110)) + + +### BREAKING CHANGES + +* **Instance-groups:** - Methods for Instance group manager is now producing InstanceGroupManagerIntf instead of InstanceGroupManager + +## [0.4.2](https://github.com/IBM/vpc-go-sdk/compare/v0.4.1...v0.4.2) (2021-03-02) + + +### Bug Fixes + +* **release:** Update SDKs to use API version 2021-02-09 ([#20](https://github.com/IBM/vpc-go-sdk/issues/20)) ([ae348ee](https://github.com/IBM/vpc-go-sdk/commit/ae348ee347f7405fac4ab4574392673a9194f6bd)) + +## [0.4.1](https://github.com/IBM/vpc-go-sdk/compare/v0.4.0...v0.4.1) (2021-01-18) + + +### Bug Fixes + +* **release:** Update SDKs to use API version 2020-01-12 ([#18](https://github.com/IBM/vpc-go-sdk/issues/18)) ([d8c2134](https://github.com/IBM/vpc-go-sdk/commit/d8c21345b1ed032484fbaf57456d4f476423b5fc)) + +# [0.4.0](https://github.com/IBM/vpc-go-sdk/compare/v0.3.1...v0.4.0) (2020-12-17) + + +### Features + +* **enhancement:** Update VPC service with API version 2020-12-15 ([#17](https://github.com/IBM/vpc-go-sdk/issues/17)) ([affcaed](https://github.com/IBM/vpc-go-sdk/commit/affcaed4e8f7e515148cb9aac82755ad2a3ea8ca)) + +## [0.3.1](https://github.com/IBM/vpc-go-sdk/compare/v0.3.0...v0.3.1) (2020-11-20) + + +### Bug Fixes + +* **SecurityGroup:** Update both VPC services fixing security group issue. ([#16](https://github.com/IBM/vpc-go-sdk/issues/16)) ([270decd](https://github.com/IBM/vpc-go-sdk/commit/270decd989abd0ed5b9cd101d6c7a2fcb9deecc2)) + +# [0.3.0](https://github.com/IBM/vpc-go-sdk/compare/v0.2.0...v0.3.0) (2020-11-20) + + +### Features + +* **SDK:** Update VPC Gen2 and Gen1 services with API version 2020-11-17 ([#15](https://github.com/IBM/vpc-go-sdk/issues/15)) ([6f97a1a](https://github.com/IBM/vpc-go-sdk/commit/6f97a1a643dce6d76f8ada9caecc49d864b656fa)) + +# [0.2.0](https://github.com/IBM/vpc-go-sdk/compare/v0.1.1...v0.2.0) (2020-10-16) + + +### Features + +* **version update:** Update both services with API version 2020-10-06 ([#14](https://github.com/IBM/vpc-go-sdk/issues/14)) ([179880c](https://github.com/IBM/vpc-go-sdk/commit/179880c4775e0d6e6a9e683546348b34e9f9b785)) + +## [0.1.1](https://github.com/IBM/vpc-go-sdk/compare/v0.1.0...v0.1.1) (2020-09-09) + + +### Bug Fixes + +* **NLB:** update NLB feature ([#13](https://github.com/IBM/vpc-go-sdk/issues/13)) ([99d207d](https://github.com/IBM/vpc-go-sdk/commit/99d207dba81fef5214be63864aa7a4b91af82c89)) + +# [0.1.0](https://github.com/IBM/vpc-go-sdk/compare/v0.0.3...v0.1.0) (2020-09-03) + + +### Features + +* **autoscale:** Add autoscale feature and NLB feature ([#12](https://github.com/IBM/vpc-go-sdk/issues/12)) ([0ee5ea1](https://github.com/IBM/vpc-go-sdk/commit/0ee5ea16247a6f94794674d0499c01e78857d6a4)) + +## [0.0.3](https://github.com/IBM/vpc-go-sdk/compare/v0.0.2...v0.0.3) (2020-08-06) + + +### Bug Fixes + +* **version:** Release SDK for API version 2020-07-28 ([#10](https://github.com/IBM/vpc-go-sdk/issues/10)) ([4550ccc](https://github.com/IBM/vpc-go-sdk/commit/4550cccb167443bad8857dc88fc097ad18061734)) + +## [0.0.2](https://github.com/IBM/vpc-go-sdk/compare/v0.0.1...v0.0.2) (2020-07-06) + + +### Bug Fixes + +* **doc:** Minor update to example code in the README ([#9](https://github.com/IBM/vpc-go-sdk/issues/9)) ([f3841fc](https://github.com/IBM/vpc-go-sdk/commit/f3841fcfbffab66d970ec966b558a48180f0651c)) + +## [0.0.1](https://github.com/IBM/vpc-go-sdk/compare/v0.0.0...v0.0.1) (2020-06-19) + + +### Bug Fixes + +* **go-sdk:** adding semantic release versioning ([#4](https://github.com/IBM/vpc-go-sdk/issues/4)) ([1d92ee5](https://github.com/IBM/vpc-go-sdk/commit/1d92ee5d6481c923382628e8dfc9b9de51cc7ddd)) +* **version:** Update version to enable semantic release ([#6](https://github.com/IBM/vpc-go-sdk/issues/6)) ([2699a61](https://github.com/IBM/vpc-go-sdk/commit/2699a615cd9fad5de60ef442c7512a8744c676a1)) diff --git a/common/github.com/IBM/vpc-go-sdk/CODE_OF_CONDUCT.md b/common/github.com/IBM/vpc-go-sdk/CODE_OF_CONDUCT.md new file mode 100644 index 0000000000..7303c87870 --- /dev/null +++ b/common/github.com/IBM/vpc-go-sdk/CODE_OF_CONDUCT.md @@ -0,0 +1,76 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at phil_adams@us.ibm.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq diff --git a/common/github.com/IBM/vpc-go-sdk/CONTRIBUTING.md b/common/github.com/IBM/vpc-go-sdk/CONTRIBUTING.md new file mode 100644 index 0000000000..fee9f665c1 --- /dev/null +++ b/common/github.com/IBM/vpc-go-sdk/CONTRIBUTING.md @@ -0,0 +1,14 @@ +# Questions +If you are having problems using the APIs or have a question about IBM Cloud services, +please ask a question at +[Stack Overflow](http://stackoverflow.com/questions/ask?tags=ibm-cloud). + +# Issues +If you encounter an issue with the project, you are welcome to submit a +[bug report](https://github.com/IBM/vpc-go-sdk/issues). +Before that, please search for similar issues. It's possible that someone has already reported the problem. + +# General Information +For general guidance on contributing to this project, please see +[this link](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/CONTRIBUTING_go.md) + diff --git a/common/github.com/IBM/vpc-go-sdk/LICENSE b/common/github.com/IBM/vpc-go-sdk/LICENSE new file mode 100644 index 0000000000..261eeb9e9f --- /dev/null +++ b/common/github.com/IBM/vpc-go-sdk/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/common/github.com/IBM/vpc-go-sdk/Makefile b/common/github.com/IBM/vpc-go-sdk/Makefile new file mode 100644 index 0000000000..81fb2e0b5a --- /dev/null +++ b/common/github.com/IBM/vpc-go-sdk/Makefile @@ -0,0 +1,23 @@ +# Makefile + +all: build lint tidy + +travis-ci: build lint tidy test-unit + +build: + go build ./vpcv1 + +test-unit: + go test `go list ./... | grep vpcv1` -v -tags=unit + +test-integration: + go test `go list ./... | grep vpcv1` -v -tags=integration -skipForMockTesting -testCount + +test-examples: + go test `go list ./... | grep vpcv1` -v -tags=examples + +lint: + golangci-lint --timeout=2m run + +tidy: + go mod tidy diff --git a/common/github.com/IBM/vpc-go-sdk/common/headers.go b/common/github.com/IBM/vpc-go-sdk/common/headers.go new file mode 100644 index 0000000000..87cc2bfcd9 --- /dev/null +++ b/common/github.com/IBM/vpc-go-sdk/common/headers.go @@ -0,0 +1,67 @@ +package common + +import ( + "fmt" + "runtime" + + "github.com/google/uuid" +) + +const ( + HEADER_NAME_USER_AGENT = "User-Agent" + + SDK_NAME = "vpc-go-sdk" + + X_CORRELATION_ID = "X-Correlation-Id" + + X_REQUEST_ID = "X-Request-Id" +) + +// GetSdkHeaders - returns the set of SDK-specific headers to be included in an outgoing request. +// +// This function is invoked by generated service methods (i.e. methods which implement the REST API operations +// defined within the API definition). The purpose of this function is to give the SDK implementor the opportunity +// to provide SDK-specific HTTP headers that will be sent with an outgoing REST API request. +// This function is invoked for each invocation of a generated service method, +// so the set of HTTP headers could be request-specific. +// As an optimization, if your SDK will be returning the same set of HTTP headers for each invocation of this +// function, it is recommended that you initialize the returned map just once (perhaps by using +// lazy initialization) and simply return it each time the function is invoked, instead of building it each time +// as in the example below. +// +// Parameters: +// +// serviceName - the name of the service as defined in the API definition (e.g. "MyService1") +// serviceVersion - the version of the service as defined in the API definition (e.g. "V1") +// operationId - the operationId as defined in the API definition (e.g. getContext) +// +// Returns: +// +// a Map which contains the set of headers to be included in the REST API request +func GetSdkHeaders(serviceName string, serviceVersion string, operationId string) map[string]string { + sdkHeaders := make(map[string]string) + + sdkHeaders[HEADER_NAME_USER_AGENT] = GetUserAgentInfo() + sdkHeaders[X_CORRELATION_ID] = GetNewXCorrelationID() + sdkHeaders[X_REQUEST_ID] = GetNewXRequestID() + + return sdkHeaders +} + +var UserAgent string = fmt.Sprintf("%s-%s %s", SDK_NAME, Version, GetSystemInfo()) + +func GetUserAgentInfo() string { + return UserAgent +} +func GetNewXCorrelationID() string { + return uuid.New().String() +} +func GetNewXRequestID() string { + return uuid.New().String() +} + +var systemInfo = fmt.Sprintf("(arch=%s; os=%s; go.version=%s)", runtime.GOARCH, runtime.GOOS, runtime.Version()) + +func GetSystemInfo() string { + return systemInfo +} diff --git a/common/github.com/IBM/vpc-go-sdk/common/headers_test.go b/common/github.com/IBM/vpc-go-sdk/common/headers_test.go new file mode 100644 index 0000000000..c8e610ed55 --- /dev/null +++ b/common/github.com/IBM/vpc-go-sdk/common/headers_test.go @@ -0,0 +1,30 @@ +package common + +import ( + "strings" + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestGetSystemInfo(t *testing.T) { + var sysinfo = GetSystemInfo() + assert.NotNil(t, sysinfo) + assert.True(t, strings.Contains(sysinfo, "arch=")) + assert.True(t, strings.Contains(sysinfo, "os=")) + assert.True(t, strings.Contains(sysinfo, "go.version=")) +} + +func TestGetSdkHeaders(t *testing.T) { + var headers = GetSdkHeaders("myService", "v123", "myOperation") + assert.NotNil(t, headers) + + var foundIt bool + + _, foundIt = headers[HEADER_NAME_USER_AGENT] + assert.True(t, foundIt) + _, foundIt = headers[X_CORRELATION_ID] + assert.True(t, foundIt) + _, foundIt = headers[X_REQUEST_ID] + assert.True(t, foundIt) +} diff --git a/common/github.com/IBM/vpc-go-sdk/common/version.go b/common/github.com/IBM/vpc-go-sdk/common/version.go new file mode 100644 index 0000000000..436114bc2b --- /dev/null +++ b/common/github.com/IBM/vpc-go-sdk/common/version.go @@ -0,0 +1,4 @@ +package common + +// Version of the SDK +const Version = "0.43.0" diff --git a/common/github.com/IBM/vpc-go-sdk/go.mod b/common/github.com/IBM/vpc-go-sdk/go.mod new file mode 100644 index 0000000000..84658a9757 --- /dev/null +++ b/common/github.com/IBM/vpc-go-sdk/go.mod @@ -0,0 +1,18 @@ +module github.com/IBM/vpc-go-sdk + +go 1.16 + +require ( + github.com/IBM/go-sdk-core/v5 v5.12.1 + github.com/go-openapi/strfmt v0.21.3 + github.com/google/uuid v1.1.1 + github.com/onsi/ginkgo v1.16.5 + github.com/onsi/gomega v1.20.0 + github.com/stretchr/testify v1.8.0 +) + +retract ( + v1.0.2 + v1.0.1 + v1.0.0 +) \ No newline at end of file diff --git a/common/github.com/IBM/vpc-go-sdk/go.sum b/common/github.com/IBM/vpc-go-sdk/go.sum new file mode 100644 index 0000000000..88c822dd8e --- /dev/null +++ b/common/github.com/IBM/vpc-go-sdk/go.sum @@ -0,0 +1,143 @@ +github.com/IBM/go-sdk-core/v5 v5.9.1 h1:06pXbD9Rgmqqe2HA5YAeQbB4eYRRFgIoOT+Kh3cp1zo= +github.com/IBM/go-sdk-core/v5 v5.9.1/go.mod h1:axE2JrRq79gIJTjKPBwV6gWHswvVptBjbcvvCPIxARM= +github.com/asaskevich/govalidator v0.0.0-20200907205600-7a23bdc65eef h1:46PFijGLmAjMPwCCCo7Jf0W6f9slllCkkv7vyc1yOSg= +github.com/asaskevich/govalidator v0.0.0-20200907205600-7a23bdc65eef/go.mod h1:WaHUgvxTVq04UNunO+XhnAqY/wQc+bxr74GqbsZ/Jqw= +github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo= +github.com/fsnotify/fsnotify v1.4.9 h1:hsms1Qyu0jgnwNXIxa+/V/PDsU6CfLf6CNO8H7IWoS4= +github.com/fsnotify/fsnotify v1.4.9/go.mod h1:znqG4EE+3YCdAaPaxE2ZRY/06pZUdp0tY4IgpuI1SZQ= +github.com/go-openapi/errors v0.19.8 h1:doM+tQdZbUm9gydV9yR+iQNmztbjj7I3sW4sIcAwIzc= +github.com/go-openapi/errors v0.19.8/go.mod h1:cM//ZKUKyO06HSwqAelJ5NsEMMcpa6VpXe8DOa1Mi1M= +github.com/go-openapi/strfmt v0.21.1 h1:G6s2t5V5kGCHLVbSdZ/6lI8Wm4OzoPFkc3/cjAsKQrM= +github.com/go-openapi/strfmt v0.21.1/go.mod h1:I/XVKeLc5+MM5oPNN7P6urMOpuLXEcNrCX/rPGuWb0k= +github.com/go-playground/locales v0.13.0 h1:HyWk6mgj5qFqCT5fjGBuRArbVDfE4hi8+e8ceBS/t7Q= +github.com/go-playground/locales v0.13.0/go.mod h1:taPMhCMXrRLJO55olJkUXHZBHCxTMfnGwq/HNwmWNS8= +github.com/go-playground/universal-translator v0.17.0 h1:icxd5fm+REJzpZx7ZfpaD876Lmtgy7VtROAbHHXk8no= +github.com/go-playground/universal-translator v0.17.0/go.mod h1:UkSxE5sNxxRwHyU+Scu5vgOQjsIJAF8j9muTVoKLVtA= +github.com/go-stack/stack v1.8.0 h1:5SgMzNM5HxrEjV0ww2lTmX6E2Izsfxas4+YHWRs3Lsk= +github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY= +github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= +github.com/golang/protobuf v1.4.0-rc.1/go.mod h1:ceaxUfeHdC40wWswd/P6IGgMaK3YpKi5j83Wpe3EHw8= +github.com/golang/protobuf v1.4.0-rc.1.0.20200221234624-67d41d38c208/go.mod h1:xKAWHe0F5eneWXFV3EuXVDTCmh+JuBKY0li0aMyXATA= +github.com/golang/protobuf v1.4.0-rc.2/go.mod h1:LlEzMj4AhA7rCAGe4KMBDvJI+AwstrUpVNzEA03Pprs= +github.com/golang/protobuf v1.4.0-rc.4.0.20200313231945-b860323f09d0/go.mod h1:WU3c8KckQ9AFe+yFwt9sWVRKCVIyN9cPHBJSNnbL67w= +github.com/golang/protobuf v1.4.0/go.mod h1:jodUvKwWbYaEsadDk5Fwe5c77LiNKVO9IDvqG2KuDX0= +github.com/golang/protobuf v1.4.2 h1:+Z5KGCizgyZCbGh1KZqA0fcLLkwbsjIzS4aV2v7wJX0= +github.com/golang/protobuf v1.4.2/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw735rRwI= +github.com/golang/snappy v0.0.1/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q= +github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU= +github.com/google/go-cmp v0.3.1/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU= +github.com/google/go-cmp v0.4.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/google/go-cmp v0.5.2 h1:X2ev0eStA3AbceY54o37/0PQ/UWqKEiiO2dKL5OPaFM= +github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/google/uuid v1.1.1 h1:Gkbcsh/GbpXz7lPftLA3P6TYMwjCLYm83jiFQZF/3gY= +github.com/google/uuid v1.1.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/hashicorp/go-cleanhttp v0.5.1/go.mod h1:JpRdi6/HCYpAwUzNwuwqhbovhLtngrth3wmdIIUrZ80= +github.com/hashicorp/go-cleanhttp v0.5.2 h1:035FKYIWjmULyFRBKPs8TBQoi0x6d9G4xc9neXJWAZQ= +github.com/hashicorp/go-cleanhttp v0.5.2/go.mod h1:kO/YDlP8L1346E6Sodw+PrpBSV4/SoxCXGY6BqNFT48= +github.com/hashicorp/go-hclog v0.9.2 h1:CG6TE5H9/JXsFWJCfoIVpKFIkFe6ysEuHirp4DxCsHI= +github.com/hashicorp/go-hclog v0.9.2/go.mod h1:5CU+agLiy3J7N7QjHK5d05KxGsuXiQLrjA0H7acj2lQ= +github.com/hashicorp/go-retryablehttp v0.7.0 h1:eu1EI/mbirUgP5C8hVsTNaGZreBDlYiwC1FZWkvQPQ4= +github.com/hashicorp/go-retryablehttp v0.7.0/go.mod h1:vAew36LZh98gCBJNLH42IQ1ER/9wtLZZ8meHqQvEYWY= +github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU= +github.com/klauspost/compress v1.13.6/go.mod h1:/3/Vjq9QcHkK5uEr5lBEmyoZ1iFhe47etQ6QUkpK6sk= +github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= +github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= +github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= +github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= +github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= +github.com/leodido/go-urn v1.2.0 h1:hpXL4XnriNwQ/ABnpepYM/1vCLWNDfUNts8dX3xTG6Y= +github.com/leodido/go-urn v1.2.0/go.mod h1:+8+nEpDfqqsY+g338gtMEUOtuK+4dEMhiQEgxpxOKII= +github.com/mitchellh/mapstructure v1.3.3 h1:SzB1nHZ2Xi+17FP0zVQBHIZqvwRN9408fJO8h+eeNA8= +github.com/mitchellh/mapstructure v1.3.3/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo= +github.com/montanaflynn/stats v0.0.0-20171201202039-1bf9dbcd8cbe/go.mod h1:wL8QJuTMNUDYhXwkmfOly8iTdp5TEcJFWZD2D7SIkUc= +github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e h1:fD57ERR4JtEqsWbfPhv4DMiApHyliiK5xCTNVSPiaAs= +github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLANZcx1PVRCS0qkT7pwLkGfwJo4zjcN/Tysno= +github.com/nxadm/tail v1.4.4 h1:DQuhQpB1tVlglWS2hLQ5OV6B5r8aGxSrPc5Qo6uTN78= +github.com/nxadm/tail v1.4.4/go.mod h1:kenIhsEOeOJmVchQTgglprH7qJGnHDVpk1VPCcaMI8A= +github.com/oklog/ulid v1.3.1 h1:EGfNDEx6MqHz8B3uNV6QAib1UR2Lm97sHi3ocA6ESJ4= +github.com/oklog/ulid v1.3.1/go.mod h1:CirwcVhetQ6Lv90oh/F+FBtV6XMibvdAFo93nm5qn4U= +github.com/onsi/ginkgo v1.6.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE= +github.com/onsi/ginkgo v1.12.1/go.mod h1:zj2OWP4+oCPe1qIXoGWkgMRwljMUYCdkwsT2108oapk= +github.com/onsi/ginkgo v1.14.2 h1:8mVmC9kjFFmA8H4pKMUhcblgifdkOIXPvbhN1T36q1M= +github.com/onsi/ginkgo v1.14.2/go.mod h1:iSB4RoI2tjJc9BBv4NKIKWKya62Rps+oPG/Lv9klQyY= +github.com/onsi/gomega v1.7.1/go.mod h1:XdKZgCCFLUoM/7CFJVPcG8C1xQ1AJ0vpAezJrB7JYyY= +github.com/onsi/gomega v1.10.1/go.mod h1:iN09h71vgCQne3DLsj+A5owkum+a2tYe+TOCB1ybHNo= +github.com/onsi/gomega v1.10.5 h1:7n6FEkpFmfCoo2t+YYqXH0evK+a9ICQz0xcAy9dYcaQ= +github.com/onsi/gomega v1.10.5/go.mod h1:gza4q3jKQJijlu05nKWRCW/GavJumGt8aNRxWg7mt48= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= +github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= +github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY= +github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/tidwall/pretty v1.0.0 h1:HsD+QiTn7sK6flMKIvNmpqz1qrpP3Ps6jOKIKMooyg4= +github.com/tidwall/pretty v1.0.0/go.mod h1:XNkn88O1ChpSDQmQeStsy+sBenx6DDtFZJxhVysOjyk= +github.com/xdg-go/pbkdf2 v1.0.0/go.mod h1:jrpuAogTd400dnrH08LKmI/xc1MbPOebTwRqcT5RDeI= +github.com/xdg-go/scram v1.0.2/go.mod h1:1WAq6h33pAW+iRreB34OORO2Nf7qel3VV3fjBj+hCSs= +github.com/xdg-go/stringprep v1.0.2/go.mod h1:8F9zXuvzgwmyT5DUm4GUfZGDdT3W+LCvS6+da4O5kxM= +github.com/youmark/pkcs8 v0.0.0-20181117223130-1be2e3e5546d/go.mod h1:rHwXgn7JulP+udvsHwJoVG1YGAP6VLg4y9I5dyZdqmA= +go.mongodb.org/mongo-driver v1.7.5 h1:ny3p0reEpgsR2cfA5cjgwFZg3Cv/ofFh/8jbhGtz9VI= +go.mongodb.org/mongo-driver v1.7.5/go.mod h1:VXEWRZ6URJIkUq2SCAyapmhH0ZLRBP+FT4xhp5Zvxng= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20200302210943-78000ba7a073/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= +golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= +golang.org/x/net v0.0.0-20180906233101-161cd47e91fd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20200520004742-59133d7f0dd7/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A= +golang.org/x/net v0.0.0-20201202161906-c7110b5ffcbb h1:eBmm0M9fYhWpKZLjQUUKka/LtIxf46G4fxeEz5KJr9U= +golang.org/x/net v0.0.0-20201202161906-c7110b5ffcbb/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU= +golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20180909124046-d0be0721c37e/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190904154756-749cb33beabd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20191005200804-aed5e4c7ecf9/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20191120155948-bd437916bb0e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200519105757-fe76b779f299/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f h1:+Nyd8tzPX9R7BWHguqsrbFdRx3WQ/1ib8I44HXV5yTA= +golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= +golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.3.5 h1:i6eZZ+zk0SOf0xgBpEpPD18qWcJda6q1sxt3S0kzyUQ= +golang.org/x/text v0.3.5/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20190531172133-b3315ee88b7d/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= +golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4= +golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +google.golang.org/protobuf v0.0.0-20200109180630-ec00e32a8dfd/go.mod h1:DFci5gLYBciE7Vtevhsrf46CRTquxDuWsQurQQe4oz8= +google.golang.org/protobuf v0.0.0-20200221191635-4d8936d0db64/go.mod h1:kwYJMbMJ01Woi6D6+Kah6886xMZcty6N08ah7+eCXa0= +google.golang.org/protobuf v0.0.0-20200228230310-ab0ca4ff8a60/go.mod h1:cfTl7dwQJ+fmap5saPgwCLgHXTUD7jkjRqWcaiX5VyM= +google.golang.org/protobuf v1.20.1-0.20200309200217-e05f789c0967/go.mod h1:A+miEFZTKqfCUM6K7xSMQL9OKL/b6hQv+e19PK+JZNE= +google.golang.org/protobuf v1.21.0/go.mod h1:47Nbq4nVaFHyn7ilMalzfO3qCViNmqZ2kzikPIcrTAo= +google.golang.org/protobuf v1.23.0 h1:4MY060fB1DLGMB/7MBTLnwQUY6+F09GEiz6SsrNqyzM= +google.golang.org/protobuf v1.23.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f h1:BLraFXnmrev5lT+xlilqcH8XK9/i0At2xKjWk4p6zsU= +gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/fsnotify.v1 v1.4.7/go.mod h1:Tz8NjZHkW78fSQdbUxIjBTcgA1z1m8ZHf0WmKUhAMys= +gopkg.in/go-playground/assert.v1 v1.2.1 h1:xoYuJVE7KT85PYWrN730RguIQO0ePzVRfFMXadIrXTM= +gopkg.in/go-playground/assert.v1 v1.2.1/go.mod h1:9RXL0bg/zibRAgZUYszZSwO/z8Y/a8bDuhia5mkpMnE= +gopkg.in/go-playground/validator.v9 v9.31.0 h1:bmXmP2RSNtFES+bn4uYuHT7iJFJv7Vj+an+ZQdDaD1M= +gopkg.in/go-playground/validator.v9 v9.31.0/go.mod h1:+c9/zcJMFNgbLvly1L1V+PpxWdVbfP1avr/N00E2vyQ= +gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7 h1:uRGJdciOHaEIrze2W8Q3AKkepLTh2hOroT7a+7czfdQ= +gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7/go.mod h1:dt/ZhP58zS4L8KSrWDmTeBkI65Dw0HsyUHuEVlX15mw= +gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.3.0 h1:clyUAQHOM3G0M3f5vQj7LuJrETvjVot3Z5el9nffUtU= +gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gopkg.in/yaml.v3 v3.0.0-20200605160147-a5ece683394c h1:grhR+C34yXImVGp7EzNk+DTIk+323eIUWOmEevy6bDo= +gopkg.in/yaml.v3 v3.0.0-20200605160147-a5ece683394c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/common/github.com/IBM/vpc-go-sdk/vpcv1/vpc_v1.go b/common/github.com/IBM/vpc-go-sdk/vpcv1/vpc_v1.go new file mode 100644 index 0000000000..31a36972c6 --- /dev/null +++ b/common/github.com/IBM/vpc-go-sdk/vpcv1/vpc_v1.go @@ -0,0 +1,102829 @@ +/** + * (C) Copyright IBM Corp. 2023. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/* + * IBM OpenAPI SDK Code Generator Version: 3.78.0-67aec9b7-20230818-174940 + */ + +// Package vpcv1 : Operations and models for the VpcV1 service +package vpcv1 + +import ( + "context" + "encoding/json" + "fmt" + "net/http" + "reflect" + "strings" + "time" + + "github.com/IBM/go-sdk-core/v5/core" + common "github.com/IBM/vpc-go-sdk/common" + "github.com/go-openapi/strfmt" +) + +// VpcV1 : The IBM Cloud Virtual Private Cloud (VPC) API can be used to programmatically provision and manage virtual +// server instances, along with subnets, volumes, load balancers, and more. +// +// API Version: 2022-09-20 +type VpcV1 struct { + Service *core.BaseService + + // The infrastructure generation. For the API behavior documented here, specify + // `2`. + generation *int64 + + // The API version, in format `YYYY-MM-DD`. For the API behavior documented here, specify any date between `2022-09-13` + // and `2023-09-20`. + Version *string +} + +// DefaultServiceURL is the default URL to make service requests to. +const DefaultServiceURL = "https://us-south.iaas.cloud.ibm.com/v1" + +// DefaultServiceName is the default key used to find external configuration information. +const DefaultServiceName = "vpc" + +// VpcV1Options : Service options +type VpcV1Options struct { + ServiceName string + URL string + Authenticator core.Authenticator + + // The API version, in format `YYYY-MM-DD`. For the API behavior documented here, specify any date between `2022-09-13` + // and `2023-09-20`. + Version *string +} + +// NewVpcV1UsingExternalConfig : constructs an instance of VpcV1 with passed in options and external configuration. +func NewVpcV1UsingExternalConfig(options *VpcV1Options) (vpc *VpcV1, err error) { + if options.ServiceName == "" { + options.ServiceName = DefaultServiceName + } + + if options.Authenticator == nil { + options.Authenticator, err = core.GetAuthenticatorFromEnvironment(options.ServiceName) + if err != nil { + return + } + } + + vpc, err = NewVpcV1(options) + if err != nil { + return + } + + err = vpc.Service.ConfigureService(options.ServiceName) + if err != nil { + return + } + + if options.URL != "" { + err = vpc.Service.SetServiceURL(options.URL) + } + return +} + +// NewVpcV1 : constructs an instance of VpcV1 with passed in options. +func NewVpcV1(options *VpcV1Options) (service *VpcV1, err error) { + serviceOptions := &core.ServiceOptions{ + URL: DefaultServiceURL, + Authenticator: options.Authenticator, + } + + err = core.ValidateStruct(options, "options") + if err != nil { + return + } + + baseService, err := core.NewBaseService(serviceOptions) + if err != nil { + return + } + + if options.URL != "" { + err = baseService.SetServiceURL(options.URL) + if err != nil { + return + } + } + + if options.Version == nil { + options.Version = core.StringPtr("2023-08-08") + } + + service = &VpcV1{ + Service: baseService, + generation: core.Int64Ptr(2), + Version: options.Version, + } + + return +} + +// GetServiceURLForRegion returns the service URL to be used for the specified region +func GetServiceURLForRegion(region string) (string, error) { + return "", fmt.Errorf("service does not support regional URLs") +} + +// Clone makes a copy of "vpc" suitable for processing requests. +func (vpc *VpcV1) Clone() *VpcV1 { + if core.IsNil(vpc) { + return nil + } + clone := *vpc + clone.Service = vpc.Service.Clone() + return &clone +} + +// SetServiceURL sets the service URL +func (vpc *VpcV1) SetServiceURL(url string) error { + return vpc.Service.SetServiceURL(url) +} + +// GetServiceURL returns the service URL +func (vpc *VpcV1) GetServiceURL() string { + return vpc.Service.GetServiceURL() +} + +// SetDefaultHeaders sets HTTP headers to be sent in every request +func (vpc *VpcV1) SetDefaultHeaders(headers http.Header) { + vpc.Service.SetDefaultHeaders(headers) +} + +// SetEnableGzipCompression sets the service's EnableGzipCompression field +func (vpc *VpcV1) SetEnableGzipCompression(enableGzip bool) { + vpc.Service.SetEnableGzipCompression(enableGzip) +} + +// GetEnableGzipCompression returns the service's EnableGzipCompression field +func (vpc *VpcV1) GetEnableGzipCompression() bool { + return vpc.Service.GetEnableGzipCompression() +} + +// EnableRetries enables automatic retries for requests invoked for this service instance. +// If either parameter is specified as 0, then a default value is used instead. +func (vpc *VpcV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration) { + vpc.Service.EnableRetries(maxRetries, maxRetryInterval) +} + +// DisableRetries disables automatic retries for requests invoked for this service instance. +func (vpc *VpcV1) DisableRetries() { + vpc.Service.DisableRetries() +} + +// ListVpcs : List all VPCs +// This request lists all VPCs in the region. A VPC is a virtual network that belongs to an account and provides logical +// isolation from other networks. A VPC is made up of resources in one or more zones. VPCs are regional, and each VPC +// can contain resources in multiple zones in a region. +func (vpc *VpcV1) ListVpcs(listVpcsOptions *ListVpcsOptions) (result *VPCCollection, response *core.DetailedResponse, err error) { + return vpc.ListVpcsWithContext(context.Background(), listVpcsOptions) +} + +// ListVpcsWithContext is an alternate form of the ListVpcs method which supports a Context parameter +func (vpc *VpcV1) ListVpcsWithContext(ctx context.Context, listVpcsOptions *ListVpcsOptions) (result *VPCCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listVpcsOptions, "listVpcsOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listVpcsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListVpcs") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listVpcsOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listVpcsOptions.Start)) + } + if listVpcsOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listVpcsOptions.Limit)) + } + if listVpcsOptions.ResourceGroupID != nil { + builder.AddQuery("resource_group.id", fmt.Sprint(*listVpcsOptions.ResourceGroupID)) + } + if listVpcsOptions.ClassicAccess != nil { + builder.AddQuery("classic_access", fmt.Sprint(*listVpcsOptions.ClassicAccess)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVPCCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateVPC : Create a VPC +// This request creates a new VPC from a VPC prototype object. The prototype object is structured in the same way as a +// retrieved VPC, and contains the information necessary to create the new VPC. +func (vpc *VpcV1) CreateVPC(createVPCOptions *CreateVPCOptions) (result *VPC, response *core.DetailedResponse, err error) { + return vpc.CreateVPCWithContext(context.Background(), createVPCOptions) +} + +// CreateVPCWithContext is an alternate form of the CreateVPC method which supports a Context parameter +func (vpc *VpcV1) CreateVPCWithContext(ctx context.Context, createVPCOptions *CreateVPCOptions) (result *VPC, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(createVPCOptions, "createVPCOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs`, nil) + if err != nil { + return + } + + for headerName, headerValue := range createVPCOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateVPC") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createVPCOptions.AddressPrefixManagement != nil { + body["address_prefix_management"] = createVPCOptions.AddressPrefixManagement + } + if createVPCOptions.ClassicAccess != nil { + body["classic_access"] = createVPCOptions.ClassicAccess + } + if createVPCOptions.Dns != nil { + body["dns"] = createVPCOptions.Dns + } + if createVPCOptions.Name != nil { + body["name"] = createVPCOptions.Name + } + if createVPCOptions.ResourceGroup != nil { + body["resource_group"] = createVPCOptions.ResourceGroup + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVPC) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteVPC : Delete a VPC +// This request deletes a VPC. This operation cannot be reversed. +// +// For this request to succeed: +// - Instances, subnets, public gateways, and endpoint gateways must not reside in this VPC +// - The VPC must not be providing DNS resolution for any other VPCs +// - If `dns.enable_hub` is `true`, `dns.resolution_binding_count` must be zero +// +// All security groups and network ACLs associated with the VPC are automatically deleted. All flow log collectors with +// `auto_delete` set to `true` targeting the VPC or any resource in the VPC are automatically deleted. +func (vpc *VpcV1) DeleteVPC(deleteVPCOptions *DeleteVPCOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteVPCWithContext(context.Background(), deleteVPCOptions) +} + +// DeleteVPCWithContext is an alternate form of the DeleteVPC method which supports a Context parameter +func (vpc *VpcV1) DeleteVPCWithContext(ctx context.Context, deleteVPCOptions *DeleteVPCOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteVPCOptions, "deleteVPCOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteVPCOptions, "deleteVPCOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *deleteVPCOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteVPCOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteVPC") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + if deleteVPCOptions.IfMatch != nil { + builder.AddHeader("If-Match", fmt.Sprint(*deleteVPCOptions.IfMatch)) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetVPC : Retrieve a VPC +// This request retrieves a single VPC specified by the identifier in the URL. +func (vpc *VpcV1) GetVPC(getVPCOptions *GetVPCOptions) (result *VPC, response *core.DetailedResponse, err error) { + return vpc.GetVPCWithContext(context.Background(), getVPCOptions) +} + +// GetVPCWithContext is an alternate form of the GetVPC method which supports a Context parameter +func (vpc *VpcV1) GetVPCWithContext(ctx context.Context, getVPCOptions *GetVPCOptions) (result *VPC, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getVPCOptions, "getVPCOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getVPCOptions, "getVPCOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getVPCOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getVPCOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetVPC") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVPC) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateVPC : Update a VPC +// This request updates a VPC with the information provided in a VPC patch object. The patch object is structured in the +// same way as a retrieved VPC and needs to contain only the information to be updated. +func (vpc *VpcV1) UpdateVPC(updateVPCOptions *UpdateVPCOptions) (result *VPC, response *core.DetailedResponse, err error) { + return vpc.UpdateVPCWithContext(context.Background(), updateVPCOptions) +} + +// UpdateVPCWithContext is an alternate form of the UpdateVPC method which supports a Context parameter +func (vpc *VpcV1) UpdateVPCWithContext(ctx context.Context, updateVPCOptions *UpdateVPCOptions) (result *VPC, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateVPCOptions, "updateVPCOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateVPCOptions, "updateVPCOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *updateVPCOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateVPCOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateVPC") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + if updateVPCOptions.IfMatch != nil { + builder.AddHeader("If-Match", fmt.Sprint(*updateVPCOptions.IfMatch)) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateVPCOptions.VPCPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVPC) + if err != nil { + return + } + response.Result = result + } + + return +} + +// GetVPCDefaultNetworkACL : Retrieve a VPC's default network ACL +// This request retrieves the default network ACL for the VPC specified by the identifier in the URL. The default +// network ACL is applied to any new subnets in the VPC which do not specify a network ACL. +func (vpc *VpcV1) GetVPCDefaultNetworkACL(getVPCDefaultNetworkACLOptions *GetVPCDefaultNetworkACLOptions) (result *DefaultNetworkACL, response *core.DetailedResponse, err error) { + return vpc.GetVPCDefaultNetworkACLWithContext(context.Background(), getVPCDefaultNetworkACLOptions) +} + +// GetVPCDefaultNetworkACLWithContext is an alternate form of the GetVPCDefaultNetworkACL method which supports a Context parameter +func (vpc *VpcV1) GetVPCDefaultNetworkACLWithContext(ctx context.Context, getVPCDefaultNetworkACLOptions *GetVPCDefaultNetworkACLOptions) (result *DefaultNetworkACL, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getVPCDefaultNetworkACLOptions, "getVPCDefaultNetworkACLOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getVPCDefaultNetworkACLOptions, "getVPCDefaultNetworkACLOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getVPCDefaultNetworkACLOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{id}/default_network_acl`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getVPCDefaultNetworkACLOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetVPCDefaultNetworkACL") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalDefaultNetworkACL) + if err != nil { + return + } + response.Result = result + } + + return +} + +// GetVPCDefaultRoutingTable : Retrieve a VPC's default routing table +// This request retrieves the default routing table for the VPC specified by the identifier in the URL. The default +// routing table is associated with any subnets in the VPC which have not been explicitly associated with another +// routing table. +func (vpc *VpcV1) GetVPCDefaultRoutingTable(getVPCDefaultRoutingTableOptions *GetVPCDefaultRoutingTableOptions) (result *DefaultRoutingTable, response *core.DetailedResponse, err error) { + return vpc.GetVPCDefaultRoutingTableWithContext(context.Background(), getVPCDefaultRoutingTableOptions) +} + +// GetVPCDefaultRoutingTableWithContext is an alternate form of the GetVPCDefaultRoutingTable method which supports a Context parameter +func (vpc *VpcV1) GetVPCDefaultRoutingTableWithContext(ctx context.Context, getVPCDefaultRoutingTableOptions *GetVPCDefaultRoutingTableOptions) (result *DefaultRoutingTable, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getVPCDefaultRoutingTableOptions, "getVPCDefaultRoutingTableOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getVPCDefaultRoutingTableOptions, "getVPCDefaultRoutingTableOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getVPCDefaultRoutingTableOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{id}/default_routing_table`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getVPCDefaultRoutingTableOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetVPCDefaultRoutingTable") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalDefaultRoutingTable) + if err != nil { + return + } + response.Result = result + } + + return +} + +// GetVPCDefaultSecurityGroup : Retrieve a VPC's default security group +// This request retrieves the default security group for the VPC specified by the identifier in the URL. Resources +// created in this VPC that allow a security group to be optionally specified will use this security group by default. +func (vpc *VpcV1) GetVPCDefaultSecurityGroup(getVPCDefaultSecurityGroupOptions *GetVPCDefaultSecurityGroupOptions) (result *DefaultSecurityGroup, response *core.DetailedResponse, err error) { + return vpc.GetVPCDefaultSecurityGroupWithContext(context.Background(), getVPCDefaultSecurityGroupOptions) +} + +// GetVPCDefaultSecurityGroupWithContext is an alternate form of the GetVPCDefaultSecurityGroup method which supports a Context parameter +func (vpc *VpcV1) GetVPCDefaultSecurityGroupWithContext(ctx context.Context, getVPCDefaultSecurityGroupOptions *GetVPCDefaultSecurityGroupOptions) (result *DefaultSecurityGroup, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getVPCDefaultSecurityGroupOptions, "getVPCDefaultSecurityGroupOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getVPCDefaultSecurityGroupOptions, "getVPCDefaultSecurityGroupOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getVPCDefaultSecurityGroupOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{id}/default_security_group`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getVPCDefaultSecurityGroupOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetVPCDefaultSecurityGroup") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalDefaultSecurityGroup) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListVPCAddressPrefixes : List all address prefixes for a VPC +// This request lists all address pool prefixes for a VPC. +func (vpc *VpcV1) ListVPCAddressPrefixes(listVPCAddressPrefixesOptions *ListVPCAddressPrefixesOptions) (result *AddressPrefixCollection, response *core.DetailedResponse, err error) { + return vpc.ListVPCAddressPrefixesWithContext(context.Background(), listVPCAddressPrefixesOptions) +} + +// ListVPCAddressPrefixesWithContext is an alternate form of the ListVPCAddressPrefixes method which supports a Context parameter +func (vpc *VpcV1) ListVPCAddressPrefixesWithContext(ctx context.Context, listVPCAddressPrefixesOptions *ListVPCAddressPrefixesOptions) (result *AddressPrefixCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listVPCAddressPrefixesOptions, "listVPCAddressPrefixesOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listVPCAddressPrefixesOptions, "listVPCAddressPrefixesOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpc_id": *listVPCAddressPrefixesOptions.VPCID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{vpc_id}/address_prefixes`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listVPCAddressPrefixesOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListVPCAddressPrefixes") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listVPCAddressPrefixesOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listVPCAddressPrefixesOptions.Start)) + } + if listVPCAddressPrefixesOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listVPCAddressPrefixesOptions.Limit)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalAddressPrefixCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateVPCAddressPrefix : Create an address prefix for a VPC +// This request creates a new prefix from a prefix prototype object. The prototype object is structured in the same way +// as a retrieved prefix, and contains the information necessary to create the new prefix. +func (vpc *VpcV1) CreateVPCAddressPrefix(createVPCAddressPrefixOptions *CreateVPCAddressPrefixOptions) (result *AddressPrefix, response *core.DetailedResponse, err error) { + return vpc.CreateVPCAddressPrefixWithContext(context.Background(), createVPCAddressPrefixOptions) +} + +// CreateVPCAddressPrefixWithContext is an alternate form of the CreateVPCAddressPrefix method which supports a Context parameter +func (vpc *VpcV1) CreateVPCAddressPrefixWithContext(ctx context.Context, createVPCAddressPrefixOptions *CreateVPCAddressPrefixOptions) (result *AddressPrefix, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createVPCAddressPrefixOptions, "createVPCAddressPrefixOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createVPCAddressPrefixOptions, "createVPCAddressPrefixOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpc_id": *createVPCAddressPrefixOptions.VPCID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{vpc_id}/address_prefixes`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range createVPCAddressPrefixOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateVPCAddressPrefix") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createVPCAddressPrefixOptions.CIDR != nil { + body["cidr"] = createVPCAddressPrefixOptions.CIDR + } + if createVPCAddressPrefixOptions.Zone != nil { + body["zone"] = createVPCAddressPrefixOptions.Zone + } + if createVPCAddressPrefixOptions.IsDefault != nil { + body["is_default"] = createVPCAddressPrefixOptions.IsDefault + } + if createVPCAddressPrefixOptions.Name != nil { + body["name"] = createVPCAddressPrefixOptions.Name + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalAddressPrefix) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteVPCAddressPrefix : Delete an address prefix +// This request deletes a prefix. This operation cannot be reversed. The request will fail if any subnets use addresses +// from this prefix. +func (vpc *VpcV1) DeleteVPCAddressPrefix(deleteVPCAddressPrefixOptions *DeleteVPCAddressPrefixOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteVPCAddressPrefixWithContext(context.Background(), deleteVPCAddressPrefixOptions) +} + +// DeleteVPCAddressPrefixWithContext is an alternate form of the DeleteVPCAddressPrefix method which supports a Context parameter +func (vpc *VpcV1) DeleteVPCAddressPrefixWithContext(ctx context.Context, deleteVPCAddressPrefixOptions *DeleteVPCAddressPrefixOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteVPCAddressPrefixOptions, "deleteVPCAddressPrefixOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteVPCAddressPrefixOptions, "deleteVPCAddressPrefixOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpc_id": *deleteVPCAddressPrefixOptions.VPCID, + "id": *deleteVPCAddressPrefixOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{vpc_id}/address_prefixes/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteVPCAddressPrefixOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteVPCAddressPrefix") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetVPCAddressPrefix : Retrieve an address prefix +// This request retrieves a single prefix specified by the identifier in the URL. +func (vpc *VpcV1) GetVPCAddressPrefix(getVPCAddressPrefixOptions *GetVPCAddressPrefixOptions) (result *AddressPrefix, response *core.DetailedResponse, err error) { + return vpc.GetVPCAddressPrefixWithContext(context.Background(), getVPCAddressPrefixOptions) +} + +// GetVPCAddressPrefixWithContext is an alternate form of the GetVPCAddressPrefix method which supports a Context parameter +func (vpc *VpcV1) GetVPCAddressPrefixWithContext(ctx context.Context, getVPCAddressPrefixOptions *GetVPCAddressPrefixOptions) (result *AddressPrefix, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getVPCAddressPrefixOptions, "getVPCAddressPrefixOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getVPCAddressPrefixOptions, "getVPCAddressPrefixOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpc_id": *getVPCAddressPrefixOptions.VPCID, + "id": *getVPCAddressPrefixOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{vpc_id}/address_prefixes/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getVPCAddressPrefixOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetVPCAddressPrefix") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalAddressPrefix) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateVPCAddressPrefix : Update an address prefix +// This request updates a prefix with the information in a provided prefix patch. The prefix patch object is structured +// in the same way as a retrieved prefix and contains only the information to be updated. +func (vpc *VpcV1) UpdateVPCAddressPrefix(updateVPCAddressPrefixOptions *UpdateVPCAddressPrefixOptions) (result *AddressPrefix, response *core.DetailedResponse, err error) { + return vpc.UpdateVPCAddressPrefixWithContext(context.Background(), updateVPCAddressPrefixOptions) +} + +// UpdateVPCAddressPrefixWithContext is an alternate form of the UpdateVPCAddressPrefix method which supports a Context parameter +func (vpc *VpcV1) UpdateVPCAddressPrefixWithContext(ctx context.Context, updateVPCAddressPrefixOptions *UpdateVPCAddressPrefixOptions) (result *AddressPrefix, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateVPCAddressPrefixOptions, "updateVPCAddressPrefixOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateVPCAddressPrefixOptions, "updateVPCAddressPrefixOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpc_id": *updateVPCAddressPrefixOptions.VPCID, + "id": *updateVPCAddressPrefixOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{vpc_id}/address_prefixes/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateVPCAddressPrefixOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateVPCAddressPrefix") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateVPCAddressPrefixOptions.AddressPrefixPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalAddressPrefix) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListVPCDnsResolutionBindings : List all DNS resolution bindings for a VPC +// This request lists all DNS resolution bindings for a VPC. A DNS resolution binding represents an association with +// another VPC for centralizing DNS name resolution. +// +// If the VPC specified by the identifier in the URL is a DNS hub VPC (has `dns.enable_hub` set to `true`) then there is +// one binding for each VPC bound to the hub VPC. The endpoint gateways in the bound VPCs can allow (using +// `allow_dns_resolution_binding`) the hub VPC to centralize resolution of their DNS names. +// +// If the VPC specified by the identifier in the URL is not a DNS hub VPC, then there is at most one binding (to a hub +// VPC). The endpoint gateways in the VPC specified by the identifier in the URL can allow (using +// `allow_dns_resolution_binding`) its hub VPC to centralize resolution of their DNS names. +// +// To make use of centralized DNS resolution, a VPC bound to a DNS hub VPC must delegate DNS resolution to its hub VPC +// by setting `dns.resolver.type` to `delegate`. +// +// The bindings will be sorted by their `created_at` property values, with newest bindings first. Bindings with +// identical `created_at` property values will in turn be sorted by ascending `name` property values. +func (vpc *VpcV1) ListVPCDnsResolutionBindings(listVPCDnsResolutionBindingsOptions *ListVPCDnsResolutionBindingsOptions) (result *VpcdnsResolutionBindingCollection, response *core.DetailedResponse, err error) { + return vpc.ListVPCDnsResolutionBindingsWithContext(context.Background(), listVPCDnsResolutionBindingsOptions) +} + +// ListVPCDnsResolutionBindingsWithContext is an alternate form of the ListVPCDnsResolutionBindings method which supports a Context parameter +func (vpc *VpcV1) ListVPCDnsResolutionBindingsWithContext(ctx context.Context, listVPCDnsResolutionBindingsOptions *ListVPCDnsResolutionBindingsOptions) (result *VpcdnsResolutionBindingCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listVPCDnsResolutionBindingsOptions, "listVPCDnsResolutionBindingsOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listVPCDnsResolutionBindingsOptions, "listVPCDnsResolutionBindingsOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpc_id": *listVPCDnsResolutionBindingsOptions.VPCID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{vpc_id}/dns_resolution_bindings`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listVPCDnsResolutionBindingsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListVPCDnsResolutionBindings") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listVPCDnsResolutionBindingsOptions.Sort != nil { + builder.AddQuery("sort", fmt.Sprint(*listVPCDnsResolutionBindingsOptions.Sort)) + } + if listVPCDnsResolutionBindingsOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listVPCDnsResolutionBindingsOptions.Start)) + } + if listVPCDnsResolutionBindingsOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listVPCDnsResolutionBindingsOptions.Limit)) + } + if listVPCDnsResolutionBindingsOptions.Name != nil { + builder.AddQuery("name", fmt.Sprint(*listVPCDnsResolutionBindingsOptions.Name)) + } + if listVPCDnsResolutionBindingsOptions.VPCCRN != nil { + builder.AddQuery("vpc.crn", fmt.Sprint(*listVPCDnsResolutionBindingsOptions.VPCCRN)) + } + if listVPCDnsResolutionBindingsOptions.VPCName != nil { + builder.AddQuery("vpc.name", fmt.Sprint(*listVPCDnsResolutionBindingsOptions.VPCName)) + } + if listVPCDnsResolutionBindingsOptions.AccountID != nil { + builder.AddQuery("account.id", fmt.Sprint(*listVPCDnsResolutionBindingsOptions.AccountID)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVpcdnsResolutionBindingCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateVPCDnsResolutionBinding : Create a DNS resolution binding +// This request creates a new DNS resolution binding from a DNS resolution binding prototype object. The prototype +// object is structured in the same way as a retrieved DNS resolution binding, and contains the information necessary to +// create the new DNS resolution binding. +// +// For this request to succeed, `dns.enable_hub` must be `false` for the VPC specified by the identifier in the URL, and +// the VPC must not already have a DNS resolution binding. +// +// # TODO: finalize topic name with docs team See [Configuring endpoint gateway DNS +// sharing](/docs/vpc?topic=vpc-hub-spoke-model) for more information. +func (vpc *VpcV1) CreateVPCDnsResolutionBinding(createVPCDnsResolutionBindingOptions *CreateVPCDnsResolutionBindingOptions) (result *VpcdnsResolutionBinding, response *core.DetailedResponse, err error) { + return vpc.CreateVPCDnsResolutionBindingWithContext(context.Background(), createVPCDnsResolutionBindingOptions) +} + +// CreateVPCDnsResolutionBindingWithContext is an alternate form of the CreateVPCDnsResolutionBinding method which supports a Context parameter +func (vpc *VpcV1) CreateVPCDnsResolutionBindingWithContext(ctx context.Context, createVPCDnsResolutionBindingOptions *CreateVPCDnsResolutionBindingOptions) (result *VpcdnsResolutionBinding, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createVPCDnsResolutionBindingOptions, "createVPCDnsResolutionBindingOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createVPCDnsResolutionBindingOptions, "createVPCDnsResolutionBindingOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpc_id": *createVPCDnsResolutionBindingOptions.VPCID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{vpc_id}/dns_resolution_bindings`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range createVPCDnsResolutionBindingOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateVPCDnsResolutionBinding") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createVPCDnsResolutionBindingOptions.VPC != nil { + body["vpc"] = createVPCDnsResolutionBindingOptions.VPC + } + if createVPCDnsResolutionBindingOptions.Name != nil { + body["name"] = createVPCDnsResolutionBindingOptions.Name + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVpcdnsResolutionBinding) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteVPCDnsResolutionBinding : Delete a DNS resolution binding +// This request deletes a DNS resolution binding. This operation cannot be reversed. +// +// A DNS resolution binding for a VPC with `dns.enable_hub` set to `true` cannot be deleted. +func (vpc *VpcV1) DeleteVPCDnsResolutionBinding(deleteVPCDnsResolutionBindingOptions *DeleteVPCDnsResolutionBindingOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteVPCDnsResolutionBindingWithContext(context.Background(), deleteVPCDnsResolutionBindingOptions) +} + +// DeleteVPCDnsResolutionBindingWithContext is an alternate form of the DeleteVPCDnsResolutionBinding method which supports a Context parameter +func (vpc *VpcV1) DeleteVPCDnsResolutionBindingWithContext(ctx context.Context, deleteVPCDnsResolutionBindingOptions *DeleteVPCDnsResolutionBindingOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteVPCDnsResolutionBindingOptions, "deleteVPCDnsResolutionBindingOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteVPCDnsResolutionBindingOptions, "deleteVPCDnsResolutionBindingOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpc_id": *deleteVPCDnsResolutionBindingOptions.VPCID, + "id": *deleteVPCDnsResolutionBindingOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{vpc_id}/dns_resolution_bindings/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteVPCDnsResolutionBindingOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteVPCDnsResolutionBinding") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetVPCDnsResolutionBinding : Retrieve a DNS resolution binding +// This request retrieves a single DNS resolution binding specified by the identifier in the URL. +func (vpc *VpcV1) GetVPCDnsResolutionBinding(getVPCDnsResolutionBindingOptions *GetVPCDnsResolutionBindingOptions) (result *VpcdnsResolutionBinding, response *core.DetailedResponse, err error) { + return vpc.GetVPCDnsResolutionBindingWithContext(context.Background(), getVPCDnsResolutionBindingOptions) +} + +// GetVPCDnsResolutionBindingWithContext is an alternate form of the GetVPCDnsResolutionBinding method which supports a Context parameter +func (vpc *VpcV1) GetVPCDnsResolutionBindingWithContext(ctx context.Context, getVPCDnsResolutionBindingOptions *GetVPCDnsResolutionBindingOptions) (result *VpcdnsResolutionBinding, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getVPCDnsResolutionBindingOptions, "getVPCDnsResolutionBindingOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getVPCDnsResolutionBindingOptions, "getVPCDnsResolutionBindingOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpc_id": *getVPCDnsResolutionBindingOptions.VPCID, + "id": *getVPCDnsResolutionBindingOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{vpc_id}/dns_resolution_bindings/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getVPCDnsResolutionBindingOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetVPCDnsResolutionBinding") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVpcdnsResolutionBinding) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateVPCDnsResolutionBinding : Update a DNS resolution binding +// This request updates a DNS resolution binding with the information in a provided DNS resolution binding patch. The +// DNS resolution binding patch object is structured in the same way as a retrieved DNS resolution binding and contains +// only the information to be updated. +func (vpc *VpcV1) UpdateVPCDnsResolutionBinding(updateVPCDnsResolutionBindingOptions *UpdateVPCDnsResolutionBindingOptions) (result *VpcdnsResolutionBinding, response *core.DetailedResponse, err error) { + return vpc.UpdateVPCDnsResolutionBindingWithContext(context.Background(), updateVPCDnsResolutionBindingOptions) +} + +// UpdateVPCDnsResolutionBindingWithContext is an alternate form of the UpdateVPCDnsResolutionBinding method which supports a Context parameter +func (vpc *VpcV1) UpdateVPCDnsResolutionBindingWithContext(ctx context.Context, updateVPCDnsResolutionBindingOptions *UpdateVPCDnsResolutionBindingOptions) (result *VpcdnsResolutionBinding, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateVPCDnsResolutionBindingOptions, "updateVPCDnsResolutionBindingOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateVPCDnsResolutionBindingOptions, "updateVPCDnsResolutionBindingOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpc_id": *updateVPCDnsResolutionBindingOptions.VPCID, + "id": *updateVPCDnsResolutionBindingOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{vpc_id}/dns_resolution_bindings/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateVPCDnsResolutionBindingOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateVPCDnsResolutionBinding") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateVPCDnsResolutionBindingOptions.VpcdnsResolutionBindingPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVpcdnsResolutionBinding) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListVPCRoutes : List all routes in a VPC's default routing table +// This request lists all routes in the VPC's default routing table. Each route is zone-specific and directs any packets +// matching its destination CIDR block to a `next_hop` IP address. The most specific route matching a packet's +// destination will be used. If multiple equally-specific routes exist, traffic will be distributed across them. +// Deprecated: this method is deprecated and may be removed in a future release. +func (vpc *VpcV1) ListVPCRoutes(listVPCRoutesOptions *ListVPCRoutesOptions) (result *RouteCollectionVPCContext, response *core.DetailedResponse, err error) { + return vpc.ListVPCRoutesWithContext(context.Background(), listVPCRoutesOptions) +} + +// ListVPCRoutesWithContext is an alternate form of the ListVPCRoutes method which supports a Context parameter +// Deprecated: this method is deprecated and may be removed in a future release. +func (vpc *VpcV1) ListVPCRoutesWithContext(ctx context.Context, listVPCRoutesOptions *ListVPCRoutesOptions) (result *RouteCollectionVPCContext, response *core.DetailedResponse, err error) { + core.GetLogger().Warn("A deprecated operation has been invoked: ListVPCRoutes") + err = core.ValidateNotNil(listVPCRoutesOptions, "listVPCRoutesOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listVPCRoutesOptions, "listVPCRoutesOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpc_id": *listVPCRoutesOptions.VPCID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{vpc_id}/routes`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listVPCRoutesOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListVPCRoutes") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listVPCRoutesOptions.ZoneName != nil { + builder.AddQuery("zone.name", fmt.Sprint(*listVPCRoutesOptions.ZoneName)) + } + if listVPCRoutesOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listVPCRoutesOptions.Start)) + } + if listVPCRoutesOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listVPCRoutesOptions.Limit)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalRouteCollectionVPCContext) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateVPCRoute : Create a route in a VPC's default routing table +// This request creates a new route in the VPC's default routing table. The route prototype object is structured in the +// same way as a retrieved route, and contains the information necessary to create the new route. The request will fail +// if the new route will cause a loop. +// Deprecated: this method is deprecated and may be removed in a future release. +func (vpc *VpcV1) CreateVPCRoute(createVPCRouteOptions *CreateVPCRouteOptions) (result *Route, response *core.DetailedResponse, err error) { + return vpc.CreateVPCRouteWithContext(context.Background(), createVPCRouteOptions) +} + +// CreateVPCRouteWithContext is an alternate form of the CreateVPCRoute method which supports a Context parameter +// Deprecated: this method is deprecated and may be removed in a future release. +func (vpc *VpcV1) CreateVPCRouteWithContext(ctx context.Context, createVPCRouteOptions *CreateVPCRouteOptions) (result *Route, response *core.DetailedResponse, err error) { + core.GetLogger().Warn("A deprecated operation has been invoked: CreateVPCRoute") + err = core.ValidateNotNil(createVPCRouteOptions, "createVPCRouteOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createVPCRouteOptions, "createVPCRouteOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpc_id": *createVPCRouteOptions.VPCID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{vpc_id}/routes`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range createVPCRouteOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateVPCRoute") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createVPCRouteOptions.Destination != nil { + body["destination"] = createVPCRouteOptions.Destination + } + if createVPCRouteOptions.Zone != nil { + body["zone"] = createVPCRouteOptions.Zone + } + if createVPCRouteOptions.Action != nil { + body["action"] = createVPCRouteOptions.Action + } + if createVPCRouteOptions.Name != nil { + body["name"] = createVPCRouteOptions.Name + } + if createVPCRouteOptions.NextHop != nil { + body["next_hop"] = createVPCRouteOptions.NextHop + } + if createVPCRouteOptions.Priority != nil { + body["priority"] = createVPCRouteOptions.Priority + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalRoute) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteVPCRoute : Delete a VPC route +// This request deletes a route. This operation cannot be reversed. +// Deprecated: this method is deprecated and may be removed in a future release. +func (vpc *VpcV1) DeleteVPCRoute(deleteVPCRouteOptions *DeleteVPCRouteOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteVPCRouteWithContext(context.Background(), deleteVPCRouteOptions) +} + +// DeleteVPCRouteWithContext is an alternate form of the DeleteVPCRoute method which supports a Context parameter +// Deprecated: this method is deprecated and may be removed in a future release. +func (vpc *VpcV1) DeleteVPCRouteWithContext(ctx context.Context, deleteVPCRouteOptions *DeleteVPCRouteOptions) (response *core.DetailedResponse, err error) { + core.GetLogger().Warn("A deprecated operation has been invoked: DeleteVPCRoute") + err = core.ValidateNotNil(deleteVPCRouteOptions, "deleteVPCRouteOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteVPCRouteOptions, "deleteVPCRouteOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpc_id": *deleteVPCRouteOptions.VPCID, + "id": *deleteVPCRouteOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{vpc_id}/routes/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteVPCRouteOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteVPCRoute") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetVPCRoute : Retrieve a VPC route +// This request retrieves a single route specified by the identifier in the URL. +// Deprecated: this method is deprecated and may be removed in a future release. +func (vpc *VpcV1) GetVPCRoute(getVPCRouteOptions *GetVPCRouteOptions) (result *Route, response *core.DetailedResponse, err error) { + return vpc.GetVPCRouteWithContext(context.Background(), getVPCRouteOptions) +} + +// GetVPCRouteWithContext is an alternate form of the GetVPCRoute method which supports a Context parameter +// Deprecated: this method is deprecated and may be removed in a future release. +func (vpc *VpcV1) GetVPCRouteWithContext(ctx context.Context, getVPCRouteOptions *GetVPCRouteOptions) (result *Route, response *core.DetailedResponse, err error) { + core.GetLogger().Warn("A deprecated operation has been invoked: GetVPCRoute") + err = core.ValidateNotNil(getVPCRouteOptions, "getVPCRouteOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getVPCRouteOptions, "getVPCRouteOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpc_id": *getVPCRouteOptions.VPCID, + "id": *getVPCRouteOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{vpc_id}/routes/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getVPCRouteOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetVPCRoute") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalRoute) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateVPCRoute : Update a VPC route +// This request updates a route with the information in a provided route patch. The route patch object is structured in +// the same way as a retrieved route and contains only the information to be updated. +// Deprecated: this method is deprecated and may be removed in a future release. +func (vpc *VpcV1) UpdateVPCRoute(updateVPCRouteOptions *UpdateVPCRouteOptions) (result *Route, response *core.DetailedResponse, err error) { + return vpc.UpdateVPCRouteWithContext(context.Background(), updateVPCRouteOptions) +} + +// UpdateVPCRouteWithContext is an alternate form of the UpdateVPCRoute method which supports a Context parameter +// Deprecated: this method is deprecated and may be removed in a future release. +func (vpc *VpcV1) UpdateVPCRouteWithContext(ctx context.Context, updateVPCRouteOptions *UpdateVPCRouteOptions) (result *Route, response *core.DetailedResponse, err error) { + core.GetLogger().Warn("A deprecated operation has been invoked: UpdateVPCRoute") + err = core.ValidateNotNil(updateVPCRouteOptions, "updateVPCRouteOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateVPCRouteOptions, "updateVPCRouteOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpc_id": *updateVPCRouteOptions.VPCID, + "id": *updateVPCRouteOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{vpc_id}/routes/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateVPCRouteOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateVPCRoute") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateVPCRouteOptions.RoutePatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalRoute) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListVPCRoutingTables : List all routing tables for a VPC +// This request lists all routing tables for a VPC. Each subnet in a VPC is associated with a routing table, which +// controls delivery of packets sent on that subnet according to the action of the most specific matching route in the +// table. If multiple equally-specific routes exist, traffic will be distributed across them. If no routes match, +// delivery will be controlled by the system's built-in routes. +func (vpc *VpcV1) ListVPCRoutingTables(listVPCRoutingTablesOptions *ListVPCRoutingTablesOptions) (result *RoutingTableCollection, response *core.DetailedResponse, err error) { + return vpc.ListVPCRoutingTablesWithContext(context.Background(), listVPCRoutingTablesOptions) +} + +// ListVPCRoutingTablesWithContext is an alternate form of the ListVPCRoutingTables method which supports a Context parameter +func (vpc *VpcV1) ListVPCRoutingTablesWithContext(ctx context.Context, listVPCRoutingTablesOptions *ListVPCRoutingTablesOptions) (result *RoutingTableCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listVPCRoutingTablesOptions, "listVPCRoutingTablesOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listVPCRoutingTablesOptions, "listVPCRoutingTablesOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpc_id": *listVPCRoutingTablesOptions.VPCID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{vpc_id}/routing_tables`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listVPCRoutingTablesOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListVPCRoutingTables") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listVPCRoutingTablesOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listVPCRoutingTablesOptions.Start)) + } + if listVPCRoutingTablesOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listVPCRoutingTablesOptions.Limit)) + } + if listVPCRoutingTablesOptions.IsDefault != nil { + builder.AddQuery("is_default", fmt.Sprint(*listVPCRoutingTablesOptions.IsDefault)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalRoutingTableCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateVPCRoutingTable : Create a routing table for a VPC +// This request creates a routing table from a routing table prototype object. The prototype object is structured in the +// same way as a retrieved routing table, and contains the information necessary to create the new routing table. +func (vpc *VpcV1) CreateVPCRoutingTable(createVPCRoutingTableOptions *CreateVPCRoutingTableOptions) (result *RoutingTable, response *core.DetailedResponse, err error) { + return vpc.CreateVPCRoutingTableWithContext(context.Background(), createVPCRoutingTableOptions) +} + +// CreateVPCRoutingTableWithContext is an alternate form of the CreateVPCRoutingTable method which supports a Context parameter +func (vpc *VpcV1) CreateVPCRoutingTableWithContext(ctx context.Context, createVPCRoutingTableOptions *CreateVPCRoutingTableOptions) (result *RoutingTable, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createVPCRoutingTableOptions, "createVPCRoutingTableOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createVPCRoutingTableOptions, "createVPCRoutingTableOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpc_id": *createVPCRoutingTableOptions.VPCID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{vpc_id}/routing_tables`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range createVPCRoutingTableOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateVPCRoutingTable") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createVPCRoutingTableOptions.AcceptRoutesFrom != nil { + body["accept_routes_from"] = createVPCRoutingTableOptions.AcceptRoutesFrom + } + if createVPCRoutingTableOptions.Name != nil { + body["name"] = createVPCRoutingTableOptions.Name + } + if createVPCRoutingTableOptions.RouteDirectLinkIngress != nil { + body["route_direct_link_ingress"] = createVPCRoutingTableOptions.RouteDirectLinkIngress + } + if createVPCRoutingTableOptions.RouteInternetIngress != nil { + body["route_internet_ingress"] = createVPCRoutingTableOptions.RouteInternetIngress + } + if createVPCRoutingTableOptions.RouteTransitGatewayIngress != nil { + body["route_transit_gateway_ingress"] = createVPCRoutingTableOptions.RouteTransitGatewayIngress + } + if createVPCRoutingTableOptions.RouteVPCZoneIngress != nil { + body["route_vpc_zone_ingress"] = createVPCRoutingTableOptions.RouteVPCZoneIngress + } + if createVPCRoutingTableOptions.Routes != nil { + body["routes"] = createVPCRoutingTableOptions.Routes + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalRoutingTable) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteVPCRoutingTable : Delete a VPC routing table +// This request deletes a routing table. A routing table cannot be deleted if it is associated with any subnets in the +// VPC. Additionally, a VPC's default routing table cannot be deleted. This operation cannot be reversed. +func (vpc *VpcV1) DeleteVPCRoutingTable(deleteVPCRoutingTableOptions *DeleteVPCRoutingTableOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteVPCRoutingTableWithContext(context.Background(), deleteVPCRoutingTableOptions) +} + +// DeleteVPCRoutingTableWithContext is an alternate form of the DeleteVPCRoutingTable method which supports a Context parameter +func (vpc *VpcV1) DeleteVPCRoutingTableWithContext(ctx context.Context, deleteVPCRoutingTableOptions *DeleteVPCRoutingTableOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteVPCRoutingTableOptions, "deleteVPCRoutingTableOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteVPCRoutingTableOptions, "deleteVPCRoutingTableOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpc_id": *deleteVPCRoutingTableOptions.VPCID, + "id": *deleteVPCRoutingTableOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{vpc_id}/routing_tables/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteVPCRoutingTableOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteVPCRoutingTable") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + if deleteVPCRoutingTableOptions.IfMatch != nil { + builder.AddHeader("If-Match", fmt.Sprint(*deleteVPCRoutingTableOptions.IfMatch)) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetVPCRoutingTable : Retrieve a VPC routing table +// This request retrieves a single routing table specified by the identifier in the URL. +func (vpc *VpcV1) GetVPCRoutingTable(getVPCRoutingTableOptions *GetVPCRoutingTableOptions) (result *RoutingTable, response *core.DetailedResponse, err error) { + return vpc.GetVPCRoutingTableWithContext(context.Background(), getVPCRoutingTableOptions) +} + +// GetVPCRoutingTableWithContext is an alternate form of the GetVPCRoutingTable method which supports a Context parameter +func (vpc *VpcV1) GetVPCRoutingTableWithContext(ctx context.Context, getVPCRoutingTableOptions *GetVPCRoutingTableOptions) (result *RoutingTable, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getVPCRoutingTableOptions, "getVPCRoutingTableOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getVPCRoutingTableOptions, "getVPCRoutingTableOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpc_id": *getVPCRoutingTableOptions.VPCID, + "id": *getVPCRoutingTableOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{vpc_id}/routing_tables/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getVPCRoutingTableOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetVPCRoutingTable") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalRoutingTable) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateVPCRoutingTable : Update a VPC routing table +// This request updates a routing table with the information in a provided routing table patch. The patch object is +// structured in the same way as a retrieved table and contains only the information to be updated. +func (vpc *VpcV1) UpdateVPCRoutingTable(updateVPCRoutingTableOptions *UpdateVPCRoutingTableOptions) (result *RoutingTable, response *core.DetailedResponse, err error) { + return vpc.UpdateVPCRoutingTableWithContext(context.Background(), updateVPCRoutingTableOptions) +} + +// UpdateVPCRoutingTableWithContext is an alternate form of the UpdateVPCRoutingTable method which supports a Context parameter +func (vpc *VpcV1) UpdateVPCRoutingTableWithContext(ctx context.Context, updateVPCRoutingTableOptions *UpdateVPCRoutingTableOptions) (result *RoutingTable, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateVPCRoutingTableOptions, "updateVPCRoutingTableOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateVPCRoutingTableOptions, "updateVPCRoutingTableOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpc_id": *updateVPCRoutingTableOptions.VPCID, + "id": *updateVPCRoutingTableOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{vpc_id}/routing_tables/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateVPCRoutingTableOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateVPCRoutingTable") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + if updateVPCRoutingTableOptions.IfMatch != nil { + builder.AddHeader("If-Match", fmt.Sprint(*updateVPCRoutingTableOptions.IfMatch)) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateVPCRoutingTableOptions.RoutingTablePatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalRoutingTable) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListVPCRoutingTableRoutes : List all routes in a VPC routing table +// This request lists all routes in a VPC routing table. If subnets are associated with this routing table, delivery of +// packets sent on a subnet is performed according to the action of the most specific matching route in the table +// (provided the subnet and route are in the same zone). If multiple equally-specific routes exist, the route with the +// highest priority will be used. If two matching routes have the same destination and priority, traffic will be +// distributed between them. If no routes match, delivery will be controlled by the system's built-in routes. +func (vpc *VpcV1) ListVPCRoutingTableRoutes(listVPCRoutingTableRoutesOptions *ListVPCRoutingTableRoutesOptions) (result *RouteCollection, response *core.DetailedResponse, err error) { + return vpc.ListVPCRoutingTableRoutesWithContext(context.Background(), listVPCRoutingTableRoutesOptions) +} + +// ListVPCRoutingTableRoutesWithContext is an alternate form of the ListVPCRoutingTableRoutes method which supports a Context parameter +func (vpc *VpcV1) ListVPCRoutingTableRoutesWithContext(ctx context.Context, listVPCRoutingTableRoutesOptions *ListVPCRoutingTableRoutesOptions) (result *RouteCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listVPCRoutingTableRoutesOptions, "listVPCRoutingTableRoutesOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listVPCRoutingTableRoutesOptions, "listVPCRoutingTableRoutesOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpc_id": *listVPCRoutingTableRoutesOptions.VPCID, + "routing_table_id": *listVPCRoutingTableRoutesOptions.RoutingTableID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{vpc_id}/routing_tables/{routing_table_id}/routes`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listVPCRoutingTableRoutesOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListVPCRoutingTableRoutes") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listVPCRoutingTableRoutesOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listVPCRoutingTableRoutesOptions.Start)) + } + if listVPCRoutingTableRoutesOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listVPCRoutingTableRoutesOptions.Limit)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalRouteCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateVPCRoutingTableRoute : Create a route in a VPC routing table +// This request creates a new VPC route from a VPC route prototype object. The prototype object is structured in the +// same way as a retrieved VPC route and contains the information necessary to create the route. +func (vpc *VpcV1) CreateVPCRoutingTableRoute(createVPCRoutingTableRouteOptions *CreateVPCRoutingTableRouteOptions) (result *Route, response *core.DetailedResponse, err error) { + return vpc.CreateVPCRoutingTableRouteWithContext(context.Background(), createVPCRoutingTableRouteOptions) +} + +// CreateVPCRoutingTableRouteWithContext is an alternate form of the CreateVPCRoutingTableRoute method which supports a Context parameter +func (vpc *VpcV1) CreateVPCRoutingTableRouteWithContext(ctx context.Context, createVPCRoutingTableRouteOptions *CreateVPCRoutingTableRouteOptions) (result *Route, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createVPCRoutingTableRouteOptions, "createVPCRoutingTableRouteOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createVPCRoutingTableRouteOptions, "createVPCRoutingTableRouteOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpc_id": *createVPCRoutingTableRouteOptions.VPCID, + "routing_table_id": *createVPCRoutingTableRouteOptions.RoutingTableID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{vpc_id}/routing_tables/{routing_table_id}/routes`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range createVPCRoutingTableRouteOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateVPCRoutingTableRoute") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createVPCRoutingTableRouteOptions.Destination != nil { + body["destination"] = createVPCRoutingTableRouteOptions.Destination + } + if createVPCRoutingTableRouteOptions.Zone != nil { + body["zone"] = createVPCRoutingTableRouteOptions.Zone + } + if createVPCRoutingTableRouteOptions.Action != nil { + body["action"] = createVPCRoutingTableRouteOptions.Action + } + if createVPCRoutingTableRouteOptions.Name != nil { + body["name"] = createVPCRoutingTableRouteOptions.Name + } + if createVPCRoutingTableRouteOptions.NextHop != nil { + body["next_hop"] = createVPCRoutingTableRouteOptions.NextHop + } + if createVPCRoutingTableRouteOptions.Priority != nil { + body["priority"] = createVPCRoutingTableRouteOptions.Priority + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalRoute) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteVPCRoutingTableRoute : Delete a VPC routing table route +// This request deletes a VPC route. This operation cannot be reversed. Only VPC routes with an `origin` of `user` are +// allowed to be deleted. +func (vpc *VpcV1) DeleteVPCRoutingTableRoute(deleteVPCRoutingTableRouteOptions *DeleteVPCRoutingTableRouteOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteVPCRoutingTableRouteWithContext(context.Background(), deleteVPCRoutingTableRouteOptions) +} + +// DeleteVPCRoutingTableRouteWithContext is an alternate form of the DeleteVPCRoutingTableRoute method which supports a Context parameter +func (vpc *VpcV1) DeleteVPCRoutingTableRouteWithContext(ctx context.Context, deleteVPCRoutingTableRouteOptions *DeleteVPCRoutingTableRouteOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteVPCRoutingTableRouteOptions, "deleteVPCRoutingTableRouteOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteVPCRoutingTableRouteOptions, "deleteVPCRoutingTableRouteOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpc_id": *deleteVPCRoutingTableRouteOptions.VPCID, + "routing_table_id": *deleteVPCRoutingTableRouteOptions.RoutingTableID, + "id": *deleteVPCRoutingTableRouteOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{vpc_id}/routing_tables/{routing_table_id}/routes/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteVPCRoutingTableRouteOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteVPCRoutingTableRoute") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetVPCRoutingTableRoute : Retrieve a VPC routing table route +// This request retrieves a single VPC route specified by the identifier in the URL path. +func (vpc *VpcV1) GetVPCRoutingTableRoute(getVPCRoutingTableRouteOptions *GetVPCRoutingTableRouteOptions) (result *Route, response *core.DetailedResponse, err error) { + return vpc.GetVPCRoutingTableRouteWithContext(context.Background(), getVPCRoutingTableRouteOptions) +} + +// GetVPCRoutingTableRouteWithContext is an alternate form of the GetVPCRoutingTableRoute method which supports a Context parameter +func (vpc *VpcV1) GetVPCRoutingTableRouteWithContext(ctx context.Context, getVPCRoutingTableRouteOptions *GetVPCRoutingTableRouteOptions) (result *Route, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getVPCRoutingTableRouteOptions, "getVPCRoutingTableRouteOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getVPCRoutingTableRouteOptions, "getVPCRoutingTableRouteOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpc_id": *getVPCRoutingTableRouteOptions.VPCID, + "routing_table_id": *getVPCRoutingTableRouteOptions.RoutingTableID, + "id": *getVPCRoutingTableRouteOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{vpc_id}/routing_tables/{routing_table_id}/routes/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getVPCRoutingTableRouteOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetVPCRoutingTableRoute") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalRoute) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateVPCRoutingTableRoute : Update a VPC routing table route +// This request updates a VPC route with the information provided in a route patch object. The patch object is +// structured in the same way as a retrieved VPC route and needs to contain only the information to be updated. Only VPC +// routes with an `origin` of `user` are allowed to be updated. +func (vpc *VpcV1) UpdateVPCRoutingTableRoute(updateVPCRoutingTableRouteOptions *UpdateVPCRoutingTableRouteOptions) (result *Route, response *core.DetailedResponse, err error) { + return vpc.UpdateVPCRoutingTableRouteWithContext(context.Background(), updateVPCRoutingTableRouteOptions) +} + +// UpdateVPCRoutingTableRouteWithContext is an alternate form of the UpdateVPCRoutingTableRoute method which supports a Context parameter +func (vpc *VpcV1) UpdateVPCRoutingTableRouteWithContext(ctx context.Context, updateVPCRoutingTableRouteOptions *UpdateVPCRoutingTableRouteOptions) (result *Route, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateVPCRoutingTableRouteOptions, "updateVPCRoutingTableRouteOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateVPCRoutingTableRouteOptions, "updateVPCRoutingTableRouteOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpc_id": *updateVPCRoutingTableRouteOptions.VPCID, + "routing_table_id": *updateVPCRoutingTableRouteOptions.RoutingTableID, + "id": *updateVPCRoutingTableRouteOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpcs/{vpc_id}/routing_tables/{routing_table_id}/routes/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateVPCRoutingTableRouteOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateVPCRoutingTableRoute") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateVPCRoutingTableRouteOptions.RoutePatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalRoute) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListSubnets : List all subnets +// This request lists all subnets in the region. Subnets are contiguous ranges of IP addresses specified in CIDR block +// notation. Each subnet is within a particular zone and cannot span multiple zones or regions. +func (vpc *VpcV1) ListSubnets(listSubnetsOptions *ListSubnetsOptions) (result *SubnetCollection, response *core.DetailedResponse, err error) { + return vpc.ListSubnetsWithContext(context.Background(), listSubnetsOptions) +} + +// ListSubnetsWithContext is an alternate form of the ListSubnets method which supports a Context parameter +func (vpc *VpcV1) ListSubnetsWithContext(ctx context.Context, listSubnetsOptions *ListSubnetsOptions) (result *SubnetCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listSubnetsOptions, "listSubnetsOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/subnets`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listSubnetsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListSubnets") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listSubnetsOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listSubnetsOptions.Start)) + } + if listSubnetsOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listSubnetsOptions.Limit)) + } + if listSubnetsOptions.ResourceGroupID != nil { + builder.AddQuery("resource_group.id", fmt.Sprint(*listSubnetsOptions.ResourceGroupID)) + } + if listSubnetsOptions.ZoneName != nil { + builder.AddQuery("zone.name", fmt.Sprint(*listSubnetsOptions.ZoneName)) + } + if listSubnetsOptions.VPCID != nil { + builder.AddQuery("vpc.id", fmt.Sprint(*listSubnetsOptions.VPCID)) + } + if listSubnetsOptions.VPCCRN != nil { + builder.AddQuery("vpc.crn", fmt.Sprint(*listSubnetsOptions.VPCCRN)) + } + if listSubnetsOptions.VPCName != nil { + builder.AddQuery("vpc.name", fmt.Sprint(*listSubnetsOptions.VPCName)) + } + if listSubnetsOptions.RoutingTableID != nil { + builder.AddQuery("routing_table.id", fmt.Sprint(*listSubnetsOptions.RoutingTableID)) + } + if listSubnetsOptions.RoutingTableName != nil { + builder.AddQuery("routing_table.name", fmt.Sprint(*listSubnetsOptions.RoutingTableName)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalSubnetCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateSubnet : Create a subnet +// This request creates a new subnet from a subnet prototype object. The prototype object is structured in the same way +// as a retrieved subnet, and contains the information necessary to create the new subnet. For this request to succeed, +// the prototype's CIDR block must not overlap with an existing subnet in the VPC. +func (vpc *VpcV1) CreateSubnet(createSubnetOptions *CreateSubnetOptions) (result *Subnet, response *core.DetailedResponse, err error) { + return vpc.CreateSubnetWithContext(context.Background(), createSubnetOptions) +} + +// CreateSubnetWithContext is an alternate form of the CreateSubnet method which supports a Context parameter +func (vpc *VpcV1) CreateSubnetWithContext(ctx context.Context, createSubnetOptions *CreateSubnetOptions) (result *Subnet, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createSubnetOptions, "createSubnetOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createSubnetOptions, "createSubnetOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/subnets`, nil) + if err != nil { + return + } + + for headerName, headerValue := range createSubnetOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateSubnet") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(createSubnetOptions.SubnetPrototype) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalSubnet) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteSubnet : Delete a subnet +// This request deletes a subnet. This operation cannot be reversed. For this request to succeed, the subnet must not be +// referenced by any bare metal server network interfaces, instance network interfaces, VPN gateways, or load balancers. +// A delete operation automatically detaches the subnet from any network ACLs, public gateways, or endpoint gateways. +// All flow log collectors with `auto_delete` set to `true` targeting the subnet or any resource in the subnet are +// automatically deleted. +func (vpc *VpcV1) DeleteSubnet(deleteSubnetOptions *DeleteSubnetOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteSubnetWithContext(context.Background(), deleteSubnetOptions) +} + +// DeleteSubnetWithContext is an alternate form of the DeleteSubnet method which supports a Context parameter +func (vpc *VpcV1) DeleteSubnetWithContext(ctx context.Context, deleteSubnetOptions *DeleteSubnetOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteSubnetOptions, "deleteSubnetOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteSubnetOptions, "deleteSubnetOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *deleteSubnetOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/subnets/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteSubnetOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteSubnet") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetSubnet : Retrieve a subnet +// This request retrieves a single subnet specified by the identifier in the URL. +func (vpc *VpcV1) GetSubnet(getSubnetOptions *GetSubnetOptions) (result *Subnet, response *core.DetailedResponse, err error) { + return vpc.GetSubnetWithContext(context.Background(), getSubnetOptions) +} + +// GetSubnetWithContext is an alternate form of the GetSubnet method which supports a Context parameter +func (vpc *VpcV1) GetSubnetWithContext(ctx context.Context, getSubnetOptions *GetSubnetOptions) (result *Subnet, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getSubnetOptions, "getSubnetOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getSubnetOptions, "getSubnetOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getSubnetOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/subnets/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getSubnetOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetSubnet") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalSubnet) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateSubnet : Update a subnet +// This request updates a subnet with the information in a provided subnet patch. The subnet patch object is structured +// in the same way as a retrieved subnet and contains only the information to be updated. +func (vpc *VpcV1) UpdateSubnet(updateSubnetOptions *UpdateSubnetOptions) (result *Subnet, response *core.DetailedResponse, err error) { + return vpc.UpdateSubnetWithContext(context.Background(), updateSubnetOptions) +} + +// UpdateSubnetWithContext is an alternate form of the UpdateSubnet method which supports a Context parameter +func (vpc *VpcV1) UpdateSubnetWithContext(ctx context.Context, updateSubnetOptions *UpdateSubnetOptions) (result *Subnet, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateSubnetOptions, "updateSubnetOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateSubnetOptions, "updateSubnetOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *updateSubnetOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/subnets/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateSubnetOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateSubnet") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateSubnetOptions.SubnetPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalSubnet) + if err != nil { + return + } + response.Result = result + } + + return +} + +// GetSubnetNetworkACL : Retrieve a subnet's attached network ACL +// This request retrieves the network ACL attached to the subnet specified by the identifier in the URL. +func (vpc *VpcV1) GetSubnetNetworkACL(getSubnetNetworkACLOptions *GetSubnetNetworkACLOptions) (result *NetworkACL, response *core.DetailedResponse, err error) { + return vpc.GetSubnetNetworkACLWithContext(context.Background(), getSubnetNetworkACLOptions) +} + +// GetSubnetNetworkACLWithContext is an alternate form of the GetSubnetNetworkACL method which supports a Context parameter +func (vpc *VpcV1) GetSubnetNetworkACLWithContext(ctx context.Context, getSubnetNetworkACLOptions *GetSubnetNetworkACLOptions) (result *NetworkACL, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getSubnetNetworkACLOptions, "getSubnetNetworkACLOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getSubnetNetworkACLOptions, "getSubnetNetworkACLOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getSubnetNetworkACLOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/subnets/{id}/network_acl`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getSubnetNetworkACLOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetSubnetNetworkACL") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalNetworkACL) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ReplaceSubnetNetworkACL : Replace the network ACL for a subnet +// This request replaces the existing network ACL for a subnet with the network ACL specified in the request body. +func (vpc *VpcV1) ReplaceSubnetNetworkACL(replaceSubnetNetworkACLOptions *ReplaceSubnetNetworkACLOptions) (result *NetworkACL, response *core.DetailedResponse, err error) { + return vpc.ReplaceSubnetNetworkACLWithContext(context.Background(), replaceSubnetNetworkACLOptions) +} + +// ReplaceSubnetNetworkACLWithContext is an alternate form of the ReplaceSubnetNetworkACL method which supports a Context parameter +func (vpc *VpcV1) ReplaceSubnetNetworkACLWithContext(ctx context.Context, replaceSubnetNetworkACLOptions *ReplaceSubnetNetworkACLOptions) (result *NetworkACL, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(replaceSubnetNetworkACLOptions, "replaceSubnetNetworkACLOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(replaceSubnetNetworkACLOptions, "replaceSubnetNetworkACLOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *replaceSubnetNetworkACLOptions.ID, + } + + builder := core.NewRequestBuilder(core.PUT) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/subnets/{id}/network_acl`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range replaceSubnetNetworkACLOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ReplaceSubnetNetworkACL") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(replaceSubnetNetworkACLOptions.NetworkACLIdentity) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalNetworkACL) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UnsetSubnetPublicGateway : Detach a public gateway from a subnet +// This request detaches the public gateway from the subnet specified by the subnet identifier in the URL. +func (vpc *VpcV1) UnsetSubnetPublicGateway(unsetSubnetPublicGatewayOptions *UnsetSubnetPublicGatewayOptions) (response *core.DetailedResponse, err error) { + return vpc.UnsetSubnetPublicGatewayWithContext(context.Background(), unsetSubnetPublicGatewayOptions) +} + +// UnsetSubnetPublicGatewayWithContext is an alternate form of the UnsetSubnetPublicGateway method which supports a Context parameter +func (vpc *VpcV1) UnsetSubnetPublicGatewayWithContext(ctx context.Context, unsetSubnetPublicGatewayOptions *UnsetSubnetPublicGatewayOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(unsetSubnetPublicGatewayOptions, "unsetSubnetPublicGatewayOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(unsetSubnetPublicGatewayOptions, "unsetSubnetPublicGatewayOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *unsetSubnetPublicGatewayOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/subnets/{id}/public_gateway`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range unsetSubnetPublicGatewayOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UnsetSubnetPublicGateway") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetSubnetPublicGateway : Retrieve a subnet's attached public gateway +// This request retrieves the public gateway attached to the subnet specified by the identifier in the URL. +func (vpc *VpcV1) GetSubnetPublicGateway(getSubnetPublicGatewayOptions *GetSubnetPublicGatewayOptions) (result *PublicGateway, response *core.DetailedResponse, err error) { + return vpc.GetSubnetPublicGatewayWithContext(context.Background(), getSubnetPublicGatewayOptions) +} + +// GetSubnetPublicGatewayWithContext is an alternate form of the GetSubnetPublicGateway method which supports a Context parameter +func (vpc *VpcV1) GetSubnetPublicGatewayWithContext(ctx context.Context, getSubnetPublicGatewayOptions *GetSubnetPublicGatewayOptions) (result *PublicGateway, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getSubnetPublicGatewayOptions, "getSubnetPublicGatewayOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getSubnetPublicGatewayOptions, "getSubnetPublicGatewayOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getSubnetPublicGatewayOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/subnets/{id}/public_gateway`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getSubnetPublicGatewayOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetSubnetPublicGateway") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalPublicGateway) + if err != nil { + return + } + response.Result = result + } + + return +} + +// SetSubnetPublicGateway : Attach a public gateway to a subnet +// This request attaches the public gateway, specified in the request body, to the subnet specified by the subnet +// identifier in the URL. The public gateway must have the same VPC and zone as the subnet. +func (vpc *VpcV1) SetSubnetPublicGateway(setSubnetPublicGatewayOptions *SetSubnetPublicGatewayOptions) (result *PublicGateway, response *core.DetailedResponse, err error) { + return vpc.SetSubnetPublicGatewayWithContext(context.Background(), setSubnetPublicGatewayOptions) +} + +// SetSubnetPublicGatewayWithContext is an alternate form of the SetSubnetPublicGateway method which supports a Context parameter +func (vpc *VpcV1) SetSubnetPublicGatewayWithContext(ctx context.Context, setSubnetPublicGatewayOptions *SetSubnetPublicGatewayOptions) (result *PublicGateway, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(setSubnetPublicGatewayOptions, "setSubnetPublicGatewayOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(setSubnetPublicGatewayOptions, "setSubnetPublicGatewayOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *setSubnetPublicGatewayOptions.ID, + } + + builder := core.NewRequestBuilder(core.PUT) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/subnets/{id}/public_gateway`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range setSubnetPublicGatewayOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "SetSubnetPublicGateway") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(setSubnetPublicGatewayOptions.PublicGatewayIdentity) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalPublicGateway) + if err != nil { + return + } + response.Result = result + } + + return +} + +// GetSubnetRoutingTable : Retrieve a subnet's attached routing table +// This request retrieves the routing table attached to the subnet specified by the identifier in the URL. +func (vpc *VpcV1) GetSubnetRoutingTable(getSubnetRoutingTableOptions *GetSubnetRoutingTableOptions) (result *RoutingTable, response *core.DetailedResponse, err error) { + return vpc.GetSubnetRoutingTableWithContext(context.Background(), getSubnetRoutingTableOptions) +} + +// GetSubnetRoutingTableWithContext is an alternate form of the GetSubnetRoutingTable method which supports a Context parameter +func (vpc *VpcV1) GetSubnetRoutingTableWithContext(ctx context.Context, getSubnetRoutingTableOptions *GetSubnetRoutingTableOptions) (result *RoutingTable, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getSubnetRoutingTableOptions, "getSubnetRoutingTableOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getSubnetRoutingTableOptions, "getSubnetRoutingTableOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getSubnetRoutingTableOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/subnets/{id}/routing_table`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getSubnetRoutingTableOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetSubnetRoutingTable") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalRoutingTable) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ReplaceSubnetRoutingTable : Replace the routing table for a subnet +// This request replaces the existing routing table for a subnet with the routing table specified in the request body. +// +// For this request to succeed, the routing table `route_direct_link_ingress`, +// `route_transit_gateway_ingress`, and `route_vpc_zone_ingress` properties must be `false`. +func (vpc *VpcV1) ReplaceSubnetRoutingTable(replaceSubnetRoutingTableOptions *ReplaceSubnetRoutingTableOptions) (result *RoutingTable, response *core.DetailedResponse, err error) { + return vpc.ReplaceSubnetRoutingTableWithContext(context.Background(), replaceSubnetRoutingTableOptions) +} + +// ReplaceSubnetRoutingTableWithContext is an alternate form of the ReplaceSubnetRoutingTable method which supports a Context parameter +func (vpc *VpcV1) ReplaceSubnetRoutingTableWithContext(ctx context.Context, replaceSubnetRoutingTableOptions *ReplaceSubnetRoutingTableOptions) (result *RoutingTable, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(replaceSubnetRoutingTableOptions, "replaceSubnetRoutingTableOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(replaceSubnetRoutingTableOptions, "replaceSubnetRoutingTableOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *replaceSubnetRoutingTableOptions.ID, + } + + builder := core.NewRequestBuilder(core.PUT) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/subnets/{id}/routing_table`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range replaceSubnetRoutingTableOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ReplaceSubnetRoutingTable") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(replaceSubnetRoutingTableOptions.RoutingTableIdentity) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalRoutingTable) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListSubnetReservedIps : List all reserved IPs in a subnet +// This request lists all reserved IPs in a subnet. A reserved IP resource will exist for every address in the subnet +// which is not available for use. +func (vpc *VpcV1) ListSubnetReservedIps(listSubnetReservedIpsOptions *ListSubnetReservedIpsOptions) (result *ReservedIPCollection, response *core.DetailedResponse, err error) { + return vpc.ListSubnetReservedIpsWithContext(context.Background(), listSubnetReservedIpsOptions) +} + +// ListSubnetReservedIpsWithContext is an alternate form of the ListSubnetReservedIps method which supports a Context parameter +func (vpc *VpcV1) ListSubnetReservedIpsWithContext(ctx context.Context, listSubnetReservedIpsOptions *ListSubnetReservedIpsOptions) (result *ReservedIPCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listSubnetReservedIpsOptions, "listSubnetReservedIpsOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listSubnetReservedIpsOptions, "listSubnetReservedIpsOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "subnet_id": *listSubnetReservedIpsOptions.SubnetID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/subnets/{subnet_id}/reserved_ips`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listSubnetReservedIpsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListSubnetReservedIps") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listSubnetReservedIpsOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listSubnetReservedIpsOptions.Start)) + } + if listSubnetReservedIpsOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listSubnetReservedIpsOptions.Limit)) + } + if listSubnetReservedIpsOptions.Sort != nil { + builder.AddQuery("sort", fmt.Sprint(*listSubnetReservedIpsOptions.Sort)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalReservedIPCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateSubnetReservedIP : Reserve an IP in a subnet +// This request reserves an IP address in a subnet. If the provided prototype object includes an `address`, the address +// must not already be reserved. +func (vpc *VpcV1) CreateSubnetReservedIP(createSubnetReservedIPOptions *CreateSubnetReservedIPOptions) (result *ReservedIP, response *core.DetailedResponse, err error) { + return vpc.CreateSubnetReservedIPWithContext(context.Background(), createSubnetReservedIPOptions) +} + +// CreateSubnetReservedIPWithContext is an alternate form of the CreateSubnetReservedIP method which supports a Context parameter +func (vpc *VpcV1) CreateSubnetReservedIPWithContext(ctx context.Context, createSubnetReservedIPOptions *CreateSubnetReservedIPOptions) (result *ReservedIP, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createSubnetReservedIPOptions, "createSubnetReservedIPOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createSubnetReservedIPOptions, "createSubnetReservedIPOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "subnet_id": *createSubnetReservedIPOptions.SubnetID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/subnets/{subnet_id}/reserved_ips`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range createSubnetReservedIPOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateSubnetReservedIP") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createSubnetReservedIPOptions.Address != nil { + body["address"] = createSubnetReservedIPOptions.Address + } + if createSubnetReservedIPOptions.AutoDelete != nil { + body["auto_delete"] = createSubnetReservedIPOptions.AutoDelete + } + if createSubnetReservedIPOptions.Name != nil { + body["name"] = createSubnetReservedIPOptions.Name + } + if createSubnetReservedIPOptions.Target != nil { + body["target"] = createSubnetReservedIPOptions.Target + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalReservedIP) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteSubnetReservedIP : Delete a reserved IP +// This request releases a reserved IP. This operation cannot be reversed. +// +// For this request to succeed, the reserved IP must not be required by another resource, such as a bare metal server +// network interface or instance network interface for which it is the primary IP. A provider-owned reserved IP is not +// allowed to be deleted. +func (vpc *VpcV1) DeleteSubnetReservedIP(deleteSubnetReservedIPOptions *DeleteSubnetReservedIPOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteSubnetReservedIPWithContext(context.Background(), deleteSubnetReservedIPOptions) +} + +// DeleteSubnetReservedIPWithContext is an alternate form of the DeleteSubnetReservedIP method which supports a Context parameter +func (vpc *VpcV1) DeleteSubnetReservedIPWithContext(ctx context.Context, deleteSubnetReservedIPOptions *DeleteSubnetReservedIPOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteSubnetReservedIPOptions, "deleteSubnetReservedIPOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteSubnetReservedIPOptions, "deleteSubnetReservedIPOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "subnet_id": *deleteSubnetReservedIPOptions.SubnetID, + "id": *deleteSubnetReservedIPOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/subnets/{subnet_id}/reserved_ips/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteSubnetReservedIPOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteSubnetReservedIP") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetSubnetReservedIP : Retrieve a reserved IP +// This request retrieves a single reserved IP specified by the identifier in the URL. +func (vpc *VpcV1) GetSubnetReservedIP(getSubnetReservedIPOptions *GetSubnetReservedIPOptions) (result *ReservedIP, response *core.DetailedResponse, err error) { + return vpc.GetSubnetReservedIPWithContext(context.Background(), getSubnetReservedIPOptions) +} + +// GetSubnetReservedIPWithContext is an alternate form of the GetSubnetReservedIP method which supports a Context parameter +func (vpc *VpcV1) GetSubnetReservedIPWithContext(ctx context.Context, getSubnetReservedIPOptions *GetSubnetReservedIPOptions) (result *ReservedIP, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getSubnetReservedIPOptions, "getSubnetReservedIPOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getSubnetReservedIPOptions, "getSubnetReservedIPOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "subnet_id": *getSubnetReservedIPOptions.SubnetID, + "id": *getSubnetReservedIPOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/subnets/{subnet_id}/reserved_ips/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getSubnetReservedIPOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetSubnetReservedIP") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalReservedIP) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateSubnetReservedIP : Update a reserved IP +// This request updates a reserved IP with the information in a provided reserved IP patch. The reserved IP patch object +// is structured in the same way as a retrieved reserved IP and contains only the information to be updated. +// +// A provider-owned reserved IP is not allowed to be updated. +func (vpc *VpcV1) UpdateSubnetReservedIP(updateSubnetReservedIPOptions *UpdateSubnetReservedIPOptions) (result *ReservedIP, response *core.DetailedResponse, err error) { + return vpc.UpdateSubnetReservedIPWithContext(context.Background(), updateSubnetReservedIPOptions) +} + +// UpdateSubnetReservedIPWithContext is an alternate form of the UpdateSubnetReservedIP method which supports a Context parameter +func (vpc *VpcV1) UpdateSubnetReservedIPWithContext(ctx context.Context, updateSubnetReservedIPOptions *UpdateSubnetReservedIPOptions) (result *ReservedIP, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateSubnetReservedIPOptions, "updateSubnetReservedIPOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateSubnetReservedIPOptions, "updateSubnetReservedIPOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "subnet_id": *updateSubnetReservedIPOptions.SubnetID, + "id": *updateSubnetReservedIPOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/subnets/{subnet_id}/reserved_ips/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateSubnetReservedIPOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateSubnetReservedIP") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateSubnetReservedIPOptions.ReservedIPPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalReservedIP) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListImages : List all images +// This request lists all images available in the region. An image provides source data for a volume. Images are either +// system-provided, or created from another source, such as importing from Cloud Object Storage. +func (vpc *VpcV1) ListImages(listImagesOptions *ListImagesOptions) (result *ImageCollection, response *core.DetailedResponse, err error) { + return vpc.ListImagesWithContext(context.Background(), listImagesOptions) +} + +// ListImagesWithContext is an alternate form of the ListImages method which supports a Context parameter +func (vpc *VpcV1) ListImagesWithContext(ctx context.Context, listImagesOptions *ListImagesOptions) (result *ImageCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listImagesOptions, "listImagesOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/images`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listImagesOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListImages") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listImagesOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listImagesOptions.Start)) + } + if listImagesOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listImagesOptions.Limit)) + } + if listImagesOptions.ResourceGroupID != nil { + builder.AddQuery("resource_group.id", fmt.Sprint(*listImagesOptions.ResourceGroupID)) + } + if listImagesOptions.Name != nil { + builder.AddQuery("name", fmt.Sprint(*listImagesOptions.Name)) + } + if listImagesOptions.Status != nil { + builder.AddQuery("status", strings.Join(listImagesOptions.Status, ",")) + } + if listImagesOptions.Visibility != nil { + builder.AddQuery("visibility", fmt.Sprint(*listImagesOptions.Visibility)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalImageCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateImage : Create an image +// This request creates a new image from an image prototype object. The prototype object is structured in the same way +// as a retrieved image, and contains the information necessary to create the new image. If an image is being imported, +// a URL to the image file on object storage must be specified. If an image is being created from an existing volume, +// that volume must be specified. +func (vpc *VpcV1) CreateImage(createImageOptions *CreateImageOptions) (result *Image, response *core.DetailedResponse, err error) { + return vpc.CreateImageWithContext(context.Background(), createImageOptions) +} + +// CreateImageWithContext is an alternate form of the CreateImage method which supports a Context parameter +func (vpc *VpcV1) CreateImageWithContext(ctx context.Context, createImageOptions *CreateImageOptions) (result *Image, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createImageOptions, "createImageOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createImageOptions, "createImageOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/images`, nil) + if err != nil { + return + } + + for headerName, headerValue := range createImageOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateImage") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(createImageOptions.ImagePrototype) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalImage) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteImage : Delete an image +// This request deletes an image. Any active image export jobs will be completed first. This operation cannot be +// reversed. A system-provided image is not allowed to be deleted. Additionally, an image cannot be deleted if it: +// - has a `status` of `deleting` +// - has a `status` of `pending` with a `status_reasons` code of `image_request_in_progress` +// - has `catalog_offering.managed` set to `true`. +func (vpc *VpcV1) DeleteImage(deleteImageOptions *DeleteImageOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteImageWithContext(context.Background(), deleteImageOptions) +} + +// DeleteImageWithContext is an alternate form of the DeleteImage method which supports a Context parameter +func (vpc *VpcV1) DeleteImageWithContext(ctx context.Context, deleteImageOptions *DeleteImageOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteImageOptions, "deleteImageOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteImageOptions, "deleteImageOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *deleteImageOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/images/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteImageOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteImage") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetImage : Retrieve an image +// This request retrieves a single image specified by the identifier in the URL. +func (vpc *VpcV1) GetImage(getImageOptions *GetImageOptions) (result *Image, response *core.DetailedResponse, err error) { + return vpc.GetImageWithContext(context.Background(), getImageOptions) +} + +// GetImageWithContext is an alternate form of the GetImage method which supports a Context parameter +func (vpc *VpcV1) GetImageWithContext(ctx context.Context, getImageOptions *GetImageOptions) (result *Image, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getImageOptions, "getImageOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getImageOptions, "getImageOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getImageOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/images/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getImageOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetImage") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalImage) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateImage : Update an image +// This request updates an image with the information in a provided image patch. The image patch object is structured in +// the same way as a retrieved image and contains only the information to be updated. A system-provided image is not +// allowed to be updated. An image with a `status` of `deleting` cannot be updated. +func (vpc *VpcV1) UpdateImage(updateImageOptions *UpdateImageOptions) (result *Image, response *core.DetailedResponse, err error) { + return vpc.UpdateImageWithContext(context.Background(), updateImageOptions) +} + +// UpdateImageWithContext is an alternate form of the UpdateImage method which supports a Context parameter +func (vpc *VpcV1) UpdateImageWithContext(ctx context.Context, updateImageOptions *UpdateImageOptions) (result *Image, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateImageOptions, "updateImageOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateImageOptions, "updateImageOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *updateImageOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/images/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateImageOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateImage") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateImageOptions.ImagePatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalImage) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeprecateImage : Deprecate an image +// This request deprecates an image, resulting in its `status` becoming `deprecated` and +// `deprecation_at` being set to the current date and time. +// +// The image must: +// - have a `status` of `available` +// - have `catalog_offering.managed` set to `false` +// - not have `deprecation_at` set +// +// The image must not have `deprecation_at` set, must have `catalog_offering.managed` set to +// `false`, and must have a `status` of `available`. +// +// A system-provided image is not allowed to be deprecated. +func (vpc *VpcV1) DeprecateImage(deprecateImageOptions *DeprecateImageOptions) (response *core.DetailedResponse, err error) { + return vpc.DeprecateImageWithContext(context.Background(), deprecateImageOptions) +} + +// DeprecateImageWithContext is an alternate form of the DeprecateImage method which supports a Context parameter +func (vpc *VpcV1) DeprecateImageWithContext(ctx context.Context, deprecateImageOptions *DeprecateImageOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deprecateImageOptions, "deprecateImageOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deprecateImageOptions, "deprecateImageOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *deprecateImageOptions.ID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/images/{id}/deprecate`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deprecateImageOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeprecateImage") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// ObsoleteImage : Obsolete an image +// This request obsoletes an image, resulting in its `status` becoming `obsolete` and +// `obsolescence_at` being set to the current date and time. +// +// The image must: +// - have a `status` of `available` or `deprecated` +// - have `catalog_offering.managed` set to `false` +// - not have `deprecation_at` set in the future +// - not have `obsolescence_at` set +// +// A system-provided image is not allowed to be obsoleted. +func (vpc *VpcV1) ObsoleteImage(obsoleteImageOptions *ObsoleteImageOptions) (response *core.DetailedResponse, err error) { + return vpc.ObsoleteImageWithContext(context.Background(), obsoleteImageOptions) +} + +// ObsoleteImageWithContext is an alternate form of the ObsoleteImage method which supports a Context parameter +func (vpc *VpcV1) ObsoleteImageWithContext(ctx context.Context, obsoleteImageOptions *ObsoleteImageOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(obsoleteImageOptions, "obsoleteImageOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(obsoleteImageOptions, "obsoleteImageOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *obsoleteImageOptions.ID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/images/{id}/obsolete`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range obsoleteImageOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ObsoleteImage") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// ListImageExportJobs : List all image export jobs +// This request lists all export jobs for an image. Each job tracks the exporting of the image to another location, such +// as a bucket within cloud object storage. +// +// The jobs will be sorted by their `created_at` property values, with newest jobs first. Jobs with identical +// `created_at` property values will in turn be sorted by ascending +// `name` property values. +func (vpc *VpcV1) ListImageExportJobs(listImageExportJobsOptions *ListImageExportJobsOptions) (result *ImageExportJobUnpaginatedCollection, response *core.DetailedResponse, err error) { + return vpc.ListImageExportJobsWithContext(context.Background(), listImageExportJobsOptions) +} + +// ListImageExportJobsWithContext is an alternate form of the ListImageExportJobs method which supports a Context parameter +func (vpc *VpcV1) ListImageExportJobsWithContext(ctx context.Context, listImageExportJobsOptions *ListImageExportJobsOptions) (result *ImageExportJobUnpaginatedCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listImageExportJobsOptions, "listImageExportJobsOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listImageExportJobsOptions, "listImageExportJobsOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "image_id": *listImageExportJobsOptions.ImageID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/images/{image_id}/export_jobs`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listImageExportJobsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListImageExportJobs") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listImageExportJobsOptions.Name != nil { + builder.AddQuery("name", fmt.Sprint(*listImageExportJobsOptions.Name)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalImageExportJobUnpaginatedCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateImageExportJob : Create an image export job +// This request creates and queues a new export job for the image specified in the URL using the image export job +// prototype object. The image must be owned by the account and be in the `available`, `deprecated`, `obsolete`, or +// `unusable` state. The prototype object is structured in the same way as a retrieved image export job, and contains +// the information necessary to create and queue the new image export job. +func (vpc *VpcV1) CreateImageExportJob(createImageExportJobOptions *CreateImageExportJobOptions) (result *ImageExportJob, response *core.DetailedResponse, err error) { + return vpc.CreateImageExportJobWithContext(context.Background(), createImageExportJobOptions) +} + +// CreateImageExportJobWithContext is an alternate form of the CreateImageExportJob method which supports a Context parameter +func (vpc *VpcV1) CreateImageExportJobWithContext(ctx context.Context, createImageExportJobOptions *CreateImageExportJobOptions) (result *ImageExportJob, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createImageExportJobOptions, "createImageExportJobOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createImageExportJobOptions, "createImageExportJobOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "image_id": *createImageExportJobOptions.ImageID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/images/{image_id}/export_jobs`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range createImageExportJobOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateImageExportJob") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createImageExportJobOptions.StorageBucket != nil { + body["storage_bucket"] = createImageExportJobOptions.StorageBucket + } + if createImageExportJobOptions.Format != nil { + body["format"] = createImageExportJobOptions.Format + } + if createImageExportJobOptions.Name != nil { + body["name"] = createImageExportJobOptions.Name + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalImageExportJob) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteImageExportJob : Delete an image export job +// This request deletes an image export job. This operation cannot be reversed. If the job has not completed, the job +// will be canceled, and the incomplete exported image object deleted. If the job has completed, the exported image +// object will not be deleted. +func (vpc *VpcV1) DeleteImageExportJob(deleteImageExportJobOptions *DeleteImageExportJobOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteImageExportJobWithContext(context.Background(), deleteImageExportJobOptions) +} + +// DeleteImageExportJobWithContext is an alternate form of the DeleteImageExportJob method which supports a Context parameter +func (vpc *VpcV1) DeleteImageExportJobWithContext(ctx context.Context, deleteImageExportJobOptions *DeleteImageExportJobOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteImageExportJobOptions, "deleteImageExportJobOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteImageExportJobOptions, "deleteImageExportJobOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "image_id": *deleteImageExportJobOptions.ImageID, + "id": *deleteImageExportJobOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/images/{image_id}/export_jobs/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteImageExportJobOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteImageExportJob") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetImageExportJob : Retrieve an image export job +// This request retrieves a single image export job specified by the identifier in the URL. +func (vpc *VpcV1) GetImageExportJob(getImageExportJobOptions *GetImageExportJobOptions) (result *ImageExportJob, response *core.DetailedResponse, err error) { + return vpc.GetImageExportJobWithContext(context.Background(), getImageExportJobOptions) +} + +// GetImageExportJobWithContext is an alternate form of the GetImageExportJob method which supports a Context parameter +func (vpc *VpcV1) GetImageExportJobWithContext(ctx context.Context, getImageExportJobOptions *GetImageExportJobOptions) (result *ImageExportJob, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getImageExportJobOptions, "getImageExportJobOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getImageExportJobOptions, "getImageExportJobOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "image_id": *getImageExportJobOptions.ImageID, + "id": *getImageExportJobOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/images/{image_id}/export_jobs/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getImageExportJobOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetImageExportJob") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalImageExportJob) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateImageExportJob : Update an image export job +// This request updates an image export job with the information in a provided image export job patch. The image export +// job patch object is structured in the same way as a retrieved image export job and contains only the information to +// be updated. +func (vpc *VpcV1) UpdateImageExportJob(updateImageExportJobOptions *UpdateImageExportJobOptions) (result *ImageExportJob, response *core.DetailedResponse, err error) { + return vpc.UpdateImageExportJobWithContext(context.Background(), updateImageExportJobOptions) +} + +// UpdateImageExportJobWithContext is an alternate form of the UpdateImageExportJob method which supports a Context parameter +func (vpc *VpcV1) UpdateImageExportJobWithContext(ctx context.Context, updateImageExportJobOptions *UpdateImageExportJobOptions) (result *ImageExportJob, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateImageExportJobOptions, "updateImageExportJobOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateImageExportJobOptions, "updateImageExportJobOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "image_id": *updateImageExportJobOptions.ImageID, + "id": *updateImageExportJobOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/images/{image_id}/export_jobs/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateImageExportJobOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateImageExportJob") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateImageExportJobOptions.ImageExportJobPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalImageExportJob) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListOperatingSystems : List all operating systems +// This request lists all operating systems in the region. +func (vpc *VpcV1) ListOperatingSystems(listOperatingSystemsOptions *ListOperatingSystemsOptions) (result *OperatingSystemCollection, response *core.DetailedResponse, err error) { + return vpc.ListOperatingSystemsWithContext(context.Background(), listOperatingSystemsOptions) +} + +// ListOperatingSystemsWithContext is an alternate form of the ListOperatingSystems method which supports a Context parameter +func (vpc *VpcV1) ListOperatingSystemsWithContext(ctx context.Context, listOperatingSystemsOptions *ListOperatingSystemsOptions) (result *OperatingSystemCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listOperatingSystemsOptions, "listOperatingSystemsOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/operating_systems`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listOperatingSystemsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListOperatingSystems") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listOperatingSystemsOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listOperatingSystemsOptions.Start)) + } + if listOperatingSystemsOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listOperatingSystemsOptions.Limit)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalOperatingSystemCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// GetOperatingSystem : Retrieve an operating system +// This request retrieves a single operating system specified by the name in the URL. +func (vpc *VpcV1) GetOperatingSystem(getOperatingSystemOptions *GetOperatingSystemOptions) (result *OperatingSystem, response *core.DetailedResponse, err error) { + return vpc.GetOperatingSystemWithContext(context.Background(), getOperatingSystemOptions) +} + +// GetOperatingSystemWithContext is an alternate form of the GetOperatingSystem method which supports a Context parameter +func (vpc *VpcV1) GetOperatingSystemWithContext(ctx context.Context, getOperatingSystemOptions *GetOperatingSystemOptions) (result *OperatingSystem, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getOperatingSystemOptions, "getOperatingSystemOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getOperatingSystemOptions, "getOperatingSystemOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "name": *getOperatingSystemOptions.Name, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/operating_systems/{name}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getOperatingSystemOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetOperatingSystem") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalOperatingSystem) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListKeys : List all keys +// This request lists all keys in the region. A key contains a public SSH key which may be installed on instances when +// they are created. Private keys are not stored. +func (vpc *VpcV1) ListKeys(listKeysOptions *ListKeysOptions) (result *KeyCollection, response *core.DetailedResponse, err error) { + return vpc.ListKeysWithContext(context.Background(), listKeysOptions) +} + +// ListKeysWithContext is an alternate form of the ListKeys method which supports a Context parameter +func (vpc *VpcV1) ListKeysWithContext(ctx context.Context, listKeysOptions *ListKeysOptions) (result *KeyCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listKeysOptions, "listKeysOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/keys`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listKeysOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListKeys") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listKeysOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listKeysOptions.Start)) + } + if listKeysOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listKeysOptions.Limit)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalKeyCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateKey : Create a key +// This request creates a new SSH key from an key prototype object. The prototype object is structured in the same way +// as a retrieved key, and contains the information necessary to create the new key. The public key value must be +// provided. +func (vpc *VpcV1) CreateKey(createKeyOptions *CreateKeyOptions) (result *Key, response *core.DetailedResponse, err error) { + return vpc.CreateKeyWithContext(context.Background(), createKeyOptions) +} + +// CreateKeyWithContext is an alternate form of the CreateKey method which supports a Context parameter +func (vpc *VpcV1) CreateKeyWithContext(ctx context.Context, createKeyOptions *CreateKeyOptions) (result *Key, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createKeyOptions, "createKeyOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createKeyOptions, "createKeyOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/keys`, nil) + if err != nil { + return + } + + for headerName, headerValue := range createKeyOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateKey") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createKeyOptions.PublicKey != nil { + body["public_key"] = createKeyOptions.PublicKey + } + if createKeyOptions.Name != nil { + body["name"] = createKeyOptions.Name + } + if createKeyOptions.ResourceGroup != nil { + body["resource_group"] = createKeyOptions.ResourceGroup + } + if createKeyOptions.Type != nil { + body["type"] = createKeyOptions.Type + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalKey) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteKey : Delete a key +// This request deletes a key. This operation cannot be reversed. +func (vpc *VpcV1) DeleteKey(deleteKeyOptions *DeleteKeyOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteKeyWithContext(context.Background(), deleteKeyOptions) +} + +// DeleteKeyWithContext is an alternate form of the DeleteKey method which supports a Context parameter +func (vpc *VpcV1) DeleteKeyWithContext(ctx context.Context, deleteKeyOptions *DeleteKeyOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteKeyOptions, "deleteKeyOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteKeyOptions, "deleteKeyOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *deleteKeyOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/keys/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteKeyOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteKey") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetKey : Retrieve a key +// This request retrieves a single key specified by the identifier in the URL. +func (vpc *VpcV1) GetKey(getKeyOptions *GetKeyOptions) (result *Key, response *core.DetailedResponse, err error) { + return vpc.GetKeyWithContext(context.Background(), getKeyOptions) +} + +// GetKeyWithContext is an alternate form of the GetKey method which supports a Context parameter +func (vpc *VpcV1) GetKeyWithContext(ctx context.Context, getKeyOptions *GetKeyOptions) (result *Key, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getKeyOptions, "getKeyOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getKeyOptions, "getKeyOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getKeyOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/keys/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getKeyOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetKey") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalKey) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateKey : Update a key +// This request updates a key's name. +func (vpc *VpcV1) UpdateKey(updateKeyOptions *UpdateKeyOptions) (result *Key, response *core.DetailedResponse, err error) { + return vpc.UpdateKeyWithContext(context.Background(), updateKeyOptions) +} + +// UpdateKeyWithContext is an alternate form of the UpdateKey method which supports a Context parameter +func (vpc *VpcV1) UpdateKeyWithContext(ctx context.Context, updateKeyOptions *UpdateKeyOptions) (result *Key, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateKeyOptions, "updateKeyOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateKeyOptions, "updateKeyOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *updateKeyOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/keys/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateKeyOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateKey") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateKeyOptions.KeyPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalKey) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListInstanceProfiles : List all instance profiles +// This request lists provisionable [instance profiles](https://cloud.ibm.com/docs/vpc?topic=vpc-profiles) in the +// region. An instance profile specifies the performance characteristics and pricing model for an instance. +func (vpc *VpcV1) ListInstanceProfiles(listInstanceProfilesOptions *ListInstanceProfilesOptions) (result *InstanceProfileCollection, response *core.DetailedResponse, err error) { + return vpc.ListInstanceProfilesWithContext(context.Background(), listInstanceProfilesOptions) +} + +// ListInstanceProfilesWithContext is an alternate form of the ListInstanceProfiles method which supports a Context parameter +func (vpc *VpcV1) ListInstanceProfilesWithContext(ctx context.Context, listInstanceProfilesOptions *ListInstanceProfilesOptions) (result *InstanceProfileCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listInstanceProfilesOptions, "listInstanceProfilesOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance/profiles`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listInstanceProfilesOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListInstanceProfiles") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceProfileCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// GetInstanceProfile : Retrieve an instance profile +// This request retrieves a single instance profile specified by the name in the URL. +func (vpc *VpcV1) GetInstanceProfile(getInstanceProfileOptions *GetInstanceProfileOptions) (result *InstanceProfile, response *core.DetailedResponse, err error) { + return vpc.GetInstanceProfileWithContext(context.Background(), getInstanceProfileOptions) +} + +// GetInstanceProfileWithContext is an alternate form of the GetInstanceProfile method which supports a Context parameter +func (vpc *VpcV1) GetInstanceProfileWithContext(ctx context.Context, getInstanceProfileOptions *GetInstanceProfileOptions) (result *InstanceProfile, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getInstanceProfileOptions, "getInstanceProfileOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getInstanceProfileOptions, "getInstanceProfileOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "name": *getInstanceProfileOptions.Name, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance/profiles/{name}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getInstanceProfileOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetInstanceProfile") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceProfile) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListInstanceTemplates : List all instance templates +// This request lists all instance templates in the region. +func (vpc *VpcV1) ListInstanceTemplates(listInstanceTemplatesOptions *ListInstanceTemplatesOptions) (result *InstanceTemplateCollection, response *core.DetailedResponse, err error) { + return vpc.ListInstanceTemplatesWithContext(context.Background(), listInstanceTemplatesOptions) +} + +// ListInstanceTemplatesWithContext is an alternate form of the ListInstanceTemplates method which supports a Context parameter +func (vpc *VpcV1) ListInstanceTemplatesWithContext(ctx context.Context, listInstanceTemplatesOptions *ListInstanceTemplatesOptions) (result *InstanceTemplateCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listInstanceTemplatesOptions, "listInstanceTemplatesOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance/templates`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listInstanceTemplatesOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListInstanceTemplates") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceTemplateCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateInstanceTemplate : Create an instance template +// This request creates a new instance template. The prototype object is structured in the same way as a retrieved +// instance template, and contains the information necessary to provision a new instance from the template. +// +// If a `source_template` is specified in the prototype object, its contents are copied into the new template prior to +// copying any other properties provided in the prototype object. +func (vpc *VpcV1) CreateInstanceTemplate(createInstanceTemplateOptions *CreateInstanceTemplateOptions) (result InstanceTemplateIntf, response *core.DetailedResponse, err error) { + return vpc.CreateInstanceTemplateWithContext(context.Background(), createInstanceTemplateOptions) +} + +// CreateInstanceTemplateWithContext is an alternate form of the CreateInstanceTemplate method which supports a Context parameter +func (vpc *VpcV1) CreateInstanceTemplateWithContext(ctx context.Context, createInstanceTemplateOptions *CreateInstanceTemplateOptions) (result InstanceTemplateIntf, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createInstanceTemplateOptions, "createInstanceTemplateOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createInstanceTemplateOptions, "createInstanceTemplateOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance/templates`, nil) + if err != nil { + return + } + + for headerName, headerValue := range createInstanceTemplateOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateInstanceTemplate") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(createInstanceTemplateOptions.InstanceTemplatePrototype) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceTemplate) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteInstanceTemplate : Delete an instance template +// This request deletes the instance template. This operation cannot be reversed. +func (vpc *VpcV1) DeleteInstanceTemplate(deleteInstanceTemplateOptions *DeleteInstanceTemplateOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteInstanceTemplateWithContext(context.Background(), deleteInstanceTemplateOptions) +} + +// DeleteInstanceTemplateWithContext is an alternate form of the DeleteInstanceTemplate method which supports a Context parameter +func (vpc *VpcV1) DeleteInstanceTemplateWithContext(ctx context.Context, deleteInstanceTemplateOptions *DeleteInstanceTemplateOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteInstanceTemplateOptions, "deleteInstanceTemplateOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteInstanceTemplateOptions, "deleteInstanceTemplateOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *deleteInstanceTemplateOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance/templates/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteInstanceTemplateOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteInstanceTemplate") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetInstanceTemplate : Retrieve an instance template +// This request retrieves a single instance template specified by the identifier in the URL. +func (vpc *VpcV1) GetInstanceTemplate(getInstanceTemplateOptions *GetInstanceTemplateOptions) (result InstanceTemplateIntf, response *core.DetailedResponse, err error) { + return vpc.GetInstanceTemplateWithContext(context.Background(), getInstanceTemplateOptions) +} + +// GetInstanceTemplateWithContext is an alternate form of the GetInstanceTemplate method which supports a Context parameter +func (vpc *VpcV1) GetInstanceTemplateWithContext(ctx context.Context, getInstanceTemplateOptions *GetInstanceTemplateOptions) (result InstanceTemplateIntf, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getInstanceTemplateOptions, "getInstanceTemplateOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getInstanceTemplateOptions, "getInstanceTemplateOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getInstanceTemplateOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance/templates/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getInstanceTemplateOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetInstanceTemplate") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceTemplate) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateInstanceTemplate : Update an instance template +// This request updates an instance template with the information provided in the instance template patch. The instance +// template patch object is structured in the same way as a retrieved instance template and contains only the +// information to be updated. +func (vpc *VpcV1) UpdateInstanceTemplate(updateInstanceTemplateOptions *UpdateInstanceTemplateOptions) (result InstanceTemplateIntf, response *core.DetailedResponse, err error) { + return vpc.UpdateInstanceTemplateWithContext(context.Background(), updateInstanceTemplateOptions) +} + +// UpdateInstanceTemplateWithContext is an alternate form of the UpdateInstanceTemplate method which supports a Context parameter +func (vpc *VpcV1) UpdateInstanceTemplateWithContext(ctx context.Context, updateInstanceTemplateOptions *UpdateInstanceTemplateOptions) (result InstanceTemplateIntf, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateInstanceTemplateOptions, "updateInstanceTemplateOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateInstanceTemplateOptions, "updateInstanceTemplateOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *updateInstanceTemplateOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance/templates/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateInstanceTemplateOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateInstanceTemplate") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateInstanceTemplateOptions.InstanceTemplatePatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceTemplate) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListInstances : List all instances +// This request lists all instances in the region. +func (vpc *VpcV1) ListInstances(listInstancesOptions *ListInstancesOptions) (result *InstanceCollection, response *core.DetailedResponse, err error) { + return vpc.ListInstancesWithContext(context.Background(), listInstancesOptions) +} + +// ListInstancesWithContext is an alternate form of the ListInstances method which supports a Context parameter +func (vpc *VpcV1) ListInstancesWithContext(ctx context.Context, listInstancesOptions *ListInstancesOptions) (result *InstanceCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listInstancesOptions, "listInstancesOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instances`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listInstancesOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListInstances") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listInstancesOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listInstancesOptions.Start)) + } + if listInstancesOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listInstancesOptions.Limit)) + } + if listInstancesOptions.ResourceGroupID != nil { + builder.AddQuery("resource_group.id", fmt.Sprint(*listInstancesOptions.ResourceGroupID)) + } + if listInstancesOptions.Name != nil { + builder.AddQuery("name", fmt.Sprint(*listInstancesOptions.Name)) + } + if listInstancesOptions.VPCID != nil { + builder.AddQuery("vpc.id", fmt.Sprint(*listInstancesOptions.VPCID)) + } + if listInstancesOptions.VPCCRN != nil { + builder.AddQuery("vpc.crn", fmt.Sprint(*listInstancesOptions.VPCCRN)) + } + if listInstancesOptions.VPCName != nil { + builder.AddQuery("vpc.name", fmt.Sprint(*listInstancesOptions.VPCName)) + } + if listInstancesOptions.DedicatedHostID != nil { + builder.AddQuery("dedicated_host.id", fmt.Sprint(*listInstancesOptions.DedicatedHostID)) + } + if listInstancesOptions.DedicatedHostCRN != nil { + builder.AddQuery("dedicated_host.crn", fmt.Sprint(*listInstancesOptions.DedicatedHostCRN)) + } + if listInstancesOptions.DedicatedHostName != nil { + builder.AddQuery("dedicated_host.name", fmt.Sprint(*listInstancesOptions.DedicatedHostName)) + } + if listInstancesOptions.PlacementGroupID != nil { + builder.AddQuery("placement_group.id", fmt.Sprint(*listInstancesOptions.PlacementGroupID)) + } + if listInstancesOptions.PlacementGroupCRN != nil { + builder.AddQuery("placement_group.crn", fmt.Sprint(*listInstancesOptions.PlacementGroupCRN)) + } + if listInstancesOptions.PlacementGroupName != nil { + builder.AddQuery("placement_group.name", fmt.Sprint(*listInstancesOptions.PlacementGroupName)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateInstance : Create an instance +// This request provisions a new instance from an instance prototype object. The prototype object is structured in the +// same way as a retrieved instance, and contains the information necessary to provision the new instance. The instance +// is automatically started. +func (vpc *VpcV1) CreateInstance(createInstanceOptions *CreateInstanceOptions) (result *Instance, response *core.DetailedResponse, err error) { + return vpc.CreateInstanceWithContext(context.Background(), createInstanceOptions) +} + +// CreateInstanceWithContext is an alternate form of the CreateInstance method which supports a Context parameter +func (vpc *VpcV1) CreateInstanceWithContext(ctx context.Context, createInstanceOptions *CreateInstanceOptions) (result *Instance, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createInstanceOptions, "createInstanceOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createInstanceOptions, "createInstanceOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instances`, nil) + if err != nil { + return + } + + for headerName, headerValue := range createInstanceOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateInstance") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(createInstanceOptions.InstancePrototype) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstance) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteInstance : Delete an instance +// This request deletes an instance. This operation cannot be reversed. Any floating IPs associated with instance +// network interfaces are implicitly disassociated. All flow log collectors with `auto_delete` set to `true` targeting +// the instance and/or the instance network interfaces are automatically deleted. +func (vpc *VpcV1) DeleteInstance(deleteInstanceOptions *DeleteInstanceOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteInstanceWithContext(context.Background(), deleteInstanceOptions) +} + +// DeleteInstanceWithContext is an alternate form of the DeleteInstance method which supports a Context parameter +func (vpc *VpcV1) DeleteInstanceWithContext(ctx context.Context, deleteInstanceOptions *DeleteInstanceOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteInstanceOptions, "deleteInstanceOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteInstanceOptions, "deleteInstanceOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *deleteInstanceOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instances/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteInstanceOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteInstance") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetInstance : Retrieve an instance +// This request retrieves a single instance specified by the identifier in the URL. +func (vpc *VpcV1) GetInstance(getInstanceOptions *GetInstanceOptions) (result *Instance, response *core.DetailedResponse, err error) { + return vpc.GetInstanceWithContext(context.Background(), getInstanceOptions) +} + +// GetInstanceWithContext is an alternate form of the GetInstance method which supports a Context parameter +func (vpc *VpcV1) GetInstanceWithContext(ctx context.Context, getInstanceOptions *GetInstanceOptions) (result *Instance, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getInstanceOptions, "getInstanceOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getInstanceOptions, "getInstanceOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getInstanceOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instances/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getInstanceOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetInstance") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstance) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateInstance : Update an instance +// This request updates an instance with the information in a provided instance patch. The instance patch object is +// structured in the same way as a retrieved instance and contains only the information to be updated. +func (vpc *VpcV1) UpdateInstance(updateInstanceOptions *UpdateInstanceOptions) (result *Instance, response *core.DetailedResponse, err error) { + return vpc.UpdateInstanceWithContext(context.Background(), updateInstanceOptions) +} + +// UpdateInstanceWithContext is an alternate form of the UpdateInstance method which supports a Context parameter +func (vpc *VpcV1) UpdateInstanceWithContext(ctx context.Context, updateInstanceOptions *UpdateInstanceOptions) (result *Instance, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateInstanceOptions, "updateInstanceOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateInstanceOptions, "updateInstanceOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *updateInstanceOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instances/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateInstanceOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateInstance") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateInstanceOptions.InstancePatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstance) + if err != nil { + return + } + response.Result = result + } + + return +} + +// GetInstanceInitialization : Retrieve initialization configuration for an instance +// This request retrieves configuration used to initialize the instance, such as SSH keys and the Windows administrator +// password. These can subsequently be changed on the instance and therefore may not be current. +func (vpc *VpcV1) GetInstanceInitialization(getInstanceInitializationOptions *GetInstanceInitializationOptions) (result *InstanceInitialization, response *core.DetailedResponse, err error) { + return vpc.GetInstanceInitializationWithContext(context.Background(), getInstanceInitializationOptions) +} + +// GetInstanceInitializationWithContext is an alternate form of the GetInstanceInitialization method which supports a Context parameter +func (vpc *VpcV1) GetInstanceInitializationWithContext(ctx context.Context, getInstanceInitializationOptions *GetInstanceInitializationOptions) (result *InstanceInitialization, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getInstanceInitializationOptions, "getInstanceInitializationOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getInstanceInitializationOptions, "getInstanceInitializationOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getInstanceInitializationOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instances/{id}/initialization`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getInstanceInitializationOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetInstanceInitialization") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceInitialization) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateInstanceAction : Create an instance action +// This request creates a new action which will be queued up to run as soon as any pending or running actions have +// completed. +func (vpc *VpcV1) CreateInstanceAction(createInstanceActionOptions *CreateInstanceActionOptions) (result *InstanceAction, response *core.DetailedResponse, err error) { + return vpc.CreateInstanceActionWithContext(context.Background(), createInstanceActionOptions) +} + +// CreateInstanceActionWithContext is an alternate form of the CreateInstanceAction method which supports a Context parameter +func (vpc *VpcV1) CreateInstanceActionWithContext(ctx context.Context, createInstanceActionOptions *CreateInstanceActionOptions) (result *InstanceAction, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createInstanceActionOptions, "createInstanceActionOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createInstanceActionOptions, "createInstanceActionOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_id": *createInstanceActionOptions.InstanceID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instances/{instance_id}/actions`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range createInstanceActionOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateInstanceAction") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createInstanceActionOptions.Type != nil { + body["type"] = createInstanceActionOptions.Type + } + if createInstanceActionOptions.Force != nil { + body["force"] = createInstanceActionOptions.Force + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceAction) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateInstanceConsoleAccessToken : Create a console access token for an instance +// This request creates a new single-use console access token for an instance. All console configuration is provided at +// token create time, and the token is subsequently used in the `access_token` query parameter for the WebSocket +// request. The access token is only valid for a short period of time, and a maximum of one token is valid for a given +// instance at a time. +func (vpc *VpcV1) CreateInstanceConsoleAccessToken(createInstanceConsoleAccessTokenOptions *CreateInstanceConsoleAccessTokenOptions) (result *InstanceConsoleAccessToken, response *core.DetailedResponse, err error) { + return vpc.CreateInstanceConsoleAccessTokenWithContext(context.Background(), createInstanceConsoleAccessTokenOptions) +} + +// CreateInstanceConsoleAccessTokenWithContext is an alternate form of the CreateInstanceConsoleAccessToken method which supports a Context parameter +func (vpc *VpcV1) CreateInstanceConsoleAccessTokenWithContext(ctx context.Context, createInstanceConsoleAccessTokenOptions *CreateInstanceConsoleAccessTokenOptions) (result *InstanceConsoleAccessToken, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createInstanceConsoleAccessTokenOptions, "createInstanceConsoleAccessTokenOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createInstanceConsoleAccessTokenOptions, "createInstanceConsoleAccessTokenOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_id": *createInstanceConsoleAccessTokenOptions.InstanceID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instances/{instance_id}/console_access_token`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range createInstanceConsoleAccessTokenOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateInstanceConsoleAccessToken") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createInstanceConsoleAccessTokenOptions.ConsoleType != nil { + body["console_type"] = createInstanceConsoleAccessTokenOptions.ConsoleType + } + if createInstanceConsoleAccessTokenOptions.Force != nil { + body["force"] = createInstanceConsoleAccessTokenOptions.Force + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceConsoleAccessToken) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListInstanceDisks : List all disks on an instance +// This request lists all disks on an instance. A disk is a block device that is locally attached to the instance's +// physical host and is also referred to as instance storage. By default, the listed disks are sorted by their +// `created_at` property values, with the newest disk first. +func (vpc *VpcV1) ListInstanceDisks(listInstanceDisksOptions *ListInstanceDisksOptions) (result *InstanceDiskCollection, response *core.DetailedResponse, err error) { + return vpc.ListInstanceDisksWithContext(context.Background(), listInstanceDisksOptions) +} + +// ListInstanceDisksWithContext is an alternate form of the ListInstanceDisks method which supports a Context parameter +func (vpc *VpcV1) ListInstanceDisksWithContext(ctx context.Context, listInstanceDisksOptions *ListInstanceDisksOptions) (result *InstanceDiskCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listInstanceDisksOptions, "listInstanceDisksOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listInstanceDisksOptions, "listInstanceDisksOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_id": *listInstanceDisksOptions.InstanceID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instances/{instance_id}/disks`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listInstanceDisksOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListInstanceDisks") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceDiskCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// GetInstanceDisk : Retrieve an instance disk +// This request retrieves a single instance disk specified by the identifier in the URL. +func (vpc *VpcV1) GetInstanceDisk(getInstanceDiskOptions *GetInstanceDiskOptions) (result *InstanceDisk, response *core.DetailedResponse, err error) { + return vpc.GetInstanceDiskWithContext(context.Background(), getInstanceDiskOptions) +} + +// GetInstanceDiskWithContext is an alternate form of the GetInstanceDisk method which supports a Context parameter +func (vpc *VpcV1) GetInstanceDiskWithContext(ctx context.Context, getInstanceDiskOptions *GetInstanceDiskOptions) (result *InstanceDisk, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getInstanceDiskOptions, "getInstanceDiskOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getInstanceDiskOptions, "getInstanceDiskOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_id": *getInstanceDiskOptions.InstanceID, + "id": *getInstanceDiskOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instances/{instance_id}/disks/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getInstanceDiskOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetInstanceDisk") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceDisk) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateInstanceDisk : Update an instance disk +// This request updates the instance disk with the information in a provided patch. +func (vpc *VpcV1) UpdateInstanceDisk(updateInstanceDiskOptions *UpdateInstanceDiskOptions) (result *InstanceDisk, response *core.DetailedResponse, err error) { + return vpc.UpdateInstanceDiskWithContext(context.Background(), updateInstanceDiskOptions) +} + +// UpdateInstanceDiskWithContext is an alternate form of the UpdateInstanceDisk method which supports a Context parameter +func (vpc *VpcV1) UpdateInstanceDiskWithContext(ctx context.Context, updateInstanceDiskOptions *UpdateInstanceDiskOptions) (result *InstanceDisk, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateInstanceDiskOptions, "updateInstanceDiskOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateInstanceDiskOptions, "updateInstanceDiskOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_id": *updateInstanceDiskOptions.InstanceID, + "id": *updateInstanceDiskOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instances/{instance_id}/disks/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateInstanceDiskOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateInstanceDisk") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateInstanceDiskOptions.InstanceDiskPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceDisk) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListInstanceNetworkInterfaces : List all network interfaces on an instance +// This request lists all network interfaces on an instance. An instance network interface is an abstract representation +// of a network device and attaches an instance to a single subnet. Each network interface on an instance can attach to +// any subnet in the zone, including subnets that are already attached to the instance. Multiple network interfaces on +// the instance may also attach to the same subnet. +func (vpc *VpcV1) ListInstanceNetworkInterfaces(listInstanceNetworkInterfacesOptions *ListInstanceNetworkInterfacesOptions) (result *NetworkInterfaceUnpaginatedCollection, response *core.DetailedResponse, err error) { + return vpc.ListInstanceNetworkInterfacesWithContext(context.Background(), listInstanceNetworkInterfacesOptions) +} + +// ListInstanceNetworkInterfacesWithContext is an alternate form of the ListInstanceNetworkInterfaces method which supports a Context parameter +func (vpc *VpcV1) ListInstanceNetworkInterfacesWithContext(ctx context.Context, listInstanceNetworkInterfacesOptions *ListInstanceNetworkInterfacesOptions) (result *NetworkInterfaceUnpaginatedCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listInstanceNetworkInterfacesOptions, "listInstanceNetworkInterfacesOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listInstanceNetworkInterfacesOptions, "listInstanceNetworkInterfacesOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_id": *listInstanceNetworkInterfacesOptions.InstanceID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instances/{instance_id}/network_interfaces`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listInstanceNetworkInterfacesOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListInstanceNetworkInterfaces") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalNetworkInterfaceUnpaginatedCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateInstanceNetworkInterface : Create a network interface on an instance +// This request creates a new instance network interface from an instance network interface prototype object. The +// prototype object is structured in the same way as a retrieved instance network interface, and contains the +// information necessary to create the new instance network interface. Any subnet in the instance's VPC may be +// specified. Addresses on the instance network interface must be within the specified subnet's CIDR blocks. +func (vpc *VpcV1) CreateInstanceNetworkInterface(createInstanceNetworkInterfaceOptions *CreateInstanceNetworkInterfaceOptions) (result *NetworkInterface, response *core.DetailedResponse, err error) { + return vpc.CreateInstanceNetworkInterfaceWithContext(context.Background(), createInstanceNetworkInterfaceOptions) +} + +// CreateInstanceNetworkInterfaceWithContext is an alternate form of the CreateInstanceNetworkInterface method which supports a Context parameter +func (vpc *VpcV1) CreateInstanceNetworkInterfaceWithContext(ctx context.Context, createInstanceNetworkInterfaceOptions *CreateInstanceNetworkInterfaceOptions) (result *NetworkInterface, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createInstanceNetworkInterfaceOptions, "createInstanceNetworkInterfaceOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createInstanceNetworkInterfaceOptions, "createInstanceNetworkInterfaceOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_id": *createInstanceNetworkInterfaceOptions.InstanceID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instances/{instance_id}/network_interfaces`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range createInstanceNetworkInterfaceOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateInstanceNetworkInterface") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createInstanceNetworkInterfaceOptions.Subnet != nil { + body["subnet"] = createInstanceNetworkInterfaceOptions.Subnet + } + if createInstanceNetworkInterfaceOptions.AllowIPSpoofing != nil { + body["allow_ip_spoofing"] = createInstanceNetworkInterfaceOptions.AllowIPSpoofing + } + if createInstanceNetworkInterfaceOptions.Name != nil { + body["name"] = createInstanceNetworkInterfaceOptions.Name + } + if createInstanceNetworkInterfaceOptions.PrimaryIP != nil { + body["primary_ip"] = createInstanceNetworkInterfaceOptions.PrimaryIP + } + if createInstanceNetworkInterfaceOptions.SecurityGroups != nil { + body["security_groups"] = createInstanceNetworkInterfaceOptions.SecurityGroups + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalNetworkInterface) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteInstanceNetworkInterface : Delete an instance network interface +// This request deletes an instance network interface. This operation cannot be reversed. Any floating IPs associated +// with the instance network interface are implicitly disassociated. All flow log collectors with `auto_delete` set to +// `true` targeting the instance network interface are automatically deleted. The primary instance network interface is +// not allowed to be deleted. +func (vpc *VpcV1) DeleteInstanceNetworkInterface(deleteInstanceNetworkInterfaceOptions *DeleteInstanceNetworkInterfaceOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteInstanceNetworkInterfaceWithContext(context.Background(), deleteInstanceNetworkInterfaceOptions) +} + +// DeleteInstanceNetworkInterfaceWithContext is an alternate form of the DeleteInstanceNetworkInterface method which supports a Context parameter +func (vpc *VpcV1) DeleteInstanceNetworkInterfaceWithContext(ctx context.Context, deleteInstanceNetworkInterfaceOptions *DeleteInstanceNetworkInterfaceOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteInstanceNetworkInterfaceOptions, "deleteInstanceNetworkInterfaceOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteInstanceNetworkInterfaceOptions, "deleteInstanceNetworkInterfaceOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_id": *deleteInstanceNetworkInterfaceOptions.InstanceID, + "id": *deleteInstanceNetworkInterfaceOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instances/{instance_id}/network_interfaces/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteInstanceNetworkInterfaceOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteInstanceNetworkInterface") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetInstanceNetworkInterface : Retrieve an instance network interface +// This request retrieves a single instance network interface specified by the identifier in the URL. +func (vpc *VpcV1) GetInstanceNetworkInterface(getInstanceNetworkInterfaceOptions *GetInstanceNetworkInterfaceOptions) (result *NetworkInterface, response *core.DetailedResponse, err error) { + return vpc.GetInstanceNetworkInterfaceWithContext(context.Background(), getInstanceNetworkInterfaceOptions) +} + +// GetInstanceNetworkInterfaceWithContext is an alternate form of the GetInstanceNetworkInterface method which supports a Context parameter +func (vpc *VpcV1) GetInstanceNetworkInterfaceWithContext(ctx context.Context, getInstanceNetworkInterfaceOptions *GetInstanceNetworkInterfaceOptions) (result *NetworkInterface, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getInstanceNetworkInterfaceOptions, "getInstanceNetworkInterfaceOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getInstanceNetworkInterfaceOptions, "getInstanceNetworkInterfaceOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_id": *getInstanceNetworkInterfaceOptions.InstanceID, + "id": *getInstanceNetworkInterfaceOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instances/{instance_id}/network_interfaces/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getInstanceNetworkInterfaceOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetInstanceNetworkInterface") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalNetworkInterface) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateInstanceNetworkInterface : Update an instance network interface +// This request updates an instance network interface with the information provided in an instance network interface +// patch object. The instance network interface patch object is structured in the same way as a retrieved instance +// network interface and needs to contain only the information to be updated. +func (vpc *VpcV1) UpdateInstanceNetworkInterface(updateInstanceNetworkInterfaceOptions *UpdateInstanceNetworkInterfaceOptions) (result *NetworkInterface, response *core.DetailedResponse, err error) { + return vpc.UpdateInstanceNetworkInterfaceWithContext(context.Background(), updateInstanceNetworkInterfaceOptions) +} + +// UpdateInstanceNetworkInterfaceWithContext is an alternate form of the UpdateInstanceNetworkInterface method which supports a Context parameter +func (vpc *VpcV1) UpdateInstanceNetworkInterfaceWithContext(ctx context.Context, updateInstanceNetworkInterfaceOptions *UpdateInstanceNetworkInterfaceOptions) (result *NetworkInterface, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateInstanceNetworkInterfaceOptions, "updateInstanceNetworkInterfaceOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateInstanceNetworkInterfaceOptions, "updateInstanceNetworkInterfaceOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_id": *updateInstanceNetworkInterfaceOptions.InstanceID, + "id": *updateInstanceNetworkInterfaceOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instances/{instance_id}/network_interfaces/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateInstanceNetworkInterfaceOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateInstanceNetworkInterface") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateInstanceNetworkInterfaceOptions.NetworkInterfacePatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalNetworkInterface) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListInstanceNetworkInterfaceFloatingIps : List all floating IPs associated with an instance network interface +// This request lists all floating IPs associated with an instance network interface. +func (vpc *VpcV1) ListInstanceNetworkInterfaceFloatingIps(listInstanceNetworkInterfaceFloatingIpsOptions *ListInstanceNetworkInterfaceFloatingIpsOptions) (result *FloatingIPUnpaginatedCollection, response *core.DetailedResponse, err error) { + return vpc.ListInstanceNetworkInterfaceFloatingIpsWithContext(context.Background(), listInstanceNetworkInterfaceFloatingIpsOptions) +} + +// ListInstanceNetworkInterfaceFloatingIpsWithContext is an alternate form of the ListInstanceNetworkInterfaceFloatingIps method which supports a Context parameter +func (vpc *VpcV1) ListInstanceNetworkInterfaceFloatingIpsWithContext(ctx context.Context, listInstanceNetworkInterfaceFloatingIpsOptions *ListInstanceNetworkInterfaceFloatingIpsOptions) (result *FloatingIPUnpaginatedCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listInstanceNetworkInterfaceFloatingIpsOptions, "listInstanceNetworkInterfaceFloatingIpsOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listInstanceNetworkInterfaceFloatingIpsOptions, "listInstanceNetworkInterfaceFloatingIpsOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_id": *listInstanceNetworkInterfaceFloatingIpsOptions.InstanceID, + "network_interface_id": *listInstanceNetworkInterfaceFloatingIpsOptions.NetworkInterfaceID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instances/{instance_id}/network_interfaces/{network_interface_id}/floating_ips`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listInstanceNetworkInterfaceFloatingIpsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListInstanceNetworkInterfaceFloatingIps") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalFloatingIPUnpaginatedCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// RemoveInstanceNetworkInterfaceFloatingIP : Disassociate a floating IP from an instance network interface +// This request disassociates the specified floating IP from the specified instance network interface. +func (vpc *VpcV1) RemoveInstanceNetworkInterfaceFloatingIP(removeInstanceNetworkInterfaceFloatingIPOptions *RemoveInstanceNetworkInterfaceFloatingIPOptions) (response *core.DetailedResponse, err error) { + return vpc.RemoveInstanceNetworkInterfaceFloatingIPWithContext(context.Background(), removeInstanceNetworkInterfaceFloatingIPOptions) +} + +// RemoveInstanceNetworkInterfaceFloatingIPWithContext is an alternate form of the RemoveInstanceNetworkInterfaceFloatingIP method which supports a Context parameter +func (vpc *VpcV1) RemoveInstanceNetworkInterfaceFloatingIPWithContext(ctx context.Context, removeInstanceNetworkInterfaceFloatingIPOptions *RemoveInstanceNetworkInterfaceFloatingIPOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(removeInstanceNetworkInterfaceFloatingIPOptions, "removeInstanceNetworkInterfaceFloatingIPOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(removeInstanceNetworkInterfaceFloatingIPOptions, "removeInstanceNetworkInterfaceFloatingIPOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_id": *removeInstanceNetworkInterfaceFloatingIPOptions.InstanceID, + "network_interface_id": *removeInstanceNetworkInterfaceFloatingIPOptions.NetworkInterfaceID, + "id": *removeInstanceNetworkInterfaceFloatingIPOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instances/{instance_id}/network_interfaces/{network_interface_id}/floating_ips/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range removeInstanceNetworkInterfaceFloatingIPOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "RemoveInstanceNetworkInterfaceFloatingIP") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetInstanceNetworkInterfaceFloatingIP : Retrieve associated floating IP +// This request retrieves a specified floating IP address if it is associated with the instance network interface and +// instance specified in the URL. +func (vpc *VpcV1) GetInstanceNetworkInterfaceFloatingIP(getInstanceNetworkInterfaceFloatingIPOptions *GetInstanceNetworkInterfaceFloatingIPOptions) (result *FloatingIP, response *core.DetailedResponse, err error) { + return vpc.GetInstanceNetworkInterfaceFloatingIPWithContext(context.Background(), getInstanceNetworkInterfaceFloatingIPOptions) +} + +// GetInstanceNetworkInterfaceFloatingIPWithContext is an alternate form of the GetInstanceNetworkInterfaceFloatingIP method which supports a Context parameter +func (vpc *VpcV1) GetInstanceNetworkInterfaceFloatingIPWithContext(ctx context.Context, getInstanceNetworkInterfaceFloatingIPOptions *GetInstanceNetworkInterfaceFloatingIPOptions) (result *FloatingIP, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getInstanceNetworkInterfaceFloatingIPOptions, "getInstanceNetworkInterfaceFloatingIPOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getInstanceNetworkInterfaceFloatingIPOptions, "getInstanceNetworkInterfaceFloatingIPOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_id": *getInstanceNetworkInterfaceFloatingIPOptions.InstanceID, + "network_interface_id": *getInstanceNetworkInterfaceFloatingIPOptions.NetworkInterfaceID, + "id": *getInstanceNetworkInterfaceFloatingIPOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instances/{instance_id}/network_interfaces/{network_interface_id}/floating_ips/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getInstanceNetworkInterfaceFloatingIPOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetInstanceNetworkInterfaceFloatingIP") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalFloatingIP) + if err != nil { + return + } + response.Result = result + } + + return +} + +// AddInstanceNetworkInterfaceFloatingIP : Associate a floating IP with an instance network interface +// This request associates the specified floating IP with the specified instance network interface, replacing any +// existing association. For this request to succeed, the existing floating IP must not be required by another resource, +// such as a public gateway. A request body is not required, and if provided, is ignored. +func (vpc *VpcV1) AddInstanceNetworkInterfaceFloatingIP(addInstanceNetworkInterfaceFloatingIPOptions *AddInstanceNetworkInterfaceFloatingIPOptions) (result *FloatingIP, response *core.DetailedResponse, err error) { + return vpc.AddInstanceNetworkInterfaceFloatingIPWithContext(context.Background(), addInstanceNetworkInterfaceFloatingIPOptions) +} + +// AddInstanceNetworkInterfaceFloatingIPWithContext is an alternate form of the AddInstanceNetworkInterfaceFloatingIP method which supports a Context parameter +func (vpc *VpcV1) AddInstanceNetworkInterfaceFloatingIPWithContext(ctx context.Context, addInstanceNetworkInterfaceFloatingIPOptions *AddInstanceNetworkInterfaceFloatingIPOptions) (result *FloatingIP, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(addInstanceNetworkInterfaceFloatingIPOptions, "addInstanceNetworkInterfaceFloatingIPOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(addInstanceNetworkInterfaceFloatingIPOptions, "addInstanceNetworkInterfaceFloatingIPOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_id": *addInstanceNetworkInterfaceFloatingIPOptions.InstanceID, + "network_interface_id": *addInstanceNetworkInterfaceFloatingIPOptions.NetworkInterfaceID, + "id": *addInstanceNetworkInterfaceFloatingIPOptions.ID, + } + + builder := core.NewRequestBuilder(core.PUT) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instances/{instance_id}/network_interfaces/{network_interface_id}/floating_ips/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range addInstanceNetworkInterfaceFloatingIPOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "AddInstanceNetworkInterfaceFloatingIP") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalFloatingIP) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListInstanceNetworkInterfaceIps : List all reserved IPs bound to an instance network interface +// This request lists all reserved IPs bound to an instance network interface. +func (vpc *VpcV1) ListInstanceNetworkInterfaceIps(listInstanceNetworkInterfaceIpsOptions *ListInstanceNetworkInterfaceIpsOptions) (result *ReservedIPCollectionInstanceNetworkInterfaceContext, response *core.DetailedResponse, err error) { + return vpc.ListInstanceNetworkInterfaceIpsWithContext(context.Background(), listInstanceNetworkInterfaceIpsOptions) +} + +// ListInstanceNetworkInterfaceIpsWithContext is an alternate form of the ListInstanceNetworkInterfaceIps method which supports a Context parameter +func (vpc *VpcV1) ListInstanceNetworkInterfaceIpsWithContext(ctx context.Context, listInstanceNetworkInterfaceIpsOptions *ListInstanceNetworkInterfaceIpsOptions) (result *ReservedIPCollectionInstanceNetworkInterfaceContext, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listInstanceNetworkInterfaceIpsOptions, "listInstanceNetworkInterfaceIpsOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listInstanceNetworkInterfaceIpsOptions, "listInstanceNetworkInterfaceIpsOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_id": *listInstanceNetworkInterfaceIpsOptions.InstanceID, + "network_interface_id": *listInstanceNetworkInterfaceIpsOptions.NetworkInterfaceID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instances/{instance_id}/network_interfaces/{network_interface_id}/ips`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listInstanceNetworkInterfaceIpsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListInstanceNetworkInterfaceIps") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listInstanceNetworkInterfaceIpsOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listInstanceNetworkInterfaceIpsOptions.Start)) + } + if listInstanceNetworkInterfaceIpsOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listInstanceNetworkInterfaceIpsOptions.Limit)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalReservedIPCollectionInstanceNetworkInterfaceContext) + if err != nil { + return + } + response.Result = result + } + + return +} + +// GetInstanceNetworkInterfaceIP : Retrieve bound reserved IP +// This request retrieves the specified reserved IP address if it is bound to the network interface and instance +// specified in the URL. +func (vpc *VpcV1) GetInstanceNetworkInterfaceIP(getInstanceNetworkInterfaceIPOptions *GetInstanceNetworkInterfaceIPOptions) (result *ReservedIP, response *core.DetailedResponse, err error) { + return vpc.GetInstanceNetworkInterfaceIPWithContext(context.Background(), getInstanceNetworkInterfaceIPOptions) +} + +// GetInstanceNetworkInterfaceIPWithContext is an alternate form of the GetInstanceNetworkInterfaceIP method which supports a Context parameter +func (vpc *VpcV1) GetInstanceNetworkInterfaceIPWithContext(ctx context.Context, getInstanceNetworkInterfaceIPOptions *GetInstanceNetworkInterfaceIPOptions) (result *ReservedIP, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getInstanceNetworkInterfaceIPOptions, "getInstanceNetworkInterfaceIPOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getInstanceNetworkInterfaceIPOptions, "getInstanceNetworkInterfaceIPOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_id": *getInstanceNetworkInterfaceIPOptions.InstanceID, + "network_interface_id": *getInstanceNetworkInterfaceIPOptions.NetworkInterfaceID, + "id": *getInstanceNetworkInterfaceIPOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instances/{instance_id}/network_interfaces/{network_interface_id}/ips/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getInstanceNetworkInterfaceIPOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetInstanceNetworkInterfaceIP") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalReservedIP) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListInstanceVolumeAttachments : List all volumes attachments on an instance +// This request lists all volume attachments on an instance. A volume attachment connects a volume to an instance. Each +// instance may have many volume attachments but each volume attachment connects exactly one instance to exactly one +// volume. +func (vpc *VpcV1) ListInstanceVolumeAttachments(listInstanceVolumeAttachmentsOptions *ListInstanceVolumeAttachmentsOptions) (result *VolumeAttachmentCollection, response *core.DetailedResponse, err error) { + return vpc.ListInstanceVolumeAttachmentsWithContext(context.Background(), listInstanceVolumeAttachmentsOptions) +} + +// ListInstanceVolumeAttachmentsWithContext is an alternate form of the ListInstanceVolumeAttachments method which supports a Context parameter +func (vpc *VpcV1) ListInstanceVolumeAttachmentsWithContext(ctx context.Context, listInstanceVolumeAttachmentsOptions *ListInstanceVolumeAttachmentsOptions) (result *VolumeAttachmentCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listInstanceVolumeAttachmentsOptions, "listInstanceVolumeAttachmentsOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listInstanceVolumeAttachmentsOptions, "listInstanceVolumeAttachmentsOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_id": *listInstanceVolumeAttachmentsOptions.InstanceID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instances/{instance_id}/volume_attachments`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listInstanceVolumeAttachmentsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListInstanceVolumeAttachments") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVolumeAttachmentCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateInstanceVolumeAttachment : Create a volume attachment on an instance +// This request creates a new volume attachment from a volume attachment prototype object, connecting a volume to an +// instance. For this request to succeed, the specified volume must not be busy. The prototype object is structured in +// the same way as a retrieved volume attachment, and contains the information necessary to create the new volume +// attachment. +func (vpc *VpcV1) CreateInstanceVolumeAttachment(createInstanceVolumeAttachmentOptions *CreateInstanceVolumeAttachmentOptions) (result *VolumeAttachment, response *core.DetailedResponse, err error) { + return vpc.CreateInstanceVolumeAttachmentWithContext(context.Background(), createInstanceVolumeAttachmentOptions) +} + +// CreateInstanceVolumeAttachmentWithContext is an alternate form of the CreateInstanceVolumeAttachment method which supports a Context parameter +func (vpc *VpcV1) CreateInstanceVolumeAttachmentWithContext(ctx context.Context, createInstanceVolumeAttachmentOptions *CreateInstanceVolumeAttachmentOptions) (result *VolumeAttachment, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createInstanceVolumeAttachmentOptions, "createInstanceVolumeAttachmentOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createInstanceVolumeAttachmentOptions, "createInstanceVolumeAttachmentOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_id": *createInstanceVolumeAttachmentOptions.InstanceID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instances/{instance_id}/volume_attachments`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range createInstanceVolumeAttachmentOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateInstanceVolumeAttachment") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createInstanceVolumeAttachmentOptions.Volume != nil { + body["volume"] = createInstanceVolumeAttachmentOptions.Volume + } + if createInstanceVolumeAttachmentOptions.DeleteVolumeOnInstanceDelete != nil { + body["delete_volume_on_instance_delete"] = createInstanceVolumeAttachmentOptions.DeleteVolumeOnInstanceDelete + } + if createInstanceVolumeAttachmentOptions.Name != nil { + body["name"] = createInstanceVolumeAttachmentOptions.Name + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVolumeAttachment) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteInstanceVolumeAttachment : Delete a volume attachment +// This request deletes a volume attachment. This operation cannot be reversed, but a new volume attachment may +// subsequently be created for the volume. For this request to succeed, the volume must not be busy. +func (vpc *VpcV1) DeleteInstanceVolumeAttachment(deleteInstanceVolumeAttachmentOptions *DeleteInstanceVolumeAttachmentOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteInstanceVolumeAttachmentWithContext(context.Background(), deleteInstanceVolumeAttachmentOptions) +} + +// DeleteInstanceVolumeAttachmentWithContext is an alternate form of the DeleteInstanceVolumeAttachment method which supports a Context parameter +func (vpc *VpcV1) DeleteInstanceVolumeAttachmentWithContext(ctx context.Context, deleteInstanceVolumeAttachmentOptions *DeleteInstanceVolumeAttachmentOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteInstanceVolumeAttachmentOptions, "deleteInstanceVolumeAttachmentOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteInstanceVolumeAttachmentOptions, "deleteInstanceVolumeAttachmentOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_id": *deleteInstanceVolumeAttachmentOptions.InstanceID, + "id": *deleteInstanceVolumeAttachmentOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instances/{instance_id}/volume_attachments/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteInstanceVolumeAttachmentOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteInstanceVolumeAttachment") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetInstanceVolumeAttachment : Retrieve a volume attachment +// This request retrieves a single volume attachment specified by the identifier in the URL. +func (vpc *VpcV1) GetInstanceVolumeAttachment(getInstanceVolumeAttachmentOptions *GetInstanceVolumeAttachmentOptions) (result *VolumeAttachment, response *core.DetailedResponse, err error) { + return vpc.GetInstanceVolumeAttachmentWithContext(context.Background(), getInstanceVolumeAttachmentOptions) +} + +// GetInstanceVolumeAttachmentWithContext is an alternate form of the GetInstanceVolumeAttachment method which supports a Context parameter +func (vpc *VpcV1) GetInstanceVolumeAttachmentWithContext(ctx context.Context, getInstanceVolumeAttachmentOptions *GetInstanceVolumeAttachmentOptions) (result *VolumeAttachment, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getInstanceVolumeAttachmentOptions, "getInstanceVolumeAttachmentOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getInstanceVolumeAttachmentOptions, "getInstanceVolumeAttachmentOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_id": *getInstanceVolumeAttachmentOptions.InstanceID, + "id": *getInstanceVolumeAttachmentOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instances/{instance_id}/volume_attachments/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getInstanceVolumeAttachmentOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetInstanceVolumeAttachment") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVolumeAttachment) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateInstanceVolumeAttachment : Update a volume attachment +// This request updates a volume attachment with the information provided in a volume attachment patch object. The +// volume attachment patch object is structured in the same way as a retrieved volume attachment and needs to contain +// only the information to be updated. +func (vpc *VpcV1) UpdateInstanceVolumeAttachment(updateInstanceVolumeAttachmentOptions *UpdateInstanceVolumeAttachmentOptions) (result *VolumeAttachment, response *core.DetailedResponse, err error) { + return vpc.UpdateInstanceVolumeAttachmentWithContext(context.Background(), updateInstanceVolumeAttachmentOptions) +} + +// UpdateInstanceVolumeAttachmentWithContext is an alternate form of the UpdateInstanceVolumeAttachment method which supports a Context parameter +func (vpc *VpcV1) UpdateInstanceVolumeAttachmentWithContext(ctx context.Context, updateInstanceVolumeAttachmentOptions *UpdateInstanceVolumeAttachmentOptions) (result *VolumeAttachment, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateInstanceVolumeAttachmentOptions, "updateInstanceVolumeAttachmentOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateInstanceVolumeAttachmentOptions, "updateInstanceVolumeAttachmentOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_id": *updateInstanceVolumeAttachmentOptions.InstanceID, + "id": *updateInstanceVolumeAttachmentOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instances/{instance_id}/volume_attachments/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateInstanceVolumeAttachmentOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateInstanceVolumeAttachment") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateInstanceVolumeAttachmentOptions.VolumeAttachmentPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVolumeAttachment) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListInstanceGroups : List all instance groups +// This request lists all instance groups in the region. +func (vpc *VpcV1) ListInstanceGroups(listInstanceGroupsOptions *ListInstanceGroupsOptions) (result *InstanceGroupCollection, response *core.DetailedResponse, err error) { + return vpc.ListInstanceGroupsWithContext(context.Background(), listInstanceGroupsOptions) +} + +// ListInstanceGroupsWithContext is an alternate form of the ListInstanceGroups method which supports a Context parameter +func (vpc *VpcV1) ListInstanceGroupsWithContext(ctx context.Context, listInstanceGroupsOptions *ListInstanceGroupsOptions) (result *InstanceGroupCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listInstanceGroupsOptions, "listInstanceGroupsOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance_groups`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listInstanceGroupsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListInstanceGroups") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listInstanceGroupsOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listInstanceGroupsOptions.Start)) + } + if listInstanceGroupsOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listInstanceGroupsOptions.Limit)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceGroupCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateInstanceGroup : Create an instance group +// This request creates a new instance group. +func (vpc *VpcV1) CreateInstanceGroup(createInstanceGroupOptions *CreateInstanceGroupOptions) (result *InstanceGroup, response *core.DetailedResponse, err error) { + return vpc.CreateInstanceGroupWithContext(context.Background(), createInstanceGroupOptions) +} + +// CreateInstanceGroupWithContext is an alternate form of the CreateInstanceGroup method which supports a Context parameter +func (vpc *VpcV1) CreateInstanceGroupWithContext(ctx context.Context, createInstanceGroupOptions *CreateInstanceGroupOptions) (result *InstanceGroup, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createInstanceGroupOptions, "createInstanceGroupOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createInstanceGroupOptions, "createInstanceGroupOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance_groups`, nil) + if err != nil { + return + } + + for headerName, headerValue := range createInstanceGroupOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateInstanceGroup") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createInstanceGroupOptions.InstanceTemplate != nil { + body["instance_template"] = createInstanceGroupOptions.InstanceTemplate + } + if createInstanceGroupOptions.Subnets != nil { + body["subnets"] = createInstanceGroupOptions.Subnets + } + if createInstanceGroupOptions.ApplicationPort != nil { + body["application_port"] = createInstanceGroupOptions.ApplicationPort + } + if createInstanceGroupOptions.LoadBalancer != nil { + body["load_balancer"] = createInstanceGroupOptions.LoadBalancer + } + if createInstanceGroupOptions.LoadBalancerPool != nil { + body["load_balancer_pool"] = createInstanceGroupOptions.LoadBalancerPool + } + if createInstanceGroupOptions.MembershipCount != nil { + body["membership_count"] = createInstanceGroupOptions.MembershipCount + } + if createInstanceGroupOptions.Name != nil { + body["name"] = createInstanceGroupOptions.Name + } + if createInstanceGroupOptions.ResourceGroup != nil { + body["resource_group"] = createInstanceGroupOptions.ResourceGroup + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceGroup) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteInstanceGroup : Delete an instance group +// This request deletes an instance group. This operation cannot be reversed. Any instances associated with the group +// will be deleted. +func (vpc *VpcV1) DeleteInstanceGroup(deleteInstanceGroupOptions *DeleteInstanceGroupOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteInstanceGroupWithContext(context.Background(), deleteInstanceGroupOptions) +} + +// DeleteInstanceGroupWithContext is an alternate form of the DeleteInstanceGroup method which supports a Context parameter +func (vpc *VpcV1) DeleteInstanceGroupWithContext(ctx context.Context, deleteInstanceGroupOptions *DeleteInstanceGroupOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteInstanceGroupOptions, "deleteInstanceGroupOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteInstanceGroupOptions, "deleteInstanceGroupOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *deleteInstanceGroupOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance_groups/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteInstanceGroupOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteInstanceGroup") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetInstanceGroup : Retrieve an instance group +// This request retrieves a single instance group specified by identifier in the URL. +func (vpc *VpcV1) GetInstanceGroup(getInstanceGroupOptions *GetInstanceGroupOptions) (result *InstanceGroup, response *core.DetailedResponse, err error) { + return vpc.GetInstanceGroupWithContext(context.Background(), getInstanceGroupOptions) +} + +// GetInstanceGroupWithContext is an alternate form of the GetInstanceGroup method which supports a Context parameter +func (vpc *VpcV1) GetInstanceGroupWithContext(ctx context.Context, getInstanceGroupOptions *GetInstanceGroupOptions) (result *InstanceGroup, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getInstanceGroupOptions, "getInstanceGroupOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getInstanceGroupOptions, "getInstanceGroupOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getInstanceGroupOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance_groups/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getInstanceGroupOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetInstanceGroup") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceGroup) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateInstanceGroup : Update an instance group +// This request updates an instance group with the information provided instance group patch. The instance group patch +// object is structured in the same way as a retrieved instance group and contains only the information to be updated. +func (vpc *VpcV1) UpdateInstanceGroup(updateInstanceGroupOptions *UpdateInstanceGroupOptions) (result *InstanceGroup, response *core.DetailedResponse, err error) { + return vpc.UpdateInstanceGroupWithContext(context.Background(), updateInstanceGroupOptions) +} + +// UpdateInstanceGroupWithContext is an alternate form of the UpdateInstanceGroup method which supports a Context parameter +func (vpc *VpcV1) UpdateInstanceGroupWithContext(ctx context.Context, updateInstanceGroupOptions *UpdateInstanceGroupOptions) (result *InstanceGroup, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateInstanceGroupOptions, "updateInstanceGroupOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateInstanceGroupOptions, "updateInstanceGroupOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *updateInstanceGroupOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance_groups/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateInstanceGroupOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateInstanceGroup") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateInstanceGroupOptions.InstanceGroupPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceGroup) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteInstanceGroupLoadBalancer : Delete an instance group load balancer +// This request unbinds the instance group from the load balancer pool, and deletes the load balancer pool members. +func (vpc *VpcV1) DeleteInstanceGroupLoadBalancer(deleteInstanceGroupLoadBalancerOptions *DeleteInstanceGroupLoadBalancerOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteInstanceGroupLoadBalancerWithContext(context.Background(), deleteInstanceGroupLoadBalancerOptions) +} + +// DeleteInstanceGroupLoadBalancerWithContext is an alternate form of the DeleteInstanceGroupLoadBalancer method which supports a Context parameter +func (vpc *VpcV1) DeleteInstanceGroupLoadBalancerWithContext(ctx context.Context, deleteInstanceGroupLoadBalancerOptions *DeleteInstanceGroupLoadBalancerOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteInstanceGroupLoadBalancerOptions, "deleteInstanceGroupLoadBalancerOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteInstanceGroupLoadBalancerOptions, "deleteInstanceGroupLoadBalancerOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_group_id": *deleteInstanceGroupLoadBalancerOptions.InstanceGroupID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance_groups/{instance_group_id}/load_balancer`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteInstanceGroupLoadBalancerOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteInstanceGroupLoadBalancer") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// ListInstanceGroupManagers : List all managers for an instance group +// This request lists all managers for an instance group. +func (vpc *VpcV1) ListInstanceGroupManagers(listInstanceGroupManagersOptions *ListInstanceGroupManagersOptions) (result *InstanceGroupManagerCollection, response *core.DetailedResponse, err error) { + return vpc.ListInstanceGroupManagersWithContext(context.Background(), listInstanceGroupManagersOptions) +} + +// ListInstanceGroupManagersWithContext is an alternate form of the ListInstanceGroupManagers method which supports a Context parameter +func (vpc *VpcV1) ListInstanceGroupManagersWithContext(ctx context.Context, listInstanceGroupManagersOptions *ListInstanceGroupManagersOptions) (result *InstanceGroupManagerCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listInstanceGroupManagersOptions, "listInstanceGroupManagersOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listInstanceGroupManagersOptions, "listInstanceGroupManagersOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_group_id": *listInstanceGroupManagersOptions.InstanceGroupID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance_groups/{instance_group_id}/managers`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listInstanceGroupManagersOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListInstanceGroupManagers") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listInstanceGroupManagersOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listInstanceGroupManagersOptions.Start)) + } + if listInstanceGroupManagersOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listInstanceGroupManagersOptions.Limit)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceGroupManagerCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateInstanceGroupManager : Create a manager for an instance group +// This request creates a new instance group manager. +func (vpc *VpcV1) CreateInstanceGroupManager(createInstanceGroupManagerOptions *CreateInstanceGroupManagerOptions) (result InstanceGroupManagerIntf, response *core.DetailedResponse, err error) { + return vpc.CreateInstanceGroupManagerWithContext(context.Background(), createInstanceGroupManagerOptions) +} + +// CreateInstanceGroupManagerWithContext is an alternate form of the CreateInstanceGroupManager method which supports a Context parameter +func (vpc *VpcV1) CreateInstanceGroupManagerWithContext(ctx context.Context, createInstanceGroupManagerOptions *CreateInstanceGroupManagerOptions) (result InstanceGroupManagerIntf, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createInstanceGroupManagerOptions, "createInstanceGroupManagerOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createInstanceGroupManagerOptions, "createInstanceGroupManagerOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_group_id": *createInstanceGroupManagerOptions.InstanceGroupID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance_groups/{instance_group_id}/managers`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range createInstanceGroupManagerOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateInstanceGroupManager") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(createInstanceGroupManagerOptions.InstanceGroupManagerPrototype) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceGroupManager) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteInstanceGroupManager : Delete an instance group manager +// This request deletes an instance group manager. This operation cannot be reversed. +func (vpc *VpcV1) DeleteInstanceGroupManager(deleteInstanceGroupManagerOptions *DeleteInstanceGroupManagerOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteInstanceGroupManagerWithContext(context.Background(), deleteInstanceGroupManagerOptions) +} + +// DeleteInstanceGroupManagerWithContext is an alternate form of the DeleteInstanceGroupManager method which supports a Context parameter +func (vpc *VpcV1) DeleteInstanceGroupManagerWithContext(ctx context.Context, deleteInstanceGroupManagerOptions *DeleteInstanceGroupManagerOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteInstanceGroupManagerOptions, "deleteInstanceGroupManagerOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteInstanceGroupManagerOptions, "deleteInstanceGroupManagerOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_group_id": *deleteInstanceGroupManagerOptions.InstanceGroupID, + "id": *deleteInstanceGroupManagerOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance_groups/{instance_group_id}/managers/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteInstanceGroupManagerOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteInstanceGroupManager") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetInstanceGroupManager : Retrieve an instance group manager +// This request retrieves a single instance group manager specified by identifier in the URL. +func (vpc *VpcV1) GetInstanceGroupManager(getInstanceGroupManagerOptions *GetInstanceGroupManagerOptions) (result InstanceGroupManagerIntf, response *core.DetailedResponse, err error) { + return vpc.GetInstanceGroupManagerWithContext(context.Background(), getInstanceGroupManagerOptions) +} + +// GetInstanceGroupManagerWithContext is an alternate form of the GetInstanceGroupManager method which supports a Context parameter +func (vpc *VpcV1) GetInstanceGroupManagerWithContext(ctx context.Context, getInstanceGroupManagerOptions *GetInstanceGroupManagerOptions) (result InstanceGroupManagerIntf, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getInstanceGroupManagerOptions, "getInstanceGroupManagerOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getInstanceGroupManagerOptions, "getInstanceGroupManagerOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_group_id": *getInstanceGroupManagerOptions.InstanceGroupID, + "id": *getInstanceGroupManagerOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance_groups/{instance_group_id}/managers/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getInstanceGroupManagerOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetInstanceGroupManager") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceGroupManager) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateInstanceGroupManager : Update an instance group manager +// This request updates an instance group manager with the information provided instance group manager patch. +func (vpc *VpcV1) UpdateInstanceGroupManager(updateInstanceGroupManagerOptions *UpdateInstanceGroupManagerOptions) (result InstanceGroupManagerIntf, response *core.DetailedResponse, err error) { + return vpc.UpdateInstanceGroupManagerWithContext(context.Background(), updateInstanceGroupManagerOptions) +} + +// UpdateInstanceGroupManagerWithContext is an alternate form of the UpdateInstanceGroupManager method which supports a Context parameter +func (vpc *VpcV1) UpdateInstanceGroupManagerWithContext(ctx context.Context, updateInstanceGroupManagerOptions *UpdateInstanceGroupManagerOptions) (result InstanceGroupManagerIntf, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateInstanceGroupManagerOptions, "updateInstanceGroupManagerOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateInstanceGroupManagerOptions, "updateInstanceGroupManagerOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_group_id": *updateInstanceGroupManagerOptions.InstanceGroupID, + "id": *updateInstanceGroupManagerOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance_groups/{instance_group_id}/managers/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateInstanceGroupManagerOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateInstanceGroupManager") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateInstanceGroupManagerOptions.InstanceGroupManagerPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceGroupManager) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListInstanceGroupManagerActions : List all actions for an instance group manager +// This request lists all instance group actions for an instance group manager. +func (vpc *VpcV1) ListInstanceGroupManagerActions(listInstanceGroupManagerActionsOptions *ListInstanceGroupManagerActionsOptions) (result *InstanceGroupManagerActionsCollection, response *core.DetailedResponse, err error) { + return vpc.ListInstanceGroupManagerActionsWithContext(context.Background(), listInstanceGroupManagerActionsOptions) +} + +// ListInstanceGroupManagerActionsWithContext is an alternate form of the ListInstanceGroupManagerActions method which supports a Context parameter +func (vpc *VpcV1) ListInstanceGroupManagerActionsWithContext(ctx context.Context, listInstanceGroupManagerActionsOptions *ListInstanceGroupManagerActionsOptions) (result *InstanceGroupManagerActionsCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listInstanceGroupManagerActionsOptions, "listInstanceGroupManagerActionsOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listInstanceGroupManagerActionsOptions, "listInstanceGroupManagerActionsOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_group_id": *listInstanceGroupManagerActionsOptions.InstanceGroupID, + "instance_group_manager_id": *listInstanceGroupManagerActionsOptions.InstanceGroupManagerID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance_groups/{instance_group_id}/managers/{instance_group_manager_id}/actions`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listInstanceGroupManagerActionsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListInstanceGroupManagerActions") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listInstanceGroupManagerActionsOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listInstanceGroupManagerActionsOptions.Start)) + } + if listInstanceGroupManagerActionsOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listInstanceGroupManagerActionsOptions.Limit)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceGroupManagerActionsCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateInstanceGroupManagerAction : Create an instance group manager action +// This request creates a new instance group manager action. +func (vpc *VpcV1) CreateInstanceGroupManagerAction(createInstanceGroupManagerActionOptions *CreateInstanceGroupManagerActionOptions) (result InstanceGroupManagerActionIntf, response *core.DetailedResponse, err error) { + return vpc.CreateInstanceGroupManagerActionWithContext(context.Background(), createInstanceGroupManagerActionOptions) +} + +// CreateInstanceGroupManagerActionWithContext is an alternate form of the CreateInstanceGroupManagerAction method which supports a Context parameter +func (vpc *VpcV1) CreateInstanceGroupManagerActionWithContext(ctx context.Context, createInstanceGroupManagerActionOptions *CreateInstanceGroupManagerActionOptions) (result InstanceGroupManagerActionIntf, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createInstanceGroupManagerActionOptions, "createInstanceGroupManagerActionOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createInstanceGroupManagerActionOptions, "createInstanceGroupManagerActionOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_group_id": *createInstanceGroupManagerActionOptions.InstanceGroupID, + "instance_group_manager_id": *createInstanceGroupManagerActionOptions.InstanceGroupManagerID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance_groups/{instance_group_id}/managers/{instance_group_manager_id}/actions`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range createInstanceGroupManagerActionOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateInstanceGroupManagerAction") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(createInstanceGroupManagerActionOptions.InstanceGroupManagerActionPrototype) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceGroupManagerAction) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteInstanceGroupManagerAction : Delete specified instance group manager action +// This request deletes an instance group manager action. This operation cannot be reversed. +func (vpc *VpcV1) DeleteInstanceGroupManagerAction(deleteInstanceGroupManagerActionOptions *DeleteInstanceGroupManagerActionOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteInstanceGroupManagerActionWithContext(context.Background(), deleteInstanceGroupManagerActionOptions) +} + +// DeleteInstanceGroupManagerActionWithContext is an alternate form of the DeleteInstanceGroupManagerAction method which supports a Context parameter +func (vpc *VpcV1) DeleteInstanceGroupManagerActionWithContext(ctx context.Context, deleteInstanceGroupManagerActionOptions *DeleteInstanceGroupManagerActionOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteInstanceGroupManagerActionOptions, "deleteInstanceGroupManagerActionOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteInstanceGroupManagerActionOptions, "deleteInstanceGroupManagerActionOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_group_id": *deleteInstanceGroupManagerActionOptions.InstanceGroupID, + "instance_group_manager_id": *deleteInstanceGroupManagerActionOptions.InstanceGroupManagerID, + "id": *deleteInstanceGroupManagerActionOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance_groups/{instance_group_id}/managers/{instance_group_manager_id}/actions/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteInstanceGroupManagerActionOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteInstanceGroupManagerAction") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetInstanceGroupManagerAction : Retrieve specified instance group manager action +// This request retrieves a single instance group manager action specified by identifier in the URL. +func (vpc *VpcV1) GetInstanceGroupManagerAction(getInstanceGroupManagerActionOptions *GetInstanceGroupManagerActionOptions) (result InstanceGroupManagerActionIntf, response *core.DetailedResponse, err error) { + return vpc.GetInstanceGroupManagerActionWithContext(context.Background(), getInstanceGroupManagerActionOptions) +} + +// GetInstanceGroupManagerActionWithContext is an alternate form of the GetInstanceGroupManagerAction method which supports a Context parameter +func (vpc *VpcV1) GetInstanceGroupManagerActionWithContext(ctx context.Context, getInstanceGroupManagerActionOptions *GetInstanceGroupManagerActionOptions) (result InstanceGroupManagerActionIntf, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getInstanceGroupManagerActionOptions, "getInstanceGroupManagerActionOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getInstanceGroupManagerActionOptions, "getInstanceGroupManagerActionOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_group_id": *getInstanceGroupManagerActionOptions.InstanceGroupID, + "instance_group_manager_id": *getInstanceGroupManagerActionOptions.InstanceGroupManagerID, + "id": *getInstanceGroupManagerActionOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance_groups/{instance_group_id}/managers/{instance_group_manager_id}/actions/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getInstanceGroupManagerActionOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetInstanceGroupManagerAction") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceGroupManagerAction) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateInstanceGroupManagerAction : Update specified instance group manager action +// This request updates an instance group manager action. +func (vpc *VpcV1) UpdateInstanceGroupManagerAction(updateInstanceGroupManagerActionOptions *UpdateInstanceGroupManagerActionOptions) (result InstanceGroupManagerActionIntf, response *core.DetailedResponse, err error) { + return vpc.UpdateInstanceGroupManagerActionWithContext(context.Background(), updateInstanceGroupManagerActionOptions) +} + +// UpdateInstanceGroupManagerActionWithContext is an alternate form of the UpdateInstanceGroupManagerAction method which supports a Context parameter +func (vpc *VpcV1) UpdateInstanceGroupManagerActionWithContext(ctx context.Context, updateInstanceGroupManagerActionOptions *UpdateInstanceGroupManagerActionOptions) (result InstanceGroupManagerActionIntf, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateInstanceGroupManagerActionOptions, "updateInstanceGroupManagerActionOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateInstanceGroupManagerActionOptions, "updateInstanceGroupManagerActionOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_group_id": *updateInstanceGroupManagerActionOptions.InstanceGroupID, + "instance_group_manager_id": *updateInstanceGroupManagerActionOptions.InstanceGroupManagerID, + "id": *updateInstanceGroupManagerActionOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance_groups/{instance_group_id}/managers/{instance_group_manager_id}/actions/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateInstanceGroupManagerActionOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateInstanceGroupManagerAction") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateInstanceGroupManagerActionOptions.InstanceGroupManagerActionPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceGroupManagerAction) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListInstanceGroupManagerPolicies : List all policies for an instance group manager +// This request lists all policies for an instance group manager. +func (vpc *VpcV1) ListInstanceGroupManagerPolicies(listInstanceGroupManagerPoliciesOptions *ListInstanceGroupManagerPoliciesOptions) (result *InstanceGroupManagerPolicyCollection, response *core.DetailedResponse, err error) { + return vpc.ListInstanceGroupManagerPoliciesWithContext(context.Background(), listInstanceGroupManagerPoliciesOptions) +} + +// ListInstanceGroupManagerPoliciesWithContext is an alternate form of the ListInstanceGroupManagerPolicies method which supports a Context parameter +func (vpc *VpcV1) ListInstanceGroupManagerPoliciesWithContext(ctx context.Context, listInstanceGroupManagerPoliciesOptions *ListInstanceGroupManagerPoliciesOptions) (result *InstanceGroupManagerPolicyCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listInstanceGroupManagerPoliciesOptions, "listInstanceGroupManagerPoliciesOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listInstanceGroupManagerPoliciesOptions, "listInstanceGroupManagerPoliciesOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_group_id": *listInstanceGroupManagerPoliciesOptions.InstanceGroupID, + "instance_group_manager_id": *listInstanceGroupManagerPoliciesOptions.InstanceGroupManagerID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance_groups/{instance_group_id}/managers/{instance_group_manager_id}/policies`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listInstanceGroupManagerPoliciesOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListInstanceGroupManagerPolicies") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listInstanceGroupManagerPoliciesOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listInstanceGroupManagerPoliciesOptions.Start)) + } + if listInstanceGroupManagerPoliciesOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listInstanceGroupManagerPoliciesOptions.Limit)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceGroupManagerPolicyCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateInstanceGroupManagerPolicy : Create a policy for an instance group manager +// This request creates a new instance group manager policy. +func (vpc *VpcV1) CreateInstanceGroupManagerPolicy(createInstanceGroupManagerPolicyOptions *CreateInstanceGroupManagerPolicyOptions) (result InstanceGroupManagerPolicyIntf, response *core.DetailedResponse, err error) { + return vpc.CreateInstanceGroupManagerPolicyWithContext(context.Background(), createInstanceGroupManagerPolicyOptions) +} + +// CreateInstanceGroupManagerPolicyWithContext is an alternate form of the CreateInstanceGroupManagerPolicy method which supports a Context parameter +func (vpc *VpcV1) CreateInstanceGroupManagerPolicyWithContext(ctx context.Context, createInstanceGroupManagerPolicyOptions *CreateInstanceGroupManagerPolicyOptions) (result InstanceGroupManagerPolicyIntf, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createInstanceGroupManagerPolicyOptions, "createInstanceGroupManagerPolicyOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createInstanceGroupManagerPolicyOptions, "createInstanceGroupManagerPolicyOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_group_id": *createInstanceGroupManagerPolicyOptions.InstanceGroupID, + "instance_group_manager_id": *createInstanceGroupManagerPolicyOptions.InstanceGroupManagerID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance_groups/{instance_group_id}/managers/{instance_group_manager_id}/policies`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range createInstanceGroupManagerPolicyOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateInstanceGroupManagerPolicy") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(createInstanceGroupManagerPolicyOptions.InstanceGroupManagerPolicyPrototype) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceGroupManagerPolicy) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteInstanceGroupManagerPolicy : Delete an instance group manager policy +// This request deletes an instance group manager policy. This operation cannot be reversed. +func (vpc *VpcV1) DeleteInstanceGroupManagerPolicy(deleteInstanceGroupManagerPolicyOptions *DeleteInstanceGroupManagerPolicyOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteInstanceGroupManagerPolicyWithContext(context.Background(), deleteInstanceGroupManagerPolicyOptions) +} + +// DeleteInstanceGroupManagerPolicyWithContext is an alternate form of the DeleteInstanceGroupManagerPolicy method which supports a Context parameter +func (vpc *VpcV1) DeleteInstanceGroupManagerPolicyWithContext(ctx context.Context, deleteInstanceGroupManagerPolicyOptions *DeleteInstanceGroupManagerPolicyOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteInstanceGroupManagerPolicyOptions, "deleteInstanceGroupManagerPolicyOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteInstanceGroupManagerPolicyOptions, "deleteInstanceGroupManagerPolicyOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_group_id": *deleteInstanceGroupManagerPolicyOptions.InstanceGroupID, + "instance_group_manager_id": *deleteInstanceGroupManagerPolicyOptions.InstanceGroupManagerID, + "id": *deleteInstanceGroupManagerPolicyOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance_groups/{instance_group_id}/managers/{instance_group_manager_id}/policies/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteInstanceGroupManagerPolicyOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteInstanceGroupManagerPolicy") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetInstanceGroupManagerPolicy : Retrieve an instance group manager policy +// This request retrieves a single instance group manager policy specified by identifier in the URL. +func (vpc *VpcV1) GetInstanceGroupManagerPolicy(getInstanceGroupManagerPolicyOptions *GetInstanceGroupManagerPolicyOptions) (result InstanceGroupManagerPolicyIntf, response *core.DetailedResponse, err error) { + return vpc.GetInstanceGroupManagerPolicyWithContext(context.Background(), getInstanceGroupManagerPolicyOptions) +} + +// GetInstanceGroupManagerPolicyWithContext is an alternate form of the GetInstanceGroupManagerPolicy method which supports a Context parameter +func (vpc *VpcV1) GetInstanceGroupManagerPolicyWithContext(ctx context.Context, getInstanceGroupManagerPolicyOptions *GetInstanceGroupManagerPolicyOptions) (result InstanceGroupManagerPolicyIntf, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getInstanceGroupManagerPolicyOptions, "getInstanceGroupManagerPolicyOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getInstanceGroupManagerPolicyOptions, "getInstanceGroupManagerPolicyOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_group_id": *getInstanceGroupManagerPolicyOptions.InstanceGroupID, + "instance_group_manager_id": *getInstanceGroupManagerPolicyOptions.InstanceGroupManagerID, + "id": *getInstanceGroupManagerPolicyOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance_groups/{instance_group_id}/managers/{instance_group_manager_id}/policies/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getInstanceGroupManagerPolicyOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetInstanceGroupManagerPolicy") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceGroupManagerPolicy) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateInstanceGroupManagerPolicy : Update an instance group manager policy +// This request updates an instance group manager policy. +func (vpc *VpcV1) UpdateInstanceGroupManagerPolicy(updateInstanceGroupManagerPolicyOptions *UpdateInstanceGroupManagerPolicyOptions) (result InstanceGroupManagerPolicyIntf, response *core.DetailedResponse, err error) { + return vpc.UpdateInstanceGroupManagerPolicyWithContext(context.Background(), updateInstanceGroupManagerPolicyOptions) +} + +// UpdateInstanceGroupManagerPolicyWithContext is an alternate form of the UpdateInstanceGroupManagerPolicy method which supports a Context parameter +func (vpc *VpcV1) UpdateInstanceGroupManagerPolicyWithContext(ctx context.Context, updateInstanceGroupManagerPolicyOptions *UpdateInstanceGroupManagerPolicyOptions) (result InstanceGroupManagerPolicyIntf, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateInstanceGroupManagerPolicyOptions, "updateInstanceGroupManagerPolicyOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateInstanceGroupManagerPolicyOptions, "updateInstanceGroupManagerPolicyOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_group_id": *updateInstanceGroupManagerPolicyOptions.InstanceGroupID, + "instance_group_manager_id": *updateInstanceGroupManagerPolicyOptions.InstanceGroupManagerID, + "id": *updateInstanceGroupManagerPolicyOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance_groups/{instance_group_id}/managers/{instance_group_manager_id}/policies/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateInstanceGroupManagerPolicyOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateInstanceGroupManagerPolicy") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateInstanceGroupManagerPolicyOptions.InstanceGroupManagerPolicyPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceGroupManagerPolicy) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteInstanceGroupMemberships : Delete all memberships from an instance group +// This request deletes all memberships of an instance group. This operation cannot be reversed. reversed. Any +// memberships that have `delete_instance_on_membership_delete` set to `true` will also have their instances deleted. +func (vpc *VpcV1) DeleteInstanceGroupMemberships(deleteInstanceGroupMembershipsOptions *DeleteInstanceGroupMembershipsOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteInstanceGroupMembershipsWithContext(context.Background(), deleteInstanceGroupMembershipsOptions) +} + +// DeleteInstanceGroupMembershipsWithContext is an alternate form of the DeleteInstanceGroupMemberships method which supports a Context parameter +func (vpc *VpcV1) DeleteInstanceGroupMembershipsWithContext(ctx context.Context, deleteInstanceGroupMembershipsOptions *DeleteInstanceGroupMembershipsOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteInstanceGroupMembershipsOptions, "deleteInstanceGroupMembershipsOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteInstanceGroupMembershipsOptions, "deleteInstanceGroupMembershipsOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_group_id": *deleteInstanceGroupMembershipsOptions.InstanceGroupID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance_groups/{instance_group_id}/memberships`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteInstanceGroupMembershipsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteInstanceGroupMemberships") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// ListInstanceGroupMemberships : List all memberships for an instance group +// This request lists all instance group memberships for an instance group. +func (vpc *VpcV1) ListInstanceGroupMemberships(listInstanceGroupMembershipsOptions *ListInstanceGroupMembershipsOptions) (result *InstanceGroupMembershipCollection, response *core.DetailedResponse, err error) { + return vpc.ListInstanceGroupMembershipsWithContext(context.Background(), listInstanceGroupMembershipsOptions) +} + +// ListInstanceGroupMembershipsWithContext is an alternate form of the ListInstanceGroupMemberships method which supports a Context parameter +func (vpc *VpcV1) ListInstanceGroupMembershipsWithContext(ctx context.Context, listInstanceGroupMembershipsOptions *ListInstanceGroupMembershipsOptions) (result *InstanceGroupMembershipCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listInstanceGroupMembershipsOptions, "listInstanceGroupMembershipsOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listInstanceGroupMembershipsOptions, "listInstanceGroupMembershipsOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_group_id": *listInstanceGroupMembershipsOptions.InstanceGroupID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance_groups/{instance_group_id}/memberships`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listInstanceGroupMembershipsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListInstanceGroupMemberships") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listInstanceGroupMembershipsOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listInstanceGroupMembershipsOptions.Start)) + } + if listInstanceGroupMembershipsOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listInstanceGroupMembershipsOptions.Limit)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceGroupMembershipCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteInstanceGroupMembership : Delete an instance group membership +// This request deletes a memberships of an instance group. This operation cannot be reversed. reversed. If the +// membership has `delete_instance_on_membership_delete` set to `true`, the instance will also be deleted. +func (vpc *VpcV1) DeleteInstanceGroupMembership(deleteInstanceGroupMembershipOptions *DeleteInstanceGroupMembershipOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteInstanceGroupMembershipWithContext(context.Background(), deleteInstanceGroupMembershipOptions) +} + +// DeleteInstanceGroupMembershipWithContext is an alternate form of the DeleteInstanceGroupMembership method which supports a Context parameter +func (vpc *VpcV1) DeleteInstanceGroupMembershipWithContext(ctx context.Context, deleteInstanceGroupMembershipOptions *DeleteInstanceGroupMembershipOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteInstanceGroupMembershipOptions, "deleteInstanceGroupMembershipOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteInstanceGroupMembershipOptions, "deleteInstanceGroupMembershipOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_group_id": *deleteInstanceGroupMembershipOptions.InstanceGroupID, + "id": *deleteInstanceGroupMembershipOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance_groups/{instance_group_id}/memberships/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteInstanceGroupMembershipOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteInstanceGroupMembership") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetInstanceGroupMembership : Retrieve an instance group membership +// This request retrieves a single instance group membership specified by identifier in the URL. +func (vpc *VpcV1) GetInstanceGroupMembership(getInstanceGroupMembershipOptions *GetInstanceGroupMembershipOptions) (result *InstanceGroupMembership, response *core.DetailedResponse, err error) { + return vpc.GetInstanceGroupMembershipWithContext(context.Background(), getInstanceGroupMembershipOptions) +} + +// GetInstanceGroupMembershipWithContext is an alternate form of the GetInstanceGroupMembership method which supports a Context parameter +func (vpc *VpcV1) GetInstanceGroupMembershipWithContext(ctx context.Context, getInstanceGroupMembershipOptions *GetInstanceGroupMembershipOptions) (result *InstanceGroupMembership, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getInstanceGroupMembershipOptions, "getInstanceGroupMembershipOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getInstanceGroupMembershipOptions, "getInstanceGroupMembershipOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_group_id": *getInstanceGroupMembershipOptions.InstanceGroupID, + "id": *getInstanceGroupMembershipOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance_groups/{instance_group_id}/memberships/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getInstanceGroupMembershipOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetInstanceGroupMembership") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceGroupMembership) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateInstanceGroupMembership : Update an instance group membership +// This request updates an instance group membership with the information provided instance group membership patch. +func (vpc *VpcV1) UpdateInstanceGroupMembership(updateInstanceGroupMembershipOptions *UpdateInstanceGroupMembershipOptions) (result *InstanceGroupMembership, response *core.DetailedResponse, err error) { + return vpc.UpdateInstanceGroupMembershipWithContext(context.Background(), updateInstanceGroupMembershipOptions) +} + +// UpdateInstanceGroupMembershipWithContext is an alternate form of the UpdateInstanceGroupMembership method which supports a Context parameter +func (vpc *VpcV1) UpdateInstanceGroupMembershipWithContext(ctx context.Context, updateInstanceGroupMembershipOptions *UpdateInstanceGroupMembershipOptions) (result *InstanceGroupMembership, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateInstanceGroupMembershipOptions, "updateInstanceGroupMembershipOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateInstanceGroupMembershipOptions, "updateInstanceGroupMembershipOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "instance_group_id": *updateInstanceGroupMembershipOptions.InstanceGroupID, + "id": *updateInstanceGroupMembershipOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/instance_groups/{instance_group_id}/memberships/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateInstanceGroupMembershipOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateInstanceGroupMembership") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateInstanceGroupMembershipOptions.InstanceGroupMembershipPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalInstanceGroupMembership) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListDedicatedHostGroups : List all dedicated host groups +// This request lists all dedicated host groups in the region. Host groups are a collection of dedicated hosts for +// placement of instances. Each dedicated host must belong to one and only one group. Host groups do not span zones. +func (vpc *VpcV1) ListDedicatedHostGroups(listDedicatedHostGroupsOptions *ListDedicatedHostGroupsOptions) (result *DedicatedHostGroupCollection, response *core.DetailedResponse, err error) { + return vpc.ListDedicatedHostGroupsWithContext(context.Background(), listDedicatedHostGroupsOptions) +} + +// ListDedicatedHostGroupsWithContext is an alternate form of the ListDedicatedHostGroups method which supports a Context parameter +func (vpc *VpcV1) ListDedicatedHostGroupsWithContext(ctx context.Context, listDedicatedHostGroupsOptions *ListDedicatedHostGroupsOptions) (result *DedicatedHostGroupCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listDedicatedHostGroupsOptions, "listDedicatedHostGroupsOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/dedicated_host/groups`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listDedicatedHostGroupsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListDedicatedHostGroups") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listDedicatedHostGroupsOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listDedicatedHostGroupsOptions.Start)) + } + if listDedicatedHostGroupsOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listDedicatedHostGroupsOptions.Limit)) + } + if listDedicatedHostGroupsOptions.ResourceGroupID != nil { + builder.AddQuery("resource_group.id", fmt.Sprint(*listDedicatedHostGroupsOptions.ResourceGroupID)) + } + if listDedicatedHostGroupsOptions.ZoneName != nil { + builder.AddQuery("zone.name", fmt.Sprint(*listDedicatedHostGroupsOptions.ZoneName)) + } + if listDedicatedHostGroupsOptions.Name != nil { + builder.AddQuery("name", fmt.Sprint(*listDedicatedHostGroupsOptions.Name)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalDedicatedHostGroupCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateDedicatedHostGroup : Create a dedicated host group +// This request creates a new dedicated host group. +func (vpc *VpcV1) CreateDedicatedHostGroup(createDedicatedHostGroupOptions *CreateDedicatedHostGroupOptions) (result *DedicatedHostGroup, response *core.DetailedResponse, err error) { + return vpc.CreateDedicatedHostGroupWithContext(context.Background(), createDedicatedHostGroupOptions) +} + +// CreateDedicatedHostGroupWithContext is an alternate form of the CreateDedicatedHostGroup method which supports a Context parameter +func (vpc *VpcV1) CreateDedicatedHostGroupWithContext(ctx context.Context, createDedicatedHostGroupOptions *CreateDedicatedHostGroupOptions) (result *DedicatedHostGroup, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createDedicatedHostGroupOptions, "createDedicatedHostGroupOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createDedicatedHostGroupOptions, "createDedicatedHostGroupOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/dedicated_host/groups`, nil) + if err != nil { + return + } + + for headerName, headerValue := range createDedicatedHostGroupOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateDedicatedHostGroup") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createDedicatedHostGroupOptions.Class != nil { + body["class"] = createDedicatedHostGroupOptions.Class + } + if createDedicatedHostGroupOptions.Family != nil { + body["family"] = createDedicatedHostGroupOptions.Family + } + if createDedicatedHostGroupOptions.Zone != nil { + body["zone"] = createDedicatedHostGroupOptions.Zone + } + if createDedicatedHostGroupOptions.Name != nil { + body["name"] = createDedicatedHostGroupOptions.Name + } + if createDedicatedHostGroupOptions.ResourceGroup != nil { + body["resource_group"] = createDedicatedHostGroupOptions.ResourceGroup + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalDedicatedHostGroup) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteDedicatedHostGroup : Delete a dedicated host group +// This request deletes a dedicated host group. +func (vpc *VpcV1) DeleteDedicatedHostGroup(deleteDedicatedHostGroupOptions *DeleteDedicatedHostGroupOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteDedicatedHostGroupWithContext(context.Background(), deleteDedicatedHostGroupOptions) +} + +// DeleteDedicatedHostGroupWithContext is an alternate form of the DeleteDedicatedHostGroup method which supports a Context parameter +func (vpc *VpcV1) DeleteDedicatedHostGroupWithContext(ctx context.Context, deleteDedicatedHostGroupOptions *DeleteDedicatedHostGroupOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteDedicatedHostGroupOptions, "deleteDedicatedHostGroupOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteDedicatedHostGroupOptions, "deleteDedicatedHostGroupOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *deleteDedicatedHostGroupOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/dedicated_host/groups/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteDedicatedHostGroupOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteDedicatedHostGroup") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetDedicatedHostGroup : Retrieve a dedicated host group +// This request retrieves a single dedicated host group specified by the identifier in the URL. +func (vpc *VpcV1) GetDedicatedHostGroup(getDedicatedHostGroupOptions *GetDedicatedHostGroupOptions) (result *DedicatedHostGroup, response *core.DetailedResponse, err error) { + return vpc.GetDedicatedHostGroupWithContext(context.Background(), getDedicatedHostGroupOptions) +} + +// GetDedicatedHostGroupWithContext is an alternate form of the GetDedicatedHostGroup method which supports a Context parameter +func (vpc *VpcV1) GetDedicatedHostGroupWithContext(ctx context.Context, getDedicatedHostGroupOptions *GetDedicatedHostGroupOptions) (result *DedicatedHostGroup, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getDedicatedHostGroupOptions, "getDedicatedHostGroupOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getDedicatedHostGroupOptions, "getDedicatedHostGroupOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getDedicatedHostGroupOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/dedicated_host/groups/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getDedicatedHostGroupOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetDedicatedHostGroup") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalDedicatedHostGroup) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateDedicatedHostGroup : Update a dedicated host group +// This request updates a dedicated host group with the information in a provided dedicated host group patch. The +// dedicated host group patch object is structured in the same way as a retrieved dedicated host group and contains only +// the information to be updated. +func (vpc *VpcV1) UpdateDedicatedHostGroup(updateDedicatedHostGroupOptions *UpdateDedicatedHostGroupOptions) (result *DedicatedHostGroup, response *core.DetailedResponse, err error) { + return vpc.UpdateDedicatedHostGroupWithContext(context.Background(), updateDedicatedHostGroupOptions) +} + +// UpdateDedicatedHostGroupWithContext is an alternate form of the UpdateDedicatedHostGroup method which supports a Context parameter +func (vpc *VpcV1) UpdateDedicatedHostGroupWithContext(ctx context.Context, updateDedicatedHostGroupOptions *UpdateDedicatedHostGroupOptions) (result *DedicatedHostGroup, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateDedicatedHostGroupOptions, "updateDedicatedHostGroupOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateDedicatedHostGroupOptions, "updateDedicatedHostGroupOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *updateDedicatedHostGroupOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/dedicated_host/groups/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateDedicatedHostGroupOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateDedicatedHostGroup") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateDedicatedHostGroupOptions.DedicatedHostGroupPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalDedicatedHostGroup) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListDedicatedHostProfiles : List all dedicated host profiles +// This request lists provisionable [dedicated host profiles](https://cloud.ibm.com/docs/vpc?topic=vpc-dh-profiles) in +// the region. A dedicated host profile specifies the hardware characteristics for a dedicated host. +func (vpc *VpcV1) ListDedicatedHostProfiles(listDedicatedHostProfilesOptions *ListDedicatedHostProfilesOptions) (result *DedicatedHostProfileCollection, response *core.DetailedResponse, err error) { + return vpc.ListDedicatedHostProfilesWithContext(context.Background(), listDedicatedHostProfilesOptions) +} + +// ListDedicatedHostProfilesWithContext is an alternate form of the ListDedicatedHostProfiles method which supports a Context parameter +func (vpc *VpcV1) ListDedicatedHostProfilesWithContext(ctx context.Context, listDedicatedHostProfilesOptions *ListDedicatedHostProfilesOptions) (result *DedicatedHostProfileCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listDedicatedHostProfilesOptions, "listDedicatedHostProfilesOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/dedicated_host/profiles`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listDedicatedHostProfilesOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListDedicatedHostProfiles") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listDedicatedHostProfilesOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listDedicatedHostProfilesOptions.Start)) + } + if listDedicatedHostProfilesOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listDedicatedHostProfilesOptions.Limit)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalDedicatedHostProfileCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// GetDedicatedHostProfile : Retrieve a dedicated host profile +// This request retrieves a single dedicated host profile specified by the name in the URL. +func (vpc *VpcV1) GetDedicatedHostProfile(getDedicatedHostProfileOptions *GetDedicatedHostProfileOptions) (result *DedicatedHostProfile, response *core.DetailedResponse, err error) { + return vpc.GetDedicatedHostProfileWithContext(context.Background(), getDedicatedHostProfileOptions) +} + +// GetDedicatedHostProfileWithContext is an alternate form of the GetDedicatedHostProfile method which supports a Context parameter +func (vpc *VpcV1) GetDedicatedHostProfileWithContext(ctx context.Context, getDedicatedHostProfileOptions *GetDedicatedHostProfileOptions) (result *DedicatedHostProfile, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getDedicatedHostProfileOptions, "getDedicatedHostProfileOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getDedicatedHostProfileOptions, "getDedicatedHostProfileOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "name": *getDedicatedHostProfileOptions.Name, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/dedicated_host/profiles/{name}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getDedicatedHostProfileOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetDedicatedHostProfile") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalDedicatedHostProfile) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListDedicatedHosts : List all dedicated hosts +// This request lists all dedicated hosts in the region. +func (vpc *VpcV1) ListDedicatedHosts(listDedicatedHostsOptions *ListDedicatedHostsOptions) (result *DedicatedHostCollection, response *core.DetailedResponse, err error) { + return vpc.ListDedicatedHostsWithContext(context.Background(), listDedicatedHostsOptions) +} + +// ListDedicatedHostsWithContext is an alternate form of the ListDedicatedHosts method which supports a Context parameter +func (vpc *VpcV1) ListDedicatedHostsWithContext(ctx context.Context, listDedicatedHostsOptions *ListDedicatedHostsOptions) (result *DedicatedHostCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listDedicatedHostsOptions, "listDedicatedHostsOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/dedicated_hosts`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listDedicatedHostsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListDedicatedHosts") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listDedicatedHostsOptions.DedicatedHostGroupID != nil { + builder.AddQuery("dedicated_host_group.id", fmt.Sprint(*listDedicatedHostsOptions.DedicatedHostGroupID)) + } + if listDedicatedHostsOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listDedicatedHostsOptions.Start)) + } + if listDedicatedHostsOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listDedicatedHostsOptions.Limit)) + } + if listDedicatedHostsOptions.ResourceGroupID != nil { + builder.AddQuery("resource_group.id", fmt.Sprint(*listDedicatedHostsOptions.ResourceGroupID)) + } + if listDedicatedHostsOptions.ZoneName != nil { + builder.AddQuery("zone.name", fmt.Sprint(*listDedicatedHostsOptions.ZoneName)) + } + if listDedicatedHostsOptions.Name != nil { + builder.AddQuery("name", fmt.Sprint(*listDedicatedHostsOptions.Name)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalDedicatedHostCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateDedicatedHost : Create a dedicated host +// This request creates a new dedicated host. +func (vpc *VpcV1) CreateDedicatedHost(createDedicatedHostOptions *CreateDedicatedHostOptions) (result *DedicatedHost, response *core.DetailedResponse, err error) { + return vpc.CreateDedicatedHostWithContext(context.Background(), createDedicatedHostOptions) +} + +// CreateDedicatedHostWithContext is an alternate form of the CreateDedicatedHost method which supports a Context parameter +func (vpc *VpcV1) CreateDedicatedHostWithContext(ctx context.Context, createDedicatedHostOptions *CreateDedicatedHostOptions) (result *DedicatedHost, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createDedicatedHostOptions, "createDedicatedHostOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createDedicatedHostOptions, "createDedicatedHostOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/dedicated_hosts`, nil) + if err != nil { + return + } + + for headerName, headerValue := range createDedicatedHostOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateDedicatedHost") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(createDedicatedHostOptions.DedicatedHostPrototype) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalDedicatedHost) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListDedicatedHostDisks : List all disks on a dedicated host +// This request lists all disks on a dedicated host. A disk is a physical device that is locally attached to the +// compute node. By default, the listed disks are sorted by their +// `created_at` property values, with the newest disk first. +func (vpc *VpcV1) ListDedicatedHostDisks(listDedicatedHostDisksOptions *ListDedicatedHostDisksOptions) (result *DedicatedHostDiskCollection, response *core.DetailedResponse, err error) { + return vpc.ListDedicatedHostDisksWithContext(context.Background(), listDedicatedHostDisksOptions) +} + +// ListDedicatedHostDisksWithContext is an alternate form of the ListDedicatedHostDisks method which supports a Context parameter +func (vpc *VpcV1) ListDedicatedHostDisksWithContext(ctx context.Context, listDedicatedHostDisksOptions *ListDedicatedHostDisksOptions) (result *DedicatedHostDiskCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listDedicatedHostDisksOptions, "listDedicatedHostDisksOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listDedicatedHostDisksOptions, "listDedicatedHostDisksOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "dedicated_host_id": *listDedicatedHostDisksOptions.DedicatedHostID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/dedicated_hosts/{dedicated_host_id}/disks`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listDedicatedHostDisksOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListDedicatedHostDisks") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalDedicatedHostDiskCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// GetDedicatedHostDisk : Retrieve a dedicated host disk +// This request retrieves a single dedicated host disk specified by the identifier in the URL. +func (vpc *VpcV1) GetDedicatedHostDisk(getDedicatedHostDiskOptions *GetDedicatedHostDiskOptions) (result *DedicatedHostDisk, response *core.DetailedResponse, err error) { + return vpc.GetDedicatedHostDiskWithContext(context.Background(), getDedicatedHostDiskOptions) +} + +// GetDedicatedHostDiskWithContext is an alternate form of the GetDedicatedHostDisk method which supports a Context parameter +func (vpc *VpcV1) GetDedicatedHostDiskWithContext(ctx context.Context, getDedicatedHostDiskOptions *GetDedicatedHostDiskOptions) (result *DedicatedHostDisk, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getDedicatedHostDiskOptions, "getDedicatedHostDiskOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getDedicatedHostDiskOptions, "getDedicatedHostDiskOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "dedicated_host_id": *getDedicatedHostDiskOptions.DedicatedHostID, + "id": *getDedicatedHostDiskOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/dedicated_hosts/{dedicated_host_id}/disks/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getDedicatedHostDiskOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetDedicatedHostDisk") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalDedicatedHostDisk) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateDedicatedHostDisk : Update a dedicated host disk +// This request updates the dedicated host disk with the information in a provided patch. +func (vpc *VpcV1) UpdateDedicatedHostDisk(updateDedicatedHostDiskOptions *UpdateDedicatedHostDiskOptions) (result *DedicatedHostDisk, response *core.DetailedResponse, err error) { + return vpc.UpdateDedicatedHostDiskWithContext(context.Background(), updateDedicatedHostDiskOptions) +} + +// UpdateDedicatedHostDiskWithContext is an alternate form of the UpdateDedicatedHostDisk method which supports a Context parameter +func (vpc *VpcV1) UpdateDedicatedHostDiskWithContext(ctx context.Context, updateDedicatedHostDiskOptions *UpdateDedicatedHostDiskOptions) (result *DedicatedHostDisk, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateDedicatedHostDiskOptions, "updateDedicatedHostDiskOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateDedicatedHostDiskOptions, "updateDedicatedHostDiskOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "dedicated_host_id": *updateDedicatedHostDiskOptions.DedicatedHostID, + "id": *updateDedicatedHostDiskOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/dedicated_hosts/{dedicated_host_id}/disks/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateDedicatedHostDiskOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateDedicatedHostDisk") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateDedicatedHostDiskOptions.DedicatedHostDiskPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalDedicatedHostDisk) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteDedicatedHost : Delete a dedicated host +// This request deletes a dedicated host. +func (vpc *VpcV1) DeleteDedicatedHost(deleteDedicatedHostOptions *DeleteDedicatedHostOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteDedicatedHostWithContext(context.Background(), deleteDedicatedHostOptions) +} + +// DeleteDedicatedHostWithContext is an alternate form of the DeleteDedicatedHost method which supports a Context parameter +func (vpc *VpcV1) DeleteDedicatedHostWithContext(ctx context.Context, deleteDedicatedHostOptions *DeleteDedicatedHostOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteDedicatedHostOptions, "deleteDedicatedHostOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteDedicatedHostOptions, "deleteDedicatedHostOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *deleteDedicatedHostOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/dedicated_hosts/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteDedicatedHostOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteDedicatedHost") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetDedicatedHost : Retrieve a dedicated host +// This request retrieves a single dedicated host specified by the identifiers in the URL. +func (vpc *VpcV1) GetDedicatedHost(getDedicatedHostOptions *GetDedicatedHostOptions) (result *DedicatedHost, response *core.DetailedResponse, err error) { + return vpc.GetDedicatedHostWithContext(context.Background(), getDedicatedHostOptions) +} + +// GetDedicatedHostWithContext is an alternate form of the GetDedicatedHost method which supports a Context parameter +func (vpc *VpcV1) GetDedicatedHostWithContext(ctx context.Context, getDedicatedHostOptions *GetDedicatedHostOptions) (result *DedicatedHost, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getDedicatedHostOptions, "getDedicatedHostOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getDedicatedHostOptions, "getDedicatedHostOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getDedicatedHostOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/dedicated_hosts/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getDedicatedHostOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetDedicatedHost") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalDedicatedHost) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateDedicatedHost : Update a dedicated host +// This request updates a dedicated host with the information in a provided dedicated host patch. The dedicated host +// patch object is structured in the same way as a retrieved dedicated host and contains only the information to be +// updated. +func (vpc *VpcV1) UpdateDedicatedHost(updateDedicatedHostOptions *UpdateDedicatedHostOptions) (result *DedicatedHost, response *core.DetailedResponse, err error) { + return vpc.UpdateDedicatedHostWithContext(context.Background(), updateDedicatedHostOptions) +} + +// UpdateDedicatedHostWithContext is an alternate form of the UpdateDedicatedHost method which supports a Context parameter +func (vpc *VpcV1) UpdateDedicatedHostWithContext(ctx context.Context, updateDedicatedHostOptions *UpdateDedicatedHostOptions) (result *DedicatedHost, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateDedicatedHostOptions, "updateDedicatedHostOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateDedicatedHostOptions, "updateDedicatedHostOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *updateDedicatedHostOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/dedicated_hosts/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateDedicatedHostOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateDedicatedHost") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateDedicatedHostOptions.DedicatedHostPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalDedicatedHost) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListBackupPolicies : List all backup policies +// This request lists all backup policies in the region. Backup policies control which sources are selected for backup +// and include a set of backup policy plans that provide the backup schedules and deletion triggers. +func (vpc *VpcV1) ListBackupPolicies(listBackupPoliciesOptions *ListBackupPoliciesOptions) (result *BackupPolicyCollection, response *core.DetailedResponse, err error) { + return vpc.ListBackupPoliciesWithContext(context.Background(), listBackupPoliciesOptions) +} + +// ListBackupPoliciesWithContext is an alternate form of the ListBackupPolicies method which supports a Context parameter +func (vpc *VpcV1) ListBackupPoliciesWithContext(ctx context.Context, listBackupPoliciesOptions *ListBackupPoliciesOptions) (result *BackupPolicyCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listBackupPoliciesOptions, "listBackupPoliciesOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/backup_policies`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listBackupPoliciesOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListBackupPolicies") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listBackupPoliciesOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listBackupPoliciesOptions.Start)) + } + if listBackupPoliciesOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listBackupPoliciesOptions.Limit)) + } + if listBackupPoliciesOptions.ResourceGroupID != nil { + builder.AddQuery("resource_group.id", fmt.Sprint(*listBackupPoliciesOptions.ResourceGroupID)) + } + if listBackupPoliciesOptions.Name != nil { + builder.AddQuery("name", fmt.Sprint(*listBackupPoliciesOptions.Name)) + } + if listBackupPoliciesOptions.Tag != nil { + builder.AddQuery("tag", fmt.Sprint(*listBackupPoliciesOptions.Tag)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalBackupPolicyCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateBackupPolicy : Create a backup policy +// This request creates a new backup policy from a backup policy prototype object. The prototype object is structured in +// the same way as a retrieved backup policy, and contains the information necessary to create the new backup policy. +func (vpc *VpcV1) CreateBackupPolicy(createBackupPolicyOptions *CreateBackupPolicyOptions) (result *BackupPolicy, response *core.DetailedResponse, err error) { + return vpc.CreateBackupPolicyWithContext(context.Background(), createBackupPolicyOptions) +} + +// CreateBackupPolicyWithContext is an alternate form of the CreateBackupPolicy method which supports a Context parameter +func (vpc *VpcV1) CreateBackupPolicyWithContext(ctx context.Context, createBackupPolicyOptions *CreateBackupPolicyOptions) (result *BackupPolicy, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createBackupPolicyOptions, "createBackupPolicyOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createBackupPolicyOptions, "createBackupPolicyOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/backup_policies`, nil) + if err != nil { + return + } + + for headerName, headerValue := range createBackupPolicyOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateBackupPolicy") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createBackupPolicyOptions.MatchUserTags != nil { + body["match_user_tags"] = createBackupPolicyOptions.MatchUserTags + } + if createBackupPolicyOptions.MatchResourceTypes != nil { + body["match_resource_types"] = createBackupPolicyOptions.MatchResourceTypes + } + if createBackupPolicyOptions.Name != nil { + body["name"] = createBackupPolicyOptions.Name + } + if createBackupPolicyOptions.Plans != nil { + body["plans"] = createBackupPolicyOptions.Plans + } + if createBackupPolicyOptions.ResourceGroup != nil { + body["resource_group"] = createBackupPolicyOptions.ResourceGroup + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalBackupPolicy) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListBackupPolicyJobs : List all jobs for a backup policy +// This request retrieves all jobs for a backup policy. A backup job represents the execution of a backup policy plan +// for a resource matching the policy's criteria. +func (vpc *VpcV1) ListBackupPolicyJobs(listBackupPolicyJobsOptions *ListBackupPolicyJobsOptions) (result *BackupPolicyJobCollection, response *core.DetailedResponse, err error) { + return vpc.ListBackupPolicyJobsWithContext(context.Background(), listBackupPolicyJobsOptions) +} + +// ListBackupPolicyJobsWithContext is an alternate form of the ListBackupPolicyJobs method which supports a Context parameter +func (vpc *VpcV1) ListBackupPolicyJobsWithContext(ctx context.Context, listBackupPolicyJobsOptions *ListBackupPolicyJobsOptions) (result *BackupPolicyJobCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listBackupPolicyJobsOptions, "listBackupPolicyJobsOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listBackupPolicyJobsOptions, "listBackupPolicyJobsOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "backup_policy_id": *listBackupPolicyJobsOptions.BackupPolicyID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/backup_policies/{backup_policy_id}/jobs`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listBackupPolicyJobsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListBackupPolicyJobs") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listBackupPolicyJobsOptions.Status != nil { + builder.AddQuery("status", fmt.Sprint(*listBackupPolicyJobsOptions.Status)) + } + if listBackupPolicyJobsOptions.BackupPolicyPlanID != nil { + builder.AddQuery("backup_policy_plan.id", fmt.Sprint(*listBackupPolicyJobsOptions.BackupPolicyPlanID)) + } + if listBackupPolicyJobsOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listBackupPolicyJobsOptions.Start)) + } + if listBackupPolicyJobsOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listBackupPolicyJobsOptions.Limit)) + } + if listBackupPolicyJobsOptions.Sort != nil { + builder.AddQuery("sort", fmt.Sprint(*listBackupPolicyJobsOptions.Sort)) + } + if listBackupPolicyJobsOptions.SourceID != nil { + builder.AddQuery("source.id", fmt.Sprint(*listBackupPolicyJobsOptions.SourceID)) + } + if listBackupPolicyJobsOptions.TargetSnapshotsID != nil { + builder.AddQuery("target_snapshots[].id", fmt.Sprint(*listBackupPolicyJobsOptions.TargetSnapshotsID)) + } + if listBackupPolicyJobsOptions.TargetSnapshotsCRN != nil { + builder.AddQuery("target_snapshots[].crn", fmt.Sprint(*listBackupPolicyJobsOptions.TargetSnapshotsCRN)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalBackupPolicyJobCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// GetBackupPolicyJob : Retrieve a backup policy job +// This request retrieves a single backup policy job specified by the identifier in the URL. +func (vpc *VpcV1) GetBackupPolicyJob(getBackupPolicyJobOptions *GetBackupPolicyJobOptions) (result *BackupPolicyJob, response *core.DetailedResponse, err error) { + return vpc.GetBackupPolicyJobWithContext(context.Background(), getBackupPolicyJobOptions) +} + +// GetBackupPolicyJobWithContext is an alternate form of the GetBackupPolicyJob method which supports a Context parameter +func (vpc *VpcV1) GetBackupPolicyJobWithContext(ctx context.Context, getBackupPolicyJobOptions *GetBackupPolicyJobOptions) (result *BackupPolicyJob, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getBackupPolicyJobOptions, "getBackupPolicyJobOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getBackupPolicyJobOptions, "getBackupPolicyJobOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "backup_policy_id": *getBackupPolicyJobOptions.BackupPolicyID, + "id": *getBackupPolicyJobOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/backup_policies/{backup_policy_id}/jobs/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getBackupPolicyJobOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetBackupPolicyJob") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalBackupPolicyJob) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListBackupPolicyPlans : List all plans for a backup policy +// This request retrieves all plans for a backup policy. Backup plans provide the backup schedule and deletion triggers. +func (vpc *VpcV1) ListBackupPolicyPlans(listBackupPolicyPlansOptions *ListBackupPolicyPlansOptions) (result *BackupPolicyPlanCollection, response *core.DetailedResponse, err error) { + return vpc.ListBackupPolicyPlansWithContext(context.Background(), listBackupPolicyPlansOptions) +} + +// ListBackupPolicyPlansWithContext is an alternate form of the ListBackupPolicyPlans method which supports a Context parameter +func (vpc *VpcV1) ListBackupPolicyPlansWithContext(ctx context.Context, listBackupPolicyPlansOptions *ListBackupPolicyPlansOptions) (result *BackupPolicyPlanCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listBackupPolicyPlansOptions, "listBackupPolicyPlansOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listBackupPolicyPlansOptions, "listBackupPolicyPlansOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "backup_policy_id": *listBackupPolicyPlansOptions.BackupPolicyID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/backup_policies/{backup_policy_id}/plans`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listBackupPolicyPlansOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListBackupPolicyPlans") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listBackupPolicyPlansOptions.Name != nil { + builder.AddQuery("name", fmt.Sprint(*listBackupPolicyPlansOptions.Name)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalBackupPolicyPlanCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateBackupPolicyPlan : Create a plan for a backup policy +// This request creates a new backup policy plan from a backup policy plan prototype object. The prototype object is +// structured in the same way as a retrieved backup policy plan, and contains the information necessary to create the +// new backup policy plan. +// +// Backups created by this plan will use the resource group of the source being backed up. +// +// Backups created by this plan will use the plan's name truncated to 46 characters, followed by a unique 16-character +// suffix. +func (vpc *VpcV1) CreateBackupPolicyPlan(createBackupPolicyPlanOptions *CreateBackupPolicyPlanOptions) (result *BackupPolicyPlan, response *core.DetailedResponse, err error) { + return vpc.CreateBackupPolicyPlanWithContext(context.Background(), createBackupPolicyPlanOptions) +} + +// CreateBackupPolicyPlanWithContext is an alternate form of the CreateBackupPolicyPlan method which supports a Context parameter +func (vpc *VpcV1) CreateBackupPolicyPlanWithContext(ctx context.Context, createBackupPolicyPlanOptions *CreateBackupPolicyPlanOptions) (result *BackupPolicyPlan, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createBackupPolicyPlanOptions, "createBackupPolicyPlanOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createBackupPolicyPlanOptions, "createBackupPolicyPlanOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "backup_policy_id": *createBackupPolicyPlanOptions.BackupPolicyID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/backup_policies/{backup_policy_id}/plans`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range createBackupPolicyPlanOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateBackupPolicyPlan") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createBackupPolicyPlanOptions.CronSpec != nil { + body["cron_spec"] = createBackupPolicyPlanOptions.CronSpec + } + if createBackupPolicyPlanOptions.Active != nil { + body["active"] = createBackupPolicyPlanOptions.Active + } + if createBackupPolicyPlanOptions.AttachUserTags != nil { + body["attach_user_tags"] = createBackupPolicyPlanOptions.AttachUserTags + } + if createBackupPolicyPlanOptions.ClonePolicy != nil { + body["clone_policy"] = createBackupPolicyPlanOptions.ClonePolicy + } + if createBackupPolicyPlanOptions.CopyUserTags != nil { + body["copy_user_tags"] = createBackupPolicyPlanOptions.CopyUserTags + } + if createBackupPolicyPlanOptions.DeletionTrigger != nil { + body["deletion_trigger"] = createBackupPolicyPlanOptions.DeletionTrigger + } + if createBackupPolicyPlanOptions.Name != nil { + body["name"] = createBackupPolicyPlanOptions.Name + } + if createBackupPolicyPlanOptions.RemoteRegionPolicies != nil { + body["remote_region_policies"] = createBackupPolicyPlanOptions.RemoteRegionPolicies + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalBackupPolicyPlan) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteBackupPolicyPlan : Delete a backup policy plan +// This request deletes a backup policy plan. This operation cannot be reversed. Any backups that have been created by +// the plan will remain but will no longer be subject to the plan's deletion trigger. Any running jobs associated with +// the plan will run to completion before the plan is deleted. +// +// If the request is accepted, the backup policy plan `status` will be set to `deleting`. Once deletion processing +// completes, the backup policy plan will no longer be retrievable. +func (vpc *VpcV1) DeleteBackupPolicyPlan(deleteBackupPolicyPlanOptions *DeleteBackupPolicyPlanOptions) (result *BackupPolicyPlan, response *core.DetailedResponse, err error) { + return vpc.DeleteBackupPolicyPlanWithContext(context.Background(), deleteBackupPolicyPlanOptions) +} + +// DeleteBackupPolicyPlanWithContext is an alternate form of the DeleteBackupPolicyPlan method which supports a Context parameter +func (vpc *VpcV1) DeleteBackupPolicyPlanWithContext(ctx context.Context, deleteBackupPolicyPlanOptions *DeleteBackupPolicyPlanOptions) (result *BackupPolicyPlan, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteBackupPolicyPlanOptions, "deleteBackupPolicyPlanOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteBackupPolicyPlanOptions, "deleteBackupPolicyPlanOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "backup_policy_id": *deleteBackupPolicyPlanOptions.BackupPolicyID, + "id": *deleteBackupPolicyPlanOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/backup_policies/{backup_policy_id}/plans/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteBackupPolicyPlanOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteBackupPolicyPlan") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + if deleteBackupPolicyPlanOptions.IfMatch != nil { + builder.AddHeader("If-Match", fmt.Sprint(*deleteBackupPolicyPlanOptions.IfMatch)) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalBackupPolicyPlan) + if err != nil { + return + } + response.Result = result + } + + return +} + +// GetBackupPolicyPlan : Retrieve a backup policy plan +// This request retrieves a single backup policy plan specified by the identifier in the URL. +func (vpc *VpcV1) GetBackupPolicyPlan(getBackupPolicyPlanOptions *GetBackupPolicyPlanOptions) (result *BackupPolicyPlan, response *core.DetailedResponse, err error) { + return vpc.GetBackupPolicyPlanWithContext(context.Background(), getBackupPolicyPlanOptions) +} + +// GetBackupPolicyPlanWithContext is an alternate form of the GetBackupPolicyPlan method which supports a Context parameter +func (vpc *VpcV1) GetBackupPolicyPlanWithContext(ctx context.Context, getBackupPolicyPlanOptions *GetBackupPolicyPlanOptions) (result *BackupPolicyPlan, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getBackupPolicyPlanOptions, "getBackupPolicyPlanOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getBackupPolicyPlanOptions, "getBackupPolicyPlanOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "backup_policy_id": *getBackupPolicyPlanOptions.BackupPolicyID, + "id": *getBackupPolicyPlanOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/backup_policies/{backup_policy_id}/plans/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getBackupPolicyPlanOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetBackupPolicyPlan") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalBackupPolicyPlan) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateBackupPolicyPlan : Update a backup policy plan +// This request updates a backup policy plan with the information in a provided plan patch. The plan patch object is +// structured in the same way as a retrieved backup policy plan and can contains only the information to be updated. +func (vpc *VpcV1) UpdateBackupPolicyPlan(updateBackupPolicyPlanOptions *UpdateBackupPolicyPlanOptions) (result *BackupPolicyPlan, response *core.DetailedResponse, err error) { + return vpc.UpdateBackupPolicyPlanWithContext(context.Background(), updateBackupPolicyPlanOptions) +} + +// UpdateBackupPolicyPlanWithContext is an alternate form of the UpdateBackupPolicyPlan method which supports a Context parameter +func (vpc *VpcV1) UpdateBackupPolicyPlanWithContext(ctx context.Context, updateBackupPolicyPlanOptions *UpdateBackupPolicyPlanOptions) (result *BackupPolicyPlan, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateBackupPolicyPlanOptions, "updateBackupPolicyPlanOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateBackupPolicyPlanOptions, "updateBackupPolicyPlanOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "backup_policy_id": *updateBackupPolicyPlanOptions.BackupPolicyID, + "id": *updateBackupPolicyPlanOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/backup_policies/{backup_policy_id}/plans/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateBackupPolicyPlanOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateBackupPolicyPlan") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + if updateBackupPolicyPlanOptions.IfMatch != nil { + builder.AddHeader("If-Match", fmt.Sprint(*updateBackupPolicyPlanOptions.IfMatch)) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateBackupPolicyPlanOptions.BackupPolicyPlanPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalBackupPolicyPlan) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteBackupPolicy : Delete a backup policy +// This request deletes a backup policy. This operation cannot be reversed. +// +// If the request is accepted, the backup policy `status` will be set to `deleting`. Once deletion processing completes, +// the backup policy will no longer be retrievable. +func (vpc *VpcV1) DeleteBackupPolicy(deleteBackupPolicyOptions *DeleteBackupPolicyOptions) (result *BackupPolicy, response *core.DetailedResponse, err error) { + return vpc.DeleteBackupPolicyWithContext(context.Background(), deleteBackupPolicyOptions) +} + +// DeleteBackupPolicyWithContext is an alternate form of the DeleteBackupPolicy method which supports a Context parameter +func (vpc *VpcV1) DeleteBackupPolicyWithContext(ctx context.Context, deleteBackupPolicyOptions *DeleteBackupPolicyOptions) (result *BackupPolicy, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteBackupPolicyOptions, "deleteBackupPolicyOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteBackupPolicyOptions, "deleteBackupPolicyOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *deleteBackupPolicyOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/backup_policies/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteBackupPolicyOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteBackupPolicy") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + if deleteBackupPolicyOptions.IfMatch != nil { + builder.AddHeader("If-Match", fmt.Sprint(*deleteBackupPolicyOptions.IfMatch)) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalBackupPolicy) + if err != nil { + return + } + response.Result = result + } + + return +} + +// GetBackupPolicy : Retrieve a backup policy +// This request retrieves a single backup policy specified by the identifier in the URL. +func (vpc *VpcV1) GetBackupPolicy(getBackupPolicyOptions *GetBackupPolicyOptions) (result *BackupPolicy, response *core.DetailedResponse, err error) { + return vpc.GetBackupPolicyWithContext(context.Background(), getBackupPolicyOptions) +} + +// GetBackupPolicyWithContext is an alternate form of the GetBackupPolicy method which supports a Context parameter +func (vpc *VpcV1) GetBackupPolicyWithContext(ctx context.Context, getBackupPolicyOptions *GetBackupPolicyOptions) (result *BackupPolicy, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getBackupPolicyOptions, "getBackupPolicyOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getBackupPolicyOptions, "getBackupPolicyOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getBackupPolicyOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/backup_policies/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getBackupPolicyOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetBackupPolicy") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalBackupPolicy) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateBackupPolicy : Update a backup policy +// This request updates a backup policy with the information in a provided backup policy patch. The backup policy patch +// object is structured in the same way as a retrieved backup policy and contains only the information to be updated. +func (vpc *VpcV1) UpdateBackupPolicy(updateBackupPolicyOptions *UpdateBackupPolicyOptions) (result *BackupPolicy, response *core.DetailedResponse, err error) { + return vpc.UpdateBackupPolicyWithContext(context.Background(), updateBackupPolicyOptions) +} + +// UpdateBackupPolicyWithContext is an alternate form of the UpdateBackupPolicy method which supports a Context parameter +func (vpc *VpcV1) UpdateBackupPolicyWithContext(ctx context.Context, updateBackupPolicyOptions *UpdateBackupPolicyOptions) (result *BackupPolicy, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateBackupPolicyOptions, "updateBackupPolicyOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateBackupPolicyOptions, "updateBackupPolicyOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *updateBackupPolicyOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/backup_policies/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateBackupPolicyOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateBackupPolicy") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + if updateBackupPolicyOptions.IfMatch != nil { + builder.AddHeader("If-Match", fmt.Sprint(*updateBackupPolicyOptions.IfMatch)) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateBackupPolicyOptions.BackupPolicyPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalBackupPolicy) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListPlacementGroups : List all placement groups +// This request lists all placement groups in the region. +func (vpc *VpcV1) ListPlacementGroups(listPlacementGroupsOptions *ListPlacementGroupsOptions) (result *PlacementGroupCollection, response *core.DetailedResponse, err error) { + return vpc.ListPlacementGroupsWithContext(context.Background(), listPlacementGroupsOptions) +} + +// ListPlacementGroupsWithContext is an alternate form of the ListPlacementGroups method which supports a Context parameter +func (vpc *VpcV1) ListPlacementGroupsWithContext(ctx context.Context, listPlacementGroupsOptions *ListPlacementGroupsOptions) (result *PlacementGroupCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listPlacementGroupsOptions, "listPlacementGroupsOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/placement_groups`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listPlacementGroupsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListPlacementGroups") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listPlacementGroupsOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listPlacementGroupsOptions.Start)) + } + if listPlacementGroupsOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listPlacementGroupsOptions.Limit)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalPlacementGroupCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreatePlacementGroup : Create a placement group +// This request creates a new placement group. +func (vpc *VpcV1) CreatePlacementGroup(createPlacementGroupOptions *CreatePlacementGroupOptions) (result *PlacementGroup, response *core.DetailedResponse, err error) { + return vpc.CreatePlacementGroupWithContext(context.Background(), createPlacementGroupOptions) +} + +// CreatePlacementGroupWithContext is an alternate form of the CreatePlacementGroup method which supports a Context parameter +func (vpc *VpcV1) CreatePlacementGroupWithContext(ctx context.Context, createPlacementGroupOptions *CreatePlacementGroupOptions) (result *PlacementGroup, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createPlacementGroupOptions, "createPlacementGroupOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createPlacementGroupOptions, "createPlacementGroupOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/placement_groups`, nil) + if err != nil { + return + } + + for headerName, headerValue := range createPlacementGroupOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreatePlacementGroup") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createPlacementGroupOptions.Strategy != nil { + body["strategy"] = createPlacementGroupOptions.Strategy + } + if createPlacementGroupOptions.Name != nil { + body["name"] = createPlacementGroupOptions.Name + } + if createPlacementGroupOptions.ResourceGroup != nil { + body["resource_group"] = createPlacementGroupOptions.ResourceGroup + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalPlacementGroup) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeletePlacementGroup : Delete a placement group +// This request deletes a placement group. This operation cannot be reversed. For this request to succeed, the placement +// group must not be associated with an instance. +func (vpc *VpcV1) DeletePlacementGroup(deletePlacementGroupOptions *DeletePlacementGroupOptions) (response *core.DetailedResponse, err error) { + return vpc.DeletePlacementGroupWithContext(context.Background(), deletePlacementGroupOptions) +} + +// DeletePlacementGroupWithContext is an alternate form of the DeletePlacementGroup method which supports a Context parameter +func (vpc *VpcV1) DeletePlacementGroupWithContext(ctx context.Context, deletePlacementGroupOptions *DeletePlacementGroupOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deletePlacementGroupOptions, "deletePlacementGroupOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deletePlacementGroupOptions, "deletePlacementGroupOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *deletePlacementGroupOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/placement_groups/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deletePlacementGroupOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeletePlacementGroup") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetPlacementGroup : Retrieve a placement group +// This request retrieves a single placement group specified by identifier in the URL. +func (vpc *VpcV1) GetPlacementGroup(getPlacementGroupOptions *GetPlacementGroupOptions) (result *PlacementGroup, response *core.DetailedResponse, err error) { + return vpc.GetPlacementGroupWithContext(context.Background(), getPlacementGroupOptions) +} + +// GetPlacementGroupWithContext is an alternate form of the GetPlacementGroup method which supports a Context parameter +func (vpc *VpcV1) GetPlacementGroupWithContext(ctx context.Context, getPlacementGroupOptions *GetPlacementGroupOptions) (result *PlacementGroup, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getPlacementGroupOptions, "getPlacementGroupOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getPlacementGroupOptions, "getPlacementGroupOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getPlacementGroupOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/placement_groups/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getPlacementGroupOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetPlacementGroup") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalPlacementGroup) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdatePlacementGroup : Update a placement group +// This request updates a placement group with the information provided placement group patch. The placement group patch +// object is structured in the same way as a retrieved placement group and contains only the information to be updated. +func (vpc *VpcV1) UpdatePlacementGroup(updatePlacementGroupOptions *UpdatePlacementGroupOptions) (result *PlacementGroup, response *core.DetailedResponse, err error) { + return vpc.UpdatePlacementGroupWithContext(context.Background(), updatePlacementGroupOptions) +} + +// UpdatePlacementGroupWithContext is an alternate form of the UpdatePlacementGroup method which supports a Context parameter +func (vpc *VpcV1) UpdatePlacementGroupWithContext(ctx context.Context, updatePlacementGroupOptions *UpdatePlacementGroupOptions) (result *PlacementGroup, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updatePlacementGroupOptions, "updatePlacementGroupOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updatePlacementGroupOptions, "updatePlacementGroupOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *updatePlacementGroupOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/placement_groups/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updatePlacementGroupOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdatePlacementGroup") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updatePlacementGroupOptions.PlacementGroupPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalPlacementGroup) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListBareMetalServerProfiles : List all bare metal server profiles +// This request lists all [bare metal server +// profiles](https://cloud.ibm.com/docs/vpc?topic=vpc-bare-metal-servers-profile) available in the region. A bare metal +// server profile specifies the performance characteristics and pricing model for a bare metal server. +func (vpc *VpcV1) ListBareMetalServerProfiles(listBareMetalServerProfilesOptions *ListBareMetalServerProfilesOptions) (result *BareMetalServerProfileCollection, response *core.DetailedResponse, err error) { + return vpc.ListBareMetalServerProfilesWithContext(context.Background(), listBareMetalServerProfilesOptions) +} + +// ListBareMetalServerProfilesWithContext is an alternate form of the ListBareMetalServerProfiles method which supports a Context parameter +func (vpc *VpcV1) ListBareMetalServerProfilesWithContext(ctx context.Context, listBareMetalServerProfilesOptions *ListBareMetalServerProfilesOptions) (result *BareMetalServerProfileCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listBareMetalServerProfilesOptions, "listBareMetalServerProfilesOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/bare_metal_server/profiles`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listBareMetalServerProfilesOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListBareMetalServerProfiles") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listBareMetalServerProfilesOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listBareMetalServerProfilesOptions.Start)) + } + if listBareMetalServerProfilesOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listBareMetalServerProfilesOptions.Limit)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalBareMetalServerProfileCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// GetBareMetalServerProfile : Retrieve a bare metal server profile +// This request retrieves a single bare metal server profile specified by the name in the URL. +func (vpc *VpcV1) GetBareMetalServerProfile(getBareMetalServerProfileOptions *GetBareMetalServerProfileOptions) (result *BareMetalServerProfile, response *core.DetailedResponse, err error) { + return vpc.GetBareMetalServerProfileWithContext(context.Background(), getBareMetalServerProfileOptions) +} + +// GetBareMetalServerProfileWithContext is an alternate form of the GetBareMetalServerProfile method which supports a Context parameter +func (vpc *VpcV1) GetBareMetalServerProfileWithContext(ctx context.Context, getBareMetalServerProfileOptions *GetBareMetalServerProfileOptions) (result *BareMetalServerProfile, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getBareMetalServerProfileOptions, "getBareMetalServerProfileOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getBareMetalServerProfileOptions, "getBareMetalServerProfileOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "name": *getBareMetalServerProfileOptions.Name, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/bare_metal_server/profiles/{name}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getBareMetalServerProfileOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetBareMetalServerProfile") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalBareMetalServerProfile) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListBareMetalServers : List all bare metal servers +// This request lists all bare metal servers in the region. +func (vpc *VpcV1) ListBareMetalServers(listBareMetalServersOptions *ListBareMetalServersOptions) (result *BareMetalServerCollection, response *core.DetailedResponse, err error) { + return vpc.ListBareMetalServersWithContext(context.Background(), listBareMetalServersOptions) +} + +// ListBareMetalServersWithContext is an alternate form of the ListBareMetalServers method which supports a Context parameter +func (vpc *VpcV1) ListBareMetalServersWithContext(ctx context.Context, listBareMetalServersOptions *ListBareMetalServersOptions) (result *BareMetalServerCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listBareMetalServersOptions, "listBareMetalServersOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/bare_metal_servers`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listBareMetalServersOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListBareMetalServers") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listBareMetalServersOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listBareMetalServersOptions.Start)) + } + if listBareMetalServersOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listBareMetalServersOptions.Limit)) + } + if listBareMetalServersOptions.ResourceGroupID != nil { + builder.AddQuery("resource_group.id", fmt.Sprint(*listBareMetalServersOptions.ResourceGroupID)) + } + if listBareMetalServersOptions.Name != nil { + builder.AddQuery("name", fmt.Sprint(*listBareMetalServersOptions.Name)) + } + if listBareMetalServersOptions.VPCID != nil { + builder.AddQuery("vpc.id", fmt.Sprint(*listBareMetalServersOptions.VPCID)) + } + if listBareMetalServersOptions.VPCCRN != nil { + builder.AddQuery("vpc.crn", fmt.Sprint(*listBareMetalServersOptions.VPCCRN)) + } + if listBareMetalServersOptions.VPCName != nil { + builder.AddQuery("vpc.name", fmt.Sprint(*listBareMetalServersOptions.VPCName)) + } + if listBareMetalServersOptions.NetworkInterfacesSubnetID != nil { + builder.AddQuery("network_interfaces.subnet.id", fmt.Sprint(*listBareMetalServersOptions.NetworkInterfacesSubnetID)) + } + if listBareMetalServersOptions.NetworkInterfacesSubnetCRN != nil { + builder.AddQuery("network_interfaces.subnet.crn", fmt.Sprint(*listBareMetalServersOptions.NetworkInterfacesSubnetCRN)) + } + if listBareMetalServersOptions.NetworkInterfacesSubnetName != nil { + builder.AddQuery("network_interfaces.subnet.name", fmt.Sprint(*listBareMetalServersOptions.NetworkInterfacesSubnetName)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalBareMetalServerCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateBareMetalServer : Create a bare metal server +// This request provisions a new bare metal server from a prototype object. The prototype object is structured in the +// same way as a retrieved bare metal server, and contains the information necessary to provision the new bare metal +// server. The bare metal server is automatically started. +func (vpc *VpcV1) CreateBareMetalServer(createBareMetalServerOptions *CreateBareMetalServerOptions) (result *BareMetalServer, response *core.DetailedResponse, err error) { + return vpc.CreateBareMetalServerWithContext(context.Background(), createBareMetalServerOptions) +} + +// CreateBareMetalServerWithContext is an alternate form of the CreateBareMetalServer method which supports a Context parameter +func (vpc *VpcV1) CreateBareMetalServerWithContext(ctx context.Context, createBareMetalServerOptions *CreateBareMetalServerOptions) (result *BareMetalServer, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createBareMetalServerOptions, "createBareMetalServerOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createBareMetalServerOptions, "createBareMetalServerOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/bare_metal_servers`, nil) + if err != nil { + return + } + + for headerName, headerValue := range createBareMetalServerOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateBareMetalServer") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createBareMetalServerOptions.Initialization != nil { + body["initialization"] = createBareMetalServerOptions.Initialization + } + if createBareMetalServerOptions.PrimaryNetworkInterface != nil { + body["primary_network_interface"] = createBareMetalServerOptions.PrimaryNetworkInterface + } + if createBareMetalServerOptions.Profile != nil { + body["profile"] = createBareMetalServerOptions.Profile + } + if createBareMetalServerOptions.Zone != nil { + body["zone"] = createBareMetalServerOptions.Zone + } + if createBareMetalServerOptions.EnableSecureBoot != nil { + body["enable_secure_boot"] = createBareMetalServerOptions.EnableSecureBoot + } + if createBareMetalServerOptions.Name != nil { + body["name"] = createBareMetalServerOptions.Name + } + if createBareMetalServerOptions.NetworkInterfaces != nil { + body["network_interfaces"] = createBareMetalServerOptions.NetworkInterfaces + } + if createBareMetalServerOptions.ResourceGroup != nil { + body["resource_group"] = createBareMetalServerOptions.ResourceGroup + } + if createBareMetalServerOptions.TrustedPlatformModule != nil { + body["trusted_platform_module"] = createBareMetalServerOptions.TrustedPlatformModule + } + if createBareMetalServerOptions.VPC != nil { + body["vpc"] = createBareMetalServerOptions.VPC + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalBareMetalServer) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateBareMetalServerConsoleAccessToken : Create a console access token for a bare metal server +// This request creates a new single-use console access token for a bare metal server. All console configuration is +// provided at token create time, and the token is subsequently used in the `access_token` query parameter for the +// WebSocket request. The access token is only valid for a short period of time, and a maximum of one token is valid +// for a given bare metal server at a time. +func (vpc *VpcV1) CreateBareMetalServerConsoleAccessToken(createBareMetalServerConsoleAccessTokenOptions *CreateBareMetalServerConsoleAccessTokenOptions) (result *BareMetalServerConsoleAccessToken, response *core.DetailedResponse, err error) { + return vpc.CreateBareMetalServerConsoleAccessTokenWithContext(context.Background(), createBareMetalServerConsoleAccessTokenOptions) +} + +// CreateBareMetalServerConsoleAccessTokenWithContext is an alternate form of the CreateBareMetalServerConsoleAccessToken method which supports a Context parameter +func (vpc *VpcV1) CreateBareMetalServerConsoleAccessTokenWithContext(ctx context.Context, createBareMetalServerConsoleAccessTokenOptions *CreateBareMetalServerConsoleAccessTokenOptions) (result *BareMetalServerConsoleAccessToken, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createBareMetalServerConsoleAccessTokenOptions, "createBareMetalServerConsoleAccessTokenOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createBareMetalServerConsoleAccessTokenOptions, "createBareMetalServerConsoleAccessTokenOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "bare_metal_server_id": *createBareMetalServerConsoleAccessTokenOptions.BareMetalServerID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/bare_metal_servers/{bare_metal_server_id}/console_access_token`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range createBareMetalServerConsoleAccessTokenOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateBareMetalServerConsoleAccessToken") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createBareMetalServerConsoleAccessTokenOptions.ConsoleType != nil { + body["console_type"] = createBareMetalServerConsoleAccessTokenOptions.ConsoleType + } + if createBareMetalServerConsoleAccessTokenOptions.Force != nil { + body["force"] = createBareMetalServerConsoleAccessTokenOptions.Force + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalBareMetalServerConsoleAccessToken) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListBareMetalServerDisks : List all disks on a bare metal server +// This request lists all disks on a bare metal server. A disk is a block device that is locally attached to the +// physical server. By default, the listed disks are sorted by their `created_at` property values, with the newest disk +// first. +func (vpc *VpcV1) ListBareMetalServerDisks(listBareMetalServerDisksOptions *ListBareMetalServerDisksOptions) (result *BareMetalServerDiskCollection, response *core.DetailedResponse, err error) { + return vpc.ListBareMetalServerDisksWithContext(context.Background(), listBareMetalServerDisksOptions) +} + +// ListBareMetalServerDisksWithContext is an alternate form of the ListBareMetalServerDisks method which supports a Context parameter +func (vpc *VpcV1) ListBareMetalServerDisksWithContext(ctx context.Context, listBareMetalServerDisksOptions *ListBareMetalServerDisksOptions) (result *BareMetalServerDiskCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listBareMetalServerDisksOptions, "listBareMetalServerDisksOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listBareMetalServerDisksOptions, "listBareMetalServerDisksOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "bare_metal_server_id": *listBareMetalServerDisksOptions.BareMetalServerID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/bare_metal_servers/{bare_metal_server_id}/disks`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listBareMetalServerDisksOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListBareMetalServerDisks") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalBareMetalServerDiskCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// GetBareMetalServerDisk : Retrieve a bare metal server disk +// This request retrieves a single disk specified by the identifier in the URL. +func (vpc *VpcV1) GetBareMetalServerDisk(getBareMetalServerDiskOptions *GetBareMetalServerDiskOptions) (result *BareMetalServerDisk, response *core.DetailedResponse, err error) { + return vpc.GetBareMetalServerDiskWithContext(context.Background(), getBareMetalServerDiskOptions) +} + +// GetBareMetalServerDiskWithContext is an alternate form of the GetBareMetalServerDisk method which supports a Context parameter +func (vpc *VpcV1) GetBareMetalServerDiskWithContext(ctx context.Context, getBareMetalServerDiskOptions *GetBareMetalServerDiskOptions) (result *BareMetalServerDisk, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getBareMetalServerDiskOptions, "getBareMetalServerDiskOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getBareMetalServerDiskOptions, "getBareMetalServerDiskOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "bare_metal_server_id": *getBareMetalServerDiskOptions.BareMetalServerID, + "id": *getBareMetalServerDiskOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/bare_metal_servers/{bare_metal_server_id}/disks/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getBareMetalServerDiskOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetBareMetalServerDisk") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalBareMetalServerDisk) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateBareMetalServerDisk : Update a bare metal server disk +// This request updates the bare metal server disk with the information in a provided patch. +func (vpc *VpcV1) UpdateBareMetalServerDisk(updateBareMetalServerDiskOptions *UpdateBareMetalServerDiskOptions) (result *BareMetalServerDisk, response *core.DetailedResponse, err error) { + return vpc.UpdateBareMetalServerDiskWithContext(context.Background(), updateBareMetalServerDiskOptions) +} + +// UpdateBareMetalServerDiskWithContext is an alternate form of the UpdateBareMetalServerDisk method which supports a Context parameter +func (vpc *VpcV1) UpdateBareMetalServerDiskWithContext(ctx context.Context, updateBareMetalServerDiskOptions *UpdateBareMetalServerDiskOptions) (result *BareMetalServerDisk, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateBareMetalServerDiskOptions, "updateBareMetalServerDiskOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateBareMetalServerDiskOptions, "updateBareMetalServerDiskOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "bare_metal_server_id": *updateBareMetalServerDiskOptions.BareMetalServerID, + "id": *updateBareMetalServerDiskOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/bare_metal_servers/{bare_metal_server_id}/disks/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateBareMetalServerDiskOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateBareMetalServerDisk") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateBareMetalServerDiskOptions.BareMetalServerDiskPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalBareMetalServerDisk) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListBareMetalServerNetworkInterfaces : List all network interfaces on a bare metal server +// This request lists all network interfaces on a bare metal server. A bare metal server network interface is an +// abstract representation of a network device and attaches a bare metal server to a single subnet. Each network +// interface on a bare metal server can attach to any subnet in the zone, including subnets that are already attached to +// the bare metal server. +func (vpc *VpcV1) ListBareMetalServerNetworkInterfaces(listBareMetalServerNetworkInterfacesOptions *ListBareMetalServerNetworkInterfacesOptions) (result *BareMetalServerNetworkInterfaceCollection, response *core.DetailedResponse, err error) { + return vpc.ListBareMetalServerNetworkInterfacesWithContext(context.Background(), listBareMetalServerNetworkInterfacesOptions) +} + +// ListBareMetalServerNetworkInterfacesWithContext is an alternate form of the ListBareMetalServerNetworkInterfaces method which supports a Context parameter +func (vpc *VpcV1) ListBareMetalServerNetworkInterfacesWithContext(ctx context.Context, listBareMetalServerNetworkInterfacesOptions *ListBareMetalServerNetworkInterfacesOptions) (result *BareMetalServerNetworkInterfaceCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listBareMetalServerNetworkInterfacesOptions, "listBareMetalServerNetworkInterfacesOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listBareMetalServerNetworkInterfacesOptions, "listBareMetalServerNetworkInterfacesOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "bare_metal_server_id": *listBareMetalServerNetworkInterfacesOptions.BareMetalServerID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/bare_metal_servers/{bare_metal_server_id}/network_interfaces`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listBareMetalServerNetworkInterfacesOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListBareMetalServerNetworkInterfaces") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listBareMetalServerNetworkInterfacesOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listBareMetalServerNetworkInterfacesOptions.Start)) + } + if listBareMetalServerNetworkInterfacesOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listBareMetalServerNetworkInterfacesOptions.Limit)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalBareMetalServerNetworkInterfaceCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateBareMetalServerNetworkInterface : Create a network interface on a bare metal server +// This request creates a new bare metal server network interface from a bare metal server network interface prototype +// object. The prototype object is structured in the same way as a retrieved bare metal server network interface, and +// contains the information necessary to create the new bare metal server network interface. Any subnet in the bare +// metal server's VPC may be specified, even if it is already attached to another bare metal server network interface. +// Addresses on the bare metal server network interface must be within the specified subnet's CIDR blocks. +func (vpc *VpcV1) CreateBareMetalServerNetworkInterface(createBareMetalServerNetworkInterfaceOptions *CreateBareMetalServerNetworkInterfaceOptions) (result BareMetalServerNetworkInterfaceIntf, response *core.DetailedResponse, err error) { + return vpc.CreateBareMetalServerNetworkInterfaceWithContext(context.Background(), createBareMetalServerNetworkInterfaceOptions) +} + +// CreateBareMetalServerNetworkInterfaceWithContext is an alternate form of the CreateBareMetalServerNetworkInterface method which supports a Context parameter +func (vpc *VpcV1) CreateBareMetalServerNetworkInterfaceWithContext(ctx context.Context, createBareMetalServerNetworkInterfaceOptions *CreateBareMetalServerNetworkInterfaceOptions) (result BareMetalServerNetworkInterfaceIntf, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createBareMetalServerNetworkInterfaceOptions, "createBareMetalServerNetworkInterfaceOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createBareMetalServerNetworkInterfaceOptions, "createBareMetalServerNetworkInterfaceOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "bare_metal_server_id": *createBareMetalServerNetworkInterfaceOptions.BareMetalServerID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/bare_metal_servers/{bare_metal_server_id}/network_interfaces`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range createBareMetalServerNetworkInterfaceOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateBareMetalServerNetworkInterface") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(createBareMetalServerNetworkInterfaceOptions.BareMetalServerNetworkInterfacePrototype) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalBareMetalServerNetworkInterface) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteBareMetalServerNetworkInterface : Delete a bare metal server network interface +// This request deletes a bare metal server network interface. This operation cannot be reversed. Any floating IPs +// associated with the bare metal server network interface are implicitly disassociated. The primary bare metal server +// network interface is not allowed to be deleted. +func (vpc *VpcV1) DeleteBareMetalServerNetworkInterface(deleteBareMetalServerNetworkInterfaceOptions *DeleteBareMetalServerNetworkInterfaceOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteBareMetalServerNetworkInterfaceWithContext(context.Background(), deleteBareMetalServerNetworkInterfaceOptions) +} + +// DeleteBareMetalServerNetworkInterfaceWithContext is an alternate form of the DeleteBareMetalServerNetworkInterface method which supports a Context parameter +func (vpc *VpcV1) DeleteBareMetalServerNetworkInterfaceWithContext(ctx context.Context, deleteBareMetalServerNetworkInterfaceOptions *DeleteBareMetalServerNetworkInterfaceOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteBareMetalServerNetworkInterfaceOptions, "deleteBareMetalServerNetworkInterfaceOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteBareMetalServerNetworkInterfaceOptions, "deleteBareMetalServerNetworkInterfaceOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "bare_metal_server_id": *deleteBareMetalServerNetworkInterfaceOptions.BareMetalServerID, + "id": *deleteBareMetalServerNetworkInterfaceOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/bare_metal_servers/{bare_metal_server_id}/network_interfaces/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteBareMetalServerNetworkInterfaceOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteBareMetalServerNetworkInterface") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetBareMetalServerNetworkInterface : Retrieve a bare metal server network interface +// This request retrieves a single bare metal server network interface specified by the identifier in the URL. +func (vpc *VpcV1) GetBareMetalServerNetworkInterface(getBareMetalServerNetworkInterfaceOptions *GetBareMetalServerNetworkInterfaceOptions) (result BareMetalServerNetworkInterfaceIntf, response *core.DetailedResponse, err error) { + return vpc.GetBareMetalServerNetworkInterfaceWithContext(context.Background(), getBareMetalServerNetworkInterfaceOptions) +} + +// GetBareMetalServerNetworkInterfaceWithContext is an alternate form of the GetBareMetalServerNetworkInterface method which supports a Context parameter +func (vpc *VpcV1) GetBareMetalServerNetworkInterfaceWithContext(ctx context.Context, getBareMetalServerNetworkInterfaceOptions *GetBareMetalServerNetworkInterfaceOptions) (result BareMetalServerNetworkInterfaceIntf, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getBareMetalServerNetworkInterfaceOptions, "getBareMetalServerNetworkInterfaceOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getBareMetalServerNetworkInterfaceOptions, "getBareMetalServerNetworkInterfaceOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "bare_metal_server_id": *getBareMetalServerNetworkInterfaceOptions.BareMetalServerID, + "id": *getBareMetalServerNetworkInterfaceOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/bare_metal_servers/{bare_metal_server_id}/network_interfaces/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getBareMetalServerNetworkInterfaceOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetBareMetalServerNetworkInterface") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalBareMetalServerNetworkInterface) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateBareMetalServerNetworkInterface : Update a bare metal server network interface +// This request updates a bare metal server network interface with the information provided in a bare metal server +// network interface patch object. The bare metal server network interface patch object is structured in the same way as +// a retrieved bare metal server network interface and needs to contain only the information to be updated. +func (vpc *VpcV1) UpdateBareMetalServerNetworkInterface(updateBareMetalServerNetworkInterfaceOptions *UpdateBareMetalServerNetworkInterfaceOptions) (result BareMetalServerNetworkInterfaceIntf, response *core.DetailedResponse, err error) { + return vpc.UpdateBareMetalServerNetworkInterfaceWithContext(context.Background(), updateBareMetalServerNetworkInterfaceOptions) +} + +// UpdateBareMetalServerNetworkInterfaceWithContext is an alternate form of the UpdateBareMetalServerNetworkInterface method which supports a Context parameter +func (vpc *VpcV1) UpdateBareMetalServerNetworkInterfaceWithContext(ctx context.Context, updateBareMetalServerNetworkInterfaceOptions *UpdateBareMetalServerNetworkInterfaceOptions) (result BareMetalServerNetworkInterfaceIntf, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateBareMetalServerNetworkInterfaceOptions, "updateBareMetalServerNetworkInterfaceOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateBareMetalServerNetworkInterfaceOptions, "updateBareMetalServerNetworkInterfaceOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "bare_metal_server_id": *updateBareMetalServerNetworkInterfaceOptions.BareMetalServerID, + "id": *updateBareMetalServerNetworkInterfaceOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/bare_metal_servers/{bare_metal_server_id}/network_interfaces/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateBareMetalServerNetworkInterfaceOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateBareMetalServerNetworkInterface") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateBareMetalServerNetworkInterfaceOptions.BareMetalServerNetworkInterfacePatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalBareMetalServerNetworkInterface) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListBareMetalServerNetworkInterfaceFloatingIps : List all floating IPs associated with a bare metal server network interface +// This request lists all floating IPs associated with a bare metal server network interface. +func (vpc *VpcV1) ListBareMetalServerNetworkInterfaceFloatingIps(listBareMetalServerNetworkInterfaceFloatingIpsOptions *ListBareMetalServerNetworkInterfaceFloatingIpsOptions) (result *FloatingIPUnpaginatedCollection, response *core.DetailedResponse, err error) { + return vpc.ListBareMetalServerNetworkInterfaceFloatingIpsWithContext(context.Background(), listBareMetalServerNetworkInterfaceFloatingIpsOptions) +} + +// ListBareMetalServerNetworkInterfaceFloatingIpsWithContext is an alternate form of the ListBareMetalServerNetworkInterfaceFloatingIps method which supports a Context parameter +func (vpc *VpcV1) ListBareMetalServerNetworkInterfaceFloatingIpsWithContext(ctx context.Context, listBareMetalServerNetworkInterfaceFloatingIpsOptions *ListBareMetalServerNetworkInterfaceFloatingIpsOptions) (result *FloatingIPUnpaginatedCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listBareMetalServerNetworkInterfaceFloatingIpsOptions, "listBareMetalServerNetworkInterfaceFloatingIpsOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listBareMetalServerNetworkInterfaceFloatingIpsOptions, "listBareMetalServerNetworkInterfaceFloatingIpsOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "bare_metal_server_id": *listBareMetalServerNetworkInterfaceFloatingIpsOptions.BareMetalServerID, + "network_interface_id": *listBareMetalServerNetworkInterfaceFloatingIpsOptions.NetworkInterfaceID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/bare_metal_servers/{bare_metal_server_id}/network_interfaces/{network_interface_id}/floating_ips`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listBareMetalServerNetworkInterfaceFloatingIpsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListBareMetalServerNetworkInterfaceFloatingIps") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalFloatingIPUnpaginatedCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// RemoveBareMetalServerNetworkInterfaceFloatingIP : Disassociate a floating IP from a bare metal server network interface +// This request disassociates the specified floating IP from the specified bare metal server network interface. +func (vpc *VpcV1) RemoveBareMetalServerNetworkInterfaceFloatingIP(removeBareMetalServerNetworkInterfaceFloatingIPOptions *RemoveBareMetalServerNetworkInterfaceFloatingIPOptions) (response *core.DetailedResponse, err error) { + return vpc.RemoveBareMetalServerNetworkInterfaceFloatingIPWithContext(context.Background(), removeBareMetalServerNetworkInterfaceFloatingIPOptions) +} + +// RemoveBareMetalServerNetworkInterfaceFloatingIPWithContext is an alternate form of the RemoveBareMetalServerNetworkInterfaceFloatingIP method which supports a Context parameter +func (vpc *VpcV1) RemoveBareMetalServerNetworkInterfaceFloatingIPWithContext(ctx context.Context, removeBareMetalServerNetworkInterfaceFloatingIPOptions *RemoveBareMetalServerNetworkInterfaceFloatingIPOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(removeBareMetalServerNetworkInterfaceFloatingIPOptions, "removeBareMetalServerNetworkInterfaceFloatingIPOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(removeBareMetalServerNetworkInterfaceFloatingIPOptions, "removeBareMetalServerNetworkInterfaceFloatingIPOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "bare_metal_server_id": *removeBareMetalServerNetworkInterfaceFloatingIPOptions.BareMetalServerID, + "network_interface_id": *removeBareMetalServerNetworkInterfaceFloatingIPOptions.NetworkInterfaceID, + "id": *removeBareMetalServerNetworkInterfaceFloatingIPOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/bare_metal_servers/{bare_metal_server_id}/network_interfaces/{network_interface_id}/floating_ips/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range removeBareMetalServerNetworkInterfaceFloatingIPOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "RemoveBareMetalServerNetworkInterfaceFloatingIP") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetBareMetalServerNetworkInterfaceFloatingIP : Retrieve associated floating IP +// This request retrieves a specified floating IP if it is associated with the bare metal server network interface +// specified in the URL. +func (vpc *VpcV1) GetBareMetalServerNetworkInterfaceFloatingIP(getBareMetalServerNetworkInterfaceFloatingIPOptions *GetBareMetalServerNetworkInterfaceFloatingIPOptions) (result *FloatingIP, response *core.DetailedResponse, err error) { + return vpc.GetBareMetalServerNetworkInterfaceFloatingIPWithContext(context.Background(), getBareMetalServerNetworkInterfaceFloatingIPOptions) +} + +// GetBareMetalServerNetworkInterfaceFloatingIPWithContext is an alternate form of the GetBareMetalServerNetworkInterfaceFloatingIP method which supports a Context parameter +func (vpc *VpcV1) GetBareMetalServerNetworkInterfaceFloatingIPWithContext(ctx context.Context, getBareMetalServerNetworkInterfaceFloatingIPOptions *GetBareMetalServerNetworkInterfaceFloatingIPOptions) (result *FloatingIP, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getBareMetalServerNetworkInterfaceFloatingIPOptions, "getBareMetalServerNetworkInterfaceFloatingIPOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getBareMetalServerNetworkInterfaceFloatingIPOptions, "getBareMetalServerNetworkInterfaceFloatingIPOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "bare_metal_server_id": *getBareMetalServerNetworkInterfaceFloatingIPOptions.BareMetalServerID, + "network_interface_id": *getBareMetalServerNetworkInterfaceFloatingIPOptions.NetworkInterfaceID, + "id": *getBareMetalServerNetworkInterfaceFloatingIPOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/bare_metal_servers/{bare_metal_server_id}/network_interfaces/{network_interface_id}/floating_ips/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getBareMetalServerNetworkInterfaceFloatingIPOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetBareMetalServerNetworkInterfaceFloatingIP") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalFloatingIP) + if err != nil { + return + } + response.Result = result + } + + return +} + +// AddBareMetalServerNetworkInterfaceFloatingIP : Associate a floating IP with a bare metal server network interface +// This request associates the specified floating IP with the specified bare metal server network interface. If +// `enable_infrastructure_nat` is `false`, this adds the IP to any existing associations. If `enable_infrastructure_nat` +// is `true`, this replaces any existing association. For this request to succeed, the existing floating IP must not be +// required by another resource, such as a public gateway. A request body is not required, and if provided, is ignored. +func (vpc *VpcV1) AddBareMetalServerNetworkInterfaceFloatingIP(addBareMetalServerNetworkInterfaceFloatingIPOptions *AddBareMetalServerNetworkInterfaceFloatingIPOptions) (result *FloatingIP, response *core.DetailedResponse, err error) { + return vpc.AddBareMetalServerNetworkInterfaceFloatingIPWithContext(context.Background(), addBareMetalServerNetworkInterfaceFloatingIPOptions) +} + +// AddBareMetalServerNetworkInterfaceFloatingIPWithContext is an alternate form of the AddBareMetalServerNetworkInterfaceFloatingIP method which supports a Context parameter +func (vpc *VpcV1) AddBareMetalServerNetworkInterfaceFloatingIPWithContext(ctx context.Context, addBareMetalServerNetworkInterfaceFloatingIPOptions *AddBareMetalServerNetworkInterfaceFloatingIPOptions) (result *FloatingIP, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(addBareMetalServerNetworkInterfaceFloatingIPOptions, "addBareMetalServerNetworkInterfaceFloatingIPOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(addBareMetalServerNetworkInterfaceFloatingIPOptions, "addBareMetalServerNetworkInterfaceFloatingIPOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "bare_metal_server_id": *addBareMetalServerNetworkInterfaceFloatingIPOptions.BareMetalServerID, + "network_interface_id": *addBareMetalServerNetworkInterfaceFloatingIPOptions.NetworkInterfaceID, + "id": *addBareMetalServerNetworkInterfaceFloatingIPOptions.ID, + } + + builder := core.NewRequestBuilder(core.PUT) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/bare_metal_servers/{bare_metal_server_id}/network_interfaces/{network_interface_id}/floating_ips/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range addBareMetalServerNetworkInterfaceFloatingIPOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "AddBareMetalServerNetworkInterfaceFloatingIP") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalFloatingIP) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListBareMetalServerNetworkInterfaceIps : List all reserved IPs bound to a bare metal server network interface +// This request lists all reserved IPs bound to a bare metal server network interface. +func (vpc *VpcV1) ListBareMetalServerNetworkInterfaceIps(listBareMetalServerNetworkInterfaceIpsOptions *ListBareMetalServerNetworkInterfaceIpsOptions) (result *ReservedIPCollectionBareMetalServerNetworkInterfaceContext, response *core.DetailedResponse, err error) { + return vpc.ListBareMetalServerNetworkInterfaceIpsWithContext(context.Background(), listBareMetalServerNetworkInterfaceIpsOptions) +} + +// ListBareMetalServerNetworkInterfaceIpsWithContext is an alternate form of the ListBareMetalServerNetworkInterfaceIps method which supports a Context parameter +func (vpc *VpcV1) ListBareMetalServerNetworkInterfaceIpsWithContext(ctx context.Context, listBareMetalServerNetworkInterfaceIpsOptions *ListBareMetalServerNetworkInterfaceIpsOptions) (result *ReservedIPCollectionBareMetalServerNetworkInterfaceContext, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listBareMetalServerNetworkInterfaceIpsOptions, "listBareMetalServerNetworkInterfaceIpsOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listBareMetalServerNetworkInterfaceIpsOptions, "listBareMetalServerNetworkInterfaceIpsOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "bare_metal_server_id": *listBareMetalServerNetworkInterfaceIpsOptions.BareMetalServerID, + "network_interface_id": *listBareMetalServerNetworkInterfaceIpsOptions.NetworkInterfaceID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/bare_metal_servers/{bare_metal_server_id}/network_interfaces/{network_interface_id}/ips`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listBareMetalServerNetworkInterfaceIpsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListBareMetalServerNetworkInterfaceIps") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalReservedIPCollectionBareMetalServerNetworkInterfaceContext) + if err != nil { + return + } + response.Result = result + } + + return +} + +// GetBareMetalServerNetworkInterfaceIP : Retrieve bound reserved IP +// This request retrieves the specified reserved IP address if it is bound to the network interface for the bare metal +// server specified in the URL. +func (vpc *VpcV1) GetBareMetalServerNetworkInterfaceIP(getBareMetalServerNetworkInterfaceIPOptions *GetBareMetalServerNetworkInterfaceIPOptions) (result *ReservedIP, response *core.DetailedResponse, err error) { + return vpc.GetBareMetalServerNetworkInterfaceIPWithContext(context.Background(), getBareMetalServerNetworkInterfaceIPOptions) +} + +// GetBareMetalServerNetworkInterfaceIPWithContext is an alternate form of the GetBareMetalServerNetworkInterfaceIP method which supports a Context parameter +func (vpc *VpcV1) GetBareMetalServerNetworkInterfaceIPWithContext(ctx context.Context, getBareMetalServerNetworkInterfaceIPOptions *GetBareMetalServerNetworkInterfaceIPOptions) (result *ReservedIP, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getBareMetalServerNetworkInterfaceIPOptions, "getBareMetalServerNetworkInterfaceIPOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getBareMetalServerNetworkInterfaceIPOptions, "getBareMetalServerNetworkInterfaceIPOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "bare_metal_server_id": *getBareMetalServerNetworkInterfaceIPOptions.BareMetalServerID, + "network_interface_id": *getBareMetalServerNetworkInterfaceIPOptions.NetworkInterfaceID, + "id": *getBareMetalServerNetworkInterfaceIPOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/bare_metal_servers/{bare_metal_server_id}/network_interfaces/{network_interface_id}/ips/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getBareMetalServerNetworkInterfaceIPOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetBareMetalServerNetworkInterfaceIP") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalReservedIP) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteBareMetalServer : Delete a bare metal server +// This request deletes a bare metal server. This operation cannot be reversed. Any floating IPs associated with the +// bare metal server network interfaces are implicitly disassociated. +func (vpc *VpcV1) DeleteBareMetalServer(deleteBareMetalServerOptions *DeleteBareMetalServerOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteBareMetalServerWithContext(context.Background(), deleteBareMetalServerOptions) +} + +// DeleteBareMetalServerWithContext is an alternate form of the DeleteBareMetalServer method which supports a Context parameter +func (vpc *VpcV1) DeleteBareMetalServerWithContext(ctx context.Context, deleteBareMetalServerOptions *DeleteBareMetalServerOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteBareMetalServerOptions, "deleteBareMetalServerOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteBareMetalServerOptions, "deleteBareMetalServerOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *deleteBareMetalServerOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/bare_metal_servers/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteBareMetalServerOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteBareMetalServer") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetBareMetalServer : Retrieve a bare metal server +// This request retrieves a single bare metal server specified by the identifier in the URL. +func (vpc *VpcV1) GetBareMetalServer(getBareMetalServerOptions *GetBareMetalServerOptions) (result *BareMetalServer, response *core.DetailedResponse, err error) { + return vpc.GetBareMetalServerWithContext(context.Background(), getBareMetalServerOptions) +} + +// GetBareMetalServerWithContext is an alternate form of the GetBareMetalServer method which supports a Context parameter +func (vpc *VpcV1) GetBareMetalServerWithContext(ctx context.Context, getBareMetalServerOptions *GetBareMetalServerOptions) (result *BareMetalServer, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getBareMetalServerOptions, "getBareMetalServerOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getBareMetalServerOptions, "getBareMetalServerOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getBareMetalServerOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/bare_metal_servers/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getBareMetalServerOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetBareMetalServer") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalBareMetalServer) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateBareMetalServer : Update a bare metal server +// This request updates a bare metal server with the information in a provided patch. The bare metal server patch object +// is structured in the same way as a retrieved bare metal server and contains only the information to be updated. +func (vpc *VpcV1) UpdateBareMetalServer(updateBareMetalServerOptions *UpdateBareMetalServerOptions) (result *BareMetalServer, response *core.DetailedResponse, err error) { + return vpc.UpdateBareMetalServerWithContext(context.Background(), updateBareMetalServerOptions) +} + +// UpdateBareMetalServerWithContext is an alternate form of the UpdateBareMetalServer method which supports a Context parameter +func (vpc *VpcV1) UpdateBareMetalServerWithContext(ctx context.Context, updateBareMetalServerOptions *UpdateBareMetalServerOptions) (result *BareMetalServer, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateBareMetalServerOptions, "updateBareMetalServerOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateBareMetalServerOptions, "updateBareMetalServerOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *updateBareMetalServerOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/bare_metal_servers/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateBareMetalServerOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateBareMetalServer") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateBareMetalServerOptions.BareMetalServerPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalBareMetalServer) + if err != nil { + return + } + response.Result = result + } + + return +} + +// GetBareMetalServerInitialization : Retrieve initialization configuration for a bare metal server +// This request retrieves configuration used to initialize the bare metal server, such as the image used, SSH keys, and +// any configured usernames and passwords. These can subsequently be changed on the server and therefore may not be +// current. +func (vpc *VpcV1) GetBareMetalServerInitialization(getBareMetalServerInitializationOptions *GetBareMetalServerInitializationOptions) (result *BareMetalServerInitialization, response *core.DetailedResponse, err error) { + return vpc.GetBareMetalServerInitializationWithContext(context.Background(), getBareMetalServerInitializationOptions) +} + +// GetBareMetalServerInitializationWithContext is an alternate form of the GetBareMetalServerInitialization method which supports a Context parameter +func (vpc *VpcV1) GetBareMetalServerInitializationWithContext(ctx context.Context, getBareMetalServerInitializationOptions *GetBareMetalServerInitializationOptions) (result *BareMetalServerInitialization, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getBareMetalServerInitializationOptions, "getBareMetalServerInitializationOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getBareMetalServerInitializationOptions, "getBareMetalServerInitializationOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getBareMetalServerInitializationOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/bare_metal_servers/{id}/initialization`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getBareMetalServerInitializationOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetBareMetalServerInitialization") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalBareMetalServerInitialization) + if err != nil { + return + } + response.Result = result + } + + return +} + +// RestartBareMetalServer : Restart a bare metal server +// This request restarts a bare metal server. It will run immediately regardless of the state of the server. +func (vpc *VpcV1) RestartBareMetalServer(restartBareMetalServerOptions *RestartBareMetalServerOptions) (response *core.DetailedResponse, err error) { + return vpc.RestartBareMetalServerWithContext(context.Background(), restartBareMetalServerOptions) +} + +// RestartBareMetalServerWithContext is an alternate form of the RestartBareMetalServer method which supports a Context parameter +func (vpc *VpcV1) RestartBareMetalServerWithContext(ctx context.Context, restartBareMetalServerOptions *RestartBareMetalServerOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(restartBareMetalServerOptions, "restartBareMetalServerOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(restartBareMetalServerOptions, "restartBareMetalServerOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *restartBareMetalServerOptions.ID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/bare_metal_servers/{id}/restart`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range restartBareMetalServerOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "RestartBareMetalServer") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// StartBareMetalServer : Start a bare metal server +// This request starts a bare metal server. It will run immediately provided the server is stopped. +func (vpc *VpcV1) StartBareMetalServer(startBareMetalServerOptions *StartBareMetalServerOptions) (response *core.DetailedResponse, err error) { + return vpc.StartBareMetalServerWithContext(context.Background(), startBareMetalServerOptions) +} + +// StartBareMetalServerWithContext is an alternate form of the StartBareMetalServer method which supports a Context parameter +func (vpc *VpcV1) StartBareMetalServerWithContext(ctx context.Context, startBareMetalServerOptions *StartBareMetalServerOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(startBareMetalServerOptions, "startBareMetalServerOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(startBareMetalServerOptions, "startBareMetalServerOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *startBareMetalServerOptions.ID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/bare_metal_servers/{id}/start`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range startBareMetalServerOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "StartBareMetalServer") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// StopBareMetalServer : Stop a bare metal server +// This request stops a bare metal server. It will run immediately provided the server is running. Note: A soft stop may +// not complete as it relies on the operating system to perform the operation. +func (vpc *VpcV1) StopBareMetalServer(stopBareMetalServerOptions *StopBareMetalServerOptions) (response *core.DetailedResponse, err error) { + return vpc.StopBareMetalServerWithContext(context.Background(), stopBareMetalServerOptions) +} + +// StopBareMetalServerWithContext is an alternate form of the StopBareMetalServer method which supports a Context parameter +func (vpc *VpcV1) StopBareMetalServerWithContext(ctx context.Context, stopBareMetalServerOptions *StopBareMetalServerOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(stopBareMetalServerOptions, "stopBareMetalServerOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(stopBareMetalServerOptions, "stopBareMetalServerOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *stopBareMetalServerOptions.ID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/bare_metal_servers/{id}/stop`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range stopBareMetalServerOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "StopBareMetalServer") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if stopBareMetalServerOptions.Type != nil { + body["type"] = stopBareMetalServerOptions.Type + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// ListVolumeProfiles : List all volume profiles +// This request lists all [volume profiles](https://cloud.ibm.com/docs/vpc?topic=vpc-block-storage-profiles) available +// in the region. A volume profile specifies the performance characteristics and pricing model for a volume. +func (vpc *VpcV1) ListVolumeProfiles(listVolumeProfilesOptions *ListVolumeProfilesOptions) (result *VolumeProfileCollection, response *core.DetailedResponse, err error) { + return vpc.ListVolumeProfilesWithContext(context.Background(), listVolumeProfilesOptions) +} + +// ListVolumeProfilesWithContext is an alternate form of the ListVolumeProfiles method which supports a Context parameter +func (vpc *VpcV1) ListVolumeProfilesWithContext(ctx context.Context, listVolumeProfilesOptions *ListVolumeProfilesOptions) (result *VolumeProfileCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listVolumeProfilesOptions, "listVolumeProfilesOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/volume/profiles`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listVolumeProfilesOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListVolumeProfiles") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listVolumeProfilesOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listVolumeProfilesOptions.Start)) + } + if listVolumeProfilesOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listVolumeProfilesOptions.Limit)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVolumeProfileCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// GetVolumeProfile : Retrieve a volume profile +// This request retrieves a single volume profile specified by the name in the URL. +func (vpc *VpcV1) GetVolumeProfile(getVolumeProfileOptions *GetVolumeProfileOptions) (result *VolumeProfile, response *core.DetailedResponse, err error) { + return vpc.GetVolumeProfileWithContext(context.Background(), getVolumeProfileOptions) +} + +// GetVolumeProfileWithContext is an alternate form of the GetVolumeProfile method which supports a Context parameter +func (vpc *VpcV1) GetVolumeProfileWithContext(ctx context.Context, getVolumeProfileOptions *GetVolumeProfileOptions) (result *VolumeProfile, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getVolumeProfileOptions, "getVolumeProfileOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getVolumeProfileOptions, "getVolumeProfileOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "name": *getVolumeProfileOptions.Name, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/volume/profiles/{name}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getVolumeProfileOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetVolumeProfile") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVolumeProfile) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListVolumes : List all volumes +// This request lists all volumes in the region. Volumes are network-connected block storage devices that may be +// attached to one or more instances in the same region. +func (vpc *VpcV1) ListVolumes(listVolumesOptions *ListVolumesOptions) (result *VolumeCollection, response *core.DetailedResponse, err error) { + return vpc.ListVolumesWithContext(context.Background(), listVolumesOptions) +} + +// ListVolumesWithContext is an alternate form of the ListVolumes method which supports a Context parameter +func (vpc *VpcV1) ListVolumesWithContext(ctx context.Context, listVolumesOptions *ListVolumesOptions) (result *VolumeCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listVolumesOptions, "listVolumesOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/volumes`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listVolumesOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListVolumes") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listVolumesOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listVolumesOptions.Start)) + } + if listVolumesOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listVolumesOptions.Limit)) + } + if listVolumesOptions.Name != nil { + builder.AddQuery("name", fmt.Sprint(*listVolumesOptions.Name)) + } + if listVolumesOptions.AttachmentState != nil { + builder.AddQuery("attachment_state", fmt.Sprint(*listVolumesOptions.AttachmentState)) + } + if listVolumesOptions.Encryption != nil { + builder.AddQuery("encryption", fmt.Sprint(*listVolumesOptions.Encryption)) + } + if listVolumesOptions.OperatingSystemFamily != nil { + builder.AddQuery("operating_system.family", fmt.Sprint(*listVolumesOptions.OperatingSystemFamily)) + } + if listVolumesOptions.OperatingSystemArchitecture != nil { + builder.AddQuery("operating_system.architecture", fmt.Sprint(*listVolumesOptions.OperatingSystemArchitecture)) + } + if listVolumesOptions.ZoneName != nil { + builder.AddQuery("zone.name", fmt.Sprint(*listVolumesOptions.ZoneName)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVolumeCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateVolume : Create a volume +// This request creates a new volume from a volume prototype object. The prototype object is structured in the same way +// as a retrieved volume, and contains the information necessary to create the new volume. +func (vpc *VpcV1) CreateVolume(createVolumeOptions *CreateVolumeOptions) (result *Volume, response *core.DetailedResponse, err error) { + return vpc.CreateVolumeWithContext(context.Background(), createVolumeOptions) +} + +// CreateVolumeWithContext is an alternate form of the CreateVolume method which supports a Context parameter +func (vpc *VpcV1) CreateVolumeWithContext(ctx context.Context, createVolumeOptions *CreateVolumeOptions) (result *Volume, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createVolumeOptions, "createVolumeOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createVolumeOptions, "createVolumeOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/volumes`, nil) + if err != nil { + return + } + + for headerName, headerValue := range createVolumeOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateVolume") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(createVolumeOptions.VolumePrototype) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVolume) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteVolume : Delete a volume +// This request deletes a volume. This operation cannot be reversed. For this request to succeed, the volume must not be +// attached to any instances. +func (vpc *VpcV1) DeleteVolume(deleteVolumeOptions *DeleteVolumeOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteVolumeWithContext(context.Background(), deleteVolumeOptions) +} + +// DeleteVolumeWithContext is an alternate form of the DeleteVolume method which supports a Context parameter +func (vpc *VpcV1) DeleteVolumeWithContext(ctx context.Context, deleteVolumeOptions *DeleteVolumeOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteVolumeOptions, "deleteVolumeOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteVolumeOptions, "deleteVolumeOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *deleteVolumeOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/volumes/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteVolumeOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteVolume") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + if deleteVolumeOptions.IfMatch != nil { + builder.AddHeader("If-Match", fmt.Sprint(*deleteVolumeOptions.IfMatch)) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetVolume : Retrieve a volume +// This request retrieves a single volume specified by the identifier in the URL. +func (vpc *VpcV1) GetVolume(getVolumeOptions *GetVolumeOptions) (result *Volume, response *core.DetailedResponse, err error) { + return vpc.GetVolumeWithContext(context.Background(), getVolumeOptions) +} + +// GetVolumeWithContext is an alternate form of the GetVolume method which supports a Context parameter +func (vpc *VpcV1) GetVolumeWithContext(ctx context.Context, getVolumeOptions *GetVolumeOptions) (result *Volume, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getVolumeOptions, "getVolumeOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getVolumeOptions, "getVolumeOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getVolumeOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/volumes/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getVolumeOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetVolume") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVolume) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateVolume : Update a volume +// This request updates a volume with the information in a provided volume patch. The volume patch object is structured +// in the same way as a retrieved volume and contains only the information to be updated. +func (vpc *VpcV1) UpdateVolume(updateVolumeOptions *UpdateVolumeOptions) (result *Volume, response *core.DetailedResponse, err error) { + return vpc.UpdateVolumeWithContext(context.Background(), updateVolumeOptions) +} + +// UpdateVolumeWithContext is an alternate form of the UpdateVolume method which supports a Context parameter +func (vpc *VpcV1) UpdateVolumeWithContext(ctx context.Context, updateVolumeOptions *UpdateVolumeOptions) (result *Volume, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateVolumeOptions, "updateVolumeOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateVolumeOptions, "updateVolumeOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *updateVolumeOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/volumes/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateVolumeOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateVolume") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + if updateVolumeOptions.IfMatch != nil { + builder.AddHeader("If-Match", fmt.Sprint(*updateVolumeOptions.IfMatch)) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateVolumeOptions.VolumePatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVolume) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteSnapshots : Delete a filtered collection of snapshots +// This request deletes all snapshots created from a specific source volume. +func (vpc *VpcV1) DeleteSnapshots(deleteSnapshotsOptions *DeleteSnapshotsOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteSnapshotsWithContext(context.Background(), deleteSnapshotsOptions) +} + +// DeleteSnapshotsWithContext is an alternate form of the DeleteSnapshots method which supports a Context parameter +func (vpc *VpcV1) DeleteSnapshotsWithContext(ctx context.Context, deleteSnapshotsOptions *DeleteSnapshotsOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteSnapshotsOptions, "deleteSnapshotsOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteSnapshotsOptions, "deleteSnapshotsOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/snapshots`, nil) + if err != nil { + return + } + + for headerName, headerValue := range deleteSnapshotsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteSnapshots") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + builder.AddQuery("source_volume.id", fmt.Sprint(*deleteSnapshotsOptions.SourceVolumeID)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// ListSnapshots : List all snapshots +// This request lists all snapshots in the region. A snapshot preserves the data of a volume at the time the snapshot is +// created. +func (vpc *VpcV1) ListSnapshots(listSnapshotsOptions *ListSnapshotsOptions) (result *SnapshotCollection, response *core.DetailedResponse, err error) { + return vpc.ListSnapshotsWithContext(context.Background(), listSnapshotsOptions) +} + +// ListSnapshotsWithContext is an alternate form of the ListSnapshots method which supports a Context parameter +func (vpc *VpcV1) ListSnapshotsWithContext(ctx context.Context, listSnapshotsOptions *ListSnapshotsOptions) (result *SnapshotCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listSnapshotsOptions, "listSnapshotsOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/snapshots`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listSnapshotsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListSnapshots") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listSnapshotsOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listSnapshotsOptions.Start)) + } + if listSnapshotsOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listSnapshotsOptions.Limit)) + } + if listSnapshotsOptions.Tag != nil { + builder.AddQuery("tag", fmt.Sprint(*listSnapshotsOptions.Tag)) + } + if listSnapshotsOptions.ResourceGroupID != nil { + builder.AddQuery("resource_group.id", fmt.Sprint(*listSnapshotsOptions.ResourceGroupID)) + } + if listSnapshotsOptions.Name != nil { + builder.AddQuery("name", fmt.Sprint(*listSnapshotsOptions.Name)) + } + if listSnapshotsOptions.SourceVolumeID != nil { + builder.AddQuery("source_volume.id", fmt.Sprint(*listSnapshotsOptions.SourceVolumeID)) + } + if listSnapshotsOptions.SourceVolumeCRN != nil { + builder.AddQuery("source_volume.crn", fmt.Sprint(*listSnapshotsOptions.SourceVolumeCRN)) + } + if listSnapshotsOptions.SourceImageID != nil { + builder.AddQuery("source_image.id", fmt.Sprint(*listSnapshotsOptions.SourceImageID)) + } + if listSnapshotsOptions.SourceImageCRN != nil { + builder.AddQuery("source_image.crn", fmt.Sprint(*listSnapshotsOptions.SourceImageCRN)) + } + if listSnapshotsOptions.Sort != nil { + builder.AddQuery("sort", fmt.Sprint(*listSnapshotsOptions.Sort)) + } + if listSnapshotsOptions.BackupPolicyPlanID != nil { + builder.AddQuery("backup_policy_plan.id", fmt.Sprint(*listSnapshotsOptions.BackupPolicyPlanID)) + } + if listSnapshotsOptions.CopiesID != nil { + builder.AddQuery("copies[].id", fmt.Sprint(*listSnapshotsOptions.CopiesID)) + } + if listSnapshotsOptions.CopiesName != nil { + builder.AddQuery("copies[].name", fmt.Sprint(*listSnapshotsOptions.CopiesName)) + } + if listSnapshotsOptions.CopiesCRN != nil { + builder.AddQuery("copies[].crn", fmt.Sprint(*listSnapshotsOptions.CopiesCRN)) + } + if listSnapshotsOptions.CopiesRemoteRegionName != nil { + builder.AddQuery("copies[].remote.region.name", fmt.Sprint(*listSnapshotsOptions.CopiesRemoteRegionName)) + } + if listSnapshotsOptions.SourceSnapshotID != nil { + builder.AddQuery("source_snapshot.id", fmt.Sprint(*listSnapshotsOptions.SourceSnapshotID)) + } + if listSnapshotsOptions.SourceSnapshotRemoteRegionName != nil { + builder.AddQuery("source_snapshot.remote.region.name", fmt.Sprint(*listSnapshotsOptions.SourceSnapshotRemoteRegionName)) + } + if listSnapshotsOptions.SourceVolumeRemoteRegionName != nil { + builder.AddQuery("source_volume.remote.region.name", fmt.Sprint(*listSnapshotsOptions.SourceVolumeRemoteRegionName)) + } + if listSnapshotsOptions.SourceImageRemoteRegionName != nil { + builder.AddQuery("source_image.remote.region.name", fmt.Sprint(*listSnapshotsOptions.SourceImageRemoteRegionName)) + } + if listSnapshotsOptions.ClonesZoneName != nil { + builder.AddQuery("clones[].zone.name", fmt.Sprint(*listSnapshotsOptions.ClonesZoneName)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalSnapshotCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateSnapshot : Create a snapshot +// This request creates a new snapshot from a snapshot prototype object. The prototype object is structured in the same +// way as a retrieved snapshot, and contains the information necessary to provision the new snapshot. +func (vpc *VpcV1) CreateSnapshot(createSnapshotOptions *CreateSnapshotOptions) (result *Snapshot, response *core.DetailedResponse, err error) { + return vpc.CreateSnapshotWithContext(context.Background(), createSnapshotOptions) +} + +// CreateSnapshotWithContext is an alternate form of the CreateSnapshot method which supports a Context parameter +func (vpc *VpcV1) CreateSnapshotWithContext(ctx context.Context, createSnapshotOptions *CreateSnapshotOptions) (result *Snapshot, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createSnapshotOptions, "createSnapshotOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createSnapshotOptions, "createSnapshotOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/snapshots`, nil) + if err != nil { + return + } + + for headerName, headerValue := range createSnapshotOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateSnapshot") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(createSnapshotOptions.SnapshotPrototype) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalSnapshot) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteSnapshot : Delete a snapshot +// This request deletes a snapshot. This operation cannot be reversed. +func (vpc *VpcV1) DeleteSnapshot(deleteSnapshotOptions *DeleteSnapshotOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteSnapshotWithContext(context.Background(), deleteSnapshotOptions) +} + +// DeleteSnapshotWithContext is an alternate form of the DeleteSnapshot method which supports a Context parameter +func (vpc *VpcV1) DeleteSnapshotWithContext(ctx context.Context, deleteSnapshotOptions *DeleteSnapshotOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteSnapshotOptions, "deleteSnapshotOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteSnapshotOptions, "deleteSnapshotOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *deleteSnapshotOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/snapshots/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteSnapshotOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteSnapshot") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + if deleteSnapshotOptions.IfMatch != nil { + builder.AddHeader("If-Match", fmt.Sprint(*deleteSnapshotOptions.IfMatch)) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetSnapshot : Retrieve a snapshot +// This request retrieves a single snapshot specified by the identifier in the URL. +func (vpc *VpcV1) GetSnapshot(getSnapshotOptions *GetSnapshotOptions) (result *Snapshot, response *core.DetailedResponse, err error) { + return vpc.GetSnapshotWithContext(context.Background(), getSnapshotOptions) +} + +// GetSnapshotWithContext is an alternate form of the GetSnapshot method which supports a Context parameter +func (vpc *VpcV1) GetSnapshotWithContext(ctx context.Context, getSnapshotOptions *GetSnapshotOptions) (result *Snapshot, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getSnapshotOptions, "getSnapshotOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getSnapshotOptions, "getSnapshotOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getSnapshotOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/snapshots/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getSnapshotOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetSnapshot") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalSnapshot) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateSnapshot : Update a snapshot +// This request updates a snapshot with the information in a provided snapshot patch. The snapshot consistency group +// patch object is structured in the same way as a retrieved snapshot and contains only the information to be updated. +func (vpc *VpcV1) UpdateSnapshot(updateSnapshotOptions *UpdateSnapshotOptions) (result *Snapshot, response *core.DetailedResponse, err error) { + return vpc.UpdateSnapshotWithContext(context.Background(), updateSnapshotOptions) +} + +// UpdateSnapshotWithContext is an alternate form of the UpdateSnapshot method which supports a Context parameter +func (vpc *VpcV1) UpdateSnapshotWithContext(ctx context.Context, updateSnapshotOptions *UpdateSnapshotOptions) (result *Snapshot, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateSnapshotOptions, "updateSnapshotOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateSnapshotOptions, "updateSnapshotOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *updateSnapshotOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/snapshots/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateSnapshotOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateSnapshot") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + if updateSnapshotOptions.IfMatch != nil { + builder.AddHeader("If-Match", fmt.Sprint(*updateSnapshotOptions.IfMatch)) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateSnapshotOptions.SnapshotPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalSnapshot) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListSnapshotClones : List all clones for a snapshot +// This request lists all clones for a snapshot. Use a clone to quickly restore a snapshot within the clone's zone. +func (vpc *VpcV1) ListSnapshotClones(listSnapshotClonesOptions *ListSnapshotClonesOptions) (result *SnapshotCloneCollection, response *core.DetailedResponse, err error) { + return vpc.ListSnapshotClonesWithContext(context.Background(), listSnapshotClonesOptions) +} + +// ListSnapshotClonesWithContext is an alternate form of the ListSnapshotClones method which supports a Context parameter +func (vpc *VpcV1) ListSnapshotClonesWithContext(ctx context.Context, listSnapshotClonesOptions *ListSnapshotClonesOptions) (result *SnapshotCloneCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listSnapshotClonesOptions, "listSnapshotClonesOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listSnapshotClonesOptions, "listSnapshotClonesOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *listSnapshotClonesOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/snapshots/{id}/clones`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listSnapshotClonesOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListSnapshotClones") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalSnapshotCloneCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteSnapshotClone : Delete a snapshot clone +// This request deletes a snapshot clone. This operation cannot be reversed, but an equivalent clone may be recreated +// from the snapshot. +func (vpc *VpcV1) DeleteSnapshotClone(deleteSnapshotCloneOptions *DeleteSnapshotCloneOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteSnapshotCloneWithContext(context.Background(), deleteSnapshotCloneOptions) +} + +// DeleteSnapshotCloneWithContext is an alternate form of the DeleteSnapshotClone method which supports a Context parameter +func (vpc *VpcV1) DeleteSnapshotCloneWithContext(ctx context.Context, deleteSnapshotCloneOptions *DeleteSnapshotCloneOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteSnapshotCloneOptions, "deleteSnapshotCloneOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteSnapshotCloneOptions, "deleteSnapshotCloneOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *deleteSnapshotCloneOptions.ID, + "zone_name": *deleteSnapshotCloneOptions.ZoneName, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/snapshots/{id}/clones/{zone_name}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteSnapshotCloneOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteSnapshotClone") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetSnapshotClone : Retrieve a snapshot clone +// This request retrieves a single clone specified by the snapshot identifier and zone name in the URL. +func (vpc *VpcV1) GetSnapshotClone(getSnapshotCloneOptions *GetSnapshotCloneOptions) (result *SnapshotClone, response *core.DetailedResponse, err error) { + return vpc.GetSnapshotCloneWithContext(context.Background(), getSnapshotCloneOptions) +} + +// GetSnapshotCloneWithContext is an alternate form of the GetSnapshotClone method which supports a Context parameter +func (vpc *VpcV1) GetSnapshotCloneWithContext(ctx context.Context, getSnapshotCloneOptions *GetSnapshotCloneOptions) (result *SnapshotClone, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getSnapshotCloneOptions, "getSnapshotCloneOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getSnapshotCloneOptions, "getSnapshotCloneOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getSnapshotCloneOptions.ID, + "zone_name": *getSnapshotCloneOptions.ZoneName, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/snapshots/{id}/clones/{zone_name}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getSnapshotCloneOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetSnapshotClone") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalSnapshotClone) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateSnapshotClone : Create a clone for a snapshot +// This request creates a new clone for a snapshot in the specified zone. A request body is not required, and if +// provided, is ignored. If the snapshot already has a clone in the zone, it is returned. +func (vpc *VpcV1) CreateSnapshotClone(createSnapshotCloneOptions *CreateSnapshotCloneOptions) (result *SnapshotClone, response *core.DetailedResponse, err error) { + return vpc.CreateSnapshotCloneWithContext(context.Background(), createSnapshotCloneOptions) +} + +// CreateSnapshotCloneWithContext is an alternate form of the CreateSnapshotClone method which supports a Context parameter +func (vpc *VpcV1) CreateSnapshotCloneWithContext(ctx context.Context, createSnapshotCloneOptions *CreateSnapshotCloneOptions) (result *SnapshotClone, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createSnapshotCloneOptions, "createSnapshotCloneOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createSnapshotCloneOptions, "createSnapshotCloneOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *createSnapshotCloneOptions.ID, + "zone_name": *createSnapshotCloneOptions.ZoneName, + } + + builder := core.NewRequestBuilder(core.PUT) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/snapshots/{id}/clones/{zone_name}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range createSnapshotCloneOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateSnapshotClone") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalSnapshotClone) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListShareProfiles : List all file share profiles +// This request lists all [file share profiles](https://cloud.ibm.com/docs/vpc?topic=vpc-file-storage-profiles) +// available in the region. A file share profile specifies the performance characteristics and pricing model for a file +// share. +func (vpc *VpcV1) ListShareProfiles(listShareProfilesOptions *ListShareProfilesOptions) (result *ShareProfileCollection, response *core.DetailedResponse, err error) { + return vpc.ListShareProfilesWithContext(context.Background(), listShareProfilesOptions) +} + +// ListShareProfilesWithContext is an alternate form of the ListShareProfiles method which supports a Context parameter +func (vpc *VpcV1) ListShareProfilesWithContext(ctx context.Context, listShareProfilesOptions *ListShareProfilesOptions) (result *ShareProfileCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listShareProfilesOptions, "listShareProfilesOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/share/profiles`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listShareProfilesOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListShareProfiles") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listShareProfilesOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listShareProfilesOptions.Start)) + } + if listShareProfilesOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listShareProfilesOptions.Limit)) + } + if listShareProfilesOptions.Sort != nil { + builder.AddQuery("sort", fmt.Sprint(*listShareProfilesOptions.Sort)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalShareProfileCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// GetShareProfile : Retrieve a file share profile +// This request retrieves a single file share profile specified by the name in the URL. +func (vpc *VpcV1) GetShareProfile(getShareProfileOptions *GetShareProfileOptions) (result *ShareProfile, response *core.DetailedResponse, err error) { + return vpc.GetShareProfileWithContext(context.Background(), getShareProfileOptions) +} + +// GetShareProfileWithContext is an alternate form of the GetShareProfile method which supports a Context parameter +func (vpc *VpcV1) GetShareProfileWithContext(ctx context.Context, getShareProfileOptions *GetShareProfileOptions) (result *ShareProfile, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getShareProfileOptions, "getShareProfileOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getShareProfileOptions, "getShareProfileOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "name": *getShareProfileOptions.Name, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/share/profiles/{name}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getShareProfileOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetShareProfile") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalShareProfile) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListShares : List all file shares +// This request lists all file shares in the region. +func (vpc *VpcV1) ListShares(listSharesOptions *ListSharesOptions) (result *ShareCollection, response *core.DetailedResponse, err error) { + return vpc.ListSharesWithContext(context.Background(), listSharesOptions) +} + +// ListSharesWithContext is an alternate form of the ListShares method which supports a Context parameter +func (vpc *VpcV1) ListSharesWithContext(ctx context.Context, listSharesOptions *ListSharesOptions) (result *ShareCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listSharesOptions, "listSharesOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/shares`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listSharesOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListShares") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listSharesOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listSharesOptions.Start)) + } + if listSharesOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listSharesOptions.Limit)) + } + if listSharesOptions.ResourceGroupID != nil { + builder.AddQuery("resource_group.id", fmt.Sprint(*listSharesOptions.ResourceGroupID)) + } + if listSharesOptions.Name != nil { + builder.AddQuery("name", fmt.Sprint(*listSharesOptions.Name)) + } + if listSharesOptions.Sort != nil { + builder.AddQuery("sort", fmt.Sprint(*listSharesOptions.Sort)) + } + if listSharesOptions.ReplicationRole != nil { + builder.AddQuery("replication_role", fmt.Sprint(*listSharesOptions.ReplicationRole)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalShareCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateShare : Create a file share +// This request provisions new file shares from a share prototype object. The new file shares can be a standalone share, +// a replica share, or both a source and replica share. +// +// The prototype object is structured in the same way as a retrieved share, and contains the information necessary to +// provision the new file shares. +func (vpc *VpcV1) CreateShare(createShareOptions *CreateShareOptions) (result *Share, response *core.DetailedResponse, err error) { + return vpc.CreateShareWithContext(context.Background(), createShareOptions) +} + +// CreateShareWithContext is an alternate form of the CreateShare method which supports a Context parameter +func (vpc *VpcV1) CreateShareWithContext(ctx context.Context, createShareOptions *CreateShareOptions) (result *Share, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createShareOptions, "createShareOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createShareOptions, "createShareOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/shares`, nil) + if err != nil { + return + } + + for headerName, headerValue := range createShareOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateShare") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(createShareOptions.SharePrototype) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalShare) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteShare : Delete a file share +// This request deletes a share. This operation cannot be reversed. A share cannot be deleted if it: +// - has share mount targets +// - has a `lifecycle_state` of `updating` +// - has a replication operation in progress +// +// If the request is accepted, the share `lifecycle_state` will be set to `deleting`. Once deletion processing +// completes, it will no longer be retrievable. +func (vpc *VpcV1) DeleteShare(deleteShareOptions *DeleteShareOptions) (result *Share, response *core.DetailedResponse, err error) { + return vpc.DeleteShareWithContext(context.Background(), deleteShareOptions) +} + +// DeleteShareWithContext is an alternate form of the DeleteShare method which supports a Context parameter +func (vpc *VpcV1) DeleteShareWithContext(ctx context.Context, deleteShareOptions *DeleteShareOptions) (result *Share, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteShareOptions, "deleteShareOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteShareOptions, "deleteShareOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *deleteShareOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/shares/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteShareOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteShare") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + if deleteShareOptions.IfMatch != nil { + builder.AddHeader("If-Match", fmt.Sprint(*deleteShareOptions.IfMatch)) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalShare) + if err != nil { + return + } + response.Result = result + } + + return +} + +// GetShare : Retrieve a file share +// This request retrieves a single file share specified by the identifier in the URL. +func (vpc *VpcV1) GetShare(getShareOptions *GetShareOptions) (result *Share, response *core.DetailedResponse, err error) { + return vpc.GetShareWithContext(context.Background(), getShareOptions) +} + +// GetShareWithContext is an alternate form of the GetShare method which supports a Context parameter +func (vpc *VpcV1) GetShareWithContext(ctx context.Context, getShareOptions *GetShareOptions) (result *Share, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getShareOptions, "getShareOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getShareOptions, "getShareOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getShareOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/shares/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getShareOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetShare") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalShare) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateShare : Update a file share +// This request updates a share with the information in a provided share patch. The share patch object is structured in +// the same way as a retrieved share and contains only the information to be updated. +func (vpc *VpcV1) UpdateShare(updateShareOptions *UpdateShareOptions) (result *Share, response *core.DetailedResponse, err error) { + return vpc.UpdateShareWithContext(context.Background(), updateShareOptions) +} + +// UpdateShareWithContext is an alternate form of the UpdateShare method which supports a Context parameter +func (vpc *VpcV1) UpdateShareWithContext(ctx context.Context, updateShareOptions *UpdateShareOptions) (result *Share, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateShareOptions, "updateShareOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateShareOptions, "updateShareOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *updateShareOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/shares/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateShareOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateShare") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + if updateShareOptions.IfMatch != nil { + builder.AddHeader("If-Match", fmt.Sprint(*updateShareOptions.IfMatch)) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateShareOptions.SharePatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalShare) + if err != nil { + return + } + response.Result = result + } + + return +} + +// FailoverShare : Failover to replica file share +// This request triggers a failover to the replica file share specified by the identifier in the URL. The failover +// cannot be started if a source share or the replica share has a `lifecycle_state` of `updating`, or has a replication +// operation in progress. +// +// If `fallback_policy` is specified as `split`, and the request is accepted but the failover operation cannot be +// performed, a split will be triggered. +func (vpc *VpcV1) FailoverShare(failoverShareOptions *FailoverShareOptions) (response *core.DetailedResponse, err error) { + return vpc.FailoverShareWithContext(context.Background(), failoverShareOptions) +} + +// FailoverShareWithContext is an alternate form of the FailoverShare method which supports a Context parameter +func (vpc *VpcV1) FailoverShareWithContext(ctx context.Context, failoverShareOptions *FailoverShareOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(failoverShareOptions, "failoverShareOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(failoverShareOptions, "failoverShareOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "share_id": *failoverShareOptions.ShareID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/shares/{share_id}/failover`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range failoverShareOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "FailoverShare") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if failoverShareOptions.FallbackPolicy != nil { + body["fallback_policy"] = failoverShareOptions.FallbackPolicy + } + if failoverShareOptions.Timeout != nil { + body["timeout"] = failoverShareOptions.Timeout + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// ListShareMountTargets : List all mount targets for a file share +// This request retrieves all share mount targets for a file share. A share mount target is a network endpoint at which +// a file share may be mounted. The file share can be mounted by clients in the same VPC and zone after creating share +// mount targets. +// +// The share mount targets will be sorted by their `created_at` property values, with newest targets first. +func (vpc *VpcV1) ListShareMountTargets(listShareMountTargetsOptions *ListShareMountTargetsOptions) (result *ShareMountTargetCollection, response *core.DetailedResponse, err error) { + return vpc.ListShareMountTargetsWithContext(context.Background(), listShareMountTargetsOptions) +} + +// ListShareMountTargetsWithContext is an alternate form of the ListShareMountTargets method which supports a Context parameter +func (vpc *VpcV1) ListShareMountTargetsWithContext(ctx context.Context, listShareMountTargetsOptions *ListShareMountTargetsOptions) (result *ShareMountTargetCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listShareMountTargetsOptions, "listShareMountTargetsOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listShareMountTargetsOptions, "listShareMountTargetsOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "share_id": *listShareMountTargetsOptions.ShareID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/shares/{share_id}/mount_targets`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listShareMountTargetsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListShareMountTargets") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listShareMountTargetsOptions.Name != nil { + builder.AddQuery("name", fmt.Sprint(*listShareMountTargetsOptions.Name)) + } + if listShareMountTargetsOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listShareMountTargetsOptions.Start)) + } + if listShareMountTargetsOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listShareMountTargetsOptions.Limit)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalShareMountTargetCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateShareMountTarget : Create a mount target for a file share +// This request creates a new share mount target from a share mount target prototype object. +// +// The prototype object is structured in the same way as a retrieved share mount target, and contains the information +// necessary to provision the new file share mount target. +func (vpc *VpcV1) CreateShareMountTarget(createShareMountTargetOptions *CreateShareMountTargetOptions) (result *ShareMountTarget, response *core.DetailedResponse, err error) { + return vpc.CreateShareMountTargetWithContext(context.Background(), createShareMountTargetOptions) +} + +// CreateShareMountTargetWithContext is an alternate form of the CreateShareMountTarget method which supports a Context parameter +func (vpc *VpcV1) CreateShareMountTargetWithContext(ctx context.Context, createShareMountTargetOptions *CreateShareMountTargetOptions) (result *ShareMountTarget, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createShareMountTargetOptions, "createShareMountTargetOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createShareMountTargetOptions, "createShareMountTargetOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "share_id": *createShareMountTargetOptions.ShareID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/shares/{share_id}/mount_targets`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range createShareMountTargetOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateShareMountTarget") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(createShareMountTargetOptions.ShareMountTargetPrototype) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalShareMountTarget) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteShareMountTarget : Delete a share mount target +// This request deletes a share mount target. This operation cannot be reversed. +// +// If the request is accepted, the share mount target `lifecycle_state` will be set to +// `deleting`. Once deletion processing completes, it will no longer be retrievable. +func (vpc *VpcV1) DeleteShareMountTarget(deleteShareMountTargetOptions *DeleteShareMountTargetOptions) (result *ShareMountTarget, response *core.DetailedResponse, err error) { + return vpc.DeleteShareMountTargetWithContext(context.Background(), deleteShareMountTargetOptions) +} + +// DeleteShareMountTargetWithContext is an alternate form of the DeleteShareMountTarget method which supports a Context parameter +func (vpc *VpcV1) DeleteShareMountTargetWithContext(ctx context.Context, deleteShareMountTargetOptions *DeleteShareMountTargetOptions) (result *ShareMountTarget, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteShareMountTargetOptions, "deleteShareMountTargetOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteShareMountTargetOptions, "deleteShareMountTargetOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "share_id": *deleteShareMountTargetOptions.ShareID, + "id": *deleteShareMountTargetOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/shares/{share_id}/mount_targets/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteShareMountTargetOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteShareMountTarget") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalShareMountTarget) + if err != nil { + return + } + response.Result = result + } + + return +} + +// GetShareMountTarget : Retrieve a share mount target +// This request retrieves a single share mount target specified by the identifier in the URL. +func (vpc *VpcV1) GetShareMountTarget(getShareMountTargetOptions *GetShareMountTargetOptions) (result *ShareMountTarget, response *core.DetailedResponse, err error) { + return vpc.GetShareMountTargetWithContext(context.Background(), getShareMountTargetOptions) +} + +// GetShareMountTargetWithContext is an alternate form of the GetShareMountTarget method which supports a Context parameter +func (vpc *VpcV1) GetShareMountTargetWithContext(ctx context.Context, getShareMountTargetOptions *GetShareMountTargetOptions) (result *ShareMountTarget, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getShareMountTargetOptions, "getShareMountTargetOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getShareMountTargetOptions, "getShareMountTargetOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "share_id": *getShareMountTargetOptions.ShareID, + "id": *getShareMountTargetOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/shares/{share_id}/mount_targets/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getShareMountTargetOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetShareMountTarget") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalShareMountTarget) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateShareMountTarget : Update a share mount target +// This request updates a share mount target with the information provided in a share mount target patch object. The +// share mount target patch object is structured in the same way as a retrieved share mount target and needs to contain +// only the information to be updated. +func (vpc *VpcV1) UpdateShareMountTarget(updateShareMountTargetOptions *UpdateShareMountTargetOptions) (result *ShareMountTarget, response *core.DetailedResponse, err error) { + return vpc.UpdateShareMountTargetWithContext(context.Background(), updateShareMountTargetOptions) +} + +// UpdateShareMountTargetWithContext is an alternate form of the UpdateShareMountTarget method which supports a Context parameter +func (vpc *VpcV1) UpdateShareMountTargetWithContext(ctx context.Context, updateShareMountTargetOptions *UpdateShareMountTargetOptions) (result *ShareMountTarget, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateShareMountTargetOptions, "updateShareMountTargetOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateShareMountTargetOptions, "updateShareMountTargetOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "share_id": *updateShareMountTargetOptions.ShareID, + "id": *updateShareMountTargetOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/shares/{share_id}/mount_targets/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateShareMountTargetOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateShareMountTarget") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateShareMountTargetOptions.ShareMountTargetPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalShareMountTarget) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteShareSource : Split the source file share from a replica share +// This request removes the replication relationship between a source share and the replica share specified by the +// identifier in the URL. The replication relationship cannot be removed if a source share or the replica share has a +// `lifecycle_state` of `updating`, or has a replication operation in progress. +// +// This operation cannot be reversed. +func (vpc *VpcV1) DeleteShareSource(deleteShareSourceOptions *DeleteShareSourceOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteShareSourceWithContext(context.Background(), deleteShareSourceOptions) +} + +// DeleteShareSourceWithContext is an alternate form of the DeleteShareSource method which supports a Context parameter +func (vpc *VpcV1) DeleteShareSourceWithContext(ctx context.Context, deleteShareSourceOptions *DeleteShareSourceOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteShareSourceOptions, "deleteShareSourceOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteShareSourceOptions, "deleteShareSourceOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "share_id": *deleteShareSourceOptions.ShareID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/shares/{share_id}/source`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteShareSourceOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteShareSource") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetShareSource : Retrieve the source file share for a replica file share +// This request retrieves the source file share associated with the replica file share specified by the identifier in +// the URL. +func (vpc *VpcV1) GetShareSource(getShareSourceOptions *GetShareSourceOptions) (result *Share, response *core.DetailedResponse, err error) { + return vpc.GetShareSourceWithContext(context.Background(), getShareSourceOptions) +} + +// GetShareSourceWithContext is an alternate form of the GetShareSource method which supports a Context parameter +func (vpc *VpcV1) GetShareSourceWithContext(ctx context.Context, getShareSourceOptions *GetShareSourceOptions) (result *Share, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getShareSourceOptions, "getShareSourceOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getShareSourceOptions, "getShareSourceOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "share_id": *getShareSourceOptions.ShareID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/shares/{share_id}/source`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getShareSourceOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetShareSource") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalShare) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListRegions : List all regions +// This request lists all regions. Each region is a separate geographic area that contains multiple isolated zones. +// Resources can be provisioned into one or more zones in a region. Each zone is isolated, but connected to other zones +// in the same region with low-latency and high-bandwidth links. Regions represent the top-level of fault isolation +// available. Resources deployed within a single region also benefit from the low latency afforded by geographic +// proximity. +func (vpc *VpcV1) ListRegions(listRegionsOptions *ListRegionsOptions) (result *RegionCollection, response *core.DetailedResponse, err error) { + return vpc.ListRegionsWithContext(context.Background(), listRegionsOptions) +} + +// ListRegionsWithContext is an alternate form of the ListRegions method which supports a Context parameter +func (vpc *VpcV1) ListRegionsWithContext(ctx context.Context, listRegionsOptions *ListRegionsOptions) (result *RegionCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listRegionsOptions, "listRegionsOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/regions`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listRegionsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListRegions") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalRegionCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// GetRegion : Retrieve a region +// This request retrieves a single region specified by the name in the URL. +func (vpc *VpcV1) GetRegion(getRegionOptions *GetRegionOptions) (result *Region, response *core.DetailedResponse, err error) { + return vpc.GetRegionWithContext(context.Background(), getRegionOptions) +} + +// GetRegionWithContext is an alternate form of the GetRegion method which supports a Context parameter +func (vpc *VpcV1) GetRegionWithContext(ctx context.Context, getRegionOptions *GetRegionOptions) (result *Region, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getRegionOptions, "getRegionOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getRegionOptions, "getRegionOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "name": *getRegionOptions.Name, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/regions/{name}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getRegionOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetRegion") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalRegion) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListRegionZones : List all zones in a region +// This request lists all zones in a region. Zones represent logically-isolated data centers with high-bandwidth and +// low-latency interconnects to other zones in the same region. Faults in a zone do not affect other zones. +func (vpc *VpcV1) ListRegionZones(listRegionZonesOptions *ListRegionZonesOptions) (result *ZoneCollection, response *core.DetailedResponse, err error) { + return vpc.ListRegionZonesWithContext(context.Background(), listRegionZonesOptions) +} + +// ListRegionZonesWithContext is an alternate form of the ListRegionZones method which supports a Context parameter +func (vpc *VpcV1) ListRegionZonesWithContext(ctx context.Context, listRegionZonesOptions *ListRegionZonesOptions) (result *ZoneCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listRegionZonesOptions, "listRegionZonesOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listRegionZonesOptions, "listRegionZonesOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "region_name": *listRegionZonesOptions.RegionName, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/regions/{region_name}/zones`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listRegionZonesOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListRegionZones") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalZoneCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// GetRegionZone : Retrieve a zone +// This request retrieves a single zone specified by the region and zone names in the URL. +func (vpc *VpcV1) GetRegionZone(getRegionZoneOptions *GetRegionZoneOptions) (result *Zone, response *core.DetailedResponse, err error) { + return vpc.GetRegionZoneWithContext(context.Background(), getRegionZoneOptions) +} + +// GetRegionZoneWithContext is an alternate form of the GetRegionZone method which supports a Context parameter +func (vpc *VpcV1) GetRegionZoneWithContext(ctx context.Context, getRegionZoneOptions *GetRegionZoneOptions) (result *Zone, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getRegionZoneOptions, "getRegionZoneOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getRegionZoneOptions, "getRegionZoneOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "region_name": *getRegionZoneOptions.RegionName, + "name": *getRegionZoneOptions.Name, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/regions/{region_name}/zones/{name}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getRegionZoneOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetRegionZone") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalZone) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListVirtualNetworkInterfaces : List all virtual network interfaces +// This request lists all virtual network interfaces in the region. A virtual network interface is a logical abstraction +// of a virtual network interface in a subnet, and may be attached to a target resource. +// +// The virtual network interfaces will be sorted by their `created_at` property values, with newest virtual network +// interfaces first. Virtual network interfaces with identical +// `created_at` property values will in turn be sorted by ascending `name` property values. +func (vpc *VpcV1) ListVirtualNetworkInterfaces(listVirtualNetworkInterfacesOptions *ListVirtualNetworkInterfacesOptions) (result *VirtualNetworkInterfaceCollection, response *core.DetailedResponse, err error) { + return vpc.ListVirtualNetworkInterfacesWithContext(context.Background(), listVirtualNetworkInterfacesOptions) +} + +// ListVirtualNetworkInterfacesWithContext is an alternate form of the ListVirtualNetworkInterfaces method which supports a Context parameter +func (vpc *VpcV1) ListVirtualNetworkInterfacesWithContext(ctx context.Context, listVirtualNetworkInterfacesOptions *ListVirtualNetworkInterfacesOptions) (result *VirtualNetworkInterfaceCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listVirtualNetworkInterfacesOptions, "listVirtualNetworkInterfacesOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/virtual_network_interfaces`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listVirtualNetworkInterfacesOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListVirtualNetworkInterfaces") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listVirtualNetworkInterfacesOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listVirtualNetworkInterfacesOptions.Start)) + } + if listVirtualNetworkInterfacesOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listVirtualNetworkInterfacesOptions.Limit)) + } + if listVirtualNetworkInterfacesOptions.ResourceGroupID != nil { + builder.AddQuery("resource_group.id", fmt.Sprint(*listVirtualNetworkInterfacesOptions.ResourceGroupID)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVirtualNetworkInterfaceCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// GetVirtualNetworkInterface : Retrieve a virtual network interface +// This request retrieves a single virtual network interface specified by the identifier in the URL. +func (vpc *VpcV1) GetVirtualNetworkInterface(getVirtualNetworkInterfaceOptions *GetVirtualNetworkInterfaceOptions) (result *VirtualNetworkInterface, response *core.DetailedResponse, err error) { + return vpc.GetVirtualNetworkInterfaceWithContext(context.Background(), getVirtualNetworkInterfaceOptions) +} + +// GetVirtualNetworkInterfaceWithContext is an alternate form of the GetVirtualNetworkInterface method which supports a Context parameter +func (vpc *VpcV1) GetVirtualNetworkInterfaceWithContext(ctx context.Context, getVirtualNetworkInterfaceOptions *GetVirtualNetworkInterfaceOptions) (result *VirtualNetworkInterface, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getVirtualNetworkInterfaceOptions, "getVirtualNetworkInterfaceOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getVirtualNetworkInterfaceOptions, "getVirtualNetworkInterfaceOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getVirtualNetworkInterfaceOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/virtual_network_interfaces/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getVirtualNetworkInterfaceOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetVirtualNetworkInterface") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVirtualNetworkInterface) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateVirtualNetworkInterface : Update a virtual network interface +// This request updates a virtual network interface with the information in a provided virtual network interface patch. +// The virtual network interface patch object is structured in the same way as a retrieved virtual network interface and +// contains only the information to be updated. +func (vpc *VpcV1) UpdateVirtualNetworkInterface(updateVirtualNetworkInterfaceOptions *UpdateVirtualNetworkInterfaceOptions) (result *VirtualNetworkInterface, response *core.DetailedResponse, err error) { + return vpc.UpdateVirtualNetworkInterfaceWithContext(context.Background(), updateVirtualNetworkInterfaceOptions) +} + +// UpdateVirtualNetworkInterfaceWithContext is an alternate form of the UpdateVirtualNetworkInterface method which supports a Context parameter +func (vpc *VpcV1) UpdateVirtualNetworkInterfaceWithContext(ctx context.Context, updateVirtualNetworkInterfaceOptions *UpdateVirtualNetworkInterfaceOptions) (result *VirtualNetworkInterface, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateVirtualNetworkInterfaceOptions, "updateVirtualNetworkInterfaceOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateVirtualNetworkInterfaceOptions, "updateVirtualNetworkInterfaceOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *updateVirtualNetworkInterfaceOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/virtual_network_interfaces/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateVirtualNetworkInterfaceOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateVirtualNetworkInterface") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateVirtualNetworkInterfaceOptions.VirtualNetworkInterfacePatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVirtualNetworkInterface) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListPublicGateways : List all public gateways +// This request lists all public gateways in the region. A public gateway is a virtual network device associated with a +// VPC, which allows access to the Internet. A public gateway resides in a zone and can be connected to subnets in the +// same zone only. +func (vpc *VpcV1) ListPublicGateways(listPublicGatewaysOptions *ListPublicGatewaysOptions) (result *PublicGatewayCollection, response *core.DetailedResponse, err error) { + return vpc.ListPublicGatewaysWithContext(context.Background(), listPublicGatewaysOptions) +} + +// ListPublicGatewaysWithContext is an alternate form of the ListPublicGateways method which supports a Context parameter +func (vpc *VpcV1) ListPublicGatewaysWithContext(ctx context.Context, listPublicGatewaysOptions *ListPublicGatewaysOptions) (result *PublicGatewayCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listPublicGatewaysOptions, "listPublicGatewaysOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/public_gateways`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listPublicGatewaysOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListPublicGateways") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listPublicGatewaysOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listPublicGatewaysOptions.Start)) + } + if listPublicGatewaysOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listPublicGatewaysOptions.Limit)) + } + if listPublicGatewaysOptions.ResourceGroupID != nil { + builder.AddQuery("resource_group.id", fmt.Sprint(*listPublicGatewaysOptions.ResourceGroupID)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalPublicGatewayCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreatePublicGateway : Create a public gateway +// This request creates a new public gateway from a public gateway prototype object. For this to succeed, the VPC must +// not already have a public gateway in the specified zone. +// +// If a floating IP is provided, it must be unbound. If a floating IP is not provided, one will be created and bound to +// the public gateway. Once a public gateway has been created, its floating IP cannot be unbound. A public gateway must +// be explicitly attached to each subnet it will provide connectivity for. +func (vpc *VpcV1) CreatePublicGateway(createPublicGatewayOptions *CreatePublicGatewayOptions) (result *PublicGateway, response *core.DetailedResponse, err error) { + return vpc.CreatePublicGatewayWithContext(context.Background(), createPublicGatewayOptions) +} + +// CreatePublicGatewayWithContext is an alternate form of the CreatePublicGateway method which supports a Context parameter +func (vpc *VpcV1) CreatePublicGatewayWithContext(ctx context.Context, createPublicGatewayOptions *CreatePublicGatewayOptions) (result *PublicGateway, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createPublicGatewayOptions, "createPublicGatewayOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createPublicGatewayOptions, "createPublicGatewayOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/public_gateways`, nil) + if err != nil { + return + } + + for headerName, headerValue := range createPublicGatewayOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreatePublicGateway") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createPublicGatewayOptions.VPC != nil { + body["vpc"] = createPublicGatewayOptions.VPC + } + if createPublicGatewayOptions.Zone != nil { + body["zone"] = createPublicGatewayOptions.Zone + } + if createPublicGatewayOptions.FloatingIP != nil { + body["floating_ip"] = createPublicGatewayOptions.FloatingIP + } + if createPublicGatewayOptions.Name != nil { + body["name"] = createPublicGatewayOptions.Name + } + if createPublicGatewayOptions.ResourceGroup != nil { + body["resource_group"] = createPublicGatewayOptions.ResourceGroup + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalPublicGateway) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeletePublicGateway : Delete a public gateway +// This request deletes a public gateway. This operation cannot be reversed. For this request to succeed, the public +// gateway must not be attached to any subnets. The public gateway's floating IP will be automatically unbound. If the +// floating IP was created when the public gateway was created, it will be deleted. +func (vpc *VpcV1) DeletePublicGateway(deletePublicGatewayOptions *DeletePublicGatewayOptions) (response *core.DetailedResponse, err error) { + return vpc.DeletePublicGatewayWithContext(context.Background(), deletePublicGatewayOptions) +} + +// DeletePublicGatewayWithContext is an alternate form of the DeletePublicGateway method which supports a Context parameter +func (vpc *VpcV1) DeletePublicGatewayWithContext(ctx context.Context, deletePublicGatewayOptions *DeletePublicGatewayOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deletePublicGatewayOptions, "deletePublicGatewayOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deletePublicGatewayOptions, "deletePublicGatewayOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *deletePublicGatewayOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/public_gateways/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deletePublicGatewayOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeletePublicGateway") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetPublicGateway : Retrieve a public gateway +// This request retrieves a single public gateway specified by the identifier in the URL. +func (vpc *VpcV1) GetPublicGateway(getPublicGatewayOptions *GetPublicGatewayOptions) (result *PublicGateway, response *core.DetailedResponse, err error) { + return vpc.GetPublicGatewayWithContext(context.Background(), getPublicGatewayOptions) +} + +// GetPublicGatewayWithContext is an alternate form of the GetPublicGateway method which supports a Context parameter +func (vpc *VpcV1) GetPublicGatewayWithContext(ctx context.Context, getPublicGatewayOptions *GetPublicGatewayOptions) (result *PublicGateway, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getPublicGatewayOptions, "getPublicGatewayOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getPublicGatewayOptions, "getPublicGatewayOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getPublicGatewayOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/public_gateways/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getPublicGatewayOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetPublicGateway") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalPublicGateway) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdatePublicGateway : Update a public gateway +// This request updates a public gateway's name. +func (vpc *VpcV1) UpdatePublicGateway(updatePublicGatewayOptions *UpdatePublicGatewayOptions) (result *PublicGateway, response *core.DetailedResponse, err error) { + return vpc.UpdatePublicGatewayWithContext(context.Background(), updatePublicGatewayOptions) +} + +// UpdatePublicGatewayWithContext is an alternate form of the UpdatePublicGateway method which supports a Context parameter +func (vpc *VpcV1) UpdatePublicGatewayWithContext(ctx context.Context, updatePublicGatewayOptions *UpdatePublicGatewayOptions) (result *PublicGateway, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updatePublicGatewayOptions, "updatePublicGatewayOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updatePublicGatewayOptions, "updatePublicGatewayOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *updatePublicGatewayOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/public_gateways/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updatePublicGatewayOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdatePublicGateway") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updatePublicGatewayOptions.PublicGatewayPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalPublicGateway) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListFloatingIps : List all floating IPs +// This request lists all floating IPs in the region. Floating IPs allow inbound and outbound traffic from the Internet +// to an instance. +func (vpc *VpcV1) ListFloatingIps(listFloatingIpsOptions *ListFloatingIpsOptions) (result *FloatingIPCollection, response *core.DetailedResponse, err error) { + return vpc.ListFloatingIpsWithContext(context.Background(), listFloatingIpsOptions) +} + +// ListFloatingIpsWithContext is an alternate form of the ListFloatingIps method which supports a Context parameter +func (vpc *VpcV1) ListFloatingIpsWithContext(ctx context.Context, listFloatingIpsOptions *ListFloatingIpsOptions) (result *FloatingIPCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listFloatingIpsOptions, "listFloatingIpsOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/floating_ips`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listFloatingIpsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListFloatingIps") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listFloatingIpsOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listFloatingIpsOptions.Start)) + } + if listFloatingIpsOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listFloatingIpsOptions.Limit)) + } + if listFloatingIpsOptions.ResourceGroupID != nil { + builder.AddQuery("resource_group.id", fmt.Sprint(*listFloatingIpsOptions.ResourceGroupID)) + } + if listFloatingIpsOptions.Sort != nil { + builder.AddQuery("sort", fmt.Sprint(*listFloatingIpsOptions.Sort)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalFloatingIPCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateFloatingIP : Reserve a floating IP +// This request reserves a new floating IP. +func (vpc *VpcV1) CreateFloatingIP(createFloatingIPOptions *CreateFloatingIPOptions) (result *FloatingIP, response *core.DetailedResponse, err error) { + return vpc.CreateFloatingIPWithContext(context.Background(), createFloatingIPOptions) +} + +// CreateFloatingIPWithContext is an alternate form of the CreateFloatingIP method which supports a Context parameter +func (vpc *VpcV1) CreateFloatingIPWithContext(ctx context.Context, createFloatingIPOptions *CreateFloatingIPOptions) (result *FloatingIP, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createFloatingIPOptions, "createFloatingIPOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createFloatingIPOptions, "createFloatingIPOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/floating_ips`, nil) + if err != nil { + return + } + + for headerName, headerValue := range createFloatingIPOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateFloatingIP") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(createFloatingIPOptions.FloatingIPPrototype) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalFloatingIP) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteFloatingIP : Delete a floating IP +// This request disassociates (if associated) and releases a floating IP. This operation cannot be reversed. For this +// request to succeed, the floating IP must not be required by another resource, such as a public gateway. +func (vpc *VpcV1) DeleteFloatingIP(deleteFloatingIPOptions *DeleteFloatingIPOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteFloatingIPWithContext(context.Background(), deleteFloatingIPOptions) +} + +// DeleteFloatingIPWithContext is an alternate form of the DeleteFloatingIP method which supports a Context parameter +func (vpc *VpcV1) DeleteFloatingIPWithContext(ctx context.Context, deleteFloatingIPOptions *DeleteFloatingIPOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteFloatingIPOptions, "deleteFloatingIPOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteFloatingIPOptions, "deleteFloatingIPOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *deleteFloatingIPOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/floating_ips/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteFloatingIPOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteFloatingIP") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetFloatingIP : Retrieve a floating IP +// This request retrieves a single floating IP specified by the identifier in the URL. +func (vpc *VpcV1) GetFloatingIP(getFloatingIPOptions *GetFloatingIPOptions) (result *FloatingIP, response *core.DetailedResponse, err error) { + return vpc.GetFloatingIPWithContext(context.Background(), getFloatingIPOptions) +} + +// GetFloatingIPWithContext is an alternate form of the GetFloatingIP method which supports a Context parameter +func (vpc *VpcV1) GetFloatingIPWithContext(ctx context.Context, getFloatingIPOptions *GetFloatingIPOptions) (result *FloatingIP, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getFloatingIPOptions, "getFloatingIPOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getFloatingIPOptions, "getFloatingIPOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getFloatingIPOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/floating_ips/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getFloatingIPOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetFloatingIP") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalFloatingIP) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateFloatingIP : Update a floating IP +// This request updates a floating IP's name and/or target. +func (vpc *VpcV1) UpdateFloatingIP(updateFloatingIPOptions *UpdateFloatingIPOptions) (result *FloatingIP, response *core.DetailedResponse, err error) { + return vpc.UpdateFloatingIPWithContext(context.Background(), updateFloatingIPOptions) +} + +// UpdateFloatingIPWithContext is an alternate form of the UpdateFloatingIP method which supports a Context parameter +func (vpc *VpcV1) UpdateFloatingIPWithContext(ctx context.Context, updateFloatingIPOptions *UpdateFloatingIPOptions) (result *FloatingIP, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateFloatingIPOptions, "updateFloatingIPOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateFloatingIPOptions, "updateFloatingIPOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *updateFloatingIPOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/floating_ips/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateFloatingIPOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateFloatingIP") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateFloatingIPOptions.FloatingIPPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalFloatingIP) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListNetworkAcls : List all network ACLs +// This request lists all network ACLs in the region. A network ACL defines a set of packet filtering (5-tuple) rules +// for all traffic in and out of a subnet. Both allow and deny rules can be defined, and rules are stateless such that +// reverse traffic in response to allowed traffic is not automatically permitted. +func (vpc *VpcV1) ListNetworkAcls(listNetworkAclsOptions *ListNetworkAclsOptions) (result *NetworkACLCollection, response *core.DetailedResponse, err error) { + return vpc.ListNetworkAclsWithContext(context.Background(), listNetworkAclsOptions) +} + +// ListNetworkAclsWithContext is an alternate form of the ListNetworkAcls method which supports a Context parameter +func (vpc *VpcV1) ListNetworkAclsWithContext(ctx context.Context, listNetworkAclsOptions *ListNetworkAclsOptions) (result *NetworkACLCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listNetworkAclsOptions, "listNetworkAclsOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/network_acls`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listNetworkAclsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListNetworkAcls") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listNetworkAclsOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listNetworkAclsOptions.Start)) + } + if listNetworkAclsOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listNetworkAclsOptions.Limit)) + } + if listNetworkAclsOptions.ResourceGroupID != nil { + builder.AddQuery("resource_group.id", fmt.Sprint(*listNetworkAclsOptions.ResourceGroupID)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalNetworkACLCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateNetworkACL : Create a network ACL +// This request creates a new stateless network ACL from a network ACL prototype object. The prototype object is +// structured in the same way as a retrieved network ACL, and contains the information necessary to create the new +// network ACL. +func (vpc *VpcV1) CreateNetworkACL(createNetworkACLOptions *CreateNetworkACLOptions) (result *NetworkACL, response *core.DetailedResponse, err error) { + return vpc.CreateNetworkACLWithContext(context.Background(), createNetworkACLOptions) +} + +// CreateNetworkACLWithContext is an alternate form of the CreateNetworkACL method which supports a Context parameter +func (vpc *VpcV1) CreateNetworkACLWithContext(ctx context.Context, createNetworkACLOptions *CreateNetworkACLOptions) (result *NetworkACL, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createNetworkACLOptions, "createNetworkACLOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createNetworkACLOptions, "createNetworkACLOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/network_acls`, nil) + if err != nil { + return + } + + for headerName, headerValue := range createNetworkACLOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateNetworkACL") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(createNetworkACLOptions.NetworkACLPrototype) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalNetworkACL) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteNetworkACL : Delete a network ACL +// This request deletes a network ACL. This operation cannot be reversed. For this request to succeed, the network ACL +// must not be the default network ACL for any VPCs, and the network ACL must not be attached to any subnets. +func (vpc *VpcV1) DeleteNetworkACL(deleteNetworkACLOptions *DeleteNetworkACLOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteNetworkACLWithContext(context.Background(), deleteNetworkACLOptions) +} + +// DeleteNetworkACLWithContext is an alternate form of the DeleteNetworkACL method which supports a Context parameter +func (vpc *VpcV1) DeleteNetworkACLWithContext(ctx context.Context, deleteNetworkACLOptions *DeleteNetworkACLOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteNetworkACLOptions, "deleteNetworkACLOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteNetworkACLOptions, "deleteNetworkACLOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *deleteNetworkACLOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/network_acls/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteNetworkACLOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteNetworkACL") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetNetworkACL : Retrieve a network ACL +// This request retrieves a single network ACL specified by the identifier in the URL. +func (vpc *VpcV1) GetNetworkACL(getNetworkACLOptions *GetNetworkACLOptions) (result *NetworkACL, response *core.DetailedResponse, err error) { + return vpc.GetNetworkACLWithContext(context.Background(), getNetworkACLOptions) +} + +// GetNetworkACLWithContext is an alternate form of the GetNetworkACL method which supports a Context parameter +func (vpc *VpcV1) GetNetworkACLWithContext(ctx context.Context, getNetworkACLOptions *GetNetworkACLOptions) (result *NetworkACL, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getNetworkACLOptions, "getNetworkACLOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getNetworkACLOptions, "getNetworkACLOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getNetworkACLOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/network_acls/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getNetworkACLOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetNetworkACL") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalNetworkACL) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateNetworkACL : Update a network ACL +// This request updates a network ACL's name. +func (vpc *VpcV1) UpdateNetworkACL(updateNetworkACLOptions *UpdateNetworkACLOptions) (result *NetworkACL, response *core.DetailedResponse, err error) { + return vpc.UpdateNetworkACLWithContext(context.Background(), updateNetworkACLOptions) +} + +// UpdateNetworkACLWithContext is an alternate form of the UpdateNetworkACL method which supports a Context parameter +func (vpc *VpcV1) UpdateNetworkACLWithContext(ctx context.Context, updateNetworkACLOptions *UpdateNetworkACLOptions) (result *NetworkACL, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateNetworkACLOptions, "updateNetworkACLOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateNetworkACLOptions, "updateNetworkACLOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *updateNetworkACLOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/network_acls/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateNetworkACLOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateNetworkACL") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateNetworkACLOptions.NetworkACLPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalNetworkACL) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListNetworkACLRules : List all rules for a network ACL +// This request lists all rules for a network ACL. These rules can allow or deny traffic between a source CIDR block and +// a destination CIDR block over a particular protocol and port range. +func (vpc *VpcV1) ListNetworkACLRules(listNetworkACLRulesOptions *ListNetworkACLRulesOptions) (result *NetworkACLRuleCollection, response *core.DetailedResponse, err error) { + return vpc.ListNetworkACLRulesWithContext(context.Background(), listNetworkACLRulesOptions) +} + +// ListNetworkACLRulesWithContext is an alternate form of the ListNetworkACLRules method which supports a Context parameter +func (vpc *VpcV1) ListNetworkACLRulesWithContext(ctx context.Context, listNetworkACLRulesOptions *ListNetworkACLRulesOptions) (result *NetworkACLRuleCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listNetworkACLRulesOptions, "listNetworkACLRulesOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listNetworkACLRulesOptions, "listNetworkACLRulesOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "network_acl_id": *listNetworkACLRulesOptions.NetworkACLID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/network_acls/{network_acl_id}/rules`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listNetworkACLRulesOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListNetworkACLRules") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listNetworkACLRulesOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listNetworkACLRulesOptions.Start)) + } + if listNetworkACLRulesOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listNetworkACLRulesOptions.Limit)) + } + if listNetworkACLRulesOptions.Direction != nil { + builder.AddQuery("direction", fmt.Sprint(*listNetworkACLRulesOptions.Direction)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalNetworkACLRuleCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateNetworkACLRule : Create a rule for a network ACL +// This request creates a new rule from a network ACL rule prototype object. The prototype object is structured in the +// same way as a retrieved rule, and contains the information necessary to create the new rule. +func (vpc *VpcV1) CreateNetworkACLRule(createNetworkACLRuleOptions *CreateNetworkACLRuleOptions) (result NetworkACLRuleIntf, response *core.DetailedResponse, err error) { + return vpc.CreateNetworkACLRuleWithContext(context.Background(), createNetworkACLRuleOptions) +} + +// CreateNetworkACLRuleWithContext is an alternate form of the CreateNetworkACLRule method which supports a Context parameter +func (vpc *VpcV1) CreateNetworkACLRuleWithContext(ctx context.Context, createNetworkACLRuleOptions *CreateNetworkACLRuleOptions) (result NetworkACLRuleIntf, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createNetworkACLRuleOptions, "createNetworkACLRuleOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createNetworkACLRuleOptions, "createNetworkACLRuleOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "network_acl_id": *createNetworkACLRuleOptions.NetworkACLID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/network_acls/{network_acl_id}/rules`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range createNetworkACLRuleOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateNetworkACLRule") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(createNetworkACLRuleOptions.NetworkACLRulePrototype) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalNetworkACLRule) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteNetworkACLRule : Delete a network ACL rule +// This request deletes a rule. This operation cannot be reversed. +func (vpc *VpcV1) DeleteNetworkACLRule(deleteNetworkACLRuleOptions *DeleteNetworkACLRuleOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteNetworkACLRuleWithContext(context.Background(), deleteNetworkACLRuleOptions) +} + +// DeleteNetworkACLRuleWithContext is an alternate form of the DeleteNetworkACLRule method which supports a Context parameter +func (vpc *VpcV1) DeleteNetworkACLRuleWithContext(ctx context.Context, deleteNetworkACLRuleOptions *DeleteNetworkACLRuleOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteNetworkACLRuleOptions, "deleteNetworkACLRuleOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteNetworkACLRuleOptions, "deleteNetworkACLRuleOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "network_acl_id": *deleteNetworkACLRuleOptions.NetworkACLID, + "id": *deleteNetworkACLRuleOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/network_acls/{network_acl_id}/rules/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteNetworkACLRuleOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteNetworkACLRule") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetNetworkACLRule : Retrieve a network ACL rule +// This request retrieves a single rule specified by the identifier in the URL. +func (vpc *VpcV1) GetNetworkACLRule(getNetworkACLRuleOptions *GetNetworkACLRuleOptions) (result NetworkACLRuleIntf, response *core.DetailedResponse, err error) { + return vpc.GetNetworkACLRuleWithContext(context.Background(), getNetworkACLRuleOptions) +} + +// GetNetworkACLRuleWithContext is an alternate form of the GetNetworkACLRule method which supports a Context parameter +func (vpc *VpcV1) GetNetworkACLRuleWithContext(ctx context.Context, getNetworkACLRuleOptions *GetNetworkACLRuleOptions) (result NetworkACLRuleIntf, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getNetworkACLRuleOptions, "getNetworkACLRuleOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getNetworkACLRuleOptions, "getNetworkACLRuleOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "network_acl_id": *getNetworkACLRuleOptions.NetworkACLID, + "id": *getNetworkACLRuleOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/network_acls/{network_acl_id}/rules/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getNetworkACLRuleOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetNetworkACLRule") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalNetworkACLRule) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateNetworkACLRule : Update a network ACL rule +// This request updates a rule with the information in a provided rule patch. The rule patch object contains only the +// information to be updated. The request will fail if the information is not applicable to the rule's protocol. +func (vpc *VpcV1) UpdateNetworkACLRule(updateNetworkACLRuleOptions *UpdateNetworkACLRuleOptions) (result NetworkACLRuleIntf, response *core.DetailedResponse, err error) { + return vpc.UpdateNetworkACLRuleWithContext(context.Background(), updateNetworkACLRuleOptions) +} + +// UpdateNetworkACLRuleWithContext is an alternate form of the UpdateNetworkACLRule method which supports a Context parameter +func (vpc *VpcV1) UpdateNetworkACLRuleWithContext(ctx context.Context, updateNetworkACLRuleOptions *UpdateNetworkACLRuleOptions) (result NetworkACLRuleIntf, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateNetworkACLRuleOptions, "updateNetworkACLRuleOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateNetworkACLRuleOptions, "updateNetworkACLRuleOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "network_acl_id": *updateNetworkACLRuleOptions.NetworkACLID, + "id": *updateNetworkACLRuleOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/network_acls/{network_acl_id}/rules/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateNetworkACLRuleOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateNetworkACLRule") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateNetworkACLRuleOptions.NetworkACLRulePatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalNetworkACLRule) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListSecurityGroups : List all security groups +// This request lists all security groups in the region. Security groups provide a way to apply IP filtering rules to +// instances in the associated VPC. With security groups, all traffic is denied by default, and rules added to security +// groups define which traffic the security group permits. Security group rules are stateful such that reverse traffic +// in response to allowed traffic is automatically permitted. +func (vpc *VpcV1) ListSecurityGroups(listSecurityGroupsOptions *ListSecurityGroupsOptions) (result *SecurityGroupCollection, response *core.DetailedResponse, err error) { + return vpc.ListSecurityGroupsWithContext(context.Background(), listSecurityGroupsOptions) +} + +// ListSecurityGroupsWithContext is an alternate form of the ListSecurityGroups method which supports a Context parameter +func (vpc *VpcV1) ListSecurityGroupsWithContext(ctx context.Context, listSecurityGroupsOptions *ListSecurityGroupsOptions) (result *SecurityGroupCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listSecurityGroupsOptions, "listSecurityGroupsOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/security_groups`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listSecurityGroupsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListSecurityGroups") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listSecurityGroupsOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listSecurityGroupsOptions.Start)) + } + if listSecurityGroupsOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listSecurityGroupsOptions.Limit)) + } + if listSecurityGroupsOptions.ResourceGroupID != nil { + builder.AddQuery("resource_group.id", fmt.Sprint(*listSecurityGroupsOptions.ResourceGroupID)) + } + if listSecurityGroupsOptions.VPCID != nil { + builder.AddQuery("vpc.id", fmt.Sprint(*listSecurityGroupsOptions.VPCID)) + } + if listSecurityGroupsOptions.VPCCRN != nil { + builder.AddQuery("vpc.crn", fmt.Sprint(*listSecurityGroupsOptions.VPCCRN)) + } + if listSecurityGroupsOptions.VPCName != nil { + builder.AddQuery("vpc.name", fmt.Sprint(*listSecurityGroupsOptions.VPCName)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalSecurityGroupCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateSecurityGroup : Create a security group +// This request creates a new security group from a security group prototype object. The prototype object is structured +// in the same way as a retrieved security group, and contains the information necessary to create the new security +// group. If security group rules are included in the prototype object, those rules will be added to the security group. +// Each security group is scoped to one VPC. Only resources in that VPC can be added to the security group. +func (vpc *VpcV1) CreateSecurityGroup(createSecurityGroupOptions *CreateSecurityGroupOptions) (result *SecurityGroup, response *core.DetailedResponse, err error) { + return vpc.CreateSecurityGroupWithContext(context.Background(), createSecurityGroupOptions) +} + +// CreateSecurityGroupWithContext is an alternate form of the CreateSecurityGroup method which supports a Context parameter +func (vpc *VpcV1) CreateSecurityGroupWithContext(ctx context.Context, createSecurityGroupOptions *CreateSecurityGroupOptions) (result *SecurityGroup, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createSecurityGroupOptions, "createSecurityGroupOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createSecurityGroupOptions, "createSecurityGroupOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/security_groups`, nil) + if err != nil { + return + } + + for headerName, headerValue := range createSecurityGroupOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateSecurityGroup") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createSecurityGroupOptions.VPC != nil { + body["vpc"] = createSecurityGroupOptions.VPC + } + if createSecurityGroupOptions.Name != nil { + body["name"] = createSecurityGroupOptions.Name + } + if createSecurityGroupOptions.ResourceGroup != nil { + body["resource_group"] = createSecurityGroupOptions.ResourceGroup + } + if createSecurityGroupOptions.Rules != nil { + body["rules"] = createSecurityGroupOptions.Rules + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalSecurityGroup) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteSecurityGroup : Delete a security group +// This request deletes a security group. A security group cannot be deleted if it is referenced by any security group +// targets or rules. Additionally, a VPC's default security group cannot be deleted. This operation cannot be reversed. +func (vpc *VpcV1) DeleteSecurityGroup(deleteSecurityGroupOptions *DeleteSecurityGroupOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteSecurityGroupWithContext(context.Background(), deleteSecurityGroupOptions) +} + +// DeleteSecurityGroupWithContext is an alternate form of the DeleteSecurityGroup method which supports a Context parameter +func (vpc *VpcV1) DeleteSecurityGroupWithContext(ctx context.Context, deleteSecurityGroupOptions *DeleteSecurityGroupOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteSecurityGroupOptions, "deleteSecurityGroupOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteSecurityGroupOptions, "deleteSecurityGroupOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *deleteSecurityGroupOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/security_groups/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteSecurityGroupOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteSecurityGroup") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetSecurityGroup : Retrieve a security group +// This request retrieves a single security group specified by the identifier in the URL path. +func (vpc *VpcV1) GetSecurityGroup(getSecurityGroupOptions *GetSecurityGroupOptions) (result *SecurityGroup, response *core.DetailedResponse, err error) { + return vpc.GetSecurityGroupWithContext(context.Background(), getSecurityGroupOptions) +} + +// GetSecurityGroupWithContext is an alternate form of the GetSecurityGroup method which supports a Context parameter +func (vpc *VpcV1) GetSecurityGroupWithContext(ctx context.Context, getSecurityGroupOptions *GetSecurityGroupOptions) (result *SecurityGroup, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getSecurityGroupOptions, "getSecurityGroupOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getSecurityGroupOptions, "getSecurityGroupOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getSecurityGroupOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/security_groups/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getSecurityGroupOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetSecurityGroup") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalSecurityGroup) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateSecurityGroup : Update a security group +// This request updates a security group with the information provided in a security group patch object. The security +// group patch object is structured in the same way as a retrieved security group and contains only the information to +// be updated. +func (vpc *VpcV1) UpdateSecurityGroup(updateSecurityGroupOptions *UpdateSecurityGroupOptions) (result *SecurityGroup, response *core.DetailedResponse, err error) { + return vpc.UpdateSecurityGroupWithContext(context.Background(), updateSecurityGroupOptions) +} + +// UpdateSecurityGroupWithContext is an alternate form of the UpdateSecurityGroup method which supports a Context parameter +func (vpc *VpcV1) UpdateSecurityGroupWithContext(ctx context.Context, updateSecurityGroupOptions *UpdateSecurityGroupOptions) (result *SecurityGroup, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateSecurityGroupOptions, "updateSecurityGroupOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateSecurityGroupOptions, "updateSecurityGroupOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *updateSecurityGroupOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/security_groups/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateSecurityGroupOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateSecurityGroup") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateSecurityGroupOptions.SecurityGroupPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalSecurityGroup) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListSecurityGroupRules : List all rules in a security group +// This request lists all rules in a security group. These rules define what traffic the security group permits. +// Security group rules are stateful, such that reverse traffic in response to allowed traffic is automatically +// permitted. +func (vpc *VpcV1) ListSecurityGroupRules(listSecurityGroupRulesOptions *ListSecurityGroupRulesOptions) (result *SecurityGroupRuleCollection, response *core.DetailedResponse, err error) { + return vpc.ListSecurityGroupRulesWithContext(context.Background(), listSecurityGroupRulesOptions) +} + +// ListSecurityGroupRulesWithContext is an alternate form of the ListSecurityGroupRules method which supports a Context parameter +func (vpc *VpcV1) ListSecurityGroupRulesWithContext(ctx context.Context, listSecurityGroupRulesOptions *ListSecurityGroupRulesOptions) (result *SecurityGroupRuleCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listSecurityGroupRulesOptions, "listSecurityGroupRulesOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listSecurityGroupRulesOptions, "listSecurityGroupRulesOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "security_group_id": *listSecurityGroupRulesOptions.SecurityGroupID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/security_groups/{security_group_id}/rules`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listSecurityGroupRulesOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListSecurityGroupRules") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalSecurityGroupRuleCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateSecurityGroupRule : Create a rule for a security group +// This request creates a new security group rule from a security group rule prototype object. The prototype object is +// structured in the same way as a retrieved security group rule and contains the information necessary to create the +// rule. As part of creating a new rule in a security group, the rule is applied to all the networking interfaces in the +// security group. Rules specify which IP traffic a security group will allow. Security group rules are stateful, such +// that reverse traffic in response to allowed traffic is automatically permitted. A rule allowing inbound TCP traffic +// on port 80 also allows outbound TCP traffic on port 80 without the need for an additional rule. +func (vpc *VpcV1) CreateSecurityGroupRule(createSecurityGroupRuleOptions *CreateSecurityGroupRuleOptions) (result SecurityGroupRuleIntf, response *core.DetailedResponse, err error) { + return vpc.CreateSecurityGroupRuleWithContext(context.Background(), createSecurityGroupRuleOptions) +} + +// CreateSecurityGroupRuleWithContext is an alternate form of the CreateSecurityGroupRule method which supports a Context parameter +func (vpc *VpcV1) CreateSecurityGroupRuleWithContext(ctx context.Context, createSecurityGroupRuleOptions *CreateSecurityGroupRuleOptions) (result SecurityGroupRuleIntf, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createSecurityGroupRuleOptions, "createSecurityGroupRuleOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createSecurityGroupRuleOptions, "createSecurityGroupRuleOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "security_group_id": *createSecurityGroupRuleOptions.SecurityGroupID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/security_groups/{security_group_id}/rules`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range createSecurityGroupRuleOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateSecurityGroupRule") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(createSecurityGroupRuleOptions.SecurityGroupRulePrototype) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalSecurityGroupRule) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteSecurityGroupRule : Delete a security group rule +// This request deletes a security group rule. This operation cannot be reversed. Removing a security group rule will +// not end existing connections allowed by that rule. +func (vpc *VpcV1) DeleteSecurityGroupRule(deleteSecurityGroupRuleOptions *DeleteSecurityGroupRuleOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteSecurityGroupRuleWithContext(context.Background(), deleteSecurityGroupRuleOptions) +} + +// DeleteSecurityGroupRuleWithContext is an alternate form of the DeleteSecurityGroupRule method which supports a Context parameter +func (vpc *VpcV1) DeleteSecurityGroupRuleWithContext(ctx context.Context, deleteSecurityGroupRuleOptions *DeleteSecurityGroupRuleOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteSecurityGroupRuleOptions, "deleteSecurityGroupRuleOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteSecurityGroupRuleOptions, "deleteSecurityGroupRuleOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "security_group_id": *deleteSecurityGroupRuleOptions.SecurityGroupID, + "id": *deleteSecurityGroupRuleOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/security_groups/{security_group_id}/rules/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteSecurityGroupRuleOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteSecurityGroupRule") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetSecurityGroupRule : Retrieve a security group rule +// This request retrieves a single security group rule specified by the identifier in the URL path. +func (vpc *VpcV1) GetSecurityGroupRule(getSecurityGroupRuleOptions *GetSecurityGroupRuleOptions) (result SecurityGroupRuleIntf, response *core.DetailedResponse, err error) { + return vpc.GetSecurityGroupRuleWithContext(context.Background(), getSecurityGroupRuleOptions) +} + +// GetSecurityGroupRuleWithContext is an alternate form of the GetSecurityGroupRule method which supports a Context parameter +func (vpc *VpcV1) GetSecurityGroupRuleWithContext(ctx context.Context, getSecurityGroupRuleOptions *GetSecurityGroupRuleOptions) (result SecurityGroupRuleIntf, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getSecurityGroupRuleOptions, "getSecurityGroupRuleOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getSecurityGroupRuleOptions, "getSecurityGroupRuleOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "security_group_id": *getSecurityGroupRuleOptions.SecurityGroupID, + "id": *getSecurityGroupRuleOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/security_groups/{security_group_id}/rules/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getSecurityGroupRuleOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetSecurityGroupRule") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalSecurityGroupRule) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateSecurityGroupRule : Update a security group rule +// This request updates a security group rule with the information in a provided rule patch object. The rule patch +// object contains only the information to be updated. The request will fail if the information is not applicable to the +// rule's protocol. +func (vpc *VpcV1) UpdateSecurityGroupRule(updateSecurityGroupRuleOptions *UpdateSecurityGroupRuleOptions) (result SecurityGroupRuleIntf, response *core.DetailedResponse, err error) { + return vpc.UpdateSecurityGroupRuleWithContext(context.Background(), updateSecurityGroupRuleOptions) +} + +// UpdateSecurityGroupRuleWithContext is an alternate form of the UpdateSecurityGroupRule method which supports a Context parameter +func (vpc *VpcV1) UpdateSecurityGroupRuleWithContext(ctx context.Context, updateSecurityGroupRuleOptions *UpdateSecurityGroupRuleOptions) (result SecurityGroupRuleIntf, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateSecurityGroupRuleOptions, "updateSecurityGroupRuleOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateSecurityGroupRuleOptions, "updateSecurityGroupRuleOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "security_group_id": *updateSecurityGroupRuleOptions.SecurityGroupID, + "id": *updateSecurityGroupRuleOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/security_groups/{security_group_id}/rules/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateSecurityGroupRuleOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateSecurityGroupRule") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateSecurityGroupRuleOptions.SecurityGroupRulePatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalSecurityGroupRule) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListSecurityGroupTargets : List all targets associated with a security group +// This request lists all targets associated with a security group, to which the rules in the security group are +// applied. +func (vpc *VpcV1) ListSecurityGroupTargets(listSecurityGroupTargetsOptions *ListSecurityGroupTargetsOptions) (result *SecurityGroupTargetCollection, response *core.DetailedResponse, err error) { + return vpc.ListSecurityGroupTargetsWithContext(context.Background(), listSecurityGroupTargetsOptions) +} + +// ListSecurityGroupTargetsWithContext is an alternate form of the ListSecurityGroupTargets method which supports a Context parameter +func (vpc *VpcV1) ListSecurityGroupTargetsWithContext(ctx context.Context, listSecurityGroupTargetsOptions *ListSecurityGroupTargetsOptions) (result *SecurityGroupTargetCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listSecurityGroupTargetsOptions, "listSecurityGroupTargetsOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listSecurityGroupTargetsOptions, "listSecurityGroupTargetsOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "security_group_id": *listSecurityGroupTargetsOptions.SecurityGroupID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/security_groups/{security_group_id}/targets`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listSecurityGroupTargetsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListSecurityGroupTargets") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listSecurityGroupTargetsOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listSecurityGroupTargetsOptions.Start)) + } + if listSecurityGroupTargetsOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listSecurityGroupTargetsOptions.Limit)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalSecurityGroupTargetCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteSecurityGroupTargetBinding : Remove a target from a security group +// This request removes a target from a security group. For this request to succeed, the target must be attached to at +// least one other security group. The specified target identifier can be: +// +// - A bare metal server network interface identifier +// - A virtual network interface identifier +// - A VPN server identifier +// - An application load balancer identifier +// - An endpoint gateway identifier +// - An instance network interface identifier +// +// Security groups are stateful, so any changes to a target's security groups are applied to new connections. Existing +// connections are not affected. +func (vpc *VpcV1) DeleteSecurityGroupTargetBinding(deleteSecurityGroupTargetBindingOptions *DeleteSecurityGroupTargetBindingOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteSecurityGroupTargetBindingWithContext(context.Background(), deleteSecurityGroupTargetBindingOptions) +} + +// DeleteSecurityGroupTargetBindingWithContext is an alternate form of the DeleteSecurityGroupTargetBinding method which supports a Context parameter +func (vpc *VpcV1) DeleteSecurityGroupTargetBindingWithContext(ctx context.Context, deleteSecurityGroupTargetBindingOptions *DeleteSecurityGroupTargetBindingOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteSecurityGroupTargetBindingOptions, "deleteSecurityGroupTargetBindingOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteSecurityGroupTargetBindingOptions, "deleteSecurityGroupTargetBindingOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "security_group_id": *deleteSecurityGroupTargetBindingOptions.SecurityGroupID, + "id": *deleteSecurityGroupTargetBindingOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/security_groups/{security_group_id}/targets/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteSecurityGroupTargetBindingOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteSecurityGroupTargetBinding") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetSecurityGroupTarget : Retrieve a security group target +// This request retrieves a single target specified by the identifier in the URL path. The target must be an existing +// target of the security group. +func (vpc *VpcV1) GetSecurityGroupTarget(getSecurityGroupTargetOptions *GetSecurityGroupTargetOptions) (result SecurityGroupTargetReferenceIntf, response *core.DetailedResponse, err error) { + return vpc.GetSecurityGroupTargetWithContext(context.Background(), getSecurityGroupTargetOptions) +} + +// GetSecurityGroupTargetWithContext is an alternate form of the GetSecurityGroupTarget method which supports a Context parameter +func (vpc *VpcV1) GetSecurityGroupTargetWithContext(ctx context.Context, getSecurityGroupTargetOptions *GetSecurityGroupTargetOptions) (result SecurityGroupTargetReferenceIntf, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getSecurityGroupTargetOptions, "getSecurityGroupTargetOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getSecurityGroupTargetOptions, "getSecurityGroupTargetOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "security_group_id": *getSecurityGroupTargetOptions.SecurityGroupID, + "id": *getSecurityGroupTargetOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/security_groups/{security_group_id}/targets/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getSecurityGroupTargetOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetSecurityGroupTarget") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalSecurityGroupTargetReference) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateSecurityGroupTargetBinding : Add a target to a security group +// This request adds a resource to an existing security group. The specified target identifier can be: +// +// - A bare metal server network interface identifier +// - A virtual network interface identifier +// - A VPN server identifier +// - An application load balancer identifier +// - An endpoint gateway identifier +// - An instance network interface identifier +// +// When a target is added to a security group, the security group rules are applied to the target. A request body is not +// required, and if provided, is ignored. +func (vpc *VpcV1) CreateSecurityGroupTargetBinding(createSecurityGroupTargetBindingOptions *CreateSecurityGroupTargetBindingOptions) (result SecurityGroupTargetReferenceIntf, response *core.DetailedResponse, err error) { + return vpc.CreateSecurityGroupTargetBindingWithContext(context.Background(), createSecurityGroupTargetBindingOptions) +} + +// CreateSecurityGroupTargetBindingWithContext is an alternate form of the CreateSecurityGroupTargetBinding method which supports a Context parameter +func (vpc *VpcV1) CreateSecurityGroupTargetBindingWithContext(ctx context.Context, createSecurityGroupTargetBindingOptions *CreateSecurityGroupTargetBindingOptions) (result SecurityGroupTargetReferenceIntf, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createSecurityGroupTargetBindingOptions, "createSecurityGroupTargetBindingOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createSecurityGroupTargetBindingOptions, "createSecurityGroupTargetBindingOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "security_group_id": *createSecurityGroupTargetBindingOptions.SecurityGroupID, + "id": *createSecurityGroupTargetBindingOptions.ID, + } + + builder := core.NewRequestBuilder(core.PUT) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/security_groups/{security_group_id}/targets/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range createSecurityGroupTargetBindingOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateSecurityGroupTargetBinding") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalSecurityGroupTargetReference) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListIkePolicies : List all IKE policies +// This request lists all IKE policies in the region. +func (vpc *VpcV1) ListIkePolicies(listIkePoliciesOptions *ListIkePoliciesOptions) (result *IkePolicyCollection, response *core.DetailedResponse, err error) { + return vpc.ListIkePoliciesWithContext(context.Background(), listIkePoliciesOptions) +} + +// ListIkePoliciesWithContext is an alternate form of the ListIkePolicies method which supports a Context parameter +func (vpc *VpcV1) ListIkePoliciesWithContext(ctx context.Context, listIkePoliciesOptions *ListIkePoliciesOptions) (result *IkePolicyCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listIkePoliciesOptions, "listIkePoliciesOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/ike_policies`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listIkePoliciesOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListIkePolicies") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listIkePoliciesOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listIkePoliciesOptions.Start)) + } + if listIkePoliciesOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listIkePoliciesOptions.Limit)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalIkePolicyCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateIkePolicy : Create an IKE policy +// This request creates a new IKE policy. +func (vpc *VpcV1) CreateIkePolicy(createIkePolicyOptions *CreateIkePolicyOptions) (result *IkePolicy, response *core.DetailedResponse, err error) { + return vpc.CreateIkePolicyWithContext(context.Background(), createIkePolicyOptions) +} + +// CreateIkePolicyWithContext is an alternate form of the CreateIkePolicy method which supports a Context parameter +func (vpc *VpcV1) CreateIkePolicyWithContext(ctx context.Context, createIkePolicyOptions *CreateIkePolicyOptions) (result *IkePolicy, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createIkePolicyOptions, "createIkePolicyOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createIkePolicyOptions, "createIkePolicyOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/ike_policies`, nil) + if err != nil { + return + } + + for headerName, headerValue := range createIkePolicyOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateIkePolicy") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createIkePolicyOptions.AuthenticationAlgorithm != nil { + body["authentication_algorithm"] = createIkePolicyOptions.AuthenticationAlgorithm + } + if createIkePolicyOptions.DhGroup != nil { + body["dh_group"] = createIkePolicyOptions.DhGroup + } + if createIkePolicyOptions.EncryptionAlgorithm != nil { + body["encryption_algorithm"] = createIkePolicyOptions.EncryptionAlgorithm + } + if createIkePolicyOptions.IkeVersion != nil { + body["ike_version"] = createIkePolicyOptions.IkeVersion + } + if createIkePolicyOptions.KeyLifetime != nil { + body["key_lifetime"] = createIkePolicyOptions.KeyLifetime + } + if createIkePolicyOptions.Name != nil { + body["name"] = createIkePolicyOptions.Name + } + if createIkePolicyOptions.ResourceGroup != nil { + body["resource_group"] = createIkePolicyOptions.ResourceGroup + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalIkePolicy) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteIkePolicy : Delete an IKE policy +// This request deletes an IKE policy. This operation cannot be reversed. For this request to succeed, there must not be +// any VPN gateway connections using this policy. +func (vpc *VpcV1) DeleteIkePolicy(deleteIkePolicyOptions *DeleteIkePolicyOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteIkePolicyWithContext(context.Background(), deleteIkePolicyOptions) +} + +// DeleteIkePolicyWithContext is an alternate form of the DeleteIkePolicy method which supports a Context parameter +func (vpc *VpcV1) DeleteIkePolicyWithContext(ctx context.Context, deleteIkePolicyOptions *DeleteIkePolicyOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteIkePolicyOptions, "deleteIkePolicyOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteIkePolicyOptions, "deleteIkePolicyOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *deleteIkePolicyOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/ike_policies/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteIkePolicyOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteIkePolicy") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetIkePolicy : Retrieve an IKE policy +// This request retrieves a single IKE policy specified by the identifier in the URL. +func (vpc *VpcV1) GetIkePolicy(getIkePolicyOptions *GetIkePolicyOptions) (result *IkePolicy, response *core.DetailedResponse, err error) { + return vpc.GetIkePolicyWithContext(context.Background(), getIkePolicyOptions) +} + +// GetIkePolicyWithContext is an alternate form of the GetIkePolicy method which supports a Context parameter +func (vpc *VpcV1) GetIkePolicyWithContext(ctx context.Context, getIkePolicyOptions *GetIkePolicyOptions) (result *IkePolicy, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getIkePolicyOptions, "getIkePolicyOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getIkePolicyOptions, "getIkePolicyOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getIkePolicyOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/ike_policies/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getIkePolicyOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetIkePolicy") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalIkePolicy) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateIkePolicy : Update an IKE policy +// This request updates the properties of an existing IKE policy. +func (vpc *VpcV1) UpdateIkePolicy(updateIkePolicyOptions *UpdateIkePolicyOptions) (result *IkePolicy, response *core.DetailedResponse, err error) { + return vpc.UpdateIkePolicyWithContext(context.Background(), updateIkePolicyOptions) +} + +// UpdateIkePolicyWithContext is an alternate form of the UpdateIkePolicy method which supports a Context parameter +func (vpc *VpcV1) UpdateIkePolicyWithContext(ctx context.Context, updateIkePolicyOptions *UpdateIkePolicyOptions) (result *IkePolicy, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateIkePolicyOptions, "updateIkePolicyOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateIkePolicyOptions, "updateIkePolicyOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *updateIkePolicyOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/ike_policies/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateIkePolicyOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateIkePolicy") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateIkePolicyOptions.IkePolicyPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalIkePolicy) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListIkePolicyConnections : List all VPN gateway connections that use a specified IKE policy +// This request lists all VPN gateway connections that use a policy. +func (vpc *VpcV1) ListIkePolicyConnections(listIkePolicyConnectionsOptions *ListIkePolicyConnectionsOptions) (result *VPNGatewayConnectionCollection, response *core.DetailedResponse, err error) { + return vpc.ListIkePolicyConnectionsWithContext(context.Background(), listIkePolicyConnectionsOptions) +} + +// ListIkePolicyConnectionsWithContext is an alternate form of the ListIkePolicyConnections method which supports a Context parameter +func (vpc *VpcV1) ListIkePolicyConnectionsWithContext(ctx context.Context, listIkePolicyConnectionsOptions *ListIkePolicyConnectionsOptions) (result *VPNGatewayConnectionCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listIkePolicyConnectionsOptions, "listIkePolicyConnectionsOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listIkePolicyConnectionsOptions, "listIkePolicyConnectionsOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *listIkePolicyConnectionsOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/ike_policies/{id}/connections`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listIkePolicyConnectionsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListIkePolicyConnections") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVPNGatewayConnectionCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListIpsecPolicies : List all IPsec policies +// This request lists all IPsec policies in the region. +func (vpc *VpcV1) ListIpsecPolicies(listIpsecPoliciesOptions *ListIpsecPoliciesOptions) (result *IPsecPolicyCollection, response *core.DetailedResponse, err error) { + return vpc.ListIpsecPoliciesWithContext(context.Background(), listIpsecPoliciesOptions) +} + +// ListIpsecPoliciesWithContext is an alternate form of the ListIpsecPolicies method which supports a Context parameter +func (vpc *VpcV1) ListIpsecPoliciesWithContext(ctx context.Context, listIpsecPoliciesOptions *ListIpsecPoliciesOptions) (result *IPsecPolicyCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listIpsecPoliciesOptions, "listIpsecPoliciesOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/ipsec_policies`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listIpsecPoliciesOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListIpsecPolicies") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listIpsecPoliciesOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listIpsecPoliciesOptions.Start)) + } + if listIpsecPoliciesOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listIpsecPoliciesOptions.Limit)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalIPsecPolicyCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateIpsecPolicy : Create an IPsec policy +// This request creates a new IPsec policy. +func (vpc *VpcV1) CreateIpsecPolicy(createIpsecPolicyOptions *CreateIpsecPolicyOptions) (result *IPsecPolicy, response *core.DetailedResponse, err error) { + return vpc.CreateIpsecPolicyWithContext(context.Background(), createIpsecPolicyOptions) +} + +// CreateIpsecPolicyWithContext is an alternate form of the CreateIpsecPolicy method which supports a Context parameter +func (vpc *VpcV1) CreateIpsecPolicyWithContext(ctx context.Context, createIpsecPolicyOptions *CreateIpsecPolicyOptions) (result *IPsecPolicy, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createIpsecPolicyOptions, "createIpsecPolicyOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createIpsecPolicyOptions, "createIpsecPolicyOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/ipsec_policies`, nil) + if err != nil { + return + } + + for headerName, headerValue := range createIpsecPolicyOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateIpsecPolicy") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createIpsecPolicyOptions.AuthenticationAlgorithm != nil { + body["authentication_algorithm"] = createIpsecPolicyOptions.AuthenticationAlgorithm + } + if createIpsecPolicyOptions.EncryptionAlgorithm != nil { + body["encryption_algorithm"] = createIpsecPolicyOptions.EncryptionAlgorithm + } + if createIpsecPolicyOptions.Pfs != nil { + body["pfs"] = createIpsecPolicyOptions.Pfs + } + if createIpsecPolicyOptions.KeyLifetime != nil { + body["key_lifetime"] = createIpsecPolicyOptions.KeyLifetime + } + if createIpsecPolicyOptions.Name != nil { + body["name"] = createIpsecPolicyOptions.Name + } + if createIpsecPolicyOptions.ResourceGroup != nil { + body["resource_group"] = createIpsecPolicyOptions.ResourceGroup + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalIPsecPolicy) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteIpsecPolicy : Delete an IPsec policy +// This request deletes an IPsec policy. This operation cannot be reversed. For this request to succeed, there must not +// be any VPN gateway connections using this policy. +func (vpc *VpcV1) DeleteIpsecPolicy(deleteIpsecPolicyOptions *DeleteIpsecPolicyOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteIpsecPolicyWithContext(context.Background(), deleteIpsecPolicyOptions) +} + +// DeleteIpsecPolicyWithContext is an alternate form of the DeleteIpsecPolicy method which supports a Context parameter +func (vpc *VpcV1) DeleteIpsecPolicyWithContext(ctx context.Context, deleteIpsecPolicyOptions *DeleteIpsecPolicyOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteIpsecPolicyOptions, "deleteIpsecPolicyOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteIpsecPolicyOptions, "deleteIpsecPolicyOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *deleteIpsecPolicyOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/ipsec_policies/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteIpsecPolicyOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteIpsecPolicy") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetIpsecPolicy : Retrieve an IPsec policy +// This request retrieves a single IPsec policy specified by the identifier in the URL. +func (vpc *VpcV1) GetIpsecPolicy(getIpsecPolicyOptions *GetIpsecPolicyOptions) (result *IPsecPolicy, response *core.DetailedResponse, err error) { + return vpc.GetIpsecPolicyWithContext(context.Background(), getIpsecPolicyOptions) +} + +// GetIpsecPolicyWithContext is an alternate form of the GetIpsecPolicy method which supports a Context parameter +func (vpc *VpcV1) GetIpsecPolicyWithContext(ctx context.Context, getIpsecPolicyOptions *GetIpsecPolicyOptions) (result *IPsecPolicy, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getIpsecPolicyOptions, "getIpsecPolicyOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getIpsecPolicyOptions, "getIpsecPolicyOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getIpsecPolicyOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/ipsec_policies/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getIpsecPolicyOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetIpsecPolicy") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalIPsecPolicy) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateIpsecPolicy : Update an IPsec policy +// This request updates the properties of an existing IPsec policy. +func (vpc *VpcV1) UpdateIpsecPolicy(updateIpsecPolicyOptions *UpdateIpsecPolicyOptions) (result *IPsecPolicy, response *core.DetailedResponse, err error) { + return vpc.UpdateIpsecPolicyWithContext(context.Background(), updateIpsecPolicyOptions) +} + +// UpdateIpsecPolicyWithContext is an alternate form of the UpdateIpsecPolicy method which supports a Context parameter +func (vpc *VpcV1) UpdateIpsecPolicyWithContext(ctx context.Context, updateIpsecPolicyOptions *UpdateIpsecPolicyOptions) (result *IPsecPolicy, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateIpsecPolicyOptions, "updateIpsecPolicyOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateIpsecPolicyOptions, "updateIpsecPolicyOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *updateIpsecPolicyOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/ipsec_policies/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateIpsecPolicyOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateIpsecPolicy") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateIpsecPolicyOptions.IPsecPolicyPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalIPsecPolicy) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListIpsecPolicyConnections : List all VPN gateway connections that use a specified IPsec policy +// This request lists all VPN gateway connections that use a policy. +func (vpc *VpcV1) ListIpsecPolicyConnections(listIpsecPolicyConnectionsOptions *ListIpsecPolicyConnectionsOptions) (result *VPNGatewayConnectionCollection, response *core.DetailedResponse, err error) { + return vpc.ListIpsecPolicyConnectionsWithContext(context.Background(), listIpsecPolicyConnectionsOptions) +} + +// ListIpsecPolicyConnectionsWithContext is an alternate form of the ListIpsecPolicyConnections method which supports a Context parameter +func (vpc *VpcV1) ListIpsecPolicyConnectionsWithContext(ctx context.Context, listIpsecPolicyConnectionsOptions *ListIpsecPolicyConnectionsOptions) (result *VPNGatewayConnectionCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listIpsecPolicyConnectionsOptions, "listIpsecPolicyConnectionsOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listIpsecPolicyConnectionsOptions, "listIpsecPolicyConnectionsOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *listIpsecPolicyConnectionsOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/ipsec_policies/{id}/connections`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listIpsecPolicyConnectionsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListIpsecPolicyConnections") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVPNGatewayConnectionCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListVPNGateways : List all VPN gateways +// This request lists all VPN gateways in the region. +func (vpc *VpcV1) ListVPNGateways(listVPNGatewaysOptions *ListVPNGatewaysOptions) (result *VPNGatewayCollection, response *core.DetailedResponse, err error) { + return vpc.ListVPNGatewaysWithContext(context.Background(), listVPNGatewaysOptions) +} + +// ListVPNGatewaysWithContext is an alternate form of the ListVPNGateways method which supports a Context parameter +func (vpc *VpcV1) ListVPNGatewaysWithContext(ctx context.Context, listVPNGatewaysOptions *ListVPNGatewaysOptions) (result *VPNGatewayCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listVPNGatewaysOptions, "listVPNGatewaysOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_gateways`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listVPNGatewaysOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListVPNGateways") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listVPNGatewaysOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listVPNGatewaysOptions.Start)) + } + if listVPNGatewaysOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listVPNGatewaysOptions.Limit)) + } + if listVPNGatewaysOptions.ResourceGroupID != nil { + builder.AddQuery("resource_group.id", fmt.Sprint(*listVPNGatewaysOptions.ResourceGroupID)) + } + if listVPNGatewaysOptions.Sort != nil { + builder.AddQuery("sort", fmt.Sprint(*listVPNGatewaysOptions.Sort)) + } + if listVPNGatewaysOptions.Mode != nil { + builder.AddQuery("mode", fmt.Sprint(*listVPNGatewaysOptions.Mode)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVPNGatewayCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateVPNGateway : Create a VPN gateway +// This request creates a new VPN gateway. +func (vpc *VpcV1) CreateVPNGateway(createVPNGatewayOptions *CreateVPNGatewayOptions) (result VPNGatewayIntf, response *core.DetailedResponse, err error) { + return vpc.CreateVPNGatewayWithContext(context.Background(), createVPNGatewayOptions) +} + +// CreateVPNGatewayWithContext is an alternate form of the CreateVPNGateway method which supports a Context parameter +func (vpc *VpcV1) CreateVPNGatewayWithContext(ctx context.Context, createVPNGatewayOptions *CreateVPNGatewayOptions) (result VPNGatewayIntf, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createVPNGatewayOptions, "createVPNGatewayOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createVPNGatewayOptions, "createVPNGatewayOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_gateways`, nil) + if err != nil { + return + } + + for headerName, headerValue := range createVPNGatewayOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateVPNGateway") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(createVPNGatewayOptions.VPNGatewayPrototype) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVPNGateway) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteVPNGateway : Delete a VPN gateway +// This request deletes a VPN gateway. This operation cannot be reversed. For this request to succeed, the VPN gateway +// must not have a `status` of `pending`, and there must not be any VPC routes using the VPN gateway's connections as a +// next hop. +func (vpc *VpcV1) DeleteVPNGateway(deleteVPNGatewayOptions *DeleteVPNGatewayOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteVPNGatewayWithContext(context.Background(), deleteVPNGatewayOptions) +} + +// DeleteVPNGatewayWithContext is an alternate form of the DeleteVPNGateway method which supports a Context parameter +func (vpc *VpcV1) DeleteVPNGatewayWithContext(ctx context.Context, deleteVPNGatewayOptions *DeleteVPNGatewayOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteVPNGatewayOptions, "deleteVPNGatewayOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteVPNGatewayOptions, "deleteVPNGatewayOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *deleteVPNGatewayOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_gateways/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteVPNGatewayOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteVPNGateway") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetVPNGateway : Retrieve a VPN gateway +// This request retrieves a single VPN gateway specified by the identifier in the URL. +func (vpc *VpcV1) GetVPNGateway(getVPNGatewayOptions *GetVPNGatewayOptions) (result VPNGatewayIntf, response *core.DetailedResponse, err error) { + return vpc.GetVPNGatewayWithContext(context.Background(), getVPNGatewayOptions) +} + +// GetVPNGatewayWithContext is an alternate form of the GetVPNGateway method which supports a Context parameter +func (vpc *VpcV1) GetVPNGatewayWithContext(ctx context.Context, getVPNGatewayOptions *GetVPNGatewayOptions) (result VPNGatewayIntf, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getVPNGatewayOptions, "getVPNGatewayOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getVPNGatewayOptions, "getVPNGatewayOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getVPNGatewayOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_gateways/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getVPNGatewayOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetVPNGateway") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVPNGateway) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateVPNGateway : Update a VPN gateway +// This request updates the properties of an existing VPN gateway. +func (vpc *VpcV1) UpdateVPNGateway(updateVPNGatewayOptions *UpdateVPNGatewayOptions) (result VPNGatewayIntf, response *core.DetailedResponse, err error) { + return vpc.UpdateVPNGatewayWithContext(context.Background(), updateVPNGatewayOptions) +} + +// UpdateVPNGatewayWithContext is an alternate form of the UpdateVPNGateway method which supports a Context parameter +func (vpc *VpcV1) UpdateVPNGatewayWithContext(ctx context.Context, updateVPNGatewayOptions *UpdateVPNGatewayOptions) (result VPNGatewayIntf, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateVPNGatewayOptions, "updateVPNGatewayOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateVPNGatewayOptions, "updateVPNGatewayOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *updateVPNGatewayOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_gateways/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateVPNGatewayOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateVPNGateway") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateVPNGatewayOptions.VPNGatewayPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVPNGateway) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListVPNGatewayConnections : List all connections of a VPN gateway +// This request lists all connections of a VPN gateway. +func (vpc *VpcV1) ListVPNGatewayConnections(listVPNGatewayConnectionsOptions *ListVPNGatewayConnectionsOptions) (result *VPNGatewayConnectionCollection, response *core.DetailedResponse, err error) { + return vpc.ListVPNGatewayConnectionsWithContext(context.Background(), listVPNGatewayConnectionsOptions) +} + +// ListVPNGatewayConnectionsWithContext is an alternate form of the ListVPNGatewayConnections method which supports a Context parameter +func (vpc *VpcV1) ListVPNGatewayConnectionsWithContext(ctx context.Context, listVPNGatewayConnectionsOptions *ListVPNGatewayConnectionsOptions) (result *VPNGatewayConnectionCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listVPNGatewayConnectionsOptions, "listVPNGatewayConnectionsOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listVPNGatewayConnectionsOptions, "listVPNGatewayConnectionsOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpn_gateway_id": *listVPNGatewayConnectionsOptions.VPNGatewayID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_gateways/{vpn_gateway_id}/connections`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listVPNGatewayConnectionsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListVPNGatewayConnections") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listVPNGatewayConnectionsOptions.Status != nil { + builder.AddQuery("status", fmt.Sprint(*listVPNGatewayConnectionsOptions.Status)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVPNGatewayConnectionCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateVPNGatewayConnection : Create a connection for a VPN gateway +// This request creates a new VPN gateway connection. +func (vpc *VpcV1) CreateVPNGatewayConnection(createVPNGatewayConnectionOptions *CreateVPNGatewayConnectionOptions) (result VPNGatewayConnectionIntf, response *core.DetailedResponse, err error) { + return vpc.CreateVPNGatewayConnectionWithContext(context.Background(), createVPNGatewayConnectionOptions) +} + +// CreateVPNGatewayConnectionWithContext is an alternate form of the CreateVPNGatewayConnection method which supports a Context parameter +func (vpc *VpcV1) CreateVPNGatewayConnectionWithContext(ctx context.Context, createVPNGatewayConnectionOptions *CreateVPNGatewayConnectionOptions) (result VPNGatewayConnectionIntf, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createVPNGatewayConnectionOptions, "createVPNGatewayConnectionOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createVPNGatewayConnectionOptions, "createVPNGatewayConnectionOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpn_gateway_id": *createVPNGatewayConnectionOptions.VPNGatewayID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_gateways/{vpn_gateway_id}/connections`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range createVPNGatewayConnectionOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateVPNGatewayConnection") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(createVPNGatewayConnectionOptions.VPNGatewayConnectionPrototype) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVPNGatewayConnection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteVPNGatewayConnection : Delete a VPN gateway connection +// This request deletes a VPN gateway connection. This operation cannot be reversed. For this request to succeed, there +// must not be VPC routes using this VPN connection as a next hop. +func (vpc *VpcV1) DeleteVPNGatewayConnection(deleteVPNGatewayConnectionOptions *DeleteVPNGatewayConnectionOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteVPNGatewayConnectionWithContext(context.Background(), deleteVPNGatewayConnectionOptions) +} + +// DeleteVPNGatewayConnectionWithContext is an alternate form of the DeleteVPNGatewayConnection method which supports a Context parameter +func (vpc *VpcV1) DeleteVPNGatewayConnectionWithContext(ctx context.Context, deleteVPNGatewayConnectionOptions *DeleteVPNGatewayConnectionOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteVPNGatewayConnectionOptions, "deleteVPNGatewayConnectionOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteVPNGatewayConnectionOptions, "deleteVPNGatewayConnectionOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpn_gateway_id": *deleteVPNGatewayConnectionOptions.VPNGatewayID, + "id": *deleteVPNGatewayConnectionOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_gateways/{vpn_gateway_id}/connections/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteVPNGatewayConnectionOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteVPNGatewayConnection") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetVPNGatewayConnection : Retrieve a VPN gateway connection +// This request retrieves a single VPN gateway connection specified by the identifier in the URL. +func (vpc *VpcV1) GetVPNGatewayConnection(getVPNGatewayConnectionOptions *GetVPNGatewayConnectionOptions) (result VPNGatewayConnectionIntf, response *core.DetailedResponse, err error) { + return vpc.GetVPNGatewayConnectionWithContext(context.Background(), getVPNGatewayConnectionOptions) +} + +// GetVPNGatewayConnectionWithContext is an alternate form of the GetVPNGatewayConnection method which supports a Context parameter +func (vpc *VpcV1) GetVPNGatewayConnectionWithContext(ctx context.Context, getVPNGatewayConnectionOptions *GetVPNGatewayConnectionOptions) (result VPNGatewayConnectionIntf, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getVPNGatewayConnectionOptions, "getVPNGatewayConnectionOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getVPNGatewayConnectionOptions, "getVPNGatewayConnectionOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpn_gateway_id": *getVPNGatewayConnectionOptions.VPNGatewayID, + "id": *getVPNGatewayConnectionOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_gateways/{vpn_gateway_id}/connections/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getVPNGatewayConnectionOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetVPNGatewayConnection") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVPNGatewayConnection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateVPNGatewayConnection : Update a VPN gateway connection +// This request updates the properties of an existing VPN gateway connection. +func (vpc *VpcV1) UpdateVPNGatewayConnection(updateVPNGatewayConnectionOptions *UpdateVPNGatewayConnectionOptions) (result VPNGatewayConnectionIntf, response *core.DetailedResponse, err error) { + return vpc.UpdateVPNGatewayConnectionWithContext(context.Background(), updateVPNGatewayConnectionOptions) +} + +// UpdateVPNGatewayConnectionWithContext is an alternate form of the UpdateVPNGatewayConnection method which supports a Context parameter +func (vpc *VpcV1) UpdateVPNGatewayConnectionWithContext(ctx context.Context, updateVPNGatewayConnectionOptions *UpdateVPNGatewayConnectionOptions) (result VPNGatewayConnectionIntf, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateVPNGatewayConnectionOptions, "updateVPNGatewayConnectionOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateVPNGatewayConnectionOptions, "updateVPNGatewayConnectionOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpn_gateway_id": *updateVPNGatewayConnectionOptions.VPNGatewayID, + "id": *updateVPNGatewayConnectionOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_gateways/{vpn_gateway_id}/connections/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateVPNGatewayConnectionOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateVPNGatewayConnection") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateVPNGatewayConnectionOptions.VPNGatewayConnectionPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVPNGatewayConnection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListVPNGatewayConnectionLocalCIDRs : List all local CIDRs for a VPN gateway connection +// This request lists all local CIDRs for a VPN gateway connection. +// +// This request is only supported for policy mode VPN gateways. +func (vpc *VpcV1) ListVPNGatewayConnectionLocalCIDRs(listVPNGatewayConnectionLocalCIDRsOptions *ListVPNGatewayConnectionLocalCIDRsOptions) (result *VPNGatewayConnectionLocalCIDRs, response *core.DetailedResponse, err error) { + return vpc.ListVPNGatewayConnectionLocalCIDRsWithContext(context.Background(), listVPNGatewayConnectionLocalCIDRsOptions) +} + +// ListVPNGatewayConnectionLocalCIDRsWithContext is an alternate form of the ListVPNGatewayConnectionLocalCIDRs method which supports a Context parameter +func (vpc *VpcV1) ListVPNGatewayConnectionLocalCIDRsWithContext(ctx context.Context, listVPNGatewayConnectionLocalCIDRsOptions *ListVPNGatewayConnectionLocalCIDRsOptions) (result *VPNGatewayConnectionLocalCIDRs, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listVPNGatewayConnectionLocalCIDRsOptions, "listVPNGatewayConnectionLocalCIDRsOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listVPNGatewayConnectionLocalCIDRsOptions, "listVPNGatewayConnectionLocalCIDRsOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpn_gateway_id": *listVPNGatewayConnectionLocalCIDRsOptions.VPNGatewayID, + "id": *listVPNGatewayConnectionLocalCIDRsOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_gateways/{vpn_gateway_id}/connections/{id}/local_cidrs`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listVPNGatewayConnectionLocalCIDRsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListVPNGatewayConnectionLocalCIDRs") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVPNGatewayConnectionLocalCIDRs) + if err != nil { + return + } + response.Result = result + } + + return +} + +// RemoveVPNGatewayConnectionLocalCIDR : Remove a local CIDR from a VPN gateway connection +// This request removes a CIDR from a VPN gateway connection. +// +// This request is only supported for policy mode VPN gateways. +func (vpc *VpcV1) RemoveVPNGatewayConnectionLocalCIDR(removeVPNGatewayConnectionLocalCIDROptions *RemoveVPNGatewayConnectionLocalCIDROptions) (response *core.DetailedResponse, err error) { + return vpc.RemoveVPNGatewayConnectionLocalCIDRWithContext(context.Background(), removeVPNGatewayConnectionLocalCIDROptions) +} + +// RemoveVPNGatewayConnectionLocalCIDRWithContext is an alternate form of the RemoveVPNGatewayConnectionLocalCIDR method which supports a Context parameter +func (vpc *VpcV1) RemoveVPNGatewayConnectionLocalCIDRWithContext(ctx context.Context, removeVPNGatewayConnectionLocalCIDROptions *RemoveVPNGatewayConnectionLocalCIDROptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(removeVPNGatewayConnectionLocalCIDROptions, "removeVPNGatewayConnectionLocalCIDROptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(removeVPNGatewayConnectionLocalCIDROptions, "removeVPNGatewayConnectionLocalCIDROptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpn_gateway_id": *removeVPNGatewayConnectionLocalCIDROptions.VPNGatewayID, + "id": *removeVPNGatewayConnectionLocalCIDROptions.ID, + "cidr_prefix": *removeVPNGatewayConnectionLocalCIDROptions.CIDRPrefix, + "prefix_length": *removeVPNGatewayConnectionLocalCIDROptions.PrefixLength, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_gateways/{vpn_gateway_id}/connections/{id}/local_cidrs/{cidr_prefix}/{prefix_length}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range removeVPNGatewayConnectionLocalCIDROptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "RemoveVPNGatewayConnectionLocalCIDR") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// CheckVPNGatewayConnectionLocalCIDR : Check if the specified local CIDR exists on a VPN gateway connection +// This request succeeds if a CIDR exists on the specified VPN gateway connection, and fails otherwise. +// +// This request is only supported for policy mode VPN gateways. +func (vpc *VpcV1) CheckVPNGatewayConnectionLocalCIDR(checkVPNGatewayConnectionLocalCIDROptions *CheckVPNGatewayConnectionLocalCIDROptions) (response *core.DetailedResponse, err error) { + return vpc.CheckVPNGatewayConnectionLocalCIDRWithContext(context.Background(), checkVPNGatewayConnectionLocalCIDROptions) +} + +// CheckVPNGatewayConnectionLocalCIDRWithContext is an alternate form of the CheckVPNGatewayConnectionLocalCIDR method which supports a Context parameter +func (vpc *VpcV1) CheckVPNGatewayConnectionLocalCIDRWithContext(ctx context.Context, checkVPNGatewayConnectionLocalCIDROptions *CheckVPNGatewayConnectionLocalCIDROptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(checkVPNGatewayConnectionLocalCIDROptions, "checkVPNGatewayConnectionLocalCIDROptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(checkVPNGatewayConnectionLocalCIDROptions, "checkVPNGatewayConnectionLocalCIDROptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpn_gateway_id": *checkVPNGatewayConnectionLocalCIDROptions.VPNGatewayID, + "id": *checkVPNGatewayConnectionLocalCIDROptions.ID, + "cidr_prefix": *checkVPNGatewayConnectionLocalCIDROptions.CIDRPrefix, + "prefix_length": *checkVPNGatewayConnectionLocalCIDROptions.PrefixLength, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_gateways/{vpn_gateway_id}/connections/{id}/local_cidrs/{cidr_prefix}/{prefix_length}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range checkVPNGatewayConnectionLocalCIDROptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CheckVPNGatewayConnectionLocalCIDR") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// AddVPNGatewayConnectionLocalCIDR : Set a local CIDR on a VPN gateway connection +// This request adds the specified CIDR to the specified VPN gateway connection. This request succeeds if the specified +// CIDR already exists. A request body is not required, and if provided, is ignored. +// +// This request is only supported for policy mode VPN gateways. +func (vpc *VpcV1) AddVPNGatewayConnectionLocalCIDR(addVPNGatewayConnectionLocalCIDROptions *AddVPNGatewayConnectionLocalCIDROptions) (response *core.DetailedResponse, err error) { + return vpc.AddVPNGatewayConnectionLocalCIDRWithContext(context.Background(), addVPNGatewayConnectionLocalCIDROptions) +} + +// AddVPNGatewayConnectionLocalCIDRWithContext is an alternate form of the AddVPNGatewayConnectionLocalCIDR method which supports a Context parameter +func (vpc *VpcV1) AddVPNGatewayConnectionLocalCIDRWithContext(ctx context.Context, addVPNGatewayConnectionLocalCIDROptions *AddVPNGatewayConnectionLocalCIDROptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(addVPNGatewayConnectionLocalCIDROptions, "addVPNGatewayConnectionLocalCIDROptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(addVPNGatewayConnectionLocalCIDROptions, "addVPNGatewayConnectionLocalCIDROptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpn_gateway_id": *addVPNGatewayConnectionLocalCIDROptions.VPNGatewayID, + "id": *addVPNGatewayConnectionLocalCIDROptions.ID, + "cidr_prefix": *addVPNGatewayConnectionLocalCIDROptions.CIDRPrefix, + "prefix_length": *addVPNGatewayConnectionLocalCIDROptions.PrefixLength, + } + + builder := core.NewRequestBuilder(core.PUT) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_gateways/{vpn_gateway_id}/connections/{id}/local_cidrs/{cidr_prefix}/{prefix_length}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range addVPNGatewayConnectionLocalCIDROptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "AddVPNGatewayConnectionLocalCIDR") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// ListVPNGatewayConnectionPeerCIDRs : List all peer CIDRs for a VPN gateway connection +// This request lists all peer CIDRs for a VPN gateway connection. +// +// This request is only supported for policy mode VPN gateways. +func (vpc *VpcV1) ListVPNGatewayConnectionPeerCIDRs(listVPNGatewayConnectionPeerCIDRsOptions *ListVPNGatewayConnectionPeerCIDRsOptions) (result *VPNGatewayConnectionPeerCIDRs, response *core.DetailedResponse, err error) { + return vpc.ListVPNGatewayConnectionPeerCIDRsWithContext(context.Background(), listVPNGatewayConnectionPeerCIDRsOptions) +} + +// ListVPNGatewayConnectionPeerCIDRsWithContext is an alternate form of the ListVPNGatewayConnectionPeerCIDRs method which supports a Context parameter +func (vpc *VpcV1) ListVPNGatewayConnectionPeerCIDRsWithContext(ctx context.Context, listVPNGatewayConnectionPeerCIDRsOptions *ListVPNGatewayConnectionPeerCIDRsOptions) (result *VPNGatewayConnectionPeerCIDRs, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listVPNGatewayConnectionPeerCIDRsOptions, "listVPNGatewayConnectionPeerCIDRsOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listVPNGatewayConnectionPeerCIDRsOptions, "listVPNGatewayConnectionPeerCIDRsOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpn_gateway_id": *listVPNGatewayConnectionPeerCIDRsOptions.VPNGatewayID, + "id": *listVPNGatewayConnectionPeerCIDRsOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_gateways/{vpn_gateway_id}/connections/{id}/peer_cidrs`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listVPNGatewayConnectionPeerCIDRsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListVPNGatewayConnectionPeerCIDRs") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVPNGatewayConnectionPeerCIDRs) + if err != nil { + return + } + response.Result = result + } + + return +} + +// RemoveVPNGatewayConnectionPeerCIDR : Remove a peer CIDR from a VPN gateway connection +// This request removes a CIDR from a VPN gateway connection. +// +// This request is only supported for policy mode VPN gateways. +func (vpc *VpcV1) RemoveVPNGatewayConnectionPeerCIDR(removeVPNGatewayConnectionPeerCIDROptions *RemoveVPNGatewayConnectionPeerCIDROptions) (response *core.DetailedResponse, err error) { + return vpc.RemoveVPNGatewayConnectionPeerCIDRWithContext(context.Background(), removeVPNGatewayConnectionPeerCIDROptions) +} + +// RemoveVPNGatewayConnectionPeerCIDRWithContext is an alternate form of the RemoveVPNGatewayConnectionPeerCIDR method which supports a Context parameter +func (vpc *VpcV1) RemoveVPNGatewayConnectionPeerCIDRWithContext(ctx context.Context, removeVPNGatewayConnectionPeerCIDROptions *RemoveVPNGatewayConnectionPeerCIDROptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(removeVPNGatewayConnectionPeerCIDROptions, "removeVPNGatewayConnectionPeerCIDROptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(removeVPNGatewayConnectionPeerCIDROptions, "removeVPNGatewayConnectionPeerCIDROptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpn_gateway_id": *removeVPNGatewayConnectionPeerCIDROptions.VPNGatewayID, + "id": *removeVPNGatewayConnectionPeerCIDROptions.ID, + "cidr_prefix": *removeVPNGatewayConnectionPeerCIDROptions.CIDRPrefix, + "prefix_length": *removeVPNGatewayConnectionPeerCIDROptions.PrefixLength, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_gateways/{vpn_gateway_id}/connections/{id}/peer_cidrs/{cidr_prefix}/{prefix_length}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range removeVPNGatewayConnectionPeerCIDROptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "RemoveVPNGatewayConnectionPeerCIDR") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// CheckVPNGatewayConnectionPeerCIDR : Check if the specified peer CIDR exists on a VPN gateway connection +// This request succeeds if a CIDR exists on the specified VPN gateway connection, and fails otherwise. +// +// This request is only supported for policy mode VPN gateways. +func (vpc *VpcV1) CheckVPNGatewayConnectionPeerCIDR(checkVPNGatewayConnectionPeerCIDROptions *CheckVPNGatewayConnectionPeerCIDROptions) (response *core.DetailedResponse, err error) { + return vpc.CheckVPNGatewayConnectionPeerCIDRWithContext(context.Background(), checkVPNGatewayConnectionPeerCIDROptions) +} + +// CheckVPNGatewayConnectionPeerCIDRWithContext is an alternate form of the CheckVPNGatewayConnectionPeerCIDR method which supports a Context parameter +func (vpc *VpcV1) CheckVPNGatewayConnectionPeerCIDRWithContext(ctx context.Context, checkVPNGatewayConnectionPeerCIDROptions *CheckVPNGatewayConnectionPeerCIDROptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(checkVPNGatewayConnectionPeerCIDROptions, "checkVPNGatewayConnectionPeerCIDROptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(checkVPNGatewayConnectionPeerCIDROptions, "checkVPNGatewayConnectionPeerCIDROptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpn_gateway_id": *checkVPNGatewayConnectionPeerCIDROptions.VPNGatewayID, + "id": *checkVPNGatewayConnectionPeerCIDROptions.ID, + "cidr_prefix": *checkVPNGatewayConnectionPeerCIDROptions.CIDRPrefix, + "prefix_length": *checkVPNGatewayConnectionPeerCIDROptions.PrefixLength, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_gateways/{vpn_gateway_id}/connections/{id}/peer_cidrs/{cidr_prefix}/{prefix_length}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range checkVPNGatewayConnectionPeerCIDROptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CheckVPNGatewayConnectionPeerCIDR") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// AddVPNGatewayConnectionPeerCIDR : Set a peer CIDR on a VPN gateway connection +// This request adds the specified CIDR to the specified VPN gateway connection. This request succeeds if the specified +// CIDR already exists. A request body is not required, and if provided, is ignored. +// +// This request is only supported for policy mode VPN gateways. +func (vpc *VpcV1) AddVPNGatewayConnectionPeerCIDR(addVPNGatewayConnectionPeerCIDROptions *AddVPNGatewayConnectionPeerCIDROptions) (response *core.DetailedResponse, err error) { + return vpc.AddVPNGatewayConnectionPeerCIDRWithContext(context.Background(), addVPNGatewayConnectionPeerCIDROptions) +} + +// AddVPNGatewayConnectionPeerCIDRWithContext is an alternate form of the AddVPNGatewayConnectionPeerCIDR method which supports a Context parameter +func (vpc *VpcV1) AddVPNGatewayConnectionPeerCIDRWithContext(ctx context.Context, addVPNGatewayConnectionPeerCIDROptions *AddVPNGatewayConnectionPeerCIDROptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(addVPNGatewayConnectionPeerCIDROptions, "addVPNGatewayConnectionPeerCIDROptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(addVPNGatewayConnectionPeerCIDROptions, "addVPNGatewayConnectionPeerCIDROptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpn_gateway_id": *addVPNGatewayConnectionPeerCIDROptions.VPNGatewayID, + "id": *addVPNGatewayConnectionPeerCIDROptions.ID, + "cidr_prefix": *addVPNGatewayConnectionPeerCIDROptions.CIDRPrefix, + "prefix_length": *addVPNGatewayConnectionPeerCIDROptions.PrefixLength, + } + + builder := core.NewRequestBuilder(core.PUT) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_gateways/{vpn_gateway_id}/connections/{id}/peer_cidrs/{cidr_prefix}/{prefix_length}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range addVPNGatewayConnectionPeerCIDROptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "AddVPNGatewayConnectionPeerCIDR") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// ListVPNServers : List all VPN servers +// This request lists all VPN servers. +func (vpc *VpcV1) ListVPNServers(listVPNServersOptions *ListVPNServersOptions) (result *VPNServerCollection, response *core.DetailedResponse, err error) { + return vpc.ListVPNServersWithContext(context.Background(), listVPNServersOptions) +} + +// ListVPNServersWithContext is an alternate form of the ListVPNServers method which supports a Context parameter +func (vpc *VpcV1) ListVPNServersWithContext(ctx context.Context, listVPNServersOptions *ListVPNServersOptions) (result *VPNServerCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listVPNServersOptions, "listVPNServersOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_servers`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listVPNServersOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListVPNServers") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listVPNServersOptions.Name != nil { + builder.AddQuery("name", fmt.Sprint(*listVPNServersOptions.Name)) + } + if listVPNServersOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listVPNServersOptions.Start)) + } + if listVPNServersOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listVPNServersOptions.Limit)) + } + if listVPNServersOptions.ResourceGroupID != nil { + builder.AddQuery("resource_group.id", fmt.Sprint(*listVPNServersOptions.ResourceGroupID)) + } + if listVPNServersOptions.Sort != nil { + builder.AddQuery("sort", fmt.Sprint(*listVPNServersOptions.Sort)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVPNServerCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateVPNServer : Create a VPN server +// This request creates a new VPN server. +func (vpc *VpcV1) CreateVPNServer(createVPNServerOptions *CreateVPNServerOptions) (result *VPNServer, response *core.DetailedResponse, err error) { + return vpc.CreateVPNServerWithContext(context.Background(), createVPNServerOptions) +} + +// CreateVPNServerWithContext is an alternate form of the CreateVPNServer method which supports a Context parameter +func (vpc *VpcV1) CreateVPNServerWithContext(ctx context.Context, createVPNServerOptions *CreateVPNServerOptions) (result *VPNServer, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createVPNServerOptions, "createVPNServerOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createVPNServerOptions, "createVPNServerOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_servers`, nil) + if err != nil { + return + } + + for headerName, headerValue := range createVPNServerOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateVPNServer") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createVPNServerOptions.Certificate != nil { + body["certificate"] = createVPNServerOptions.Certificate + } + if createVPNServerOptions.ClientAuthentication != nil { + body["client_authentication"] = createVPNServerOptions.ClientAuthentication + } + if createVPNServerOptions.ClientIPPool != nil { + body["client_ip_pool"] = createVPNServerOptions.ClientIPPool + } + if createVPNServerOptions.Subnets != nil { + body["subnets"] = createVPNServerOptions.Subnets + } + if createVPNServerOptions.ClientDnsServerIps != nil { + body["client_dns_server_ips"] = createVPNServerOptions.ClientDnsServerIps + } + if createVPNServerOptions.ClientIdleTimeout != nil { + body["client_idle_timeout"] = createVPNServerOptions.ClientIdleTimeout + } + if createVPNServerOptions.EnableSplitTunneling != nil { + body["enable_split_tunneling"] = createVPNServerOptions.EnableSplitTunneling + } + if createVPNServerOptions.Name != nil { + body["name"] = createVPNServerOptions.Name + } + if createVPNServerOptions.Port != nil { + body["port"] = createVPNServerOptions.Port + } + if createVPNServerOptions.Protocol != nil { + body["protocol"] = createVPNServerOptions.Protocol + } + if createVPNServerOptions.ResourceGroup != nil { + body["resource_group"] = createVPNServerOptions.ResourceGroup + } + if createVPNServerOptions.SecurityGroups != nil { + body["security_groups"] = createVPNServerOptions.SecurityGroups + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVPNServer) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteVPNServer : Delete a VPN server +// This request deletes a VPN server. This operation cannot be reversed. +func (vpc *VpcV1) DeleteVPNServer(deleteVPNServerOptions *DeleteVPNServerOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteVPNServerWithContext(context.Background(), deleteVPNServerOptions) +} + +// DeleteVPNServerWithContext is an alternate form of the DeleteVPNServer method which supports a Context parameter +func (vpc *VpcV1) DeleteVPNServerWithContext(ctx context.Context, deleteVPNServerOptions *DeleteVPNServerOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteVPNServerOptions, "deleteVPNServerOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteVPNServerOptions, "deleteVPNServerOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *deleteVPNServerOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_servers/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteVPNServerOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteVPNServer") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + if deleteVPNServerOptions.IfMatch != nil { + builder.AddHeader("If-Match", fmt.Sprint(*deleteVPNServerOptions.IfMatch)) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetVPNServer : Retrieve a VPN server +// This request retrieves a single VPN server specified by the identifier in the URL. +func (vpc *VpcV1) GetVPNServer(getVPNServerOptions *GetVPNServerOptions) (result *VPNServer, response *core.DetailedResponse, err error) { + return vpc.GetVPNServerWithContext(context.Background(), getVPNServerOptions) +} + +// GetVPNServerWithContext is an alternate form of the GetVPNServer method which supports a Context parameter +func (vpc *VpcV1) GetVPNServerWithContext(ctx context.Context, getVPNServerOptions *GetVPNServerOptions) (result *VPNServer, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getVPNServerOptions, "getVPNServerOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getVPNServerOptions, "getVPNServerOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getVPNServerOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_servers/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getVPNServerOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetVPNServer") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVPNServer) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateVPNServer : Update a VPN server +// This request updates the properties of an existing VPN server. Any property changes will cause all connected VPN +// clients are disconnected from this VPN server except for the name change. +func (vpc *VpcV1) UpdateVPNServer(updateVPNServerOptions *UpdateVPNServerOptions) (result *VPNServer, response *core.DetailedResponse, err error) { + return vpc.UpdateVPNServerWithContext(context.Background(), updateVPNServerOptions) +} + +// UpdateVPNServerWithContext is an alternate form of the UpdateVPNServer method which supports a Context parameter +func (vpc *VpcV1) UpdateVPNServerWithContext(ctx context.Context, updateVPNServerOptions *UpdateVPNServerOptions) (result *VPNServer, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateVPNServerOptions, "updateVPNServerOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateVPNServerOptions, "updateVPNServerOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *updateVPNServerOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_servers/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateVPNServerOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateVPNServer") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + if updateVPNServerOptions.IfMatch != nil { + builder.AddHeader("If-Match", fmt.Sprint(*updateVPNServerOptions.IfMatch)) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateVPNServerOptions.VPNServerPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVPNServer) + if err != nil { + return + } + response.Result = result + } + + return +} + +// GetVPNServerClientConfiguration : Retrieve client configuration +// This request retrieves OpenVPN client configuration on a single VPN server specified by the identifier in the URL. +// This configuration includes directives compatible with OpenVPN releases 2.4 and 2.5. +func (vpc *VpcV1) GetVPNServerClientConfiguration(getVPNServerClientConfigurationOptions *GetVPNServerClientConfigurationOptions) (result *string, response *core.DetailedResponse, err error) { + return vpc.GetVPNServerClientConfigurationWithContext(context.Background(), getVPNServerClientConfigurationOptions) +} + +// GetVPNServerClientConfigurationWithContext is an alternate form of the GetVPNServerClientConfiguration method which supports a Context parameter +func (vpc *VpcV1) GetVPNServerClientConfigurationWithContext(ctx context.Context, getVPNServerClientConfigurationOptions *GetVPNServerClientConfigurationOptions) (result *string, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getVPNServerClientConfigurationOptions, "getVPNServerClientConfigurationOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getVPNServerClientConfigurationOptions, "getVPNServerClientConfigurationOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getVPNServerClientConfigurationOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_servers/{id}/client_configuration`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getVPNServerClientConfigurationOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetVPNServerClientConfiguration") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "text/plain") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, &result) + + return +} + +// ListVPNServerClients : List all VPN clients for a VPN server +// This request retrieves all connected VPN clients, and any disconnected VPN clients that the VPN server has not yet +// deleted based on its auto-deletion policy. +func (vpc *VpcV1) ListVPNServerClients(listVPNServerClientsOptions *ListVPNServerClientsOptions) (result *VPNServerClientCollection, response *core.DetailedResponse, err error) { + return vpc.ListVPNServerClientsWithContext(context.Background(), listVPNServerClientsOptions) +} + +// ListVPNServerClientsWithContext is an alternate form of the ListVPNServerClients method which supports a Context parameter +func (vpc *VpcV1) ListVPNServerClientsWithContext(ctx context.Context, listVPNServerClientsOptions *ListVPNServerClientsOptions) (result *VPNServerClientCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listVPNServerClientsOptions, "listVPNServerClientsOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listVPNServerClientsOptions, "listVPNServerClientsOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpn_server_id": *listVPNServerClientsOptions.VPNServerID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_servers/{vpn_server_id}/clients`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listVPNServerClientsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListVPNServerClients") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listVPNServerClientsOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listVPNServerClientsOptions.Start)) + } + if listVPNServerClientsOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listVPNServerClientsOptions.Limit)) + } + if listVPNServerClientsOptions.Sort != nil { + builder.AddQuery("sort", fmt.Sprint(*listVPNServerClientsOptions.Sort)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVPNServerClientCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteVPNServerClient : Delete a VPN client +// This request disconnects and deletes the VPN client from the VPN server. The VPN client may reconnect unless its +// authentication permissions for the configured authentication methods (such as its client certificate) have been +// revoked. +func (vpc *VpcV1) DeleteVPNServerClient(deleteVPNServerClientOptions *DeleteVPNServerClientOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteVPNServerClientWithContext(context.Background(), deleteVPNServerClientOptions) +} + +// DeleteVPNServerClientWithContext is an alternate form of the DeleteVPNServerClient method which supports a Context parameter +func (vpc *VpcV1) DeleteVPNServerClientWithContext(ctx context.Context, deleteVPNServerClientOptions *DeleteVPNServerClientOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteVPNServerClientOptions, "deleteVPNServerClientOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteVPNServerClientOptions, "deleteVPNServerClientOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpn_server_id": *deleteVPNServerClientOptions.VPNServerID, + "id": *deleteVPNServerClientOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_servers/{vpn_server_id}/clients/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteVPNServerClientOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteVPNServerClient") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetVPNServerClient : Retrieve a VPN client +// This request retrieves a single VPN client specified by the identifier in the URL. +func (vpc *VpcV1) GetVPNServerClient(getVPNServerClientOptions *GetVPNServerClientOptions) (result *VPNServerClient, response *core.DetailedResponse, err error) { + return vpc.GetVPNServerClientWithContext(context.Background(), getVPNServerClientOptions) +} + +// GetVPNServerClientWithContext is an alternate form of the GetVPNServerClient method which supports a Context parameter +func (vpc *VpcV1) GetVPNServerClientWithContext(ctx context.Context, getVPNServerClientOptions *GetVPNServerClientOptions) (result *VPNServerClient, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getVPNServerClientOptions, "getVPNServerClientOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getVPNServerClientOptions, "getVPNServerClientOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpn_server_id": *getVPNServerClientOptions.VPNServerID, + "id": *getVPNServerClientOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_servers/{vpn_server_id}/clients/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getVPNServerClientOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetVPNServerClient") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVPNServerClient) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DisconnectVPNClient : Disconnect a VPN client +// This request disconnects the specified VPN client, and deletes the client according to the VPN server's auto-deletion +// policy. The VPN client may reconnect unless its authentication permissions for the configured authentication methods +// (such as its client certificate) have been revoked. +func (vpc *VpcV1) DisconnectVPNClient(disconnectVPNClientOptions *DisconnectVPNClientOptions) (response *core.DetailedResponse, err error) { + return vpc.DisconnectVPNClientWithContext(context.Background(), disconnectVPNClientOptions) +} + +// DisconnectVPNClientWithContext is an alternate form of the DisconnectVPNClient method which supports a Context parameter +func (vpc *VpcV1) DisconnectVPNClientWithContext(ctx context.Context, disconnectVPNClientOptions *DisconnectVPNClientOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(disconnectVPNClientOptions, "disconnectVPNClientOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(disconnectVPNClientOptions, "disconnectVPNClientOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpn_server_id": *disconnectVPNClientOptions.VPNServerID, + "id": *disconnectVPNClientOptions.ID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_servers/{vpn_server_id}/clients/{id}/disconnect`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range disconnectVPNClientOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DisconnectVPNClient") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// ListVPNServerRoutes : List all VPN routes for a VPN server +// This request lists all VPN routes in a VPN server. All VPN routes are provided to the VPN client when the connection +// is established. Packets received from the VPN client will be dropped by the VPN server if there is no VPN route +// matching their specified destinations. All VPN routes must be unique within the VPN server. +func (vpc *VpcV1) ListVPNServerRoutes(listVPNServerRoutesOptions *ListVPNServerRoutesOptions) (result *VPNServerRouteCollection, response *core.DetailedResponse, err error) { + return vpc.ListVPNServerRoutesWithContext(context.Background(), listVPNServerRoutesOptions) +} + +// ListVPNServerRoutesWithContext is an alternate form of the ListVPNServerRoutes method which supports a Context parameter +func (vpc *VpcV1) ListVPNServerRoutesWithContext(ctx context.Context, listVPNServerRoutesOptions *ListVPNServerRoutesOptions) (result *VPNServerRouteCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listVPNServerRoutesOptions, "listVPNServerRoutesOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listVPNServerRoutesOptions, "listVPNServerRoutesOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpn_server_id": *listVPNServerRoutesOptions.VPNServerID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_servers/{vpn_server_id}/routes`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listVPNServerRoutesOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListVPNServerRoutes") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listVPNServerRoutesOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listVPNServerRoutesOptions.Start)) + } + if listVPNServerRoutesOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listVPNServerRoutesOptions.Limit)) + } + if listVPNServerRoutesOptions.Sort != nil { + builder.AddQuery("sort", fmt.Sprint(*listVPNServerRoutesOptions.Sort)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVPNServerRouteCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateVPNServerRoute : Create a VPN route for a VPN server +// This request creates a new VPN route in the VPN server. All VPN routes are provided to the VPN client when the +// connection is established. Packets received from the VPN client will be dropped by the VPN server if there is no VPN +// route matching their specified destinations. All VPN routes must be unique within the VPN server. destination of the +// packet. +func (vpc *VpcV1) CreateVPNServerRoute(createVPNServerRouteOptions *CreateVPNServerRouteOptions) (result *VPNServerRoute, response *core.DetailedResponse, err error) { + return vpc.CreateVPNServerRouteWithContext(context.Background(), createVPNServerRouteOptions) +} + +// CreateVPNServerRouteWithContext is an alternate form of the CreateVPNServerRoute method which supports a Context parameter +func (vpc *VpcV1) CreateVPNServerRouteWithContext(ctx context.Context, createVPNServerRouteOptions *CreateVPNServerRouteOptions) (result *VPNServerRoute, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createVPNServerRouteOptions, "createVPNServerRouteOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createVPNServerRouteOptions, "createVPNServerRouteOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpn_server_id": *createVPNServerRouteOptions.VPNServerID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_servers/{vpn_server_id}/routes`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range createVPNServerRouteOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateVPNServerRoute") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createVPNServerRouteOptions.Destination != nil { + body["destination"] = createVPNServerRouteOptions.Destination + } + if createVPNServerRouteOptions.Action != nil { + body["action"] = createVPNServerRouteOptions.Action + } + if createVPNServerRouteOptions.Name != nil { + body["name"] = createVPNServerRouteOptions.Name + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVPNServerRoute) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteVPNServerRoute : Delete a VPN route +// This request deletes a VPN route. This operation cannot be reversed. +func (vpc *VpcV1) DeleteVPNServerRoute(deleteVPNServerRouteOptions *DeleteVPNServerRouteOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteVPNServerRouteWithContext(context.Background(), deleteVPNServerRouteOptions) +} + +// DeleteVPNServerRouteWithContext is an alternate form of the DeleteVPNServerRoute method which supports a Context parameter +func (vpc *VpcV1) DeleteVPNServerRouteWithContext(ctx context.Context, deleteVPNServerRouteOptions *DeleteVPNServerRouteOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteVPNServerRouteOptions, "deleteVPNServerRouteOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteVPNServerRouteOptions, "deleteVPNServerRouteOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpn_server_id": *deleteVPNServerRouteOptions.VPNServerID, + "id": *deleteVPNServerRouteOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_servers/{vpn_server_id}/routes/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteVPNServerRouteOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteVPNServerRoute") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetVPNServerRoute : Retrieve a VPN route +// This request retrieves a single VPN route specified by the identifier in the URL. +func (vpc *VpcV1) GetVPNServerRoute(getVPNServerRouteOptions *GetVPNServerRouteOptions) (result *VPNServerRoute, response *core.DetailedResponse, err error) { + return vpc.GetVPNServerRouteWithContext(context.Background(), getVPNServerRouteOptions) +} + +// GetVPNServerRouteWithContext is an alternate form of the GetVPNServerRoute method which supports a Context parameter +func (vpc *VpcV1) GetVPNServerRouteWithContext(ctx context.Context, getVPNServerRouteOptions *GetVPNServerRouteOptions) (result *VPNServerRoute, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getVPNServerRouteOptions, "getVPNServerRouteOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getVPNServerRouteOptions, "getVPNServerRouteOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpn_server_id": *getVPNServerRouteOptions.VPNServerID, + "id": *getVPNServerRouteOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_servers/{vpn_server_id}/routes/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getVPNServerRouteOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetVPNServerRoute") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVPNServerRoute) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateVPNServerRoute : Update a VPN route +// This request updates a VPN route with the information in a provided VPN route patch. The VPN route patch object is +// structured in the same way as a retrieved VPN route and contains only the information to be updated. +func (vpc *VpcV1) UpdateVPNServerRoute(updateVPNServerRouteOptions *UpdateVPNServerRouteOptions) (result *VPNServerRoute, response *core.DetailedResponse, err error) { + return vpc.UpdateVPNServerRouteWithContext(context.Background(), updateVPNServerRouteOptions) +} + +// UpdateVPNServerRouteWithContext is an alternate form of the UpdateVPNServerRoute method which supports a Context parameter +func (vpc *VpcV1) UpdateVPNServerRouteWithContext(ctx context.Context, updateVPNServerRouteOptions *UpdateVPNServerRouteOptions) (result *VPNServerRoute, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateVPNServerRouteOptions, "updateVPNServerRouteOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateVPNServerRouteOptions, "updateVPNServerRouteOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "vpn_server_id": *updateVPNServerRouteOptions.VPNServerID, + "id": *updateVPNServerRouteOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/vpn_servers/{vpn_server_id}/routes/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateVPNServerRouteOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateVPNServerRoute") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateVPNServerRouteOptions.VPNServerRoutePatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalVPNServerRoute) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListLoadBalancerProfiles : List all load balancer profiles +// This request lists all load balancer profiles available in the region. A load balancer profile specifies the +// performance characteristics and pricing model for a load balancer. +func (vpc *VpcV1) ListLoadBalancerProfiles(listLoadBalancerProfilesOptions *ListLoadBalancerProfilesOptions) (result *LoadBalancerProfileCollection, response *core.DetailedResponse, err error) { + return vpc.ListLoadBalancerProfilesWithContext(context.Background(), listLoadBalancerProfilesOptions) +} + +// ListLoadBalancerProfilesWithContext is an alternate form of the ListLoadBalancerProfiles method which supports a Context parameter +func (vpc *VpcV1) ListLoadBalancerProfilesWithContext(ctx context.Context, listLoadBalancerProfilesOptions *ListLoadBalancerProfilesOptions) (result *LoadBalancerProfileCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listLoadBalancerProfilesOptions, "listLoadBalancerProfilesOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancer/profiles`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listLoadBalancerProfilesOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListLoadBalancerProfiles") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listLoadBalancerProfilesOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listLoadBalancerProfilesOptions.Start)) + } + if listLoadBalancerProfilesOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listLoadBalancerProfilesOptions.Limit)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalLoadBalancerProfileCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// GetLoadBalancerProfile : Retrieve a load balancer profile +// This request retrieves a load balancer profile specified by the name in the URL. +func (vpc *VpcV1) GetLoadBalancerProfile(getLoadBalancerProfileOptions *GetLoadBalancerProfileOptions) (result *LoadBalancerProfile, response *core.DetailedResponse, err error) { + return vpc.GetLoadBalancerProfileWithContext(context.Background(), getLoadBalancerProfileOptions) +} + +// GetLoadBalancerProfileWithContext is an alternate form of the GetLoadBalancerProfile method which supports a Context parameter +func (vpc *VpcV1) GetLoadBalancerProfileWithContext(ctx context.Context, getLoadBalancerProfileOptions *GetLoadBalancerProfileOptions) (result *LoadBalancerProfile, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getLoadBalancerProfileOptions, "getLoadBalancerProfileOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getLoadBalancerProfileOptions, "getLoadBalancerProfileOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "name": *getLoadBalancerProfileOptions.Name, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancer/profiles/{name}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getLoadBalancerProfileOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetLoadBalancerProfile") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalLoadBalancerProfile) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListLoadBalancers : List all load balancers +// This request lists all load balancers in the region. +func (vpc *VpcV1) ListLoadBalancers(listLoadBalancersOptions *ListLoadBalancersOptions) (result *LoadBalancerCollection, response *core.DetailedResponse, err error) { + return vpc.ListLoadBalancersWithContext(context.Background(), listLoadBalancersOptions) +} + +// ListLoadBalancersWithContext is an alternate form of the ListLoadBalancers method which supports a Context parameter +func (vpc *VpcV1) ListLoadBalancersWithContext(ctx context.Context, listLoadBalancersOptions *ListLoadBalancersOptions) (result *LoadBalancerCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listLoadBalancersOptions, "listLoadBalancersOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listLoadBalancersOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListLoadBalancers") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listLoadBalancersOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listLoadBalancersOptions.Start)) + } + if listLoadBalancersOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listLoadBalancersOptions.Limit)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalLoadBalancerCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateLoadBalancer : Create a load balancer +// This request creates and provisions a new load balancer. +func (vpc *VpcV1) CreateLoadBalancer(createLoadBalancerOptions *CreateLoadBalancerOptions) (result *LoadBalancer, response *core.DetailedResponse, err error) { + return vpc.CreateLoadBalancerWithContext(context.Background(), createLoadBalancerOptions) +} + +// CreateLoadBalancerWithContext is an alternate form of the CreateLoadBalancer method which supports a Context parameter +func (vpc *VpcV1) CreateLoadBalancerWithContext(ctx context.Context, createLoadBalancerOptions *CreateLoadBalancerOptions) (result *LoadBalancer, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createLoadBalancerOptions, "createLoadBalancerOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createLoadBalancerOptions, "createLoadBalancerOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers`, nil) + if err != nil { + return + } + + for headerName, headerValue := range createLoadBalancerOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateLoadBalancer") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createLoadBalancerOptions.IsPublic != nil { + body["is_public"] = createLoadBalancerOptions.IsPublic + } + if createLoadBalancerOptions.Subnets != nil { + body["subnets"] = createLoadBalancerOptions.Subnets + } + if createLoadBalancerOptions.Datapath != nil { + body["datapath"] = createLoadBalancerOptions.Datapath + } + if createLoadBalancerOptions.Dns != nil { + body["dns"] = createLoadBalancerOptions.Dns + } + if createLoadBalancerOptions.Listeners != nil { + body["listeners"] = createLoadBalancerOptions.Listeners + } + if createLoadBalancerOptions.Logging != nil { + body["logging"] = createLoadBalancerOptions.Logging + } + if createLoadBalancerOptions.Name != nil { + body["name"] = createLoadBalancerOptions.Name + } + if createLoadBalancerOptions.Pools != nil { + body["pools"] = createLoadBalancerOptions.Pools + } + if createLoadBalancerOptions.Profile != nil { + body["profile"] = createLoadBalancerOptions.Profile + } + if createLoadBalancerOptions.ResourceGroup != nil { + body["resource_group"] = createLoadBalancerOptions.ResourceGroup + } + if createLoadBalancerOptions.RouteMode != nil { + body["route_mode"] = createLoadBalancerOptions.RouteMode + } + if createLoadBalancerOptions.SecurityGroups != nil { + body["security_groups"] = createLoadBalancerOptions.SecurityGroups + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalLoadBalancer) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteLoadBalancer : Delete a load balancer +// This request deletes a load balancer. This operation cannot be reversed. A load balancer cannot be deleted if its +// `provisioning_status` is `delete_pending`. +func (vpc *VpcV1) DeleteLoadBalancer(deleteLoadBalancerOptions *DeleteLoadBalancerOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteLoadBalancerWithContext(context.Background(), deleteLoadBalancerOptions) +} + +// DeleteLoadBalancerWithContext is an alternate form of the DeleteLoadBalancer method which supports a Context parameter +func (vpc *VpcV1) DeleteLoadBalancerWithContext(ctx context.Context, deleteLoadBalancerOptions *DeleteLoadBalancerOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteLoadBalancerOptions, "deleteLoadBalancerOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteLoadBalancerOptions, "deleteLoadBalancerOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *deleteLoadBalancerOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteLoadBalancerOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteLoadBalancer") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + if deleteLoadBalancerOptions.IfMatch != nil { + builder.AddHeader("If-Match", fmt.Sprint(*deleteLoadBalancerOptions.IfMatch)) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetLoadBalancer : Retrieve a load balancer +// This request retrieves a single load balancer specified by the identifier in the URL path. +func (vpc *VpcV1) GetLoadBalancer(getLoadBalancerOptions *GetLoadBalancerOptions) (result *LoadBalancer, response *core.DetailedResponse, err error) { + return vpc.GetLoadBalancerWithContext(context.Background(), getLoadBalancerOptions) +} + +// GetLoadBalancerWithContext is an alternate form of the GetLoadBalancer method which supports a Context parameter +func (vpc *VpcV1) GetLoadBalancerWithContext(ctx context.Context, getLoadBalancerOptions *GetLoadBalancerOptions) (result *LoadBalancer, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getLoadBalancerOptions, "getLoadBalancerOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getLoadBalancerOptions, "getLoadBalancerOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getLoadBalancerOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getLoadBalancerOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetLoadBalancer") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalLoadBalancer) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateLoadBalancer : Update a load balancer +// This request updates a load balancer with the information in a provided load balancer patch. The load balancer patch +// object is structured in the same way as a retrieved load balancer and contains only the information to be updated. A +// load balancer can only be updated if its `provisioning_status` is `active`. +func (vpc *VpcV1) UpdateLoadBalancer(updateLoadBalancerOptions *UpdateLoadBalancerOptions) (result *LoadBalancer, response *core.DetailedResponse, err error) { + return vpc.UpdateLoadBalancerWithContext(context.Background(), updateLoadBalancerOptions) +} + +// UpdateLoadBalancerWithContext is an alternate form of the UpdateLoadBalancer method which supports a Context parameter +func (vpc *VpcV1) UpdateLoadBalancerWithContext(ctx context.Context, updateLoadBalancerOptions *UpdateLoadBalancerOptions) (result *LoadBalancer, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateLoadBalancerOptions, "updateLoadBalancerOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateLoadBalancerOptions, "updateLoadBalancerOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *updateLoadBalancerOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateLoadBalancerOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateLoadBalancer") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + if updateLoadBalancerOptions.IfMatch != nil { + builder.AddHeader("If-Match", fmt.Sprint(*updateLoadBalancerOptions.IfMatch)) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateLoadBalancerOptions.LoadBalancerPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalLoadBalancer) + if err != nil { + return + } + response.Result = result + } + + return +} + +// GetLoadBalancerStatistics : List all statistics of a load balancer +// This request lists statistics of a load balancer. +func (vpc *VpcV1) GetLoadBalancerStatistics(getLoadBalancerStatisticsOptions *GetLoadBalancerStatisticsOptions) (result *LoadBalancerStatistics, response *core.DetailedResponse, err error) { + return vpc.GetLoadBalancerStatisticsWithContext(context.Background(), getLoadBalancerStatisticsOptions) +} + +// GetLoadBalancerStatisticsWithContext is an alternate form of the GetLoadBalancerStatistics method which supports a Context parameter +func (vpc *VpcV1) GetLoadBalancerStatisticsWithContext(ctx context.Context, getLoadBalancerStatisticsOptions *GetLoadBalancerStatisticsOptions) (result *LoadBalancerStatistics, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getLoadBalancerStatisticsOptions, "getLoadBalancerStatisticsOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getLoadBalancerStatisticsOptions, "getLoadBalancerStatisticsOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getLoadBalancerStatisticsOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers/{id}/statistics`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getLoadBalancerStatisticsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetLoadBalancerStatistics") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalLoadBalancerStatistics) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListLoadBalancerListeners : List all listeners for a load balancer +// This request lists all listeners for a load balancer. +func (vpc *VpcV1) ListLoadBalancerListeners(listLoadBalancerListenersOptions *ListLoadBalancerListenersOptions) (result *LoadBalancerListenerCollection, response *core.DetailedResponse, err error) { + return vpc.ListLoadBalancerListenersWithContext(context.Background(), listLoadBalancerListenersOptions) +} + +// ListLoadBalancerListenersWithContext is an alternate form of the ListLoadBalancerListeners method which supports a Context parameter +func (vpc *VpcV1) ListLoadBalancerListenersWithContext(ctx context.Context, listLoadBalancerListenersOptions *ListLoadBalancerListenersOptions) (result *LoadBalancerListenerCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listLoadBalancerListenersOptions, "listLoadBalancerListenersOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listLoadBalancerListenersOptions, "listLoadBalancerListenersOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "load_balancer_id": *listLoadBalancerListenersOptions.LoadBalancerID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers/{load_balancer_id}/listeners`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listLoadBalancerListenersOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListLoadBalancerListeners") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalLoadBalancerListenerCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateLoadBalancerListener : Create a listener for a load balancer +// This request creates a new listener for a load balancer. +func (vpc *VpcV1) CreateLoadBalancerListener(createLoadBalancerListenerOptions *CreateLoadBalancerListenerOptions) (result *LoadBalancerListener, response *core.DetailedResponse, err error) { + return vpc.CreateLoadBalancerListenerWithContext(context.Background(), createLoadBalancerListenerOptions) +} + +// CreateLoadBalancerListenerWithContext is an alternate form of the CreateLoadBalancerListener method which supports a Context parameter +func (vpc *VpcV1) CreateLoadBalancerListenerWithContext(ctx context.Context, createLoadBalancerListenerOptions *CreateLoadBalancerListenerOptions) (result *LoadBalancerListener, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createLoadBalancerListenerOptions, "createLoadBalancerListenerOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createLoadBalancerListenerOptions, "createLoadBalancerListenerOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "load_balancer_id": *createLoadBalancerListenerOptions.LoadBalancerID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers/{load_balancer_id}/listeners`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range createLoadBalancerListenerOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateLoadBalancerListener") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createLoadBalancerListenerOptions.Protocol != nil { + body["protocol"] = createLoadBalancerListenerOptions.Protocol + } + if createLoadBalancerListenerOptions.AcceptProxyProtocol != nil { + body["accept_proxy_protocol"] = createLoadBalancerListenerOptions.AcceptProxyProtocol + } + if createLoadBalancerListenerOptions.CertificateInstance != nil { + body["certificate_instance"] = createLoadBalancerListenerOptions.CertificateInstance + } + if createLoadBalancerListenerOptions.ConnectionLimit != nil { + body["connection_limit"] = createLoadBalancerListenerOptions.ConnectionLimit + } + if createLoadBalancerListenerOptions.DefaultPool != nil { + body["default_pool"] = createLoadBalancerListenerOptions.DefaultPool + } + if createLoadBalancerListenerOptions.HTTPSRedirect != nil { + body["https_redirect"] = createLoadBalancerListenerOptions.HTTPSRedirect + } + if createLoadBalancerListenerOptions.IdleConnectionTimeout != nil { + body["idle_connection_timeout"] = createLoadBalancerListenerOptions.IdleConnectionTimeout + } + if createLoadBalancerListenerOptions.Policies != nil { + body["policies"] = createLoadBalancerListenerOptions.Policies + } + if createLoadBalancerListenerOptions.Port != nil { + body["port"] = createLoadBalancerListenerOptions.Port + } + if createLoadBalancerListenerOptions.PortMax != nil { + body["port_max"] = createLoadBalancerListenerOptions.PortMax + } + if createLoadBalancerListenerOptions.PortMin != nil { + body["port_min"] = createLoadBalancerListenerOptions.PortMin + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalLoadBalancerListener) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteLoadBalancerListener : Delete a load balancer listener +// This request deletes a load balancer listener. This operation cannot be reversed. For this operation to succeed, the +// listener must not be the target of another load balancer listener. +func (vpc *VpcV1) DeleteLoadBalancerListener(deleteLoadBalancerListenerOptions *DeleteLoadBalancerListenerOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteLoadBalancerListenerWithContext(context.Background(), deleteLoadBalancerListenerOptions) +} + +// DeleteLoadBalancerListenerWithContext is an alternate form of the DeleteLoadBalancerListener method which supports a Context parameter +func (vpc *VpcV1) DeleteLoadBalancerListenerWithContext(ctx context.Context, deleteLoadBalancerListenerOptions *DeleteLoadBalancerListenerOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteLoadBalancerListenerOptions, "deleteLoadBalancerListenerOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteLoadBalancerListenerOptions, "deleteLoadBalancerListenerOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "load_balancer_id": *deleteLoadBalancerListenerOptions.LoadBalancerID, + "id": *deleteLoadBalancerListenerOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers/{load_balancer_id}/listeners/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteLoadBalancerListenerOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteLoadBalancerListener") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetLoadBalancerListener : Retrieve a load balancer listener +// This request retrieves a single listener specified by the identifier in the URL path. +func (vpc *VpcV1) GetLoadBalancerListener(getLoadBalancerListenerOptions *GetLoadBalancerListenerOptions) (result *LoadBalancerListener, response *core.DetailedResponse, err error) { + return vpc.GetLoadBalancerListenerWithContext(context.Background(), getLoadBalancerListenerOptions) +} + +// GetLoadBalancerListenerWithContext is an alternate form of the GetLoadBalancerListener method which supports a Context parameter +func (vpc *VpcV1) GetLoadBalancerListenerWithContext(ctx context.Context, getLoadBalancerListenerOptions *GetLoadBalancerListenerOptions) (result *LoadBalancerListener, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getLoadBalancerListenerOptions, "getLoadBalancerListenerOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getLoadBalancerListenerOptions, "getLoadBalancerListenerOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "load_balancer_id": *getLoadBalancerListenerOptions.LoadBalancerID, + "id": *getLoadBalancerListenerOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers/{load_balancer_id}/listeners/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getLoadBalancerListenerOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetLoadBalancerListener") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalLoadBalancerListener) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateLoadBalancerListener : Update a load balancer listener +// This request updates a load balancer listener from a listener patch. +func (vpc *VpcV1) UpdateLoadBalancerListener(updateLoadBalancerListenerOptions *UpdateLoadBalancerListenerOptions) (result *LoadBalancerListener, response *core.DetailedResponse, err error) { + return vpc.UpdateLoadBalancerListenerWithContext(context.Background(), updateLoadBalancerListenerOptions) +} + +// UpdateLoadBalancerListenerWithContext is an alternate form of the UpdateLoadBalancerListener method which supports a Context parameter +func (vpc *VpcV1) UpdateLoadBalancerListenerWithContext(ctx context.Context, updateLoadBalancerListenerOptions *UpdateLoadBalancerListenerOptions) (result *LoadBalancerListener, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateLoadBalancerListenerOptions, "updateLoadBalancerListenerOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateLoadBalancerListenerOptions, "updateLoadBalancerListenerOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "load_balancer_id": *updateLoadBalancerListenerOptions.LoadBalancerID, + "id": *updateLoadBalancerListenerOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers/{load_balancer_id}/listeners/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateLoadBalancerListenerOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateLoadBalancerListener") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateLoadBalancerListenerOptions.LoadBalancerListenerPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalLoadBalancerListener) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListLoadBalancerListenerPolicies : List all policies for a load balancer listener +// This request lists all policies for a load balancer listener. +func (vpc *VpcV1) ListLoadBalancerListenerPolicies(listLoadBalancerListenerPoliciesOptions *ListLoadBalancerListenerPoliciesOptions) (result *LoadBalancerListenerPolicyCollection, response *core.DetailedResponse, err error) { + return vpc.ListLoadBalancerListenerPoliciesWithContext(context.Background(), listLoadBalancerListenerPoliciesOptions) +} + +// ListLoadBalancerListenerPoliciesWithContext is an alternate form of the ListLoadBalancerListenerPolicies method which supports a Context parameter +func (vpc *VpcV1) ListLoadBalancerListenerPoliciesWithContext(ctx context.Context, listLoadBalancerListenerPoliciesOptions *ListLoadBalancerListenerPoliciesOptions) (result *LoadBalancerListenerPolicyCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listLoadBalancerListenerPoliciesOptions, "listLoadBalancerListenerPoliciesOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listLoadBalancerListenerPoliciesOptions, "listLoadBalancerListenerPoliciesOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "load_balancer_id": *listLoadBalancerListenerPoliciesOptions.LoadBalancerID, + "listener_id": *listLoadBalancerListenerPoliciesOptions.ListenerID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers/{load_balancer_id}/listeners/{listener_id}/policies`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listLoadBalancerListenerPoliciesOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListLoadBalancerListenerPolicies") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalLoadBalancerListenerPolicyCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateLoadBalancerListenerPolicy : Create a policy for a load balancer listener +// Creates a new policy for a load balancer listener. +func (vpc *VpcV1) CreateLoadBalancerListenerPolicy(createLoadBalancerListenerPolicyOptions *CreateLoadBalancerListenerPolicyOptions) (result *LoadBalancerListenerPolicy, response *core.DetailedResponse, err error) { + return vpc.CreateLoadBalancerListenerPolicyWithContext(context.Background(), createLoadBalancerListenerPolicyOptions) +} + +// CreateLoadBalancerListenerPolicyWithContext is an alternate form of the CreateLoadBalancerListenerPolicy method which supports a Context parameter +func (vpc *VpcV1) CreateLoadBalancerListenerPolicyWithContext(ctx context.Context, createLoadBalancerListenerPolicyOptions *CreateLoadBalancerListenerPolicyOptions) (result *LoadBalancerListenerPolicy, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createLoadBalancerListenerPolicyOptions, "createLoadBalancerListenerPolicyOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createLoadBalancerListenerPolicyOptions, "createLoadBalancerListenerPolicyOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "load_balancer_id": *createLoadBalancerListenerPolicyOptions.LoadBalancerID, + "listener_id": *createLoadBalancerListenerPolicyOptions.ListenerID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers/{load_balancer_id}/listeners/{listener_id}/policies`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range createLoadBalancerListenerPolicyOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateLoadBalancerListenerPolicy") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createLoadBalancerListenerPolicyOptions.Action != nil { + body["action"] = createLoadBalancerListenerPolicyOptions.Action + } + if createLoadBalancerListenerPolicyOptions.Priority != nil { + body["priority"] = createLoadBalancerListenerPolicyOptions.Priority + } + if createLoadBalancerListenerPolicyOptions.Name != nil { + body["name"] = createLoadBalancerListenerPolicyOptions.Name + } + if createLoadBalancerListenerPolicyOptions.Rules != nil { + body["rules"] = createLoadBalancerListenerPolicyOptions.Rules + } + if createLoadBalancerListenerPolicyOptions.Target != nil { + body["target"] = createLoadBalancerListenerPolicyOptions.Target + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalLoadBalancerListenerPolicy) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteLoadBalancerListenerPolicy : Delete a load balancer listener policy +// Deletes a policy of the load balancer listener. This operation cannot be reversed. +func (vpc *VpcV1) DeleteLoadBalancerListenerPolicy(deleteLoadBalancerListenerPolicyOptions *DeleteLoadBalancerListenerPolicyOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteLoadBalancerListenerPolicyWithContext(context.Background(), deleteLoadBalancerListenerPolicyOptions) +} + +// DeleteLoadBalancerListenerPolicyWithContext is an alternate form of the DeleteLoadBalancerListenerPolicy method which supports a Context parameter +func (vpc *VpcV1) DeleteLoadBalancerListenerPolicyWithContext(ctx context.Context, deleteLoadBalancerListenerPolicyOptions *DeleteLoadBalancerListenerPolicyOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteLoadBalancerListenerPolicyOptions, "deleteLoadBalancerListenerPolicyOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteLoadBalancerListenerPolicyOptions, "deleteLoadBalancerListenerPolicyOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "load_balancer_id": *deleteLoadBalancerListenerPolicyOptions.LoadBalancerID, + "listener_id": *deleteLoadBalancerListenerPolicyOptions.ListenerID, + "id": *deleteLoadBalancerListenerPolicyOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers/{load_balancer_id}/listeners/{listener_id}/policies/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteLoadBalancerListenerPolicyOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteLoadBalancerListenerPolicy") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetLoadBalancerListenerPolicy : Retrieve a load balancer listener policy +// Retrieve a single policy specified by the identifier in the URL path. +func (vpc *VpcV1) GetLoadBalancerListenerPolicy(getLoadBalancerListenerPolicyOptions *GetLoadBalancerListenerPolicyOptions) (result *LoadBalancerListenerPolicy, response *core.DetailedResponse, err error) { + return vpc.GetLoadBalancerListenerPolicyWithContext(context.Background(), getLoadBalancerListenerPolicyOptions) +} + +// GetLoadBalancerListenerPolicyWithContext is an alternate form of the GetLoadBalancerListenerPolicy method which supports a Context parameter +func (vpc *VpcV1) GetLoadBalancerListenerPolicyWithContext(ctx context.Context, getLoadBalancerListenerPolicyOptions *GetLoadBalancerListenerPolicyOptions) (result *LoadBalancerListenerPolicy, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getLoadBalancerListenerPolicyOptions, "getLoadBalancerListenerPolicyOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getLoadBalancerListenerPolicyOptions, "getLoadBalancerListenerPolicyOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "load_balancer_id": *getLoadBalancerListenerPolicyOptions.LoadBalancerID, + "listener_id": *getLoadBalancerListenerPolicyOptions.ListenerID, + "id": *getLoadBalancerListenerPolicyOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers/{load_balancer_id}/listeners/{listener_id}/policies/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getLoadBalancerListenerPolicyOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetLoadBalancerListenerPolicy") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalLoadBalancerListenerPolicy) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateLoadBalancerListenerPolicy : Update a load balancer listener policy +// Updates a policy from a policy patch. +func (vpc *VpcV1) UpdateLoadBalancerListenerPolicy(updateLoadBalancerListenerPolicyOptions *UpdateLoadBalancerListenerPolicyOptions) (result *LoadBalancerListenerPolicy, response *core.DetailedResponse, err error) { + return vpc.UpdateLoadBalancerListenerPolicyWithContext(context.Background(), updateLoadBalancerListenerPolicyOptions) +} + +// UpdateLoadBalancerListenerPolicyWithContext is an alternate form of the UpdateLoadBalancerListenerPolicy method which supports a Context parameter +func (vpc *VpcV1) UpdateLoadBalancerListenerPolicyWithContext(ctx context.Context, updateLoadBalancerListenerPolicyOptions *UpdateLoadBalancerListenerPolicyOptions) (result *LoadBalancerListenerPolicy, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateLoadBalancerListenerPolicyOptions, "updateLoadBalancerListenerPolicyOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateLoadBalancerListenerPolicyOptions, "updateLoadBalancerListenerPolicyOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "load_balancer_id": *updateLoadBalancerListenerPolicyOptions.LoadBalancerID, + "listener_id": *updateLoadBalancerListenerPolicyOptions.ListenerID, + "id": *updateLoadBalancerListenerPolicyOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers/{load_balancer_id}/listeners/{listener_id}/policies/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateLoadBalancerListenerPolicyOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateLoadBalancerListenerPolicy") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateLoadBalancerListenerPolicyOptions.LoadBalancerListenerPolicyPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalLoadBalancerListenerPolicy) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListLoadBalancerListenerPolicyRules : List all rules of a load balancer listener policy +// This request lists all rules of a load balancer listener policy. +func (vpc *VpcV1) ListLoadBalancerListenerPolicyRules(listLoadBalancerListenerPolicyRulesOptions *ListLoadBalancerListenerPolicyRulesOptions) (result *LoadBalancerListenerPolicyRuleCollection, response *core.DetailedResponse, err error) { + return vpc.ListLoadBalancerListenerPolicyRulesWithContext(context.Background(), listLoadBalancerListenerPolicyRulesOptions) +} + +// ListLoadBalancerListenerPolicyRulesWithContext is an alternate form of the ListLoadBalancerListenerPolicyRules method which supports a Context parameter +func (vpc *VpcV1) ListLoadBalancerListenerPolicyRulesWithContext(ctx context.Context, listLoadBalancerListenerPolicyRulesOptions *ListLoadBalancerListenerPolicyRulesOptions) (result *LoadBalancerListenerPolicyRuleCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listLoadBalancerListenerPolicyRulesOptions, "listLoadBalancerListenerPolicyRulesOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listLoadBalancerListenerPolicyRulesOptions, "listLoadBalancerListenerPolicyRulesOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "load_balancer_id": *listLoadBalancerListenerPolicyRulesOptions.LoadBalancerID, + "listener_id": *listLoadBalancerListenerPolicyRulesOptions.ListenerID, + "policy_id": *listLoadBalancerListenerPolicyRulesOptions.PolicyID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers/{load_balancer_id}/listeners/{listener_id}/policies/{policy_id}/rules`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listLoadBalancerListenerPolicyRulesOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListLoadBalancerListenerPolicyRules") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalLoadBalancerListenerPolicyRuleCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateLoadBalancerListenerPolicyRule : Create a rule for a load balancer listener policy +// Creates a new rule for the load balancer listener policy. +func (vpc *VpcV1) CreateLoadBalancerListenerPolicyRule(createLoadBalancerListenerPolicyRuleOptions *CreateLoadBalancerListenerPolicyRuleOptions) (result *LoadBalancerListenerPolicyRule, response *core.DetailedResponse, err error) { + return vpc.CreateLoadBalancerListenerPolicyRuleWithContext(context.Background(), createLoadBalancerListenerPolicyRuleOptions) +} + +// CreateLoadBalancerListenerPolicyRuleWithContext is an alternate form of the CreateLoadBalancerListenerPolicyRule method which supports a Context parameter +func (vpc *VpcV1) CreateLoadBalancerListenerPolicyRuleWithContext(ctx context.Context, createLoadBalancerListenerPolicyRuleOptions *CreateLoadBalancerListenerPolicyRuleOptions) (result *LoadBalancerListenerPolicyRule, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createLoadBalancerListenerPolicyRuleOptions, "createLoadBalancerListenerPolicyRuleOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createLoadBalancerListenerPolicyRuleOptions, "createLoadBalancerListenerPolicyRuleOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "load_balancer_id": *createLoadBalancerListenerPolicyRuleOptions.LoadBalancerID, + "listener_id": *createLoadBalancerListenerPolicyRuleOptions.ListenerID, + "policy_id": *createLoadBalancerListenerPolicyRuleOptions.PolicyID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers/{load_balancer_id}/listeners/{listener_id}/policies/{policy_id}/rules`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range createLoadBalancerListenerPolicyRuleOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateLoadBalancerListenerPolicyRule") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createLoadBalancerListenerPolicyRuleOptions.Condition != nil { + body["condition"] = createLoadBalancerListenerPolicyRuleOptions.Condition + } + if createLoadBalancerListenerPolicyRuleOptions.Type != nil { + body["type"] = createLoadBalancerListenerPolicyRuleOptions.Type + } + if createLoadBalancerListenerPolicyRuleOptions.Value != nil { + body["value"] = createLoadBalancerListenerPolicyRuleOptions.Value + } + if createLoadBalancerListenerPolicyRuleOptions.Field != nil { + body["field"] = createLoadBalancerListenerPolicyRuleOptions.Field + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalLoadBalancerListenerPolicyRule) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteLoadBalancerListenerPolicyRule : Delete a load balancer listener policy rule +// Deletes a rule from the load balancer listener policy. This operation cannot be reversed. +func (vpc *VpcV1) DeleteLoadBalancerListenerPolicyRule(deleteLoadBalancerListenerPolicyRuleOptions *DeleteLoadBalancerListenerPolicyRuleOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteLoadBalancerListenerPolicyRuleWithContext(context.Background(), deleteLoadBalancerListenerPolicyRuleOptions) +} + +// DeleteLoadBalancerListenerPolicyRuleWithContext is an alternate form of the DeleteLoadBalancerListenerPolicyRule method which supports a Context parameter +func (vpc *VpcV1) DeleteLoadBalancerListenerPolicyRuleWithContext(ctx context.Context, deleteLoadBalancerListenerPolicyRuleOptions *DeleteLoadBalancerListenerPolicyRuleOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteLoadBalancerListenerPolicyRuleOptions, "deleteLoadBalancerListenerPolicyRuleOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteLoadBalancerListenerPolicyRuleOptions, "deleteLoadBalancerListenerPolicyRuleOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "load_balancer_id": *deleteLoadBalancerListenerPolicyRuleOptions.LoadBalancerID, + "listener_id": *deleteLoadBalancerListenerPolicyRuleOptions.ListenerID, + "policy_id": *deleteLoadBalancerListenerPolicyRuleOptions.PolicyID, + "id": *deleteLoadBalancerListenerPolicyRuleOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers/{load_balancer_id}/listeners/{listener_id}/policies/{policy_id}/rules/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteLoadBalancerListenerPolicyRuleOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteLoadBalancerListenerPolicyRule") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetLoadBalancerListenerPolicyRule : Retrieve a load balancer listener policy rule +// Retrieves a single rule specified by the identifier in the URL path. +func (vpc *VpcV1) GetLoadBalancerListenerPolicyRule(getLoadBalancerListenerPolicyRuleOptions *GetLoadBalancerListenerPolicyRuleOptions) (result *LoadBalancerListenerPolicyRule, response *core.DetailedResponse, err error) { + return vpc.GetLoadBalancerListenerPolicyRuleWithContext(context.Background(), getLoadBalancerListenerPolicyRuleOptions) +} + +// GetLoadBalancerListenerPolicyRuleWithContext is an alternate form of the GetLoadBalancerListenerPolicyRule method which supports a Context parameter +func (vpc *VpcV1) GetLoadBalancerListenerPolicyRuleWithContext(ctx context.Context, getLoadBalancerListenerPolicyRuleOptions *GetLoadBalancerListenerPolicyRuleOptions) (result *LoadBalancerListenerPolicyRule, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getLoadBalancerListenerPolicyRuleOptions, "getLoadBalancerListenerPolicyRuleOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getLoadBalancerListenerPolicyRuleOptions, "getLoadBalancerListenerPolicyRuleOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "load_balancer_id": *getLoadBalancerListenerPolicyRuleOptions.LoadBalancerID, + "listener_id": *getLoadBalancerListenerPolicyRuleOptions.ListenerID, + "policy_id": *getLoadBalancerListenerPolicyRuleOptions.PolicyID, + "id": *getLoadBalancerListenerPolicyRuleOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers/{load_balancer_id}/listeners/{listener_id}/policies/{policy_id}/rules/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getLoadBalancerListenerPolicyRuleOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetLoadBalancerListenerPolicyRule") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalLoadBalancerListenerPolicyRule) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateLoadBalancerListenerPolicyRule : Update a load balancer listener policy rule +// Updates a rule of the load balancer listener policy. +func (vpc *VpcV1) UpdateLoadBalancerListenerPolicyRule(updateLoadBalancerListenerPolicyRuleOptions *UpdateLoadBalancerListenerPolicyRuleOptions) (result *LoadBalancerListenerPolicyRule, response *core.DetailedResponse, err error) { + return vpc.UpdateLoadBalancerListenerPolicyRuleWithContext(context.Background(), updateLoadBalancerListenerPolicyRuleOptions) +} + +// UpdateLoadBalancerListenerPolicyRuleWithContext is an alternate form of the UpdateLoadBalancerListenerPolicyRule method which supports a Context parameter +func (vpc *VpcV1) UpdateLoadBalancerListenerPolicyRuleWithContext(ctx context.Context, updateLoadBalancerListenerPolicyRuleOptions *UpdateLoadBalancerListenerPolicyRuleOptions) (result *LoadBalancerListenerPolicyRule, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateLoadBalancerListenerPolicyRuleOptions, "updateLoadBalancerListenerPolicyRuleOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateLoadBalancerListenerPolicyRuleOptions, "updateLoadBalancerListenerPolicyRuleOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "load_balancer_id": *updateLoadBalancerListenerPolicyRuleOptions.LoadBalancerID, + "listener_id": *updateLoadBalancerListenerPolicyRuleOptions.ListenerID, + "policy_id": *updateLoadBalancerListenerPolicyRuleOptions.PolicyID, + "id": *updateLoadBalancerListenerPolicyRuleOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers/{load_balancer_id}/listeners/{listener_id}/policies/{policy_id}/rules/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateLoadBalancerListenerPolicyRuleOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateLoadBalancerListenerPolicyRule") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateLoadBalancerListenerPolicyRuleOptions.LoadBalancerListenerPolicyRulePatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalLoadBalancerListenerPolicyRule) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListLoadBalancerPools : List all pools of a load balancer +// This request lists all pools of a load balancer. +func (vpc *VpcV1) ListLoadBalancerPools(listLoadBalancerPoolsOptions *ListLoadBalancerPoolsOptions) (result *LoadBalancerPoolCollection, response *core.DetailedResponse, err error) { + return vpc.ListLoadBalancerPoolsWithContext(context.Background(), listLoadBalancerPoolsOptions) +} + +// ListLoadBalancerPoolsWithContext is an alternate form of the ListLoadBalancerPools method which supports a Context parameter +func (vpc *VpcV1) ListLoadBalancerPoolsWithContext(ctx context.Context, listLoadBalancerPoolsOptions *ListLoadBalancerPoolsOptions) (result *LoadBalancerPoolCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listLoadBalancerPoolsOptions, "listLoadBalancerPoolsOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listLoadBalancerPoolsOptions, "listLoadBalancerPoolsOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "load_balancer_id": *listLoadBalancerPoolsOptions.LoadBalancerID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers/{load_balancer_id}/pools`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listLoadBalancerPoolsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListLoadBalancerPools") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalLoadBalancerPoolCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateLoadBalancerPool : Create a load balancer pool +// This request creates a new pool from a pool prototype object. +func (vpc *VpcV1) CreateLoadBalancerPool(createLoadBalancerPoolOptions *CreateLoadBalancerPoolOptions) (result *LoadBalancerPool, response *core.DetailedResponse, err error) { + return vpc.CreateLoadBalancerPoolWithContext(context.Background(), createLoadBalancerPoolOptions) +} + +// CreateLoadBalancerPoolWithContext is an alternate form of the CreateLoadBalancerPool method which supports a Context parameter +func (vpc *VpcV1) CreateLoadBalancerPoolWithContext(ctx context.Context, createLoadBalancerPoolOptions *CreateLoadBalancerPoolOptions) (result *LoadBalancerPool, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createLoadBalancerPoolOptions, "createLoadBalancerPoolOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createLoadBalancerPoolOptions, "createLoadBalancerPoolOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "load_balancer_id": *createLoadBalancerPoolOptions.LoadBalancerID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers/{load_balancer_id}/pools`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range createLoadBalancerPoolOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateLoadBalancerPool") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createLoadBalancerPoolOptions.Algorithm != nil { + body["algorithm"] = createLoadBalancerPoolOptions.Algorithm + } + if createLoadBalancerPoolOptions.HealthMonitor != nil { + body["health_monitor"] = createLoadBalancerPoolOptions.HealthMonitor + } + if createLoadBalancerPoolOptions.Protocol != nil { + body["protocol"] = createLoadBalancerPoolOptions.Protocol + } + if createLoadBalancerPoolOptions.Members != nil { + body["members"] = createLoadBalancerPoolOptions.Members + } + if createLoadBalancerPoolOptions.Name != nil { + body["name"] = createLoadBalancerPoolOptions.Name + } + if createLoadBalancerPoolOptions.ProxyProtocol != nil { + body["proxy_protocol"] = createLoadBalancerPoolOptions.ProxyProtocol + } + if createLoadBalancerPoolOptions.SessionPersistence != nil { + body["session_persistence"] = createLoadBalancerPoolOptions.SessionPersistence + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalLoadBalancerPool) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteLoadBalancerPool : Delete a load balancer pool +// This request deletes a load balancer pool. This operation cannot be reversed. The pool must not currently be the +// default pool for any listener in the load balancer. +func (vpc *VpcV1) DeleteLoadBalancerPool(deleteLoadBalancerPoolOptions *DeleteLoadBalancerPoolOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteLoadBalancerPoolWithContext(context.Background(), deleteLoadBalancerPoolOptions) +} + +// DeleteLoadBalancerPoolWithContext is an alternate form of the DeleteLoadBalancerPool method which supports a Context parameter +func (vpc *VpcV1) DeleteLoadBalancerPoolWithContext(ctx context.Context, deleteLoadBalancerPoolOptions *DeleteLoadBalancerPoolOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteLoadBalancerPoolOptions, "deleteLoadBalancerPoolOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteLoadBalancerPoolOptions, "deleteLoadBalancerPoolOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "load_balancer_id": *deleteLoadBalancerPoolOptions.LoadBalancerID, + "id": *deleteLoadBalancerPoolOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers/{load_balancer_id}/pools/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteLoadBalancerPoolOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteLoadBalancerPool") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetLoadBalancerPool : Retrieve a load balancer pool +// This request retrieves a single pool specified by the identifier in the URL path. +func (vpc *VpcV1) GetLoadBalancerPool(getLoadBalancerPoolOptions *GetLoadBalancerPoolOptions) (result *LoadBalancerPool, response *core.DetailedResponse, err error) { + return vpc.GetLoadBalancerPoolWithContext(context.Background(), getLoadBalancerPoolOptions) +} + +// GetLoadBalancerPoolWithContext is an alternate form of the GetLoadBalancerPool method which supports a Context parameter +func (vpc *VpcV1) GetLoadBalancerPoolWithContext(ctx context.Context, getLoadBalancerPoolOptions *GetLoadBalancerPoolOptions) (result *LoadBalancerPool, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getLoadBalancerPoolOptions, "getLoadBalancerPoolOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getLoadBalancerPoolOptions, "getLoadBalancerPoolOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "load_balancer_id": *getLoadBalancerPoolOptions.LoadBalancerID, + "id": *getLoadBalancerPoolOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers/{load_balancer_id}/pools/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getLoadBalancerPoolOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetLoadBalancerPool") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalLoadBalancerPool) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateLoadBalancerPool : Update a load balancer pool +// This request updates a load balancer pool from a pool patch. +func (vpc *VpcV1) UpdateLoadBalancerPool(updateLoadBalancerPoolOptions *UpdateLoadBalancerPoolOptions) (result *LoadBalancerPool, response *core.DetailedResponse, err error) { + return vpc.UpdateLoadBalancerPoolWithContext(context.Background(), updateLoadBalancerPoolOptions) +} + +// UpdateLoadBalancerPoolWithContext is an alternate form of the UpdateLoadBalancerPool method which supports a Context parameter +func (vpc *VpcV1) UpdateLoadBalancerPoolWithContext(ctx context.Context, updateLoadBalancerPoolOptions *UpdateLoadBalancerPoolOptions) (result *LoadBalancerPool, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateLoadBalancerPoolOptions, "updateLoadBalancerPoolOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateLoadBalancerPoolOptions, "updateLoadBalancerPoolOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "load_balancer_id": *updateLoadBalancerPoolOptions.LoadBalancerID, + "id": *updateLoadBalancerPoolOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers/{load_balancer_id}/pools/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateLoadBalancerPoolOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateLoadBalancerPool") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateLoadBalancerPoolOptions.LoadBalancerPoolPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalLoadBalancerPool) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListLoadBalancerPoolMembers : List all members of a load balancer pool +// This request lists all members of a load balancer pool. +func (vpc *VpcV1) ListLoadBalancerPoolMembers(listLoadBalancerPoolMembersOptions *ListLoadBalancerPoolMembersOptions) (result *LoadBalancerPoolMemberCollection, response *core.DetailedResponse, err error) { + return vpc.ListLoadBalancerPoolMembersWithContext(context.Background(), listLoadBalancerPoolMembersOptions) +} + +// ListLoadBalancerPoolMembersWithContext is an alternate form of the ListLoadBalancerPoolMembers method which supports a Context parameter +func (vpc *VpcV1) ListLoadBalancerPoolMembersWithContext(ctx context.Context, listLoadBalancerPoolMembersOptions *ListLoadBalancerPoolMembersOptions) (result *LoadBalancerPoolMemberCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listLoadBalancerPoolMembersOptions, "listLoadBalancerPoolMembersOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listLoadBalancerPoolMembersOptions, "listLoadBalancerPoolMembersOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "load_balancer_id": *listLoadBalancerPoolMembersOptions.LoadBalancerID, + "pool_id": *listLoadBalancerPoolMembersOptions.PoolID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers/{load_balancer_id}/pools/{pool_id}/members`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listLoadBalancerPoolMembersOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListLoadBalancerPoolMembers") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalLoadBalancerPoolMemberCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateLoadBalancerPoolMember : Create a member in a load balancer pool +// This request creates a new member and adds the member to the pool. +func (vpc *VpcV1) CreateLoadBalancerPoolMember(createLoadBalancerPoolMemberOptions *CreateLoadBalancerPoolMemberOptions) (result *LoadBalancerPoolMember, response *core.DetailedResponse, err error) { + return vpc.CreateLoadBalancerPoolMemberWithContext(context.Background(), createLoadBalancerPoolMemberOptions) +} + +// CreateLoadBalancerPoolMemberWithContext is an alternate form of the CreateLoadBalancerPoolMember method which supports a Context parameter +func (vpc *VpcV1) CreateLoadBalancerPoolMemberWithContext(ctx context.Context, createLoadBalancerPoolMemberOptions *CreateLoadBalancerPoolMemberOptions) (result *LoadBalancerPoolMember, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createLoadBalancerPoolMemberOptions, "createLoadBalancerPoolMemberOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createLoadBalancerPoolMemberOptions, "createLoadBalancerPoolMemberOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "load_balancer_id": *createLoadBalancerPoolMemberOptions.LoadBalancerID, + "pool_id": *createLoadBalancerPoolMemberOptions.PoolID, + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers/{load_balancer_id}/pools/{pool_id}/members`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range createLoadBalancerPoolMemberOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateLoadBalancerPoolMember") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createLoadBalancerPoolMemberOptions.Port != nil { + body["port"] = createLoadBalancerPoolMemberOptions.Port + } + if createLoadBalancerPoolMemberOptions.Target != nil { + body["target"] = createLoadBalancerPoolMemberOptions.Target + } + if createLoadBalancerPoolMemberOptions.Weight != nil { + body["weight"] = createLoadBalancerPoolMemberOptions.Weight + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalLoadBalancerPoolMember) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ReplaceLoadBalancerPoolMembers : Replace load balancer pool members +// This request replaces the existing members of the load balancer pool with new members created from the collection of +// member prototype objects. +func (vpc *VpcV1) ReplaceLoadBalancerPoolMembers(replaceLoadBalancerPoolMembersOptions *ReplaceLoadBalancerPoolMembersOptions) (result *LoadBalancerPoolMemberCollection, response *core.DetailedResponse, err error) { + return vpc.ReplaceLoadBalancerPoolMembersWithContext(context.Background(), replaceLoadBalancerPoolMembersOptions) +} + +// ReplaceLoadBalancerPoolMembersWithContext is an alternate form of the ReplaceLoadBalancerPoolMembers method which supports a Context parameter +func (vpc *VpcV1) ReplaceLoadBalancerPoolMembersWithContext(ctx context.Context, replaceLoadBalancerPoolMembersOptions *ReplaceLoadBalancerPoolMembersOptions) (result *LoadBalancerPoolMemberCollection, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(replaceLoadBalancerPoolMembersOptions, "replaceLoadBalancerPoolMembersOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(replaceLoadBalancerPoolMembersOptions, "replaceLoadBalancerPoolMembersOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "load_balancer_id": *replaceLoadBalancerPoolMembersOptions.LoadBalancerID, + "pool_id": *replaceLoadBalancerPoolMembersOptions.PoolID, + } + + builder := core.NewRequestBuilder(core.PUT) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers/{load_balancer_id}/pools/{pool_id}/members`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range replaceLoadBalancerPoolMembersOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ReplaceLoadBalancerPoolMembers") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if replaceLoadBalancerPoolMembersOptions.Members != nil { + body["members"] = replaceLoadBalancerPoolMembersOptions.Members + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalLoadBalancerPoolMemberCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteLoadBalancerPoolMember : Delete a load balancer pool member +// This request deletes a member from the pool. This operation cannot be reversed. +func (vpc *VpcV1) DeleteLoadBalancerPoolMember(deleteLoadBalancerPoolMemberOptions *DeleteLoadBalancerPoolMemberOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteLoadBalancerPoolMemberWithContext(context.Background(), deleteLoadBalancerPoolMemberOptions) +} + +// DeleteLoadBalancerPoolMemberWithContext is an alternate form of the DeleteLoadBalancerPoolMember method which supports a Context parameter +func (vpc *VpcV1) DeleteLoadBalancerPoolMemberWithContext(ctx context.Context, deleteLoadBalancerPoolMemberOptions *DeleteLoadBalancerPoolMemberOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteLoadBalancerPoolMemberOptions, "deleteLoadBalancerPoolMemberOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteLoadBalancerPoolMemberOptions, "deleteLoadBalancerPoolMemberOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "load_balancer_id": *deleteLoadBalancerPoolMemberOptions.LoadBalancerID, + "pool_id": *deleteLoadBalancerPoolMemberOptions.PoolID, + "id": *deleteLoadBalancerPoolMemberOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers/{load_balancer_id}/pools/{pool_id}/members/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteLoadBalancerPoolMemberOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteLoadBalancerPoolMember") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetLoadBalancerPoolMember : Retrieve a load balancer pool member +// This request retrieves a single member specified by the identifier in the URL path. +func (vpc *VpcV1) GetLoadBalancerPoolMember(getLoadBalancerPoolMemberOptions *GetLoadBalancerPoolMemberOptions) (result *LoadBalancerPoolMember, response *core.DetailedResponse, err error) { + return vpc.GetLoadBalancerPoolMemberWithContext(context.Background(), getLoadBalancerPoolMemberOptions) +} + +// GetLoadBalancerPoolMemberWithContext is an alternate form of the GetLoadBalancerPoolMember method which supports a Context parameter +func (vpc *VpcV1) GetLoadBalancerPoolMemberWithContext(ctx context.Context, getLoadBalancerPoolMemberOptions *GetLoadBalancerPoolMemberOptions) (result *LoadBalancerPoolMember, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getLoadBalancerPoolMemberOptions, "getLoadBalancerPoolMemberOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getLoadBalancerPoolMemberOptions, "getLoadBalancerPoolMemberOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "load_balancer_id": *getLoadBalancerPoolMemberOptions.LoadBalancerID, + "pool_id": *getLoadBalancerPoolMemberOptions.PoolID, + "id": *getLoadBalancerPoolMemberOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers/{load_balancer_id}/pools/{pool_id}/members/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getLoadBalancerPoolMemberOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetLoadBalancerPoolMember") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalLoadBalancerPoolMember) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateLoadBalancerPoolMember : Update a load balancer pool member +// This request updates an existing member from a member patch. +func (vpc *VpcV1) UpdateLoadBalancerPoolMember(updateLoadBalancerPoolMemberOptions *UpdateLoadBalancerPoolMemberOptions) (result *LoadBalancerPoolMember, response *core.DetailedResponse, err error) { + return vpc.UpdateLoadBalancerPoolMemberWithContext(context.Background(), updateLoadBalancerPoolMemberOptions) +} + +// UpdateLoadBalancerPoolMemberWithContext is an alternate form of the UpdateLoadBalancerPoolMember method which supports a Context parameter +func (vpc *VpcV1) UpdateLoadBalancerPoolMemberWithContext(ctx context.Context, updateLoadBalancerPoolMemberOptions *UpdateLoadBalancerPoolMemberOptions) (result *LoadBalancerPoolMember, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateLoadBalancerPoolMemberOptions, "updateLoadBalancerPoolMemberOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateLoadBalancerPoolMemberOptions, "updateLoadBalancerPoolMemberOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "load_balancer_id": *updateLoadBalancerPoolMemberOptions.LoadBalancerID, + "pool_id": *updateLoadBalancerPoolMemberOptions.PoolID, + "id": *updateLoadBalancerPoolMemberOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/load_balancers/{load_balancer_id}/pools/{pool_id}/members/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateLoadBalancerPoolMemberOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateLoadBalancerPoolMember") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateLoadBalancerPoolMemberOptions.LoadBalancerPoolMemberPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalLoadBalancerPoolMember) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListEndpointGateways : List all endpoint gateways +// This request lists all endpoint gateways in the region. An endpoint gateway maps one or more reserved IPs in a VPC to +// a target outside the VPC. +func (vpc *VpcV1) ListEndpointGateways(listEndpointGatewaysOptions *ListEndpointGatewaysOptions) (result *EndpointGatewayCollection, response *core.DetailedResponse, err error) { + return vpc.ListEndpointGatewaysWithContext(context.Background(), listEndpointGatewaysOptions) +} + +// ListEndpointGatewaysWithContext is an alternate form of the ListEndpointGateways method which supports a Context parameter +func (vpc *VpcV1) ListEndpointGatewaysWithContext(ctx context.Context, listEndpointGatewaysOptions *ListEndpointGatewaysOptions) (result *EndpointGatewayCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listEndpointGatewaysOptions, "listEndpointGatewaysOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/endpoint_gateways`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listEndpointGatewaysOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListEndpointGateways") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listEndpointGatewaysOptions.Name != nil { + builder.AddQuery("name", fmt.Sprint(*listEndpointGatewaysOptions.Name)) + } + if listEndpointGatewaysOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listEndpointGatewaysOptions.Start)) + } + if listEndpointGatewaysOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listEndpointGatewaysOptions.Limit)) + } + if listEndpointGatewaysOptions.ResourceGroupID != nil { + builder.AddQuery("resource_group.id", fmt.Sprint(*listEndpointGatewaysOptions.ResourceGroupID)) + } + if listEndpointGatewaysOptions.VPCID != nil { + builder.AddQuery("vpc.id", fmt.Sprint(*listEndpointGatewaysOptions.VPCID)) + } + if listEndpointGatewaysOptions.VPCCRN != nil { + builder.AddQuery("vpc.crn", fmt.Sprint(*listEndpointGatewaysOptions.VPCCRN)) + } + if listEndpointGatewaysOptions.VPCName != nil { + builder.AddQuery("vpc.name", fmt.Sprint(*listEndpointGatewaysOptions.VPCName)) + } + if listEndpointGatewaysOptions.AllowDnsResolutionBinding != nil { + builder.AddQuery("allow_dns_resolution_binding", fmt.Sprint(*listEndpointGatewaysOptions.AllowDnsResolutionBinding)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalEndpointGatewayCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateEndpointGateway : Create an endpoint gateway +// This request creates a new endpoint gateway. An endpoint gateway maps one or more reserved IPs in a VPC to a target +// outside the VPC. +func (vpc *VpcV1) CreateEndpointGateway(createEndpointGatewayOptions *CreateEndpointGatewayOptions) (result *EndpointGateway, response *core.DetailedResponse, err error) { + return vpc.CreateEndpointGatewayWithContext(context.Background(), createEndpointGatewayOptions) +} + +// CreateEndpointGatewayWithContext is an alternate form of the CreateEndpointGateway method which supports a Context parameter +func (vpc *VpcV1) CreateEndpointGatewayWithContext(ctx context.Context, createEndpointGatewayOptions *CreateEndpointGatewayOptions) (result *EndpointGateway, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createEndpointGatewayOptions, "createEndpointGatewayOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createEndpointGatewayOptions, "createEndpointGatewayOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/endpoint_gateways`, nil) + if err != nil { + return + } + + for headerName, headerValue := range createEndpointGatewayOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateEndpointGateway") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createEndpointGatewayOptions.Target != nil { + body["target"] = createEndpointGatewayOptions.Target + } + if createEndpointGatewayOptions.VPC != nil { + body["vpc"] = createEndpointGatewayOptions.VPC + } + if createEndpointGatewayOptions.AllowDnsResolutionBinding != nil { + body["allow_dns_resolution_binding"] = createEndpointGatewayOptions.AllowDnsResolutionBinding + } + if createEndpointGatewayOptions.Ips != nil { + body["ips"] = createEndpointGatewayOptions.Ips + } + if createEndpointGatewayOptions.Name != nil { + body["name"] = createEndpointGatewayOptions.Name + } + if createEndpointGatewayOptions.ResourceGroup != nil { + body["resource_group"] = createEndpointGatewayOptions.ResourceGroup + } + if createEndpointGatewayOptions.SecurityGroups != nil { + body["security_groups"] = createEndpointGatewayOptions.SecurityGroups + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalEndpointGateway) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListEndpointGatewayIps : List all reserved IPs bound to an endpoint gateway +// This request lists all reserved IPs bound to an endpoint gateway. +func (vpc *VpcV1) ListEndpointGatewayIps(listEndpointGatewayIpsOptions *ListEndpointGatewayIpsOptions) (result *ReservedIPCollectionEndpointGatewayContext, response *core.DetailedResponse, err error) { + return vpc.ListEndpointGatewayIpsWithContext(context.Background(), listEndpointGatewayIpsOptions) +} + +// ListEndpointGatewayIpsWithContext is an alternate form of the ListEndpointGatewayIps method which supports a Context parameter +func (vpc *VpcV1) ListEndpointGatewayIpsWithContext(ctx context.Context, listEndpointGatewayIpsOptions *ListEndpointGatewayIpsOptions) (result *ReservedIPCollectionEndpointGatewayContext, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(listEndpointGatewayIpsOptions, "listEndpointGatewayIpsOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(listEndpointGatewayIpsOptions, "listEndpointGatewayIpsOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "endpoint_gateway_id": *listEndpointGatewayIpsOptions.EndpointGatewayID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/endpoint_gateways/{endpoint_gateway_id}/ips`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range listEndpointGatewayIpsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListEndpointGatewayIps") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listEndpointGatewayIpsOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listEndpointGatewayIpsOptions.Start)) + } + if listEndpointGatewayIpsOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listEndpointGatewayIpsOptions.Limit)) + } + if listEndpointGatewayIpsOptions.Sort != nil { + builder.AddQuery("sort", fmt.Sprint(*listEndpointGatewayIpsOptions.Sort)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalReservedIPCollectionEndpointGatewayContext) + if err != nil { + return + } + response.Result = result + } + + return +} + +// RemoveEndpointGatewayIP : Unbind a reserved IP from an endpoint gateway +// This request unbinds the specified reserved IP from the specified endpoint gateway. If the reserved IP has +// `auto_delete` set to `true`, the reserved IP will be deleted. +func (vpc *VpcV1) RemoveEndpointGatewayIP(removeEndpointGatewayIPOptions *RemoveEndpointGatewayIPOptions) (response *core.DetailedResponse, err error) { + return vpc.RemoveEndpointGatewayIPWithContext(context.Background(), removeEndpointGatewayIPOptions) +} + +// RemoveEndpointGatewayIPWithContext is an alternate form of the RemoveEndpointGatewayIP method which supports a Context parameter +func (vpc *VpcV1) RemoveEndpointGatewayIPWithContext(ctx context.Context, removeEndpointGatewayIPOptions *RemoveEndpointGatewayIPOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(removeEndpointGatewayIPOptions, "removeEndpointGatewayIPOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(removeEndpointGatewayIPOptions, "removeEndpointGatewayIPOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "endpoint_gateway_id": *removeEndpointGatewayIPOptions.EndpointGatewayID, + "id": *removeEndpointGatewayIPOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/endpoint_gateways/{endpoint_gateway_id}/ips/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range removeEndpointGatewayIPOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "RemoveEndpointGatewayIP") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetEndpointGatewayIP : Retrieve a reserved IP bound to an endpoint gateway +// This request retrieves the specified reserved IP address if it is bound to the endpoint gateway specified in the URL. +func (vpc *VpcV1) GetEndpointGatewayIP(getEndpointGatewayIPOptions *GetEndpointGatewayIPOptions) (result *ReservedIP, response *core.DetailedResponse, err error) { + return vpc.GetEndpointGatewayIPWithContext(context.Background(), getEndpointGatewayIPOptions) +} + +// GetEndpointGatewayIPWithContext is an alternate form of the GetEndpointGatewayIP method which supports a Context parameter +func (vpc *VpcV1) GetEndpointGatewayIPWithContext(ctx context.Context, getEndpointGatewayIPOptions *GetEndpointGatewayIPOptions) (result *ReservedIP, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getEndpointGatewayIPOptions, "getEndpointGatewayIPOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getEndpointGatewayIPOptions, "getEndpointGatewayIPOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "endpoint_gateway_id": *getEndpointGatewayIPOptions.EndpointGatewayID, + "id": *getEndpointGatewayIPOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/endpoint_gateways/{endpoint_gateway_id}/ips/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getEndpointGatewayIPOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetEndpointGatewayIP") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalReservedIP) + if err != nil { + return + } + response.Result = result + } + + return +} + +// AddEndpointGatewayIP : Bind a reserved IP to an endpoint gateway +// This request binds the specified reserved IP to the specified endpoint gateway. The reserved IP: +// +// - must currently be unbound +// - must not be in the same zone as any other reserved IP bound to the endpoint gateway. +func (vpc *VpcV1) AddEndpointGatewayIP(addEndpointGatewayIPOptions *AddEndpointGatewayIPOptions) (result *ReservedIP, response *core.DetailedResponse, err error) { + return vpc.AddEndpointGatewayIPWithContext(context.Background(), addEndpointGatewayIPOptions) +} + +// AddEndpointGatewayIPWithContext is an alternate form of the AddEndpointGatewayIP method which supports a Context parameter +func (vpc *VpcV1) AddEndpointGatewayIPWithContext(ctx context.Context, addEndpointGatewayIPOptions *AddEndpointGatewayIPOptions) (result *ReservedIP, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(addEndpointGatewayIPOptions, "addEndpointGatewayIPOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(addEndpointGatewayIPOptions, "addEndpointGatewayIPOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "endpoint_gateway_id": *addEndpointGatewayIPOptions.EndpointGatewayID, + "id": *addEndpointGatewayIPOptions.ID, + } + + builder := core.NewRequestBuilder(core.PUT) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/endpoint_gateways/{endpoint_gateway_id}/ips/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range addEndpointGatewayIPOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "AddEndpointGatewayIP") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalReservedIP) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteEndpointGateway : Delete an endpoint gateway +// This request deletes an endpoint gateway. This operation cannot be reversed. +// +// Reserved IPs that were bound to the endpoint gateway will be released if their +// `auto_delete` property is set to true. +func (vpc *VpcV1) DeleteEndpointGateway(deleteEndpointGatewayOptions *DeleteEndpointGatewayOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteEndpointGatewayWithContext(context.Background(), deleteEndpointGatewayOptions) +} + +// DeleteEndpointGatewayWithContext is an alternate form of the DeleteEndpointGateway method which supports a Context parameter +func (vpc *VpcV1) DeleteEndpointGatewayWithContext(ctx context.Context, deleteEndpointGatewayOptions *DeleteEndpointGatewayOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteEndpointGatewayOptions, "deleteEndpointGatewayOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteEndpointGatewayOptions, "deleteEndpointGatewayOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *deleteEndpointGatewayOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/endpoint_gateways/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteEndpointGatewayOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteEndpointGateway") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetEndpointGateway : Retrieve an endpoint gateway +// This request retrieves a single endpoint gateway specified by the identifier in the URL. +func (vpc *VpcV1) GetEndpointGateway(getEndpointGatewayOptions *GetEndpointGatewayOptions) (result *EndpointGateway, response *core.DetailedResponse, err error) { + return vpc.GetEndpointGatewayWithContext(context.Background(), getEndpointGatewayOptions) +} + +// GetEndpointGatewayWithContext is an alternate form of the GetEndpointGateway method which supports a Context parameter +func (vpc *VpcV1) GetEndpointGatewayWithContext(ctx context.Context, getEndpointGatewayOptions *GetEndpointGatewayOptions) (result *EndpointGateway, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getEndpointGatewayOptions, "getEndpointGatewayOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getEndpointGatewayOptions, "getEndpointGatewayOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getEndpointGatewayOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/endpoint_gateways/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getEndpointGatewayOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetEndpointGateway") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalEndpointGateway) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateEndpointGateway : Update an endpoint gateway +// This request updates an endpoint gateway's name. +func (vpc *VpcV1) UpdateEndpointGateway(updateEndpointGatewayOptions *UpdateEndpointGatewayOptions) (result *EndpointGateway, response *core.DetailedResponse, err error) { + return vpc.UpdateEndpointGatewayWithContext(context.Background(), updateEndpointGatewayOptions) +} + +// UpdateEndpointGatewayWithContext is an alternate form of the UpdateEndpointGateway method which supports a Context parameter +func (vpc *VpcV1) UpdateEndpointGatewayWithContext(ctx context.Context, updateEndpointGatewayOptions *UpdateEndpointGatewayOptions) (result *EndpointGateway, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateEndpointGatewayOptions, "updateEndpointGatewayOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateEndpointGatewayOptions, "updateEndpointGatewayOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *updateEndpointGatewayOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/endpoint_gateways/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateEndpointGatewayOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateEndpointGateway") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateEndpointGatewayOptions.EndpointGatewayPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalEndpointGateway) + if err != nil { + return + } + response.Result = result + } + + return +} + +// ListFlowLogCollectors : List all flow log collectors +// This request lists all flow log collectors in the region. A flow log collector summarizes data sent over the instance +// network interfaces contained within its target. +func (vpc *VpcV1) ListFlowLogCollectors(listFlowLogCollectorsOptions *ListFlowLogCollectorsOptions) (result *FlowLogCollectorCollection, response *core.DetailedResponse, err error) { + return vpc.ListFlowLogCollectorsWithContext(context.Background(), listFlowLogCollectorsOptions) +} + +// ListFlowLogCollectorsWithContext is an alternate form of the ListFlowLogCollectors method which supports a Context parameter +func (vpc *VpcV1) ListFlowLogCollectorsWithContext(ctx context.Context, listFlowLogCollectorsOptions *ListFlowLogCollectorsOptions) (result *FlowLogCollectorCollection, response *core.DetailedResponse, err error) { + err = core.ValidateStruct(listFlowLogCollectorsOptions, "listFlowLogCollectorsOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/flow_log_collectors`, nil) + if err != nil { + return + } + + for headerName, headerValue := range listFlowLogCollectorsOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "ListFlowLogCollectors") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + if listFlowLogCollectorsOptions.Start != nil { + builder.AddQuery("start", fmt.Sprint(*listFlowLogCollectorsOptions.Start)) + } + if listFlowLogCollectorsOptions.Limit != nil { + builder.AddQuery("limit", fmt.Sprint(*listFlowLogCollectorsOptions.Limit)) + } + if listFlowLogCollectorsOptions.ResourceGroupID != nil { + builder.AddQuery("resource_group.id", fmt.Sprint(*listFlowLogCollectorsOptions.ResourceGroupID)) + } + if listFlowLogCollectorsOptions.Name != nil { + builder.AddQuery("name", fmt.Sprint(*listFlowLogCollectorsOptions.Name)) + } + if listFlowLogCollectorsOptions.VPCID != nil { + builder.AddQuery("vpc.id", fmt.Sprint(*listFlowLogCollectorsOptions.VPCID)) + } + if listFlowLogCollectorsOptions.VPCCRN != nil { + builder.AddQuery("vpc.crn", fmt.Sprint(*listFlowLogCollectorsOptions.VPCCRN)) + } + if listFlowLogCollectorsOptions.VPCName != nil { + builder.AddQuery("vpc.name", fmt.Sprint(*listFlowLogCollectorsOptions.VPCName)) + } + if listFlowLogCollectorsOptions.TargetID != nil { + builder.AddQuery("target.id", fmt.Sprint(*listFlowLogCollectorsOptions.TargetID)) + } + if listFlowLogCollectorsOptions.TargetResourceType != nil { + builder.AddQuery("target.resource_type", fmt.Sprint(*listFlowLogCollectorsOptions.TargetResourceType)) + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalFlowLogCollectorCollection) + if err != nil { + return + } + response.Result = result + } + + return +} + +// CreateFlowLogCollector : Create a flow log collector +// This request creates and starts a new flow log collector from a flow log collector prototype object. The prototype +// object is structured in the same way as a retrieved flow log collector, and contains the information necessary to +// create and start the new flow log collector. +func (vpc *VpcV1) CreateFlowLogCollector(createFlowLogCollectorOptions *CreateFlowLogCollectorOptions) (result *FlowLogCollector, response *core.DetailedResponse, err error) { + return vpc.CreateFlowLogCollectorWithContext(context.Background(), createFlowLogCollectorOptions) +} + +// CreateFlowLogCollectorWithContext is an alternate form of the CreateFlowLogCollector method which supports a Context parameter +func (vpc *VpcV1) CreateFlowLogCollectorWithContext(ctx context.Context, createFlowLogCollectorOptions *CreateFlowLogCollectorOptions) (result *FlowLogCollector, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(createFlowLogCollectorOptions, "createFlowLogCollectorOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(createFlowLogCollectorOptions, "createFlowLogCollectorOptions") + if err != nil { + return + } + + builder := core.NewRequestBuilder(core.POST) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/flow_log_collectors`, nil) + if err != nil { + return + } + + for headerName, headerValue := range createFlowLogCollectorOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "CreateFlowLogCollector") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + body := make(map[string]interface{}) + if createFlowLogCollectorOptions.StorageBucket != nil { + body["storage_bucket"] = createFlowLogCollectorOptions.StorageBucket + } + if createFlowLogCollectorOptions.Target != nil { + body["target"] = createFlowLogCollectorOptions.Target + } + if createFlowLogCollectorOptions.Active != nil { + body["active"] = createFlowLogCollectorOptions.Active + } + if createFlowLogCollectorOptions.Name != nil { + body["name"] = createFlowLogCollectorOptions.Name + } + if createFlowLogCollectorOptions.ResourceGroup != nil { + body["resource_group"] = createFlowLogCollectorOptions.ResourceGroup + } + _, err = builder.SetBodyContentJSON(body) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalFlowLogCollector) + if err != nil { + return + } + response.Result = result + } + + return +} + +// DeleteFlowLogCollector : Delete a flow log collector +// This request stops and deletes a flow log collector. This operation cannot be reversed. +// +// Collected flow logs remain available within the flow log collector's Cloud Object Storage bucket. +func (vpc *VpcV1) DeleteFlowLogCollector(deleteFlowLogCollectorOptions *DeleteFlowLogCollectorOptions) (response *core.DetailedResponse, err error) { + return vpc.DeleteFlowLogCollectorWithContext(context.Background(), deleteFlowLogCollectorOptions) +} + +// DeleteFlowLogCollectorWithContext is an alternate form of the DeleteFlowLogCollector method which supports a Context parameter +func (vpc *VpcV1) DeleteFlowLogCollectorWithContext(ctx context.Context, deleteFlowLogCollectorOptions *DeleteFlowLogCollectorOptions) (response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(deleteFlowLogCollectorOptions, "deleteFlowLogCollectorOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(deleteFlowLogCollectorOptions, "deleteFlowLogCollectorOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *deleteFlowLogCollectorOptions.ID, + } + + builder := core.NewRequestBuilder(core.DELETE) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/flow_log_collectors/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range deleteFlowLogCollectorOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "DeleteFlowLogCollector") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + response, err = vpc.Service.Request(request, nil) + + return +} + +// GetFlowLogCollector : Retrieve a flow log collector +// This request retrieves a single flow log collector specified by the identifier in the URL. +func (vpc *VpcV1) GetFlowLogCollector(getFlowLogCollectorOptions *GetFlowLogCollectorOptions) (result *FlowLogCollector, response *core.DetailedResponse, err error) { + return vpc.GetFlowLogCollectorWithContext(context.Background(), getFlowLogCollectorOptions) +} + +// GetFlowLogCollectorWithContext is an alternate form of the GetFlowLogCollector method which supports a Context parameter +func (vpc *VpcV1) GetFlowLogCollectorWithContext(ctx context.Context, getFlowLogCollectorOptions *GetFlowLogCollectorOptions) (result *FlowLogCollector, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(getFlowLogCollectorOptions, "getFlowLogCollectorOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(getFlowLogCollectorOptions, "getFlowLogCollectorOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *getFlowLogCollectorOptions.ID, + } + + builder := core.NewRequestBuilder(core.GET) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/flow_log_collectors/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range getFlowLogCollectorOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "GetFlowLogCollector") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalFlowLogCollector) + if err != nil { + return + } + response.Result = result + } + + return +} + +// UpdateFlowLogCollector : Update a flow log collector +// This request updates a flow log collector with the information in a provided flow log collector patch. The flow log +// collector patch object is structured in the same way as a retrieved flow log collector and contains only the +// information to be updated. +func (vpc *VpcV1) UpdateFlowLogCollector(updateFlowLogCollectorOptions *UpdateFlowLogCollectorOptions) (result *FlowLogCollector, response *core.DetailedResponse, err error) { + return vpc.UpdateFlowLogCollectorWithContext(context.Background(), updateFlowLogCollectorOptions) +} + +// UpdateFlowLogCollectorWithContext is an alternate form of the UpdateFlowLogCollector method which supports a Context parameter +func (vpc *VpcV1) UpdateFlowLogCollectorWithContext(ctx context.Context, updateFlowLogCollectorOptions *UpdateFlowLogCollectorOptions) (result *FlowLogCollector, response *core.DetailedResponse, err error) { + err = core.ValidateNotNil(updateFlowLogCollectorOptions, "updateFlowLogCollectorOptions cannot be nil") + if err != nil { + return + } + err = core.ValidateStruct(updateFlowLogCollectorOptions, "updateFlowLogCollectorOptions") + if err != nil { + return + } + + pathParamsMap := map[string]string{ + "id": *updateFlowLogCollectorOptions.ID, + } + + builder := core.NewRequestBuilder(core.PATCH) + builder = builder.WithContext(ctx) + builder.EnableGzipCompression = vpc.GetEnableGzipCompression() + _, err = builder.ResolveRequestURL(vpc.Service.Options.URL, `/flow_log_collectors/{id}`, pathParamsMap) + if err != nil { + return + } + + for headerName, headerValue := range updateFlowLogCollectorOptions.Headers { + builder.AddHeader(headerName, headerValue) + } + + sdkHeaders := common.GetSdkHeaders("vpc", "V1", "UpdateFlowLogCollector") + for headerName, headerValue := range sdkHeaders { + builder.AddHeader(headerName, headerValue) + } + builder.AddHeader("Accept", "application/json") + builder.AddHeader("Content-Type", "application/merge-patch+json") + + builder.AddQuery("version", fmt.Sprint(*vpc.Version)) + builder.AddQuery("generation", fmt.Sprint(*vpc.generation)) + + _, err = builder.SetBodyContentJSON(updateFlowLogCollectorOptions.FlowLogCollectorPatch) + if err != nil { + return + } + + request, err := builder.Build() + if err != nil { + return + } + + var rawResponse map[string]json.RawMessage + response, err = vpc.Service.Request(request, &rawResponse) + if err != nil { + return + } + if rawResponse != nil { + err = core.UnmarshalModel(rawResponse, "", &result, UnmarshalFlowLogCollector) + if err != nil { + return + } + response.Result = result + } + + return +} + +// AccountReference : AccountReference struct +type AccountReference struct { + // The unique identifier for this account. + ID *string `json:"id" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the AccountReference.ResourceType property. +// The resource type. +const ( + AccountReferenceResourceTypeAccountConst = "account" +) + +// UnmarshalAccountReference unmarshals an instance of AccountReference from the specified map of raw messages. +func UnmarshalAccountReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(AccountReference) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AddBareMetalServerNetworkInterfaceFloatingIPOptions : The AddBareMetalServerNetworkInterfaceFloatingIP options. +type AddBareMetalServerNetworkInterfaceFloatingIPOptions struct { + // The bare metal server identifier. + BareMetalServerID *string `json:"bare_metal_server_id" validate:"required,ne="` + + // The bare metal server network interface identifier. + NetworkInterfaceID *string `json:"network_interface_id" validate:"required,ne="` + + // The floating IP identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewAddBareMetalServerNetworkInterfaceFloatingIPOptions : Instantiate AddBareMetalServerNetworkInterfaceFloatingIPOptions +func (*VpcV1) NewAddBareMetalServerNetworkInterfaceFloatingIPOptions(bareMetalServerID string, networkInterfaceID string, id string) *AddBareMetalServerNetworkInterfaceFloatingIPOptions { + return &AddBareMetalServerNetworkInterfaceFloatingIPOptions{ + BareMetalServerID: core.StringPtr(bareMetalServerID), + NetworkInterfaceID: core.StringPtr(networkInterfaceID), + ID: core.StringPtr(id), + } +} + +// SetBareMetalServerID : Allow user to set BareMetalServerID +func (_options *AddBareMetalServerNetworkInterfaceFloatingIPOptions) SetBareMetalServerID(bareMetalServerID string) *AddBareMetalServerNetworkInterfaceFloatingIPOptions { + _options.BareMetalServerID = core.StringPtr(bareMetalServerID) + return _options +} + +// SetNetworkInterfaceID : Allow user to set NetworkInterfaceID +func (_options *AddBareMetalServerNetworkInterfaceFloatingIPOptions) SetNetworkInterfaceID(networkInterfaceID string) *AddBareMetalServerNetworkInterfaceFloatingIPOptions { + _options.NetworkInterfaceID = core.StringPtr(networkInterfaceID) + return _options +} + +// SetID : Allow user to set ID +func (_options *AddBareMetalServerNetworkInterfaceFloatingIPOptions) SetID(id string) *AddBareMetalServerNetworkInterfaceFloatingIPOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *AddBareMetalServerNetworkInterfaceFloatingIPOptions) SetHeaders(param map[string]string) *AddBareMetalServerNetworkInterfaceFloatingIPOptions { + options.Headers = param + return options +} + +// AddEndpointGatewayIPOptions : The AddEndpointGatewayIP options. +type AddEndpointGatewayIPOptions struct { + // The endpoint gateway identifier. + EndpointGatewayID *string `json:"endpoint_gateway_id" validate:"required,ne="` + + // The reserved IP identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewAddEndpointGatewayIPOptions : Instantiate AddEndpointGatewayIPOptions +func (*VpcV1) NewAddEndpointGatewayIPOptions(endpointGatewayID string, id string) *AddEndpointGatewayIPOptions { + return &AddEndpointGatewayIPOptions{ + EndpointGatewayID: core.StringPtr(endpointGatewayID), + ID: core.StringPtr(id), + } +} + +// SetEndpointGatewayID : Allow user to set EndpointGatewayID +func (_options *AddEndpointGatewayIPOptions) SetEndpointGatewayID(endpointGatewayID string) *AddEndpointGatewayIPOptions { + _options.EndpointGatewayID = core.StringPtr(endpointGatewayID) + return _options +} + +// SetID : Allow user to set ID +func (_options *AddEndpointGatewayIPOptions) SetID(id string) *AddEndpointGatewayIPOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *AddEndpointGatewayIPOptions) SetHeaders(param map[string]string) *AddEndpointGatewayIPOptions { + options.Headers = param + return options +} + +// AddInstanceNetworkInterfaceFloatingIPOptions : The AddInstanceNetworkInterfaceFloatingIP options. +type AddInstanceNetworkInterfaceFloatingIPOptions struct { + // The virtual server instance identifier. + InstanceID *string `json:"instance_id" validate:"required,ne="` + + // The instance network interface identifier. + NetworkInterfaceID *string `json:"network_interface_id" validate:"required,ne="` + + // The floating IP identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewAddInstanceNetworkInterfaceFloatingIPOptions : Instantiate AddInstanceNetworkInterfaceFloatingIPOptions +func (*VpcV1) NewAddInstanceNetworkInterfaceFloatingIPOptions(instanceID string, networkInterfaceID string, id string) *AddInstanceNetworkInterfaceFloatingIPOptions { + return &AddInstanceNetworkInterfaceFloatingIPOptions{ + InstanceID: core.StringPtr(instanceID), + NetworkInterfaceID: core.StringPtr(networkInterfaceID), + ID: core.StringPtr(id), + } +} + +// SetInstanceID : Allow user to set InstanceID +func (_options *AddInstanceNetworkInterfaceFloatingIPOptions) SetInstanceID(instanceID string) *AddInstanceNetworkInterfaceFloatingIPOptions { + _options.InstanceID = core.StringPtr(instanceID) + return _options +} + +// SetNetworkInterfaceID : Allow user to set NetworkInterfaceID +func (_options *AddInstanceNetworkInterfaceFloatingIPOptions) SetNetworkInterfaceID(networkInterfaceID string) *AddInstanceNetworkInterfaceFloatingIPOptions { + _options.NetworkInterfaceID = core.StringPtr(networkInterfaceID) + return _options +} + +// SetID : Allow user to set ID +func (_options *AddInstanceNetworkInterfaceFloatingIPOptions) SetID(id string) *AddInstanceNetworkInterfaceFloatingIPOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *AddInstanceNetworkInterfaceFloatingIPOptions) SetHeaders(param map[string]string) *AddInstanceNetworkInterfaceFloatingIPOptions { + options.Headers = param + return options +} + +// AddVPNGatewayConnectionLocalCIDROptions : The AddVPNGatewayConnectionLocalCIDR options. +type AddVPNGatewayConnectionLocalCIDROptions struct { + // The VPN gateway identifier. + VPNGatewayID *string `json:"vpn_gateway_id" validate:"required,ne="` + + // The VPN gateway connection identifier. + ID *string `json:"id" validate:"required,ne="` + + // The address prefix part of the CIDR. + CIDRPrefix *string `json:"cidr_prefix" validate:"required,ne="` + + // The prefix length part of the CIDR. + PrefixLength *string `json:"prefix_length" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewAddVPNGatewayConnectionLocalCIDROptions : Instantiate AddVPNGatewayConnectionLocalCIDROptions +func (*VpcV1) NewAddVPNGatewayConnectionLocalCIDROptions(vpnGatewayID string, id string, cidrPrefix string, prefixLength string) *AddVPNGatewayConnectionLocalCIDROptions { + return &AddVPNGatewayConnectionLocalCIDROptions{ + VPNGatewayID: core.StringPtr(vpnGatewayID), + ID: core.StringPtr(id), + CIDRPrefix: core.StringPtr(cidrPrefix), + PrefixLength: core.StringPtr(prefixLength), + } +} + +// SetVPNGatewayID : Allow user to set VPNGatewayID +func (_options *AddVPNGatewayConnectionLocalCIDROptions) SetVPNGatewayID(vpnGatewayID string) *AddVPNGatewayConnectionLocalCIDROptions { + _options.VPNGatewayID = core.StringPtr(vpnGatewayID) + return _options +} + +// SetID : Allow user to set ID +func (_options *AddVPNGatewayConnectionLocalCIDROptions) SetID(id string) *AddVPNGatewayConnectionLocalCIDROptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetCIDRPrefix : Allow user to set CIDRPrefix +func (_options *AddVPNGatewayConnectionLocalCIDROptions) SetCIDRPrefix(cidrPrefix string) *AddVPNGatewayConnectionLocalCIDROptions { + _options.CIDRPrefix = core.StringPtr(cidrPrefix) + return _options +} + +// SetPrefixLength : Allow user to set PrefixLength +func (_options *AddVPNGatewayConnectionLocalCIDROptions) SetPrefixLength(prefixLength string) *AddVPNGatewayConnectionLocalCIDROptions { + _options.PrefixLength = core.StringPtr(prefixLength) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *AddVPNGatewayConnectionLocalCIDROptions) SetHeaders(param map[string]string) *AddVPNGatewayConnectionLocalCIDROptions { + options.Headers = param + return options +} + +// AddVPNGatewayConnectionPeerCIDROptions : The AddVPNGatewayConnectionPeerCIDR options. +type AddVPNGatewayConnectionPeerCIDROptions struct { + // The VPN gateway identifier. + VPNGatewayID *string `json:"vpn_gateway_id" validate:"required,ne="` + + // The VPN gateway connection identifier. + ID *string `json:"id" validate:"required,ne="` + + // The address prefix part of the CIDR. + CIDRPrefix *string `json:"cidr_prefix" validate:"required,ne="` + + // The prefix length part of the CIDR. + PrefixLength *string `json:"prefix_length" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewAddVPNGatewayConnectionPeerCIDROptions : Instantiate AddVPNGatewayConnectionPeerCIDROptions +func (*VpcV1) NewAddVPNGatewayConnectionPeerCIDROptions(vpnGatewayID string, id string, cidrPrefix string, prefixLength string) *AddVPNGatewayConnectionPeerCIDROptions { + return &AddVPNGatewayConnectionPeerCIDROptions{ + VPNGatewayID: core.StringPtr(vpnGatewayID), + ID: core.StringPtr(id), + CIDRPrefix: core.StringPtr(cidrPrefix), + PrefixLength: core.StringPtr(prefixLength), + } +} + +// SetVPNGatewayID : Allow user to set VPNGatewayID +func (_options *AddVPNGatewayConnectionPeerCIDROptions) SetVPNGatewayID(vpnGatewayID string) *AddVPNGatewayConnectionPeerCIDROptions { + _options.VPNGatewayID = core.StringPtr(vpnGatewayID) + return _options +} + +// SetID : Allow user to set ID +func (_options *AddVPNGatewayConnectionPeerCIDROptions) SetID(id string) *AddVPNGatewayConnectionPeerCIDROptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetCIDRPrefix : Allow user to set CIDRPrefix +func (_options *AddVPNGatewayConnectionPeerCIDROptions) SetCIDRPrefix(cidrPrefix string) *AddVPNGatewayConnectionPeerCIDROptions { + _options.CIDRPrefix = core.StringPtr(cidrPrefix) + return _options +} + +// SetPrefixLength : Allow user to set PrefixLength +func (_options *AddVPNGatewayConnectionPeerCIDROptions) SetPrefixLength(prefixLength string) *AddVPNGatewayConnectionPeerCIDROptions { + _options.PrefixLength = core.StringPtr(prefixLength) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *AddVPNGatewayConnectionPeerCIDROptions) SetHeaders(param map[string]string) *AddVPNGatewayConnectionPeerCIDROptions { + options.Headers = param + return options +} + +// AddressPrefix : AddressPrefix struct +type AddressPrefix struct { + // The CIDR block for this prefix. + CIDR *string `json:"cidr" validate:"required"` + + // The date and time that the prefix was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // Indicates whether subnets exist with addresses from this prefix. + HasSubnets *bool `json:"has_subnets" validate:"required"` + + // The URL for this address prefix. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this address prefix. + ID *string `json:"id" validate:"required"` + + // Indicates whether this is the default prefix for this zone in this VPC. If a default prefix was automatically + // created when the VPC was created, the prefix is automatically named using a hyphenated list of randomly-selected + // words, but may be changed. + IsDefault *bool `json:"is_default" validate:"required"` + + // The name for this address prefix. The name must not be used by another address prefix for the VPC. + Name *string `json:"name" validate:"required"` + + // The zone this address prefix resides in. + Zone *ZoneReference `json:"zone" validate:"required"` +} + +// UnmarshalAddressPrefix unmarshals an instance of AddressPrefix from the specified map of raw messages. +func UnmarshalAddressPrefix(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(AddressPrefix) + err = core.UnmarshalPrimitive(m, "cidr", &obj.CIDR) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "has_subnets", &obj.HasSubnets) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "is_default", &obj.IsDefault) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AddressPrefixCollection : AddressPrefixCollection struct +type AddressPrefixCollection struct { + // Collection of address prefixes. + AddressPrefixes []AddressPrefix `json:"address_prefixes" validate:"required"` + + // A link to the first page of resources. + First *AddressPrefixCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *AddressPrefixCollectionNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalAddressPrefixCollection unmarshals an instance of AddressPrefixCollection from the specified map of raw messages. +func UnmarshalAddressPrefixCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(AddressPrefixCollection) + err = core.UnmarshalModel(m, "address_prefixes", &obj.AddressPrefixes, UnmarshalAddressPrefix) + if err != nil { + return + } + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalAddressPrefixCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalAddressPrefixCollectionNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *AddressPrefixCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// AddressPrefixCollectionFirst : A link to the first page of resources. +type AddressPrefixCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalAddressPrefixCollectionFirst unmarshals an instance of AddressPrefixCollectionFirst from the specified map of raw messages. +func UnmarshalAddressPrefixCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(AddressPrefixCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AddressPrefixCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type AddressPrefixCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalAddressPrefixCollectionNext unmarshals an instance of AddressPrefixCollectionNext from the specified map of raw messages. +func UnmarshalAddressPrefixCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(AddressPrefixCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AddressPrefixPatch : AddressPrefixPatch struct +type AddressPrefixPatch struct { + // Indicates whether this is the default prefix for this zone in this VPC. Updating to true makes this prefix the + // default prefix for this zone in this VPC, provided the VPC currently has no default address prefix for this zone. + // Updating to false removes the default prefix for this zone in this VPC. + IsDefault *bool `json:"is_default,omitempty"` + + // The name for this address prefix. The name must not be used by another address prefix for the VPC. + Name *string `json:"name,omitempty"` +} + +// UnmarshalAddressPrefixPatch unmarshals an instance of AddressPrefixPatch from the specified map of raw messages. +func UnmarshalAddressPrefixPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(AddressPrefixPatch) + err = core.UnmarshalPrimitive(m, "is_default", &obj.IsDefault) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the AddressPrefixPatch +func (addressPrefixPatch *AddressPrefixPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(addressPrefixPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// BackupPolicy : BackupPolicy struct +type BackupPolicy struct { + // The date and time that the backup policy was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The CRN for this backup policy. + CRN *string `json:"crn" validate:"required"` + + // The URL for this backup policy. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this backup policy. + ID *string `json:"id" validate:"required"` + + // The date and time that the most recent job for this backup policy completed. + // + // If absent, no job has yet completed for this backup policy. + LastJobCompletedAt *strfmt.DateTime `json:"last_job_completed_at,omitempty"` + + // The lifecycle state of the backup policy. + LifecycleState *string `json:"lifecycle_state" validate:"required"` + + // The resource types this backup policy applies to. Resources that have both a matching type and a matching user tag + // will be subject to the backup policy. + // + // The enumerated values for this property will expand in the future. When processing this property, check for and log + // unknown values. Optionally halt processing and surface the error, or bypass the backup policy on which the + // unexpected property value was encountered. + MatchResourceTypes []string `json:"match_resource_types" validate:"required"` + + // The user tags this backup policy applies to. Resources that have both a matching user tag and a matching type will + // be subject to the backup policy. + MatchUserTags []string `json:"match_user_tags" validate:"required"` + + // The name for this backup policy. The name is unique across all backup policies in the region. + Name *string `json:"name" validate:"required"` + + // The plans for the backup policy. + Plans []BackupPolicyPlanReference `json:"plans" validate:"required"` + + // The resource group for this backup policy. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the BackupPolicy.LifecycleState property. +// The lifecycle state of the backup policy. +const ( + BackupPolicyLifecycleStateDeletingConst = "deleting" + BackupPolicyLifecycleStateFailedConst = "failed" + BackupPolicyLifecycleStatePendingConst = "pending" + BackupPolicyLifecycleStateStableConst = "stable" + BackupPolicyLifecycleStateSuspendedConst = "suspended" + BackupPolicyLifecycleStateUpdatingConst = "updating" + BackupPolicyLifecycleStateWaitingConst = "waiting" +) + +// Constants associated with the BackupPolicy.MatchResourceTypes property. +// The resource type. +const ( + BackupPolicyMatchResourceTypesVolumeConst = "volume" +) + +// Constants associated with the BackupPolicy.ResourceType property. +// The resource type. +const ( + BackupPolicyResourceTypeBackupPolicyConst = "backup_policy" +) + +// UnmarshalBackupPolicy unmarshals an instance of BackupPolicy from the specified map of raw messages. +func UnmarshalBackupPolicy(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BackupPolicy) + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "last_job_completed_at", &obj.LastJobCompletedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "lifecycle_state", &obj.LifecycleState) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "match_resource_types", &obj.MatchResourceTypes) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "match_user_tags", &obj.MatchUserTags) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "plans", &obj.Plans, UnmarshalBackupPolicyPlanReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BackupPolicyCollection : BackupPolicyCollection struct +type BackupPolicyCollection struct { + // Collection of backup policies. + BackupPolicies []BackupPolicy `json:"backup_policies" validate:"required"` + + // A link to the first page of resources. + First *BackupPolicyCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *BackupPolicyCollectionNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalBackupPolicyCollection unmarshals an instance of BackupPolicyCollection from the specified map of raw messages. +func UnmarshalBackupPolicyCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BackupPolicyCollection) + err = core.UnmarshalModel(m, "backup_policies", &obj.BackupPolicies, UnmarshalBackupPolicy) + if err != nil { + return + } + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalBackupPolicyCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalBackupPolicyCollectionNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *BackupPolicyCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// BackupPolicyCollectionFirst : A link to the first page of resources. +type BackupPolicyCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalBackupPolicyCollectionFirst unmarshals an instance of BackupPolicyCollectionFirst from the specified map of raw messages. +func UnmarshalBackupPolicyCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BackupPolicyCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BackupPolicyCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type BackupPolicyCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalBackupPolicyCollectionNext unmarshals an instance of BackupPolicyCollectionNext from the specified map of raw messages. +func UnmarshalBackupPolicyCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BackupPolicyCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BackupPolicyJob : BackupPolicyJob struct +type BackupPolicyJob struct { + // Indicates whether this backup policy job will be automatically deleted after it completes. At present, this is + // always `true`, but may be modifiable in the future. + AutoDelete *bool `json:"auto_delete" validate:"required"` + + // If `auto_delete` is `true`, the days after completion that this backup policy job will be deleted. This value may be + // modifiable in the future. + AutoDeleteAfter *int64 `json:"auto_delete_after" validate:"required"` + + // The backup policy plan operated this backup policy job (may be + // [deleted](https://cloud.ibm.com/apidocs/vpc#deleted-resources)). + BackupPolicyPlan *BackupPolicyPlanReference `json:"backup_policy_plan" validate:"required"` + + // The date and time that the backup policy job was completed. + // + // If absent, the backup policy job has not yet completed. + CompletedAt *strfmt.DateTime `json:"completed_at,omitempty"` + + // The date and time that the backup policy job was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The URL for this backup policy job. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this backup policy job. + ID *string `json:"id" validate:"required"` + + // The type of backup policy job. + // + // The enumerated values for this property will expand in the future. When processing this property, check for and log + // unknown values. Optionally halt processing and surface the error, or bypass the backup policy job on which the + // unexpected property value was encountered. + JobType *string `json:"job_type" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The source this backup was created from (may be + // [deleted](https://cloud.ibm.com/apidocs/vpc#deleted-resources)). + Source BackupPolicyJobSourceIntf `json:"source" validate:"required"` + + // The status of the backup policy job. + // + // The enumerated values for this property will expand in the future. When processing this property, check for and log + // unknown values. Optionally halt processing and surface the error, or bypass the backup policy job on which the + // unexpected property value was encountered. + Status *string `json:"status" validate:"required"` + + // The reasons for the current status (if any). + // + // The enumerated reason code values for this property will expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the + // unexpected reason code was encountered. + StatusReasons []BackupPolicyJobStatusReason `json:"status_reasons" validate:"required"` + + // The snapshots operated on by this backup policy job (may be + // [deleted](https://cloud.ibm.com/apidocs/vpc#deleted-resources)). + TargetSnapshots []SnapshotReference `json:"target_snapshots" validate:"required"` +} + +// Constants associated with the BackupPolicyJob.JobType property. +// The type of backup policy job. +// +// The enumerated values for this property will expand in the future. When processing this property, check for and log +// unknown values. Optionally halt processing and surface the error, or bypass the backup policy job on which the +// unexpected property value was encountered. +const ( + BackupPolicyJobJobTypeCreationConst = "creation" + BackupPolicyJobJobTypeDeletionConst = "deletion" +) + +// Constants associated with the BackupPolicyJob.ResourceType property. +// The resource type. +const ( + BackupPolicyJobResourceTypeBackupPolicyJobConst = "backup_policy_job" +) + +// Constants associated with the BackupPolicyJob.Status property. +// The status of the backup policy job. +// +// The enumerated values for this property will expand in the future. When processing this property, check for and log +// unknown values. Optionally halt processing and surface the error, or bypass the backup policy job on which the +// unexpected property value was encountered. +const ( + BackupPolicyJobStatusFailedConst = "failed" + BackupPolicyJobStatusRunningConst = "running" + BackupPolicyJobStatusSucceededConst = "succeeded" +) + +// UnmarshalBackupPolicyJob unmarshals an instance of BackupPolicyJob from the specified map of raw messages. +func UnmarshalBackupPolicyJob(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BackupPolicyJob) + err = core.UnmarshalPrimitive(m, "auto_delete", &obj.AutoDelete) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "auto_delete_after", &obj.AutoDeleteAfter) + if err != nil { + return + } + err = core.UnmarshalModel(m, "backup_policy_plan", &obj.BackupPolicyPlan, UnmarshalBackupPolicyPlanReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "completed_at", &obj.CompletedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "job_type", &obj.JobType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalModel(m, "source", &obj.Source, UnmarshalBackupPolicyJobSource) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + err = core.UnmarshalModel(m, "status_reasons", &obj.StatusReasons, UnmarshalBackupPolicyJobStatusReason) + if err != nil { + return + } + err = core.UnmarshalModel(m, "target_snapshots", &obj.TargetSnapshots, UnmarshalSnapshotReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BackupPolicyJobCollection : BackupPolicyJobCollection struct +type BackupPolicyJobCollection struct { + // A link to the first page of resources. + First *BackupPolicyJobCollectionFirst `json:"first" validate:"required"` + + // Collection of backup policy jobs. + Jobs []BackupPolicyJob `json:"jobs" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *BackupPolicyJobCollectionNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalBackupPolicyJobCollection unmarshals an instance of BackupPolicyJobCollection from the specified map of raw messages. +func UnmarshalBackupPolicyJobCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BackupPolicyJobCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalBackupPolicyJobCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalModel(m, "jobs", &obj.Jobs, UnmarshalBackupPolicyJob) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalBackupPolicyJobCollectionNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *BackupPolicyJobCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// BackupPolicyJobCollectionFirst : A link to the first page of resources. +type BackupPolicyJobCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalBackupPolicyJobCollectionFirst unmarshals an instance of BackupPolicyJobCollectionFirst from the specified map of raw messages. +func UnmarshalBackupPolicyJobCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BackupPolicyJobCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BackupPolicyJobCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type BackupPolicyJobCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalBackupPolicyJobCollectionNext unmarshals an instance of BackupPolicyJobCollectionNext from the specified map of raw messages. +func UnmarshalBackupPolicyJobCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BackupPolicyJobCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BackupPolicyJobSource : The source this backup was created from (may be +// [deleted](https://cloud.ibm.com/apidocs/vpc#deleted-resources)). +// Models which "extend" this model: +// - BackupPolicyJobSourceVolumeReference +type BackupPolicyJobSource struct { + // The CRN for this volume. + CRN *string `json:"crn,omitempty"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *VolumeReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this volume. + Href *string `json:"href,omitempty"` + + // The unique identifier for this volume. + ID *string `json:"id,omitempty"` + + // The name for this volume. The name is unique across all volumes in the region. + Name *string `json:"name,omitempty"` + + // If present, this property indicates that the resource associated with this reference + // is remote and therefore may not be directly retrievable. + Remote *VolumeRemote `json:"remote,omitempty"` + + // The resource type. + ResourceType *string `json:"resource_type,omitempty"` +} + +// Constants associated with the BackupPolicyJobSource.ResourceType property. +// The resource type. +const ( + BackupPolicyJobSourceResourceTypeVolumeConst = "volume" +) + +func (*BackupPolicyJobSource) isaBackupPolicyJobSource() bool { + return true +} + +type BackupPolicyJobSourceIntf interface { + isaBackupPolicyJobSource() bool +} + +// UnmarshalBackupPolicyJobSource unmarshals an instance of BackupPolicyJobSource from the specified map of raw messages. +func UnmarshalBackupPolicyJobSource(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BackupPolicyJobSource) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalVolumeReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "remote", &obj.Remote, UnmarshalVolumeRemote) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BackupPolicyJobStatusReason : BackupPolicyJobStatusReason struct +type BackupPolicyJobStatusReason struct { + // A snake case string succinctly identifying the status reason: + // - `internal_error`: Internal error (contact IBM support) + // - `snapshot_pending`: Cannot delete backup (snapshot) in the `pending` lifecycle state + // - `snapshot_volume_limit`: The snapshot limit for the source volume has been reached + // - `source_volume_busy`: The source volume has `busy` set (after multiple retries). + Code *string `json:"code" validate:"required"` + + // An explanation of the status reason. + Message *string `json:"message" validate:"required"` + + // Link to documentation about this status reason. + MoreInfo *string `json:"more_info,omitempty"` +} + +// Constants associated with the BackupPolicyJobStatusReason.Code property. +// A snake case string succinctly identifying the status reason: +// - `internal_error`: Internal error (contact IBM support) +// - `snapshot_pending`: Cannot delete backup (snapshot) in the `pending` lifecycle state +// - `snapshot_volume_limit`: The snapshot limit for the source volume has been reached +// - `source_volume_busy`: The source volume has `busy` set (after multiple retries). +const ( + BackupPolicyJobStatusReasonCodeInternalErrorConst = "internal_error" + BackupPolicyJobStatusReasonCodeSnapshotPendingConst = "snapshot_pending" + BackupPolicyJobStatusReasonCodeSnapshotVolumeLimitConst = "snapshot_volume_limit" + BackupPolicyJobStatusReasonCodeSourceVolumeBusyConst = "source_volume_busy" +) + +// UnmarshalBackupPolicyJobStatusReason unmarshals an instance of BackupPolicyJobStatusReason from the specified map of raw messages. +func UnmarshalBackupPolicyJobStatusReason(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BackupPolicyJobStatusReason) + err = core.UnmarshalPrimitive(m, "code", &obj.Code) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "message", &obj.Message) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BackupPolicyPatch : BackupPolicyPatch struct +type BackupPolicyPatch struct { + // The user tags this backup policy will apply to (replacing any existing tags). Resources that have both a matching + // user tag and a matching type will be subject to the backup policy. + MatchUserTags []string `json:"match_user_tags,omitempty"` + + // The name for this backup policy. The name must not be used by another backup policy in the region. + Name *string `json:"name,omitempty"` +} + +// UnmarshalBackupPolicyPatch unmarshals an instance of BackupPolicyPatch from the specified map of raw messages. +func UnmarshalBackupPolicyPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BackupPolicyPatch) + err = core.UnmarshalPrimitive(m, "match_user_tags", &obj.MatchUserTags) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the BackupPolicyPatch +func (backupPolicyPatch *BackupPolicyPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(backupPolicyPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// BackupPolicyPlan : BackupPolicyPlan struct +type BackupPolicyPlan struct { + // Indicates whether the plan is active. + Active *bool `json:"active" validate:"required"` + + // The user tags to attach to backups (snapshots) created by this plan. + AttachUserTags []string `json:"attach_user_tags" validate:"required"` + + ClonePolicy *BackupPolicyPlanClonePolicy `json:"clone_policy" validate:"required"` + + // Indicates whether to copy the source's user tags to the created backups (snapshots). + CopyUserTags *bool `json:"copy_user_tags" validate:"required"` + + // The date and time that the backup policy plan was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The cron specification for the backup schedule. The backup policy jobs + // (which create and delete backups for this plan) will not start until this time, and may start for up to 90 minutes + // after this time. + // + // All backup schedules for plans in the same policy must be at least an hour apart. + CronSpec *string `json:"cron_spec" validate:"required"` + + DeletionTrigger *BackupPolicyPlanDeletionTrigger `json:"deletion_trigger" validate:"required"` + + // The URL for this backup policy plan. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this backup policy plan. + ID *string `json:"id" validate:"required"` + + // The lifecycle state of this backup policy plan. + LifecycleState *string `json:"lifecycle_state" validate:"required"` + + // The name for this backup policy plan. The name is unique across all plans in the backup policy. + Name *string `json:"name" validate:"required"` + + // The policies for additional backups in remote regions. + RemoteRegionPolicies []BackupPolicyPlanRemoteRegionPolicy `json:"remote_region_policies" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the BackupPolicyPlan.LifecycleState property. +// The lifecycle state of this backup policy plan. +const ( + BackupPolicyPlanLifecycleStateDeletingConst = "deleting" + BackupPolicyPlanLifecycleStateFailedConst = "failed" + BackupPolicyPlanLifecycleStatePendingConst = "pending" + BackupPolicyPlanLifecycleStateStableConst = "stable" + BackupPolicyPlanLifecycleStateSuspendedConst = "suspended" + BackupPolicyPlanLifecycleStateUpdatingConst = "updating" + BackupPolicyPlanLifecycleStateWaitingConst = "waiting" +) + +// Constants associated with the BackupPolicyPlan.ResourceType property. +// The resource type. +const ( + BackupPolicyPlanResourceTypeBackupPolicyPlanConst = "backup_policy_plan" +) + +// UnmarshalBackupPolicyPlan unmarshals an instance of BackupPolicyPlan from the specified map of raw messages. +func UnmarshalBackupPolicyPlan(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BackupPolicyPlan) + err = core.UnmarshalPrimitive(m, "active", &obj.Active) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "attach_user_tags", &obj.AttachUserTags) + if err != nil { + return + } + err = core.UnmarshalModel(m, "clone_policy", &obj.ClonePolicy, UnmarshalBackupPolicyPlanClonePolicy) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "copy_user_tags", &obj.CopyUserTags) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "cron_spec", &obj.CronSpec) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deletion_trigger", &obj.DeletionTrigger, UnmarshalBackupPolicyPlanDeletionTrigger) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "lifecycle_state", &obj.LifecycleState) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "remote_region_policies", &obj.RemoteRegionPolicies, UnmarshalBackupPolicyPlanRemoteRegionPolicy) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BackupPolicyPlanClonePolicy : BackupPolicyPlanClonePolicy struct +type BackupPolicyPlanClonePolicy struct { + // The maximum number of recent snapshots (per source) that will keep clones. + MaxSnapshots *int64 `json:"max_snapshots" validate:"required"` + + // The zone this backup policy plan will create snapshot clones in. + Zones []ZoneReference `json:"zones" validate:"required"` +} + +// UnmarshalBackupPolicyPlanClonePolicy unmarshals an instance of BackupPolicyPlanClonePolicy from the specified map of raw messages. +func UnmarshalBackupPolicyPlanClonePolicy(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BackupPolicyPlanClonePolicy) + err = core.UnmarshalPrimitive(m, "max_snapshots", &obj.MaxSnapshots) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zones", &obj.Zones, UnmarshalZoneReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BackupPolicyPlanClonePolicyPatch : BackupPolicyPlanClonePolicyPatch struct +type BackupPolicyPlanClonePolicyPatch struct { + // The maximum number of recent snapshots (per source) that will keep clones. + MaxSnapshots *int64 `json:"max_snapshots,omitempty"` + + // The zones this backup policy plan will create snapshot clones in. Updating this value does not change the clones for + // snapshots that have already been created by this plan. + Zones []ZoneIdentityIntf `json:"zones,omitempty"` +} + +// UnmarshalBackupPolicyPlanClonePolicyPatch unmarshals an instance of BackupPolicyPlanClonePolicyPatch from the specified map of raw messages. +func UnmarshalBackupPolicyPlanClonePolicyPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BackupPolicyPlanClonePolicyPatch) + err = core.UnmarshalPrimitive(m, "max_snapshots", &obj.MaxSnapshots) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zones", &obj.Zones, UnmarshalZoneIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BackupPolicyPlanClonePolicyPrototype : BackupPolicyPlanClonePolicyPrototype struct +type BackupPolicyPlanClonePolicyPrototype struct { + // The maximum number of recent snapshots (per source) that will keep clones. + MaxSnapshots *int64 `json:"max_snapshots,omitempty"` + + // The zone this backup policy plan will create snapshot clones in. + Zones []ZoneIdentityIntf `json:"zones" validate:"required"` +} + +// NewBackupPolicyPlanClonePolicyPrototype : Instantiate BackupPolicyPlanClonePolicyPrototype (Generic Model Constructor) +func (*VpcV1) NewBackupPolicyPlanClonePolicyPrototype(zones []ZoneIdentityIntf) (_model *BackupPolicyPlanClonePolicyPrototype, err error) { + _model = &BackupPolicyPlanClonePolicyPrototype{ + Zones: zones, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalBackupPolicyPlanClonePolicyPrototype unmarshals an instance of BackupPolicyPlanClonePolicyPrototype from the specified map of raw messages. +func UnmarshalBackupPolicyPlanClonePolicyPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BackupPolicyPlanClonePolicyPrototype) + err = core.UnmarshalPrimitive(m, "max_snapshots", &obj.MaxSnapshots) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zones", &obj.Zones, UnmarshalZoneIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BackupPolicyPlanCollection : BackupPolicyPlanCollection struct +type BackupPolicyPlanCollection struct { + // Collection of backup policy plans. + Plans []BackupPolicyPlan `json:"plans" validate:"required"` +} + +// UnmarshalBackupPolicyPlanCollection unmarshals an instance of BackupPolicyPlanCollection from the specified map of raw messages. +func UnmarshalBackupPolicyPlanCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BackupPolicyPlanCollection) + err = core.UnmarshalModel(m, "plans", &obj.Plans, UnmarshalBackupPolicyPlan) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BackupPolicyPlanDeletionTrigger : BackupPolicyPlanDeletionTrigger struct +type BackupPolicyPlanDeletionTrigger struct { + // The maximum number of days to keep each backup after creation. + DeleteAfter *int64 `json:"delete_after" validate:"required"` + + // The maximum number of recent backups to keep. If absent, there is no maximum. + DeleteOverCount *int64 `json:"delete_over_count,omitempty"` +} + +// UnmarshalBackupPolicyPlanDeletionTrigger unmarshals an instance of BackupPolicyPlanDeletionTrigger from the specified map of raw messages. +func UnmarshalBackupPolicyPlanDeletionTrigger(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BackupPolicyPlanDeletionTrigger) + err = core.UnmarshalPrimitive(m, "delete_after", &obj.DeleteAfter) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "delete_over_count", &obj.DeleteOverCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BackupPolicyPlanDeletionTriggerPatch : BackupPolicyPlanDeletionTriggerPatch struct +type BackupPolicyPlanDeletionTriggerPatch struct { + // The maximum number of days to keep each backup after creation. + DeleteAfter *int64 `json:"delete_after,omitempty"` + + // The maximum number of recent backups to keep. Specify `null` to remove any existing maximum. + DeleteOverCount *int64 `json:"delete_over_count,omitempty"` +} + +// UnmarshalBackupPolicyPlanDeletionTriggerPatch unmarshals an instance of BackupPolicyPlanDeletionTriggerPatch from the specified map of raw messages. +func UnmarshalBackupPolicyPlanDeletionTriggerPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BackupPolicyPlanDeletionTriggerPatch) + err = core.UnmarshalPrimitive(m, "delete_after", &obj.DeleteAfter) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "delete_over_count", &obj.DeleteOverCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BackupPolicyPlanDeletionTriggerPrototype : BackupPolicyPlanDeletionTriggerPrototype struct +type BackupPolicyPlanDeletionTriggerPrototype struct { + // The maximum number of days to keep each backup after creation. + DeleteAfter *int64 `json:"delete_after,omitempty"` + + // The maximum number of recent backups to keep. If unspecified, there will be no maximum. + DeleteOverCount *int64 `json:"delete_over_count,omitempty"` +} + +// UnmarshalBackupPolicyPlanDeletionTriggerPrototype unmarshals an instance of BackupPolicyPlanDeletionTriggerPrototype from the specified map of raw messages. +func UnmarshalBackupPolicyPlanDeletionTriggerPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BackupPolicyPlanDeletionTriggerPrototype) + err = core.UnmarshalPrimitive(m, "delete_after", &obj.DeleteAfter) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "delete_over_count", &obj.DeleteOverCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BackupPolicyPlanPatch : BackupPolicyPlanPatch struct +type BackupPolicyPlanPatch struct { + // Indicates whether the plan is active. + Active *bool `json:"active,omitempty"` + + // The user tags to attach to backups (snapshots) created by this plan. Updating this value does not change the user + // tags for backups that have already been created by this plan. + AttachUserTags []string `json:"attach_user_tags,omitempty"` + + ClonePolicy *BackupPolicyPlanClonePolicyPatch `json:"clone_policy,omitempty"` + + // Indicates whether to copy the source's user tags to the created backups (snapshots). + CopyUserTags *bool `json:"copy_user_tags,omitempty"` + + // The cron specification for the backup schedule. The backup policy jobs + // (which create and delete backups for this plan) will not start until this time, and may start for up to 90 minutes + // after this time. + // + // All backup schedules for plans in the same policy must be at least an hour apart. + CronSpec *string `json:"cron_spec,omitempty"` + + DeletionTrigger *BackupPolicyPlanDeletionTriggerPatch `json:"deletion_trigger,omitempty"` + + // The name for this backup policy plan. The name must not be used by another plan for the backup policy. + Name *string `json:"name,omitempty"` + + // The policies for additional backups in remote regions (replacing any existing policies). + RemoteRegionPolicies []BackupPolicyPlanRemoteRegionPolicyPrototype `json:"remote_region_policies,omitempty"` +} + +// UnmarshalBackupPolicyPlanPatch unmarshals an instance of BackupPolicyPlanPatch from the specified map of raw messages. +func UnmarshalBackupPolicyPlanPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BackupPolicyPlanPatch) + err = core.UnmarshalPrimitive(m, "active", &obj.Active) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "attach_user_tags", &obj.AttachUserTags) + if err != nil { + return + } + err = core.UnmarshalModel(m, "clone_policy", &obj.ClonePolicy, UnmarshalBackupPolicyPlanClonePolicyPatch) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "copy_user_tags", &obj.CopyUserTags) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "cron_spec", &obj.CronSpec) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deletion_trigger", &obj.DeletionTrigger, UnmarshalBackupPolicyPlanDeletionTriggerPatch) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "remote_region_policies", &obj.RemoteRegionPolicies, UnmarshalBackupPolicyPlanRemoteRegionPolicyPrototype) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the BackupPolicyPlanPatch +func (backupPolicyPlanPatch *BackupPolicyPlanPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(backupPolicyPlanPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// BackupPolicyPlanPrototype : BackupPolicyPlanPrototype struct +type BackupPolicyPlanPrototype struct { + // Indicates whether the plan is active. + Active *bool `json:"active,omitempty"` + + // User tags to attach to each backup (snapshot) created by this plan. If unspecified, no user tags will be attached. + AttachUserTags []string `json:"attach_user_tags,omitempty"` + + ClonePolicy *BackupPolicyPlanClonePolicyPrototype `json:"clone_policy,omitempty"` + + // Indicates whether to copy the source's user tags to the created backups (snapshots). + CopyUserTags *bool `json:"copy_user_tags,omitempty"` + + // The cron specification for the backup schedule. The backup policy jobs + // (which create and delete backups for this plan) will not start until this time, and may start for up to 90 minutes + // after this time. + // + // All backup schedules for plans in the same policy must be at least an hour apart. + CronSpec *string `json:"cron_spec" validate:"required"` + + DeletionTrigger *BackupPolicyPlanDeletionTriggerPrototype `json:"deletion_trigger,omitempty"` + + // The name for this backup policy plan. The name must not be used by another plan for the backup policy. If + // unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The policies for additional backups in remote regions. + RemoteRegionPolicies []BackupPolicyPlanRemoteRegionPolicyPrototype `json:"remote_region_policies,omitempty"` +} + +// NewBackupPolicyPlanPrototype : Instantiate BackupPolicyPlanPrototype (Generic Model Constructor) +func (*VpcV1) NewBackupPolicyPlanPrototype(cronSpec string) (_model *BackupPolicyPlanPrototype, err error) { + _model = &BackupPolicyPlanPrototype{ + CronSpec: core.StringPtr(cronSpec), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalBackupPolicyPlanPrototype unmarshals an instance of BackupPolicyPlanPrototype from the specified map of raw messages. +func UnmarshalBackupPolicyPlanPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BackupPolicyPlanPrototype) + err = core.UnmarshalPrimitive(m, "active", &obj.Active) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "attach_user_tags", &obj.AttachUserTags) + if err != nil { + return + } + err = core.UnmarshalModel(m, "clone_policy", &obj.ClonePolicy, UnmarshalBackupPolicyPlanClonePolicyPrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "copy_user_tags", &obj.CopyUserTags) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "cron_spec", &obj.CronSpec) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deletion_trigger", &obj.DeletionTrigger, UnmarshalBackupPolicyPlanDeletionTriggerPrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "remote_region_policies", &obj.RemoteRegionPolicies, UnmarshalBackupPolicyPlanRemoteRegionPolicyPrototype) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BackupPolicyPlanReference : BackupPolicyPlanReference struct +type BackupPolicyPlanReference struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *BackupPolicyPlanReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this backup policy plan. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this backup policy plan. + ID *string `json:"id" validate:"required"` + + // The name for this backup policy plan. The name is unique across all plans in the backup policy. + Name *string `json:"name" validate:"required"` + + // If present, this property indicates that the resource associated with this reference + // is remote and therefore may not be directly retrievable. + Remote *BackupPolicyPlanRemote `json:"remote,omitempty"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the BackupPolicyPlanReference.ResourceType property. +// The resource type. +const ( + BackupPolicyPlanReferenceResourceTypeBackupPolicyPlanConst = "backup_policy_plan" +) + +// UnmarshalBackupPolicyPlanReference unmarshals an instance of BackupPolicyPlanReference from the specified map of raw messages. +func UnmarshalBackupPolicyPlanReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BackupPolicyPlanReference) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalBackupPolicyPlanReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "remote", &obj.Remote, UnmarshalBackupPolicyPlanRemote) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BackupPolicyPlanReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type BackupPolicyPlanReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalBackupPolicyPlanReferenceDeleted unmarshals an instance of BackupPolicyPlanReferenceDeleted from the specified map of raw messages. +func UnmarshalBackupPolicyPlanReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BackupPolicyPlanReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BackupPolicyPlanRemote : If present, this property indicates that the resource associated with this reference is remote and therefore may not +// be directly retrievable. +type BackupPolicyPlanRemote struct { + // If present, this property indicates that the referenced resource is remote to this + // region, and identifies the native region. + Region *RegionReference `json:"region,omitempty"` +} + +// UnmarshalBackupPolicyPlanRemote unmarshals an instance of BackupPolicyPlanRemote from the specified map of raw messages. +func UnmarshalBackupPolicyPlanRemote(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BackupPolicyPlanRemote) + err = core.UnmarshalModel(m, "region", &obj.Region, UnmarshalRegionReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BackupPolicyPlanRemoteRegionPolicy : BackupPolicyPlanRemoteRegionPolicy struct +type BackupPolicyPlanRemoteRegionPolicy struct { + // The region this backup policy plan will create backups in. + DeleteOverCount *int64 `json:"delete_over_count" validate:"required"` + + // The root key used to rewrap the data encryption key for the backup (snapshot). + EncryptionKey *EncryptionKeyReference `json:"encryption_key" validate:"required"` + + // The region this backup policy plan will create backups in. + Region *RegionReference `json:"region" validate:"required"` +} + +// UnmarshalBackupPolicyPlanRemoteRegionPolicy unmarshals an instance of BackupPolicyPlanRemoteRegionPolicy from the specified map of raw messages. +func UnmarshalBackupPolicyPlanRemoteRegionPolicy(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BackupPolicyPlanRemoteRegionPolicy) + err = core.UnmarshalPrimitive(m, "delete_over_count", &obj.DeleteOverCount) + if err != nil { + return + } + err = core.UnmarshalModel(m, "encryption_key", &obj.EncryptionKey, UnmarshalEncryptionKeyReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "region", &obj.Region, UnmarshalRegionReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BackupPolicyPlanRemoteRegionPolicyPrototype : BackupPolicyPlanRemoteRegionPolicyPrototype struct +type BackupPolicyPlanRemoteRegionPolicyPrototype struct { + // The region this backup policy plan will create backups in. + DeleteOverCount *int64 `json:"delete_over_count,omitempty"` + + // The root key to use to rewrap the data encryption key for the backup (snapshot). + // + // If unspecified, the source's `encryption_key` will be used. + // The specified key may be in a different account, subject to IAM policies. + EncryptionKey EncryptionKeyIdentityIntf `json:"encryption_key,omitempty"` + + // The region this backup policy plan will create backups in. + Region RegionIdentityIntf `json:"region" validate:"required"` +} + +// NewBackupPolicyPlanRemoteRegionPolicyPrototype : Instantiate BackupPolicyPlanRemoteRegionPolicyPrototype (Generic Model Constructor) +func (*VpcV1) NewBackupPolicyPlanRemoteRegionPolicyPrototype(region RegionIdentityIntf) (_model *BackupPolicyPlanRemoteRegionPolicyPrototype, err error) { + _model = &BackupPolicyPlanRemoteRegionPolicyPrototype{ + Region: region, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalBackupPolicyPlanRemoteRegionPolicyPrototype unmarshals an instance of BackupPolicyPlanRemoteRegionPolicyPrototype from the specified map of raw messages. +func UnmarshalBackupPolicyPlanRemoteRegionPolicyPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BackupPolicyPlanRemoteRegionPolicyPrototype) + err = core.UnmarshalPrimitive(m, "delete_over_count", &obj.DeleteOverCount) + if err != nil { + return + } + err = core.UnmarshalModel(m, "encryption_key", &obj.EncryptionKey, UnmarshalEncryptionKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "region", &obj.Region, UnmarshalRegionIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServer : BareMetalServer struct +type BareMetalServer struct { + // The total bandwidth (in megabits per second) shared across the bare metal server network interfaces. + Bandwidth *int64 `json:"bandwidth" validate:"required"` + + // The possible resource types for this property are expected to expand in the future. + BootTarget BareMetalServerBootTargetIntf `json:"boot_target" validate:"required"` + + // The bare metal server CPU configuration. + Cpu *BareMetalServerCpu `json:"cpu" validate:"required"` + + // The date and time that the bare metal server was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The CRN for this bare metal server. + CRN *string `json:"crn" validate:"required"` + + // The disks for this bare metal server, including any disks that are associated with the + // `boot_target`. + Disks []BareMetalServerDisk `json:"disks" validate:"required"` + + // Indicates whether secure boot is enabled. If enabled, the image must support secure boot or the server will fail to + // boot. + EnableSecureBoot *bool `json:"enable_secure_boot" validate:"required"` + + // The URL for this bare metal server. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this bare metal server. + ID *string `json:"id" validate:"required"` + + // The reasons for the current `lifecycle_state` (if any). + // + // The enumerated reason code values for this property will expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the + // unexpected reason code was encountered. + LifecycleReasons []BareMetalServerLifecycleReason `json:"lifecycle_reasons" validate:"required"` + + // The lifecycle state of the bare metal server. + LifecycleState *string `json:"lifecycle_state" validate:"required"` + + // The amount of memory, truncated to whole gibibytes. + Memory *int64 `json:"memory" validate:"required"` + + // The name for this bare metal server. The name is unique across all bare metal servers in the region. + Name *string `json:"name" validate:"required"` + + // The network interfaces for this bare metal server, including the primary network interface. + NetworkInterfaces []NetworkInterfaceBareMetalServerContextReference `json:"network_interfaces" validate:"required"` + + // The primary network interface for this bare metal server. + PrimaryNetworkInterface *NetworkInterfaceBareMetalServerContextReference `json:"primary_network_interface" validate:"required"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-bare-metal-servers-profile) + // for this bare metal server. + Profile *BareMetalServerProfileReference `json:"profile" validate:"required"` + + // The resource group for this bare metal server. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The status of the bare metal server. + Status *string `json:"status" validate:"required"` + + // The reasons for the current status (if any). + // + // The enumerated reason code values for this property will expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the + // unexpected reason code was encountered. + StatusReasons []BareMetalServerStatusReason `json:"status_reasons" validate:"required"` + + TrustedPlatformModule *BareMetalServerTrustedPlatformModule `json:"trusted_platform_module" validate:"required"` + + // The VPC this bare metal server resides in. + VPC *VPCReference `json:"vpc" validate:"required"` + + // The zone this bare metal server resides in. + Zone *ZoneReference `json:"zone" validate:"required"` +} + +// Constants associated with the BareMetalServer.LifecycleState property. +// The lifecycle state of the bare metal server. +const ( + BareMetalServerLifecycleStateDeletingConst = "deleting" + BareMetalServerLifecycleStateFailedConst = "failed" + BareMetalServerLifecycleStatePendingConst = "pending" + BareMetalServerLifecycleStateStableConst = "stable" + BareMetalServerLifecycleStateSuspendedConst = "suspended" + BareMetalServerLifecycleStateUpdatingConst = "updating" + BareMetalServerLifecycleStateWaitingConst = "waiting" +) + +// Constants associated with the BareMetalServer.ResourceType property. +// The resource type. +const ( + BareMetalServerResourceTypeBareMetalServerConst = "bare_metal_server" +) + +// Constants associated with the BareMetalServer.Status property. +// The status of the bare metal server. +const ( + BareMetalServerStatusDeletingConst = "deleting" + BareMetalServerStatusFailedConst = "failed" + BareMetalServerStatusMaintenanceConst = "maintenance" + BareMetalServerStatusPendingConst = "pending" + BareMetalServerStatusRestartingConst = "restarting" + BareMetalServerStatusRunningConst = "running" + BareMetalServerStatusStartingConst = "starting" + BareMetalServerStatusStoppedConst = "stopped" + BareMetalServerStatusStoppingConst = "stopping" +) + +// UnmarshalBareMetalServer unmarshals an instance of BareMetalServer from the specified map of raw messages. +func UnmarshalBareMetalServer(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServer) + err = core.UnmarshalPrimitive(m, "bandwidth", &obj.Bandwidth) + if err != nil { + return + } + err = core.UnmarshalModel(m, "boot_target", &obj.BootTarget, UnmarshalBareMetalServerBootTarget) + if err != nil { + return + } + err = core.UnmarshalModel(m, "cpu", &obj.Cpu, UnmarshalBareMetalServerCpu) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "disks", &obj.Disks, UnmarshalBareMetalServerDisk) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "enable_secure_boot", &obj.EnableSecureBoot) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalModel(m, "lifecycle_reasons", &obj.LifecycleReasons, UnmarshalBareMetalServerLifecycleReason) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "lifecycle_state", &obj.LifecycleState) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "memory", &obj.Memory) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "network_interfaces", &obj.NetworkInterfaces, UnmarshalNetworkInterfaceBareMetalServerContextReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_network_interface", &obj.PrimaryNetworkInterface, UnmarshalNetworkInterfaceBareMetalServerContextReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalBareMetalServerProfileReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + err = core.UnmarshalModel(m, "status_reasons", &obj.StatusReasons, UnmarshalBareMetalServerStatusReason) + if err != nil { + return + } + err = core.UnmarshalModel(m, "trusted_platform_module", &obj.TrustedPlatformModule, UnmarshalBareMetalServerTrustedPlatformModule) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerBootTarget : The possible resource types for this property are expected to expand in the future. +// Models which "extend" this model: +// - BareMetalServerBootTargetBareMetalServerDiskReference +type BareMetalServerBootTarget struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *BareMetalServerDiskReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this bare metal server disk. + Href *string `json:"href,omitempty"` + + // The unique identifier for this bare metal server disk. + ID *string `json:"id,omitempty"` + + // The name for this bare metal server disk. The name is unique across all disks on the bare metal server. + Name *string `json:"name,omitempty"` + + // The resource type. + ResourceType *string `json:"resource_type,omitempty"` +} + +// Constants associated with the BareMetalServerBootTarget.ResourceType property. +// The resource type. +const ( + BareMetalServerBootTargetResourceTypeBareMetalServerDiskConst = "bare_metal_server_disk" +) + +func (*BareMetalServerBootTarget) isaBareMetalServerBootTarget() bool { + return true +} + +type BareMetalServerBootTargetIntf interface { + isaBareMetalServerBootTarget() bool +} + +// UnmarshalBareMetalServerBootTarget unmarshals an instance of BareMetalServerBootTarget from the specified map of raw messages. +func UnmarshalBareMetalServerBootTarget(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerBootTarget) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalBareMetalServerDiskReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerCpu : The bare metal server CPU configuration. +type BareMetalServerCpu struct { + // The CPU architecture. + Architecture *string `json:"architecture" validate:"required"` + + // The total number of cores. + CoreCount *int64 `json:"core_count" validate:"required"` + + // The total number of CPU sockets. + SocketCount *int64 `json:"socket_count" validate:"required"` + + // The total number of hardware threads per core. + ThreadsPerCore *int64 `json:"threads_per_core" validate:"required"` +} + +// UnmarshalBareMetalServerCpu unmarshals an instance of BareMetalServerCpu from the specified map of raw messages. +func UnmarshalBareMetalServerCpu(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerCpu) + err = core.UnmarshalPrimitive(m, "architecture", &obj.Architecture) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "core_count", &obj.CoreCount) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "socket_count", &obj.SocketCount) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "threads_per_core", &obj.ThreadsPerCore) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerCollection : BareMetalServerCollection struct +type BareMetalServerCollection struct { + // Collection of bare metal servers. + BareMetalServers []BareMetalServer `json:"bare_metal_servers" validate:"required"` + + // A link to the first page of resources. + First *BareMetalServerCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *BareMetalServerCollectionNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalBareMetalServerCollection unmarshals an instance of BareMetalServerCollection from the specified map of raw messages. +func UnmarshalBareMetalServerCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerCollection) + err = core.UnmarshalModel(m, "bare_metal_servers", &obj.BareMetalServers, UnmarshalBareMetalServer) + if err != nil { + return + } + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalBareMetalServerCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalBareMetalServerCollectionNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *BareMetalServerCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// BareMetalServerCollectionFirst : A link to the first page of resources. +type BareMetalServerCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalBareMetalServerCollectionFirst unmarshals an instance of BareMetalServerCollectionFirst from the specified map of raw messages. +func UnmarshalBareMetalServerCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type BareMetalServerCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalBareMetalServerCollectionNext unmarshals an instance of BareMetalServerCollectionNext from the specified map of raw messages. +func UnmarshalBareMetalServerCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerConsoleAccessToken : The bare metal server console access token information. +type BareMetalServerConsoleAccessToken struct { + // A URL safe single-use token used to access the console WebSocket. + AccessToken *string `json:"access_token" validate:"required"` + + // The bare metal server console type for which this token may be used. + ConsoleType *string `json:"console_type" validate:"required"` + + // The date and time that the access token was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The date and time that the access token will expire. + ExpiresAt *strfmt.DateTime `json:"expires_at" validate:"required"` + + // Indicates whether to disconnect an existing serial console session as the serial console cannot be shared. This has + // no effect on VNC consoles. + Force *bool `json:"force" validate:"required"` + + // The URL to access this bare metal server console. + Href *string `json:"href" validate:"required"` +} + +// Constants associated with the BareMetalServerConsoleAccessToken.ConsoleType property. +// The bare metal server console type for which this token may be used. +const ( + BareMetalServerConsoleAccessTokenConsoleTypeSerialConst = "serial" + BareMetalServerConsoleAccessTokenConsoleTypeVncConst = "vnc" +) + +// UnmarshalBareMetalServerConsoleAccessToken unmarshals an instance of BareMetalServerConsoleAccessToken from the specified map of raw messages. +func UnmarshalBareMetalServerConsoleAccessToken(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerConsoleAccessToken) + err = core.UnmarshalPrimitive(m, "access_token", &obj.AccessToken) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "console_type", &obj.ConsoleType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "expires_at", &obj.ExpiresAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "force", &obj.Force) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerDisk : BareMetalServerDisk struct +type BareMetalServerDisk struct { + // The date and time that the disk was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The URL for this bare metal server disk. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this bare metal server disk. + ID *string `json:"id" validate:"required"` + + // The disk interface used for attaching the disk. + // + // - `fcp`: Attached using Fiber Channel Protocol + // - `sata`: Attached using Serial Advanced Technology Attachment + // - `nvme`: Attached using Non-Volatile Memory Express + // + // The enumerated values for this property are expected to expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the + // unexpected property value was encountered. + InterfaceType *string `json:"interface_type" validate:"required"` + + // The name for this bare metal server disk. The name is unique across all disks on the bare metal server. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The size of the disk in GB (gigabytes). + Size *int64 `json:"size" validate:"required"` +} + +// Constants associated with the BareMetalServerDisk.InterfaceType property. +// The disk interface used for attaching the disk. +// +// - `fcp`: Attached using Fiber Channel Protocol +// - `sata`: Attached using Serial Advanced Technology Attachment +// - `nvme`: Attached using Non-Volatile Memory Express +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the +// unexpected property value was encountered. +const ( + BareMetalServerDiskInterfaceTypeFcpConst = "fcp" + BareMetalServerDiskInterfaceTypeNvmeConst = "nvme" + BareMetalServerDiskInterfaceTypeSataConst = "sata" +) + +// Constants associated with the BareMetalServerDisk.ResourceType property. +// The resource type. +const ( + BareMetalServerDiskResourceTypeBareMetalServerDiskConst = "bare_metal_server_disk" +) + +// UnmarshalBareMetalServerDisk unmarshals an instance of BareMetalServerDisk from the specified map of raw messages. +func UnmarshalBareMetalServerDisk(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerDisk) + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "interface_type", &obj.InterfaceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "size", &obj.Size) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerDiskCollection : BareMetalServerDiskCollection struct +type BareMetalServerDiskCollection struct { + // Collection of the bare metal server's disks. + Disks []BareMetalServerDisk `json:"disks" validate:"required"` +} + +// UnmarshalBareMetalServerDiskCollection unmarshals an instance of BareMetalServerDiskCollection from the specified map of raw messages. +func UnmarshalBareMetalServerDiskCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerDiskCollection) + err = core.UnmarshalModel(m, "disks", &obj.Disks, UnmarshalBareMetalServerDisk) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerDiskPatch : BareMetalServerDiskPatch struct +type BareMetalServerDiskPatch struct { + // The name for this bare metal server disk. The name must not be used by another disk on the bare metal server. + Name *string `json:"name,omitempty"` +} + +// UnmarshalBareMetalServerDiskPatch unmarshals an instance of BareMetalServerDiskPatch from the specified map of raw messages. +func UnmarshalBareMetalServerDiskPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerDiskPatch) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the BareMetalServerDiskPatch +func (bareMetalServerDiskPatch *BareMetalServerDiskPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(bareMetalServerDiskPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// BareMetalServerDiskReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type BareMetalServerDiskReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalBareMetalServerDiskReferenceDeleted unmarshals an instance of BareMetalServerDiskReferenceDeleted from the specified map of raw messages. +func UnmarshalBareMetalServerDiskReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerDiskReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerInitialization : BareMetalServerInitialization struct +type BareMetalServerInitialization struct { + // The image the bare metal server was provisioned from. + Image *ImageReference `json:"image" validate:"required"` + + // The public SSH keys used at initialization. + Keys []KeyReference `json:"keys" validate:"required"` + + // The user accounts that are created at initialization. There can be multiple account types distinguished by the + // `resource_type` property. + UserAccounts []BareMetalServerInitializationUserAccountIntf `json:"user_accounts" validate:"required"` +} + +// UnmarshalBareMetalServerInitialization unmarshals an instance of BareMetalServerInitialization from the specified map of raw messages. +func UnmarshalBareMetalServerInitialization(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerInitialization) + err = core.UnmarshalModel(m, "image", &obj.Image, UnmarshalImageReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "keys", &obj.Keys, UnmarshalKeyReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "user_accounts", &obj.UserAccounts, UnmarshalBareMetalServerInitializationUserAccount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerInitializationPrototype : BareMetalServerInitializationPrototype struct +type BareMetalServerInitializationPrototype struct { + // The image to be used when provisioning the bare metal server. + Image ImageIdentityIntf `json:"image" validate:"required"` + + // The public SSH keys to install on the bare metal server. Keys will be made available to the bare metal server as + // cloud-init vendor data. For cloud-init enabled images, these keys will also be added as SSH authorized keys for the + // administrative user. + // + // For Windows images, at least one key must be specified, and one will be selected to encrypt the administrator + // password. Keys are optional for other images, but if no keys are specified, the instance will be inaccessible unless + // the specified image provides another means of access. + Keys []KeyIdentityIntf `json:"keys" validate:"required"` + + // User data to be made available when initializing the bare metal server. + UserData *string `json:"user_data,omitempty"` +} + +// NewBareMetalServerInitializationPrototype : Instantiate BareMetalServerInitializationPrototype (Generic Model Constructor) +func (*VpcV1) NewBareMetalServerInitializationPrototype(image ImageIdentityIntf, keys []KeyIdentityIntf) (_model *BareMetalServerInitializationPrototype, err error) { + _model = &BareMetalServerInitializationPrototype{ + Image: image, + Keys: keys, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalBareMetalServerInitializationPrototype unmarshals an instance of BareMetalServerInitializationPrototype from the specified map of raw messages. +func UnmarshalBareMetalServerInitializationPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerInitializationPrototype) + err = core.UnmarshalModel(m, "image", &obj.Image, UnmarshalImageIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "keys", &obj.Keys, UnmarshalKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_data", &obj.UserData) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerInitializationUserAccount : BareMetalServerInitializationUserAccount struct +// Models which "extend" this model: +// - BareMetalServerInitializationUserAccountBareMetalServerInitializationHostUserAccount +type BareMetalServerInitializationUserAccount struct { + // The password at initialization, encrypted using `encryption_key`, and returned base64-encoded. + EncryptedPassword *[]byte `json:"encrypted_password,omitempty"` + + // The public SSH key used to encrypt the password. + EncryptionKey *KeyReference `json:"encryption_key,omitempty"` + + // The resource type. + ResourceType *string `json:"resource_type,omitempty"` + + // The username for the account created at initialization. + Username *string `json:"username,omitempty"` +} + +// Constants associated with the BareMetalServerInitializationUserAccount.ResourceType property. +// The resource type. +const ( + BareMetalServerInitializationUserAccountResourceTypeHostUserAccountConst = "host_user_account" +) + +func (*BareMetalServerInitializationUserAccount) isaBareMetalServerInitializationUserAccount() bool { + return true +} + +type BareMetalServerInitializationUserAccountIntf interface { + isaBareMetalServerInitializationUserAccount() bool +} + +// UnmarshalBareMetalServerInitializationUserAccount unmarshals an instance of BareMetalServerInitializationUserAccount from the specified map of raw messages. +func UnmarshalBareMetalServerInitializationUserAccount(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerInitializationUserAccount) + err = core.UnmarshalPrimitive(m, "encrypted_password", &obj.EncryptedPassword) + if err != nil { + return + } + err = core.UnmarshalModel(m, "encryption_key", &obj.EncryptionKey, UnmarshalKeyReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "username", &obj.Username) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerLifecycleReason : BareMetalServerLifecycleReason struct +type BareMetalServerLifecycleReason struct { + // A snake case string succinctly identifying the reason for this lifecycle state. + Code *string `json:"code" validate:"required"` + + // An explanation of the reason for this lifecycle state. + Message *string `json:"message" validate:"required"` + + // Link to documentation about the reason for this lifecycle state. + MoreInfo *string `json:"more_info,omitempty"` +} + +// Constants associated with the BareMetalServerLifecycleReason.Code property. +// A snake case string succinctly identifying the reason for this lifecycle state. +const ( + BareMetalServerLifecycleReasonCodeResourceSuspendedByProviderConst = "resource_suspended_by_provider" +) + +// UnmarshalBareMetalServerLifecycleReason unmarshals an instance of BareMetalServerLifecycleReason from the specified map of raw messages. +func UnmarshalBareMetalServerLifecycleReason(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerLifecycleReason) + err = core.UnmarshalPrimitive(m, "code", &obj.Code) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "message", &obj.Message) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerNetworkInterface : BareMetalServerNetworkInterface struct +// Models which "extend" this model: +// - BareMetalServerNetworkInterfaceByHiperSocket +// - BareMetalServerNetworkInterfaceByPci +// - BareMetalServerNetworkInterfaceByVlan +type BareMetalServerNetworkInterface struct { + // Indicates whether source IP spoofing is allowed on this bare metal server network interface. + AllowIPSpoofing *bool `json:"allow_ip_spoofing" validate:"required"` + + // The date and time that the bare metal server network interface was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // If `true`: + // - The VPC infrastructure performs any needed NAT operations. + // - `floating_ips` must not have more than one floating IP. + // + // If `false`: + // - Packets are passed unchanged to/from the bare metal server network interface, + // allowing the workload to perform any needed NAT operations. + // - `allow_ip_spoofing` must be `false`. + // - `interface_type` must not be `hipersocket`. + EnableInfrastructureNat *bool `json:"enable_infrastructure_nat" validate:"required"` + + // The floating IPs associated with this bare metal server network interface. + FloatingIps []FloatingIPReference `json:"floating_ips" validate:"required"` + + // The URL for this bare metal server network interface. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this bare metal server network interface. + ID *string `json:"id" validate:"required"` + + // The interface type: + // - `hipersocket`: a virtual device that provides high-speed TCP/IP connectivity + // within a `s390x` based system + // - `pci`: a physical PCI device which can only be created or deleted when the bare metal + // server is stopped + // - Has an `allowed_vlans` property which controls the VLANs that will be permitted + // to use the PCI interface + // - Cannot directly use an IEEE 802.1q VLAN tag. + // - `vlan`: a virtual device, used through a `pci` device that has the `vlan` in its + // array of `allowed_vlans`. + // - Must use an IEEE 802.1q tag. + // - Has its own security groups and does not inherit those of the PCI device through + // which traffic flows. + // + // The enumerated values for this property are expected to expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the + // unexpected property value was encountered. + InterfaceType *string `json:"interface_type" validate:"required"` + + // The MAC address of this bare metal server network interface. If the MAC address has not yet been selected, the value + // will be an empty string. + MacAddress *string `json:"mac_address" validate:"required"` + + // The name for this bare metal server network interface. + Name *string `json:"name" validate:"required"` + + // The bare metal server network interface port speed in Mbps. + PortSpeed *int64 `json:"port_speed" validate:"required"` + + PrimaryIP *ReservedIPReference `json:"primary_ip" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The security groups targeting this bare metal server network interface. + SecurityGroups []SecurityGroupReference `json:"security_groups" validate:"required"` + + // The status of the bare metal server network interface. + Status *string `json:"status" validate:"required"` + + // The associated subnet. + Subnet *SubnetReference `json:"subnet" validate:"required"` + + // The bare metal server network interface type. + Type *string `json:"type" validate:"required"` + + // Indicates what VLAN IDs (for VLAN type only) can use this physical (PCI type) interface. + AllowedVlans []int64 `json:"allowed_vlans,omitempty"` + + // Indicates if the interface can float to any other server within the same + // `resource_group`. The interface will float automatically if the network detects a GARP or RARP on another bare metal + // server in the resource group. Applies only to `vlan` type interfaces. + AllowInterfaceToFloat *bool `json:"allow_interface_to_float,omitempty"` + + // Indicates the 802.1Q VLAN ID tag that must be used for all traffic on this interface. + Vlan *int64 `json:"vlan,omitempty"` +} + +// Constants associated with the BareMetalServerNetworkInterface.InterfaceType property. +// The interface type: +// - `hipersocket`: a virtual device that provides high-speed TCP/IP connectivity +// within a `s390x` based system +// - `pci`: a physical PCI device which can only be created or deleted when the bare metal +// server is stopped +// - Has an `allowed_vlans` property which controls the VLANs that will be permitted +// to use the PCI interface +// - Cannot directly use an IEEE 802.1q VLAN tag. +// - `vlan`: a virtual device, used through a `pci` device that has the `vlan` in its +// array of `allowed_vlans`. +// - Must use an IEEE 802.1q tag. +// - Has its own security groups and does not inherit those of the PCI device through +// which traffic flows. +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the +// unexpected property value was encountered. +const ( + BareMetalServerNetworkInterfaceInterfaceTypeHipersocketConst = "hipersocket" + BareMetalServerNetworkInterfaceInterfaceTypePciConst = "pci" + BareMetalServerNetworkInterfaceInterfaceTypeVlanConst = "vlan" +) + +// Constants associated with the BareMetalServerNetworkInterface.ResourceType property. +// The resource type. +const ( + BareMetalServerNetworkInterfaceResourceTypeNetworkInterfaceConst = "network_interface" +) + +// Constants associated with the BareMetalServerNetworkInterface.Status property. +// The status of the bare metal server network interface. +const ( + BareMetalServerNetworkInterfaceStatusAvailableConst = "available" + BareMetalServerNetworkInterfaceStatusDeletingConst = "deleting" + BareMetalServerNetworkInterfaceStatusFailedConst = "failed" + BareMetalServerNetworkInterfaceStatusPendingConst = "pending" +) + +// Constants associated with the BareMetalServerNetworkInterface.Type property. +// The bare metal server network interface type. +const ( + BareMetalServerNetworkInterfaceTypePrimaryConst = "primary" + BareMetalServerNetworkInterfaceTypeSecondaryConst = "secondary" +) + +func (*BareMetalServerNetworkInterface) isaBareMetalServerNetworkInterface() bool { + return true +} + +type BareMetalServerNetworkInterfaceIntf interface { + isaBareMetalServerNetworkInterface() bool +} + +// UnmarshalBareMetalServerNetworkInterface unmarshals an instance of BareMetalServerNetworkInterface from the specified map of raw messages. +func UnmarshalBareMetalServerNetworkInterface(m map[string]json.RawMessage, result interface{}) (err error) { + // Retrieve discriminator value to determine correct "subclass". + var discValue string + err = core.UnmarshalPrimitive(m, "interface_type", &discValue) + if err != nil { + err = fmt.Errorf("error unmarshalling discriminator property 'interface_type': %s", err.Error()) + return + } + if discValue == "" { + err = fmt.Errorf("required discriminator property 'interface_type' not found in JSON object") + return + } + if discValue == "hipersocket" { + err = core.UnmarshalModel(m, "", result, UnmarshalBareMetalServerNetworkInterfaceByHiperSocket) + } else if discValue == "pci" { + err = core.UnmarshalModel(m, "", result, UnmarshalBareMetalServerNetworkInterfaceByPci) + } else if discValue == "vlan" { + err = core.UnmarshalModel(m, "", result, UnmarshalBareMetalServerNetworkInterfaceByVlan) + } else { + err = fmt.Errorf("unrecognized value for discriminator property 'interface_type': %s", discValue) + } + return +} + +// BareMetalServerNetworkInterfaceCollection : BareMetalServerNetworkInterfaceCollection struct +type BareMetalServerNetworkInterfaceCollection struct { + // A link to the first page of resources. + First *BareMetalServerNetworkInterfaceCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // Collection of bare metal server network interfaces. + NetworkInterfaces []BareMetalServerNetworkInterfaceIntf `json:"network_interfaces" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *BareMetalServerNetworkInterfaceCollectionNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalBareMetalServerNetworkInterfaceCollection unmarshals an instance of BareMetalServerNetworkInterfaceCollection from the specified map of raw messages. +func UnmarshalBareMetalServerNetworkInterfaceCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerNetworkInterfaceCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalBareMetalServerNetworkInterfaceCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "network_interfaces", &obj.NetworkInterfaces, UnmarshalBareMetalServerNetworkInterface) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalBareMetalServerNetworkInterfaceCollectionNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *BareMetalServerNetworkInterfaceCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// BareMetalServerNetworkInterfaceCollectionFirst : A link to the first page of resources. +type BareMetalServerNetworkInterfaceCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalBareMetalServerNetworkInterfaceCollectionFirst unmarshals an instance of BareMetalServerNetworkInterfaceCollectionFirst from the specified map of raw messages. +func UnmarshalBareMetalServerNetworkInterfaceCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerNetworkInterfaceCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerNetworkInterfaceCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type BareMetalServerNetworkInterfaceCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalBareMetalServerNetworkInterfaceCollectionNext unmarshals an instance of BareMetalServerNetworkInterfaceCollectionNext from the specified map of raw messages. +func UnmarshalBareMetalServerNetworkInterfaceCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerNetworkInterfaceCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerNetworkInterfacePatch : BareMetalServerNetworkInterfacePatch struct +type BareMetalServerNetworkInterfacePatch struct { + // Indicates whether source IP spoofing is allowed on this bare metal server network interface. + AllowIPSpoofing *bool `json:"allow_ip_spoofing,omitempty"` + + // Indicates what VLAN IDs (for VLAN type only) can use this physical (PCI type) interface. + AllowedVlans []int64 `json:"allowed_vlans,omitempty"` + + // If `true`: + // - The VPC infrastructure performs any needed NAT operations. + // - `floating_ips` must not have more than one floating IP. + // + // If `false`: + // - Packets are passed unchanged to/from the bare metal server network interface, + // allowing the workload to perform any needed NAT operations. + // - `allow_ip_spoofing` must be `false`. + // - `interface_type` must not be `hipersocket`. + EnableInfrastructureNat *bool `json:"enable_infrastructure_nat,omitempty"` + + // The name for this bare metal server network interface. The name must not be used by another network interface on the + // bare metal server. + Name *string `json:"name,omitempty"` +} + +// UnmarshalBareMetalServerNetworkInterfacePatch unmarshals an instance of BareMetalServerNetworkInterfacePatch from the specified map of raw messages. +func UnmarshalBareMetalServerNetworkInterfacePatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerNetworkInterfacePatch) + err = core.UnmarshalPrimitive(m, "allow_ip_spoofing", &obj.AllowIPSpoofing) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "allowed_vlans", &obj.AllowedVlans) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "enable_infrastructure_nat", &obj.EnableInfrastructureNat) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the BareMetalServerNetworkInterfacePatch +func (bareMetalServerNetworkInterfacePatch *BareMetalServerNetworkInterfacePatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(bareMetalServerNetworkInterfacePatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// BareMetalServerNetworkInterfacePrototype : BareMetalServerNetworkInterfacePrototype struct +// Models which "extend" this model: +// - BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByHiperSocketPrototype +// - BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByPciPrototype +// - BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByVlanPrototype +type BareMetalServerNetworkInterfacePrototype struct { + // Indicates whether source IP spoofing is allowed on this bare metal server network interface. + AllowIPSpoofing *bool `json:"allow_ip_spoofing,omitempty"` + + // If `true`: + // - The VPC infrastructure performs any needed NAT operations. + // - `floating_ips` must not have more than one floating IP. + // + // If `false`: + // - Packets are passed unchanged to/from the bare metal server network interface, + // allowing the workload to perform any needed NAT operations. + // - `allow_ip_spoofing` must be `false`. + // - `interface_type` must not be `hipersocket`. + EnableInfrastructureNat *bool `json:"enable_infrastructure_nat,omitempty"` + + // The interface type: + // - `hipersocket`: a virtual device that provides high-speed TCP/IP connectivity + // within a `s390x` based system + // - Not supported on bare metal servers with a `cpu.architecture` of `amd64` + // - `pci`: a physical PCI device which can only be created or deleted when the bare metal + // server is stopped + // - Has an `allowed_vlans` property which controls the VLANs that will be permitted + // to use the PCI interface + // - Cannot directly use an IEEE 802.1q VLAN tag. + // - Not supported on bare metal servers with a `cpu.architecture` of `s390x` + // - `vlan`: a virtual device, used through a `pci` device that has the `vlan` in its + // array of `allowed_vlans`. + // - Must use an IEEE 802.1q tag. + // - Has its own security groups and does not inherit those of the PCI device through + // which traffic flows. + // - Not supported on bare metal servers with a `cpu.architecture` of `s390x`. + InterfaceType *string `json:"interface_type" validate:"required"` + + // The name for this bare metal server network interface. The name must not be used by another network interface on the + // bare metal server. If unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The primary IP address to bind to the bare metal server network interface. This can be + // specified using an existing reserved IP, or a prototype object for a new reserved IP. + // + // If an existing reserved IP or a prototype object with an address is specified, it must + // be available on the bare metal server network interface's subnet. Otherwise, an + // available address on the subnet will be automatically selected and reserved. + PrimaryIP NetworkInterfaceIPPrototypeIntf `json:"primary_ip,omitempty"` + + // The security groups to use for this bare metal server network interface. If unspecified, the VPC's default security + // group is used. + SecurityGroups []SecurityGroupIdentityIntf `json:"security_groups,omitempty"` + + // The associated subnet. + Subnet SubnetIdentityIntf `json:"subnet" validate:"required"` + + // Indicates what VLAN IDs (for VLAN type only) can use this physical (PCI type) interface. + AllowedVlans []int64 `json:"allowed_vlans,omitempty"` + + // Indicates if the interface can float to any other server within the same + // `resource_group`. The interface will float automatically if the network detects a GARP or RARP on another bare metal + // server in the resource group. Applies only to `vlan` type interfaces. + AllowInterfaceToFloat *bool `json:"allow_interface_to_float,omitempty"` + + // Indicates the 802.1Q VLAN ID tag that must be used for all traffic on this interface. + Vlan *int64 `json:"vlan,omitempty"` +} + +// Constants associated with the BareMetalServerNetworkInterfacePrototype.InterfaceType property. +// The interface type: +// - `hipersocket`: a virtual device that provides high-speed TCP/IP connectivity +// within a `s390x` based system +// - Not supported on bare metal servers with a `cpu.architecture` of `amd64` +// - `pci`: a physical PCI device which can only be created or deleted when the bare metal +// server is stopped +// - Has an `allowed_vlans` property which controls the VLANs that will be permitted +// to use the PCI interface +// - Cannot directly use an IEEE 802.1q VLAN tag. +// - Not supported on bare metal servers with a `cpu.architecture` of `s390x` +// - `vlan`: a virtual device, used through a `pci` device that has the `vlan` in its +// array of `allowed_vlans`. +// - Must use an IEEE 802.1q tag. +// - Has its own security groups and does not inherit those of the PCI device through +// which traffic flows. +// - Not supported on bare metal servers with a `cpu.architecture` of `s390x`. +const ( + BareMetalServerNetworkInterfacePrototypeInterfaceTypeHipersocketConst = "hipersocket" + BareMetalServerNetworkInterfacePrototypeInterfaceTypePciConst = "pci" + BareMetalServerNetworkInterfacePrototypeInterfaceTypeVlanConst = "vlan" +) + +func (*BareMetalServerNetworkInterfacePrototype) isaBareMetalServerNetworkInterfacePrototype() bool { + return true +} + +type BareMetalServerNetworkInterfacePrototypeIntf interface { + isaBareMetalServerNetworkInterfacePrototype() bool +} + +// UnmarshalBareMetalServerNetworkInterfacePrototype unmarshals an instance of BareMetalServerNetworkInterfacePrototype from the specified map of raw messages. +func UnmarshalBareMetalServerNetworkInterfacePrototype(m map[string]json.RawMessage, result interface{}) (err error) { + // Retrieve discriminator value to determine correct "subclass". + var discValue string + err = core.UnmarshalPrimitive(m, "interface_type", &discValue) + if err != nil { + err = fmt.Errorf("error unmarshalling discriminator property 'interface_type': %s", err.Error()) + return + } + if discValue == "" { + err = fmt.Errorf("required discriminator property 'interface_type' not found in JSON object") + return + } + if discValue == "hipersocket" { + err = core.UnmarshalModel(m, "", result, UnmarshalBareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByHiperSocketPrototype) + } else if discValue == "pci" { + err = core.UnmarshalModel(m, "", result, UnmarshalBareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByPciPrototype) + } else if discValue == "vlan" { + err = core.UnmarshalModel(m, "", result, UnmarshalBareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByVlanPrototype) + } else { + err = fmt.Errorf("unrecognized value for discriminator property 'interface_type': %s", discValue) + } + return +} + +// BareMetalServerNetworkInterfaceReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type BareMetalServerNetworkInterfaceReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalBareMetalServerNetworkInterfaceReferenceDeleted unmarshals an instance of BareMetalServerNetworkInterfaceReferenceDeleted from the specified map of raw messages. +func UnmarshalBareMetalServerNetworkInterfaceReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerNetworkInterfaceReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerNetworkInterfaceReferenceTargetContextDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type BareMetalServerNetworkInterfaceReferenceTargetContextDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalBareMetalServerNetworkInterfaceReferenceTargetContextDeleted unmarshals an instance of BareMetalServerNetworkInterfaceReferenceTargetContextDeleted from the specified map of raw messages. +func UnmarshalBareMetalServerNetworkInterfaceReferenceTargetContextDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerNetworkInterfaceReferenceTargetContextDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerPatch : BareMetalServerPatch struct +type BareMetalServerPatch struct { + // Indicates whether secure boot is enabled. If enabled, the image must support secure boot or the bare metal server + // will fail to boot. + // + // For `enable_secure_boot` to be changed, the bare metal server `status` must be + // `stopped`. + EnableSecureBoot *bool `json:"enable_secure_boot,omitempty"` + + // The name for this bare metal server. The name must not be used by another bare metal server in the region. Changing + // the name will not affect the system hostname. + Name *string `json:"name,omitempty"` + + TrustedPlatformModule *BareMetalServerTrustedPlatformModulePatch `json:"trusted_platform_module,omitempty"` +} + +// UnmarshalBareMetalServerPatch unmarshals an instance of BareMetalServerPatch from the specified map of raw messages. +func UnmarshalBareMetalServerPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerPatch) + err = core.UnmarshalPrimitive(m, "enable_secure_boot", &obj.EnableSecureBoot) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "trusted_platform_module", &obj.TrustedPlatformModule, UnmarshalBareMetalServerTrustedPlatformModulePatch) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the BareMetalServerPatch +func (bareMetalServerPatch *BareMetalServerPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(bareMetalServerPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// BareMetalServerPrimaryNetworkInterfacePrototype : BareMetalServerPrimaryNetworkInterfacePrototype struct +type BareMetalServerPrimaryNetworkInterfacePrototype struct { + // Indicates whether source IP spoofing is allowed on this bare metal server network interface. + AllowIPSpoofing *bool `json:"allow_ip_spoofing,omitempty"` + + // Indicates what VLAN IDs (for VLAN type only) can use this physical (PCI type) interface. + AllowedVlans []int64 `json:"allowed_vlans,omitempty"` + + // If `true`: + // - The VPC infrastructure performs any needed NAT operations. + // - `floating_ips` must not have more than one floating IP. + // + // If `false`: + // - Packets are passed unchanged to/from the bare metal server network interface, + // allowing the workload to perform any needed NAT operations. + // - `allow_ip_spoofing` must be `false`. + // - `interface_type` must not be `hipersocket`. + EnableInfrastructureNat *bool `json:"enable_infrastructure_nat,omitempty"` + + // The interface type: + // - `hipersocket`: a virtual device that provides high-speed TCP/IP connectivity + // within a `s390x` based system. + // - Not supported on bare metal servers with a `cpu.architecture` of `amd64` + // - `pci`: a physical PCI device which can only be created or deleted when the bare metal + // server is stopped + // - Has an `allowed_vlans` property which controls the VLANs that will be permitted + // to use the PCI interface + // - Cannot directly use an IEEE 802.1q VLAN tag. + // - Not supported on bare metal servers with a `cpu.architecture` of `s390x`. + InterfaceType *string `json:"interface_type,omitempty"` + + // The name for this bare metal server network interface. The name must not be used by another network interface on the + // bare metal server. If unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The primary IP address to bind to the bare metal server network interface. This can be + // specified using an existing reserved IP, or a prototype object for a new reserved IP. + // + // If an existing reserved IP or a prototype object with an address is specified, it must + // be available on the bare metal server network interface's subnet. Otherwise, an + // available address on the subnet will be automatically selected and reserved. + PrimaryIP NetworkInterfaceIPPrototypeIntf `json:"primary_ip,omitempty"` + + // The security groups to use for this bare metal server network interface. If unspecified, the VPC's default security + // group is used. + SecurityGroups []SecurityGroupIdentityIntf `json:"security_groups,omitempty"` + + // The associated subnet. + Subnet SubnetIdentityIntf `json:"subnet" validate:"required"` +} + +// Constants associated with the BareMetalServerPrimaryNetworkInterfacePrototype.InterfaceType property. +// The interface type: +// - `hipersocket`: a virtual device that provides high-speed TCP/IP connectivity +// within a `s390x` based system. +// - Not supported on bare metal servers with a `cpu.architecture` of `amd64` +// - `pci`: a physical PCI device which can only be created or deleted when the bare metal +// server is stopped +// - Has an `allowed_vlans` property which controls the VLANs that will be permitted +// to use the PCI interface +// - Cannot directly use an IEEE 802.1q VLAN tag. +// - Not supported on bare metal servers with a `cpu.architecture` of `s390x`. +const ( + BareMetalServerPrimaryNetworkInterfacePrototypeInterfaceTypeHipersocketConst = "hipersocket" + BareMetalServerPrimaryNetworkInterfacePrototypeInterfaceTypePciConst = "pci" +) + +// NewBareMetalServerPrimaryNetworkInterfacePrototype : Instantiate BareMetalServerPrimaryNetworkInterfacePrototype (Generic Model Constructor) +func (*VpcV1) NewBareMetalServerPrimaryNetworkInterfacePrototype(subnet SubnetIdentityIntf) (_model *BareMetalServerPrimaryNetworkInterfacePrototype, err error) { + _model = &BareMetalServerPrimaryNetworkInterfacePrototype{ + Subnet: subnet, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalBareMetalServerPrimaryNetworkInterfacePrototype unmarshals an instance of BareMetalServerPrimaryNetworkInterfacePrototype from the specified map of raw messages. +func UnmarshalBareMetalServerPrimaryNetworkInterfacePrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerPrimaryNetworkInterfacePrototype) + err = core.UnmarshalPrimitive(m, "allow_ip_spoofing", &obj.AllowIPSpoofing) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "allowed_vlans", &obj.AllowedVlans) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "enable_infrastructure_nat", &obj.EnableInfrastructureNat) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "interface_type", &obj.InterfaceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_ip", &obj.PrimaryIP, UnmarshalNetworkInterfaceIPPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "security_groups", &obj.SecurityGroups, UnmarshalSecurityGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnet", &obj.Subnet, UnmarshalSubnetIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfile : BareMetalServerProfile struct +type BareMetalServerProfile struct { + Bandwidth BareMetalServerProfileBandwidthIntf `json:"bandwidth" validate:"required"` + + // The console type configuration for a bare metal server with this profile. + ConsoleTypes *BareMetalServerProfileConsoleTypes `json:"console_types" validate:"required"` + + CpuArchitecture *BareMetalServerProfileCpuArchitecture `json:"cpu_architecture" validate:"required"` + + CpuCoreCount BareMetalServerProfileCpuCoreCountIntf `json:"cpu_core_count" validate:"required"` + + CpuSocketCount BareMetalServerProfileCpuSocketCountIntf `json:"cpu_socket_count" validate:"required"` + + // Collection of the bare metal server profile's disks. + Disks []BareMetalServerProfileDisk `json:"disks" validate:"required"` + + // The product family this bare metal server profile belongs to. + Family *string `json:"family" validate:"required"` + + // The URL for this bare metal server profile. + Href *string `json:"href" validate:"required"` + + Memory BareMetalServerProfileMemoryIntf `json:"memory" validate:"required"` + + // The name for this bare metal server profile. + Name *string `json:"name" validate:"required"` + + NetworkInterfaceCount BareMetalServerProfileNetworkInterfaceCountIntf `json:"network_interface_count" validate:"required"` + + OsArchitecture *BareMetalServerProfileOsArchitecture `json:"os_architecture" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The supported trusted platform module modes for this bare metal server profile. + SupportedTrustedPlatformModuleModes *BareMetalServerProfileSupportedTrustedPlatformModuleModes `json:"supported_trusted_platform_module_modes" validate:"required"` +} + +// Constants associated with the BareMetalServerProfile.ResourceType property. +// The resource type. +const ( + BareMetalServerProfileResourceTypeBareMetalServerProfileConst = "bare_metal_server_profile" +) + +// UnmarshalBareMetalServerProfile unmarshals an instance of BareMetalServerProfile from the specified map of raw messages. +func UnmarshalBareMetalServerProfile(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfile) + err = core.UnmarshalModel(m, "bandwidth", &obj.Bandwidth, UnmarshalBareMetalServerProfileBandwidth) + if err != nil { + return + } + err = core.UnmarshalModel(m, "console_types", &obj.ConsoleTypes, UnmarshalBareMetalServerProfileConsoleTypes) + if err != nil { + return + } + err = core.UnmarshalModel(m, "cpu_architecture", &obj.CpuArchitecture, UnmarshalBareMetalServerProfileCpuArchitecture) + if err != nil { + return + } + err = core.UnmarshalModel(m, "cpu_core_count", &obj.CpuCoreCount, UnmarshalBareMetalServerProfileCpuCoreCount) + if err != nil { + return + } + err = core.UnmarshalModel(m, "cpu_socket_count", &obj.CpuSocketCount, UnmarshalBareMetalServerProfileCpuSocketCount) + if err != nil { + return + } + err = core.UnmarshalModel(m, "disks", &obj.Disks, UnmarshalBareMetalServerProfileDisk) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "family", &obj.Family) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalModel(m, "memory", &obj.Memory, UnmarshalBareMetalServerProfileMemory) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "network_interface_count", &obj.NetworkInterfaceCount, UnmarshalBareMetalServerProfileNetworkInterfaceCount) + if err != nil { + return + } + err = core.UnmarshalModel(m, "os_architecture", &obj.OsArchitecture, UnmarshalBareMetalServerProfileOsArchitecture) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalModel(m, "supported_trusted_platform_module_modes", &obj.SupportedTrustedPlatformModuleModes, UnmarshalBareMetalServerProfileSupportedTrustedPlatformModuleModes) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileBandwidth : BareMetalServerProfileBandwidth struct +// Models which "extend" this model: +// - BareMetalServerProfileBandwidthFixed +// - BareMetalServerProfileBandwidthRange +// - BareMetalServerProfileBandwidthEnum +// - BareMetalServerProfileBandwidthDependent +type BareMetalServerProfileBandwidth struct { + // The type for this profile field. + Type *string `json:"type,omitempty"` + + // The value for this profile field. + Value *int64 `json:"value,omitempty"` + + // The default value for this profile field. + Default *int64 `json:"default,omitempty"` + + // The maximum value for this profile field. + Max *int64 `json:"max,omitempty"` + + // The minimum value for this profile field. + Min *int64 `json:"min,omitempty"` + + // The increment step value for this profile field. + Step *int64 `json:"step,omitempty"` + + // The permitted values for this profile field. + Values []int64 `json:"values,omitempty"` +} + +// Constants associated with the BareMetalServerProfileBandwidth.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileBandwidthTypeFixedConst = "fixed" +) + +func (*BareMetalServerProfileBandwidth) isaBareMetalServerProfileBandwidth() bool { + return true +} + +type BareMetalServerProfileBandwidthIntf interface { + isaBareMetalServerProfileBandwidth() bool +} + +// UnmarshalBareMetalServerProfileBandwidth unmarshals an instance of BareMetalServerProfileBandwidth from the specified map of raw messages. +func UnmarshalBareMetalServerProfileBandwidth(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileBandwidth) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileCpuArchitecture : BareMetalServerProfileCpuArchitecture struct +type BareMetalServerProfileCpuArchitecture struct { + // The default CPU architecture for a bare metal server with this profile. + Default *string `json:"default,omitempty"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The CPU architecture for a bare metal server with this profile. + Value *string `json:"value" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileCpuArchitecture.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileCpuArchitectureTypeFixedConst = "fixed" +) + +// UnmarshalBareMetalServerProfileCpuArchitecture unmarshals an instance of BareMetalServerProfileCpuArchitecture from the specified map of raw messages. +func UnmarshalBareMetalServerProfileCpuArchitecture(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileCpuArchitecture) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileCpuCoreCount : BareMetalServerProfileCpuCoreCount struct +// Models which "extend" this model: +// - BareMetalServerProfileCpuCoreCountFixed +// - BareMetalServerProfileCpuCoreCountRange +// - BareMetalServerProfileCpuCoreCountEnum +// - BareMetalServerProfileCpuCoreCountDependent +type BareMetalServerProfileCpuCoreCount struct { + // The type for this profile field. + Type *string `json:"type,omitempty"` + + // The value for this profile field. + Value *int64 `json:"value,omitempty"` + + // The default value for this profile field. + Default *int64 `json:"default,omitempty"` + + // The maximum value for this profile field. + Max *int64 `json:"max,omitempty"` + + // The minimum value for this profile field. + Min *int64 `json:"min,omitempty"` + + // The increment step value for this profile field. + Step *int64 `json:"step,omitempty"` + + // The permitted values for this profile field. + Values []int64 `json:"values,omitempty"` +} + +// Constants associated with the BareMetalServerProfileCpuCoreCount.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileCpuCoreCountTypeFixedConst = "fixed" +) + +func (*BareMetalServerProfileCpuCoreCount) isaBareMetalServerProfileCpuCoreCount() bool { + return true +} + +type BareMetalServerProfileCpuCoreCountIntf interface { + isaBareMetalServerProfileCpuCoreCount() bool +} + +// UnmarshalBareMetalServerProfileCpuCoreCount unmarshals an instance of BareMetalServerProfileCpuCoreCount from the specified map of raw messages. +func UnmarshalBareMetalServerProfileCpuCoreCount(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileCpuCoreCount) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileCpuSocketCount : BareMetalServerProfileCpuSocketCount struct +// Models which "extend" this model: +// - BareMetalServerProfileCpuSocketCountFixed +// - BareMetalServerProfileCpuSocketCountRange +// - BareMetalServerProfileCpuSocketCountEnum +// - BareMetalServerProfileCpuSocketCountDependent +type BareMetalServerProfileCpuSocketCount struct { + // The type for this profile field. + Type *string `json:"type,omitempty"` + + // The value for this profile field. + Value *int64 `json:"value,omitempty"` + + // The default value for this profile field. + Default *int64 `json:"default,omitempty"` + + // The maximum value for this profile field. + Max *int64 `json:"max,omitempty"` + + // The minimum value for this profile field. + Min *int64 `json:"min,omitempty"` + + // The increment step value for this profile field. + Step *int64 `json:"step,omitempty"` + + // The permitted values for this profile field. + Values []int64 `json:"values,omitempty"` +} + +// Constants associated with the BareMetalServerProfileCpuSocketCount.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileCpuSocketCountTypeFixedConst = "fixed" +) + +func (*BareMetalServerProfileCpuSocketCount) isaBareMetalServerProfileCpuSocketCount() bool { + return true +} + +type BareMetalServerProfileCpuSocketCountIntf interface { + isaBareMetalServerProfileCpuSocketCount() bool +} + +// UnmarshalBareMetalServerProfileCpuSocketCount unmarshals an instance of BareMetalServerProfileCpuSocketCount from the specified map of raw messages. +func UnmarshalBareMetalServerProfileCpuSocketCount(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileCpuSocketCount) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileCollection : BareMetalServerProfileCollection struct +type BareMetalServerProfileCollection struct { + // A link to the first page of resources. + First *BareMetalServerProfileCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *BareMetalServerProfileCollectionNext `json:"next,omitempty"` + + // Collection of bare metal server profiles. + Profiles []BareMetalServerProfile `json:"profiles" validate:"required"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalBareMetalServerProfileCollection unmarshals an instance of BareMetalServerProfileCollection from the specified map of raw messages. +func UnmarshalBareMetalServerProfileCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalBareMetalServerProfileCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalBareMetalServerProfileCollectionNext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profiles", &obj.Profiles, UnmarshalBareMetalServerProfile) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *BareMetalServerProfileCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// BareMetalServerProfileCollectionFirst : A link to the first page of resources. +type BareMetalServerProfileCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalBareMetalServerProfileCollectionFirst unmarshals an instance of BareMetalServerProfileCollectionFirst from the specified map of raw messages. +func UnmarshalBareMetalServerProfileCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type BareMetalServerProfileCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalBareMetalServerProfileCollectionNext unmarshals an instance of BareMetalServerProfileCollectionNext from the specified map of raw messages. +func UnmarshalBareMetalServerProfileCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileConsoleTypes : The console type configuration for a bare metal server with this profile. +type BareMetalServerProfileConsoleTypes struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The console types for a bare metal server with this profile. + Values []string `json:"values" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileConsoleTypes.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileConsoleTypesTypeEnumConst = "enum" +) + +// Constants associated with the BareMetalServerProfileConsoleTypes.Values property. +// A console type. +const ( + BareMetalServerProfileConsoleTypesValuesSerialConst = "serial" + BareMetalServerProfileConsoleTypesValuesVncConst = "vnc" +) + +// UnmarshalBareMetalServerProfileConsoleTypes unmarshals an instance of BareMetalServerProfileConsoleTypes from the specified map of raw messages. +func UnmarshalBareMetalServerProfileConsoleTypes(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileConsoleTypes) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileDisk : Disks provided by this profile. +type BareMetalServerProfileDisk struct { + Quantity BareMetalServerProfileDiskQuantityIntf `json:"quantity" validate:"required"` + + Size BareMetalServerProfileDiskSizeIntf `json:"size" validate:"required"` + + SupportedInterfaceTypes *BareMetalServerProfileDiskSupportedInterfaces `json:"supported_interface_types" validate:"required"` +} + +// UnmarshalBareMetalServerProfileDisk unmarshals an instance of BareMetalServerProfileDisk from the specified map of raw messages. +func UnmarshalBareMetalServerProfileDisk(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileDisk) + err = core.UnmarshalModel(m, "quantity", &obj.Quantity, UnmarshalBareMetalServerProfileDiskQuantity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "size", &obj.Size, UnmarshalBareMetalServerProfileDiskSize) + if err != nil { + return + } + err = core.UnmarshalModel(m, "supported_interface_types", &obj.SupportedInterfaceTypes, UnmarshalBareMetalServerProfileDiskSupportedInterfaces) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileDiskQuantity : BareMetalServerProfileDiskQuantity struct +// Models which "extend" this model: +// - BareMetalServerProfileDiskQuantityFixed +// - BareMetalServerProfileDiskQuantityRange +// - BareMetalServerProfileDiskQuantityEnum +// - BareMetalServerProfileDiskQuantityDependent +type BareMetalServerProfileDiskQuantity struct { + // The type for this profile field. + Type *string `json:"type,omitempty"` + + // The value for this profile field. + Value *int64 `json:"value,omitempty"` + + // The default value for this profile field. + Default *int64 `json:"default,omitempty"` + + // The maximum value for this profile field. + Max *int64 `json:"max,omitempty"` + + // The minimum value for this profile field. + Min *int64 `json:"min,omitempty"` + + // The increment step value for this profile field. + Step *int64 `json:"step,omitempty"` + + // The permitted values for this profile field. + Values []int64 `json:"values,omitempty"` +} + +// Constants associated with the BareMetalServerProfileDiskQuantity.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileDiskQuantityTypeFixedConst = "fixed" +) + +func (*BareMetalServerProfileDiskQuantity) isaBareMetalServerProfileDiskQuantity() bool { + return true +} + +type BareMetalServerProfileDiskQuantityIntf interface { + isaBareMetalServerProfileDiskQuantity() bool +} + +// UnmarshalBareMetalServerProfileDiskQuantity unmarshals an instance of BareMetalServerProfileDiskQuantity from the specified map of raw messages. +func UnmarshalBareMetalServerProfileDiskQuantity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileDiskQuantity) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileDiskSize : BareMetalServerProfileDiskSize struct +// Models which "extend" this model: +// - BareMetalServerProfileDiskSizeFixed +// - BareMetalServerProfileDiskSizeRange +// - BareMetalServerProfileDiskSizeEnum +// - BareMetalServerProfileDiskSizeDependent +type BareMetalServerProfileDiskSize struct { + // The type for this profile field. + Type *string `json:"type,omitempty"` + + // The value for this profile field. + Value *int64 `json:"value,omitempty"` + + // The default value for this profile field. + Default *int64 `json:"default,omitempty"` + + // The maximum value for this profile field. + Max *int64 `json:"max,omitempty"` + + // The minimum value for this profile field. + Min *int64 `json:"min,omitempty"` + + // The increment step value for this profile field. + Step *int64 `json:"step,omitempty"` + + // The permitted values for this profile field. + Values []int64 `json:"values,omitempty"` +} + +// Constants associated with the BareMetalServerProfileDiskSize.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileDiskSizeTypeFixedConst = "fixed" +) + +func (*BareMetalServerProfileDiskSize) isaBareMetalServerProfileDiskSize() bool { + return true +} + +type BareMetalServerProfileDiskSizeIntf interface { + isaBareMetalServerProfileDiskSize() bool +} + +// UnmarshalBareMetalServerProfileDiskSize unmarshals an instance of BareMetalServerProfileDiskSize from the specified map of raw messages. +func UnmarshalBareMetalServerProfileDiskSize(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileDiskSize) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileDiskSupportedInterfaces : BareMetalServerProfileDiskSupportedInterfaces struct +type BareMetalServerProfileDiskSupportedInterfaces struct { + // The disk interface used for attaching the disk. + // + // - `fcp`: Attached using Fiber Channel Protocol + // - `sata`: Attached using Serial Advanced Technology Attachment + // - `nvme`: Attached using Non-Volatile Memory Express + // + // The enumerated values for this property are expected to expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the + // unexpected property value was encountered. + Default *string `json:"default" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The supported disk interfaces used for attaching the disk. + Values []string `json:"values" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileDiskSupportedInterfaces.Default property. +// The disk interface used for attaching the disk. +// +// - `fcp`: Attached using Fiber Channel Protocol +// - `sata`: Attached using Serial Advanced Technology Attachment +// - `nvme`: Attached using Non-Volatile Memory Express +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the +// unexpected property value was encountered. +const ( + BareMetalServerProfileDiskSupportedInterfacesDefaultFcpConst = "fcp" + BareMetalServerProfileDiskSupportedInterfacesDefaultNvmeConst = "nvme" + BareMetalServerProfileDiskSupportedInterfacesDefaultSataConst = "sata" +) + +// Constants associated with the BareMetalServerProfileDiskSupportedInterfaces.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileDiskSupportedInterfacesTypeEnumConst = "enum" +) + +// Constants associated with the BareMetalServerProfileDiskSupportedInterfaces.Values property. +// The disk interface used for attaching the disk. +// +// - `fcp`: Attached using Fiber Channel Protocol +// - `sata`: Attached using Serial Advanced Technology Attachment +// - `nvme`: Attached using Non-Volatile Memory Express +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the +// unexpected property value was encountered. +const ( + BareMetalServerProfileDiskSupportedInterfacesValuesFcpConst = "fcp" + BareMetalServerProfileDiskSupportedInterfacesValuesNvmeConst = "nvme" + BareMetalServerProfileDiskSupportedInterfacesValuesSataConst = "sata" +) + +// UnmarshalBareMetalServerProfileDiskSupportedInterfaces unmarshals an instance of BareMetalServerProfileDiskSupportedInterfaces from the specified map of raw messages. +func UnmarshalBareMetalServerProfileDiskSupportedInterfaces(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileDiskSupportedInterfaces) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileIdentity : Identifies a bare metal server profile by a unique property. +// Models which "extend" this model: +// - BareMetalServerProfileIdentityByName +// - BareMetalServerProfileIdentityByHref +type BareMetalServerProfileIdentity struct { + // The name for this bare metal server profile. + Name *string `json:"name,omitempty"` + + // The URL for this bare metal server profile. + Href *string `json:"href,omitempty"` +} + +func (*BareMetalServerProfileIdentity) isaBareMetalServerProfileIdentity() bool { + return true +} + +type BareMetalServerProfileIdentityIntf interface { + isaBareMetalServerProfileIdentity() bool +} + +// UnmarshalBareMetalServerProfileIdentity unmarshals an instance of BareMetalServerProfileIdentity from the specified map of raw messages. +func UnmarshalBareMetalServerProfileIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileIdentity) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileMemory : BareMetalServerProfileMemory struct +// Models which "extend" this model: +// - BareMetalServerProfileMemoryFixed +// - BareMetalServerProfileMemoryRange +// - BareMetalServerProfileMemoryEnum +// - BareMetalServerProfileMemoryDependent +type BareMetalServerProfileMemory struct { + // The type for this profile field. + Type *string `json:"type,omitempty"` + + // The value for this profile field. + Value *int64 `json:"value,omitempty"` + + // The default value for this profile field. + Default *int64 `json:"default,omitempty"` + + // The maximum value for this profile field. + Max *int64 `json:"max,omitempty"` + + // The minimum value for this profile field. + Min *int64 `json:"min,omitempty"` + + // The increment step value for this profile field. + Step *int64 `json:"step,omitempty"` + + // The permitted values for this profile field. + Values []int64 `json:"values,omitempty"` +} + +// Constants associated with the BareMetalServerProfileMemory.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileMemoryTypeFixedConst = "fixed" +) + +func (*BareMetalServerProfileMemory) isaBareMetalServerProfileMemory() bool { + return true +} + +type BareMetalServerProfileMemoryIntf interface { + isaBareMetalServerProfileMemory() bool +} + +// UnmarshalBareMetalServerProfileMemory unmarshals an instance of BareMetalServerProfileMemory from the specified map of raw messages. +func UnmarshalBareMetalServerProfileMemory(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileMemory) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileNetworkInterfaceCount : BareMetalServerProfileNetworkInterfaceCount struct +// Models which "extend" this model: +// - BareMetalServerProfileNetworkInterfaceCountRange +// - BareMetalServerProfileNetworkInterfaceCountDependent +type BareMetalServerProfileNetworkInterfaceCount struct { + // The maximum value for this profile field. + Max *int64 `json:"max,omitempty"` + + // The minimum value for this profile field. + Min *int64 `json:"min,omitempty"` + + // The type for this profile field. + Type *string `json:"type,omitempty"` +} + +// Constants associated with the BareMetalServerProfileNetworkInterfaceCount.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileNetworkInterfaceCountTypeRangeConst = "range" +) + +func (*BareMetalServerProfileNetworkInterfaceCount) isaBareMetalServerProfileNetworkInterfaceCount() bool { + return true +} + +type BareMetalServerProfileNetworkInterfaceCountIntf interface { + isaBareMetalServerProfileNetworkInterfaceCount() bool +} + +// UnmarshalBareMetalServerProfileNetworkInterfaceCount unmarshals an instance of BareMetalServerProfileNetworkInterfaceCount from the specified map of raw messages. +func UnmarshalBareMetalServerProfileNetworkInterfaceCount(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileNetworkInterfaceCount) + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileOsArchitecture : BareMetalServerProfileOsArchitecture struct +type BareMetalServerProfileOsArchitecture struct { + // The default OS architecture for a bare metal server with this profile. + Default *string `json:"default" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The supported OS architecture(s) for a bare metal server with this profile. + Values []string `json:"values" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileOsArchitecture.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileOsArchitectureTypeEnumConst = "enum" +) + +// UnmarshalBareMetalServerProfileOsArchitecture unmarshals an instance of BareMetalServerProfileOsArchitecture from the specified map of raw messages. +func UnmarshalBareMetalServerProfileOsArchitecture(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileOsArchitecture) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileReference : BareMetalServerProfileReference struct +type BareMetalServerProfileReference struct { + // The URL for this bare metal server profile. + Href *string `json:"href" validate:"required"` + + // The name for this bare metal server profile. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileReference.ResourceType property. +// The resource type. +const ( + BareMetalServerProfileReferenceResourceTypeBareMetalServerProfileConst = "bare_metal_server_profile" +) + +// UnmarshalBareMetalServerProfileReference unmarshals an instance of BareMetalServerProfileReference from the specified map of raw messages. +func UnmarshalBareMetalServerProfileReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileReference) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileSupportedTrustedPlatformModuleModes : The supported trusted platform module modes for this bare metal server profile. +type BareMetalServerProfileSupportedTrustedPlatformModuleModes struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The supported trusted platform module modes. + Values []string `json:"values" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileSupportedTrustedPlatformModuleModes.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileSupportedTrustedPlatformModuleModesTypeEnumConst = "enum" +) + +// Constants associated with the BareMetalServerProfileSupportedTrustedPlatformModuleModes.Values property. +// The trusted platform module (TPM) mode: +// - `disabled`: No TPM functionality +// - `tpm_2`: TPM 2.0 +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the +// unexpected property value was encountered. +const ( + BareMetalServerProfileSupportedTrustedPlatformModuleModesValuesDisabledConst = "disabled" + BareMetalServerProfileSupportedTrustedPlatformModuleModesValuesTpm2Const = "tpm_2" +) + +// UnmarshalBareMetalServerProfileSupportedTrustedPlatformModuleModes unmarshals an instance of BareMetalServerProfileSupportedTrustedPlatformModuleModes from the specified map of raw messages. +func UnmarshalBareMetalServerProfileSupportedTrustedPlatformModuleModes(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileSupportedTrustedPlatformModuleModes) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerStatusReason : BareMetalServerStatusReason struct +type BareMetalServerStatusReason struct { + // The status reason code: + // - `cannot_start`: Failed to start due to an internal error + // - `cannot_start_capacity`: Insufficient capacity within the selected zone + // - `cannot_start_compute`: An error occurred while allocating compute resources + // - `cannot_start_ip_address`: An error occurred while allocating an IP address + // - `cannot_start_network`: An error occurred while allocating network resources. + Code *string `json:"code" validate:"required"` + + // An explanation of the status reason. + Message *string `json:"message" validate:"required"` + + // Link to documentation about this status reason. + MoreInfo *string `json:"more_info,omitempty"` +} + +// Constants associated with the BareMetalServerStatusReason.Code property. +// The status reason code: +// - `cannot_start`: Failed to start due to an internal error +// - `cannot_start_capacity`: Insufficient capacity within the selected zone +// - `cannot_start_compute`: An error occurred while allocating compute resources +// - `cannot_start_ip_address`: An error occurred while allocating an IP address +// - `cannot_start_network`: An error occurred while allocating network resources. +const ( + BareMetalServerStatusReasonCodeCannotStartConst = "cannot_start" + BareMetalServerStatusReasonCodeCannotStartCapacityConst = "cannot_start_capacity" + BareMetalServerStatusReasonCodeCannotStartComputeConst = "cannot_start_compute" + BareMetalServerStatusReasonCodeCannotStartIPAddressConst = "cannot_start_ip_address" + BareMetalServerStatusReasonCodeCannotStartNetworkConst = "cannot_start_network" +) + +// UnmarshalBareMetalServerStatusReason unmarshals an instance of BareMetalServerStatusReason from the specified map of raw messages. +func UnmarshalBareMetalServerStatusReason(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerStatusReason) + err = core.UnmarshalPrimitive(m, "code", &obj.Code) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "message", &obj.Message) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerTrustedPlatformModule : BareMetalServerTrustedPlatformModule struct +type BareMetalServerTrustedPlatformModule struct { + // Indicates whether the trusted platform module is enabled. + Enabled *bool `json:"enabled" validate:"required"` + + // The trusted platform module (TPM) mode: + // - `disabled`: No TPM functionality + // - `tpm_2`: TPM 2.0 + // + // The enumerated values for this property are expected to expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the + // unexpected property value was encountered. + Mode *string `json:"mode" validate:"required"` + + // The supported trusted platform module modes. + SupportedModes []string `json:"supported_modes" validate:"required"` +} + +// Constants associated with the BareMetalServerTrustedPlatformModule.Mode property. +// The trusted platform module (TPM) mode: +// - `disabled`: No TPM functionality +// - `tpm_2`: TPM 2.0 +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the +// unexpected property value was encountered. +const ( + BareMetalServerTrustedPlatformModuleModeDisabledConst = "disabled" + BareMetalServerTrustedPlatformModuleModeTpm2Const = "tpm_2" +) + +// Constants associated with the BareMetalServerTrustedPlatformModule.SupportedModes property. +// The trusted platform module (TPM) mode: +// - `disabled`: No TPM functionality +// - `tpm_2`: TPM 2.0 +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the +// unexpected property value was encountered. +const ( + BareMetalServerTrustedPlatformModuleSupportedModesDisabledConst = "disabled" + BareMetalServerTrustedPlatformModuleSupportedModesTpm2Const = "tpm_2" +) + +// UnmarshalBareMetalServerTrustedPlatformModule unmarshals an instance of BareMetalServerTrustedPlatformModule from the specified map of raw messages. +func UnmarshalBareMetalServerTrustedPlatformModule(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerTrustedPlatformModule) + err = core.UnmarshalPrimitive(m, "enabled", &obj.Enabled) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "mode", &obj.Mode) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "supported_modes", &obj.SupportedModes) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerTrustedPlatformModulePatch : BareMetalServerTrustedPlatformModulePatch struct +type BareMetalServerTrustedPlatformModulePatch struct { + // The trusted platform module mode to use. The specified value must be listed in the bare metal server's + // `supported_modes`. + // + // For the trusted platform module mode to be changed, the bare metal server `status` must be `stopped`. + Mode *string `json:"mode,omitempty"` +} + +// Constants associated with the BareMetalServerTrustedPlatformModulePatch.Mode property. +// The trusted platform module mode to use. The specified value must be listed in the bare metal server's +// `supported_modes`. +// +// For the trusted platform module mode to be changed, the bare metal server `status` must be `stopped`. +const ( + BareMetalServerTrustedPlatformModulePatchModeDisabledConst = "disabled" + BareMetalServerTrustedPlatformModulePatchModeTpm2Const = "tpm_2" +) + +// UnmarshalBareMetalServerTrustedPlatformModulePatch unmarshals an instance of BareMetalServerTrustedPlatformModulePatch from the specified map of raw messages. +func UnmarshalBareMetalServerTrustedPlatformModulePatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerTrustedPlatformModulePatch) + err = core.UnmarshalPrimitive(m, "mode", &obj.Mode) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerTrustedPlatformModulePrototype : BareMetalServerTrustedPlatformModulePrototype struct +type BareMetalServerTrustedPlatformModulePrototype struct { + // The trusted platform module mode to use. The specified value must be listed in the bare metal server profile's + // `supported_trusted_platform_module_modes`. + Mode *string `json:"mode,omitempty"` +} + +// Constants associated with the BareMetalServerTrustedPlatformModulePrototype.Mode property. +// The trusted platform module mode to use. The specified value must be listed in the bare metal server profile's +// `supported_trusted_platform_module_modes`. +const ( + BareMetalServerTrustedPlatformModulePrototypeModeDisabledConst = "disabled" + BareMetalServerTrustedPlatformModulePrototypeModeTpm2Const = "tpm_2" +) + +// UnmarshalBareMetalServerTrustedPlatformModulePrototype unmarshals an instance of BareMetalServerTrustedPlatformModulePrototype from the specified map of raw messages. +func UnmarshalBareMetalServerTrustedPlatformModulePrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerTrustedPlatformModulePrototype) + err = core.UnmarshalPrimitive(m, "mode", &obj.Mode) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// CatalogOfferingIdentity : Identifies a [catalog](https://cloud.ibm.com/docs/account?topic=account-restrict-by-user) offering by a unique +// property. +// Models which "extend" this model: +// - CatalogOfferingIdentityCatalogOfferingByCRN +type CatalogOfferingIdentity struct { + // The CRN for this + // [catalog](https://cloud.ibm.com/docs/account?topic=account-restrict-by-user) offering. + CRN *string `json:"crn,omitempty"` +} + +func (*CatalogOfferingIdentity) isaCatalogOfferingIdentity() bool { + return true +} + +type CatalogOfferingIdentityIntf interface { + isaCatalogOfferingIdentity() bool +} + +// UnmarshalCatalogOfferingIdentity unmarshals an instance of CatalogOfferingIdentity from the specified map of raw messages. +func UnmarshalCatalogOfferingIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(CatalogOfferingIdentity) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// CatalogOfferingVersionIdentity : Identifies a version of a +// [catalog](https://cloud.ibm.com/docs/account?topic=account-restrict-by-user) offering by a unique property. +// Models which "extend" this model: +// - CatalogOfferingVersionIdentityCatalogOfferingVersionByCRN +type CatalogOfferingVersionIdentity struct { + // The CRN for this version of a + // [catalog](https://cloud.ibm.com/docs/account?topic=account-restrict-by-user) offering. + CRN *string `json:"crn,omitempty"` +} + +func (*CatalogOfferingVersionIdentity) isaCatalogOfferingVersionIdentity() bool { + return true +} + +type CatalogOfferingVersionIdentityIntf interface { + isaCatalogOfferingVersionIdentity() bool +} + +// UnmarshalCatalogOfferingVersionIdentity unmarshals an instance of CatalogOfferingVersionIdentity from the specified map of raw messages. +func UnmarshalCatalogOfferingVersionIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(CatalogOfferingVersionIdentity) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// CatalogOfferingVersionReference : CatalogOfferingVersionReference struct +type CatalogOfferingVersionReference struct { + // The CRN for this version of a + // [catalog](https://cloud.ibm.com/docs/account?topic=account-restrict-by-user) offering. + CRN *string `json:"crn" validate:"required"` +} + +// UnmarshalCatalogOfferingVersionReference unmarshals an instance of CatalogOfferingVersionReference from the specified map of raw messages. +func UnmarshalCatalogOfferingVersionReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(CatalogOfferingVersionReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// CertificateInstanceIdentity : Identifies a certificate instance by a unique property. +// Models which "extend" this model: +// - CertificateInstanceIdentityByCRN +type CertificateInstanceIdentity struct { + // The CRN for this certificate instance. + CRN *string `json:"crn,omitempty"` +} + +func (*CertificateInstanceIdentity) isaCertificateInstanceIdentity() bool { + return true +} + +type CertificateInstanceIdentityIntf interface { + isaCertificateInstanceIdentity() bool +} + +// UnmarshalCertificateInstanceIdentity unmarshals an instance of CertificateInstanceIdentity from the specified map of raw messages. +func UnmarshalCertificateInstanceIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(CertificateInstanceIdentity) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// CertificateInstanceReference : CertificateInstanceReference struct +type CertificateInstanceReference struct { + // The CRN for this certificate instance. + CRN *string `json:"crn" validate:"required"` +} + +// UnmarshalCertificateInstanceReference unmarshals an instance of CertificateInstanceReference from the specified map of raw messages. +func UnmarshalCertificateInstanceReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(CertificateInstanceReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// CheckVPNGatewayConnectionLocalCIDROptions : The CheckVPNGatewayConnectionLocalCIDR options. +type CheckVPNGatewayConnectionLocalCIDROptions struct { + // The VPN gateway identifier. + VPNGatewayID *string `json:"vpn_gateway_id" validate:"required,ne="` + + // The VPN gateway connection identifier. + ID *string `json:"id" validate:"required,ne="` + + // The address prefix part of the CIDR. + CIDRPrefix *string `json:"cidr_prefix" validate:"required,ne="` + + // The prefix length part of the CIDR. + PrefixLength *string `json:"prefix_length" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCheckVPNGatewayConnectionLocalCIDROptions : Instantiate CheckVPNGatewayConnectionLocalCIDROptions +func (*VpcV1) NewCheckVPNGatewayConnectionLocalCIDROptions(vpnGatewayID string, id string, cidrPrefix string, prefixLength string) *CheckVPNGatewayConnectionLocalCIDROptions { + return &CheckVPNGatewayConnectionLocalCIDROptions{ + VPNGatewayID: core.StringPtr(vpnGatewayID), + ID: core.StringPtr(id), + CIDRPrefix: core.StringPtr(cidrPrefix), + PrefixLength: core.StringPtr(prefixLength), + } +} + +// SetVPNGatewayID : Allow user to set VPNGatewayID +func (_options *CheckVPNGatewayConnectionLocalCIDROptions) SetVPNGatewayID(vpnGatewayID string) *CheckVPNGatewayConnectionLocalCIDROptions { + _options.VPNGatewayID = core.StringPtr(vpnGatewayID) + return _options +} + +// SetID : Allow user to set ID +func (_options *CheckVPNGatewayConnectionLocalCIDROptions) SetID(id string) *CheckVPNGatewayConnectionLocalCIDROptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetCIDRPrefix : Allow user to set CIDRPrefix +func (_options *CheckVPNGatewayConnectionLocalCIDROptions) SetCIDRPrefix(cidrPrefix string) *CheckVPNGatewayConnectionLocalCIDROptions { + _options.CIDRPrefix = core.StringPtr(cidrPrefix) + return _options +} + +// SetPrefixLength : Allow user to set PrefixLength +func (_options *CheckVPNGatewayConnectionLocalCIDROptions) SetPrefixLength(prefixLength string) *CheckVPNGatewayConnectionLocalCIDROptions { + _options.PrefixLength = core.StringPtr(prefixLength) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CheckVPNGatewayConnectionLocalCIDROptions) SetHeaders(param map[string]string) *CheckVPNGatewayConnectionLocalCIDROptions { + options.Headers = param + return options +} + +// CheckVPNGatewayConnectionPeerCIDROptions : The CheckVPNGatewayConnectionPeerCIDR options. +type CheckVPNGatewayConnectionPeerCIDROptions struct { + // The VPN gateway identifier. + VPNGatewayID *string `json:"vpn_gateway_id" validate:"required,ne="` + + // The VPN gateway connection identifier. + ID *string `json:"id" validate:"required,ne="` + + // The address prefix part of the CIDR. + CIDRPrefix *string `json:"cidr_prefix" validate:"required,ne="` + + // The prefix length part of the CIDR. + PrefixLength *string `json:"prefix_length" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCheckVPNGatewayConnectionPeerCIDROptions : Instantiate CheckVPNGatewayConnectionPeerCIDROptions +func (*VpcV1) NewCheckVPNGatewayConnectionPeerCIDROptions(vpnGatewayID string, id string, cidrPrefix string, prefixLength string) *CheckVPNGatewayConnectionPeerCIDROptions { + return &CheckVPNGatewayConnectionPeerCIDROptions{ + VPNGatewayID: core.StringPtr(vpnGatewayID), + ID: core.StringPtr(id), + CIDRPrefix: core.StringPtr(cidrPrefix), + PrefixLength: core.StringPtr(prefixLength), + } +} + +// SetVPNGatewayID : Allow user to set VPNGatewayID +func (_options *CheckVPNGatewayConnectionPeerCIDROptions) SetVPNGatewayID(vpnGatewayID string) *CheckVPNGatewayConnectionPeerCIDROptions { + _options.VPNGatewayID = core.StringPtr(vpnGatewayID) + return _options +} + +// SetID : Allow user to set ID +func (_options *CheckVPNGatewayConnectionPeerCIDROptions) SetID(id string) *CheckVPNGatewayConnectionPeerCIDROptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetCIDRPrefix : Allow user to set CIDRPrefix +func (_options *CheckVPNGatewayConnectionPeerCIDROptions) SetCIDRPrefix(cidrPrefix string) *CheckVPNGatewayConnectionPeerCIDROptions { + _options.CIDRPrefix = core.StringPtr(cidrPrefix) + return _options +} + +// SetPrefixLength : Allow user to set PrefixLength +func (_options *CheckVPNGatewayConnectionPeerCIDROptions) SetPrefixLength(prefixLength string) *CheckVPNGatewayConnectionPeerCIDROptions { + _options.PrefixLength = core.StringPtr(prefixLength) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CheckVPNGatewayConnectionPeerCIDROptions) SetHeaders(param map[string]string) *CheckVPNGatewayConnectionPeerCIDROptions { + options.Headers = param + return options +} + +// CloudObjectStorageBucketIdentity : Identifies a Cloud Object Storage bucket by a unique property. +// Models which "extend" this model: +// - CloudObjectStorageBucketIdentityCloudObjectStorageBucketIdentityByName +// - CloudObjectStorageBucketIdentityByCRN +type CloudObjectStorageBucketIdentity struct { + // The globally unique name of this Cloud Object Storage bucket. + Name *string `json:"name,omitempty"` + + // The CRN of this Cloud Object Storage bucket. + CRN *string `json:"crn,omitempty"` +} + +func (*CloudObjectStorageBucketIdentity) isaCloudObjectStorageBucketIdentity() bool { + return true +} + +type CloudObjectStorageBucketIdentityIntf interface { + isaCloudObjectStorageBucketIdentity() bool +} + +// UnmarshalCloudObjectStorageBucketIdentity unmarshals an instance of CloudObjectStorageBucketIdentity from the specified map of raw messages. +func UnmarshalCloudObjectStorageBucketIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(CloudObjectStorageBucketIdentity) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// CloudObjectStorageBucketReference : CloudObjectStorageBucketReference struct +type CloudObjectStorageBucketReference struct { + // The CRN of this Cloud Object Storage bucket. + CRN *string `json:"crn" validate:"required"` + + // The globally unique name of this Cloud Object Storage bucket. + Name *string `json:"name" validate:"required"` +} + +// UnmarshalCloudObjectStorageBucketReference unmarshals an instance of CloudObjectStorageBucketReference from the specified map of raw messages. +func UnmarshalCloudObjectStorageBucketReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(CloudObjectStorageBucketReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// CloudObjectStorageObjectReference : CloudObjectStorageObjectReference struct +type CloudObjectStorageObjectReference struct { + // The name of this Cloud Object Storage object. Names are unique within a Cloud Object Storage bucket. + Name *string `json:"name" validate:"required"` +} + +// UnmarshalCloudObjectStorageObjectReference unmarshals an instance of CloudObjectStorageObjectReference from the specified map of raw messages. +func UnmarshalCloudObjectStorageObjectReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(CloudObjectStorageObjectReference) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// CreateBackupPolicyOptions : The CreateBackupPolicy options. +type CreateBackupPolicyOptions struct { + // The user tags this backup policy will apply to. Resources that have both a matching user tag and a matching type + // will be subject to the backup policy. + MatchUserTags []string `json:"match_user_tags" validate:"required"` + + // The resource types this backup policy will apply to. Resources that have both a matching type and a matching user + // tag will be subject to the backup policy. + MatchResourceTypes []string `json:"match_resource_types,omitempty"` + + // The name for this backup policy. The name must not be used by another backup policy in the region. If unspecified, + // the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The prototype objects for backup plans to be created for this backup policy. + Plans []BackupPolicyPlanPrototype `json:"plans,omitempty"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the CreateBackupPolicyOptions.MatchResourceTypes property. +// The resource type. +const ( + CreateBackupPolicyOptionsMatchResourceTypesVolumeConst = "volume" +) + +// NewCreateBackupPolicyOptions : Instantiate CreateBackupPolicyOptions +func (*VpcV1) NewCreateBackupPolicyOptions(matchUserTags []string) *CreateBackupPolicyOptions { + return &CreateBackupPolicyOptions{ + MatchUserTags: matchUserTags, + } +} + +// SetMatchUserTags : Allow user to set MatchUserTags +func (_options *CreateBackupPolicyOptions) SetMatchUserTags(matchUserTags []string) *CreateBackupPolicyOptions { + _options.MatchUserTags = matchUserTags + return _options +} + +// SetMatchResourceTypes : Allow user to set MatchResourceTypes +func (_options *CreateBackupPolicyOptions) SetMatchResourceTypes(matchResourceTypes []string) *CreateBackupPolicyOptions { + _options.MatchResourceTypes = matchResourceTypes + return _options +} + +// SetName : Allow user to set Name +func (_options *CreateBackupPolicyOptions) SetName(name string) *CreateBackupPolicyOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetPlans : Allow user to set Plans +func (_options *CreateBackupPolicyOptions) SetPlans(plans []BackupPolicyPlanPrototype) *CreateBackupPolicyOptions { + _options.Plans = plans + return _options +} + +// SetResourceGroup : Allow user to set ResourceGroup +func (_options *CreateBackupPolicyOptions) SetResourceGroup(resourceGroup ResourceGroupIdentityIntf) *CreateBackupPolicyOptions { + _options.ResourceGroup = resourceGroup + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateBackupPolicyOptions) SetHeaders(param map[string]string) *CreateBackupPolicyOptions { + options.Headers = param + return options +} + +// CreateBackupPolicyPlanOptions : The CreateBackupPolicyPlan options. +type CreateBackupPolicyPlanOptions struct { + // The backup policy identifier. + BackupPolicyID *string `json:"backup_policy_id" validate:"required,ne="` + + // The cron specification for the backup schedule. The backup policy jobs + // (which create and delete backups for this plan) will not start until this time, and may start for up to 90 minutes + // after this time. + // + // All backup schedules for plans in the same policy must be at least an hour apart. + CronSpec *string `json:"cron_spec" validate:"required"` + + // Indicates whether the plan is active. + Active *bool `json:"active,omitempty"` + + // User tags to attach to each backup (snapshot) created by this plan. If unspecified, no user tags will be attached. + AttachUserTags []string `json:"attach_user_tags,omitempty"` + + ClonePolicy *BackupPolicyPlanClonePolicyPrototype `json:"clone_policy,omitempty"` + + // Indicates whether to copy the source's user tags to the created backups (snapshots). + CopyUserTags *bool `json:"copy_user_tags,omitempty"` + + DeletionTrigger *BackupPolicyPlanDeletionTriggerPrototype `json:"deletion_trigger,omitempty"` + + // The name for this backup policy plan. The name must not be used by another plan for the backup policy. If + // unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The policies for additional backups in remote regions. + RemoteRegionPolicies []BackupPolicyPlanRemoteRegionPolicyPrototype `json:"remote_region_policies,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateBackupPolicyPlanOptions : Instantiate CreateBackupPolicyPlanOptions +func (*VpcV1) NewCreateBackupPolicyPlanOptions(backupPolicyID string, cronSpec string) *CreateBackupPolicyPlanOptions { + return &CreateBackupPolicyPlanOptions{ + BackupPolicyID: core.StringPtr(backupPolicyID), + CronSpec: core.StringPtr(cronSpec), + } +} + +// SetBackupPolicyID : Allow user to set BackupPolicyID +func (_options *CreateBackupPolicyPlanOptions) SetBackupPolicyID(backupPolicyID string) *CreateBackupPolicyPlanOptions { + _options.BackupPolicyID = core.StringPtr(backupPolicyID) + return _options +} + +// SetCronSpec : Allow user to set CronSpec +func (_options *CreateBackupPolicyPlanOptions) SetCronSpec(cronSpec string) *CreateBackupPolicyPlanOptions { + _options.CronSpec = core.StringPtr(cronSpec) + return _options +} + +// SetActive : Allow user to set Active +func (_options *CreateBackupPolicyPlanOptions) SetActive(active bool) *CreateBackupPolicyPlanOptions { + _options.Active = core.BoolPtr(active) + return _options +} + +// SetAttachUserTags : Allow user to set AttachUserTags +func (_options *CreateBackupPolicyPlanOptions) SetAttachUserTags(attachUserTags []string) *CreateBackupPolicyPlanOptions { + _options.AttachUserTags = attachUserTags + return _options +} + +// SetClonePolicy : Allow user to set ClonePolicy +func (_options *CreateBackupPolicyPlanOptions) SetClonePolicy(clonePolicy *BackupPolicyPlanClonePolicyPrototype) *CreateBackupPolicyPlanOptions { + _options.ClonePolicy = clonePolicy + return _options +} + +// SetCopyUserTags : Allow user to set CopyUserTags +func (_options *CreateBackupPolicyPlanOptions) SetCopyUserTags(copyUserTags bool) *CreateBackupPolicyPlanOptions { + _options.CopyUserTags = core.BoolPtr(copyUserTags) + return _options +} + +// SetDeletionTrigger : Allow user to set DeletionTrigger +func (_options *CreateBackupPolicyPlanOptions) SetDeletionTrigger(deletionTrigger *BackupPolicyPlanDeletionTriggerPrototype) *CreateBackupPolicyPlanOptions { + _options.DeletionTrigger = deletionTrigger + return _options +} + +// SetName : Allow user to set Name +func (_options *CreateBackupPolicyPlanOptions) SetName(name string) *CreateBackupPolicyPlanOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetRemoteRegionPolicies : Allow user to set RemoteRegionPolicies +func (_options *CreateBackupPolicyPlanOptions) SetRemoteRegionPolicies(remoteRegionPolicies []BackupPolicyPlanRemoteRegionPolicyPrototype) *CreateBackupPolicyPlanOptions { + _options.RemoteRegionPolicies = remoteRegionPolicies + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateBackupPolicyPlanOptions) SetHeaders(param map[string]string) *CreateBackupPolicyPlanOptions { + options.Headers = param + return options +} + +// CreateBareMetalServerConsoleAccessTokenOptions : The CreateBareMetalServerConsoleAccessToken options. +type CreateBareMetalServerConsoleAccessTokenOptions struct { + // The bare metal server identifier. + BareMetalServerID *string `json:"bare_metal_server_id" validate:"required,ne="` + + // The bare metal server console type for which this token may be used + // + // Must be `serial` for bare metal servers with a `cpu.architecture` of `s390x`. + ConsoleType *string `json:"console_type" validate:"required"` + + // Indicates whether to disconnect an existing serial console session as the serial console cannot be shared. This has + // no effect on VNC consoles. + Force *bool `json:"force,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the CreateBareMetalServerConsoleAccessTokenOptions.ConsoleType property. +// The bare metal server console type for which this token may be used +// +// Must be `serial` for bare metal servers with a `cpu.architecture` of `s390x`. +const ( + CreateBareMetalServerConsoleAccessTokenOptionsConsoleTypeSerialConst = "serial" + CreateBareMetalServerConsoleAccessTokenOptionsConsoleTypeVncConst = "vnc" +) + +// NewCreateBareMetalServerConsoleAccessTokenOptions : Instantiate CreateBareMetalServerConsoleAccessTokenOptions +func (*VpcV1) NewCreateBareMetalServerConsoleAccessTokenOptions(bareMetalServerID string, consoleType string) *CreateBareMetalServerConsoleAccessTokenOptions { + return &CreateBareMetalServerConsoleAccessTokenOptions{ + BareMetalServerID: core.StringPtr(bareMetalServerID), + ConsoleType: core.StringPtr(consoleType), + } +} + +// SetBareMetalServerID : Allow user to set BareMetalServerID +func (_options *CreateBareMetalServerConsoleAccessTokenOptions) SetBareMetalServerID(bareMetalServerID string) *CreateBareMetalServerConsoleAccessTokenOptions { + _options.BareMetalServerID = core.StringPtr(bareMetalServerID) + return _options +} + +// SetConsoleType : Allow user to set ConsoleType +func (_options *CreateBareMetalServerConsoleAccessTokenOptions) SetConsoleType(consoleType string) *CreateBareMetalServerConsoleAccessTokenOptions { + _options.ConsoleType = core.StringPtr(consoleType) + return _options +} + +// SetForce : Allow user to set Force +func (_options *CreateBareMetalServerConsoleAccessTokenOptions) SetForce(force bool) *CreateBareMetalServerConsoleAccessTokenOptions { + _options.Force = core.BoolPtr(force) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateBareMetalServerConsoleAccessTokenOptions) SetHeaders(param map[string]string) *CreateBareMetalServerConsoleAccessTokenOptions { + options.Headers = param + return options +} + +// CreateBareMetalServerNetworkInterfaceOptions : The CreateBareMetalServerNetworkInterface options. +type CreateBareMetalServerNetworkInterfaceOptions struct { + // The bare metal server identifier. + BareMetalServerID *string `json:"bare_metal_server_id" validate:"required,ne="` + + // The bare metal server network interface prototype object. + BareMetalServerNetworkInterfacePrototype BareMetalServerNetworkInterfacePrototypeIntf `json:"BareMetalServerNetworkInterfacePrototype" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateBareMetalServerNetworkInterfaceOptions : Instantiate CreateBareMetalServerNetworkInterfaceOptions +func (*VpcV1) NewCreateBareMetalServerNetworkInterfaceOptions(bareMetalServerID string, bareMetalServerNetworkInterfacePrototype BareMetalServerNetworkInterfacePrototypeIntf) *CreateBareMetalServerNetworkInterfaceOptions { + return &CreateBareMetalServerNetworkInterfaceOptions{ + BareMetalServerID: core.StringPtr(bareMetalServerID), + BareMetalServerNetworkInterfacePrototype: bareMetalServerNetworkInterfacePrototype, + } +} + +// SetBareMetalServerID : Allow user to set BareMetalServerID +func (_options *CreateBareMetalServerNetworkInterfaceOptions) SetBareMetalServerID(bareMetalServerID string) *CreateBareMetalServerNetworkInterfaceOptions { + _options.BareMetalServerID = core.StringPtr(bareMetalServerID) + return _options +} + +// SetBareMetalServerNetworkInterfacePrototype : Allow user to set BareMetalServerNetworkInterfacePrototype +func (_options *CreateBareMetalServerNetworkInterfaceOptions) SetBareMetalServerNetworkInterfacePrototype(bareMetalServerNetworkInterfacePrototype BareMetalServerNetworkInterfacePrototypeIntf) *CreateBareMetalServerNetworkInterfaceOptions { + _options.BareMetalServerNetworkInterfacePrototype = bareMetalServerNetworkInterfacePrototype + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateBareMetalServerNetworkInterfaceOptions) SetHeaders(param map[string]string) *CreateBareMetalServerNetworkInterfaceOptions { + options.Headers = param + return options +} + +// CreateBareMetalServerOptions : The CreateBareMetalServer options. +type CreateBareMetalServerOptions struct { + Initialization *BareMetalServerInitializationPrototype `json:"initialization" validate:"required"` + + // The primary bare metal server network interface to create. + PrimaryNetworkInterface *BareMetalServerPrimaryNetworkInterfacePrototype `json:"primary_network_interface" validate:"required"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-bare-metal-servers-profile) + // to use for this bare metal server. + Profile BareMetalServerProfileIdentityIntf `json:"profile" validate:"required"` + + // The zone this bare metal server will reside in. + Zone ZoneIdentityIntf `json:"zone" validate:"required"` + + // Indicates whether secure boot is enabled. If enabled, the image must support secure boot or the server will fail to + // boot. + EnableSecureBoot *bool `json:"enable_secure_boot,omitempty"` + + // The name for this bare metal server. The name must not be used by another bare metal server in the region. If + // unspecified, the name will be a hyphenated list of randomly-selected words. + // + // The system hostname will be based on this name. + Name *string `json:"name,omitempty"` + + // The additional bare metal server network interfaces to create. + NetworkInterfaces []BareMetalServerNetworkInterfacePrototypeIntf `json:"network_interfaces,omitempty"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + TrustedPlatformModule *BareMetalServerTrustedPlatformModulePrototype `json:"trusted_platform_module,omitempty"` + + // The VPC this bare metal server will reside in. + // + // If specified, it must match the VPC for the subnets that the network interfaces of + // the bare metal server are attached to. + VPC VPCIdentityIntf `json:"vpc,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateBareMetalServerOptions : Instantiate CreateBareMetalServerOptions +func (*VpcV1) NewCreateBareMetalServerOptions(initialization *BareMetalServerInitializationPrototype, primaryNetworkInterface *BareMetalServerPrimaryNetworkInterfacePrototype, profile BareMetalServerProfileIdentityIntf, zone ZoneIdentityIntf) *CreateBareMetalServerOptions { + return &CreateBareMetalServerOptions{ + Initialization: initialization, + PrimaryNetworkInterface: primaryNetworkInterface, + Profile: profile, + Zone: zone, + } +} + +// SetInitialization : Allow user to set Initialization +func (_options *CreateBareMetalServerOptions) SetInitialization(initialization *BareMetalServerInitializationPrototype) *CreateBareMetalServerOptions { + _options.Initialization = initialization + return _options +} + +// SetPrimaryNetworkInterface : Allow user to set PrimaryNetworkInterface +func (_options *CreateBareMetalServerOptions) SetPrimaryNetworkInterface(primaryNetworkInterface *BareMetalServerPrimaryNetworkInterfacePrototype) *CreateBareMetalServerOptions { + _options.PrimaryNetworkInterface = primaryNetworkInterface + return _options +} + +// SetProfile : Allow user to set Profile +func (_options *CreateBareMetalServerOptions) SetProfile(profile BareMetalServerProfileIdentityIntf) *CreateBareMetalServerOptions { + _options.Profile = profile + return _options +} + +// SetZone : Allow user to set Zone +func (_options *CreateBareMetalServerOptions) SetZone(zone ZoneIdentityIntf) *CreateBareMetalServerOptions { + _options.Zone = zone + return _options +} + +// SetEnableSecureBoot : Allow user to set EnableSecureBoot +func (_options *CreateBareMetalServerOptions) SetEnableSecureBoot(enableSecureBoot bool) *CreateBareMetalServerOptions { + _options.EnableSecureBoot = core.BoolPtr(enableSecureBoot) + return _options +} + +// SetName : Allow user to set Name +func (_options *CreateBareMetalServerOptions) SetName(name string) *CreateBareMetalServerOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetNetworkInterfaces : Allow user to set NetworkInterfaces +func (_options *CreateBareMetalServerOptions) SetNetworkInterfaces(networkInterfaces []BareMetalServerNetworkInterfacePrototypeIntf) *CreateBareMetalServerOptions { + _options.NetworkInterfaces = networkInterfaces + return _options +} + +// SetResourceGroup : Allow user to set ResourceGroup +func (_options *CreateBareMetalServerOptions) SetResourceGroup(resourceGroup ResourceGroupIdentityIntf) *CreateBareMetalServerOptions { + _options.ResourceGroup = resourceGroup + return _options +} + +// SetTrustedPlatformModule : Allow user to set TrustedPlatformModule +func (_options *CreateBareMetalServerOptions) SetTrustedPlatformModule(trustedPlatformModule *BareMetalServerTrustedPlatformModulePrototype) *CreateBareMetalServerOptions { + _options.TrustedPlatformModule = trustedPlatformModule + return _options +} + +// SetVPC : Allow user to set VPC +func (_options *CreateBareMetalServerOptions) SetVPC(vpc VPCIdentityIntf) *CreateBareMetalServerOptions { + _options.VPC = vpc + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateBareMetalServerOptions) SetHeaders(param map[string]string) *CreateBareMetalServerOptions { + options.Headers = param + return options +} + +// CreateDedicatedHostGroupOptions : The CreateDedicatedHostGroup options. +type CreateDedicatedHostGroupOptions struct { + // The dedicated host profile class for hosts in this group. + Class *string `json:"class" validate:"required"` + + // The dedicated host profile family for hosts in this group. + Family *string `json:"family" validate:"required"` + + // The zone this dedicated host group will reside in. + Zone ZoneIdentityIntf `json:"zone" validate:"required"` + + // The name for this dedicated host group. The name must not be used by another dedicated host group in the region. If + // unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the CreateDedicatedHostGroupOptions.Family property. +// The dedicated host profile family for hosts in this group. +const ( + CreateDedicatedHostGroupOptionsFamilyBalancedConst = "balanced" + CreateDedicatedHostGroupOptionsFamilyComputeConst = "compute" + CreateDedicatedHostGroupOptionsFamilyMemoryConst = "memory" +) + +// NewCreateDedicatedHostGroupOptions : Instantiate CreateDedicatedHostGroupOptions +func (*VpcV1) NewCreateDedicatedHostGroupOptions(class string, family string, zone ZoneIdentityIntf) *CreateDedicatedHostGroupOptions { + return &CreateDedicatedHostGroupOptions{ + Class: core.StringPtr(class), + Family: core.StringPtr(family), + Zone: zone, + } +} + +// SetClass : Allow user to set Class +func (_options *CreateDedicatedHostGroupOptions) SetClass(class string) *CreateDedicatedHostGroupOptions { + _options.Class = core.StringPtr(class) + return _options +} + +// SetFamily : Allow user to set Family +func (_options *CreateDedicatedHostGroupOptions) SetFamily(family string) *CreateDedicatedHostGroupOptions { + _options.Family = core.StringPtr(family) + return _options +} + +// SetZone : Allow user to set Zone +func (_options *CreateDedicatedHostGroupOptions) SetZone(zone ZoneIdentityIntf) *CreateDedicatedHostGroupOptions { + _options.Zone = zone + return _options +} + +// SetName : Allow user to set Name +func (_options *CreateDedicatedHostGroupOptions) SetName(name string) *CreateDedicatedHostGroupOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetResourceGroup : Allow user to set ResourceGroup +func (_options *CreateDedicatedHostGroupOptions) SetResourceGroup(resourceGroup ResourceGroupIdentityIntf) *CreateDedicatedHostGroupOptions { + _options.ResourceGroup = resourceGroup + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateDedicatedHostGroupOptions) SetHeaders(param map[string]string) *CreateDedicatedHostGroupOptions { + options.Headers = param + return options +} + +// CreateDedicatedHostOptions : The CreateDedicatedHost options. +type CreateDedicatedHostOptions struct { + // The dedicated host prototype object. + DedicatedHostPrototype DedicatedHostPrototypeIntf `json:"DedicatedHostPrototype" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateDedicatedHostOptions : Instantiate CreateDedicatedHostOptions +func (*VpcV1) NewCreateDedicatedHostOptions(dedicatedHostPrototype DedicatedHostPrototypeIntf) *CreateDedicatedHostOptions { + return &CreateDedicatedHostOptions{ + DedicatedHostPrototype: dedicatedHostPrototype, + } +} + +// SetDedicatedHostPrototype : Allow user to set DedicatedHostPrototype +func (_options *CreateDedicatedHostOptions) SetDedicatedHostPrototype(dedicatedHostPrototype DedicatedHostPrototypeIntf) *CreateDedicatedHostOptions { + _options.DedicatedHostPrototype = dedicatedHostPrototype + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateDedicatedHostOptions) SetHeaders(param map[string]string) *CreateDedicatedHostOptions { + options.Headers = param + return options +} + +// CreateEndpointGatewayOptions : The CreateEndpointGateway options. +type CreateEndpointGatewayOptions struct { + // The target to use for this endpoint gateway. Must not already be the target of another + // endpoint gateway in the VPC. + Target EndpointGatewayTargetPrototypeIntf `json:"target" validate:"required"` + + // The VPC this endpoint gateway will reside in. + VPC VPCIdentityIntf `json:"vpc" validate:"required"` + + // Indicates whether to allow DNS resolution for this endpoint gateway when the VPC this endpoint gateway resides in + // has a DNS resolution binding to a VPC with `dns.enable_hub` set to `true`. + // + // Must be `true` if the VPC this endpoint gateway resides in has `dns.enable_hub` set to + // `true`. + AllowDnsResolutionBinding *bool `json:"allow_dns_resolution_binding,omitempty"` + + // The reserved IPs to bind to this endpoint gateway. At most one reserved IP per zone is allowed. + Ips []EndpointGatewayReservedIPIntf `json:"ips,omitempty"` + + // The name for this endpoint gateway. The name must not be used by another endpoint gateway in the VPC. If + // unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The security groups to use for this endpoint gateway. If unspecified, the VPC's default security group is used. + SecurityGroups []SecurityGroupIdentityIntf `json:"security_groups,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateEndpointGatewayOptions : Instantiate CreateEndpointGatewayOptions +func (*VpcV1) NewCreateEndpointGatewayOptions(target EndpointGatewayTargetPrototypeIntf, vpc VPCIdentityIntf) *CreateEndpointGatewayOptions { + return &CreateEndpointGatewayOptions{ + Target: target, + VPC: vpc, + } +} + +// SetTarget : Allow user to set Target +func (_options *CreateEndpointGatewayOptions) SetTarget(target EndpointGatewayTargetPrototypeIntf) *CreateEndpointGatewayOptions { + _options.Target = target + return _options +} + +// SetVPC : Allow user to set VPC +func (_options *CreateEndpointGatewayOptions) SetVPC(vpc VPCIdentityIntf) *CreateEndpointGatewayOptions { + _options.VPC = vpc + return _options +} + +// SetAllowDnsResolutionBinding : Allow user to set AllowDnsResolutionBinding +func (_options *CreateEndpointGatewayOptions) SetAllowDnsResolutionBinding(allowDnsResolutionBinding bool) *CreateEndpointGatewayOptions { + _options.AllowDnsResolutionBinding = core.BoolPtr(allowDnsResolutionBinding) + return _options +} + +// SetIps : Allow user to set Ips +func (_options *CreateEndpointGatewayOptions) SetIps(ips []EndpointGatewayReservedIPIntf) *CreateEndpointGatewayOptions { + _options.Ips = ips + return _options +} + +// SetName : Allow user to set Name +func (_options *CreateEndpointGatewayOptions) SetName(name string) *CreateEndpointGatewayOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetResourceGroup : Allow user to set ResourceGroup +func (_options *CreateEndpointGatewayOptions) SetResourceGroup(resourceGroup ResourceGroupIdentityIntf) *CreateEndpointGatewayOptions { + _options.ResourceGroup = resourceGroup + return _options +} + +// SetSecurityGroups : Allow user to set SecurityGroups +func (_options *CreateEndpointGatewayOptions) SetSecurityGroups(securityGroups []SecurityGroupIdentityIntf) *CreateEndpointGatewayOptions { + _options.SecurityGroups = securityGroups + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateEndpointGatewayOptions) SetHeaders(param map[string]string) *CreateEndpointGatewayOptions { + options.Headers = param + return options +} + +// CreateFloatingIPOptions : The CreateFloatingIP options. +type CreateFloatingIPOptions struct { + // The floating IP prototype object. + FloatingIPPrototype FloatingIPPrototypeIntf `json:"FloatingIPPrototype" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateFloatingIPOptions : Instantiate CreateFloatingIPOptions +func (*VpcV1) NewCreateFloatingIPOptions(floatingIPPrototype FloatingIPPrototypeIntf) *CreateFloatingIPOptions { + return &CreateFloatingIPOptions{ + FloatingIPPrototype: floatingIPPrototype, + } +} + +// SetFloatingIPPrototype : Allow user to set FloatingIPPrototype +func (_options *CreateFloatingIPOptions) SetFloatingIPPrototype(floatingIPPrototype FloatingIPPrototypeIntf) *CreateFloatingIPOptions { + _options.FloatingIPPrototype = floatingIPPrototype + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateFloatingIPOptions) SetHeaders(param map[string]string) *CreateFloatingIPOptions { + options.Headers = param + return options +} + +// CreateFlowLogCollectorOptions : The CreateFlowLogCollector options. +type CreateFlowLogCollectorOptions struct { + // The Cloud Object Storage bucket where the collected flows will be logged. + // The bucket must exist and an IAM service authorization must grant + // `IBM Cloud Flow Logs` resources of `VPC Infrastructure Services` writer + // access to the bucket. + StorageBucket LegacyCloudObjectStorageBucketIdentityIntf `json:"storage_bucket" validate:"required"` + + // The target this collector will collect flow logs for. If the target is an instance, + // subnet, or VPC, flow logs will not be collected for any instance network interfaces within + // the target that are themselves the target of a more specific flow log collector. + Target FlowLogCollectorTargetPrototypeIntf `json:"target" validate:"required"` + + // Indicates whether this collector will be active upon creation. + Active *bool `json:"active,omitempty"` + + // The name for this flow log collector. The name must not be used by another flow log collector in the VPC. If + // unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateFlowLogCollectorOptions : Instantiate CreateFlowLogCollectorOptions +func (*VpcV1) NewCreateFlowLogCollectorOptions(storageBucket LegacyCloudObjectStorageBucketIdentityIntf, target FlowLogCollectorTargetPrototypeIntf) *CreateFlowLogCollectorOptions { + return &CreateFlowLogCollectorOptions{ + StorageBucket: storageBucket, + Target: target, + } +} + +// SetStorageBucket : Allow user to set StorageBucket +func (_options *CreateFlowLogCollectorOptions) SetStorageBucket(storageBucket LegacyCloudObjectStorageBucketIdentityIntf) *CreateFlowLogCollectorOptions { + _options.StorageBucket = storageBucket + return _options +} + +// SetTarget : Allow user to set Target +func (_options *CreateFlowLogCollectorOptions) SetTarget(target FlowLogCollectorTargetPrototypeIntf) *CreateFlowLogCollectorOptions { + _options.Target = target + return _options +} + +// SetActive : Allow user to set Active +func (_options *CreateFlowLogCollectorOptions) SetActive(active bool) *CreateFlowLogCollectorOptions { + _options.Active = core.BoolPtr(active) + return _options +} + +// SetName : Allow user to set Name +func (_options *CreateFlowLogCollectorOptions) SetName(name string) *CreateFlowLogCollectorOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetResourceGroup : Allow user to set ResourceGroup +func (_options *CreateFlowLogCollectorOptions) SetResourceGroup(resourceGroup ResourceGroupIdentityIntf) *CreateFlowLogCollectorOptions { + _options.ResourceGroup = resourceGroup + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateFlowLogCollectorOptions) SetHeaders(param map[string]string) *CreateFlowLogCollectorOptions { + options.Headers = param + return options +} + +// CreateIkePolicyOptions : The CreateIkePolicy options. +type CreateIkePolicyOptions struct { + // The authentication algorithm. + AuthenticationAlgorithm *string `json:"authentication_algorithm" validate:"required"` + + // The Diffie-Hellman group. + DhGroup *int64 `json:"dh_group" validate:"required"` + + // The encryption algorithm. + EncryptionAlgorithm *string `json:"encryption_algorithm" validate:"required"` + + // The IKE protocol version. + IkeVersion *int64 `json:"ike_version" validate:"required"` + + // The key lifetime in seconds. + KeyLifetime *int64 `json:"key_lifetime,omitempty"` + + // The name for this IKE policy. The name must not be used by another IKE policies in the region. If unspecified, the + // name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the CreateIkePolicyOptions.AuthenticationAlgorithm property. +// The authentication algorithm. +const ( + CreateIkePolicyOptionsAuthenticationAlgorithmSha256Const = "sha256" + CreateIkePolicyOptionsAuthenticationAlgorithmSha384Const = "sha384" + CreateIkePolicyOptionsAuthenticationAlgorithmSha512Const = "sha512" +) + +// Constants associated with the CreateIkePolicyOptions.EncryptionAlgorithm property. +// The encryption algorithm. +const ( + CreateIkePolicyOptionsEncryptionAlgorithmAes128Const = "aes128" + CreateIkePolicyOptionsEncryptionAlgorithmAes192Const = "aes192" + CreateIkePolicyOptionsEncryptionAlgorithmAes256Const = "aes256" +) + +// NewCreateIkePolicyOptions : Instantiate CreateIkePolicyOptions +func (*VpcV1) NewCreateIkePolicyOptions(authenticationAlgorithm string, dhGroup int64, encryptionAlgorithm string, ikeVersion int64) *CreateIkePolicyOptions { + return &CreateIkePolicyOptions{ + AuthenticationAlgorithm: core.StringPtr(authenticationAlgorithm), + DhGroup: core.Int64Ptr(dhGroup), + EncryptionAlgorithm: core.StringPtr(encryptionAlgorithm), + IkeVersion: core.Int64Ptr(ikeVersion), + } +} + +// SetAuthenticationAlgorithm : Allow user to set AuthenticationAlgorithm +func (_options *CreateIkePolicyOptions) SetAuthenticationAlgorithm(authenticationAlgorithm string) *CreateIkePolicyOptions { + _options.AuthenticationAlgorithm = core.StringPtr(authenticationAlgorithm) + return _options +} + +// SetDhGroup : Allow user to set DhGroup +func (_options *CreateIkePolicyOptions) SetDhGroup(dhGroup int64) *CreateIkePolicyOptions { + _options.DhGroup = core.Int64Ptr(dhGroup) + return _options +} + +// SetEncryptionAlgorithm : Allow user to set EncryptionAlgorithm +func (_options *CreateIkePolicyOptions) SetEncryptionAlgorithm(encryptionAlgorithm string) *CreateIkePolicyOptions { + _options.EncryptionAlgorithm = core.StringPtr(encryptionAlgorithm) + return _options +} + +// SetIkeVersion : Allow user to set IkeVersion +func (_options *CreateIkePolicyOptions) SetIkeVersion(ikeVersion int64) *CreateIkePolicyOptions { + _options.IkeVersion = core.Int64Ptr(ikeVersion) + return _options +} + +// SetKeyLifetime : Allow user to set KeyLifetime +func (_options *CreateIkePolicyOptions) SetKeyLifetime(keyLifetime int64) *CreateIkePolicyOptions { + _options.KeyLifetime = core.Int64Ptr(keyLifetime) + return _options +} + +// SetName : Allow user to set Name +func (_options *CreateIkePolicyOptions) SetName(name string) *CreateIkePolicyOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetResourceGroup : Allow user to set ResourceGroup +func (_options *CreateIkePolicyOptions) SetResourceGroup(resourceGroup ResourceGroupIdentityIntf) *CreateIkePolicyOptions { + _options.ResourceGroup = resourceGroup + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateIkePolicyOptions) SetHeaders(param map[string]string) *CreateIkePolicyOptions { + options.Headers = param + return options +} + +// CreateImageExportJobOptions : The CreateImageExportJob options. +type CreateImageExportJobOptions struct { + // The image identifier. + ImageID *string `json:"image_id" validate:"required,ne="` + + // The Cloud Object Storage bucket to export the image to. The bucket must exist and an IAM + // service authorization must grant `Image Service for VPC` of + // `VPC Infrastructure Services` writer access to the bucket. + StorageBucket CloudObjectStorageBucketIdentityIntf `json:"storage_bucket" validate:"required"` + + // The format to use for the exported image. If the image is encrypted, only `qcow2` is supported. + Format *string `json:"format,omitempty"` + + // The name for this image export job. The name must not be used by another export job for the image. If unspecified, + // the name will be a hyphenated list of randomly-selected words prefixed with the first 16 characters of the parent + // image name. + // + // The exported image object name in Cloud Object Storage (`storage_object.name` in the response) will be based on this + // name. The object name will be unique within the bucket. + Name *string `json:"name,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the CreateImageExportJobOptions.Format property. +// The format to use for the exported image. If the image is encrypted, only `qcow2` is supported. +const ( + CreateImageExportJobOptionsFormatQcow2Const = "qcow2" + CreateImageExportJobOptionsFormatVhdConst = "vhd" +) + +// NewCreateImageExportJobOptions : Instantiate CreateImageExportJobOptions +func (*VpcV1) NewCreateImageExportJobOptions(imageID string, storageBucket CloudObjectStorageBucketIdentityIntf) *CreateImageExportJobOptions { + return &CreateImageExportJobOptions{ + ImageID: core.StringPtr(imageID), + StorageBucket: storageBucket, + } +} + +// SetImageID : Allow user to set ImageID +func (_options *CreateImageExportJobOptions) SetImageID(imageID string) *CreateImageExportJobOptions { + _options.ImageID = core.StringPtr(imageID) + return _options +} + +// SetStorageBucket : Allow user to set StorageBucket +func (_options *CreateImageExportJobOptions) SetStorageBucket(storageBucket CloudObjectStorageBucketIdentityIntf) *CreateImageExportJobOptions { + _options.StorageBucket = storageBucket + return _options +} + +// SetFormat : Allow user to set Format +func (_options *CreateImageExportJobOptions) SetFormat(format string) *CreateImageExportJobOptions { + _options.Format = core.StringPtr(format) + return _options +} + +// SetName : Allow user to set Name +func (_options *CreateImageExportJobOptions) SetName(name string) *CreateImageExportJobOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateImageExportJobOptions) SetHeaders(param map[string]string) *CreateImageExportJobOptions { + options.Headers = param + return options +} + +// CreateImageOptions : The CreateImage options. +type CreateImageOptions struct { + // The image prototype object. + ImagePrototype ImagePrototypeIntf `json:"ImagePrototype" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateImageOptions : Instantiate CreateImageOptions +func (*VpcV1) NewCreateImageOptions(imagePrototype ImagePrototypeIntf) *CreateImageOptions { + return &CreateImageOptions{ + ImagePrototype: imagePrototype, + } +} + +// SetImagePrototype : Allow user to set ImagePrototype +func (_options *CreateImageOptions) SetImagePrototype(imagePrototype ImagePrototypeIntf) *CreateImageOptions { + _options.ImagePrototype = imagePrototype + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateImageOptions) SetHeaders(param map[string]string) *CreateImageOptions { + options.Headers = param + return options +} + +// CreateInstanceActionOptions : The CreateInstanceAction options. +type CreateInstanceActionOptions struct { + // The virtual server instance identifier. + InstanceID *string `json:"instance_id" validate:"required,ne="` + + // The type of action. + Type *string `json:"type" validate:"required"` + + // If set to true, the action will be forced immediately, and all queued actions deleted. Ignored for the start action. + Force *bool `json:"force,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the CreateInstanceActionOptions.Type property. +// The type of action. +const ( + CreateInstanceActionOptionsTypeRebootConst = "reboot" + CreateInstanceActionOptionsTypeStartConst = "start" + CreateInstanceActionOptionsTypeStopConst = "stop" +) + +// NewCreateInstanceActionOptions : Instantiate CreateInstanceActionOptions +func (*VpcV1) NewCreateInstanceActionOptions(instanceID string, typeVar string) *CreateInstanceActionOptions { + return &CreateInstanceActionOptions{ + InstanceID: core.StringPtr(instanceID), + Type: core.StringPtr(typeVar), + } +} + +// SetInstanceID : Allow user to set InstanceID +func (_options *CreateInstanceActionOptions) SetInstanceID(instanceID string) *CreateInstanceActionOptions { + _options.InstanceID = core.StringPtr(instanceID) + return _options +} + +// SetType : Allow user to set Type +func (_options *CreateInstanceActionOptions) SetType(typeVar string) *CreateInstanceActionOptions { + _options.Type = core.StringPtr(typeVar) + return _options +} + +// SetForce : Allow user to set Force +func (_options *CreateInstanceActionOptions) SetForce(force bool) *CreateInstanceActionOptions { + _options.Force = core.BoolPtr(force) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateInstanceActionOptions) SetHeaders(param map[string]string) *CreateInstanceActionOptions { + options.Headers = param + return options +} + +// CreateInstanceConsoleAccessTokenOptions : The CreateInstanceConsoleAccessToken options. +type CreateInstanceConsoleAccessTokenOptions struct { + // The virtual server instance identifier. + InstanceID *string `json:"instance_id" validate:"required,ne="` + + // The instance console type for which this token may be used. + ConsoleType *string `json:"console_type" validate:"required"` + + // Indicates whether to disconnect an existing serial console session as the serial console cannot be shared. This has + // no effect on VNC consoles. + Force *bool `json:"force,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the CreateInstanceConsoleAccessTokenOptions.ConsoleType property. +// The instance console type for which this token may be used. +const ( + CreateInstanceConsoleAccessTokenOptionsConsoleTypeSerialConst = "serial" + CreateInstanceConsoleAccessTokenOptionsConsoleTypeVncConst = "vnc" +) + +// NewCreateInstanceConsoleAccessTokenOptions : Instantiate CreateInstanceConsoleAccessTokenOptions +func (*VpcV1) NewCreateInstanceConsoleAccessTokenOptions(instanceID string, consoleType string) *CreateInstanceConsoleAccessTokenOptions { + return &CreateInstanceConsoleAccessTokenOptions{ + InstanceID: core.StringPtr(instanceID), + ConsoleType: core.StringPtr(consoleType), + } +} + +// SetInstanceID : Allow user to set InstanceID +func (_options *CreateInstanceConsoleAccessTokenOptions) SetInstanceID(instanceID string) *CreateInstanceConsoleAccessTokenOptions { + _options.InstanceID = core.StringPtr(instanceID) + return _options +} + +// SetConsoleType : Allow user to set ConsoleType +func (_options *CreateInstanceConsoleAccessTokenOptions) SetConsoleType(consoleType string) *CreateInstanceConsoleAccessTokenOptions { + _options.ConsoleType = core.StringPtr(consoleType) + return _options +} + +// SetForce : Allow user to set Force +func (_options *CreateInstanceConsoleAccessTokenOptions) SetForce(force bool) *CreateInstanceConsoleAccessTokenOptions { + _options.Force = core.BoolPtr(force) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateInstanceConsoleAccessTokenOptions) SetHeaders(param map[string]string) *CreateInstanceConsoleAccessTokenOptions { + options.Headers = param + return options +} + +// CreateInstanceGroupManagerActionOptions : The CreateInstanceGroupManagerAction options. +type CreateInstanceGroupManagerActionOptions struct { + // The instance group identifier. + InstanceGroupID *string `json:"instance_group_id" validate:"required,ne="` + + // The instance group manager identifier. + InstanceGroupManagerID *string `json:"instance_group_manager_id" validate:"required,ne="` + + // The instance group manager action prototype object. + InstanceGroupManagerActionPrototype InstanceGroupManagerActionPrototypeIntf `json:"InstanceGroupManagerActionPrototype" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateInstanceGroupManagerActionOptions : Instantiate CreateInstanceGroupManagerActionOptions +func (*VpcV1) NewCreateInstanceGroupManagerActionOptions(instanceGroupID string, instanceGroupManagerID string, instanceGroupManagerActionPrototype InstanceGroupManagerActionPrototypeIntf) *CreateInstanceGroupManagerActionOptions { + return &CreateInstanceGroupManagerActionOptions{ + InstanceGroupID: core.StringPtr(instanceGroupID), + InstanceGroupManagerID: core.StringPtr(instanceGroupManagerID), + InstanceGroupManagerActionPrototype: instanceGroupManagerActionPrototype, + } +} + +// SetInstanceGroupID : Allow user to set InstanceGroupID +func (_options *CreateInstanceGroupManagerActionOptions) SetInstanceGroupID(instanceGroupID string) *CreateInstanceGroupManagerActionOptions { + _options.InstanceGroupID = core.StringPtr(instanceGroupID) + return _options +} + +// SetInstanceGroupManagerID : Allow user to set InstanceGroupManagerID +func (_options *CreateInstanceGroupManagerActionOptions) SetInstanceGroupManagerID(instanceGroupManagerID string) *CreateInstanceGroupManagerActionOptions { + _options.InstanceGroupManagerID = core.StringPtr(instanceGroupManagerID) + return _options +} + +// SetInstanceGroupManagerActionPrototype : Allow user to set InstanceGroupManagerActionPrototype +func (_options *CreateInstanceGroupManagerActionOptions) SetInstanceGroupManagerActionPrototype(instanceGroupManagerActionPrototype InstanceGroupManagerActionPrototypeIntf) *CreateInstanceGroupManagerActionOptions { + _options.InstanceGroupManagerActionPrototype = instanceGroupManagerActionPrototype + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateInstanceGroupManagerActionOptions) SetHeaders(param map[string]string) *CreateInstanceGroupManagerActionOptions { + options.Headers = param + return options +} + +// CreateInstanceGroupManagerOptions : The CreateInstanceGroupManager options. +type CreateInstanceGroupManagerOptions struct { + // The instance group identifier. + InstanceGroupID *string `json:"instance_group_id" validate:"required,ne="` + + // The instance group manager prototype object. + InstanceGroupManagerPrototype InstanceGroupManagerPrototypeIntf `json:"InstanceGroupManagerPrototype" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateInstanceGroupManagerOptions : Instantiate CreateInstanceGroupManagerOptions +func (*VpcV1) NewCreateInstanceGroupManagerOptions(instanceGroupID string, instanceGroupManagerPrototype InstanceGroupManagerPrototypeIntf) *CreateInstanceGroupManagerOptions { + return &CreateInstanceGroupManagerOptions{ + InstanceGroupID: core.StringPtr(instanceGroupID), + InstanceGroupManagerPrototype: instanceGroupManagerPrototype, + } +} + +// SetInstanceGroupID : Allow user to set InstanceGroupID +func (_options *CreateInstanceGroupManagerOptions) SetInstanceGroupID(instanceGroupID string) *CreateInstanceGroupManagerOptions { + _options.InstanceGroupID = core.StringPtr(instanceGroupID) + return _options +} + +// SetInstanceGroupManagerPrototype : Allow user to set InstanceGroupManagerPrototype +func (_options *CreateInstanceGroupManagerOptions) SetInstanceGroupManagerPrototype(instanceGroupManagerPrototype InstanceGroupManagerPrototypeIntf) *CreateInstanceGroupManagerOptions { + _options.InstanceGroupManagerPrototype = instanceGroupManagerPrototype + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateInstanceGroupManagerOptions) SetHeaders(param map[string]string) *CreateInstanceGroupManagerOptions { + options.Headers = param + return options +} + +// CreateInstanceGroupManagerPolicyOptions : The CreateInstanceGroupManagerPolicy options. +type CreateInstanceGroupManagerPolicyOptions struct { + // The instance group identifier. + InstanceGroupID *string `json:"instance_group_id" validate:"required,ne="` + + // The instance group manager identifier. + InstanceGroupManagerID *string `json:"instance_group_manager_id" validate:"required,ne="` + + // The instance group manager policy prototype object. + InstanceGroupManagerPolicyPrototype InstanceGroupManagerPolicyPrototypeIntf `json:"InstanceGroupManagerPolicyPrototype" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateInstanceGroupManagerPolicyOptions : Instantiate CreateInstanceGroupManagerPolicyOptions +func (*VpcV1) NewCreateInstanceGroupManagerPolicyOptions(instanceGroupID string, instanceGroupManagerID string, instanceGroupManagerPolicyPrototype InstanceGroupManagerPolicyPrototypeIntf) *CreateInstanceGroupManagerPolicyOptions { + return &CreateInstanceGroupManagerPolicyOptions{ + InstanceGroupID: core.StringPtr(instanceGroupID), + InstanceGroupManagerID: core.StringPtr(instanceGroupManagerID), + InstanceGroupManagerPolicyPrototype: instanceGroupManagerPolicyPrototype, + } +} + +// SetInstanceGroupID : Allow user to set InstanceGroupID +func (_options *CreateInstanceGroupManagerPolicyOptions) SetInstanceGroupID(instanceGroupID string) *CreateInstanceGroupManagerPolicyOptions { + _options.InstanceGroupID = core.StringPtr(instanceGroupID) + return _options +} + +// SetInstanceGroupManagerID : Allow user to set InstanceGroupManagerID +func (_options *CreateInstanceGroupManagerPolicyOptions) SetInstanceGroupManagerID(instanceGroupManagerID string) *CreateInstanceGroupManagerPolicyOptions { + _options.InstanceGroupManagerID = core.StringPtr(instanceGroupManagerID) + return _options +} + +// SetInstanceGroupManagerPolicyPrototype : Allow user to set InstanceGroupManagerPolicyPrototype +func (_options *CreateInstanceGroupManagerPolicyOptions) SetInstanceGroupManagerPolicyPrototype(instanceGroupManagerPolicyPrototype InstanceGroupManagerPolicyPrototypeIntf) *CreateInstanceGroupManagerPolicyOptions { + _options.InstanceGroupManagerPolicyPrototype = instanceGroupManagerPolicyPrototype + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateInstanceGroupManagerPolicyOptions) SetHeaders(param map[string]string) *CreateInstanceGroupManagerPolicyOptions { + options.Headers = param + return options +} + +// CreateInstanceGroupOptions : The CreateInstanceGroup options. +type CreateInstanceGroupOptions struct { + // Instance template to use when creating new instances. + // + // Instance groups are not compatible with instance templates that specify `true` for + // `default_trusted_profile.auto_link`. + InstanceTemplate InstanceTemplateIdentityIntf `json:"instance_template" validate:"required"` + + // The subnets to use when creating new instances. + Subnets []SubnetIdentityIntf `json:"subnets" validate:"required"` + + // The port to use for new load balancer pool members created by this instance group. The load balancer pool member + // will receive load balancer traffic on this port, unless the load balancer listener is using a port range. (Traffic + // received on a listener using a port range will be sent to members using the same port the listener received it on.) + // + // This port will also be used for health checks unless the port property of + // `health_monitor` property is specified. + // + // This property must be specified if and only if `load_balancer_pool` has been specified. + ApplicationPort *int64 `json:"application_port,omitempty"` + + // The load balancer associated with the specified load balancer pool. + // Required if `load_balancer_pool` is specified. The load balancer must have + // `instance_groups_supported` set to `true`. + LoadBalancer LoadBalancerIdentityIntf `json:"load_balancer,omitempty"` + + // If specified, this instance group will manage the load balancer pool. A pool member + // will be created for each instance created by this group. The specified load + // balancer pool must not be used by another instance group in the VPC. + // + // If specified, `load_balancer` and `application_port` must also be specified. + LoadBalancerPool LoadBalancerPoolIdentityIntf `json:"load_balancer_pool,omitempty"` + + // The number of instances in the instance group. + MembershipCount *int64 `json:"membership_count,omitempty"` + + // The name for this instance group. The name must not be used by another instance group in the region. If unspecified, + // the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateInstanceGroupOptions : Instantiate CreateInstanceGroupOptions +func (*VpcV1) NewCreateInstanceGroupOptions(instanceTemplate InstanceTemplateIdentityIntf, subnets []SubnetIdentityIntf) *CreateInstanceGroupOptions { + return &CreateInstanceGroupOptions{ + InstanceTemplate: instanceTemplate, + Subnets: subnets, + } +} + +// SetInstanceTemplate : Allow user to set InstanceTemplate +func (_options *CreateInstanceGroupOptions) SetInstanceTemplate(instanceTemplate InstanceTemplateIdentityIntf) *CreateInstanceGroupOptions { + _options.InstanceTemplate = instanceTemplate + return _options +} + +// SetSubnets : Allow user to set Subnets +func (_options *CreateInstanceGroupOptions) SetSubnets(subnets []SubnetIdentityIntf) *CreateInstanceGroupOptions { + _options.Subnets = subnets + return _options +} + +// SetApplicationPort : Allow user to set ApplicationPort +func (_options *CreateInstanceGroupOptions) SetApplicationPort(applicationPort int64) *CreateInstanceGroupOptions { + _options.ApplicationPort = core.Int64Ptr(applicationPort) + return _options +} + +// SetLoadBalancer : Allow user to set LoadBalancer +func (_options *CreateInstanceGroupOptions) SetLoadBalancer(loadBalancer LoadBalancerIdentityIntf) *CreateInstanceGroupOptions { + _options.LoadBalancer = loadBalancer + return _options +} + +// SetLoadBalancerPool : Allow user to set LoadBalancerPool +func (_options *CreateInstanceGroupOptions) SetLoadBalancerPool(loadBalancerPool LoadBalancerPoolIdentityIntf) *CreateInstanceGroupOptions { + _options.LoadBalancerPool = loadBalancerPool + return _options +} + +// SetMembershipCount : Allow user to set MembershipCount +func (_options *CreateInstanceGroupOptions) SetMembershipCount(membershipCount int64) *CreateInstanceGroupOptions { + _options.MembershipCount = core.Int64Ptr(membershipCount) + return _options +} + +// SetName : Allow user to set Name +func (_options *CreateInstanceGroupOptions) SetName(name string) *CreateInstanceGroupOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetResourceGroup : Allow user to set ResourceGroup +func (_options *CreateInstanceGroupOptions) SetResourceGroup(resourceGroup ResourceGroupIdentityIntf) *CreateInstanceGroupOptions { + _options.ResourceGroup = resourceGroup + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateInstanceGroupOptions) SetHeaders(param map[string]string) *CreateInstanceGroupOptions { + options.Headers = param + return options +} + +// CreateInstanceNetworkInterfaceOptions : The CreateInstanceNetworkInterface options. +type CreateInstanceNetworkInterfaceOptions struct { + // The virtual server instance identifier. + InstanceID *string `json:"instance_id" validate:"required,ne="` + + // The associated subnet. + Subnet SubnetIdentityIntf `json:"subnet" validate:"required"` + + // Indicates whether source IP spoofing is allowed on this instance interface. + AllowIPSpoofing *bool `json:"allow_ip_spoofing,omitempty"` + + // The name for the instance network interface. The name must not be used by another network interface on the virtual + // server instance. If unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The primary IP address to bind to the instance network interface. This can be + // specified using an existing reserved IP, or a prototype object for a new reserved IP. + // + // If an existing reserved IP or a prototype object with an address is specified, it must + // be available on the instance network interface's subnet. Otherwise, an + // available address on the subnet will be automatically selected and reserved. + PrimaryIP NetworkInterfaceIPPrototypeIntf `json:"primary_ip,omitempty"` + + // The security groups to use for this instance network interface. If unspecified, the VPC's default security group is + // used. + SecurityGroups []SecurityGroupIdentityIntf `json:"security_groups,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateInstanceNetworkInterfaceOptions : Instantiate CreateInstanceNetworkInterfaceOptions +func (*VpcV1) NewCreateInstanceNetworkInterfaceOptions(instanceID string, subnet SubnetIdentityIntf) *CreateInstanceNetworkInterfaceOptions { + return &CreateInstanceNetworkInterfaceOptions{ + InstanceID: core.StringPtr(instanceID), + Subnet: subnet, + } +} + +// SetInstanceID : Allow user to set InstanceID +func (_options *CreateInstanceNetworkInterfaceOptions) SetInstanceID(instanceID string) *CreateInstanceNetworkInterfaceOptions { + _options.InstanceID = core.StringPtr(instanceID) + return _options +} + +// SetSubnet : Allow user to set Subnet +func (_options *CreateInstanceNetworkInterfaceOptions) SetSubnet(subnet SubnetIdentityIntf) *CreateInstanceNetworkInterfaceOptions { + _options.Subnet = subnet + return _options +} + +// SetAllowIPSpoofing : Allow user to set AllowIPSpoofing +func (_options *CreateInstanceNetworkInterfaceOptions) SetAllowIPSpoofing(allowIPSpoofing bool) *CreateInstanceNetworkInterfaceOptions { + _options.AllowIPSpoofing = core.BoolPtr(allowIPSpoofing) + return _options +} + +// SetName : Allow user to set Name +func (_options *CreateInstanceNetworkInterfaceOptions) SetName(name string) *CreateInstanceNetworkInterfaceOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetPrimaryIP : Allow user to set PrimaryIP +func (_options *CreateInstanceNetworkInterfaceOptions) SetPrimaryIP(primaryIP NetworkInterfaceIPPrototypeIntf) *CreateInstanceNetworkInterfaceOptions { + _options.PrimaryIP = primaryIP + return _options +} + +// SetSecurityGroups : Allow user to set SecurityGroups +func (_options *CreateInstanceNetworkInterfaceOptions) SetSecurityGroups(securityGroups []SecurityGroupIdentityIntf) *CreateInstanceNetworkInterfaceOptions { + _options.SecurityGroups = securityGroups + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateInstanceNetworkInterfaceOptions) SetHeaders(param map[string]string) *CreateInstanceNetworkInterfaceOptions { + options.Headers = param + return options +} + +// CreateInstanceOptions : The CreateInstance options. +type CreateInstanceOptions struct { + // The instance prototype object. + InstancePrototype InstancePrototypeIntf `json:"InstancePrototype" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateInstanceOptions : Instantiate CreateInstanceOptions +func (*VpcV1) NewCreateInstanceOptions(instancePrototype InstancePrototypeIntf) *CreateInstanceOptions { + return &CreateInstanceOptions{ + InstancePrototype: instancePrototype, + } +} + +// SetInstancePrototype : Allow user to set InstancePrototype +func (_options *CreateInstanceOptions) SetInstancePrototype(instancePrototype InstancePrototypeIntf) *CreateInstanceOptions { + _options.InstancePrototype = instancePrototype + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateInstanceOptions) SetHeaders(param map[string]string) *CreateInstanceOptions { + options.Headers = param + return options +} + +// CreateInstanceTemplateOptions : The CreateInstanceTemplate options. +type CreateInstanceTemplateOptions struct { + // The instance template prototype object. + InstanceTemplatePrototype InstanceTemplatePrototypeIntf `json:"InstanceTemplatePrototype" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateInstanceTemplateOptions : Instantiate CreateInstanceTemplateOptions +func (*VpcV1) NewCreateInstanceTemplateOptions(instanceTemplatePrototype InstanceTemplatePrototypeIntf) *CreateInstanceTemplateOptions { + return &CreateInstanceTemplateOptions{ + InstanceTemplatePrototype: instanceTemplatePrototype, + } +} + +// SetInstanceTemplatePrototype : Allow user to set InstanceTemplatePrototype +func (_options *CreateInstanceTemplateOptions) SetInstanceTemplatePrototype(instanceTemplatePrototype InstanceTemplatePrototypeIntf) *CreateInstanceTemplateOptions { + _options.InstanceTemplatePrototype = instanceTemplatePrototype + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateInstanceTemplateOptions) SetHeaders(param map[string]string) *CreateInstanceTemplateOptions { + options.Headers = param + return options +} + +// CreateInstanceVolumeAttachmentOptions : The CreateInstanceVolumeAttachment options. +type CreateInstanceVolumeAttachmentOptions struct { + // The virtual server instance identifier. + InstanceID *string `json:"instance_id" validate:"required,ne="` + + // An existing volume to attach to the instance, or a prototype object for a new volume. + Volume VolumeAttachmentPrototypeVolumeIntf `json:"volume" validate:"required"` + + // Indicates whether deleting the instance will also delete the attached volume. + DeleteVolumeOnInstanceDelete *bool `json:"delete_volume_on_instance_delete,omitempty"` + + // The name for this volume attachment. The name must not be used by another volume attachment on the instance. If + // unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateInstanceVolumeAttachmentOptions : Instantiate CreateInstanceVolumeAttachmentOptions +func (*VpcV1) NewCreateInstanceVolumeAttachmentOptions(instanceID string, volume VolumeAttachmentPrototypeVolumeIntf) *CreateInstanceVolumeAttachmentOptions { + return &CreateInstanceVolumeAttachmentOptions{ + InstanceID: core.StringPtr(instanceID), + Volume: volume, + } +} + +// SetInstanceID : Allow user to set InstanceID +func (_options *CreateInstanceVolumeAttachmentOptions) SetInstanceID(instanceID string) *CreateInstanceVolumeAttachmentOptions { + _options.InstanceID = core.StringPtr(instanceID) + return _options +} + +// SetVolume : Allow user to set Volume +func (_options *CreateInstanceVolumeAttachmentOptions) SetVolume(volume VolumeAttachmentPrototypeVolumeIntf) *CreateInstanceVolumeAttachmentOptions { + _options.Volume = volume + return _options +} + +// SetDeleteVolumeOnInstanceDelete : Allow user to set DeleteVolumeOnInstanceDelete +func (_options *CreateInstanceVolumeAttachmentOptions) SetDeleteVolumeOnInstanceDelete(deleteVolumeOnInstanceDelete bool) *CreateInstanceVolumeAttachmentOptions { + _options.DeleteVolumeOnInstanceDelete = core.BoolPtr(deleteVolumeOnInstanceDelete) + return _options +} + +// SetName : Allow user to set Name +func (_options *CreateInstanceVolumeAttachmentOptions) SetName(name string) *CreateInstanceVolumeAttachmentOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateInstanceVolumeAttachmentOptions) SetHeaders(param map[string]string) *CreateInstanceVolumeAttachmentOptions { + options.Headers = param + return options +} + +// CreateIpsecPolicyOptions : The CreateIpsecPolicy options. +type CreateIpsecPolicyOptions struct { + // The authentication algorithm + // + // Must be `disabled` if and only if the `encryption_algorithm` is + // `aes128gcm16`, `aes192gcm16`, or `aes256gcm16`. + AuthenticationAlgorithm *string `json:"authentication_algorithm" validate:"required"` + + // The encryption algorithm + // + // The `authentication_algorithm` must be `disabled` if and only if + // `encryption_algorithm` is `aes128gcm16`, `aes192gcm16`, or + // `aes256gcm16`. + EncryptionAlgorithm *string `json:"encryption_algorithm" validate:"required"` + + // Perfect Forward Secrecy. + Pfs *string `json:"pfs" validate:"required"` + + // The key lifetime in seconds. + KeyLifetime *int64 `json:"key_lifetime,omitempty"` + + // The name for this IPsec policy. The name must not be used by another IPsec policies in the region. If unspecified, + // the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the CreateIpsecPolicyOptions.AuthenticationAlgorithm property. +// The authentication algorithm +// +// Must be `disabled` if and only if the `encryption_algorithm` is +// `aes128gcm16`, `aes192gcm16`, or `aes256gcm16`. +const ( + CreateIpsecPolicyOptionsAuthenticationAlgorithmDisabledConst = "disabled" + CreateIpsecPolicyOptionsAuthenticationAlgorithmSha256Const = "sha256" + CreateIpsecPolicyOptionsAuthenticationAlgorithmSha384Const = "sha384" + CreateIpsecPolicyOptionsAuthenticationAlgorithmSha512Const = "sha512" +) + +// Constants associated with the CreateIpsecPolicyOptions.EncryptionAlgorithm property. +// The encryption algorithm +// +// The `authentication_algorithm` must be `disabled` if and only if +// `encryption_algorithm` is `aes128gcm16`, `aes192gcm16`, or +// `aes256gcm16`. +const ( + CreateIpsecPolicyOptionsEncryptionAlgorithmAes128Const = "aes128" + CreateIpsecPolicyOptionsEncryptionAlgorithmAes128gcm16Const = "aes128gcm16" + CreateIpsecPolicyOptionsEncryptionAlgorithmAes192Const = "aes192" + CreateIpsecPolicyOptionsEncryptionAlgorithmAes192gcm16Const = "aes192gcm16" + CreateIpsecPolicyOptionsEncryptionAlgorithmAes256Const = "aes256" + CreateIpsecPolicyOptionsEncryptionAlgorithmAes256gcm16Const = "aes256gcm16" +) + +// Constants associated with the CreateIpsecPolicyOptions.Pfs property. +// Perfect Forward Secrecy. +const ( + CreateIpsecPolicyOptionsPfsDisabledConst = "disabled" + CreateIpsecPolicyOptionsPfsGroup14Const = "group_14" + CreateIpsecPolicyOptionsPfsGroup15Const = "group_15" + CreateIpsecPolicyOptionsPfsGroup16Const = "group_16" + CreateIpsecPolicyOptionsPfsGroup17Const = "group_17" + CreateIpsecPolicyOptionsPfsGroup18Const = "group_18" + CreateIpsecPolicyOptionsPfsGroup19Const = "group_19" + CreateIpsecPolicyOptionsPfsGroup20Const = "group_20" + CreateIpsecPolicyOptionsPfsGroup21Const = "group_21" + CreateIpsecPolicyOptionsPfsGroup22Const = "group_22" + CreateIpsecPolicyOptionsPfsGroup23Const = "group_23" + CreateIpsecPolicyOptionsPfsGroup24Const = "group_24" + CreateIpsecPolicyOptionsPfsGroup31Const = "group_31" +) + +// NewCreateIpsecPolicyOptions : Instantiate CreateIpsecPolicyOptions +func (*VpcV1) NewCreateIpsecPolicyOptions(authenticationAlgorithm string, encryptionAlgorithm string, pfs string) *CreateIpsecPolicyOptions { + return &CreateIpsecPolicyOptions{ + AuthenticationAlgorithm: core.StringPtr(authenticationAlgorithm), + EncryptionAlgorithm: core.StringPtr(encryptionAlgorithm), + Pfs: core.StringPtr(pfs), + } +} + +// SetAuthenticationAlgorithm : Allow user to set AuthenticationAlgorithm +func (_options *CreateIpsecPolicyOptions) SetAuthenticationAlgorithm(authenticationAlgorithm string) *CreateIpsecPolicyOptions { + _options.AuthenticationAlgorithm = core.StringPtr(authenticationAlgorithm) + return _options +} + +// SetEncryptionAlgorithm : Allow user to set EncryptionAlgorithm +func (_options *CreateIpsecPolicyOptions) SetEncryptionAlgorithm(encryptionAlgorithm string) *CreateIpsecPolicyOptions { + _options.EncryptionAlgorithm = core.StringPtr(encryptionAlgorithm) + return _options +} + +// SetPfs : Allow user to set Pfs +func (_options *CreateIpsecPolicyOptions) SetPfs(pfs string) *CreateIpsecPolicyOptions { + _options.Pfs = core.StringPtr(pfs) + return _options +} + +// SetKeyLifetime : Allow user to set KeyLifetime +func (_options *CreateIpsecPolicyOptions) SetKeyLifetime(keyLifetime int64) *CreateIpsecPolicyOptions { + _options.KeyLifetime = core.Int64Ptr(keyLifetime) + return _options +} + +// SetName : Allow user to set Name +func (_options *CreateIpsecPolicyOptions) SetName(name string) *CreateIpsecPolicyOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetResourceGroup : Allow user to set ResourceGroup +func (_options *CreateIpsecPolicyOptions) SetResourceGroup(resourceGroup ResourceGroupIdentityIntf) *CreateIpsecPolicyOptions { + _options.ResourceGroup = resourceGroup + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateIpsecPolicyOptions) SetHeaders(param map[string]string) *CreateIpsecPolicyOptions { + options.Headers = param + return options +} + +// CreateKeyOptions : The CreateKey options. +type CreateKeyOptions struct { + // A unique public SSH key to import, in OpenSSH format (consisting of three space-separated fields: the algorithm + // name, base64-encoded key, and a comment). The algorithm and comment fields may be omitted, as only the key field is + // imported. + // + // Keys of type `rsa` may be 2048 or 4096 bits in length, however 4096 is recommended. Keys of type `ed25519` are 256 + // bits in length. + PublicKey *string `json:"public_key" validate:"required"` + + // The name for this key. The name must not be used by another key in the region. If unspecified, the name will be a + // hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The crypto-system used by this key. + Type *string `json:"type,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the CreateKeyOptions.Type property. +// The crypto-system used by this key. +const ( + CreateKeyOptionsTypeEd25519Const = "ed25519" + CreateKeyOptionsTypeRsaConst = "rsa" +) + +// NewCreateKeyOptions : Instantiate CreateKeyOptions +func (*VpcV1) NewCreateKeyOptions(publicKey string) *CreateKeyOptions { + return &CreateKeyOptions{ + PublicKey: core.StringPtr(publicKey), + } +} + +// SetPublicKey : Allow user to set PublicKey +func (_options *CreateKeyOptions) SetPublicKey(publicKey string) *CreateKeyOptions { + _options.PublicKey = core.StringPtr(publicKey) + return _options +} + +// SetName : Allow user to set Name +func (_options *CreateKeyOptions) SetName(name string) *CreateKeyOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetResourceGroup : Allow user to set ResourceGroup +func (_options *CreateKeyOptions) SetResourceGroup(resourceGroup ResourceGroupIdentityIntf) *CreateKeyOptions { + _options.ResourceGroup = resourceGroup + return _options +} + +// SetType : Allow user to set Type +func (_options *CreateKeyOptions) SetType(typeVar string) *CreateKeyOptions { + _options.Type = core.StringPtr(typeVar) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateKeyOptions) SetHeaders(param map[string]string) *CreateKeyOptions { + options.Headers = param + return options +} + +// CreateLoadBalancerListenerOptions : The CreateLoadBalancerListener options. +type CreateLoadBalancerListenerOptions struct { + // The load balancer identifier. + LoadBalancerID *string `json:"load_balancer_id" validate:"required,ne="` + + // The listener protocol. Each listener in the load balancer must have a unique `port` and `protocol` combination. + // + // Load balancers in the `network` family support `tcp` and `udp` (if `udp_supported` is `true`). Load balancers in the + // `application` family support `tcp`, `http` and + // `https`. + // + // Additional restrictions: + // - If `default_pool` is set, the pool's protocol must match, or be compatible with + // the listener's protocol. At present, the compatible protocols are `http` and + // `https`. + // - If `https_redirect` is set, the protocol must be `http`. + Protocol *string `json:"protocol" validate:"required"` + + // If set to `true`, this listener will accept and forward PROXY protocol information. Supported by load balancers in + // the `application` family (otherwise always `false`). Additional restrictions: + // - If this listener has `https_redirect` specified, its `accept_proxy_protocol` value must + // match the `accept_proxy_protocol` value of the `https_redirect` listener. + // - If this listener is the target of another listener's `https_redirect`, its + // `accept_proxy_protocol` value must match that listener's `accept_proxy_protocol` value. + AcceptProxyProtocol *bool `json:"accept_proxy_protocol,omitempty"` + + // The certificate instance to use for SSL termination. The listener must have a + // `protocol` of `https`. + CertificateInstance CertificateInstanceIdentityIntf `json:"certificate_instance,omitempty"` + + // The connection limit of the listener. + ConnectionLimit *int64 `json:"connection_limit,omitempty"` + + // The default pool for this listener. If specified, the pool must: + // - Belong to this load balancer. + // - Have the same `protocol` as this listener, or have a compatible protocol. + // At present, the compatible protocols are `http` and `https`. + // - Not already be the `default_pool` for another listener. + // + // If unspecified, this listener will be created with no default pool, but one may be + // subsequently set. + DefaultPool LoadBalancerPoolIdentityIntf `json:"default_pool,omitempty"` + + // The target listener that requests will be redirected to. This listener must have a + // `protocol` of `http`, and the target listener must have a `protocol` of `https`. + HTTPSRedirect *LoadBalancerListenerHTTPSRedirectPrototype `json:"https_redirect,omitempty"` + + // The idle connection timeout of the listener in seconds. Supported for load balancers in the `application` family. + IdleConnectionTimeout *int64 `json:"idle_connection_timeout,omitempty"` + + // The policy prototype objects for this listener. The load balancer must be in the + // `application` family. + Policies []LoadBalancerListenerPolicyPrototype `json:"policies,omitempty"` + + // The listener port number, or the inclusive lower bound of the port range. Each listener in the load balancer must + // have a unique `port` and `protocol` combination. + // + // Not supported for load balancers operating with route mode enabled. + Port *int64 `json:"port,omitempty"` + + // The inclusive upper bound of the range of ports used by this listener. Must not be less than `port_min`. + // + // At present, only load balancers operating with route mode enabled, and public load balancers in the `network` family + // support different values for `port_min` and + // `port_max`. When route mode is enabled, the value `65535` must be specified. + // + // The specified port range must not overlap with port ranges used by other listeners for this load balancer using the + // same protocol. + PortMax *int64 `json:"port_max,omitempty"` + + // The inclusive lower bound of the range of ports used by this listener. Must not be greater than `port_max`. + // + // At present, only load balancers operating with route mode enabled, and public load balancers in the `network` family + // support different values for `port_min` and + // `port_max`. When route mode is enabled, the value `1` must be specified. + // + // The specified port range must not overlap with port ranges used by other listeners for this load balancer using the + // same protocol. + PortMin *int64 `json:"port_min,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the CreateLoadBalancerListenerOptions.Protocol property. +// The listener protocol. Each listener in the load balancer must have a unique `port` and `protocol` combination. +// +// Load balancers in the `network` family support `tcp` and `udp` (if `udp_supported` is `true`). Load balancers in the +// `application` family support `tcp`, `http` and +// `https`. +// +// Additional restrictions: +// - If `default_pool` is set, the pool's protocol must match, or be compatible with +// the listener's protocol. At present, the compatible protocols are `http` and +// `https`. +// - If `https_redirect` is set, the protocol must be `http`. +const ( + CreateLoadBalancerListenerOptionsProtocolHTTPConst = "http" + CreateLoadBalancerListenerOptionsProtocolHTTPSConst = "https" + CreateLoadBalancerListenerOptionsProtocolTCPConst = "tcp" + CreateLoadBalancerListenerOptionsProtocolUDPConst = "udp" +) + +// NewCreateLoadBalancerListenerOptions : Instantiate CreateLoadBalancerListenerOptions +func (*VpcV1) NewCreateLoadBalancerListenerOptions(loadBalancerID string, protocol string) *CreateLoadBalancerListenerOptions { + return &CreateLoadBalancerListenerOptions{ + LoadBalancerID: core.StringPtr(loadBalancerID), + Protocol: core.StringPtr(protocol), + } +} + +// SetLoadBalancerID : Allow user to set LoadBalancerID +func (_options *CreateLoadBalancerListenerOptions) SetLoadBalancerID(loadBalancerID string) *CreateLoadBalancerListenerOptions { + _options.LoadBalancerID = core.StringPtr(loadBalancerID) + return _options +} + +// SetProtocol : Allow user to set Protocol +func (_options *CreateLoadBalancerListenerOptions) SetProtocol(protocol string) *CreateLoadBalancerListenerOptions { + _options.Protocol = core.StringPtr(protocol) + return _options +} + +// SetAcceptProxyProtocol : Allow user to set AcceptProxyProtocol +func (_options *CreateLoadBalancerListenerOptions) SetAcceptProxyProtocol(acceptProxyProtocol bool) *CreateLoadBalancerListenerOptions { + _options.AcceptProxyProtocol = core.BoolPtr(acceptProxyProtocol) + return _options +} + +// SetCertificateInstance : Allow user to set CertificateInstance +func (_options *CreateLoadBalancerListenerOptions) SetCertificateInstance(certificateInstance CertificateInstanceIdentityIntf) *CreateLoadBalancerListenerOptions { + _options.CertificateInstance = certificateInstance + return _options +} + +// SetConnectionLimit : Allow user to set ConnectionLimit +func (_options *CreateLoadBalancerListenerOptions) SetConnectionLimit(connectionLimit int64) *CreateLoadBalancerListenerOptions { + _options.ConnectionLimit = core.Int64Ptr(connectionLimit) + return _options +} + +// SetDefaultPool : Allow user to set DefaultPool +func (_options *CreateLoadBalancerListenerOptions) SetDefaultPool(defaultPool LoadBalancerPoolIdentityIntf) *CreateLoadBalancerListenerOptions { + _options.DefaultPool = defaultPool + return _options +} + +// SetHTTPSRedirect : Allow user to set HTTPSRedirect +func (_options *CreateLoadBalancerListenerOptions) SetHTTPSRedirect(httpsRedirect *LoadBalancerListenerHTTPSRedirectPrototype) *CreateLoadBalancerListenerOptions { + _options.HTTPSRedirect = httpsRedirect + return _options +} + +// SetIdleConnectionTimeout : Allow user to set IdleConnectionTimeout +func (_options *CreateLoadBalancerListenerOptions) SetIdleConnectionTimeout(idleConnectionTimeout int64) *CreateLoadBalancerListenerOptions { + _options.IdleConnectionTimeout = core.Int64Ptr(idleConnectionTimeout) + return _options +} + +// SetPolicies : Allow user to set Policies +func (_options *CreateLoadBalancerListenerOptions) SetPolicies(policies []LoadBalancerListenerPolicyPrototype) *CreateLoadBalancerListenerOptions { + _options.Policies = policies + return _options +} + +// SetPort : Allow user to set Port +func (_options *CreateLoadBalancerListenerOptions) SetPort(port int64) *CreateLoadBalancerListenerOptions { + _options.Port = core.Int64Ptr(port) + return _options +} + +// SetPortMax : Allow user to set PortMax +func (_options *CreateLoadBalancerListenerOptions) SetPortMax(portMax int64) *CreateLoadBalancerListenerOptions { + _options.PortMax = core.Int64Ptr(portMax) + return _options +} + +// SetPortMin : Allow user to set PortMin +func (_options *CreateLoadBalancerListenerOptions) SetPortMin(portMin int64) *CreateLoadBalancerListenerOptions { + _options.PortMin = core.Int64Ptr(portMin) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateLoadBalancerListenerOptions) SetHeaders(param map[string]string) *CreateLoadBalancerListenerOptions { + options.Headers = param + return options +} + +// CreateLoadBalancerListenerPolicyOptions : The CreateLoadBalancerListenerPolicy options. +type CreateLoadBalancerListenerPolicyOptions struct { + // The load balancer identifier. + LoadBalancerID *string `json:"load_balancer_id" validate:"required,ne="` + + // The listener identifier. + ListenerID *string `json:"listener_id" validate:"required,ne="` + + // The policy action. + // + // The enumerated values for this property are expected to expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the policy on which the + // unexpected property value was encountered. + Action *string `json:"action" validate:"required"` + + // Priority of the policy. Lower value indicates higher priority. + Priority *int64 `json:"priority" validate:"required"` + + // The name for this policy. The name must not be used by another policy for the load balancer listener. If + // unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The rule prototype objects for this policy. + Rules []LoadBalancerListenerPolicyRulePrototype `json:"rules,omitempty"` + + // - If `action` is `forward`, specify a `LoadBalancerPoolIdentity`. + // - If `action` is `redirect`, specify a `LoadBalancerListenerPolicyRedirectURLPrototype`. + // - If `action` is `https_redirect`, specify a + // `LoadBalancerListenerPolicyHTTPSRedirectPrototype`. + Target LoadBalancerListenerPolicyTargetPrototypeIntf `json:"target,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the CreateLoadBalancerListenerPolicyOptions.Action property. +// The policy action. +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the policy on which the +// unexpected property value was encountered. +const ( + CreateLoadBalancerListenerPolicyOptionsActionForwardConst = "forward" + CreateLoadBalancerListenerPolicyOptionsActionHTTPSRedirectConst = "https_redirect" + CreateLoadBalancerListenerPolicyOptionsActionRedirectConst = "redirect" + CreateLoadBalancerListenerPolicyOptionsActionRejectConst = "reject" +) + +// NewCreateLoadBalancerListenerPolicyOptions : Instantiate CreateLoadBalancerListenerPolicyOptions +func (*VpcV1) NewCreateLoadBalancerListenerPolicyOptions(loadBalancerID string, listenerID string, action string, priority int64) *CreateLoadBalancerListenerPolicyOptions { + return &CreateLoadBalancerListenerPolicyOptions{ + LoadBalancerID: core.StringPtr(loadBalancerID), + ListenerID: core.StringPtr(listenerID), + Action: core.StringPtr(action), + Priority: core.Int64Ptr(priority), + } +} + +// SetLoadBalancerID : Allow user to set LoadBalancerID +func (_options *CreateLoadBalancerListenerPolicyOptions) SetLoadBalancerID(loadBalancerID string) *CreateLoadBalancerListenerPolicyOptions { + _options.LoadBalancerID = core.StringPtr(loadBalancerID) + return _options +} + +// SetListenerID : Allow user to set ListenerID +func (_options *CreateLoadBalancerListenerPolicyOptions) SetListenerID(listenerID string) *CreateLoadBalancerListenerPolicyOptions { + _options.ListenerID = core.StringPtr(listenerID) + return _options +} + +// SetAction : Allow user to set Action +func (_options *CreateLoadBalancerListenerPolicyOptions) SetAction(action string) *CreateLoadBalancerListenerPolicyOptions { + _options.Action = core.StringPtr(action) + return _options +} + +// SetPriority : Allow user to set Priority +func (_options *CreateLoadBalancerListenerPolicyOptions) SetPriority(priority int64) *CreateLoadBalancerListenerPolicyOptions { + _options.Priority = core.Int64Ptr(priority) + return _options +} + +// SetName : Allow user to set Name +func (_options *CreateLoadBalancerListenerPolicyOptions) SetName(name string) *CreateLoadBalancerListenerPolicyOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetRules : Allow user to set Rules +func (_options *CreateLoadBalancerListenerPolicyOptions) SetRules(rules []LoadBalancerListenerPolicyRulePrototype) *CreateLoadBalancerListenerPolicyOptions { + _options.Rules = rules + return _options +} + +// SetTarget : Allow user to set Target +func (_options *CreateLoadBalancerListenerPolicyOptions) SetTarget(target LoadBalancerListenerPolicyTargetPrototypeIntf) *CreateLoadBalancerListenerPolicyOptions { + _options.Target = target + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateLoadBalancerListenerPolicyOptions) SetHeaders(param map[string]string) *CreateLoadBalancerListenerPolicyOptions { + options.Headers = param + return options +} + +// CreateLoadBalancerListenerPolicyRuleOptions : The CreateLoadBalancerListenerPolicyRule options. +type CreateLoadBalancerListenerPolicyRuleOptions struct { + // The load balancer identifier. + LoadBalancerID *string `json:"load_balancer_id" validate:"required,ne="` + + // The listener identifier. + ListenerID *string `json:"listener_id" validate:"required,ne="` + + // The policy identifier. + PolicyID *string `json:"policy_id" validate:"required,ne="` + + // The condition of the rule. + Condition *string `json:"condition" validate:"required"` + + // The type of the rule. + // + // Body rules are applied to form-encoded request bodies using the `UTF-8` character set. + Type *string `json:"type" validate:"required"` + + // Value to be matched for rule condition. + // + // If the rule type is `query` and the rule condition is not `matches_regex`, the value must be percent-encoded. + Value *string `json:"value" validate:"required"` + + // The field. This is applicable to `header`, `query`, and `body` rule types. + // + // If the rule type is `header`, this property is required. + // + // If the rule type is `query`, this is optional. If specified and the rule condition is not + // `matches_regex`, the value must be percent-encoded. + // + // If the rule type is `body`, this is optional. + Field *string `json:"field,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the CreateLoadBalancerListenerPolicyRuleOptions.Condition property. +// The condition of the rule. +const ( + CreateLoadBalancerListenerPolicyRuleOptionsConditionContainsConst = "contains" + CreateLoadBalancerListenerPolicyRuleOptionsConditionEqualsConst = "equals" + CreateLoadBalancerListenerPolicyRuleOptionsConditionMatchesRegexConst = "matches_regex" +) + +// Constants associated with the CreateLoadBalancerListenerPolicyRuleOptions.Type property. +// The type of the rule. +// +// Body rules are applied to form-encoded request bodies using the `UTF-8` character set. +const ( + CreateLoadBalancerListenerPolicyRuleOptionsTypeBodyConst = "body" + CreateLoadBalancerListenerPolicyRuleOptionsTypeHeaderConst = "header" + CreateLoadBalancerListenerPolicyRuleOptionsTypeHostnameConst = "hostname" + CreateLoadBalancerListenerPolicyRuleOptionsTypePathConst = "path" + CreateLoadBalancerListenerPolicyRuleOptionsTypeQueryConst = "query" +) + +// NewCreateLoadBalancerListenerPolicyRuleOptions : Instantiate CreateLoadBalancerListenerPolicyRuleOptions +func (*VpcV1) NewCreateLoadBalancerListenerPolicyRuleOptions(loadBalancerID string, listenerID string, policyID string, condition string, typeVar string, value string) *CreateLoadBalancerListenerPolicyRuleOptions { + return &CreateLoadBalancerListenerPolicyRuleOptions{ + LoadBalancerID: core.StringPtr(loadBalancerID), + ListenerID: core.StringPtr(listenerID), + PolicyID: core.StringPtr(policyID), + Condition: core.StringPtr(condition), + Type: core.StringPtr(typeVar), + Value: core.StringPtr(value), + } +} + +// SetLoadBalancerID : Allow user to set LoadBalancerID +func (_options *CreateLoadBalancerListenerPolicyRuleOptions) SetLoadBalancerID(loadBalancerID string) *CreateLoadBalancerListenerPolicyRuleOptions { + _options.LoadBalancerID = core.StringPtr(loadBalancerID) + return _options +} + +// SetListenerID : Allow user to set ListenerID +func (_options *CreateLoadBalancerListenerPolicyRuleOptions) SetListenerID(listenerID string) *CreateLoadBalancerListenerPolicyRuleOptions { + _options.ListenerID = core.StringPtr(listenerID) + return _options +} + +// SetPolicyID : Allow user to set PolicyID +func (_options *CreateLoadBalancerListenerPolicyRuleOptions) SetPolicyID(policyID string) *CreateLoadBalancerListenerPolicyRuleOptions { + _options.PolicyID = core.StringPtr(policyID) + return _options +} + +// SetCondition : Allow user to set Condition +func (_options *CreateLoadBalancerListenerPolicyRuleOptions) SetCondition(condition string) *CreateLoadBalancerListenerPolicyRuleOptions { + _options.Condition = core.StringPtr(condition) + return _options +} + +// SetType : Allow user to set Type +func (_options *CreateLoadBalancerListenerPolicyRuleOptions) SetType(typeVar string) *CreateLoadBalancerListenerPolicyRuleOptions { + _options.Type = core.StringPtr(typeVar) + return _options +} + +// SetValue : Allow user to set Value +func (_options *CreateLoadBalancerListenerPolicyRuleOptions) SetValue(value string) *CreateLoadBalancerListenerPolicyRuleOptions { + _options.Value = core.StringPtr(value) + return _options +} + +// SetField : Allow user to set Field +func (_options *CreateLoadBalancerListenerPolicyRuleOptions) SetField(field string) *CreateLoadBalancerListenerPolicyRuleOptions { + _options.Field = core.StringPtr(field) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateLoadBalancerListenerPolicyRuleOptions) SetHeaders(param map[string]string) *CreateLoadBalancerListenerPolicyRuleOptions { + options.Headers = param + return options +} + +// CreateLoadBalancerOptions : The CreateLoadBalancer options. +type CreateLoadBalancerOptions struct { + // Indicates whether this load balancer is public. + // + // At present, if route mode is enabled, the load balancer must not be public. + IsPublic *bool `json:"is_public" validate:"required"` + + // The subnets to provision this load balancer in. The subnets must be in the same VPC. The load balancer's + // availability will depend on the availability of the zones that the subnets reside in. + // + // Load balancers in the `network` family allow only one subnet to be specified. + Subnets []SubnetIdentityIntf `json:"subnets" validate:"required"` + + // The datapath logging configuration for this load balancer. + Datapath *LoadBalancerLoggingDatapathPrototype `json:"datapath,omitempty"` + + // The DNS configuration for this load balancer. + // + // If unspecified, DNS `A` records for this load balancer's `hostname` property will be added + // to the public DNS zone `lb.appdomain.cloud`. Otherwise, those DNS `A` records will be + // added to the specified `zone`. + Dns *LoadBalancerDnsPrototype `json:"dns,omitempty"` + + // The listeners of this load balancer. + Listeners []LoadBalancerListenerPrototypeLoadBalancerContext `json:"listeners,omitempty"` + + // The logging configuration to use for this load balancer. See [VPC Datapath + // Logging](https://cloud.ibm.com/docs/vpc?topic=vpc-datapath-logging) on the logging + // format, fields and permitted values. + // + // To activate logging, the load balancer profile must support the specified logging type. + Logging *LoadBalancerLoggingPrototype `json:"logging,omitempty"` + + // The name for this load balancer. The name must not be used by another load balancer in the VPC. If unspecified, the + // name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The pools of this load balancer. + Pools []LoadBalancerPoolPrototype `json:"pools,omitempty"` + + // The profile to use for this load balancer. + // + // If unspecified, `application` will be used. + Profile LoadBalancerProfileIdentityIntf `json:"profile,omitempty"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // Indicates whether route mode is enabled for this load balancer. + // + // At present, public load balancers are not supported with route mode enabled. + RouteMode *bool `json:"route_mode,omitempty"` + + // The security groups to use for this load balancer. If unspecified, the VPC's default security group is used. + // + // The load balancer profile must support security groups. + SecurityGroups []SecurityGroupIdentityIntf `json:"security_groups,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateLoadBalancerOptions : Instantiate CreateLoadBalancerOptions +func (*VpcV1) NewCreateLoadBalancerOptions(isPublic bool, subnets []SubnetIdentityIntf) *CreateLoadBalancerOptions { + return &CreateLoadBalancerOptions{ + IsPublic: core.BoolPtr(isPublic), + Subnets: subnets, + } +} + +// SetIsPublic : Allow user to set IsPublic +func (_options *CreateLoadBalancerOptions) SetIsPublic(isPublic bool) *CreateLoadBalancerOptions { + _options.IsPublic = core.BoolPtr(isPublic) + return _options +} + +// SetSubnets : Allow user to set Subnets +func (_options *CreateLoadBalancerOptions) SetSubnets(subnets []SubnetIdentityIntf) *CreateLoadBalancerOptions { + _options.Subnets = subnets + return _options +} + +// SetDatapath : Allow user to set Datapath +func (_options *CreateLoadBalancerOptions) SetDatapath(datapath *LoadBalancerLoggingDatapathPrototype) *CreateLoadBalancerOptions { + _options.Datapath = datapath + return _options +} + +// SetDns : Allow user to set Dns +func (_options *CreateLoadBalancerOptions) SetDns(dns *LoadBalancerDnsPrototype) *CreateLoadBalancerOptions { + _options.Dns = dns + return _options +} + +// SetListeners : Allow user to set Listeners +func (_options *CreateLoadBalancerOptions) SetListeners(listeners []LoadBalancerListenerPrototypeLoadBalancerContext) *CreateLoadBalancerOptions { + _options.Listeners = listeners + return _options +} + +// SetLogging : Allow user to set Logging +func (_options *CreateLoadBalancerOptions) SetLogging(logging *LoadBalancerLoggingPrototype) *CreateLoadBalancerOptions { + _options.Logging = logging + return _options +} + +// SetName : Allow user to set Name +func (_options *CreateLoadBalancerOptions) SetName(name string) *CreateLoadBalancerOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetPools : Allow user to set Pools +func (_options *CreateLoadBalancerOptions) SetPools(pools []LoadBalancerPoolPrototype) *CreateLoadBalancerOptions { + _options.Pools = pools + return _options +} + +// SetProfile : Allow user to set Profile +func (_options *CreateLoadBalancerOptions) SetProfile(profile LoadBalancerProfileIdentityIntf) *CreateLoadBalancerOptions { + _options.Profile = profile + return _options +} + +// SetResourceGroup : Allow user to set ResourceGroup +func (_options *CreateLoadBalancerOptions) SetResourceGroup(resourceGroup ResourceGroupIdentityIntf) *CreateLoadBalancerOptions { + _options.ResourceGroup = resourceGroup + return _options +} + +// SetRouteMode : Allow user to set RouteMode +func (_options *CreateLoadBalancerOptions) SetRouteMode(routeMode bool) *CreateLoadBalancerOptions { + _options.RouteMode = core.BoolPtr(routeMode) + return _options +} + +// SetSecurityGroups : Allow user to set SecurityGroups +func (_options *CreateLoadBalancerOptions) SetSecurityGroups(securityGroups []SecurityGroupIdentityIntf) *CreateLoadBalancerOptions { + _options.SecurityGroups = securityGroups + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateLoadBalancerOptions) SetHeaders(param map[string]string) *CreateLoadBalancerOptions { + options.Headers = param + return options +} + +// CreateLoadBalancerPoolMemberOptions : The CreateLoadBalancerPoolMember options. +type CreateLoadBalancerPoolMemberOptions struct { + // The load balancer identifier. + LoadBalancerID *string `json:"load_balancer_id" validate:"required,ne="` + + // The pool identifier. + PoolID *string `json:"pool_id" validate:"required,ne="` + + // The port the member will receive load balancer traffic on. Applies only to load balancer traffic received on a + // listener with a single port. (If the traffic is received on a listener with a port range, the member will receive + // the traffic on the same port the listener received it on.) + // + // This port will also be used for health checks unless the `port` property of + // `health_monitor` property is specified. + // + // The port must be unique across all members for all pools associated with this pool's listener. + Port *int64 `json:"port" validate:"required"` + + // The pool member target. Load balancers in the `network` family support virtual server + // instances. Load balancers in the `application` family support IP addresses. If the load + // balancer has route mode enabled, the member must be in a zone the load balancer has a + // subnet in. + Target LoadBalancerPoolMemberTargetPrototypeIntf `json:"target" validate:"required"` + + // Weight of the server member. Applicable only if the pool algorithm is + // `weighted_round_robin`. + Weight *int64 `json:"weight,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateLoadBalancerPoolMemberOptions : Instantiate CreateLoadBalancerPoolMemberOptions +func (*VpcV1) NewCreateLoadBalancerPoolMemberOptions(loadBalancerID string, poolID string, port int64, target LoadBalancerPoolMemberTargetPrototypeIntf) *CreateLoadBalancerPoolMemberOptions { + return &CreateLoadBalancerPoolMemberOptions{ + LoadBalancerID: core.StringPtr(loadBalancerID), + PoolID: core.StringPtr(poolID), + Port: core.Int64Ptr(port), + Target: target, + } +} + +// SetLoadBalancerID : Allow user to set LoadBalancerID +func (_options *CreateLoadBalancerPoolMemberOptions) SetLoadBalancerID(loadBalancerID string) *CreateLoadBalancerPoolMemberOptions { + _options.LoadBalancerID = core.StringPtr(loadBalancerID) + return _options +} + +// SetPoolID : Allow user to set PoolID +func (_options *CreateLoadBalancerPoolMemberOptions) SetPoolID(poolID string) *CreateLoadBalancerPoolMemberOptions { + _options.PoolID = core.StringPtr(poolID) + return _options +} + +// SetPort : Allow user to set Port +func (_options *CreateLoadBalancerPoolMemberOptions) SetPort(port int64) *CreateLoadBalancerPoolMemberOptions { + _options.Port = core.Int64Ptr(port) + return _options +} + +// SetTarget : Allow user to set Target +func (_options *CreateLoadBalancerPoolMemberOptions) SetTarget(target LoadBalancerPoolMemberTargetPrototypeIntf) *CreateLoadBalancerPoolMemberOptions { + _options.Target = target + return _options +} + +// SetWeight : Allow user to set Weight +func (_options *CreateLoadBalancerPoolMemberOptions) SetWeight(weight int64) *CreateLoadBalancerPoolMemberOptions { + _options.Weight = core.Int64Ptr(weight) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateLoadBalancerPoolMemberOptions) SetHeaders(param map[string]string) *CreateLoadBalancerPoolMemberOptions { + options.Headers = param + return options +} + +// CreateLoadBalancerPoolOptions : The CreateLoadBalancerPool options. +type CreateLoadBalancerPoolOptions struct { + // The load balancer identifier. + LoadBalancerID *string `json:"load_balancer_id" validate:"required,ne="` + + // The load balancing algorithm. + Algorithm *string `json:"algorithm" validate:"required"` + + // The health monitor of this pool. + HealthMonitor *LoadBalancerPoolHealthMonitorPrototype `json:"health_monitor" validate:"required"` + + // The protocol used for this load balancer pool. Load balancers in the `network` family support `tcp` and `udp` (if + // `udp_supported` is `true`). Load balancers in the + // `application` family support `tcp`, `http`, and `https`. + Protocol *string `json:"protocol" validate:"required"` + + // The members for this load balancer pool. For load balancers in the `network` family, the same `port` and `target` + // tuple cannot be shared by a pool member of any other load balancer in the same VPC. + Members []LoadBalancerPoolMemberPrototype `json:"members,omitempty"` + + // The name for this load balancer pool. The name must not be used by another pool for the load balancer. If + // unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The PROXY protocol setting for this pool: + // - `v1`: Enabled with version 1 (human-readable header format) + // - `v2`: Enabled with version 2 (binary header format) + // - `disabled`: Disabled + // + // Supported by load balancers in the `application` family (otherwise always `disabled`). + ProxyProtocol *string `json:"proxy_protocol,omitempty"` + + // The session persistence of this pool. + SessionPersistence *LoadBalancerPoolSessionPersistencePrototype `json:"session_persistence,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the CreateLoadBalancerPoolOptions.Algorithm property. +// The load balancing algorithm. +const ( + CreateLoadBalancerPoolOptionsAlgorithmLeastConnectionsConst = "least_connections" + CreateLoadBalancerPoolOptionsAlgorithmRoundRobinConst = "round_robin" + CreateLoadBalancerPoolOptionsAlgorithmWeightedRoundRobinConst = "weighted_round_robin" +) + +// Constants associated with the CreateLoadBalancerPoolOptions.Protocol property. +// The protocol used for this load balancer pool. Load balancers in the `network` family support `tcp` and `udp` (if +// `udp_supported` is `true`). Load balancers in the +// `application` family support `tcp`, `http`, and `https`. +const ( + CreateLoadBalancerPoolOptionsProtocolHTTPConst = "http" + CreateLoadBalancerPoolOptionsProtocolHTTPSConst = "https" + CreateLoadBalancerPoolOptionsProtocolTCPConst = "tcp" + CreateLoadBalancerPoolOptionsProtocolUDPConst = "udp" +) + +// Constants associated with the CreateLoadBalancerPoolOptions.ProxyProtocol property. +// The PROXY protocol setting for this pool: +// - `v1`: Enabled with version 1 (human-readable header format) +// - `v2`: Enabled with version 2 (binary header format) +// - `disabled`: Disabled +// +// Supported by load balancers in the `application` family (otherwise always `disabled`). +const ( + CreateLoadBalancerPoolOptionsProxyProtocolDisabledConst = "disabled" + CreateLoadBalancerPoolOptionsProxyProtocolV1Const = "v1" + CreateLoadBalancerPoolOptionsProxyProtocolV2Const = "v2" +) + +// NewCreateLoadBalancerPoolOptions : Instantiate CreateLoadBalancerPoolOptions +func (*VpcV1) NewCreateLoadBalancerPoolOptions(loadBalancerID string, algorithm string, healthMonitor *LoadBalancerPoolHealthMonitorPrototype, protocol string) *CreateLoadBalancerPoolOptions { + return &CreateLoadBalancerPoolOptions{ + LoadBalancerID: core.StringPtr(loadBalancerID), + Algorithm: core.StringPtr(algorithm), + HealthMonitor: healthMonitor, + Protocol: core.StringPtr(protocol), + } +} + +// SetLoadBalancerID : Allow user to set LoadBalancerID +func (_options *CreateLoadBalancerPoolOptions) SetLoadBalancerID(loadBalancerID string) *CreateLoadBalancerPoolOptions { + _options.LoadBalancerID = core.StringPtr(loadBalancerID) + return _options +} + +// SetAlgorithm : Allow user to set Algorithm +func (_options *CreateLoadBalancerPoolOptions) SetAlgorithm(algorithm string) *CreateLoadBalancerPoolOptions { + _options.Algorithm = core.StringPtr(algorithm) + return _options +} + +// SetHealthMonitor : Allow user to set HealthMonitor +func (_options *CreateLoadBalancerPoolOptions) SetHealthMonitor(healthMonitor *LoadBalancerPoolHealthMonitorPrototype) *CreateLoadBalancerPoolOptions { + _options.HealthMonitor = healthMonitor + return _options +} + +// SetProtocol : Allow user to set Protocol +func (_options *CreateLoadBalancerPoolOptions) SetProtocol(protocol string) *CreateLoadBalancerPoolOptions { + _options.Protocol = core.StringPtr(protocol) + return _options +} + +// SetMembers : Allow user to set Members +func (_options *CreateLoadBalancerPoolOptions) SetMembers(members []LoadBalancerPoolMemberPrototype) *CreateLoadBalancerPoolOptions { + _options.Members = members + return _options +} + +// SetName : Allow user to set Name +func (_options *CreateLoadBalancerPoolOptions) SetName(name string) *CreateLoadBalancerPoolOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetProxyProtocol : Allow user to set ProxyProtocol +func (_options *CreateLoadBalancerPoolOptions) SetProxyProtocol(proxyProtocol string) *CreateLoadBalancerPoolOptions { + _options.ProxyProtocol = core.StringPtr(proxyProtocol) + return _options +} + +// SetSessionPersistence : Allow user to set SessionPersistence +func (_options *CreateLoadBalancerPoolOptions) SetSessionPersistence(sessionPersistence *LoadBalancerPoolSessionPersistencePrototype) *CreateLoadBalancerPoolOptions { + _options.SessionPersistence = sessionPersistence + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateLoadBalancerPoolOptions) SetHeaders(param map[string]string) *CreateLoadBalancerPoolOptions { + options.Headers = param + return options +} + +// CreateNetworkACLOptions : The CreateNetworkACL options. +type CreateNetworkACLOptions struct { + // The network ACL prototype object. + NetworkACLPrototype NetworkACLPrototypeIntf `json:"NetworkACLPrototype" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateNetworkACLOptions : Instantiate CreateNetworkACLOptions +func (*VpcV1) NewCreateNetworkACLOptions(networkACLPrototype NetworkACLPrototypeIntf) *CreateNetworkACLOptions { + return &CreateNetworkACLOptions{ + NetworkACLPrototype: networkACLPrototype, + } +} + +// SetNetworkACLPrototype : Allow user to set NetworkACLPrototype +func (_options *CreateNetworkACLOptions) SetNetworkACLPrototype(networkACLPrototype NetworkACLPrototypeIntf) *CreateNetworkACLOptions { + _options.NetworkACLPrototype = networkACLPrototype + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateNetworkACLOptions) SetHeaders(param map[string]string) *CreateNetworkACLOptions { + options.Headers = param + return options +} + +// CreateNetworkACLRuleOptions : The CreateNetworkACLRule options. +type CreateNetworkACLRuleOptions struct { + // The network ACL identifier. + NetworkACLID *string `json:"network_acl_id" validate:"required,ne="` + + // The network ACL rule prototype object. + NetworkACLRulePrototype NetworkACLRulePrototypeIntf `json:"NetworkACLRulePrototype" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateNetworkACLRuleOptions : Instantiate CreateNetworkACLRuleOptions +func (*VpcV1) NewCreateNetworkACLRuleOptions(networkACLID string, networkACLRulePrototype NetworkACLRulePrototypeIntf) *CreateNetworkACLRuleOptions { + return &CreateNetworkACLRuleOptions{ + NetworkACLID: core.StringPtr(networkACLID), + NetworkACLRulePrototype: networkACLRulePrototype, + } +} + +// SetNetworkACLID : Allow user to set NetworkACLID +func (_options *CreateNetworkACLRuleOptions) SetNetworkACLID(networkACLID string) *CreateNetworkACLRuleOptions { + _options.NetworkACLID = core.StringPtr(networkACLID) + return _options +} + +// SetNetworkACLRulePrototype : Allow user to set NetworkACLRulePrototype +func (_options *CreateNetworkACLRuleOptions) SetNetworkACLRulePrototype(networkACLRulePrototype NetworkACLRulePrototypeIntf) *CreateNetworkACLRuleOptions { + _options.NetworkACLRulePrototype = networkACLRulePrototype + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateNetworkACLRuleOptions) SetHeaders(param map[string]string) *CreateNetworkACLRuleOptions { + options.Headers = param + return options +} + +// CreatePlacementGroupOptions : The CreatePlacementGroup options. +type CreatePlacementGroupOptions struct { + // The strategy for this placement group + // - `host_spread`: place on different compute hosts + // - `power_spread`: place on compute hosts that use different power sources + // + // The enumerated values for this property may expand in the future. When processing this property, check for and log + // unknown values. Optionally halt processing and surface the error, or bypass the placement group on which the + // unexpected strategy was encountered. + Strategy *string `json:"strategy" validate:"required"` + + // The name for this placement group. The name must not be used by another placement group in the region. If + // unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the CreatePlacementGroupOptions.Strategy property. +// The strategy for this placement group +// - `host_spread`: place on different compute hosts +// - `power_spread`: place on compute hosts that use different power sources +// +// The enumerated values for this property may expand in the future. When processing this property, check for and log +// unknown values. Optionally halt processing and surface the error, or bypass the placement group on which the +// unexpected strategy was encountered. +const ( + CreatePlacementGroupOptionsStrategyHostSpreadConst = "host_spread" + CreatePlacementGroupOptionsStrategyPowerSpreadConst = "power_spread" +) + +// NewCreatePlacementGroupOptions : Instantiate CreatePlacementGroupOptions +func (*VpcV1) NewCreatePlacementGroupOptions(strategy string) *CreatePlacementGroupOptions { + return &CreatePlacementGroupOptions{ + Strategy: core.StringPtr(strategy), + } +} + +// SetStrategy : Allow user to set Strategy +func (_options *CreatePlacementGroupOptions) SetStrategy(strategy string) *CreatePlacementGroupOptions { + _options.Strategy = core.StringPtr(strategy) + return _options +} + +// SetName : Allow user to set Name +func (_options *CreatePlacementGroupOptions) SetName(name string) *CreatePlacementGroupOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetResourceGroup : Allow user to set ResourceGroup +func (_options *CreatePlacementGroupOptions) SetResourceGroup(resourceGroup ResourceGroupIdentityIntf) *CreatePlacementGroupOptions { + _options.ResourceGroup = resourceGroup + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreatePlacementGroupOptions) SetHeaders(param map[string]string) *CreatePlacementGroupOptions { + options.Headers = param + return options +} + +// CreatePublicGatewayOptions : The CreatePublicGateway options. +type CreatePublicGatewayOptions struct { + // The VPC this public gateway will reside in. + VPC VPCIdentityIntf `json:"vpc" validate:"required"` + + // The zone this public gateway will reside in. + Zone ZoneIdentityIntf `json:"zone" validate:"required"` + + FloatingIP PublicGatewayFloatingIPPrototypeIntf `json:"floating_ip,omitempty"` + + // The name for this public gateway. The name must not be used by another public gateway in the VPC. If unspecified, + // the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreatePublicGatewayOptions : Instantiate CreatePublicGatewayOptions +func (*VpcV1) NewCreatePublicGatewayOptions(vpc VPCIdentityIntf, zone ZoneIdentityIntf) *CreatePublicGatewayOptions { + return &CreatePublicGatewayOptions{ + VPC: vpc, + Zone: zone, + } +} + +// SetVPC : Allow user to set VPC +func (_options *CreatePublicGatewayOptions) SetVPC(vpc VPCIdentityIntf) *CreatePublicGatewayOptions { + _options.VPC = vpc + return _options +} + +// SetZone : Allow user to set Zone +func (_options *CreatePublicGatewayOptions) SetZone(zone ZoneIdentityIntf) *CreatePublicGatewayOptions { + _options.Zone = zone + return _options +} + +// SetFloatingIP : Allow user to set FloatingIP +func (_options *CreatePublicGatewayOptions) SetFloatingIP(floatingIP PublicGatewayFloatingIPPrototypeIntf) *CreatePublicGatewayOptions { + _options.FloatingIP = floatingIP + return _options +} + +// SetName : Allow user to set Name +func (_options *CreatePublicGatewayOptions) SetName(name string) *CreatePublicGatewayOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetResourceGroup : Allow user to set ResourceGroup +func (_options *CreatePublicGatewayOptions) SetResourceGroup(resourceGroup ResourceGroupIdentityIntf) *CreatePublicGatewayOptions { + _options.ResourceGroup = resourceGroup + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreatePublicGatewayOptions) SetHeaders(param map[string]string) *CreatePublicGatewayOptions { + options.Headers = param + return options +} + +// CreateSecurityGroupOptions : The CreateSecurityGroup options. +type CreateSecurityGroupOptions struct { + // The VPC this security group will reside in. + VPC VPCIdentityIntf `json:"vpc" validate:"required"` + + // The name for this security group. The name must not be used by another security group for the VPC. If unspecified, + // the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The prototype objects for rules to be created for this security group. If unspecified, no rules will be created, + // resulting in all traffic being denied. + Rules []SecurityGroupRulePrototypeIntf `json:"rules,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateSecurityGroupOptions : Instantiate CreateSecurityGroupOptions +func (*VpcV1) NewCreateSecurityGroupOptions(vpc VPCIdentityIntf) *CreateSecurityGroupOptions { + return &CreateSecurityGroupOptions{ + VPC: vpc, + } +} + +// SetVPC : Allow user to set VPC +func (_options *CreateSecurityGroupOptions) SetVPC(vpc VPCIdentityIntf) *CreateSecurityGroupOptions { + _options.VPC = vpc + return _options +} + +// SetName : Allow user to set Name +func (_options *CreateSecurityGroupOptions) SetName(name string) *CreateSecurityGroupOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetResourceGroup : Allow user to set ResourceGroup +func (_options *CreateSecurityGroupOptions) SetResourceGroup(resourceGroup ResourceGroupIdentityIntf) *CreateSecurityGroupOptions { + _options.ResourceGroup = resourceGroup + return _options +} + +// SetRules : Allow user to set Rules +func (_options *CreateSecurityGroupOptions) SetRules(rules []SecurityGroupRulePrototypeIntf) *CreateSecurityGroupOptions { + _options.Rules = rules + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateSecurityGroupOptions) SetHeaders(param map[string]string) *CreateSecurityGroupOptions { + options.Headers = param + return options +} + +// CreateSecurityGroupRuleOptions : The CreateSecurityGroupRule options. +type CreateSecurityGroupRuleOptions struct { + // The security group identifier. + SecurityGroupID *string `json:"security_group_id" validate:"required,ne="` + + // The properties of the security group rule to be created. + SecurityGroupRulePrototype SecurityGroupRulePrototypeIntf `json:"SecurityGroupRulePrototype" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateSecurityGroupRuleOptions : Instantiate CreateSecurityGroupRuleOptions +func (*VpcV1) NewCreateSecurityGroupRuleOptions(securityGroupID string, securityGroupRulePrototype SecurityGroupRulePrototypeIntf) *CreateSecurityGroupRuleOptions { + return &CreateSecurityGroupRuleOptions{ + SecurityGroupID: core.StringPtr(securityGroupID), + SecurityGroupRulePrototype: securityGroupRulePrototype, + } +} + +// SetSecurityGroupID : Allow user to set SecurityGroupID +func (_options *CreateSecurityGroupRuleOptions) SetSecurityGroupID(securityGroupID string) *CreateSecurityGroupRuleOptions { + _options.SecurityGroupID = core.StringPtr(securityGroupID) + return _options +} + +// SetSecurityGroupRulePrototype : Allow user to set SecurityGroupRulePrototype +func (_options *CreateSecurityGroupRuleOptions) SetSecurityGroupRulePrototype(securityGroupRulePrototype SecurityGroupRulePrototypeIntf) *CreateSecurityGroupRuleOptions { + _options.SecurityGroupRulePrototype = securityGroupRulePrototype + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateSecurityGroupRuleOptions) SetHeaders(param map[string]string) *CreateSecurityGroupRuleOptions { + options.Headers = param + return options +} + +// CreateSecurityGroupTargetBindingOptions : The CreateSecurityGroupTargetBinding options. +type CreateSecurityGroupTargetBindingOptions struct { + // The security group identifier. + SecurityGroupID *string `json:"security_group_id" validate:"required,ne="` + + // The security group target identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateSecurityGroupTargetBindingOptions : Instantiate CreateSecurityGroupTargetBindingOptions +func (*VpcV1) NewCreateSecurityGroupTargetBindingOptions(securityGroupID string, id string) *CreateSecurityGroupTargetBindingOptions { + return &CreateSecurityGroupTargetBindingOptions{ + SecurityGroupID: core.StringPtr(securityGroupID), + ID: core.StringPtr(id), + } +} + +// SetSecurityGroupID : Allow user to set SecurityGroupID +func (_options *CreateSecurityGroupTargetBindingOptions) SetSecurityGroupID(securityGroupID string) *CreateSecurityGroupTargetBindingOptions { + _options.SecurityGroupID = core.StringPtr(securityGroupID) + return _options +} + +// SetID : Allow user to set ID +func (_options *CreateSecurityGroupTargetBindingOptions) SetID(id string) *CreateSecurityGroupTargetBindingOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateSecurityGroupTargetBindingOptions) SetHeaders(param map[string]string) *CreateSecurityGroupTargetBindingOptions { + options.Headers = param + return options +} + +// CreateShareMountTargetOptions : The CreateShareMountTarget options. +type CreateShareMountTargetOptions struct { + // The file share identifier. + ShareID *string `json:"share_id" validate:"required,ne="` + + // The share mount target prototype object. + ShareMountTargetPrototype ShareMountTargetPrototypeIntf `json:"ShareMountTargetPrototype" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateShareMountTargetOptions : Instantiate CreateShareMountTargetOptions +func (*VpcV1) NewCreateShareMountTargetOptions(shareID string, shareMountTargetPrototype ShareMountTargetPrototypeIntf) *CreateShareMountTargetOptions { + return &CreateShareMountTargetOptions{ + ShareID: core.StringPtr(shareID), + ShareMountTargetPrototype: shareMountTargetPrototype, + } +} + +// SetShareID : Allow user to set ShareID +func (_options *CreateShareMountTargetOptions) SetShareID(shareID string) *CreateShareMountTargetOptions { + _options.ShareID = core.StringPtr(shareID) + return _options +} + +// SetShareMountTargetPrototype : Allow user to set ShareMountTargetPrototype +func (_options *CreateShareMountTargetOptions) SetShareMountTargetPrototype(shareMountTargetPrototype ShareMountTargetPrototypeIntf) *CreateShareMountTargetOptions { + _options.ShareMountTargetPrototype = shareMountTargetPrototype + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateShareMountTargetOptions) SetHeaders(param map[string]string) *CreateShareMountTargetOptions { + options.Headers = param + return options +} + +// CreateShareOptions : The CreateShare options. +type CreateShareOptions struct { + // The file share prototype object. + SharePrototype SharePrototypeIntf `json:"SharePrototype" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateShareOptions : Instantiate CreateShareOptions +func (*VpcV1) NewCreateShareOptions(sharePrototype SharePrototypeIntf) *CreateShareOptions { + return &CreateShareOptions{ + SharePrototype: sharePrototype, + } +} + +// SetSharePrototype : Allow user to set SharePrototype +func (_options *CreateShareOptions) SetSharePrototype(sharePrototype SharePrototypeIntf) *CreateShareOptions { + _options.SharePrototype = sharePrototype + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateShareOptions) SetHeaders(param map[string]string) *CreateShareOptions { + options.Headers = param + return options +} + +// CreateSnapshotCloneOptions : The CreateSnapshotClone options. +type CreateSnapshotCloneOptions struct { + // The snapshot identifier. + ID *string `json:"id" validate:"required,ne="` + + // The zone name. + ZoneName *string `json:"zone_name" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateSnapshotCloneOptions : Instantiate CreateSnapshotCloneOptions +func (*VpcV1) NewCreateSnapshotCloneOptions(id string, zoneName string) *CreateSnapshotCloneOptions { + return &CreateSnapshotCloneOptions{ + ID: core.StringPtr(id), + ZoneName: core.StringPtr(zoneName), + } +} + +// SetID : Allow user to set ID +func (_options *CreateSnapshotCloneOptions) SetID(id string) *CreateSnapshotCloneOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetZoneName : Allow user to set ZoneName +func (_options *CreateSnapshotCloneOptions) SetZoneName(zoneName string) *CreateSnapshotCloneOptions { + _options.ZoneName = core.StringPtr(zoneName) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateSnapshotCloneOptions) SetHeaders(param map[string]string) *CreateSnapshotCloneOptions { + options.Headers = param + return options +} + +// CreateSnapshotOptions : The CreateSnapshot options. +type CreateSnapshotOptions struct { + // The snapshot prototype object. + SnapshotPrototype SnapshotPrototypeIntf `json:"SnapshotPrototype" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateSnapshotOptions : Instantiate CreateSnapshotOptions +func (*VpcV1) NewCreateSnapshotOptions(snapshotPrototype SnapshotPrototypeIntf) *CreateSnapshotOptions { + return &CreateSnapshotOptions{ + SnapshotPrototype: snapshotPrototype, + } +} + +// SetSnapshotPrototype : Allow user to set SnapshotPrototype +func (_options *CreateSnapshotOptions) SetSnapshotPrototype(snapshotPrototype SnapshotPrototypeIntf) *CreateSnapshotOptions { + _options.SnapshotPrototype = snapshotPrototype + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateSnapshotOptions) SetHeaders(param map[string]string) *CreateSnapshotOptions { + options.Headers = param + return options +} + +// CreateSubnetOptions : The CreateSubnet options. +type CreateSubnetOptions struct { + // The subnet prototype object. + SubnetPrototype SubnetPrototypeIntf `json:"SubnetPrototype" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateSubnetOptions : Instantiate CreateSubnetOptions +func (*VpcV1) NewCreateSubnetOptions(subnetPrototype SubnetPrototypeIntf) *CreateSubnetOptions { + return &CreateSubnetOptions{ + SubnetPrototype: subnetPrototype, + } +} + +// SetSubnetPrototype : Allow user to set SubnetPrototype +func (_options *CreateSubnetOptions) SetSubnetPrototype(subnetPrototype SubnetPrototypeIntf) *CreateSubnetOptions { + _options.SubnetPrototype = subnetPrototype + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateSubnetOptions) SetHeaders(param map[string]string) *CreateSubnetOptions { + options.Headers = param + return options +} + +// CreateSubnetReservedIPOptions : The CreateSubnetReservedIP options. +type CreateSubnetReservedIPOptions struct { + // The subnet identifier. + SubnetID *string `json:"subnet_id" validate:"required,ne="` + + // The IP address to reserve, which must not already be reserved on the subnet. + // + // If unspecified, an available address on the subnet will automatically be selected. + Address *string `json:"address,omitempty"` + + // Indicates whether this reserved IP member will be automatically deleted when either + // `target` is deleted, or the reserved IP is unbound. Must be `false` if the reserved IP is unbound. + AutoDelete *bool `json:"auto_delete,omitempty"` + + // The name for this reserved IP. The name must not be used by another reserved IP in the subnet. Names starting with + // `ibm-` are reserved for provider-owned resources, and are not allowed. If unspecified, the name will be a hyphenated + // list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The target to bind this reserved IP to. The target must be in the same VPC. + // + // At present, only endpoint gateway targets are supported. The endpoint gateway must + // not be already bound to a reserved IP in the subnet's zone. + // + // If unspecified, the reserved IP will be created unbound. + Target ReservedIPTargetPrototypeIntf `json:"target,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateSubnetReservedIPOptions : Instantiate CreateSubnetReservedIPOptions +func (*VpcV1) NewCreateSubnetReservedIPOptions(subnetID string) *CreateSubnetReservedIPOptions { + return &CreateSubnetReservedIPOptions{ + SubnetID: core.StringPtr(subnetID), + } +} + +// SetSubnetID : Allow user to set SubnetID +func (_options *CreateSubnetReservedIPOptions) SetSubnetID(subnetID string) *CreateSubnetReservedIPOptions { + _options.SubnetID = core.StringPtr(subnetID) + return _options +} + +// SetAddress : Allow user to set Address +func (_options *CreateSubnetReservedIPOptions) SetAddress(address string) *CreateSubnetReservedIPOptions { + _options.Address = core.StringPtr(address) + return _options +} + +// SetAutoDelete : Allow user to set AutoDelete +func (_options *CreateSubnetReservedIPOptions) SetAutoDelete(autoDelete bool) *CreateSubnetReservedIPOptions { + _options.AutoDelete = core.BoolPtr(autoDelete) + return _options +} + +// SetName : Allow user to set Name +func (_options *CreateSubnetReservedIPOptions) SetName(name string) *CreateSubnetReservedIPOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetTarget : Allow user to set Target +func (_options *CreateSubnetReservedIPOptions) SetTarget(target ReservedIPTargetPrototypeIntf) *CreateSubnetReservedIPOptions { + _options.Target = target + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateSubnetReservedIPOptions) SetHeaders(param map[string]string) *CreateSubnetReservedIPOptions { + options.Headers = param + return options +} + +// CreateVolumeOptions : The CreateVolume options. +type CreateVolumeOptions struct { + // The volume prototype object. + VolumePrototype VolumePrototypeIntf `json:"VolumePrototype" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateVolumeOptions : Instantiate CreateVolumeOptions +func (*VpcV1) NewCreateVolumeOptions(volumePrototype VolumePrototypeIntf) *CreateVolumeOptions { + return &CreateVolumeOptions{ + VolumePrototype: volumePrototype, + } +} + +// SetVolumePrototype : Allow user to set VolumePrototype +func (_options *CreateVolumeOptions) SetVolumePrototype(volumePrototype VolumePrototypeIntf) *CreateVolumeOptions { + _options.VolumePrototype = volumePrototype + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateVolumeOptions) SetHeaders(param map[string]string) *CreateVolumeOptions { + options.Headers = param + return options +} + +// CreateVPCAddressPrefixOptions : The CreateVPCAddressPrefix options. +type CreateVPCAddressPrefixOptions struct { + // The VPC identifier. + VPCID *string `json:"vpc_id" validate:"required,ne="` + + // The IPv4 range of the address prefix, expressed in CIDR format. The range must not overlap with any existing address + // prefixes in the VPC or any of the following reserved address ranges: + // + // - `127.0.0.0/8` (IPv4 loopback addresses) + // - `161.26.0.0/16` (IBM services) + // - `166.8.0.0/14` (Cloud Service Endpoints) + // - `169.254.0.0/16` (IPv4 link-local addresses) + // - `224.0.0.0/4` (IPv4 multicast addresses) + // + // The prefix length of the address prefix's CIDR must be between `/9` (8,388,608 addresses) and `/29` (8 addresses). + CIDR *string `json:"cidr" validate:"required"` + + // The zone this address prefix will reside in. + Zone ZoneIdentityIntf `json:"zone" validate:"required"` + + // Indicates whether this will be the default address prefix for this zone in this VPC. If `true`, the VPC must not + // have a default address prefix for this zone. + IsDefault *bool `json:"is_default,omitempty"` + + // The name for this address prefix. The name must not be used by another address prefix for the VPC. If unspecified, + // the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateVPCAddressPrefixOptions : Instantiate CreateVPCAddressPrefixOptions +func (*VpcV1) NewCreateVPCAddressPrefixOptions(vpcID string, cidr string, zone ZoneIdentityIntf) *CreateVPCAddressPrefixOptions { + return &CreateVPCAddressPrefixOptions{ + VPCID: core.StringPtr(vpcID), + CIDR: core.StringPtr(cidr), + Zone: zone, + } +} + +// SetVPCID : Allow user to set VPCID +func (_options *CreateVPCAddressPrefixOptions) SetVPCID(vpcID string) *CreateVPCAddressPrefixOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetCIDR : Allow user to set CIDR +func (_options *CreateVPCAddressPrefixOptions) SetCIDR(cidr string) *CreateVPCAddressPrefixOptions { + _options.CIDR = core.StringPtr(cidr) + return _options +} + +// SetZone : Allow user to set Zone +func (_options *CreateVPCAddressPrefixOptions) SetZone(zone ZoneIdentityIntf) *CreateVPCAddressPrefixOptions { + _options.Zone = zone + return _options +} + +// SetIsDefault : Allow user to set IsDefault +func (_options *CreateVPCAddressPrefixOptions) SetIsDefault(isDefault bool) *CreateVPCAddressPrefixOptions { + _options.IsDefault = core.BoolPtr(isDefault) + return _options +} + +// SetName : Allow user to set Name +func (_options *CreateVPCAddressPrefixOptions) SetName(name string) *CreateVPCAddressPrefixOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateVPCAddressPrefixOptions) SetHeaders(param map[string]string) *CreateVPCAddressPrefixOptions { + options.Headers = param + return options +} + +// CreateVPCDnsResolutionBindingOptions : The CreateVPCDnsResolutionBinding options. +type CreateVPCDnsResolutionBindingOptions struct { + // The VPC identifier. + VPCID *string `json:"vpc_id" validate:"required,ne="` + + // Another VPC to bind this VPC to for DNS resolution. The VPC must have + // `dns.enable_hub` set to `true`, and may be in a different account (subject to + // IAM policies). + // + // Additionally, the VPC specified in the URL (this VPC) must have `dns.enable_hub` + // set to `false` and a `dns.resolution_binding_count` of zero. + VPC VPCIdentityIntf `json:"vpc" validate:"required"` + + // The name for this DNS resolution binding. The name must not be used by another DNS resolution binding for the VPC. + // If unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateVPCDnsResolutionBindingOptions : Instantiate CreateVPCDnsResolutionBindingOptions +func (*VpcV1) NewCreateVPCDnsResolutionBindingOptions(vpcID string, vpc VPCIdentityIntf) *CreateVPCDnsResolutionBindingOptions { + return &CreateVPCDnsResolutionBindingOptions{ + VPCID: core.StringPtr(vpcID), + VPC: vpc, + } +} + +// SetVPCID : Allow user to set VPCID +func (_options *CreateVPCDnsResolutionBindingOptions) SetVPCID(vpcID string) *CreateVPCDnsResolutionBindingOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetVPC : Allow user to set VPC +func (_options *CreateVPCDnsResolutionBindingOptions) SetVPC(vpc VPCIdentityIntf) *CreateVPCDnsResolutionBindingOptions { + _options.VPC = vpc + return _options +} + +// SetName : Allow user to set Name +func (_options *CreateVPCDnsResolutionBindingOptions) SetName(name string) *CreateVPCDnsResolutionBindingOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateVPCDnsResolutionBindingOptions) SetHeaders(param map[string]string) *CreateVPCDnsResolutionBindingOptions { + options.Headers = param + return options +} + +// CreateVPCOptions : The CreateVPC options. +type CreateVPCOptions struct { + // Indicates whether a [default address prefix](https://cloud.ibm.com/docs/vpc?topic=vpc-configuring-address-prefixes) + // will be automatically created for each zone in this VPC. If `manual`, this VPC will be created with no default + // address prefixes. + // + // Since address prefixes are managed identically regardless of whether they were automatically created, the value is + // not preserved as a VPC property. + AddressPrefixManagement *string `json:"address_prefix_management,omitempty"` + + // Indicates whether this VPC will be connected to Classic Infrastructure. If true, this VPC's resources will have + // private network connectivity to the account's Classic Infrastructure resources. Only one VPC, per region, may be + // connected in this way. This value is set at creation and subsequently immutable. + ClassicAccess *bool `json:"classic_access,omitempty"` + + // The DNS configuration for this VPC. + // + // If unspecified, the system will assign DNS servers capable of resolving hosts and endpoint + // gateways within this VPC, and hosts on the internet. + Dns *VpcdnsPrototype `json:"dns,omitempty"` + + // The name for this VPC. The name must not be used by another VPC in the region. If unspecified, the name will be a + // hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the CreateVPCOptions.AddressPrefixManagement property. +// Indicates whether a [default address prefix](https://cloud.ibm.com/docs/vpc?topic=vpc-configuring-address-prefixes) +// will be automatically created for each zone in this VPC. If `manual`, this VPC will be created with no default +// address prefixes. +// +// Since address prefixes are managed identically regardless of whether they were automatically created, the value is +// not preserved as a VPC property. +const ( + CreateVPCOptionsAddressPrefixManagementAutoConst = "auto" + CreateVPCOptionsAddressPrefixManagementManualConst = "manual" +) + +// NewCreateVPCOptions : Instantiate CreateVPCOptions +func (*VpcV1) NewCreateVPCOptions() *CreateVPCOptions { + return &CreateVPCOptions{} +} + +// SetAddressPrefixManagement : Allow user to set AddressPrefixManagement +func (_options *CreateVPCOptions) SetAddressPrefixManagement(addressPrefixManagement string) *CreateVPCOptions { + _options.AddressPrefixManagement = core.StringPtr(addressPrefixManagement) + return _options +} + +// SetClassicAccess : Allow user to set ClassicAccess +func (_options *CreateVPCOptions) SetClassicAccess(classicAccess bool) *CreateVPCOptions { + _options.ClassicAccess = core.BoolPtr(classicAccess) + return _options +} + +// SetDns : Allow user to set Dns +func (_options *CreateVPCOptions) SetDns(dns *VpcdnsPrototype) *CreateVPCOptions { + _options.Dns = dns + return _options +} + +// SetName : Allow user to set Name +func (_options *CreateVPCOptions) SetName(name string) *CreateVPCOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetResourceGroup : Allow user to set ResourceGroup +func (_options *CreateVPCOptions) SetResourceGroup(resourceGroup ResourceGroupIdentityIntf) *CreateVPCOptions { + _options.ResourceGroup = resourceGroup + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateVPCOptions) SetHeaders(param map[string]string) *CreateVPCOptions { + options.Headers = param + return options +} + +// CreateVPCRouteOptions : The CreateVPCRoute options. +type CreateVPCRouteOptions struct { + // The VPC identifier. + VPCID *string `json:"vpc_id" validate:"required,ne="` + + // The destination CIDR of the route. The host identifier in the CIDR must be zero. + // + // At most two routes per `zone` in a table can have the same `destination` and + // `priority`, and only if both routes have an `action` of `deliver` and the `next_hop` is an IP address. + Destination *string `json:"destination" validate:"required"` + + // The zone to apply the route to. (Traffic from subnets in this zone will be + // subject to this route.). + Zone ZoneIdentityIntf `json:"zone" validate:"required"` + + // The action to perform with a packet matching the route: + // - `delegate`: delegate to system-provided routes + // - `delegate_vpc`: delegate to system-provided routes, ignoring Internet-bound routes + // - `deliver`: deliver the packet to the specified `next_hop` + // - `drop`: drop the packet. + Action *string `json:"action,omitempty"` + + // The name for this route. The name must not be used by another route in the routing table. Names starting with `ibm-` + // are reserved for system-provided routes, and are not allowed. If unspecified, the name will be a hyphenated list of + // randomly-selected words. + Name *string `json:"name,omitempty"` + + // If `action` is `deliver`, the next hop that packets will be delivered to. For other + // `action` values, it must be omitted or specified as `0.0.0.0`. + // + // At most two routes per `zone` in a table can have the same `destination` and `priority`, + // and only when each route has an `action` of `deliver` and `next_hop` is an IP address. + NextHop RoutePrototypeNextHopIntf `json:"next_hop,omitempty"` + + // The priority of this route. Smaller values have higher priority. + // + // If a routing table contains multiple routes with the same `zone` and `destination`, the route with the highest + // priority (smallest value) is selected. If two routes have the same `destination` and `priority`, traffic is + // distributed between them. + Priority *int64 `json:"priority,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the CreateVPCRouteOptions.Action property. +// The action to perform with a packet matching the route: +// - `delegate`: delegate to system-provided routes +// - `delegate_vpc`: delegate to system-provided routes, ignoring Internet-bound routes +// - `deliver`: deliver the packet to the specified `next_hop` +// - `drop`: drop the packet. +const ( + CreateVPCRouteOptionsActionDelegateConst = "delegate" + CreateVPCRouteOptionsActionDelegateVPCConst = "delegate_vpc" + CreateVPCRouteOptionsActionDeliverConst = "deliver" + CreateVPCRouteOptionsActionDropConst = "drop" +) + +// NewCreateVPCRouteOptions : Instantiate CreateVPCRouteOptions +func (*VpcV1) NewCreateVPCRouteOptions(vpcID string, destination string, zone ZoneIdentityIntf) *CreateVPCRouteOptions { + return &CreateVPCRouteOptions{ + VPCID: core.StringPtr(vpcID), + Destination: core.StringPtr(destination), + Zone: zone, + } +} + +// SetVPCID : Allow user to set VPCID +func (_options *CreateVPCRouteOptions) SetVPCID(vpcID string) *CreateVPCRouteOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetDestination : Allow user to set Destination +func (_options *CreateVPCRouteOptions) SetDestination(destination string) *CreateVPCRouteOptions { + _options.Destination = core.StringPtr(destination) + return _options +} + +// SetZone : Allow user to set Zone +func (_options *CreateVPCRouteOptions) SetZone(zone ZoneIdentityIntf) *CreateVPCRouteOptions { + _options.Zone = zone + return _options +} + +// SetAction : Allow user to set Action +func (_options *CreateVPCRouteOptions) SetAction(action string) *CreateVPCRouteOptions { + _options.Action = core.StringPtr(action) + return _options +} + +// SetName : Allow user to set Name +func (_options *CreateVPCRouteOptions) SetName(name string) *CreateVPCRouteOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetNextHop : Allow user to set NextHop +func (_options *CreateVPCRouteOptions) SetNextHop(nextHop RoutePrototypeNextHopIntf) *CreateVPCRouteOptions { + _options.NextHop = nextHop + return _options +} + +// SetPriority : Allow user to set Priority +func (_options *CreateVPCRouteOptions) SetPriority(priority int64) *CreateVPCRouteOptions { + _options.Priority = core.Int64Ptr(priority) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateVPCRouteOptions) SetHeaders(param map[string]string) *CreateVPCRouteOptions { + options.Headers = param + return options +} + +// CreateVPCRoutingTableOptions : The CreateVPCRoutingTable options. +type CreateVPCRoutingTableOptions struct { + // The VPC identifier. + VPCID *string `json:"vpc_id" validate:"required,ne="` + + // The filters specifying the resources that may create routes in this routing table. + // + // At present, only the `resource_type` filter is permitted, and only the `vpn_server` value is supported, but filter + // support is expected to expand in the future. + AcceptRoutesFrom []ResourceFilter `json:"accept_routes_from,omitempty"` + + // The name for this routing table. The name must not be used by another routing table in the VPC. If unspecified, the + // name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // If set to `true`, this routing table will be used to route traffic that originates from [Direct + // Link](https://cloud.ibm.com/docs/dl) to this VPC. The VPC must not already have a routing table with this property + // set to `true`. + // + // Incoming traffic will be routed according to the routing table with one exception: routes with an `action` of + // `deliver` are treated as `drop` unless the `next_hop` is an IP address in a subnet in the route's `zone` that is + // able to accept traffic. Therefore, if an incoming packet matches a route with a `next_hop` of a VPN gateway + // connection, the packet will be dropped. + // + // If [Classic Access](https://cloud.ibm.com/docs/vpc?topic=vpc-setting-up-access-to-classic-infrastructure) is enabled + // for this VPC, and this property is set to `true`, its incoming traffic will also be routed according to this routing + // table. + RouteDirectLinkIngress *bool `json:"route_direct_link_ingress,omitempty"` + + // If set to `true`, this routing table will be used to route traffic that originates from the internet. For this to + // succeed, the VPC must not already have a routing table with this property set to `true`. + // + // Incoming traffic will be routed according to the routing table with two exceptions: + // - Traffic destined for IP addresses associated with public gateways will not be + // subject to routes in this routing table. + // - Routes with an `action` of `deliver` are treated as `drop` unless the `next_hop` is + // an IP address in a subnet in the route's `zone` that is able to accept traffic. + // Therefore, if an incoming packet matches a route with a `next_hop` of a VPN gateway + // connection, the packet will be dropped. + RouteInternetIngress *bool `json:"route_internet_ingress,omitempty"` + + // If set to `true`, this routing table will be used to route traffic that originates from [Transit + // Gateway](https://cloud.ibm.com/docs/transit-gateway) to this VPC. The VPC must not already have a routing table with + // this property set to `true`. + // + // Incoming traffic will be routed according to the routing table with one exception: routes with an `action` of + // `deliver` are treated as `drop` unless the `next_hop` is an IP address in a subnet in the route's `zone` that is + // able to accept traffic. Therefore, if an incoming packet matches a route with a `next_hop` of a VPN gateway + // connection, the packet will be dropped. + RouteTransitGatewayIngress *bool `json:"route_transit_gateway_ingress,omitempty"` + + // If set to `true`, this routing table will be used to route traffic that originates from subnets in other zones in + // this VPC. The VPC must not already have a routing table with this property set to `true`. + // + // Incoming traffic will be routed according to the routing table with one exception: routes with an `action` of + // `deliver` are treated as `drop` unless the `next_hop` is an IP address in a subnet in the route's `zone` that is + // able to accept traffic. Therefore, if an incoming packet matches a route with a `next_hop` of a VPN gateway + // connection, the packet will be dropped. + RouteVPCZoneIngress *bool `json:"route_vpc_zone_ingress,omitempty"` + + // The prototype objects for routes to create for this routing table. If unspecified, the routing table will be created + // with no routes. + Routes []RoutePrototype `json:"routes,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateVPCRoutingTableOptions : Instantiate CreateVPCRoutingTableOptions +func (*VpcV1) NewCreateVPCRoutingTableOptions(vpcID string) *CreateVPCRoutingTableOptions { + return &CreateVPCRoutingTableOptions{ + VPCID: core.StringPtr(vpcID), + } +} + +// SetVPCID : Allow user to set VPCID +func (_options *CreateVPCRoutingTableOptions) SetVPCID(vpcID string) *CreateVPCRoutingTableOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetAcceptRoutesFrom : Allow user to set AcceptRoutesFrom +func (_options *CreateVPCRoutingTableOptions) SetAcceptRoutesFrom(acceptRoutesFrom []ResourceFilter) *CreateVPCRoutingTableOptions { + _options.AcceptRoutesFrom = acceptRoutesFrom + return _options +} + +// SetName : Allow user to set Name +func (_options *CreateVPCRoutingTableOptions) SetName(name string) *CreateVPCRoutingTableOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetRouteDirectLinkIngress : Allow user to set RouteDirectLinkIngress +func (_options *CreateVPCRoutingTableOptions) SetRouteDirectLinkIngress(routeDirectLinkIngress bool) *CreateVPCRoutingTableOptions { + _options.RouteDirectLinkIngress = core.BoolPtr(routeDirectLinkIngress) + return _options +} + +// SetRouteInternetIngress : Allow user to set RouteInternetIngress +func (_options *CreateVPCRoutingTableOptions) SetRouteInternetIngress(routeInternetIngress bool) *CreateVPCRoutingTableOptions { + _options.RouteInternetIngress = core.BoolPtr(routeInternetIngress) + return _options +} + +// SetRouteTransitGatewayIngress : Allow user to set RouteTransitGatewayIngress +func (_options *CreateVPCRoutingTableOptions) SetRouteTransitGatewayIngress(routeTransitGatewayIngress bool) *CreateVPCRoutingTableOptions { + _options.RouteTransitGatewayIngress = core.BoolPtr(routeTransitGatewayIngress) + return _options +} + +// SetRouteVPCZoneIngress : Allow user to set RouteVPCZoneIngress +func (_options *CreateVPCRoutingTableOptions) SetRouteVPCZoneIngress(routeVPCZoneIngress bool) *CreateVPCRoutingTableOptions { + _options.RouteVPCZoneIngress = core.BoolPtr(routeVPCZoneIngress) + return _options +} + +// SetRoutes : Allow user to set Routes +func (_options *CreateVPCRoutingTableOptions) SetRoutes(routes []RoutePrototype) *CreateVPCRoutingTableOptions { + _options.Routes = routes + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateVPCRoutingTableOptions) SetHeaders(param map[string]string) *CreateVPCRoutingTableOptions { + options.Headers = param + return options +} + +// CreateVPCRoutingTableRouteOptions : The CreateVPCRoutingTableRoute options. +type CreateVPCRoutingTableRouteOptions struct { + // The VPC identifier. + VPCID *string `json:"vpc_id" validate:"required,ne="` + + // The routing table identifier. + RoutingTableID *string `json:"routing_table_id" validate:"required,ne="` + + // The destination CIDR of the route. The host identifier in the CIDR must be zero. + // + // At most two routes per `zone` in a table can have the same `destination` and + // `priority`, and only if both routes have an `action` of `deliver` and the `next_hop` is an IP address. + Destination *string `json:"destination" validate:"required"` + + // The zone to apply the route to. (Traffic from subnets in this zone will be + // subject to this route.). + Zone ZoneIdentityIntf `json:"zone" validate:"required"` + + // The action to perform with a packet matching the route: + // - `delegate`: delegate to system-provided routes + // - `delegate_vpc`: delegate to system-provided routes, ignoring Internet-bound routes + // - `deliver`: deliver the packet to the specified `next_hop` + // - `drop`: drop the packet. + Action *string `json:"action,omitempty"` + + // The name for this route. The name must not be used by another route in the routing table. Names starting with `ibm-` + // are reserved for system-provided routes, and are not allowed. If unspecified, the name will be a hyphenated list of + // randomly-selected words. + Name *string `json:"name,omitempty"` + + // If `action` is `deliver`, the next hop that packets will be delivered to. For other + // `action` values, it must be omitted or specified as `0.0.0.0`. + // + // At most two routes per `zone` in a table can have the same `destination` and `priority`, + // and only when each route has an `action` of `deliver` and `next_hop` is an IP address. + NextHop RoutePrototypeNextHopIntf `json:"next_hop,omitempty"` + + // The priority of this route. Smaller values have higher priority. + // + // If a routing table contains multiple routes with the same `zone` and `destination`, the route with the highest + // priority (smallest value) is selected. If two routes have the same `destination` and `priority`, traffic is + // distributed between them. + Priority *int64 `json:"priority,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the CreateVPCRoutingTableRouteOptions.Action property. +// The action to perform with a packet matching the route: +// - `delegate`: delegate to system-provided routes +// - `delegate_vpc`: delegate to system-provided routes, ignoring Internet-bound routes +// - `deliver`: deliver the packet to the specified `next_hop` +// - `drop`: drop the packet. +const ( + CreateVPCRoutingTableRouteOptionsActionDelegateConst = "delegate" + CreateVPCRoutingTableRouteOptionsActionDelegateVPCConst = "delegate_vpc" + CreateVPCRoutingTableRouteOptionsActionDeliverConst = "deliver" + CreateVPCRoutingTableRouteOptionsActionDropConst = "drop" +) + +// NewCreateVPCRoutingTableRouteOptions : Instantiate CreateVPCRoutingTableRouteOptions +func (*VpcV1) NewCreateVPCRoutingTableRouteOptions(vpcID string, routingTableID string, destination string, zone ZoneIdentityIntf) *CreateVPCRoutingTableRouteOptions { + return &CreateVPCRoutingTableRouteOptions{ + VPCID: core.StringPtr(vpcID), + RoutingTableID: core.StringPtr(routingTableID), + Destination: core.StringPtr(destination), + Zone: zone, + } +} + +// SetVPCID : Allow user to set VPCID +func (_options *CreateVPCRoutingTableRouteOptions) SetVPCID(vpcID string) *CreateVPCRoutingTableRouteOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetRoutingTableID : Allow user to set RoutingTableID +func (_options *CreateVPCRoutingTableRouteOptions) SetRoutingTableID(routingTableID string) *CreateVPCRoutingTableRouteOptions { + _options.RoutingTableID = core.StringPtr(routingTableID) + return _options +} + +// SetDestination : Allow user to set Destination +func (_options *CreateVPCRoutingTableRouteOptions) SetDestination(destination string) *CreateVPCRoutingTableRouteOptions { + _options.Destination = core.StringPtr(destination) + return _options +} + +// SetZone : Allow user to set Zone +func (_options *CreateVPCRoutingTableRouteOptions) SetZone(zone ZoneIdentityIntf) *CreateVPCRoutingTableRouteOptions { + _options.Zone = zone + return _options +} + +// SetAction : Allow user to set Action +func (_options *CreateVPCRoutingTableRouteOptions) SetAction(action string) *CreateVPCRoutingTableRouteOptions { + _options.Action = core.StringPtr(action) + return _options +} + +// SetName : Allow user to set Name +func (_options *CreateVPCRoutingTableRouteOptions) SetName(name string) *CreateVPCRoutingTableRouteOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetNextHop : Allow user to set NextHop +func (_options *CreateVPCRoutingTableRouteOptions) SetNextHop(nextHop RoutePrototypeNextHopIntf) *CreateVPCRoutingTableRouteOptions { + _options.NextHop = nextHop + return _options +} + +// SetPriority : Allow user to set Priority +func (_options *CreateVPCRoutingTableRouteOptions) SetPriority(priority int64) *CreateVPCRoutingTableRouteOptions { + _options.Priority = core.Int64Ptr(priority) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateVPCRoutingTableRouteOptions) SetHeaders(param map[string]string) *CreateVPCRoutingTableRouteOptions { + options.Headers = param + return options +} + +// CreateVPNGatewayConnectionOptions : The CreateVPNGatewayConnection options. +type CreateVPNGatewayConnectionOptions struct { + // The VPN gateway identifier. + VPNGatewayID *string `json:"vpn_gateway_id" validate:"required,ne="` + + // The VPN gateway connection prototype object. + VPNGatewayConnectionPrototype VPNGatewayConnectionPrototypeIntf `json:"VPNGatewayConnectionPrototype" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateVPNGatewayConnectionOptions : Instantiate CreateVPNGatewayConnectionOptions +func (*VpcV1) NewCreateVPNGatewayConnectionOptions(vpnGatewayID string, vpnGatewayConnectionPrototype VPNGatewayConnectionPrototypeIntf) *CreateVPNGatewayConnectionOptions { + return &CreateVPNGatewayConnectionOptions{ + VPNGatewayID: core.StringPtr(vpnGatewayID), + VPNGatewayConnectionPrototype: vpnGatewayConnectionPrototype, + } +} + +// SetVPNGatewayID : Allow user to set VPNGatewayID +func (_options *CreateVPNGatewayConnectionOptions) SetVPNGatewayID(vpnGatewayID string) *CreateVPNGatewayConnectionOptions { + _options.VPNGatewayID = core.StringPtr(vpnGatewayID) + return _options +} + +// SetVPNGatewayConnectionPrototype : Allow user to set VPNGatewayConnectionPrototype +func (_options *CreateVPNGatewayConnectionOptions) SetVPNGatewayConnectionPrototype(vpnGatewayConnectionPrototype VPNGatewayConnectionPrototypeIntf) *CreateVPNGatewayConnectionOptions { + _options.VPNGatewayConnectionPrototype = vpnGatewayConnectionPrototype + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateVPNGatewayConnectionOptions) SetHeaders(param map[string]string) *CreateVPNGatewayConnectionOptions { + options.Headers = param + return options +} + +// CreateVPNGatewayOptions : The CreateVPNGateway options. +type CreateVPNGatewayOptions struct { + // The VPN gateway prototype object. + VPNGatewayPrototype VPNGatewayPrototypeIntf `json:"VPNGatewayPrototype" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewCreateVPNGatewayOptions : Instantiate CreateVPNGatewayOptions +func (*VpcV1) NewCreateVPNGatewayOptions(vpnGatewayPrototype VPNGatewayPrototypeIntf) *CreateVPNGatewayOptions { + return &CreateVPNGatewayOptions{ + VPNGatewayPrototype: vpnGatewayPrototype, + } +} + +// SetVPNGatewayPrototype : Allow user to set VPNGatewayPrototype +func (_options *CreateVPNGatewayOptions) SetVPNGatewayPrototype(vpnGatewayPrototype VPNGatewayPrototypeIntf) *CreateVPNGatewayOptions { + _options.VPNGatewayPrototype = vpnGatewayPrototype + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateVPNGatewayOptions) SetHeaders(param map[string]string) *CreateVPNGatewayOptions { + options.Headers = param + return options +} + +// CreateVPNServerOptions : The CreateVPNServer options. +type CreateVPNServerOptions struct { + // The certificate instance for this VPN server. + Certificate CertificateInstanceIdentityIntf `json:"certificate" validate:"required"` + + // The methods used to authenticate VPN clients to this VPN server. VPN clients must authenticate against all specified + // methods. + ClientAuthentication []VPNServerAuthenticationPrototypeIntf `json:"client_authentication" validate:"required"` + + // The VPN client IPv4 address pool, expressed in CIDR format. The request must not overlap with any existing address + // prefixes in the VPC or any of the following reserved address ranges: + // - `127.0.0.0/8` (IPv4 loopback addresses) + // - `161.26.0.0/16` (IBM services) + // - `166.8.0.0/14` (Cloud Service Endpoints) + // - `169.254.0.0/16` (IPv4 link-local addresses) + // - `224.0.0.0/4` (IPv4 multicast addresses) + // + // The prefix length of the client IP address pool's CIDR must be between + // `/9` (8,388,608 addresses) and `/22` (1024 addresses). A CIDR block that contains twice the number of IP addresses + // that are required to enable the maximum number of concurrent connections is recommended. + ClientIPPool *string `json:"client_ip_pool" validate:"required"` + + // The subnets to provision this VPN server in. Use subnets in different zones for high availability. + Subnets []SubnetIdentityIntf `json:"subnets" validate:"required"` + + // The DNS server addresses that will be provided to VPN clients connected to this VPN server. + ClientDnsServerIps []IP `json:"client_dns_server_ips,omitempty"` + + // The seconds a VPN client can be idle before this VPN server will disconnect it. Specify `0` to prevent the server + // from disconnecting idle clients. + ClientIdleTimeout *int64 `json:"client_idle_timeout,omitempty"` + + // Indicates whether the split tunneling is enabled on this VPN server. + EnableSplitTunneling *bool `json:"enable_split_tunneling,omitempty"` + + // The name for this VPN server. The name must not be used by another VPN server in the VPC. If unspecified, the name + // will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The port number to use for this VPN server. + Port *int64 `json:"port,omitempty"` + + // The transport protocol to use for this VPN server. + Protocol *string `json:"protocol,omitempty"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The security groups to use for this VPN server. If unspecified, the VPC's default security group is used. + SecurityGroups []SecurityGroupIdentityIntf `json:"security_groups,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the CreateVPNServerOptions.Protocol property. +// The transport protocol to use for this VPN server. +const ( + CreateVPNServerOptionsProtocolTCPConst = "tcp" + CreateVPNServerOptionsProtocolUDPConst = "udp" +) + +// NewCreateVPNServerOptions : Instantiate CreateVPNServerOptions +func (*VpcV1) NewCreateVPNServerOptions(certificate CertificateInstanceIdentityIntf, clientAuthentication []VPNServerAuthenticationPrototypeIntf, clientIPPool string, subnets []SubnetIdentityIntf) *CreateVPNServerOptions { + return &CreateVPNServerOptions{ + Certificate: certificate, + ClientAuthentication: clientAuthentication, + ClientIPPool: core.StringPtr(clientIPPool), + Subnets: subnets, + } +} + +// SetCertificate : Allow user to set Certificate +func (_options *CreateVPNServerOptions) SetCertificate(certificate CertificateInstanceIdentityIntf) *CreateVPNServerOptions { + _options.Certificate = certificate + return _options +} + +// SetClientAuthentication : Allow user to set ClientAuthentication +func (_options *CreateVPNServerOptions) SetClientAuthentication(clientAuthentication []VPNServerAuthenticationPrototypeIntf) *CreateVPNServerOptions { + _options.ClientAuthentication = clientAuthentication + return _options +} + +// SetClientIPPool : Allow user to set ClientIPPool +func (_options *CreateVPNServerOptions) SetClientIPPool(clientIPPool string) *CreateVPNServerOptions { + _options.ClientIPPool = core.StringPtr(clientIPPool) + return _options +} + +// SetSubnets : Allow user to set Subnets +func (_options *CreateVPNServerOptions) SetSubnets(subnets []SubnetIdentityIntf) *CreateVPNServerOptions { + _options.Subnets = subnets + return _options +} + +// SetClientDnsServerIps : Allow user to set ClientDnsServerIps +func (_options *CreateVPNServerOptions) SetClientDnsServerIps(clientDnsServerIps []IP) *CreateVPNServerOptions { + _options.ClientDnsServerIps = clientDnsServerIps + return _options +} + +// SetClientIdleTimeout : Allow user to set ClientIdleTimeout +func (_options *CreateVPNServerOptions) SetClientIdleTimeout(clientIdleTimeout int64) *CreateVPNServerOptions { + _options.ClientIdleTimeout = core.Int64Ptr(clientIdleTimeout) + return _options +} + +// SetEnableSplitTunneling : Allow user to set EnableSplitTunneling +func (_options *CreateVPNServerOptions) SetEnableSplitTunneling(enableSplitTunneling bool) *CreateVPNServerOptions { + _options.EnableSplitTunneling = core.BoolPtr(enableSplitTunneling) + return _options +} + +// SetName : Allow user to set Name +func (_options *CreateVPNServerOptions) SetName(name string) *CreateVPNServerOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetPort : Allow user to set Port +func (_options *CreateVPNServerOptions) SetPort(port int64) *CreateVPNServerOptions { + _options.Port = core.Int64Ptr(port) + return _options +} + +// SetProtocol : Allow user to set Protocol +func (_options *CreateVPNServerOptions) SetProtocol(protocol string) *CreateVPNServerOptions { + _options.Protocol = core.StringPtr(protocol) + return _options +} + +// SetResourceGroup : Allow user to set ResourceGroup +func (_options *CreateVPNServerOptions) SetResourceGroup(resourceGroup ResourceGroupIdentityIntf) *CreateVPNServerOptions { + _options.ResourceGroup = resourceGroup + return _options +} + +// SetSecurityGroups : Allow user to set SecurityGroups +func (_options *CreateVPNServerOptions) SetSecurityGroups(securityGroups []SecurityGroupIdentityIntf) *CreateVPNServerOptions { + _options.SecurityGroups = securityGroups + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateVPNServerOptions) SetHeaders(param map[string]string) *CreateVPNServerOptions { + options.Headers = param + return options +} + +// CreateVPNServerRouteOptions : The CreateVPNServerRoute options. +type CreateVPNServerRouteOptions struct { + // The VPN server identifier. + VPNServerID *string `json:"vpn_server_id" validate:"required,ne="` + + // The destination to use for this VPN route in the VPN server. Must be unique within the VPN server. If an incoming + // packet does not match any destination, it will be dropped. + Destination *string `json:"destination" validate:"required"` + + // The action to perform with a packet matching the VPN route: + // - `translate`: translate the source IP address to one of the private IP addresses of the VPN server, then deliver + // the packet to target. + // - `deliver`: deliver the packet to the target. + // - `drop`: drop the packet + // + // The enumerated values for this property are expected to expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the VPN route on which the + // unexpected property value was encountered. + Action *string `json:"action,omitempty"` + + // The name for this VPN server route. The name must not be used by another route for the VPN server. If unspecified, + // the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the CreateVPNServerRouteOptions.Action property. +// The action to perform with a packet matching the VPN route: +// - `translate`: translate the source IP address to one of the private IP addresses of the VPN server, then deliver the +// packet to target. +// - `deliver`: deliver the packet to the target. +// - `drop`: drop the packet +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the VPN route on which the +// unexpected property value was encountered. +const ( + CreateVPNServerRouteOptionsActionDeliverConst = "deliver" + CreateVPNServerRouteOptionsActionDropConst = "drop" + CreateVPNServerRouteOptionsActionTranslateConst = "translate" +) + +// NewCreateVPNServerRouteOptions : Instantiate CreateVPNServerRouteOptions +func (*VpcV1) NewCreateVPNServerRouteOptions(vpnServerID string, destination string) *CreateVPNServerRouteOptions { + return &CreateVPNServerRouteOptions{ + VPNServerID: core.StringPtr(vpnServerID), + Destination: core.StringPtr(destination), + } +} + +// SetVPNServerID : Allow user to set VPNServerID +func (_options *CreateVPNServerRouteOptions) SetVPNServerID(vpnServerID string) *CreateVPNServerRouteOptions { + _options.VPNServerID = core.StringPtr(vpnServerID) + return _options +} + +// SetDestination : Allow user to set Destination +func (_options *CreateVPNServerRouteOptions) SetDestination(destination string) *CreateVPNServerRouteOptions { + _options.Destination = core.StringPtr(destination) + return _options +} + +// SetAction : Allow user to set Action +func (_options *CreateVPNServerRouteOptions) SetAction(action string) *CreateVPNServerRouteOptions { + _options.Action = core.StringPtr(action) + return _options +} + +// SetName : Allow user to set Name +func (_options *CreateVPNServerRouteOptions) SetName(name string) *CreateVPNServerRouteOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *CreateVPNServerRouteOptions) SetHeaders(param map[string]string) *CreateVPNServerRouteOptions { + options.Headers = param + return options +} + +// DnsInstanceIdentity : Identifies a DNS instance by a unique property. +// Models which "extend" this model: +// - DnsInstanceIdentityByCRN +type DnsInstanceIdentity struct { + // The CRN for this DNS instance. + CRN *string `json:"crn,omitempty"` +} + +func (*DnsInstanceIdentity) isaDnsInstanceIdentity() bool { + return true +} + +type DnsInstanceIdentityIntf interface { + isaDnsInstanceIdentity() bool +} + +// UnmarshalDnsInstanceIdentity unmarshals an instance of DnsInstanceIdentity from the specified map of raw messages. +func UnmarshalDnsInstanceIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DnsInstanceIdentity) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DnsInstanceReference : DnsInstanceReference struct +type DnsInstanceReference struct { + // The CRN for this DNS instance. + CRN *string `json:"crn" validate:"required"` +} + +// UnmarshalDnsInstanceReference unmarshals an instance of DnsInstanceReference from the specified map of raw messages. +func UnmarshalDnsInstanceReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DnsInstanceReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DnsServer : A DNS server. +type DnsServer struct { + // The IP address. + // + // This property may add support for IPv6 addresses in the future. When processing a value in this property, verify + // that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the + // error, or bypass the resource on which the unexpected IP address format was encountered. + Address *string `json:"address" validate:"required"` + + // If present, DHCP configuration for this zone will have this DNS server listed first. + ZoneAffinity *ZoneReference `json:"zone_affinity,omitempty"` +} + +// UnmarshalDnsServer unmarshals an instance of DnsServer from the specified map of raw messages. +func UnmarshalDnsServer(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DnsServer) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone_affinity", &obj.ZoneAffinity, UnmarshalZoneReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DnsServerPrototype : DnsServerPrototype struct +type DnsServerPrototype struct { + // The IP address. + // + // This property may add support for IPv6 addresses in the future. When processing a value in this property, verify + // that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the + // error, or bypass the resource on which the unexpected IP address format was encountered. + Address *string `json:"address" validate:"required"` + + // DHCP configuration for the specified zone will have this DNS server listed first. + ZoneAffinity ZoneIdentityIntf `json:"zone_affinity,omitempty"` +} + +// NewDnsServerPrototype : Instantiate DnsServerPrototype (Generic Model Constructor) +func (*VpcV1) NewDnsServerPrototype(address string) (_model *DnsServerPrototype, err error) { + _model = &DnsServerPrototype{ + Address: core.StringPtr(address), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalDnsServerPrototype unmarshals an instance of DnsServerPrototype from the specified map of raw messages. +func UnmarshalDnsServerPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DnsServerPrototype) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone_affinity", &obj.ZoneAffinity, UnmarshalZoneIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DnsZoneIdentity : Identifies a DNS zone by a unique property. +// Models which "extend" this model: +// - DnsZoneIdentityByID +type DnsZoneIdentity struct { + ID *string `json:"id,omitempty"` +} + +func (*DnsZoneIdentity) isaDnsZoneIdentity() bool { + return true +} + +type DnsZoneIdentityIntf interface { + isaDnsZoneIdentity() bool +} + +// UnmarshalDnsZoneIdentity unmarshals an instance of DnsZoneIdentity from the specified map of raw messages. +func UnmarshalDnsZoneIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DnsZoneIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DnsZoneReference : DnsZoneReference struct +type DnsZoneReference struct { + ID *string `json:"id" validate:"required"` +} + +// UnmarshalDnsZoneReference unmarshals an instance of DnsZoneReference from the specified map of raw messages. +func UnmarshalDnsZoneReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DnsZoneReference) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHost : DedicatedHost struct +type DedicatedHost struct { + // The amount of memory in gibibytes that is currently available for instances. + AvailableMemory *int64 `json:"available_memory" validate:"required"` + + // The available VCPU for the dedicated host. + AvailableVcpu *Vcpu `json:"available_vcpu" validate:"required"` + + // The date and time that the dedicated host was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The CRN for this dedicated host. + CRN *string `json:"crn" validate:"required"` + + // Collection of the dedicated host's disks. + Disks []DedicatedHostDisk `json:"disks" validate:"required"` + + // The dedicated host group this dedicated host is in. + Group *DedicatedHostGroupReference `json:"group" validate:"required"` + + // The URL for this dedicated host. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this dedicated host. + ID *string `json:"id" validate:"required"` + + // If set to true, instances can be placed on this dedicated host. + InstancePlacementEnabled *bool `json:"instance_placement_enabled" validate:"required"` + + // The instances that are allocated to this dedicated host. + Instances []InstanceReference `json:"instances" validate:"required"` + + // The lifecycle state of the dedicated host. + LifecycleState *string `json:"lifecycle_state" validate:"required"` + + // The total amount of memory in gibibytes for this host. + Memory *int64 `json:"memory" validate:"required"` + + // The name for this dedicated host. The name is unique across all dedicated hosts in the region. + Name *string `json:"name" validate:"required"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-dh-profiles) for this + // dedicated host. + Profile *DedicatedHostProfileReference `json:"profile" validate:"required"` + + // Indicates whether this dedicated host is available for instance creation. + Provisionable *bool `json:"provisionable" validate:"required"` + + // The resource group for this dedicated host. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The total number of sockets for this host. + SocketCount *int64 `json:"socket_count" validate:"required"` + + // The administrative state of the dedicated host. + // + // The enumerated values for this property are expected to expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the dedicated host on which + // the unexpected property value was encountered. + State *string `json:"state" validate:"required"` + + // The instance profiles usable by instances placed on this dedicated host. + SupportedInstanceProfiles []InstanceProfileReference `json:"supported_instance_profiles" validate:"required"` + + // The total VCPU of the dedicated host. + Vcpu *Vcpu `json:"vcpu" validate:"required"` + + // The zone this dedicated host resides in. + Zone *ZoneReference `json:"zone" validate:"required"` +} + +// Constants associated with the DedicatedHost.LifecycleState property. +// The lifecycle state of the dedicated host. +const ( + DedicatedHostLifecycleStateDeletingConst = "deleting" + DedicatedHostLifecycleStateFailedConst = "failed" + DedicatedHostLifecycleStatePendingConst = "pending" + DedicatedHostLifecycleStateStableConst = "stable" + DedicatedHostLifecycleStateSuspendedConst = "suspended" + DedicatedHostLifecycleStateUpdatingConst = "updating" + DedicatedHostLifecycleStateWaitingConst = "waiting" +) + +// Constants associated with the DedicatedHost.ResourceType property. +// The resource type. +const ( + DedicatedHostResourceTypeDedicatedHostConst = "dedicated_host" +) + +// Constants associated with the DedicatedHost.State property. +// The administrative state of the dedicated host. +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the dedicated host on which +// the unexpected property value was encountered. +const ( + DedicatedHostStateAvailableConst = "available" + DedicatedHostStateDegradedConst = "degraded" + DedicatedHostStateMigratingConst = "migrating" + DedicatedHostStateUnavailableConst = "unavailable" +) + +// UnmarshalDedicatedHost unmarshals an instance of DedicatedHost from the specified map of raw messages. +func UnmarshalDedicatedHost(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHost) + err = core.UnmarshalPrimitive(m, "available_memory", &obj.AvailableMemory) + if err != nil { + return + } + err = core.UnmarshalModel(m, "available_vcpu", &obj.AvailableVcpu, UnmarshalVcpu) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "disks", &obj.Disks, UnmarshalDedicatedHostDisk) + if err != nil { + return + } + err = core.UnmarshalModel(m, "group", &obj.Group, UnmarshalDedicatedHostGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "instance_placement_enabled", &obj.InstancePlacementEnabled) + if err != nil { + return + } + err = core.UnmarshalModel(m, "instances", &obj.Instances, UnmarshalInstanceReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "lifecycle_state", &obj.LifecycleState) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "memory", &obj.Memory) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalDedicatedHostProfileReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "provisionable", &obj.Provisionable) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "socket_count", &obj.SocketCount) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "state", &obj.State) + if err != nil { + return + } + err = core.UnmarshalModel(m, "supported_instance_profiles", &obj.SupportedInstanceProfiles, UnmarshalInstanceProfileReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vcpu", &obj.Vcpu, UnmarshalVcpu) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostCollection : DedicatedHostCollection struct +type DedicatedHostCollection struct { + // Collection of dedicated hosts. + DedicatedHosts []DedicatedHost `json:"dedicated_hosts" validate:"required"` + + // A link to the first page of resources. + First *DedicatedHostCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *DedicatedHostCollectionNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalDedicatedHostCollection unmarshals an instance of DedicatedHostCollection from the specified map of raw messages. +func UnmarshalDedicatedHostCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostCollection) + err = core.UnmarshalModel(m, "dedicated_hosts", &obj.DedicatedHosts, UnmarshalDedicatedHost) + if err != nil { + return + } + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalDedicatedHostCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalDedicatedHostCollectionNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *DedicatedHostCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// DedicatedHostCollectionFirst : A link to the first page of resources. +type DedicatedHostCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalDedicatedHostCollectionFirst unmarshals an instance of DedicatedHostCollectionFirst from the specified map of raw messages. +func UnmarshalDedicatedHostCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type DedicatedHostCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalDedicatedHostCollectionNext unmarshals an instance of DedicatedHostCollectionNext from the specified map of raw messages. +func UnmarshalDedicatedHostCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostDisk : DedicatedHostDisk struct +type DedicatedHostDisk struct { + // The remaining space left for instance placement in GB (gigabytes). + Available *int64 `json:"available" validate:"required"` + + // The date and time that the disk was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The URL for this disk. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this disk. + ID *string `json:"id" validate:"required"` + + // Instance disks that are on this dedicated host disk. + InstanceDisks []InstanceDiskReference `json:"instance_disks" validate:"required"` + + // The disk interface used for attaching the disk + // + // The enumerated values for this property are expected to expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the + // unexpected property value was encountered. + InterfaceType *string `json:"interface_type" validate:"required"` + + // The lifecycle state of this dedicated host disk. + LifecycleState *string `json:"lifecycle_state,omitempty"` + + // The name for this dedicated host disk. The name is unique across all disks on the dedicated host. + Name *string `json:"name" validate:"required"` + + // Indicates whether this dedicated host disk is available for instance disk creation. + Provisionable *bool `json:"provisionable" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The size of the disk in GB (gigabytes). + Size *int64 `json:"size" validate:"required"` + + // The instance disk interfaces supported for this dedicated host disk. + SupportedInstanceInterfaceTypes []string `json:"supported_instance_interface_types" validate:"required"` +} + +// Constants associated with the DedicatedHostDisk.InterfaceType property. +// The disk interface used for attaching the disk +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the +// unexpected property value was encountered. +const ( + DedicatedHostDiskInterfaceTypeNvmeConst = "nvme" +) + +// Constants associated with the DedicatedHostDisk.LifecycleState property. +// The lifecycle state of this dedicated host disk. +const ( + DedicatedHostDiskLifecycleStateDeletingConst = "deleting" + DedicatedHostDiskLifecycleStateFailedConst = "failed" + DedicatedHostDiskLifecycleStatePendingConst = "pending" + DedicatedHostDiskLifecycleStateStableConst = "stable" + DedicatedHostDiskLifecycleStateSuspendedConst = "suspended" + DedicatedHostDiskLifecycleStateUpdatingConst = "updating" + DedicatedHostDiskLifecycleStateWaitingConst = "waiting" +) + +// Constants associated with the DedicatedHostDisk.ResourceType property. +// The resource type. +const ( + DedicatedHostDiskResourceTypeDedicatedHostDiskConst = "dedicated_host_disk" +) + +// Constants associated with the DedicatedHostDisk.SupportedInstanceInterfaceTypes property. +// The disk interface used for attaching the disk. +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the +// unexpected property value was encountered. +const ( + DedicatedHostDiskSupportedInstanceInterfaceTypesNvmeConst = "nvme" + DedicatedHostDiskSupportedInstanceInterfaceTypesVirtioBlkConst = "virtio_blk" +) + +// UnmarshalDedicatedHostDisk unmarshals an instance of DedicatedHostDisk from the specified map of raw messages. +func UnmarshalDedicatedHostDisk(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostDisk) + err = core.UnmarshalPrimitive(m, "available", &obj.Available) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalModel(m, "instance_disks", &obj.InstanceDisks, UnmarshalInstanceDiskReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "interface_type", &obj.InterfaceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "lifecycle_state", &obj.LifecycleState) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "provisionable", &obj.Provisionable) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "size", &obj.Size) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "supported_instance_interface_types", &obj.SupportedInstanceInterfaceTypes) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostDiskCollection : DedicatedHostDiskCollection struct +type DedicatedHostDiskCollection struct { + // Collection of the dedicated host's disks. + Disks []DedicatedHostDisk `json:"disks" validate:"required"` +} + +// UnmarshalDedicatedHostDiskCollection unmarshals an instance of DedicatedHostDiskCollection from the specified map of raw messages. +func UnmarshalDedicatedHostDiskCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostDiskCollection) + err = core.UnmarshalModel(m, "disks", &obj.Disks, UnmarshalDedicatedHostDisk) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostDiskPatch : DedicatedHostDiskPatch struct +type DedicatedHostDiskPatch struct { + // The name for this dedicated host disk. The name must not be used by another disk on the dedicated host. + Name *string `json:"name,omitempty"` +} + +// UnmarshalDedicatedHostDiskPatch unmarshals an instance of DedicatedHostDiskPatch from the specified map of raw messages. +func UnmarshalDedicatedHostDiskPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostDiskPatch) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the DedicatedHostDiskPatch +func (dedicatedHostDiskPatch *DedicatedHostDiskPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(dedicatedHostDiskPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// DedicatedHostGroup : DedicatedHostGroup struct +type DedicatedHostGroup struct { + // The dedicated host profile class for hosts in this group. + Class *string `json:"class" validate:"required"` + + // The date and time that the dedicated host group was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The CRN for this dedicated host group. + CRN *string `json:"crn" validate:"required"` + + // The dedicated hosts that are in this dedicated host group. + DedicatedHosts []DedicatedHostReference `json:"dedicated_hosts" validate:"required"` + + // The dedicated host profile family for hosts in this group. + Family *string `json:"family" validate:"required"` + + // The URL for this dedicated host group. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this dedicated host group. + ID *string `json:"id" validate:"required"` + + // The name for this dedicated host group. The name is unique across all dedicated host groups in the region. + Name *string `json:"name" validate:"required"` + + // The resource group for this dedicated host group. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The instance profiles usable by instances placed on this dedicated host group. + SupportedInstanceProfiles []InstanceProfileReference `json:"supported_instance_profiles" validate:"required"` + + // The zone this dedicated host group resides in. + Zone *ZoneReference `json:"zone" validate:"required"` +} + +// Constants associated with the DedicatedHostGroup.Family property. +// The dedicated host profile family for hosts in this group. +const ( + DedicatedHostGroupFamilyBalancedConst = "balanced" + DedicatedHostGroupFamilyComputeConst = "compute" + DedicatedHostGroupFamilyMemoryConst = "memory" +) + +// Constants associated with the DedicatedHostGroup.ResourceType property. +// The resource type. +const ( + DedicatedHostGroupResourceTypeDedicatedHostGroupConst = "dedicated_host_group" +) + +// UnmarshalDedicatedHostGroup unmarshals an instance of DedicatedHostGroup from the specified map of raw messages. +func UnmarshalDedicatedHostGroup(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostGroup) + err = core.UnmarshalPrimitive(m, "class", &obj.Class) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "dedicated_hosts", &obj.DedicatedHosts, UnmarshalDedicatedHostReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "family", &obj.Family) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalModel(m, "supported_instance_profiles", &obj.SupportedInstanceProfiles, UnmarshalInstanceProfileReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostGroupCollection : DedicatedHostGroupCollection struct +type DedicatedHostGroupCollection struct { + // A link to the first page of resources. + First *DedicatedHostGroupCollectionFirst `json:"first" validate:"required"` + + // Collection of dedicated host groups. + Groups []DedicatedHostGroup `json:"groups" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *DedicatedHostGroupCollectionNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalDedicatedHostGroupCollection unmarshals an instance of DedicatedHostGroupCollection from the specified map of raw messages. +func UnmarshalDedicatedHostGroupCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostGroupCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalDedicatedHostGroupCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalModel(m, "groups", &obj.Groups, UnmarshalDedicatedHostGroup) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalDedicatedHostGroupCollectionNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *DedicatedHostGroupCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// DedicatedHostGroupCollectionFirst : A link to the first page of resources. +type DedicatedHostGroupCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalDedicatedHostGroupCollectionFirst unmarshals an instance of DedicatedHostGroupCollectionFirst from the specified map of raw messages. +func UnmarshalDedicatedHostGroupCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostGroupCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostGroupCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type DedicatedHostGroupCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalDedicatedHostGroupCollectionNext unmarshals an instance of DedicatedHostGroupCollectionNext from the specified map of raw messages. +func UnmarshalDedicatedHostGroupCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostGroupCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostGroupIdentity : Identifies a dedicated host group by a unique property. +// Models which "extend" this model: +// - DedicatedHostGroupIdentityByID +// - DedicatedHostGroupIdentityByCRN +// - DedicatedHostGroupIdentityByHref +type DedicatedHostGroupIdentity struct { + // The unique identifier for this dedicated host group. + ID *string `json:"id,omitempty"` + + // The CRN for this dedicated host group. + CRN *string `json:"crn,omitempty"` + + // The URL for this dedicated host group. + Href *string `json:"href,omitempty"` +} + +func (*DedicatedHostGroupIdentity) isaDedicatedHostGroupIdentity() bool { + return true +} + +type DedicatedHostGroupIdentityIntf interface { + isaDedicatedHostGroupIdentity() bool +} + +// UnmarshalDedicatedHostGroupIdentity unmarshals an instance of DedicatedHostGroupIdentity from the specified map of raw messages. +func UnmarshalDedicatedHostGroupIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostGroupIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostGroupPatch : DedicatedHostGroupPatch struct +type DedicatedHostGroupPatch struct { + // The name for this dedicated host group. The name must not be used by another dedicated host group in the region. + Name *string `json:"name,omitempty"` +} + +// UnmarshalDedicatedHostGroupPatch unmarshals an instance of DedicatedHostGroupPatch from the specified map of raw messages. +func UnmarshalDedicatedHostGroupPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostGroupPatch) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the DedicatedHostGroupPatch +func (dedicatedHostGroupPatch *DedicatedHostGroupPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(dedicatedHostGroupPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// DedicatedHostGroupPrototypeDedicatedHostByZoneContext : DedicatedHostGroupPrototypeDedicatedHostByZoneContext struct +type DedicatedHostGroupPrototypeDedicatedHostByZoneContext struct { + // The name for this dedicated host group. The name must not be used by another dedicated host group in the region. If + // unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The resource group to use. If unspecified, the host's resource group is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` +} + +// UnmarshalDedicatedHostGroupPrototypeDedicatedHostByZoneContext unmarshals an instance of DedicatedHostGroupPrototypeDedicatedHostByZoneContext from the specified map of raw messages. +func UnmarshalDedicatedHostGroupPrototypeDedicatedHostByZoneContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostGroupPrototypeDedicatedHostByZoneContext) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostGroupReference : DedicatedHostGroupReference struct +type DedicatedHostGroupReference struct { + // The CRN for this dedicated host group. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *DedicatedHostGroupReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this dedicated host group. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this dedicated host group. + ID *string `json:"id" validate:"required"` + + // The name for this dedicated host group. The name is unique across all dedicated host groups in the region. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the DedicatedHostGroupReference.ResourceType property. +// The resource type. +const ( + DedicatedHostGroupReferenceResourceTypeDedicatedHostGroupConst = "dedicated_host_group" +) + +// UnmarshalDedicatedHostGroupReference unmarshals an instance of DedicatedHostGroupReference from the specified map of raw messages. +func UnmarshalDedicatedHostGroupReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostGroupReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalDedicatedHostGroupReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostGroupReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type DedicatedHostGroupReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalDedicatedHostGroupReferenceDeleted unmarshals an instance of DedicatedHostGroupReferenceDeleted from the specified map of raw messages. +func UnmarshalDedicatedHostGroupReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostGroupReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostPatch : DedicatedHostPatch struct +type DedicatedHostPatch struct { + // If set to true, instances can be placed on this dedicated host. + InstancePlacementEnabled *bool `json:"instance_placement_enabled,omitempty"` + + // The name for this dedicated host. The name must not be used by another dedicated host in the region. + Name *string `json:"name,omitempty"` +} + +// UnmarshalDedicatedHostPatch unmarshals an instance of DedicatedHostPatch from the specified map of raw messages. +func UnmarshalDedicatedHostPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostPatch) + err = core.UnmarshalPrimitive(m, "instance_placement_enabled", &obj.InstancePlacementEnabled) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the DedicatedHostPatch +func (dedicatedHostPatch *DedicatedHostPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(dedicatedHostPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// DedicatedHostProfile : DedicatedHostProfile struct +type DedicatedHostProfile struct { + // The product class this dedicated host profile belongs to. + Class *string `json:"class" validate:"required"` + + // Collection of the dedicated host profile's disks. + Disks []DedicatedHostProfileDisk `json:"disks" validate:"required"` + + // The product family this dedicated host profile belongs to + // + // The enumerated values for this property are expected to expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the + // unexpected property value was encountered. + Family *string `json:"family" validate:"required"` + + // The URL for this dedicated host. + Href *string `json:"href" validate:"required"` + + Memory DedicatedHostProfileMemoryIntf `json:"memory" validate:"required"` + + // The globally unique name for this dedicated host profile. + Name *string `json:"name" validate:"required"` + + SocketCount DedicatedHostProfileSocketIntf `json:"socket_count" validate:"required"` + + // The instance profiles usable by instances placed on dedicated hosts with this profile. + SupportedInstanceProfiles []InstanceProfileReference `json:"supported_instance_profiles" validate:"required"` + + VcpuArchitecture *DedicatedHostProfileVcpuArchitecture `json:"vcpu_architecture" validate:"required"` + + VcpuCount DedicatedHostProfileVcpuIntf `json:"vcpu_count" validate:"required"` + + VcpuManufacturer *DedicatedHostProfileVcpuManufacturer `json:"vcpu_manufacturer" validate:"required"` +} + +// Constants associated with the DedicatedHostProfile.Family property. +// The product family this dedicated host profile belongs to +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the +// unexpected property value was encountered. +const ( + DedicatedHostProfileFamilyBalancedConst = "balanced" + DedicatedHostProfileFamilyComputeConst = "compute" + DedicatedHostProfileFamilyMemoryConst = "memory" +) + +// UnmarshalDedicatedHostProfile unmarshals an instance of DedicatedHostProfile from the specified map of raw messages. +func UnmarshalDedicatedHostProfile(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostProfile) + err = core.UnmarshalPrimitive(m, "class", &obj.Class) + if err != nil { + return + } + err = core.UnmarshalModel(m, "disks", &obj.Disks, UnmarshalDedicatedHostProfileDisk) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "family", &obj.Family) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalModel(m, "memory", &obj.Memory, UnmarshalDedicatedHostProfileMemory) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "socket_count", &obj.SocketCount, UnmarshalDedicatedHostProfileSocket) + if err != nil { + return + } + err = core.UnmarshalModel(m, "supported_instance_profiles", &obj.SupportedInstanceProfiles, UnmarshalInstanceProfileReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vcpu_architecture", &obj.VcpuArchitecture, UnmarshalDedicatedHostProfileVcpuArchitecture) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vcpu_count", &obj.VcpuCount, UnmarshalDedicatedHostProfileVcpu) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vcpu_manufacturer", &obj.VcpuManufacturer, UnmarshalDedicatedHostProfileVcpuManufacturer) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostProfileCollection : DedicatedHostProfileCollection struct +type DedicatedHostProfileCollection struct { + // A link to the first page of resources. + First *DedicatedHostProfileCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *DedicatedHostProfileCollectionNext `json:"next,omitempty"` + + // Collection of dedicated host profiles. + Profiles []DedicatedHostProfile `json:"profiles" validate:"required"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalDedicatedHostProfileCollection unmarshals an instance of DedicatedHostProfileCollection from the specified map of raw messages. +func UnmarshalDedicatedHostProfileCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostProfileCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalDedicatedHostProfileCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalDedicatedHostProfileCollectionNext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profiles", &obj.Profiles, UnmarshalDedicatedHostProfile) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *DedicatedHostProfileCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// DedicatedHostProfileCollectionFirst : A link to the first page of resources. +type DedicatedHostProfileCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalDedicatedHostProfileCollectionFirst unmarshals an instance of DedicatedHostProfileCollectionFirst from the specified map of raw messages. +func UnmarshalDedicatedHostProfileCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostProfileCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostProfileCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type DedicatedHostProfileCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalDedicatedHostProfileCollectionNext unmarshals an instance of DedicatedHostProfileCollectionNext from the specified map of raw messages. +func UnmarshalDedicatedHostProfileCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostProfileCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostProfileDisk : Disks provided by this profile. +type DedicatedHostProfileDisk struct { + InterfaceType *DedicatedHostProfileDiskInterface `json:"interface_type" validate:"required"` + + // The number of disks of this type for a dedicated host with this profile. + Quantity *DedicatedHostProfileDiskQuantity `json:"quantity" validate:"required"` + + // The size of the disk in GB (gigabytes). + Size *DedicatedHostProfileDiskSize `json:"size" validate:"required"` + + SupportedInstanceInterfaceTypes *DedicatedHostProfileDiskSupportedInterfaces `json:"supported_instance_interface_types" validate:"required"` +} + +// UnmarshalDedicatedHostProfileDisk unmarshals an instance of DedicatedHostProfileDisk from the specified map of raw messages. +func UnmarshalDedicatedHostProfileDisk(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostProfileDisk) + err = core.UnmarshalModel(m, "interface_type", &obj.InterfaceType, UnmarshalDedicatedHostProfileDiskInterface) + if err != nil { + return + } + err = core.UnmarshalModel(m, "quantity", &obj.Quantity, UnmarshalDedicatedHostProfileDiskQuantity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "size", &obj.Size, UnmarshalDedicatedHostProfileDiskSize) + if err != nil { + return + } + err = core.UnmarshalModel(m, "supported_instance_interface_types", &obj.SupportedInstanceInterfaceTypes, UnmarshalDedicatedHostProfileDiskSupportedInterfaces) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostProfileDiskInterface : DedicatedHostProfileDiskInterface struct +type DedicatedHostProfileDiskInterface struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The interface of the disk for a dedicated host with this profile + // + // The enumerated values for this property are expected to expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the + // unexpected property value was encountered. + Value *string `json:"value" validate:"required"` +} + +// Constants associated with the DedicatedHostProfileDiskInterface.Type property. +// The type for this profile field. +const ( + DedicatedHostProfileDiskInterfaceTypeFixedConst = "fixed" +) + +// Constants associated with the DedicatedHostProfileDiskInterface.Value property. +// The interface of the disk for a dedicated host with this profile +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the +// unexpected property value was encountered. +const ( + DedicatedHostProfileDiskInterfaceValueNvmeConst = "nvme" +) + +// UnmarshalDedicatedHostProfileDiskInterface unmarshals an instance of DedicatedHostProfileDiskInterface from the specified map of raw messages. +func UnmarshalDedicatedHostProfileDiskInterface(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostProfileDiskInterface) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostProfileDiskQuantity : The number of disks of this type for a dedicated host with this profile. +type DedicatedHostProfileDiskQuantity struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The value for this profile field. + Value *int64 `json:"value" validate:"required"` +} + +// Constants associated with the DedicatedHostProfileDiskQuantity.Type property. +// The type for this profile field. +const ( + DedicatedHostProfileDiskQuantityTypeFixedConst = "fixed" +) + +// UnmarshalDedicatedHostProfileDiskQuantity unmarshals an instance of DedicatedHostProfileDiskQuantity from the specified map of raw messages. +func UnmarshalDedicatedHostProfileDiskQuantity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostProfileDiskQuantity) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostProfileDiskSize : The size of the disk in GB (gigabytes). +type DedicatedHostProfileDiskSize struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The size of the disk in GB (gigabytes). + Value *int64 `json:"value" validate:"required"` +} + +// Constants associated with the DedicatedHostProfileDiskSize.Type property. +// The type for this profile field. +const ( + DedicatedHostProfileDiskSizeTypeFixedConst = "fixed" +) + +// UnmarshalDedicatedHostProfileDiskSize unmarshals an instance of DedicatedHostProfileDiskSize from the specified map of raw messages. +func UnmarshalDedicatedHostProfileDiskSize(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostProfileDiskSize) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostProfileDiskSupportedInterfaces : DedicatedHostProfileDiskSupportedInterfaces struct +type DedicatedHostProfileDiskSupportedInterfaces struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The instance disk interfaces supported for a dedicated host with this profile. + Value []string `json:"value" validate:"required"` +} + +// Constants associated with the DedicatedHostProfileDiskSupportedInterfaces.Type property. +// The type for this profile field. +const ( + DedicatedHostProfileDiskSupportedInterfacesTypeFixedConst = "fixed" +) + +// Constants associated with the DedicatedHostProfileDiskSupportedInterfaces.Value property. +// The disk interface used for attaching the disk. +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the +// unexpected property value was encountered. +const ( + DedicatedHostProfileDiskSupportedInterfacesValueNvmeConst = "nvme" + DedicatedHostProfileDiskSupportedInterfacesValueVirtioBlkConst = "virtio_blk" +) + +// UnmarshalDedicatedHostProfileDiskSupportedInterfaces unmarshals an instance of DedicatedHostProfileDiskSupportedInterfaces from the specified map of raw messages. +func UnmarshalDedicatedHostProfileDiskSupportedInterfaces(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostProfileDiskSupportedInterfaces) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostProfileIdentity : Identifies a dedicated host profile by a unique property. +// Models which "extend" this model: +// - DedicatedHostProfileIdentityByName +// - DedicatedHostProfileIdentityByHref +type DedicatedHostProfileIdentity struct { + // The globally unique name for this dedicated host profile. + Name *string `json:"name,omitempty"` + + // The URL for this dedicated host profile. + Href *string `json:"href,omitempty"` +} + +func (*DedicatedHostProfileIdentity) isaDedicatedHostProfileIdentity() bool { + return true +} + +type DedicatedHostProfileIdentityIntf interface { + isaDedicatedHostProfileIdentity() bool +} + +// UnmarshalDedicatedHostProfileIdentity unmarshals an instance of DedicatedHostProfileIdentity from the specified map of raw messages. +func UnmarshalDedicatedHostProfileIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostProfileIdentity) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostProfileMemory : DedicatedHostProfileMemory struct +// Models which "extend" this model: +// - DedicatedHostProfileMemoryFixed +// - DedicatedHostProfileMemoryRange +// - DedicatedHostProfileMemoryEnum +// - DedicatedHostProfileMemoryDependent +type DedicatedHostProfileMemory struct { + // The type for this profile field. + Type *string `json:"type,omitempty"` + + // The value for this profile field. + Value *int64 `json:"value,omitempty"` + + // The default value for this profile field. + Default *int64 `json:"default,omitempty"` + + // The maximum value for this profile field. + Max *int64 `json:"max,omitempty"` + + // The minimum value for this profile field. + Min *int64 `json:"min,omitempty"` + + // The increment step value for this profile field. + Step *int64 `json:"step,omitempty"` + + // The permitted values for this profile field. + Values []int64 `json:"values,omitempty"` +} + +// Constants associated with the DedicatedHostProfileMemory.Type property. +// The type for this profile field. +const ( + DedicatedHostProfileMemoryTypeFixedConst = "fixed" +) + +func (*DedicatedHostProfileMemory) isaDedicatedHostProfileMemory() bool { + return true +} + +type DedicatedHostProfileMemoryIntf interface { + isaDedicatedHostProfileMemory() bool +} + +// UnmarshalDedicatedHostProfileMemory unmarshals an instance of DedicatedHostProfileMemory from the specified map of raw messages. +func UnmarshalDedicatedHostProfileMemory(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostProfileMemory) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostProfileReference : DedicatedHostProfileReference struct +type DedicatedHostProfileReference struct { + // The URL for this dedicated host. + Href *string `json:"href" validate:"required"` + + // The globally unique name for this dedicated host profile. + Name *string `json:"name" validate:"required"` +} + +// UnmarshalDedicatedHostProfileReference unmarshals an instance of DedicatedHostProfileReference from the specified map of raw messages. +func UnmarshalDedicatedHostProfileReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostProfileReference) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostProfileSocket : DedicatedHostProfileSocket struct +// Models which "extend" this model: +// - DedicatedHostProfileSocketFixed +// - DedicatedHostProfileSocketRange +// - DedicatedHostProfileSocketEnum +// - DedicatedHostProfileSocketDependent +type DedicatedHostProfileSocket struct { + // The type for this profile field. + Type *string `json:"type,omitempty"` + + // The value for this profile field. + Value *int64 `json:"value,omitempty"` + + // The default value for this profile field. + Default *int64 `json:"default,omitempty"` + + // The maximum value for this profile field. + Max *int64 `json:"max,omitempty"` + + // The minimum value for this profile field. + Min *int64 `json:"min,omitempty"` + + // The increment step value for this profile field. + Step *int64 `json:"step,omitempty"` + + // The permitted values for this profile field. + Values []int64 `json:"values,omitempty"` +} + +// Constants associated with the DedicatedHostProfileSocket.Type property. +// The type for this profile field. +const ( + DedicatedHostProfileSocketTypeFixedConst = "fixed" +) + +func (*DedicatedHostProfileSocket) isaDedicatedHostProfileSocket() bool { + return true +} + +type DedicatedHostProfileSocketIntf interface { + isaDedicatedHostProfileSocket() bool +} + +// UnmarshalDedicatedHostProfileSocket unmarshals an instance of DedicatedHostProfileSocket from the specified map of raw messages. +func UnmarshalDedicatedHostProfileSocket(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostProfileSocket) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostProfileVcpu : DedicatedHostProfileVcpu struct +// Models which "extend" this model: +// - DedicatedHostProfileVcpuFixed +// - DedicatedHostProfileVcpuRange +// - DedicatedHostProfileVcpuEnum +// - DedicatedHostProfileVcpuDependent +type DedicatedHostProfileVcpu struct { + // The type for this profile field. + Type *string `json:"type,omitempty"` + + // The value for this profile field. + Value *int64 `json:"value,omitempty"` + + // The default value for this profile field. + Default *int64 `json:"default,omitempty"` + + // The maximum value for this profile field. + Max *int64 `json:"max,omitempty"` + + // The minimum value for this profile field. + Min *int64 `json:"min,omitempty"` + + // The increment step value for this profile field. + Step *int64 `json:"step,omitempty"` + + // The permitted values for this profile field. + Values []int64 `json:"values,omitempty"` +} + +// Constants associated with the DedicatedHostProfileVcpu.Type property. +// The type for this profile field. +const ( + DedicatedHostProfileVcpuTypeFixedConst = "fixed" +) + +func (*DedicatedHostProfileVcpu) isaDedicatedHostProfileVcpu() bool { + return true +} + +type DedicatedHostProfileVcpuIntf interface { + isaDedicatedHostProfileVcpu() bool +} + +// UnmarshalDedicatedHostProfileVcpu unmarshals an instance of DedicatedHostProfileVcpu from the specified map of raw messages. +func UnmarshalDedicatedHostProfileVcpu(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostProfileVcpu) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostProfileVcpuArchitecture : DedicatedHostProfileVcpuArchitecture struct +type DedicatedHostProfileVcpuArchitecture struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The VCPU architecture for a dedicated host with this profile. + Value *string `json:"value" validate:"required"` +} + +// Constants associated with the DedicatedHostProfileVcpuArchitecture.Type property. +// The type for this profile field. +const ( + DedicatedHostProfileVcpuArchitectureTypeFixedConst = "fixed" +) + +// UnmarshalDedicatedHostProfileVcpuArchitecture unmarshals an instance of DedicatedHostProfileVcpuArchitecture from the specified map of raw messages. +func UnmarshalDedicatedHostProfileVcpuArchitecture(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostProfileVcpuArchitecture) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostProfileVcpuManufacturer : DedicatedHostProfileVcpuManufacturer struct +type DedicatedHostProfileVcpuManufacturer struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The VCPU manufacturer for a dedicated host with this profile. + Value *string `json:"value" validate:"required"` +} + +// Constants associated with the DedicatedHostProfileVcpuManufacturer.Type property. +// The type for this profile field. +const ( + DedicatedHostProfileVcpuManufacturerTypeFixedConst = "fixed" +) + +// UnmarshalDedicatedHostProfileVcpuManufacturer unmarshals an instance of DedicatedHostProfileVcpuManufacturer from the specified map of raw messages. +func UnmarshalDedicatedHostProfileVcpuManufacturer(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostProfileVcpuManufacturer) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostPrototype : DedicatedHostPrototype struct +// Models which "extend" this model: +// - DedicatedHostPrototypeDedicatedHostByGroup +// - DedicatedHostPrototypeDedicatedHostByZone +type DedicatedHostPrototype struct { + // If set to true, instances can be placed on this dedicated host. + InstancePlacementEnabled *bool `json:"instance_placement_enabled,omitempty"` + + // The name for this dedicated host. The name must not be used by another dedicated host in the region. If unspecified, + // the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-dh-profiles) to use for this + // dedicated host. + Profile DedicatedHostProfileIdentityIntf `json:"profile" validate:"required"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The dedicated host group for this dedicated host. + Group DedicatedHostGroupIdentityIntf `json:"group,omitempty"` + + // The zone this dedicated host will reside in. + Zone ZoneIdentityIntf `json:"zone,omitempty"` +} + +func (*DedicatedHostPrototype) isaDedicatedHostPrototype() bool { + return true +} + +type DedicatedHostPrototypeIntf interface { + isaDedicatedHostPrototype() bool +} + +// UnmarshalDedicatedHostPrototype unmarshals an instance of DedicatedHostPrototype from the specified map of raw messages. +func UnmarshalDedicatedHostPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostPrototype) + err = core.UnmarshalPrimitive(m, "instance_placement_enabled", &obj.InstancePlacementEnabled) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalDedicatedHostProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "group", &obj.Group, UnmarshalDedicatedHostGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostReference : DedicatedHostReference struct +type DedicatedHostReference struct { + // The CRN for this dedicated host. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *DedicatedHostReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this dedicated host. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this dedicated host. + ID *string `json:"id" validate:"required"` + + // The name for this dedicated host. The name is unique across all dedicated hosts in the region. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the DedicatedHostReference.ResourceType property. +// The resource type. +const ( + DedicatedHostReferenceResourceTypeDedicatedHostConst = "dedicated_host" +) + +// UnmarshalDedicatedHostReference unmarshals an instance of DedicatedHostReference from the specified map of raw messages. +func UnmarshalDedicatedHostReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalDedicatedHostReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type DedicatedHostReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalDedicatedHostReferenceDeleted unmarshals an instance of DedicatedHostReferenceDeleted from the specified map of raw messages. +func UnmarshalDedicatedHostReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DefaultNetworkACL : DefaultNetworkACL struct +type DefaultNetworkACL struct { + // The date and time that the network ACL was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The CRN for this network ACL. + CRN *string `json:"crn" validate:"required"` + + // The URL for this network ACL. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this network ACL. + ID *string `json:"id" validate:"required"` + + // The name of the default network ACL created for a VPC. The name will be a hyphenated list of randomly-selected words + // at creation, but may be changed. + Name *string `json:"name" validate:"required"` + + // The resource group for the default network ACL for a VPC. Set to the VPC's + // resource group at creation. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The ordered rules for the default network ACL for a VPC. Defaults to two rules which allow all inbound and outbound + // traffic, respectively. Rules for the default network ACL may be changed, added, or removed. + Rules []NetworkACLRuleItemIntf `json:"rules" validate:"required"` + + // The subnets to which this network ACL is attached. + Subnets []SubnetReference `json:"subnets" validate:"required"` + + // The VPC this network ACL resides in. + VPC *VPCReference `json:"vpc" validate:"required"` +} + +// UnmarshalDefaultNetworkACL unmarshals an instance of DefaultNetworkACL from the specified map of raw messages. +func UnmarshalDefaultNetworkACL(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DefaultNetworkACL) + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "rules", &obj.Rules, UnmarshalNetworkACLRuleItem) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnets", &obj.Subnets, UnmarshalSubnetReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DefaultRoutingTable : DefaultRoutingTable struct +type DefaultRoutingTable struct { + // The filters specifying the resources that may create routes in this routing table. + // + // At present, only the `resource_type` filter is permitted, and only the `vpn_server` value is supported, but filter + // support is expected to expand in the future. + AcceptRoutesFrom []ResourceFilter `json:"accept_routes_from" validate:"required"` + + // The date and time that this routing table was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The URL for this routing table. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this routing table. + ID *string `json:"id" validate:"required"` + + // Indicates whether this is the default routing table for this VPC. + IsDefault *bool `json:"is_default" validate:"required"` + + // The lifecycle state of the routing table. + LifecycleState *string `json:"lifecycle_state" validate:"required"` + + // The name of the default routing table created for this VPC. The name will be a hyphenated list of randomly-selected + // words at creation, but may be changed. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // Indicates whether this routing table is used to route traffic that originates from + // [Direct Link](https://cloud.ibm.com/docs/dl) to this VPC. + // + // Incoming traffic will be routed according to the routing table with one exception: routes with an `action` of + // `deliver` are treated as `drop` unless the `next_hop` is an IP address in a subnet in the route's `zone` that is + // able to accept traffic. Therefore, if an incoming packet matches a route with a `next_hop` of a VPN gateway + // connection, the packet will be dropped. + RouteDirectLinkIngress *bool `json:"route_direct_link_ingress" validate:"required"` + + // Indicates whether this routing table is used to route traffic that originates from the internet. + // + // Incoming traffic will be routed according to the routing table with two exceptions: + // - Traffic destined for IP addresses associated with public gateways will not be + // subject to routes in this routing table. + // - Routes with an `action` of `deliver` are treated as `drop` unless the `next_hop` is + // an IP address in a subnet in the route's `zone` that is able to accept traffic. + // Therefore, if an incoming packet matches a route with a `next_hop` of a VPN gateway + // connection, the packet will be dropped. + RouteInternetIngress *bool `json:"route_internet_ingress" validate:"required"` + + // Indicates whether this routing table is used to route traffic that originates from from [Transit + // Gateway](https://cloud.ibm.com/docs/transit-gateway) to this VPC. + // + // Incoming traffic will be routed according to the routing table with one exception: routes with an `action` of + // `deliver` are treated as `drop` unless the `next_hop` is an IP address in a subnet in the route's `zone` that is + // able to accept traffic. Therefore, if an incoming packet matches a route with a `next_hop` of a VPN gateway + // connection, the packet will be dropped. + RouteTransitGatewayIngress *bool `json:"route_transit_gateway_ingress" validate:"required"` + + // Indicates whether this routing table is used to route traffic that originates from subnets in other zones in this + // VPC. + // + // Incoming traffic will be routed according to the routing table with one exception: routes with an `action` of + // `deliver` are treated as `drop` unless the `next_hop` is an IP address in a subnet in the route's `zone` that is + // able to accept traffic. Therefore, if an incoming packet matches a route with a `next_hop` of a VPN gateway + // connection, the packet will be dropped. + RouteVPCZoneIngress *bool `json:"route_vpc_zone_ingress" validate:"required"` + + // The routes for the default routing table for this VPC. The table is created with no routes, but routes may be added, + // changed, or removed with a subsequent request. + Routes []RouteReference `json:"routes" validate:"required"` + + // The subnets to which this routing table is attached. + Subnets []SubnetReference `json:"subnets" validate:"required"` +} + +// Constants associated with the DefaultRoutingTable.LifecycleState property. +// The lifecycle state of the routing table. +const ( + DefaultRoutingTableLifecycleStateDeletingConst = "deleting" + DefaultRoutingTableLifecycleStateFailedConst = "failed" + DefaultRoutingTableLifecycleStatePendingConst = "pending" + DefaultRoutingTableLifecycleStateStableConst = "stable" + DefaultRoutingTableLifecycleStateSuspendedConst = "suspended" + DefaultRoutingTableLifecycleStateUpdatingConst = "updating" + DefaultRoutingTableLifecycleStateWaitingConst = "waiting" +) + +// Constants associated with the DefaultRoutingTable.ResourceType property. +// The resource type. +const ( + DefaultRoutingTableResourceTypeRoutingTableConst = "routing_table" +) + +// UnmarshalDefaultRoutingTable unmarshals an instance of DefaultRoutingTable from the specified map of raw messages. +func UnmarshalDefaultRoutingTable(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DefaultRoutingTable) + err = core.UnmarshalModel(m, "accept_routes_from", &obj.AcceptRoutesFrom, UnmarshalResourceFilter) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "is_default", &obj.IsDefault) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "lifecycle_state", &obj.LifecycleState) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "route_direct_link_ingress", &obj.RouteDirectLinkIngress) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "route_internet_ingress", &obj.RouteInternetIngress) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "route_transit_gateway_ingress", &obj.RouteTransitGatewayIngress) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "route_vpc_zone_ingress", &obj.RouteVPCZoneIngress) + if err != nil { + return + } + err = core.UnmarshalModel(m, "routes", &obj.Routes, UnmarshalRouteReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnets", &obj.Subnets, UnmarshalSubnetReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DefaultSecurityGroup : DefaultSecurityGroup struct +type DefaultSecurityGroup struct { + // The date and time that this security group was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The security group's CRN. + CRN *string `json:"crn" validate:"required"` + + // The security group's canonical URL. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this security group. + ID *string `json:"id" validate:"required"` + + // The name for the default security group for a VPC. The name will be a hyphenated list of randomly-selected words at + // creation, but may changed. + Name *string `json:"name" validate:"required"` + + // The resource group for this security group. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The rules for the default security group for a VPC. Defaults to allowing all outbound traffic, and allowing all + // inbound traffic from other interfaces in the VPC's default security group. Rules for the default security group may + // be changed, added or removed. + Rules []SecurityGroupRuleIntf `json:"rules" validate:"required"` + + // The targets for this security group. + Targets []SecurityGroupTargetReferenceIntf `json:"targets" validate:"required"` + + // The VPC this security group resides in. + VPC *VPCReference `json:"vpc" validate:"required"` +} + +// UnmarshalDefaultSecurityGroup unmarshals an instance of DefaultSecurityGroup from the specified map of raw messages. +func UnmarshalDefaultSecurityGroup(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DefaultSecurityGroup) + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "rules", &obj.Rules, UnmarshalSecurityGroupRule) + if err != nil { + return + } + err = core.UnmarshalModel(m, "targets", &obj.Targets, UnmarshalSecurityGroupTargetReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DeleteBackupPolicyOptions : The DeleteBackupPolicy options. +type DeleteBackupPolicyOptions struct { + // The backup policy identifier. + ID *string `json:"id" validate:"required,ne="` + + // If present, the request will fail if the specified ETag value does not match the resource's current ETag value. + IfMatch *string `json:"If-Match,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteBackupPolicyOptions : Instantiate DeleteBackupPolicyOptions +func (*VpcV1) NewDeleteBackupPolicyOptions(id string) *DeleteBackupPolicyOptions { + return &DeleteBackupPolicyOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *DeleteBackupPolicyOptions) SetID(id string) *DeleteBackupPolicyOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetIfMatch : Allow user to set IfMatch +func (_options *DeleteBackupPolicyOptions) SetIfMatch(ifMatch string) *DeleteBackupPolicyOptions { + _options.IfMatch = core.StringPtr(ifMatch) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteBackupPolicyOptions) SetHeaders(param map[string]string) *DeleteBackupPolicyOptions { + options.Headers = param + return options +} + +// DeleteBackupPolicyPlanOptions : The DeleteBackupPolicyPlan options. +type DeleteBackupPolicyPlanOptions struct { + // The backup policy identifier. + BackupPolicyID *string `json:"backup_policy_id" validate:"required,ne="` + + // The backup policy plan identifier. + ID *string `json:"id" validate:"required,ne="` + + // If present, the request will fail if the specified ETag value does not match the resource's current ETag value. + IfMatch *string `json:"If-Match,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteBackupPolicyPlanOptions : Instantiate DeleteBackupPolicyPlanOptions +func (*VpcV1) NewDeleteBackupPolicyPlanOptions(backupPolicyID string, id string) *DeleteBackupPolicyPlanOptions { + return &DeleteBackupPolicyPlanOptions{ + BackupPolicyID: core.StringPtr(backupPolicyID), + ID: core.StringPtr(id), + } +} + +// SetBackupPolicyID : Allow user to set BackupPolicyID +func (_options *DeleteBackupPolicyPlanOptions) SetBackupPolicyID(backupPolicyID string) *DeleteBackupPolicyPlanOptions { + _options.BackupPolicyID = core.StringPtr(backupPolicyID) + return _options +} + +// SetID : Allow user to set ID +func (_options *DeleteBackupPolicyPlanOptions) SetID(id string) *DeleteBackupPolicyPlanOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetIfMatch : Allow user to set IfMatch +func (_options *DeleteBackupPolicyPlanOptions) SetIfMatch(ifMatch string) *DeleteBackupPolicyPlanOptions { + _options.IfMatch = core.StringPtr(ifMatch) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteBackupPolicyPlanOptions) SetHeaders(param map[string]string) *DeleteBackupPolicyPlanOptions { + options.Headers = param + return options +} + +// DeleteBareMetalServerNetworkInterfaceOptions : The DeleteBareMetalServerNetworkInterface options. +type DeleteBareMetalServerNetworkInterfaceOptions struct { + // The bare metal server identifier. + BareMetalServerID *string `json:"bare_metal_server_id" validate:"required,ne="` + + // The bare metal server network interface identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteBareMetalServerNetworkInterfaceOptions : Instantiate DeleteBareMetalServerNetworkInterfaceOptions +func (*VpcV1) NewDeleteBareMetalServerNetworkInterfaceOptions(bareMetalServerID string, id string) *DeleteBareMetalServerNetworkInterfaceOptions { + return &DeleteBareMetalServerNetworkInterfaceOptions{ + BareMetalServerID: core.StringPtr(bareMetalServerID), + ID: core.StringPtr(id), + } +} + +// SetBareMetalServerID : Allow user to set BareMetalServerID +func (_options *DeleteBareMetalServerNetworkInterfaceOptions) SetBareMetalServerID(bareMetalServerID string) *DeleteBareMetalServerNetworkInterfaceOptions { + _options.BareMetalServerID = core.StringPtr(bareMetalServerID) + return _options +} + +// SetID : Allow user to set ID +func (_options *DeleteBareMetalServerNetworkInterfaceOptions) SetID(id string) *DeleteBareMetalServerNetworkInterfaceOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteBareMetalServerNetworkInterfaceOptions) SetHeaders(param map[string]string) *DeleteBareMetalServerNetworkInterfaceOptions { + options.Headers = param + return options +} + +// DeleteBareMetalServerOptions : The DeleteBareMetalServer options. +type DeleteBareMetalServerOptions struct { + // The bare metal server identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteBareMetalServerOptions : Instantiate DeleteBareMetalServerOptions +func (*VpcV1) NewDeleteBareMetalServerOptions(id string) *DeleteBareMetalServerOptions { + return &DeleteBareMetalServerOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *DeleteBareMetalServerOptions) SetID(id string) *DeleteBareMetalServerOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteBareMetalServerOptions) SetHeaders(param map[string]string) *DeleteBareMetalServerOptions { + options.Headers = param + return options +} + +// DeleteDedicatedHostGroupOptions : The DeleteDedicatedHostGroup options. +type DeleteDedicatedHostGroupOptions struct { + // The dedicated host group identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteDedicatedHostGroupOptions : Instantiate DeleteDedicatedHostGroupOptions +func (*VpcV1) NewDeleteDedicatedHostGroupOptions(id string) *DeleteDedicatedHostGroupOptions { + return &DeleteDedicatedHostGroupOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *DeleteDedicatedHostGroupOptions) SetID(id string) *DeleteDedicatedHostGroupOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteDedicatedHostGroupOptions) SetHeaders(param map[string]string) *DeleteDedicatedHostGroupOptions { + options.Headers = param + return options +} + +// DeleteDedicatedHostOptions : The DeleteDedicatedHost options. +type DeleteDedicatedHostOptions struct { + // The dedicated host identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteDedicatedHostOptions : Instantiate DeleteDedicatedHostOptions +func (*VpcV1) NewDeleteDedicatedHostOptions(id string) *DeleteDedicatedHostOptions { + return &DeleteDedicatedHostOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *DeleteDedicatedHostOptions) SetID(id string) *DeleteDedicatedHostOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteDedicatedHostOptions) SetHeaders(param map[string]string) *DeleteDedicatedHostOptions { + options.Headers = param + return options +} + +// DeleteEndpointGatewayOptions : The DeleteEndpointGateway options. +type DeleteEndpointGatewayOptions struct { + // The endpoint gateway identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteEndpointGatewayOptions : Instantiate DeleteEndpointGatewayOptions +func (*VpcV1) NewDeleteEndpointGatewayOptions(id string) *DeleteEndpointGatewayOptions { + return &DeleteEndpointGatewayOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *DeleteEndpointGatewayOptions) SetID(id string) *DeleteEndpointGatewayOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteEndpointGatewayOptions) SetHeaders(param map[string]string) *DeleteEndpointGatewayOptions { + options.Headers = param + return options +} + +// DeleteFloatingIPOptions : The DeleteFloatingIP options. +type DeleteFloatingIPOptions struct { + // The floating IP identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteFloatingIPOptions : Instantiate DeleteFloatingIPOptions +func (*VpcV1) NewDeleteFloatingIPOptions(id string) *DeleteFloatingIPOptions { + return &DeleteFloatingIPOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *DeleteFloatingIPOptions) SetID(id string) *DeleteFloatingIPOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteFloatingIPOptions) SetHeaders(param map[string]string) *DeleteFloatingIPOptions { + options.Headers = param + return options +} + +// DeleteFlowLogCollectorOptions : The DeleteFlowLogCollector options. +type DeleteFlowLogCollectorOptions struct { + // The flow log collector identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteFlowLogCollectorOptions : Instantiate DeleteFlowLogCollectorOptions +func (*VpcV1) NewDeleteFlowLogCollectorOptions(id string) *DeleteFlowLogCollectorOptions { + return &DeleteFlowLogCollectorOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *DeleteFlowLogCollectorOptions) SetID(id string) *DeleteFlowLogCollectorOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteFlowLogCollectorOptions) SetHeaders(param map[string]string) *DeleteFlowLogCollectorOptions { + options.Headers = param + return options +} + +// DeleteIkePolicyOptions : The DeleteIkePolicy options. +type DeleteIkePolicyOptions struct { + // The IKE policy identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteIkePolicyOptions : Instantiate DeleteIkePolicyOptions +func (*VpcV1) NewDeleteIkePolicyOptions(id string) *DeleteIkePolicyOptions { + return &DeleteIkePolicyOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *DeleteIkePolicyOptions) SetID(id string) *DeleteIkePolicyOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteIkePolicyOptions) SetHeaders(param map[string]string) *DeleteIkePolicyOptions { + options.Headers = param + return options +} + +// DeleteImageExportJobOptions : The DeleteImageExportJob options. +type DeleteImageExportJobOptions struct { + // The image identifier. + ImageID *string `json:"image_id" validate:"required,ne="` + + // The image export job identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteImageExportJobOptions : Instantiate DeleteImageExportJobOptions +func (*VpcV1) NewDeleteImageExportJobOptions(imageID string, id string) *DeleteImageExportJobOptions { + return &DeleteImageExportJobOptions{ + ImageID: core.StringPtr(imageID), + ID: core.StringPtr(id), + } +} + +// SetImageID : Allow user to set ImageID +func (_options *DeleteImageExportJobOptions) SetImageID(imageID string) *DeleteImageExportJobOptions { + _options.ImageID = core.StringPtr(imageID) + return _options +} + +// SetID : Allow user to set ID +func (_options *DeleteImageExportJobOptions) SetID(id string) *DeleteImageExportJobOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteImageExportJobOptions) SetHeaders(param map[string]string) *DeleteImageExportJobOptions { + options.Headers = param + return options +} + +// DeleteImageOptions : The DeleteImage options. +type DeleteImageOptions struct { + // The image identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteImageOptions : Instantiate DeleteImageOptions +func (*VpcV1) NewDeleteImageOptions(id string) *DeleteImageOptions { + return &DeleteImageOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *DeleteImageOptions) SetID(id string) *DeleteImageOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteImageOptions) SetHeaders(param map[string]string) *DeleteImageOptions { + options.Headers = param + return options +} + +// DeleteInstanceGroupLoadBalancerOptions : The DeleteInstanceGroupLoadBalancer options. +type DeleteInstanceGroupLoadBalancerOptions struct { + // The instance group identifier. + InstanceGroupID *string `json:"instance_group_id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteInstanceGroupLoadBalancerOptions : Instantiate DeleteInstanceGroupLoadBalancerOptions +func (*VpcV1) NewDeleteInstanceGroupLoadBalancerOptions(instanceGroupID string) *DeleteInstanceGroupLoadBalancerOptions { + return &DeleteInstanceGroupLoadBalancerOptions{ + InstanceGroupID: core.StringPtr(instanceGroupID), + } +} + +// SetInstanceGroupID : Allow user to set InstanceGroupID +func (_options *DeleteInstanceGroupLoadBalancerOptions) SetInstanceGroupID(instanceGroupID string) *DeleteInstanceGroupLoadBalancerOptions { + _options.InstanceGroupID = core.StringPtr(instanceGroupID) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteInstanceGroupLoadBalancerOptions) SetHeaders(param map[string]string) *DeleteInstanceGroupLoadBalancerOptions { + options.Headers = param + return options +} + +// DeleteInstanceGroupManagerActionOptions : The DeleteInstanceGroupManagerAction options. +type DeleteInstanceGroupManagerActionOptions struct { + // The instance group identifier. + InstanceGroupID *string `json:"instance_group_id" validate:"required,ne="` + + // The instance group manager identifier. + InstanceGroupManagerID *string `json:"instance_group_manager_id" validate:"required,ne="` + + // The instance group manager action identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteInstanceGroupManagerActionOptions : Instantiate DeleteInstanceGroupManagerActionOptions +func (*VpcV1) NewDeleteInstanceGroupManagerActionOptions(instanceGroupID string, instanceGroupManagerID string, id string) *DeleteInstanceGroupManagerActionOptions { + return &DeleteInstanceGroupManagerActionOptions{ + InstanceGroupID: core.StringPtr(instanceGroupID), + InstanceGroupManagerID: core.StringPtr(instanceGroupManagerID), + ID: core.StringPtr(id), + } +} + +// SetInstanceGroupID : Allow user to set InstanceGroupID +func (_options *DeleteInstanceGroupManagerActionOptions) SetInstanceGroupID(instanceGroupID string) *DeleteInstanceGroupManagerActionOptions { + _options.InstanceGroupID = core.StringPtr(instanceGroupID) + return _options +} + +// SetInstanceGroupManagerID : Allow user to set InstanceGroupManagerID +func (_options *DeleteInstanceGroupManagerActionOptions) SetInstanceGroupManagerID(instanceGroupManagerID string) *DeleteInstanceGroupManagerActionOptions { + _options.InstanceGroupManagerID = core.StringPtr(instanceGroupManagerID) + return _options +} + +// SetID : Allow user to set ID +func (_options *DeleteInstanceGroupManagerActionOptions) SetID(id string) *DeleteInstanceGroupManagerActionOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteInstanceGroupManagerActionOptions) SetHeaders(param map[string]string) *DeleteInstanceGroupManagerActionOptions { + options.Headers = param + return options +} + +// DeleteInstanceGroupManagerOptions : The DeleteInstanceGroupManager options. +type DeleteInstanceGroupManagerOptions struct { + // The instance group identifier. + InstanceGroupID *string `json:"instance_group_id" validate:"required,ne="` + + // The instance group manager identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteInstanceGroupManagerOptions : Instantiate DeleteInstanceGroupManagerOptions +func (*VpcV1) NewDeleteInstanceGroupManagerOptions(instanceGroupID string, id string) *DeleteInstanceGroupManagerOptions { + return &DeleteInstanceGroupManagerOptions{ + InstanceGroupID: core.StringPtr(instanceGroupID), + ID: core.StringPtr(id), + } +} + +// SetInstanceGroupID : Allow user to set InstanceGroupID +func (_options *DeleteInstanceGroupManagerOptions) SetInstanceGroupID(instanceGroupID string) *DeleteInstanceGroupManagerOptions { + _options.InstanceGroupID = core.StringPtr(instanceGroupID) + return _options +} + +// SetID : Allow user to set ID +func (_options *DeleteInstanceGroupManagerOptions) SetID(id string) *DeleteInstanceGroupManagerOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteInstanceGroupManagerOptions) SetHeaders(param map[string]string) *DeleteInstanceGroupManagerOptions { + options.Headers = param + return options +} + +// DeleteInstanceGroupManagerPolicyOptions : The DeleteInstanceGroupManagerPolicy options. +type DeleteInstanceGroupManagerPolicyOptions struct { + // The instance group identifier. + InstanceGroupID *string `json:"instance_group_id" validate:"required,ne="` + + // The instance group manager identifier. + InstanceGroupManagerID *string `json:"instance_group_manager_id" validate:"required,ne="` + + // The instance group manager policy identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteInstanceGroupManagerPolicyOptions : Instantiate DeleteInstanceGroupManagerPolicyOptions +func (*VpcV1) NewDeleteInstanceGroupManagerPolicyOptions(instanceGroupID string, instanceGroupManagerID string, id string) *DeleteInstanceGroupManagerPolicyOptions { + return &DeleteInstanceGroupManagerPolicyOptions{ + InstanceGroupID: core.StringPtr(instanceGroupID), + InstanceGroupManagerID: core.StringPtr(instanceGroupManagerID), + ID: core.StringPtr(id), + } +} + +// SetInstanceGroupID : Allow user to set InstanceGroupID +func (_options *DeleteInstanceGroupManagerPolicyOptions) SetInstanceGroupID(instanceGroupID string) *DeleteInstanceGroupManagerPolicyOptions { + _options.InstanceGroupID = core.StringPtr(instanceGroupID) + return _options +} + +// SetInstanceGroupManagerID : Allow user to set InstanceGroupManagerID +func (_options *DeleteInstanceGroupManagerPolicyOptions) SetInstanceGroupManagerID(instanceGroupManagerID string) *DeleteInstanceGroupManagerPolicyOptions { + _options.InstanceGroupManagerID = core.StringPtr(instanceGroupManagerID) + return _options +} + +// SetID : Allow user to set ID +func (_options *DeleteInstanceGroupManagerPolicyOptions) SetID(id string) *DeleteInstanceGroupManagerPolicyOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteInstanceGroupManagerPolicyOptions) SetHeaders(param map[string]string) *DeleteInstanceGroupManagerPolicyOptions { + options.Headers = param + return options +} + +// DeleteInstanceGroupMembershipOptions : The DeleteInstanceGroupMembership options. +type DeleteInstanceGroupMembershipOptions struct { + // The instance group identifier. + InstanceGroupID *string `json:"instance_group_id" validate:"required,ne="` + + // The instance group membership identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteInstanceGroupMembershipOptions : Instantiate DeleteInstanceGroupMembershipOptions +func (*VpcV1) NewDeleteInstanceGroupMembershipOptions(instanceGroupID string, id string) *DeleteInstanceGroupMembershipOptions { + return &DeleteInstanceGroupMembershipOptions{ + InstanceGroupID: core.StringPtr(instanceGroupID), + ID: core.StringPtr(id), + } +} + +// SetInstanceGroupID : Allow user to set InstanceGroupID +func (_options *DeleteInstanceGroupMembershipOptions) SetInstanceGroupID(instanceGroupID string) *DeleteInstanceGroupMembershipOptions { + _options.InstanceGroupID = core.StringPtr(instanceGroupID) + return _options +} + +// SetID : Allow user to set ID +func (_options *DeleteInstanceGroupMembershipOptions) SetID(id string) *DeleteInstanceGroupMembershipOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteInstanceGroupMembershipOptions) SetHeaders(param map[string]string) *DeleteInstanceGroupMembershipOptions { + options.Headers = param + return options +} + +// DeleteInstanceGroupMembershipsOptions : The DeleteInstanceGroupMemberships options. +type DeleteInstanceGroupMembershipsOptions struct { + // The instance group identifier. + InstanceGroupID *string `json:"instance_group_id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteInstanceGroupMembershipsOptions : Instantiate DeleteInstanceGroupMembershipsOptions +func (*VpcV1) NewDeleteInstanceGroupMembershipsOptions(instanceGroupID string) *DeleteInstanceGroupMembershipsOptions { + return &DeleteInstanceGroupMembershipsOptions{ + InstanceGroupID: core.StringPtr(instanceGroupID), + } +} + +// SetInstanceGroupID : Allow user to set InstanceGroupID +func (_options *DeleteInstanceGroupMembershipsOptions) SetInstanceGroupID(instanceGroupID string) *DeleteInstanceGroupMembershipsOptions { + _options.InstanceGroupID = core.StringPtr(instanceGroupID) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteInstanceGroupMembershipsOptions) SetHeaders(param map[string]string) *DeleteInstanceGroupMembershipsOptions { + options.Headers = param + return options +} + +// DeleteInstanceGroupOptions : The DeleteInstanceGroup options. +type DeleteInstanceGroupOptions struct { + // The instance group identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteInstanceGroupOptions : Instantiate DeleteInstanceGroupOptions +func (*VpcV1) NewDeleteInstanceGroupOptions(id string) *DeleteInstanceGroupOptions { + return &DeleteInstanceGroupOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *DeleteInstanceGroupOptions) SetID(id string) *DeleteInstanceGroupOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteInstanceGroupOptions) SetHeaders(param map[string]string) *DeleteInstanceGroupOptions { + options.Headers = param + return options +} + +// DeleteInstanceNetworkInterfaceOptions : The DeleteInstanceNetworkInterface options. +type DeleteInstanceNetworkInterfaceOptions struct { + // The virtual server instance identifier. + InstanceID *string `json:"instance_id" validate:"required,ne="` + + // The instance network interface identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteInstanceNetworkInterfaceOptions : Instantiate DeleteInstanceNetworkInterfaceOptions +func (*VpcV1) NewDeleteInstanceNetworkInterfaceOptions(instanceID string, id string) *DeleteInstanceNetworkInterfaceOptions { + return &DeleteInstanceNetworkInterfaceOptions{ + InstanceID: core.StringPtr(instanceID), + ID: core.StringPtr(id), + } +} + +// SetInstanceID : Allow user to set InstanceID +func (_options *DeleteInstanceNetworkInterfaceOptions) SetInstanceID(instanceID string) *DeleteInstanceNetworkInterfaceOptions { + _options.InstanceID = core.StringPtr(instanceID) + return _options +} + +// SetID : Allow user to set ID +func (_options *DeleteInstanceNetworkInterfaceOptions) SetID(id string) *DeleteInstanceNetworkInterfaceOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteInstanceNetworkInterfaceOptions) SetHeaders(param map[string]string) *DeleteInstanceNetworkInterfaceOptions { + options.Headers = param + return options +} + +// DeleteInstanceOptions : The DeleteInstance options. +type DeleteInstanceOptions struct { + // The virtual server instance identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteInstanceOptions : Instantiate DeleteInstanceOptions +func (*VpcV1) NewDeleteInstanceOptions(id string) *DeleteInstanceOptions { + return &DeleteInstanceOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *DeleteInstanceOptions) SetID(id string) *DeleteInstanceOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteInstanceOptions) SetHeaders(param map[string]string) *DeleteInstanceOptions { + options.Headers = param + return options +} + +// DeleteInstanceTemplateOptions : The DeleteInstanceTemplate options. +type DeleteInstanceTemplateOptions struct { + // The instance template identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteInstanceTemplateOptions : Instantiate DeleteInstanceTemplateOptions +func (*VpcV1) NewDeleteInstanceTemplateOptions(id string) *DeleteInstanceTemplateOptions { + return &DeleteInstanceTemplateOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *DeleteInstanceTemplateOptions) SetID(id string) *DeleteInstanceTemplateOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteInstanceTemplateOptions) SetHeaders(param map[string]string) *DeleteInstanceTemplateOptions { + options.Headers = param + return options +} + +// DeleteInstanceVolumeAttachmentOptions : The DeleteInstanceVolumeAttachment options. +type DeleteInstanceVolumeAttachmentOptions struct { + // The virtual server instance identifier. + InstanceID *string `json:"instance_id" validate:"required,ne="` + + // The volume attachment identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteInstanceVolumeAttachmentOptions : Instantiate DeleteInstanceVolumeAttachmentOptions +func (*VpcV1) NewDeleteInstanceVolumeAttachmentOptions(instanceID string, id string) *DeleteInstanceVolumeAttachmentOptions { + return &DeleteInstanceVolumeAttachmentOptions{ + InstanceID: core.StringPtr(instanceID), + ID: core.StringPtr(id), + } +} + +// SetInstanceID : Allow user to set InstanceID +func (_options *DeleteInstanceVolumeAttachmentOptions) SetInstanceID(instanceID string) *DeleteInstanceVolumeAttachmentOptions { + _options.InstanceID = core.StringPtr(instanceID) + return _options +} + +// SetID : Allow user to set ID +func (_options *DeleteInstanceVolumeAttachmentOptions) SetID(id string) *DeleteInstanceVolumeAttachmentOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteInstanceVolumeAttachmentOptions) SetHeaders(param map[string]string) *DeleteInstanceVolumeAttachmentOptions { + options.Headers = param + return options +} + +// DeleteIpsecPolicyOptions : The DeleteIpsecPolicy options. +type DeleteIpsecPolicyOptions struct { + // The IPsec policy identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteIpsecPolicyOptions : Instantiate DeleteIpsecPolicyOptions +func (*VpcV1) NewDeleteIpsecPolicyOptions(id string) *DeleteIpsecPolicyOptions { + return &DeleteIpsecPolicyOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *DeleteIpsecPolicyOptions) SetID(id string) *DeleteIpsecPolicyOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteIpsecPolicyOptions) SetHeaders(param map[string]string) *DeleteIpsecPolicyOptions { + options.Headers = param + return options +} + +// DeleteKeyOptions : The DeleteKey options. +type DeleteKeyOptions struct { + // The key identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteKeyOptions : Instantiate DeleteKeyOptions +func (*VpcV1) NewDeleteKeyOptions(id string) *DeleteKeyOptions { + return &DeleteKeyOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *DeleteKeyOptions) SetID(id string) *DeleteKeyOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteKeyOptions) SetHeaders(param map[string]string) *DeleteKeyOptions { + options.Headers = param + return options +} + +// DeleteLoadBalancerListenerOptions : The DeleteLoadBalancerListener options. +type DeleteLoadBalancerListenerOptions struct { + // The load balancer identifier. + LoadBalancerID *string `json:"load_balancer_id" validate:"required,ne="` + + // The listener identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteLoadBalancerListenerOptions : Instantiate DeleteLoadBalancerListenerOptions +func (*VpcV1) NewDeleteLoadBalancerListenerOptions(loadBalancerID string, id string) *DeleteLoadBalancerListenerOptions { + return &DeleteLoadBalancerListenerOptions{ + LoadBalancerID: core.StringPtr(loadBalancerID), + ID: core.StringPtr(id), + } +} + +// SetLoadBalancerID : Allow user to set LoadBalancerID +func (_options *DeleteLoadBalancerListenerOptions) SetLoadBalancerID(loadBalancerID string) *DeleteLoadBalancerListenerOptions { + _options.LoadBalancerID = core.StringPtr(loadBalancerID) + return _options +} + +// SetID : Allow user to set ID +func (_options *DeleteLoadBalancerListenerOptions) SetID(id string) *DeleteLoadBalancerListenerOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteLoadBalancerListenerOptions) SetHeaders(param map[string]string) *DeleteLoadBalancerListenerOptions { + options.Headers = param + return options +} + +// DeleteLoadBalancerListenerPolicyOptions : The DeleteLoadBalancerListenerPolicy options. +type DeleteLoadBalancerListenerPolicyOptions struct { + // The load balancer identifier. + LoadBalancerID *string `json:"load_balancer_id" validate:"required,ne="` + + // The listener identifier. + ListenerID *string `json:"listener_id" validate:"required,ne="` + + // The policy identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteLoadBalancerListenerPolicyOptions : Instantiate DeleteLoadBalancerListenerPolicyOptions +func (*VpcV1) NewDeleteLoadBalancerListenerPolicyOptions(loadBalancerID string, listenerID string, id string) *DeleteLoadBalancerListenerPolicyOptions { + return &DeleteLoadBalancerListenerPolicyOptions{ + LoadBalancerID: core.StringPtr(loadBalancerID), + ListenerID: core.StringPtr(listenerID), + ID: core.StringPtr(id), + } +} + +// SetLoadBalancerID : Allow user to set LoadBalancerID +func (_options *DeleteLoadBalancerListenerPolicyOptions) SetLoadBalancerID(loadBalancerID string) *DeleteLoadBalancerListenerPolicyOptions { + _options.LoadBalancerID = core.StringPtr(loadBalancerID) + return _options +} + +// SetListenerID : Allow user to set ListenerID +func (_options *DeleteLoadBalancerListenerPolicyOptions) SetListenerID(listenerID string) *DeleteLoadBalancerListenerPolicyOptions { + _options.ListenerID = core.StringPtr(listenerID) + return _options +} + +// SetID : Allow user to set ID +func (_options *DeleteLoadBalancerListenerPolicyOptions) SetID(id string) *DeleteLoadBalancerListenerPolicyOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteLoadBalancerListenerPolicyOptions) SetHeaders(param map[string]string) *DeleteLoadBalancerListenerPolicyOptions { + options.Headers = param + return options +} + +// DeleteLoadBalancerListenerPolicyRuleOptions : The DeleteLoadBalancerListenerPolicyRule options. +type DeleteLoadBalancerListenerPolicyRuleOptions struct { + // The load balancer identifier. + LoadBalancerID *string `json:"load_balancer_id" validate:"required,ne="` + + // The listener identifier. + ListenerID *string `json:"listener_id" validate:"required,ne="` + + // The policy identifier. + PolicyID *string `json:"policy_id" validate:"required,ne="` + + // The rule identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteLoadBalancerListenerPolicyRuleOptions : Instantiate DeleteLoadBalancerListenerPolicyRuleOptions +func (*VpcV1) NewDeleteLoadBalancerListenerPolicyRuleOptions(loadBalancerID string, listenerID string, policyID string, id string) *DeleteLoadBalancerListenerPolicyRuleOptions { + return &DeleteLoadBalancerListenerPolicyRuleOptions{ + LoadBalancerID: core.StringPtr(loadBalancerID), + ListenerID: core.StringPtr(listenerID), + PolicyID: core.StringPtr(policyID), + ID: core.StringPtr(id), + } +} + +// SetLoadBalancerID : Allow user to set LoadBalancerID +func (_options *DeleteLoadBalancerListenerPolicyRuleOptions) SetLoadBalancerID(loadBalancerID string) *DeleteLoadBalancerListenerPolicyRuleOptions { + _options.LoadBalancerID = core.StringPtr(loadBalancerID) + return _options +} + +// SetListenerID : Allow user to set ListenerID +func (_options *DeleteLoadBalancerListenerPolicyRuleOptions) SetListenerID(listenerID string) *DeleteLoadBalancerListenerPolicyRuleOptions { + _options.ListenerID = core.StringPtr(listenerID) + return _options +} + +// SetPolicyID : Allow user to set PolicyID +func (_options *DeleteLoadBalancerListenerPolicyRuleOptions) SetPolicyID(policyID string) *DeleteLoadBalancerListenerPolicyRuleOptions { + _options.PolicyID = core.StringPtr(policyID) + return _options +} + +// SetID : Allow user to set ID +func (_options *DeleteLoadBalancerListenerPolicyRuleOptions) SetID(id string) *DeleteLoadBalancerListenerPolicyRuleOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteLoadBalancerListenerPolicyRuleOptions) SetHeaders(param map[string]string) *DeleteLoadBalancerListenerPolicyRuleOptions { + options.Headers = param + return options +} + +// DeleteLoadBalancerOptions : The DeleteLoadBalancer options. +type DeleteLoadBalancerOptions struct { + // The load balancer identifier. + ID *string `json:"id" validate:"required,ne="` + + // If present, the request will fail if the specified ETag value does not match the resource's current ETag value. + IfMatch *string `json:"If-Match,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteLoadBalancerOptions : Instantiate DeleteLoadBalancerOptions +func (*VpcV1) NewDeleteLoadBalancerOptions(id string) *DeleteLoadBalancerOptions { + return &DeleteLoadBalancerOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *DeleteLoadBalancerOptions) SetID(id string) *DeleteLoadBalancerOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetIfMatch : Allow user to set IfMatch +func (_options *DeleteLoadBalancerOptions) SetIfMatch(ifMatch string) *DeleteLoadBalancerOptions { + _options.IfMatch = core.StringPtr(ifMatch) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteLoadBalancerOptions) SetHeaders(param map[string]string) *DeleteLoadBalancerOptions { + options.Headers = param + return options +} + +// DeleteLoadBalancerPoolMemberOptions : The DeleteLoadBalancerPoolMember options. +type DeleteLoadBalancerPoolMemberOptions struct { + // The load balancer identifier. + LoadBalancerID *string `json:"load_balancer_id" validate:"required,ne="` + + // The pool identifier. + PoolID *string `json:"pool_id" validate:"required,ne="` + + // The member identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteLoadBalancerPoolMemberOptions : Instantiate DeleteLoadBalancerPoolMemberOptions +func (*VpcV1) NewDeleteLoadBalancerPoolMemberOptions(loadBalancerID string, poolID string, id string) *DeleteLoadBalancerPoolMemberOptions { + return &DeleteLoadBalancerPoolMemberOptions{ + LoadBalancerID: core.StringPtr(loadBalancerID), + PoolID: core.StringPtr(poolID), + ID: core.StringPtr(id), + } +} + +// SetLoadBalancerID : Allow user to set LoadBalancerID +func (_options *DeleteLoadBalancerPoolMemberOptions) SetLoadBalancerID(loadBalancerID string) *DeleteLoadBalancerPoolMemberOptions { + _options.LoadBalancerID = core.StringPtr(loadBalancerID) + return _options +} + +// SetPoolID : Allow user to set PoolID +func (_options *DeleteLoadBalancerPoolMemberOptions) SetPoolID(poolID string) *DeleteLoadBalancerPoolMemberOptions { + _options.PoolID = core.StringPtr(poolID) + return _options +} + +// SetID : Allow user to set ID +func (_options *DeleteLoadBalancerPoolMemberOptions) SetID(id string) *DeleteLoadBalancerPoolMemberOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteLoadBalancerPoolMemberOptions) SetHeaders(param map[string]string) *DeleteLoadBalancerPoolMemberOptions { + options.Headers = param + return options +} + +// DeleteLoadBalancerPoolOptions : The DeleteLoadBalancerPool options. +type DeleteLoadBalancerPoolOptions struct { + // The load balancer identifier. + LoadBalancerID *string `json:"load_balancer_id" validate:"required,ne="` + + // The pool identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteLoadBalancerPoolOptions : Instantiate DeleteLoadBalancerPoolOptions +func (*VpcV1) NewDeleteLoadBalancerPoolOptions(loadBalancerID string, id string) *DeleteLoadBalancerPoolOptions { + return &DeleteLoadBalancerPoolOptions{ + LoadBalancerID: core.StringPtr(loadBalancerID), + ID: core.StringPtr(id), + } +} + +// SetLoadBalancerID : Allow user to set LoadBalancerID +func (_options *DeleteLoadBalancerPoolOptions) SetLoadBalancerID(loadBalancerID string) *DeleteLoadBalancerPoolOptions { + _options.LoadBalancerID = core.StringPtr(loadBalancerID) + return _options +} + +// SetID : Allow user to set ID +func (_options *DeleteLoadBalancerPoolOptions) SetID(id string) *DeleteLoadBalancerPoolOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteLoadBalancerPoolOptions) SetHeaders(param map[string]string) *DeleteLoadBalancerPoolOptions { + options.Headers = param + return options +} + +// DeleteNetworkACLOptions : The DeleteNetworkACL options. +type DeleteNetworkACLOptions struct { + // The network ACL identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteNetworkACLOptions : Instantiate DeleteNetworkACLOptions +func (*VpcV1) NewDeleteNetworkACLOptions(id string) *DeleteNetworkACLOptions { + return &DeleteNetworkACLOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *DeleteNetworkACLOptions) SetID(id string) *DeleteNetworkACLOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteNetworkACLOptions) SetHeaders(param map[string]string) *DeleteNetworkACLOptions { + options.Headers = param + return options +} + +// DeleteNetworkACLRuleOptions : The DeleteNetworkACLRule options. +type DeleteNetworkACLRuleOptions struct { + // The network ACL identifier. + NetworkACLID *string `json:"network_acl_id" validate:"required,ne="` + + // The rule identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteNetworkACLRuleOptions : Instantiate DeleteNetworkACLRuleOptions +func (*VpcV1) NewDeleteNetworkACLRuleOptions(networkACLID string, id string) *DeleteNetworkACLRuleOptions { + return &DeleteNetworkACLRuleOptions{ + NetworkACLID: core.StringPtr(networkACLID), + ID: core.StringPtr(id), + } +} + +// SetNetworkACLID : Allow user to set NetworkACLID +func (_options *DeleteNetworkACLRuleOptions) SetNetworkACLID(networkACLID string) *DeleteNetworkACLRuleOptions { + _options.NetworkACLID = core.StringPtr(networkACLID) + return _options +} + +// SetID : Allow user to set ID +func (_options *DeleteNetworkACLRuleOptions) SetID(id string) *DeleteNetworkACLRuleOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteNetworkACLRuleOptions) SetHeaders(param map[string]string) *DeleteNetworkACLRuleOptions { + options.Headers = param + return options +} + +// DeletePlacementGroupOptions : The DeletePlacementGroup options. +type DeletePlacementGroupOptions struct { + // The placement group identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeletePlacementGroupOptions : Instantiate DeletePlacementGroupOptions +func (*VpcV1) NewDeletePlacementGroupOptions(id string) *DeletePlacementGroupOptions { + return &DeletePlacementGroupOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *DeletePlacementGroupOptions) SetID(id string) *DeletePlacementGroupOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeletePlacementGroupOptions) SetHeaders(param map[string]string) *DeletePlacementGroupOptions { + options.Headers = param + return options +} + +// DeletePublicGatewayOptions : The DeletePublicGateway options. +type DeletePublicGatewayOptions struct { + // The public gateway identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeletePublicGatewayOptions : Instantiate DeletePublicGatewayOptions +func (*VpcV1) NewDeletePublicGatewayOptions(id string) *DeletePublicGatewayOptions { + return &DeletePublicGatewayOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *DeletePublicGatewayOptions) SetID(id string) *DeletePublicGatewayOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeletePublicGatewayOptions) SetHeaders(param map[string]string) *DeletePublicGatewayOptions { + options.Headers = param + return options +} + +// DeleteSecurityGroupOptions : The DeleteSecurityGroup options. +type DeleteSecurityGroupOptions struct { + // The security group identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteSecurityGroupOptions : Instantiate DeleteSecurityGroupOptions +func (*VpcV1) NewDeleteSecurityGroupOptions(id string) *DeleteSecurityGroupOptions { + return &DeleteSecurityGroupOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *DeleteSecurityGroupOptions) SetID(id string) *DeleteSecurityGroupOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteSecurityGroupOptions) SetHeaders(param map[string]string) *DeleteSecurityGroupOptions { + options.Headers = param + return options +} + +// DeleteSecurityGroupRuleOptions : The DeleteSecurityGroupRule options. +type DeleteSecurityGroupRuleOptions struct { + // The security group identifier. + SecurityGroupID *string `json:"security_group_id" validate:"required,ne="` + + // The rule identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteSecurityGroupRuleOptions : Instantiate DeleteSecurityGroupRuleOptions +func (*VpcV1) NewDeleteSecurityGroupRuleOptions(securityGroupID string, id string) *DeleteSecurityGroupRuleOptions { + return &DeleteSecurityGroupRuleOptions{ + SecurityGroupID: core.StringPtr(securityGroupID), + ID: core.StringPtr(id), + } +} + +// SetSecurityGroupID : Allow user to set SecurityGroupID +func (_options *DeleteSecurityGroupRuleOptions) SetSecurityGroupID(securityGroupID string) *DeleteSecurityGroupRuleOptions { + _options.SecurityGroupID = core.StringPtr(securityGroupID) + return _options +} + +// SetID : Allow user to set ID +func (_options *DeleteSecurityGroupRuleOptions) SetID(id string) *DeleteSecurityGroupRuleOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteSecurityGroupRuleOptions) SetHeaders(param map[string]string) *DeleteSecurityGroupRuleOptions { + options.Headers = param + return options +} + +// DeleteSecurityGroupTargetBindingOptions : The DeleteSecurityGroupTargetBinding options. +type DeleteSecurityGroupTargetBindingOptions struct { + // The security group identifier. + SecurityGroupID *string `json:"security_group_id" validate:"required,ne="` + + // The security group target identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteSecurityGroupTargetBindingOptions : Instantiate DeleteSecurityGroupTargetBindingOptions +func (*VpcV1) NewDeleteSecurityGroupTargetBindingOptions(securityGroupID string, id string) *DeleteSecurityGroupTargetBindingOptions { + return &DeleteSecurityGroupTargetBindingOptions{ + SecurityGroupID: core.StringPtr(securityGroupID), + ID: core.StringPtr(id), + } +} + +// SetSecurityGroupID : Allow user to set SecurityGroupID +func (_options *DeleteSecurityGroupTargetBindingOptions) SetSecurityGroupID(securityGroupID string) *DeleteSecurityGroupTargetBindingOptions { + _options.SecurityGroupID = core.StringPtr(securityGroupID) + return _options +} + +// SetID : Allow user to set ID +func (_options *DeleteSecurityGroupTargetBindingOptions) SetID(id string) *DeleteSecurityGroupTargetBindingOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteSecurityGroupTargetBindingOptions) SetHeaders(param map[string]string) *DeleteSecurityGroupTargetBindingOptions { + options.Headers = param + return options +} + +// DeleteShareMountTargetOptions : The DeleteShareMountTarget options. +type DeleteShareMountTargetOptions struct { + // The file share identifier. + ShareID *string `json:"share_id" validate:"required,ne="` + + // The share mount target identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteShareMountTargetOptions : Instantiate DeleteShareMountTargetOptions +func (*VpcV1) NewDeleteShareMountTargetOptions(shareID string, id string) *DeleteShareMountTargetOptions { + return &DeleteShareMountTargetOptions{ + ShareID: core.StringPtr(shareID), + ID: core.StringPtr(id), + } +} + +// SetShareID : Allow user to set ShareID +func (_options *DeleteShareMountTargetOptions) SetShareID(shareID string) *DeleteShareMountTargetOptions { + _options.ShareID = core.StringPtr(shareID) + return _options +} + +// SetID : Allow user to set ID +func (_options *DeleteShareMountTargetOptions) SetID(id string) *DeleteShareMountTargetOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteShareMountTargetOptions) SetHeaders(param map[string]string) *DeleteShareMountTargetOptions { + options.Headers = param + return options +} + +// DeleteShareOptions : The DeleteShare options. +type DeleteShareOptions struct { + // The file share identifier. + ID *string `json:"id" validate:"required,ne="` + + // If present, the request will fail if the specified ETag value does not match the resource's current ETag value. + IfMatch *string `json:"If-Match,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteShareOptions : Instantiate DeleteShareOptions +func (*VpcV1) NewDeleteShareOptions(id string) *DeleteShareOptions { + return &DeleteShareOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *DeleteShareOptions) SetID(id string) *DeleteShareOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetIfMatch : Allow user to set IfMatch +func (_options *DeleteShareOptions) SetIfMatch(ifMatch string) *DeleteShareOptions { + _options.IfMatch = core.StringPtr(ifMatch) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteShareOptions) SetHeaders(param map[string]string) *DeleteShareOptions { + options.Headers = param + return options +} + +// DeleteShareSourceOptions : The DeleteShareSource options. +type DeleteShareSourceOptions struct { + // The file share identifier. + ShareID *string `json:"share_id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteShareSourceOptions : Instantiate DeleteShareSourceOptions +func (*VpcV1) NewDeleteShareSourceOptions(shareID string) *DeleteShareSourceOptions { + return &DeleteShareSourceOptions{ + ShareID: core.StringPtr(shareID), + } +} + +// SetShareID : Allow user to set ShareID +func (_options *DeleteShareSourceOptions) SetShareID(shareID string) *DeleteShareSourceOptions { + _options.ShareID = core.StringPtr(shareID) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteShareSourceOptions) SetHeaders(param map[string]string) *DeleteShareSourceOptions { + options.Headers = param + return options +} + +// DeleteSnapshotCloneOptions : The DeleteSnapshotClone options. +type DeleteSnapshotCloneOptions struct { + // The snapshot identifier. + ID *string `json:"id" validate:"required,ne="` + + // The zone name. + ZoneName *string `json:"zone_name" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteSnapshotCloneOptions : Instantiate DeleteSnapshotCloneOptions +func (*VpcV1) NewDeleteSnapshotCloneOptions(id string, zoneName string) *DeleteSnapshotCloneOptions { + return &DeleteSnapshotCloneOptions{ + ID: core.StringPtr(id), + ZoneName: core.StringPtr(zoneName), + } +} + +// SetID : Allow user to set ID +func (_options *DeleteSnapshotCloneOptions) SetID(id string) *DeleteSnapshotCloneOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetZoneName : Allow user to set ZoneName +func (_options *DeleteSnapshotCloneOptions) SetZoneName(zoneName string) *DeleteSnapshotCloneOptions { + _options.ZoneName = core.StringPtr(zoneName) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteSnapshotCloneOptions) SetHeaders(param map[string]string) *DeleteSnapshotCloneOptions { + options.Headers = param + return options +} + +// DeleteSnapshotOptions : The DeleteSnapshot options. +type DeleteSnapshotOptions struct { + // The snapshot identifier. + ID *string `json:"id" validate:"required,ne="` + + // If present, the request will fail if the specified ETag value does not match the resource's current ETag value. + IfMatch *string `json:"If-Match,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteSnapshotOptions : Instantiate DeleteSnapshotOptions +func (*VpcV1) NewDeleteSnapshotOptions(id string) *DeleteSnapshotOptions { + return &DeleteSnapshotOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *DeleteSnapshotOptions) SetID(id string) *DeleteSnapshotOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetIfMatch : Allow user to set IfMatch +func (_options *DeleteSnapshotOptions) SetIfMatch(ifMatch string) *DeleteSnapshotOptions { + _options.IfMatch = core.StringPtr(ifMatch) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteSnapshotOptions) SetHeaders(param map[string]string) *DeleteSnapshotOptions { + options.Headers = param + return options +} + +// DeleteSnapshotsOptions : The DeleteSnapshots options. +type DeleteSnapshotsOptions struct { + // Filters the collection to resources with a `source_volume.id` property matching the specified identifier. + SourceVolumeID *string `json:"source_volume.id" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteSnapshotsOptions : Instantiate DeleteSnapshotsOptions +func (*VpcV1) NewDeleteSnapshotsOptions(sourceVolumeID string) *DeleteSnapshotsOptions { + return &DeleteSnapshotsOptions{ + SourceVolumeID: core.StringPtr(sourceVolumeID), + } +} + +// SetSourceVolumeID : Allow user to set SourceVolumeID +func (_options *DeleteSnapshotsOptions) SetSourceVolumeID(sourceVolumeID string) *DeleteSnapshotsOptions { + _options.SourceVolumeID = core.StringPtr(sourceVolumeID) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteSnapshotsOptions) SetHeaders(param map[string]string) *DeleteSnapshotsOptions { + options.Headers = param + return options +} + +// DeleteSubnetOptions : The DeleteSubnet options. +type DeleteSubnetOptions struct { + // The subnet identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteSubnetOptions : Instantiate DeleteSubnetOptions +func (*VpcV1) NewDeleteSubnetOptions(id string) *DeleteSubnetOptions { + return &DeleteSubnetOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *DeleteSubnetOptions) SetID(id string) *DeleteSubnetOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteSubnetOptions) SetHeaders(param map[string]string) *DeleteSubnetOptions { + options.Headers = param + return options +} + +// DeleteSubnetReservedIPOptions : The DeleteSubnetReservedIP options. +type DeleteSubnetReservedIPOptions struct { + // The subnet identifier. + SubnetID *string `json:"subnet_id" validate:"required,ne="` + + // The reserved IP identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteSubnetReservedIPOptions : Instantiate DeleteSubnetReservedIPOptions +func (*VpcV1) NewDeleteSubnetReservedIPOptions(subnetID string, id string) *DeleteSubnetReservedIPOptions { + return &DeleteSubnetReservedIPOptions{ + SubnetID: core.StringPtr(subnetID), + ID: core.StringPtr(id), + } +} + +// SetSubnetID : Allow user to set SubnetID +func (_options *DeleteSubnetReservedIPOptions) SetSubnetID(subnetID string) *DeleteSubnetReservedIPOptions { + _options.SubnetID = core.StringPtr(subnetID) + return _options +} + +// SetID : Allow user to set ID +func (_options *DeleteSubnetReservedIPOptions) SetID(id string) *DeleteSubnetReservedIPOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteSubnetReservedIPOptions) SetHeaders(param map[string]string) *DeleteSubnetReservedIPOptions { + options.Headers = param + return options +} + +// DeleteVolumeOptions : The DeleteVolume options. +type DeleteVolumeOptions struct { + // The volume identifier. + ID *string `json:"id" validate:"required,ne="` + + // If present, the request will fail if the specified ETag value does not match the resource's current ETag value. + IfMatch *string `json:"If-Match,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteVolumeOptions : Instantiate DeleteVolumeOptions +func (*VpcV1) NewDeleteVolumeOptions(id string) *DeleteVolumeOptions { + return &DeleteVolumeOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *DeleteVolumeOptions) SetID(id string) *DeleteVolumeOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetIfMatch : Allow user to set IfMatch +func (_options *DeleteVolumeOptions) SetIfMatch(ifMatch string) *DeleteVolumeOptions { + _options.IfMatch = core.StringPtr(ifMatch) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteVolumeOptions) SetHeaders(param map[string]string) *DeleteVolumeOptions { + options.Headers = param + return options +} + +// DeleteVPCAddressPrefixOptions : The DeleteVPCAddressPrefix options. +type DeleteVPCAddressPrefixOptions struct { + // The VPC identifier. + VPCID *string `json:"vpc_id" validate:"required,ne="` + + // The prefix identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteVPCAddressPrefixOptions : Instantiate DeleteVPCAddressPrefixOptions +func (*VpcV1) NewDeleteVPCAddressPrefixOptions(vpcID string, id string) *DeleteVPCAddressPrefixOptions { + return &DeleteVPCAddressPrefixOptions{ + VPCID: core.StringPtr(vpcID), + ID: core.StringPtr(id), + } +} + +// SetVPCID : Allow user to set VPCID +func (_options *DeleteVPCAddressPrefixOptions) SetVPCID(vpcID string) *DeleteVPCAddressPrefixOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetID : Allow user to set ID +func (_options *DeleteVPCAddressPrefixOptions) SetID(id string) *DeleteVPCAddressPrefixOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteVPCAddressPrefixOptions) SetHeaders(param map[string]string) *DeleteVPCAddressPrefixOptions { + options.Headers = param + return options +} + +// DeleteVPCDnsResolutionBindingOptions : The DeleteVPCDnsResolutionBinding options. +type DeleteVPCDnsResolutionBindingOptions struct { + // The VPC identifier. + VPCID *string `json:"vpc_id" validate:"required,ne="` + + // The DNS resolution binding identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteVPCDnsResolutionBindingOptions : Instantiate DeleteVPCDnsResolutionBindingOptions +func (*VpcV1) NewDeleteVPCDnsResolutionBindingOptions(vpcID string, id string) *DeleteVPCDnsResolutionBindingOptions { + return &DeleteVPCDnsResolutionBindingOptions{ + VPCID: core.StringPtr(vpcID), + ID: core.StringPtr(id), + } +} + +// SetVPCID : Allow user to set VPCID +func (_options *DeleteVPCDnsResolutionBindingOptions) SetVPCID(vpcID string) *DeleteVPCDnsResolutionBindingOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetID : Allow user to set ID +func (_options *DeleteVPCDnsResolutionBindingOptions) SetID(id string) *DeleteVPCDnsResolutionBindingOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteVPCDnsResolutionBindingOptions) SetHeaders(param map[string]string) *DeleteVPCDnsResolutionBindingOptions { + options.Headers = param + return options +} + +// DeleteVPCOptions : The DeleteVPC options. +type DeleteVPCOptions struct { + // The VPC identifier. + ID *string `json:"id" validate:"required,ne="` + + // If present, the request will fail if the specified ETag value does not match the resource's current ETag value. + IfMatch *string `json:"If-Match,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteVPCOptions : Instantiate DeleteVPCOptions +func (*VpcV1) NewDeleteVPCOptions(id string) *DeleteVPCOptions { + return &DeleteVPCOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *DeleteVPCOptions) SetID(id string) *DeleteVPCOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetIfMatch : Allow user to set IfMatch +func (_options *DeleteVPCOptions) SetIfMatch(ifMatch string) *DeleteVPCOptions { + _options.IfMatch = core.StringPtr(ifMatch) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteVPCOptions) SetHeaders(param map[string]string) *DeleteVPCOptions { + options.Headers = param + return options +} + +// DeleteVPCRouteOptions : The DeleteVPCRoute options. +type DeleteVPCRouteOptions struct { + // The VPC identifier. + VPCID *string `json:"vpc_id" validate:"required,ne="` + + // The route identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteVPCRouteOptions : Instantiate DeleteVPCRouteOptions +func (*VpcV1) NewDeleteVPCRouteOptions(vpcID string, id string) *DeleteVPCRouteOptions { + return &DeleteVPCRouteOptions{ + VPCID: core.StringPtr(vpcID), + ID: core.StringPtr(id), + } +} + +// SetVPCID : Allow user to set VPCID +func (_options *DeleteVPCRouteOptions) SetVPCID(vpcID string) *DeleteVPCRouteOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetID : Allow user to set ID +func (_options *DeleteVPCRouteOptions) SetID(id string) *DeleteVPCRouteOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteVPCRouteOptions) SetHeaders(param map[string]string) *DeleteVPCRouteOptions { + options.Headers = param + return options +} + +// DeleteVPCRoutingTableOptions : The DeleteVPCRoutingTable options. +type DeleteVPCRoutingTableOptions struct { + // The VPC identifier. + VPCID *string `json:"vpc_id" validate:"required,ne="` + + // The routing table identifier. + ID *string `json:"id" validate:"required,ne="` + + // If present, the request will fail if the specified ETag value does not match the resource's current ETag value. + IfMatch *string `json:"If-Match,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteVPCRoutingTableOptions : Instantiate DeleteVPCRoutingTableOptions +func (*VpcV1) NewDeleteVPCRoutingTableOptions(vpcID string, id string) *DeleteVPCRoutingTableOptions { + return &DeleteVPCRoutingTableOptions{ + VPCID: core.StringPtr(vpcID), + ID: core.StringPtr(id), + } +} + +// SetVPCID : Allow user to set VPCID +func (_options *DeleteVPCRoutingTableOptions) SetVPCID(vpcID string) *DeleteVPCRoutingTableOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetID : Allow user to set ID +func (_options *DeleteVPCRoutingTableOptions) SetID(id string) *DeleteVPCRoutingTableOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetIfMatch : Allow user to set IfMatch +func (_options *DeleteVPCRoutingTableOptions) SetIfMatch(ifMatch string) *DeleteVPCRoutingTableOptions { + _options.IfMatch = core.StringPtr(ifMatch) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteVPCRoutingTableOptions) SetHeaders(param map[string]string) *DeleteVPCRoutingTableOptions { + options.Headers = param + return options +} + +// DeleteVPCRoutingTableRouteOptions : The DeleteVPCRoutingTableRoute options. +type DeleteVPCRoutingTableRouteOptions struct { + // The VPC identifier. + VPCID *string `json:"vpc_id" validate:"required,ne="` + + // The routing table identifier. + RoutingTableID *string `json:"routing_table_id" validate:"required,ne="` + + // The VPC routing table route identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteVPCRoutingTableRouteOptions : Instantiate DeleteVPCRoutingTableRouteOptions +func (*VpcV1) NewDeleteVPCRoutingTableRouteOptions(vpcID string, routingTableID string, id string) *DeleteVPCRoutingTableRouteOptions { + return &DeleteVPCRoutingTableRouteOptions{ + VPCID: core.StringPtr(vpcID), + RoutingTableID: core.StringPtr(routingTableID), + ID: core.StringPtr(id), + } +} + +// SetVPCID : Allow user to set VPCID +func (_options *DeleteVPCRoutingTableRouteOptions) SetVPCID(vpcID string) *DeleteVPCRoutingTableRouteOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetRoutingTableID : Allow user to set RoutingTableID +func (_options *DeleteVPCRoutingTableRouteOptions) SetRoutingTableID(routingTableID string) *DeleteVPCRoutingTableRouteOptions { + _options.RoutingTableID = core.StringPtr(routingTableID) + return _options +} + +// SetID : Allow user to set ID +func (_options *DeleteVPCRoutingTableRouteOptions) SetID(id string) *DeleteVPCRoutingTableRouteOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteVPCRoutingTableRouteOptions) SetHeaders(param map[string]string) *DeleteVPCRoutingTableRouteOptions { + options.Headers = param + return options +} + +// DeleteVPNGatewayConnectionOptions : The DeleteVPNGatewayConnection options. +type DeleteVPNGatewayConnectionOptions struct { + // The VPN gateway identifier. + VPNGatewayID *string `json:"vpn_gateway_id" validate:"required,ne="` + + // The VPN gateway connection identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteVPNGatewayConnectionOptions : Instantiate DeleteVPNGatewayConnectionOptions +func (*VpcV1) NewDeleteVPNGatewayConnectionOptions(vpnGatewayID string, id string) *DeleteVPNGatewayConnectionOptions { + return &DeleteVPNGatewayConnectionOptions{ + VPNGatewayID: core.StringPtr(vpnGatewayID), + ID: core.StringPtr(id), + } +} + +// SetVPNGatewayID : Allow user to set VPNGatewayID +func (_options *DeleteVPNGatewayConnectionOptions) SetVPNGatewayID(vpnGatewayID string) *DeleteVPNGatewayConnectionOptions { + _options.VPNGatewayID = core.StringPtr(vpnGatewayID) + return _options +} + +// SetID : Allow user to set ID +func (_options *DeleteVPNGatewayConnectionOptions) SetID(id string) *DeleteVPNGatewayConnectionOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteVPNGatewayConnectionOptions) SetHeaders(param map[string]string) *DeleteVPNGatewayConnectionOptions { + options.Headers = param + return options +} + +// DeleteVPNGatewayOptions : The DeleteVPNGateway options. +type DeleteVPNGatewayOptions struct { + // The VPN gateway identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteVPNGatewayOptions : Instantiate DeleteVPNGatewayOptions +func (*VpcV1) NewDeleteVPNGatewayOptions(id string) *DeleteVPNGatewayOptions { + return &DeleteVPNGatewayOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *DeleteVPNGatewayOptions) SetID(id string) *DeleteVPNGatewayOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteVPNGatewayOptions) SetHeaders(param map[string]string) *DeleteVPNGatewayOptions { + options.Headers = param + return options +} + +// DeleteVPNServerClientOptions : The DeleteVPNServerClient options. +type DeleteVPNServerClientOptions struct { + // The VPN server identifier. + VPNServerID *string `json:"vpn_server_id" validate:"required,ne="` + + // The VPN client identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteVPNServerClientOptions : Instantiate DeleteVPNServerClientOptions +func (*VpcV1) NewDeleteVPNServerClientOptions(vpnServerID string, id string) *DeleteVPNServerClientOptions { + return &DeleteVPNServerClientOptions{ + VPNServerID: core.StringPtr(vpnServerID), + ID: core.StringPtr(id), + } +} + +// SetVPNServerID : Allow user to set VPNServerID +func (_options *DeleteVPNServerClientOptions) SetVPNServerID(vpnServerID string) *DeleteVPNServerClientOptions { + _options.VPNServerID = core.StringPtr(vpnServerID) + return _options +} + +// SetID : Allow user to set ID +func (_options *DeleteVPNServerClientOptions) SetID(id string) *DeleteVPNServerClientOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteVPNServerClientOptions) SetHeaders(param map[string]string) *DeleteVPNServerClientOptions { + options.Headers = param + return options +} + +// DeleteVPNServerOptions : The DeleteVPNServer options. +type DeleteVPNServerOptions struct { + // The VPN server identifier. + ID *string `json:"id" validate:"required,ne="` + + // If present, the request will fail if the specified ETag value does not match the resource's current ETag value. + IfMatch *string `json:"If-Match,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteVPNServerOptions : Instantiate DeleteVPNServerOptions +func (*VpcV1) NewDeleteVPNServerOptions(id string) *DeleteVPNServerOptions { + return &DeleteVPNServerOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *DeleteVPNServerOptions) SetID(id string) *DeleteVPNServerOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetIfMatch : Allow user to set IfMatch +func (_options *DeleteVPNServerOptions) SetIfMatch(ifMatch string) *DeleteVPNServerOptions { + _options.IfMatch = core.StringPtr(ifMatch) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteVPNServerOptions) SetHeaders(param map[string]string) *DeleteVPNServerOptions { + options.Headers = param + return options +} + +// DeleteVPNServerRouteOptions : The DeleteVPNServerRoute options. +type DeleteVPNServerRouteOptions struct { + // The VPN server identifier. + VPNServerID *string `json:"vpn_server_id" validate:"required,ne="` + + // The VPN route identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeleteVPNServerRouteOptions : Instantiate DeleteVPNServerRouteOptions +func (*VpcV1) NewDeleteVPNServerRouteOptions(vpnServerID string, id string) *DeleteVPNServerRouteOptions { + return &DeleteVPNServerRouteOptions{ + VPNServerID: core.StringPtr(vpnServerID), + ID: core.StringPtr(id), + } +} + +// SetVPNServerID : Allow user to set VPNServerID +func (_options *DeleteVPNServerRouteOptions) SetVPNServerID(vpnServerID string) *DeleteVPNServerRouteOptions { + _options.VPNServerID = core.StringPtr(vpnServerID) + return _options +} + +// SetID : Allow user to set ID +func (_options *DeleteVPNServerRouteOptions) SetID(id string) *DeleteVPNServerRouteOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeleteVPNServerRouteOptions) SetHeaders(param map[string]string) *DeleteVPNServerRouteOptions { + options.Headers = param + return options +} + +// DeprecateImageOptions : The DeprecateImage options. +type DeprecateImageOptions struct { + // The image identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDeprecateImageOptions : Instantiate DeprecateImageOptions +func (*VpcV1) NewDeprecateImageOptions(id string) *DeprecateImageOptions { + return &DeprecateImageOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *DeprecateImageOptions) SetID(id string) *DeprecateImageOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DeprecateImageOptions) SetHeaders(param map[string]string) *DeprecateImageOptions { + options.Headers = param + return options +} + +// DisconnectVPNClientOptions : The DisconnectVPNClient options. +type DisconnectVPNClientOptions struct { + // The VPN server identifier. + VPNServerID *string `json:"vpn_server_id" validate:"required,ne="` + + // The VPN client identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewDisconnectVPNClientOptions : Instantiate DisconnectVPNClientOptions +func (*VpcV1) NewDisconnectVPNClientOptions(vpnServerID string, id string) *DisconnectVPNClientOptions { + return &DisconnectVPNClientOptions{ + VPNServerID: core.StringPtr(vpnServerID), + ID: core.StringPtr(id), + } +} + +// SetVPNServerID : Allow user to set VPNServerID +func (_options *DisconnectVPNClientOptions) SetVPNServerID(vpnServerID string) *DisconnectVPNClientOptions { + _options.VPNServerID = core.StringPtr(vpnServerID) + return _options +} + +// SetID : Allow user to set ID +func (_options *DisconnectVPNClientOptions) SetID(id string) *DisconnectVPNClientOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *DisconnectVPNClientOptions) SetHeaders(param map[string]string) *DisconnectVPNClientOptions { + options.Headers = param + return options +} + +// EncryptionKeyIdentity : Identifies an encryption key by a unique property. +// Models which "extend" this model: +// - EncryptionKeyIdentityByCRN +type EncryptionKeyIdentity struct { + // The CRN of the [Key Protect Root + // Key](https://cloud.ibm.com/docs/key-protect?topic=key-protect-getting-started-tutorial) or [Hyper Protect Crypto + // Services Root Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started) for this resource. + CRN *string `json:"crn,omitempty"` +} + +func (*EncryptionKeyIdentity) isaEncryptionKeyIdentity() bool { + return true +} + +type EncryptionKeyIdentityIntf interface { + isaEncryptionKeyIdentity() bool +} + +// UnmarshalEncryptionKeyIdentity unmarshals an instance of EncryptionKeyIdentity from the specified map of raw messages. +func UnmarshalEncryptionKeyIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(EncryptionKeyIdentity) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// EncryptionKeyReference : EncryptionKeyReference struct +type EncryptionKeyReference struct { + // The CRN of the [Key Protect Root + // Key](https://cloud.ibm.com/docs/key-protect?topic=key-protect-getting-started-tutorial) or [Hyper Protect Crypto + // Services Root Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started) for this resource. + CRN *string `json:"crn" validate:"required"` +} + +// UnmarshalEncryptionKeyReference unmarshals an instance of EncryptionKeyReference from the specified map of raw messages. +func UnmarshalEncryptionKeyReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(EncryptionKeyReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// EndpointGateway : EndpointGateway struct +type EndpointGateway struct { + // Indicates whether to allow DNS resolution for this endpoint gateway when the VPC this endpoint gateway resides in + // has a DNS resolution binding to a VPC with `dns.enable_hub` set to `true`. + AllowDnsResolutionBinding *bool `json:"allow_dns_resolution_binding" validate:"required"` + + // The date and time that the endpoint gateway was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The CRN for this endpoint gateway. + CRN *string `json:"crn" validate:"required"` + + // The health of this resource. + // - `ok`: No abnormal behavior detected + // - `degraded`: Experiencing compromised performance, capacity, or connectivity + // - `faulted`: Completely unreachable, inoperative, or otherwise entirely incapacitated + // - `inapplicable`: The health state does not apply because of the current lifecycle state. A resource with a + // lifecycle state of `failed` or `deleting` will have a health state of `inapplicable`. A `pending` resource may also + // have this state. + HealthState *string `json:"health_state" validate:"required"` + + // The URL for this endpoint gateway. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this endpoint gateway. + ID *string `json:"id" validate:"required"` + + // The reserved IPs bound to this endpoint gateway. + Ips []ReservedIPReference `json:"ips" validate:"required"` + + // The lifecycle state of the endpoint gateway. + LifecycleState *string `json:"lifecycle_state" validate:"required"` + + // The name for this endpoint gateway. The name is unique across all endpoint gateways in the VPC. + Name *string `json:"name" validate:"required"` + + // The resource group for this endpoint gateway. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The security groups targeting this endpoint gateway. + SecurityGroups []SecurityGroupReference `json:"security_groups" validate:"required"` + + // The fully qualified domain name for the target service. + // Deprecated: this field is deprecated and may be removed in a future release. + ServiceEndpoint *string `json:"service_endpoint,omitempty"` + + // The fully qualified domain names for the target service. + ServiceEndpoints []string `json:"service_endpoints" validate:"required"` + + // The target for this endpoint gateway. + Target EndpointGatewayTargetIntf `json:"target" validate:"required"` + + // The VPC this endpoint gateway resides in. + VPC *VPCReference `json:"vpc" validate:"required"` +} + +// Constants associated with the EndpointGateway.HealthState property. +// The health of this resource. +// - `ok`: No abnormal behavior detected +// - `degraded`: Experiencing compromised performance, capacity, or connectivity +// - `faulted`: Completely unreachable, inoperative, or otherwise entirely incapacitated +// - `inapplicable`: The health state does not apply because of the current lifecycle state. A resource with a lifecycle +// state of `failed` or `deleting` will have a health state of `inapplicable`. A `pending` resource may also have this +// state. +const ( + EndpointGatewayHealthStateDegradedConst = "degraded" + EndpointGatewayHealthStateFaultedConst = "faulted" + EndpointGatewayHealthStateInapplicableConst = "inapplicable" + EndpointGatewayHealthStateOkConst = "ok" +) + +// Constants associated with the EndpointGateway.LifecycleState property. +// The lifecycle state of the endpoint gateway. +const ( + EndpointGatewayLifecycleStateDeletingConst = "deleting" + EndpointGatewayLifecycleStateFailedConst = "failed" + EndpointGatewayLifecycleStatePendingConst = "pending" + EndpointGatewayLifecycleStateStableConst = "stable" + EndpointGatewayLifecycleStateSuspendedConst = "suspended" + EndpointGatewayLifecycleStateUpdatingConst = "updating" + EndpointGatewayLifecycleStateWaitingConst = "waiting" +) + +// Constants associated with the EndpointGateway.ResourceType property. +// The resource type. +const ( + EndpointGatewayResourceTypeEndpointGatewayConst = "endpoint_gateway" +) + +// UnmarshalEndpointGateway unmarshals an instance of EndpointGateway from the specified map of raw messages. +func UnmarshalEndpointGateway(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(EndpointGateway) + err = core.UnmarshalPrimitive(m, "allow_dns_resolution_binding", &obj.AllowDnsResolutionBinding) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "health_state", &obj.HealthState) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalModel(m, "ips", &obj.Ips, UnmarshalReservedIPReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "lifecycle_state", &obj.LifecycleState) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalModel(m, "security_groups", &obj.SecurityGroups, UnmarshalSecurityGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "service_endpoint", &obj.ServiceEndpoint) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "service_endpoints", &obj.ServiceEndpoints) + if err != nil { + return + } + err = core.UnmarshalModel(m, "target", &obj.Target, UnmarshalEndpointGatewayTarget) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// EndpointGatewayCollection : EndpointGatewayCollection struct +type EndpointGatewayCollection struct { + // Collection of endpoint gateways. + EndpointGateways []EndpointGateway `json:"endpoint_gateways" validate:"required"` + + // A link to the first page of resources. + First *EndpointGatewayCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *EndpointGatewayCollectionNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalEndpointGatewayCollection unmarshals an instance of EndpointGatewayCollection from the specified map of raw messages. +func UnmarshalEndpointGatewayCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(EndpointGatewayCollection) + err = core.UnmarshalModel(m, "endpoint_gateways", &obj.EndpointGateways, UnmarshalEndpointGateway) + if err != nil { + return + } + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalEndpointGatewayCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalEndpointGatewayCollectionNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *EndpointGatewayCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// EndpointGatewayCollectionFirst : A link to the first page of resources. +type EndpointGatewayCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalEndpointGatewayCollectionFirst unmarshals an instance of EndpointGatewayCollectionFirst from the specified map of raw messages. +func UnmarshalEndpointGatewayCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(EndpointGatewayCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// EndpointGatewayCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type EndpointGatewayCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalEndpointGatewayCollectionNext unmarshals an instance of EndpointGatewayCollectionNext from the specified map of raw messages. +func UnmarshalEndpointGatewayCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(EndpointGatewayCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// EndpointGatewayPatch : EndpointGatewayPatch struct +type EndpointGatewayPatch struct { + // Indicates whether to allow DNS resolution for this endpoint gateway when the VPC this endpoint gateway resides in + // has a DNS resolution binding to a VPC with `dns.enable_hub` set to `true`. + // + // Must be `true` if the VPC this endpoint gateway resides in has `dns.enable_hub` set to + // `true`. + AllowDnsResolutionBinding *bool `json:"allow_dns_resolution_binding,omitempty"` + + // The name for this endpoint gateway. The name must not be used by another endpoint gateway in the VPC. + Name *string `json:"name,omitempty"` +} + +// UnmarshalEndpointGatewayPatch unmarshals an instance of EndpointGatewayPatch from the specified map of raw messages. +func UnmarshalEndpointGatewayPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(EndpointGatewayPatch) + err = core.UnmarshalPrimitive(m, "allow_dns_resolution_binding", &obj.AllowDnsResolutionBinding) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the EndpointGatewayPatch +func (endpointGatewayPatch *EndpointGatewayPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(endpointGatewayPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// EndpointGatewayReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type EndpointGatewayReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalEndpointGatewayReferenceDeleted unmarshals an instance of EndpointGatewayReferenceDeleted from the specified map of raw messages. +func UnmarshalEndpointGatewayReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(EndpointGatewayReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// EndpointGatewayReferenceRemote : EndpointGatewayReferenceRemote struct +type EndpointGatewayReferenceRemote struct { + // The CRN for this endpoint gateway. + CRN *string `json:"crn" validate:"required"` + + // The URL for this endpoint gateway. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this endpoint gateway. + ID *string `json:"id" validate:"required"` + + // The name for this endpoint gateway. The name is unique across all endpoint gateways in the VPC. + Name *string `json:"name" validate:"required"` + + // If present, this property indicates that the resource associated with this reference + // is remote and therefore may not be directly retrievable. + Remote *EndpointGatewayRemote `json:"remote,omitempty"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the EndpointGatewayReferenceRemote.ResourceType property. +// The resource type. +const ( + EndpointGatewayReferenceRemoteResourceTypeEndpointGatewayConst = "endpoint_gateway" +) + +// UnmarshalEndpointGatewayReferenceRemote unmarshals an instance of EndpointGatewayReferenceRemote from the specified map of raw messages. +func UnmarshalEndpointGatewayReferenceRemote(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(EndpointGatewayReferenceRemote) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "remote", &obj.Remote, UnmarshalEndpointGatewayRemote) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// EndpointGatewayRemote : If present, this property indicates that the resource associated with this reference is remote and therefore may not +// be directly retrievable. +type EndpointGatewayRemote struct { + // If present, this property indicates that the referenced resource is remote to this + // account, and identifies the owning account. + Account *AccountReference `json:"account,omitempty"` + + // If present, this property indicates that the referenced resource is remote to this + // region, and identifies the native region. + Region *RegionReference `json:"region,omitempty"` +} + +// UnmarshalEndpointGatewayRemote unmarshals an instance of EndpointGatewayRemote from the specified map of raw messages. +func UnmarshalEndpointGatewayRemote(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(EndpointGatewayRemote) + err = core.UnmarshalModel(m, "account", &obj.Account, UnmarshalAccountReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "region", &obj.Region, UnmarshalRegionReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// EndpointGatewayReservedIP : A reserved IP to bind to the endpoint gateway. This can be specified using an existing reserved IP, or a prototype +// object for a new reserved IP. The reserved IP will be bound to the endpoint gateway to function as a virtual private +// endpoint for the service. +// Models which "extend" this model: +// - EndpointGatewayReservedIPReservedIPIdentity +// - EndpointGatewayReservedIPReservedIPPrototypeTargetContext +type EndpointGatewayReservedIP struct { + // The unique identifier for this reserved IP. + ID *string `json:"id,omitempty"` + + // The URL for this reserved IP. + Href *string `json:"href,omitempty"` + + // The IP address to reserve, which must not already be reserved on the subnet. + // + // If unspecified, an available address on the subnet will automatically be selected. + Address *string `json:"address,omitempty"` + + // Indicates whether this reserved IP member will be automatically deleted when either + // `target` is deleted, or the reserved IP is unbound. + AutoDelete *bool `json:"auto_delete,omitempty"` + + // The name for this reserved IP. The name must not be used by another reserved IP in the subnet. Names starting with + // `ibm-` are reserved for provider-owned resources, and are not allowed. If unspecified, the name will be a hyphenated + // list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The subnet in which to create this reserved IP. + Subnet SubnetIdentityIntf `json:"subnet,omitempty"` +} + +func (*EndpointGatewayReservedIP) isaEndpointGatewayReservedIP() bool { + return true +} + +type EndpointGatewayReservedIPIntf interface { + isaEndpointGatewayReservedIP() bool +} + +// UnmarshalEndpointGatewayReservedIP unmarshals an instance of EndpointGatewayReservedIP from the specified map of raw messages. +func UnmarshalEndpointGatewayReservedIP(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(EndpointGatewayReservedIP) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "auto_delete", &obj.AutoDelete) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnet", &obj.Subnet, UnmarshalSubnetIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// EndpointGatewayTarget : The target for this endpoint gateway. +// Models which "extend" this model: +// - EndpointGatewayTargetProviderCloudServiceReference +// - EndpointGatewayTargetProviderInfrastructureServiceReference +type EndpointGatewayTarget struct { + // The CRN for this provider cloud service, or the CRN for the user's instance of a provider cloud service. + CRN *string `json:"crn,omitempty"` + + // The type of target. + ResourceType *string `json:"resource_type,omitempty"` + + // The name of a provider infrastructure service. Must be: + // - `ibm-ntp-server`: An NTP (Network Time Protocol) server provided by IBM. + Name *string `json:"name,omitempty"` +} + +// Constants associated with the EndpointGatewayTarget.ResourceType property. +// The type of target. +const ( + EndpointGatewayTargetResourceTypeProviderCloudServiceConst = "provider_cloud_service" +) + +func (*EndpointGatewayTarget) isaEndpointGatewayTarget() bool { + return true +} + +type EndpointGatewayTargetIntf interface { + isaEndpointGatewayTarget() bool +} + +// UnmarshalEndpointGatewayTarget unmarshals an instance of EndpointGatewayTarget from the specified map of raw messages. +func UnmarshalEndpointGatewayTarget(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(EndpointGatewayTarget) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// EndpointGatewayTargetPrototype : The target to use for this endpoint gateway. Must not already be the target of another endpoint gateway in the VPC. +// Models which "extend" this model: +// - EndpointGatewayTargetPrototypeProviderCloudServiceIdentity +// - EndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentity +type EndpointGatewayTargetPrototype struct { + // The type of target for this endpoint gateway. + ResourceType *string `json:"resource_type" validate:"required"` + + // The CRN for this provider cloud service, or the CRN for the user's instance of a provider cloud service. + CRN *string `json:"crn,omitempty"` + + // The name of a provider infrastructure service. Must be: + // - `ibm-ntp-server`: An NTP (Network Time Protocol) server provided by IBM. + Name *string `json:"name,omitempty"` +} + +// Constants associated with the EndpointGatewayTargetPrototype.ResourceType property. +// The type of target for this endpoint gateway. +const ( + EndpointGatewayTargetPrototypeResourceTypeProviderCloudServiceConst = "provider_cloud_service" + EndpointGatewayTargetPrototypeResourceTypeProviderInfrastructureServiceConst = "provider_infrastructure_service" +) + +func (*EndpointGatewayTargetPrototype) isaEndpointGatewayTargetPrototype() bool { + return true +} + +type EndpointGatewayTargetPrototypeIntf interface { + isaEndpointGatewayTargetPrototype() bool +} + +// UnmarshalEndpointGatewayTargetPrototype unmarshals an instance of EndpointGatewayTargetPrototype from the specified map of raw messages. +func UnmarshalEndpointGatewayTargetPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + // Retrieve discriminator value to determine correct "subclass". + var discValue string + err = core.UnmarshalPrimitive(m, "resource_type", &discValue) + if err != nil { + err = fmt.Errorf("error unmarshalling discriminator property 'resource_type': %s", err.Error()) + return + } + if discValue == "" { + err = fmt.Errorf("required discriminator property 'resource_type' not found in JSON object") + return + } + if discValue == "provider_cloud_service" { + err = core.UnmarshalModel(m, "", result, UnmarshalEndpointGatewayTargetPrototypeProviderCloudServiceIdentity) + } else if discValue == "provider_infrastructure_service" { + err = core.UnmarshalModel(m, "", result, UnmarshalEndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentity) + } else { + err = fmt.Errorf("unrecognized value for discriminator property 'resource_type': %s", discValue) + } + return +} + +// FailoverShareOptions : The FailoverShare options. +type FailoverShareOptions struct { + // The file share identifier. + ShareID *string `json:"share_id" validate:"required,ne="` + + // The action to take if the failover request is accepted but cannot be performed or times out: + // - `fail`: Fail the operation, resulting in the replication relationship being unchanged. + // - `split`: Split the replica from its source, resulting in two individual read-write + // file shares. Because the final sync was not completed, the replica may be + // out-of-date. This is useful in disaster recovery scenarios where the source is known + // to be unreachable. + FallbackPolicy *string `json:"fallback_policy,omitempty"` + + // The failover timeout in seconds. + // + // If the timeout is reached, the `fallback_policy` will be triggered. + Timeout *int64 `json:"timeout,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the FailoverShareOptions.FallbackPolicy property. +// The action to take if the failover request is accepted but cannot be performed or times out: +// - `fail`: Fail the operation, resulting in the replication relationship being unchanged. +// - `split`: Split the replica from its source, resulting in two individual read-write +// file shares. Because the final sync was not completed, the replica may be +// out-of-date. This is useful in disaster recovery scenarios where the source is known +// to be unreachable. +const ( + FailoverShareOptionsFallbackPolicyFailConst = "fail" + FailoverShareOptionsFallbackPolicySplitConst = "split" +) + +// NewFailoverShareOptions : Instantiate FailoverShareOptions +func (*VpcV1) NewFailoverShareOptions(shareID string) *FailoverShareOptions { + return &FailoverShareOptions{ + ShareID: core.StringPtr(shareID), + } +} + +// SetShareID : Allow user to set ShareID +func (_options *FailoverShareOptions) SetShareID(shareID string) *FailoverShareOptions { + _options.ShareID = core.StringPtr(shareID) + return _options +} + +// SetFallbackPolicy : Allow user to set FallbackPolicy +func (_options *FailoverShareOptions) SetFallbackPolicy(fallbackPolicy string) *FailoverShareOptions { + _options.FallbackPolicy = core.StringPtr(fallbackPolicy) + return _options +} + +// SetTimeout : Allow user to set Timeout +func (_options *FailoverShareOptions) SetTimeout(timeout int64) *FailoverShareOptions { + _options.Timeout = core.Int64Ptr(timeout) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *FailoverShareOptions) SetHeaders(param map[string]string) *FailoverShareOptions { + options.Headers = param + return options +} + +// FloatingIP : FloatingIP struct +type FloatingIP struct { + // The globally unique IP address. + Address *string `json:"address" validate:"required"` + + // The date and time that the floating IP was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The CRN for this floating IP. + CRN *string `json:"crn" validate:"required"` + + // The URL for this floating IP. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this floating IP. + ID *string `json:"id" validate:"required"` + + // The name for this floating IP. The name is unique across all floating IPs in the region. + Name *string `json:"name" validate:"required"` + + // The resource group for this floating IP. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The status of the floating IP. + Status *string `json:"status" validate:"required"` + + // The target of this floating IP. + Target FloatingIPTargetIntf `json:"target,omitempty"` + + // The zone this floating IP resides in. + Zone *ZoneReference `json:"zone" validate:"required"` +} + +// Constants associated with the FloatingIP.Status property. +// The status of the floating IP. +const ( + FloatingIPStatusAvailableConst = "available" + FloatingIPStatusDeletingConst = "deleting" + FloatingIPStatusFailedConst = "failed" + FloatingIPStatusPendingConst = "pending" +) + +// UnmarshalFloatingIP unmarshals an instance of FloatingIP from the specified map of raw messages. +func UnmarshalFloatingIP(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FloatingIP) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + err = core.UnmarshalModel(m, "target", &obj.Target, UnmarshalFloatingIPTarget) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FloatingIPCollection : FloatingIPCollection struct +type FloatingIPCollection struct { + // A link to the first page of resources. + First *FloatingIPCollectionFirst `json:"first" validate:"required"` + + // Collection of floating IPs. + FloatingIps []FloatingIP `json:"floating_ips" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *FloatingIPCollectionNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalFloatingIPCollection unmarshals an instance of FloatingIPCollection from the specified map of raw messages. +func UnmarshalFloatingIPCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FloatingIPCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalFloatingIPCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalModel(m, "floating_ips", &obj.FloatingIps, UnmarshalFloatingIP) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalFloatingIPCollectionNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *FloatingIPCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// FloatingIPCollectionFirst : A link to the first page of resources. +type FloatingIPCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalFloatingIPCollectionFirst unmarshals an instance of FloatingIPCollectionFirst from the specified map of raw messages. +func UnmarshalFloatingIPCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FloatingIPCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FloatingIPCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type FloatingIPCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalFloatingIPCollectionNext unmarshals an instance of FloatingIPCollectionNext from the specified map of raw messages. +func UnmarshalFloatingIPCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FloatingIPCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FloatingIPPatch : FloatingIPPatch struct +type FloatingIPPatch struct { + // The name for this floating IP. The name must not be used by another floating IP in the region. + Name *string `json:"name,omitempty"` + + // The target resource to bind this floating IP to, replacing any existing binding. + // The floating IP must not be required by another resource, such as a public gateway. + // + // The target resource must not already have a floating IP bound to it if the target + // resource is: + // + // - an instance network interface + // - a bare metal server network interface with `enable_infrastructure_nat` set to `true`. + Target FloatingIPTargetPatchIntf `json:"target,omitempty"` +} + +// UnmarshalFloatingIPPatch unmarshals an instance of FloatingIPPatch from the specified map of raw messages. +func UnmarshalFloatingIPPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FloatingIPPatch) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "target", &obj.Target, UnmarshalFloatingIPTargetPatch) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the FloatingIPPatch +func (floatingIPPatch *FloatingIPPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(floatingIPPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// FloatingIPPrototype : FloatingIPPrototype struct +// Models which "extend" this model: +// - FloatingIPPrototypeFloatingIPByZone +// - FloatingIPPrototypeFloatingIPByTarget +type FloatingIPPrototype struct { + // The name for this floating IP. The name must not be used by another floating IP in the region. If unspecified, the + // name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The zone this floating IP will reside in. + Zone ZoneIdentityIntf `json:"zone,omitempty"` + + // The target resource to bind this floating IP to. + // + // The target resource must not already have a floating IP bound to it if the target + // resource is: + // + // - an instance network interface + // - a bare metal server network interface with `enable_infrastructure_nat` set to `true`. + Target FloatingIPTargetPrototypeIntf `json:"target,omitempty"` +} + +func (*FloatingIPPrototype) isaFloatingIPPrototype() bool { + return true +} + +type FloatingIPPrototypeIntf interface { + isaFloatingIPPrototype() bool +} + +// UnmarshalFloatingIPPrototype unmarshals an instance of FloatingIPPrototype from the specified map of raw messages. +func UnmarshalFloatingIPPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FloatingIPPrototype) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "target", &obj.Target, UnmarshalFloatingIPTargetPrototype) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FloatingIPReference : FloatingIPReference struct +type FloatingIPReference struct { + // The globally unique IP address. + Address *string `json:"address" validate:"required"` + + // The CRN for this floating IP. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *FloatingIPReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this floating IP. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this floating IP. + ID *string `json:"id" validate:"required"` + + // The name for this floating IP. The name is unique across all floating IPs in the region. + Name *string `json:"name" validate:"required"` +} + +// UnmarshalFloatingIPReference unmarshals an instance of FloatingIPReference from the specified map of raw messages. +func UnmarshalFloatingIPReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FloatingIPReference) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalFloatingIPReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FloatingIPReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type FloatingIPReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalFloatingIPReferenceDeleted unmarshals an instance of FloatingIPReferenceDeleted from the specified map of raw messages. +func UnmarshalFloatingIPReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FloatingIPReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FloatingIPTarget : The target of this floating IP. +// Models which "extend" this model: +// - FloatingIPTargetNetworkInterfaceReference +// - FloatingIPTargetBareMetalServerNetworkInterfaceReference +// - FloatingIPTargetPublicGatewayReference +type FloatingIPTarget struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *NetworkInterfaceReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this instance network interface. + Href *string `json:"href,omitempty"` + + // The unique identifier for this instance network interface. + ID *string `json:"id,omitempty"` + + // The name for this instance network interface. + Name *string `json:"name,omitempty"` + + PrimaryIP *ReservedIPReference `json:"primary_ip,omitempty"` + + // The resource type. + ResourceType *string `json:"resource_type,omitempty"` + + // The CRN for this public gateway. + CRN *string `json:"crn,omitempty"` +} + +// Constants associated with the FloatingIPTarget.ResourceType property. +// The resource type. +const ( + FloatingIPTargetResourceTypeNetworkInterfaceConst = "network_interface" +) + +func (*FloatingIPTarget) isaFloatingIPTarget() bool { + return true +} + +type FloatingIPTargetIntf interface { + isaFloatingIPTarget() bool +} + +// UnmarshalFloatingIPTarget unmarshals an instance of FloatingIPTarget from the specified map of raw messages. +func UnmarshalFloatingIPTarget(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FloatingIPTarget) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalNetworkInterfaceReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_ip", &obj.PrimaryIP, UnmarshalReservedIPReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FloatingIPTargetPatch : The target resource to bind this floating IP to, replacing any existing binding. The floating IP must not be required +// by another resource, such as a public gateway. +// +// The target resource must not already have a floating IP bound to it if the target resource is: +// +// - an instance network interface +// - a bare metal server network interface with `enable_infrastructure_nat` set to `true`. +// Models which "extend" this model: +// - FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentity +// - FloatingIPTargetPatchNetworkInterfaceIdentity +type FloatingIPTargetPatch struct { + // The unique identifier for this bare metal server network interface. + ID *string `json:"id,omitempty"` + + // The URL for this bare metal server network interface. + Href *string `json:"href,omitempty"` +} + +func (*FloatingIPTargetPatch) isaFloatingIPTargetPatch() bool { + return true +} + +type FloatingIPTargetPatchIntf interface { + isaFloatingIPTargetPatch() bool +} + +// UnmarshalFloatingIPTargetPatch unmarshals an instance of FloatingIPTargetPatch from the specified map of raw messages. +func UnmarshalFloatingIPTargetPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FloatingIPTargetPatch) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FloatingIPTargetPrototype : The target resource to bind this floating IP to. +// +// The target resource must not already have a floating IP bound to it if the target resource is: +// +// - an instance network interface +// - a bare metal server network interface with `enable_infrastructure_nat` set to `true`. +// Models which "extend" this model: +// - FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentity +// - FloatingIPTargetPrototypeNetworkInterfaceIdentity +type FloatingIPTargetPrototype struct { + // The unique identifier for this bare metal server network interface. + ID *string `json:"id,omitempty"` + + // The URL for this bare metal server network interface. + Href *string `json:"href,omitempty"` +} + +func (*FloatingIPTargetPrototype) isaFloatingIPTargetPrototype() bool { + return true +} + +type FloatingIPTargetPrototypeIntf interface { + isaFloatingIPTargetPrototype() bool +} + +// UnmarshalFloatingIPTargetPrototype unmarshals an instance of FloatingIPTargetPrototype from the specified map of raw messages. +func UnmarshalFloatingIPTargetPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FloatingIPTargetPrototype) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FloatingIPUnpaginatedCollection : FloatingIPUnpaginatedCollection struct +type FloatingIPUnpaginatedCollection struct { + // Collection of floating IPs. + FloatingIps []FloatingIP `json:"floating_ips" validate:"required"` +} + +// UnmarshalFloatingIPUnpaginatedCollection unmarshals an instance of FloatingIPUnpaginatedCollection from the specified map of raw messages. +func UnmarshalFloatingIPUnpaginatedCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FloatingIPUnpaginatedCollection) + err = core.UnmarshalModel(m, "floating_ips", &obj.FloatingIps, UnmarshalFloatingIP) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FlowLogCollector : FlowLogCollector struct +type FlowLogCollector struct { + // Indicates whether this collector is active. + Active *bool `json:"active" validate:"required"` + + // Indicates whether this flow log collector will be automatically deleted when `target` is deleted. At present, this + // is always `true`, but may be modifiable in the future. + AutoDelete *bool `json:"auto_delete" validate:"required"` + + // The date and time that the flow log collector was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The CRN for this flow log collector. + CRN *string `json:"crn" validate:"required"` + + // The URL for this flow log collector. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this flow log collector. + ID *string `json:"id" validate:"required"` + + // The lifecycle state of the flow log collector. + LifecycleState *string `json:"lifecycle_state" validate:"required"` + + // The name for this flow log collector. The name is unique across all flow log collectors in the VPC. + Name *string `json:"name" validate:"required"` + + // The resource group for this flow log collector. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The Cloud Object Storage bucket where the collected flows are logged. + StorageBucket *LegacyCloudObjectStorageBucketReference `json:"storage_bucket" validate:"required"` + + // The target this collector is collecting flow logs for. + // - If the target is an instance network interface, flow logs will be collected + // for that instance network interface. + // - If the target is a virtual server instance, flow logs will be collected + // for all network interfaces on that instance. + // - If the target is a subnet, flow logs will be collected + // for all instance network interfaces attached to that subnet. + // - If the target is a VPC, flow logs will be collected for instance network interfaces + // attached to all subnets within that VPC. + // If the target is an instance, subnet, or VPC, flow logs will not be collected + // for any instance network interfaces within the target that are themselves the target of + // a more specific flow log collector. + Target FlowLogCollectorTargetIntf `json:"target" validate:"required"` + + // The VPC this flow log collector resides in. + VPC *VPCReference `json:"vpc" validate:"required"` +} + +// Constants associated with the FlowLogCollector.LifecycleState property. +// The lifecycle state of the flow log collector. +const ( + FlowLogCollectorLifecycleStateDeletingConst = "deleting" + FlowLogCollectorLifecycleStateFailedConst = "failed" + FlowLogCollectorLifecycleStatePendingConst = "pending" + FlowLogCollectorLifecycleStateStableConst = "stable" + FlowLogCollectorLifecycleStateSuspendedConst = "suspended" + FlowLogCollectorLifecycleStateUpdatingConst = "updating" + FlowLogCollectorLifecycleStateWaitingConst = "waiting" +) + +// UnmarshalFlowLogCollector unmarshals an instance of FlowLogCollector from the specified map of raw messages. +func UnmarshalFlowLogCollector(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FlowLogCollector) + err = core.UnmarshalPrimitive(m, "active", &obj.Active) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "auto_delete", &obj.AutoDelete) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "lifecycle_state", &obj.LifecycleState) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "storage_bucket", &obj.StorageBucket, UnmarshalLegacyCloudObjectStorageBucketReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "target", &obj.Target, UnmarshalFlowLogCollectorTarget) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FlowLogCollectorCollection : FlowLogCollectorCollection struct +type FlowLogCollectorCollection struct { + // A link to the first page of resources. + First *FlowLogCollectorCollectionFirst `json:"first" validate:"required"` + + // Collection of flow log collectors. + FlowLogCollectors []FlowLogCollector `json:"flow_log_collectors" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *FlowLogCollectorCollectionNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalFlowLogCollectorCollection unmarshals an instance of FlowLogCollectorCollection from the specified map of raw messages. +func UnmarshalFlowLogCollectorCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FlowLogCollectorCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalFlowLogCollectorCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalModel(m, "flow_log_collectors", &obj.FlowLogCollectors, UnmarshalFlowLogCollector) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalFlowLogCollectorCollectionNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *FlowLogCollectorCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// FlowLogCollectorCollectionFirst : A link to the first page of resources. +type FlowLogCollectorCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalFlowLogCollectorCollectionFirst unmarshals an instance of FlowLogCollectorCollectionFirst from the specified map of raw messages. +func UnmarshalFlowLogCollectorCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FlowLogCollectorCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FlowLogCollectorCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type FlowLogCollectorCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalFlowLogCollectorCollectionNext unmarshals an instance of FlowLogCollectorCollectionNext from the specified map of raw messages. +func UnmarshalFlowLogCollectorCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FlowLogCollectorCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FlowLogCollectorPatch : FlowLogCollectorPatch struct +type FlowLogCollectorPatch struct { + // Indicates whether this collector is active. Updating to false deactivates the collector and updating to true + // activates the collector. + Active *bool `json:"active,omitempty"` + + // The name for this flow log collector. The name must not be used by another flow log collector in the VPC. + Name *string `json:"name,omitempty"` +} + +// UnmarshalFlowLogCollectorPatch unmarshals an instance of FlowLogCollectorPatch from the specified map of raw messages. +func UnmarshalFlowLogCollectorPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FlowLogCollectorPatch) + err = core.UnmarshalPrimitive(m, "active", &obj.Active) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the FlowLogCollectorPatch +func (flowLogCollectorPatch *FlowLogCollectorPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(flowLogCollectorPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// FlowLogCollectorTarget : The target this collector is collecting flow logs for. +// - If the target is an instance network interface, flow logs will be collected +// for that instance network interface. +// - If the target is a virtual server instance, flow logs will be collected +// for all network interfaces on that instance. +// - If the target is a subnet, flow logs will be collected +// for all instance network interfaces attached to that subnet. +// - If the target is a VPC, flow logs will be collected for instance network interfaces +// attached to all subnets within that VPC. If the target is an instance, subnet, or VPC, flow logs will not be +// +// collected for any instance network interfaces within the target that are themselves the target of a more specific +// flow log collector. +// Models which "extend" this model: +// - FlowLogCollectorTargetNetworkInterfaceReferenceTargetContext +// - FlowLogCollectorTargetInstanceReference +// - FlowLogCollectorTargetSubnetReference +// - FlowLogCollectorTargetVPCReference +type FlowLogCollectorTarget struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *NetworkInterfaceReferenceTargetContextDeleted `json:"deleted,omitempty"` + + // The URL for this instance network interface. + Href *string `json:"href,omitempty"` + + // The unique identifier for this instance network interface. + ID *string `json:"id,omitempty"` + + // The name for this instance network interface. + Name *string `json:"name,omitempty"` + + // The resource type. + ResourceType *string `json:"resource_type,omitempty"` + + // The CRN for this virtual server instance. + CRN *string `json:"crn,omitempty"` +} + +// Constants associated with the FlowLogCollectorTarget.ResourceType property. +// The resource type. +const ( + FlowLogCollectorTargetResourceTypeNetworkInterfaceConst = "network_interface" +) + +func (*FlowLogCollectorTarget) isaFlowLogCollectorTarget() bool { + return true +} + +type FlowLogCollectorTargetIntf interface { + isaFlowLogCollectorTarget() bool +} + +// UnmarshalFlowLogCollectorTarget unmarshals an instance of FlowLogCollectorTarget from the specified map of raw messages. +func UnmarshalFlowLogCollectorTarget(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FlowLogCollectorTarget) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalNetworkInterfaceReferenceTargetContextDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FlowLogCollectorTargetPrototype : The target this collector will collect flow logs for. If the target is an instance, subnet, or VPC, flow logs will +// not be collected for any instance network interfaces within the target that are themselves the target of a more +// specific flow log collector. +// Models which "extend" this model: +// - FlowLogCollectorTargetPrototypeNetworkInterfaceIdentity +// - FlowLogCollectorTargetPrototypeInstanceIdentity +// - FlowLogCollectorTargetPrototypeSubnetIdentity +// - FlowLogCollectorTargetPrototypeVPCIdentity +type FlowLogCollectorTargetPrototype struct { + // The unique identifier for this instance network interface. + ID *string `json:"id,omitempty"` + + // The URL for this instance network interface. + Href *string `json:"href,omitempty"` + + // The CRN for this virtual server instance. + CRN *string `json:"crn,omitempty"` +} + +func (*FlowLogCollectorTargetPrototype) isaFlowLogCollectorTargetPrototype() bool { + return true +} + +type FlowLogCollectorTargetPrototypeIntf interface { + isaFlowLogCollectorTargetPrototype() bool +} + +// UnmarshalFlowLogCollectorTargetPrototype unmarshals an instance of FlowLogCollectorTargetPrototype from the specified map of raw messages. +func UnmarshalFlowLogCollectorTargetPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FlowLogCollectorTargetPrototype) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// GenericResourceReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type GenericResourceReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalGenericResourceReferenceDeleted unmarshals an instance of GenericResourceReferenceDeleted from the specified map of raw messages. +func UnmarshalGenericResourceReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(GenericResourceReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// GetBackupPolicyJobOptions : The GetBackupPolicyJob options. +type GetBackupPolicyJobOptions struct { + // The backup policy identifier. + BackupPolicyID *string `json:"backup_policy_id" validate:"required,ne="` + + // The backup policy job identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetBackupPolicyJobOptions : Instantiate GetBackupPolicyJobOptions +func (*VpcV1) NewGetBackupPolicyJobOptions(backupPolicyID string, id string) *GetBackupPolicyJobOptions { + return &GetBackupPolicyJobOptions{ + BackupPolicyID: core.StringPtr(backupPolicyID), + ID: core.StringPtr(id), + } +} + +// SetBackupPolicyID : Allow user to set BackupPolicyID +func (_options *GetBackupPolicyJobOptions) SetBackupPolicyID(backupPolicyID string) *GetBackupPolicyJobOptions { + _options.BackupPolicyID = core.StringPtr(backupPolicyID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetBackupPolicyJobOptions) SetID(id string) *GetBackupPolicyJobOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetBackupPolicyJobOptions) SetHeaders(param map[string]string) *GetBackupPolicyJobOptions { + options.Headers = param + return options +} + +// GetBackupPolicyOptions : The GetBackupPolicy options. +type GetBackupPolicyOptions struct { + // The backup policy identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetBackupPolicyOptions : Instantiate GetBackupPolicyOptions +func (*VpcV1) NewGetBackupPolicyOptions(id string) *GetBackupPolicyOptions { + return &GetBackupPolicyOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetBackupPolicyOptions) SetID(id string) *GetBackupPolicyOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetBackupPolicyOptions) SetHeaders(param map[string]string) *GetBackupPolicyOptions { + options.Headers = param + return options +} + +// GetBackupPolicyPlanOptions : The GetBackupPolicyPlan options. +type GetBackupPolicyPlanOptions struct { + // The backup policy identifier. + BackupPolicyID *string `json:"backup_policy_id" validate:"required,ne="` + + // The backup policy plan identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetBackupPolicyPlanOptions : Instantiate GetBackupPolicyPlanOptions +func (*VpcV1) NewGetBackupPolicyPlanOptions(backupPolicyID string, id string) *GetBackupPolicyPlanOptions { + return &GetBackupPolicyPlanOptions{ + BackupPolicyID: core.StringPtr(backupPolicyID), + ID: core.StringPtr(id), + } +} + +// SetBackupPolicyID : Allow user to set BackupPolicyID +func (_options *GetBackupPolicyPlanOptions) SetBackupPolicyID(backupPolicyID string) *GetBackupPolicyPlanOptions { + _options.BackupPolicyID = core.StringPtr(backupPolicyID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetBackupPolicyPlanOptions) SetID(id string) *GetBackupPolicyPlanOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetBackupPolicyPlanOptions) SetHeaders(param map[string]string) *GetBackupPolicyPlanOptions { + options.Headers = param + return options +} + +// GetBareMetalServerDiskOptions : The GetBareMetalServerDisk options. +type GetBareMetalServerDiskOptions struct { + // The bare metal server identifier. + BareMetalServerID *string `json:"bare_metal_server_id" validate:"required,ne="` + + // The bare metal server disk identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetBareMetalServerDiskOptions : Instantiate GetBareMetalServerDiskOptions +func (*VpcV1) NewGetBareMetalServerDiskOptions(bareMetalServerID string, id string) *GetBareMetalServerDiskOptions { + return &GetBareMetalServerDiskOptions{ + BareMetalServerID: core.StringPtr(bareMetalServerID), + ID: core.StringPtr(id), + } +} + +// SetBareMetalServerID : Allow user to set BareMetalServerID +func (_options *GetBareMetalServerDiskOptions) SetBareMetalServerID(bareMetalServerID string) *GetBareMetalServerDiskOptions { + _options.BareMetalServerID = core.StringPtr(bareMetalServerID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetBareMetalServerDiskOptions) SetID(id string) *GetBareMetalServerDiskOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetBareMetalServerDiskOptions) SetHeaders(param map[string]string) *GetBareMetalServerDiskOptions { + options.Headers = param + return options +} + +// GetBareMetalServerInitializationOptions : The GetBareMetalServerInitialization options. +type GetBareMetalServerInitializationOptions struct { + // The bare metal server identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetBareMetalServerInitializationOptions : Instantiate GetBareMetalServerInitializationOptions +func (*VpcV1) NewGetBareMetalServerInitializationOptions(id string) *GetBareMetalServerInitializationOptions { + return &GetBareMetalServerInitializationOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetBareMetalServerInitializationOptions) SetID(id string) *GetBareMetalServerInitializationOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetBareMetalServerInitializationOptions) SetHeaders(param map[string]string) *GetBareMetalServerInitializationOptions { + options.Headers = param + return options +} + +// GetBareMetalServerNetworkInterfaceFloatingIPOptions : The GetBareMetalServerNetworkInterfaceFloatingIP options. +type GetBareMetalServerNetworkInterfaceFloatingIPOptions struct { + // The bare metal server identifier. + BareMetalServerID *string `json:"bare_metal_server_id" validate:"required,ne="` + + // The bare metal server network interface identifier. + NetworkInterfaceID *string `json:"network_interface_id" validate:"required,ne="` + + // The floating IP identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetBareMetalServerNetworkInterfaceFloatingIPOptions : Instantiate GetBareMetalServerNetworkInterfaceFloatingIPOptions +func (*VpcV1) NewGetBareMetalServerNetworkInterfaceFloatingIPOptions(bareMetalServerID string, networkInterfaceID string, id string) *GetBareMetalServerNetworkInterfaceFloatingIPOptions { + return &GetBareMetalServerNetworkInterfaceFloatingIPOptions{ + BareMetalServerID: core.StringPtr(bareMetalServerID), + NetworkInterfaceID: core.StringPtr(networkInterfaceID), + ID: core.StringPtr(id), + } +} + +// SetBareMetalServerID : Allow user to set BareMetalServerID +func (_options *GetBareMetalServerNetworkInterfaceFloatingIPOptions) SetBareMetalServerID(bareMetalServerID string) *GetBareMetalServerNetworkInterfaceFloatingIPOptions { + _options.BareMetalServerID = core.StringPtr(bareMetalServerID) + return _options +} + +// SetNetworkInterfaceID : Allow user to set NetworkInterfaceID +func (_options *GetBareMetalServerNetworkInterfaceFloatingIPOptions) SetNetworkInterfaceID(networkInterfaceID string) *GetBareMetalServerNetworkInterfaceFloatingIPOptions { + _options.NetworkInterfaceID = core.StringPtr(networkInterfaceID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetBareMetalServerNetworkInterfaceFloatingIPOptions) SetID(id string) *GetBareMetalServerNetworkInterfaceFloatingIPOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetBareMetalServerNetworkInterfaceFloatingIPOptions) SetHeaders(param map[string]string) *GetBareMetalServerNetworkInterfaceFloatingIPOptions { + options.Headers = param + return options +} + +// GetBareMetalServerNetworkInterfaceIPOptions : The GetBareMetalServerNetworkInterfaceIP options. +type GetBareMetalServerNetworkInterfaceIPOptions struct { + // The bare metal server identifier. + BareMetalServerID *string `json:"bare_metal_server_id" validate:"required,ne="` + + // The bare metal server network interface identifier. + NetworkInterfaceID *string `json:"network_interface_id" validate:"required,ne="` + + // The reserved IP identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetBareMetalServerNetworkInterfaceIPOptions : Instantiate GetBareMetalServerNetworkInterfaceIPOptions +func (*VpcV1) NewGetBareMetalServerNetworkInterfaceIPOptions(bareMetalServerID string, networkInterfaceID string, id string) *GetBareMetalServerNetworkInterfaceIPOptions { + return &GetBareMetalServerNetworkInterfaceIPOptions{ + BareMetalServerID: core.StringPtr(bareMetalServerID), + NetworkInterfaceID: core.StringPtr(networkInterfaceID), + ID: core.StringPtr(id), + } +} + +// SetBareMetalServerID : Allow user to set BareMetalServerID +func (_options *GetBareMetalServerNetworkInterfaceIPOptions) SetBareMetalServerID(bareMetalServerID string) *GetBareMetalServerNetworkInterfaceIPOptions { + _options.BareMetalServerID = core.StringPtr(bareMetalServerID) + return _options +} + +// SetNetworkInterfaceID : Allow user to set NetworkInterfaceID +func (_options *GetBareMetalServerNetworkInterfaceIPOptions) SetNetworkInterfaceID(networkInterfaceID string) *GetBareMetalServerNetworkInterfaceIPOptions { + _options.NetworkInterfaceID = core.StringPtr(networkInterfaceID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetBareMetalServerNetworkInterfaceIPOptions) SetID(id string) *GetBareMetalServerNetworkInterfaceIPOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetBareMetalServerNetworkInterfaceIPOptions) SetHeaders(param map[string]string) *GetBareMetalServerNetworkInterfaceIPOptions { + options.Headers = param + return options +} + +// GetBareMetalServerNetworkInterfaceOptions : The GetBareMetalServerNetworkInterface options. +type GetBareMetalServerNetworkInterfaceOptions struct { + // The bare metal server identifier. + BareMetalServerID *string `json:"bare_metal_server_id" validate:"required,ne="` + + // The bare metal server network interface identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetBareMetalServerNetworkInterfaceOptions : Instantiate GetBareMetalServerNetworkInterfaceOptions +func (*VpcV1) NewGetBareMetalServerNetworkInterfaceOptions(bareMetalServerID string, id string) *GetBareMetalServerNetworkInterfaceOptions { + return &GetBareMetalServerNetworkInterfaceOptions{ + BareMetalServerID: core.StringPtr(bareMetalServerID), + ID: core.StringPtr(id), + } +} + +// SetBareMetalServerID : Allow user to set BareMetalServerID +func (_options *GetBareMetalServerNetworkInterfaceOptions) SetBareMetalServerID(bareMetalServerID string) *GetBareMetalServerNetworkInterfaceOptions { + _options.BareMetalServerID = core.StringPtr(bareMetalServerID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetBareMetalServerNetworkInterfaceOptions) SetID(id string) *GetBareMetalServerNetworkInterfaceOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetBareMetalServerNetworkInterfaceOptions) SetHeaders(param map[string]string) *GetBareMetalServerNetworkInterfaceOptions { + options.Headers = param + return options +} + +// GetBareMetalServerOptions : The GetBareMetalServer options. +type GetBareMetalServerOptions struct { + // The bare metal server identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetBareMetalServerOptions : Instantiate GetBareMetalServerOptions +func (*VpcV1) NewGetBareMetalServerOptions(id string) *GetBareMetalServerOptions { + return &GetBareMetalServerOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetBareMetalServerOptions) SetID(id string) *GetBareMetalServerOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetBareMetalServerOptions) SetHeaders(param map[string]string) *GetBareMetalServerOptions { + options.Headers = param + return options +} + +// GetBareMetalServerProfileOptions : The GetBareMetalServerProfile options. +type GetBareMetalServerProfileOptions struct { + // The bare metal server profile name. + Name *string `json:"name" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetBareMetalServerProfileOptions : Instantiate GetBareMetalServerProfileOptions +func (*VpcV1) NewGetBareMetalServerProfileOptions(name string) *GetBareMetalServerProfileOptions { + return &GetBareMetalServerProfileOptions{ + Name: core.StringPtr(name), + } +} + +// SetName : Allow user to set Name +func (_options *GetBareMetalServerProfileOptions) SetName(name string) *GetBareMetalServerProfileOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetBareMetalServerProfileOptions) SetHeaders(param map[string]string) *GetBareMetalServerProfileOptions { + options.Headers = param + return options +} + +// GetDedicatedHostDiskOptions : The GetDedicatedHostDisk options. +type GetDedicatedHostDiskOptions struct { + // The dedicated host identifier. + DedicatedHostID *string `json:"dedicated_host_id" validate:"required,ne="` + + // The dedicated host disk identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetDedicatedHostDiskOptions : Instantiate GetDedicatedHostDiskOptions +func (*VpcV1) NewGetDedicatedHostDiskOptions(dedicatedHostID string, id string) *GetDedicatedHostDiskOptions { + return &GetDedicatedHostDiskOptions{ + DedicatedHostID: core.StringPtr(dedicatedHostID), + ID: core.StringPtr(id), + } +} + +// SetDedicatedHostID : Allow user to set DedicatedHostID +func (_options *GetDedicatedHostDiskOptions) SetDedicatedHostID(dedicatedHostID string) *GetDedicatedHostDiskOptions { + _options.DedicatedHostID = core.StringPtr(dedicatedHostID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetDedicatedHostDiskOptions) SetID(id string) *GetDedicatedHostDiskOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetDedicatedHostDiskOptions) SetHeaders(param map[string]string) *GetDedicatedHostDiskOptions { + options.Headers = param + return options +} + +// GetDedicatedHostGroupOptions : The GetDedicatedHostGroup options. +type GetDedicatedHostGroupOptions struct { + // The dedicated host group identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetDedicatedHostGroupOptions : Instantiate GetDedicatedHostGroupOptions +func (*VpcV1) NewGetDedicatedHostGroupOptions(id string) *GetDedicatedHostGroupOptions { + return &GetDedicatedHostGroupOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetDedicatedHostGroupOptions) SetID(id string) *GetDedicatedHostGroupOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetDedicatedHostGroupOptions) SetHeaders(param map[string]string) *GetDedicatedHostGroupOptions { + options.Headers = param + return options +} + +// GetDedicatedHostOptions : The GetDedicatedHost options. +type GetDedicatedHostOptions struct { + // The dedicated host identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetDedicatedHostOptions : Instantiate GetDedicatedHostOptions +func (*VpcV1) NewGetDedicatedHostOptions(id string) *GetDedicatedHostOptions { + return &GetDedicatedHostOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetDedicatedHostOptions) SetID(id string) *GetDedicatedHostOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetDedicatedHostOptions) SetHeaders(param map[string]string) *GetDedicatedHostOptions { + options.Headers = param + return options +} + +// GetDedicatedHostProfileOptions : The GetDedicatedHostProfile options. +type GetDedicatedHostProfileOptions struct { + // The dedicated host profile name. + Name *string `json:"name" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetDedicatedHostProfileOptions : Instantiate GetDedicatedHostProfileOptions +func (*VpcV1) NewGetDedicatedHostProfileOptions(name string) *GetDedicatedHostProfileOptions { + return &GetDedicatedHostProfileOptions{ + Name: core.StringPtr(name), + } +} + +// SetName : Allow user to set Name +func (_options *GetDedicatedHostProfileOptions) SetName(name string) *GetDedicatedHostProfileOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetDedicatedHostProfileOptions) SetHeaders(param map[string]string) *GetDedicatedHostProfileOptions { + options.Headers = param + return options +} + +// GetEndpointGatewayIPOptions : The GetEndpointGatewayIP options. +type GetEndpointGatewayIPOptions struct { + // The endpoint gateway identifier. + EndpointGatewayID *string `json:"endpoint_gateway_id" validate:"required,ne="` + + // The reserved IP identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetEndpointGatewayIPOptions : Instantiate GetEndpointGatewayIPOptions +func (*VpcV1) NewGetEndpointGatewayIPOptions(endpointGatewayID string, id string) *GetEndpointGatewayIPOptions { + return &GetEndpointGatewayIPOptions{ + EndpointGatewayID: core.StringPtr(endpointGatewayID), + ID: core.StringPtr(id), + } +} + +// SetEndpointGatewayID : Allow user to set EndpointGatewayID +func (_options *GetEndpointGatewayIPOptions) SetEndpointGatewayID(endpointGatewayID string) *GetEndpointGatewayIPOptions { + _options.EndpointGatewayID = core.StringPtr(endpointGatewayID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetEndpointGatewayIPOptions) SetID(id string) *GetEndpointGatewayIPOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetEndpointGatewayIPOptions) SetHeaders(param map[string]string) *GetEndpointGatewayIPOptions { + options.Headers = param + return options +} + +// GetEndpointGatewayOptions : The GetEndpointGateway options. +type GetEndpointGatewayOptions struct { + // The endpoint gateway identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetEndpointGatewayOptions : Instantiate GetEndpointGatewayOptions +func (*VpcV1) NewGetEndpointGatewayOptions(id string) *GetEndpointGatewayOptions { + return &GetEndpointGatewayOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetEndpointGatewayOptions) SetID(id string) *GetEndpointGatewayOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetEndpointGatewayOptions) SetHeaders(param map[string]string) *GetEndpointGatewayOptions { + options.Headers = param + return options +} + +// GetFloatingIPOptions : The GetFloatingIP options. +type GetFloatingIPOptions struct { + // The floating IP identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetFloatingIPOptions : Instantiate GetFloatingIPOptions +func (*VpcV1) NewGetFloatingIPOptions(id string) *GetFloatingIPOptions { + return &GetFloatingIPOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetFloatingIPOptions) SetID(id string) *GetFloatingIPOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetFloatingIPOptions) SetHeaders(param map[string]string) *GetFloatingIPOptions { + options.Headers = param + return options +} + +// GetFlowLogCollectorOptions : The GetFlowLogCollector options. +type GetFlowLogCollectorOptions struct { + // The flow log collector identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetFlowLogCollectorOptions : Instantiate GetFlowLogCollectorOptions +func (*VpcV1) NewGetFlowLogCollectorOptions(id string) *GetFlowLogCollectorOptions { + return &GetFlowLogCollectorOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetFlowLogCollectorOptions) SetID(id string) *GetFlowLogCollectorOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetFlowLogCollectorOptions) SetHeaders(param map[string]string) *GetFlowLogCollectorOptions { + options.Headers = param + return options +} + +// GetIkePolicyOptions : The GetIkePolicy options. +type GetIkePolicyOptions struct { + // The IKE policy identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetIkePolicyOptions : Instantiate GetIkePolicyOptions +func (*VpcV1) NewGetIkePolicyOptions(id string) *GetIkePolicyOptions { + return &GetIkePolicyOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetIkePolicyOptions) SetID(id string) *GetIkePolicyOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetIkePolicyOptions) SetHeaders(param map[string]string) *GetIkePolicyOptions { + options.Headers = param + return options +} + +// GetImageExportJobOptions : The GetImageExportJob options. +type GetImageExportJobOptions struct { + // The image identifier. + ImageID *string `json:"image_id" validate:"required,ne="` + + // The image export job identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetImageExportJobOptions : Instantiate GetImageExportJobOptions +func (*VpcV1) NewGetImageExportJobOptions(imageID string, id string) *GetImageExportJobOptions { + return &GetImageExportJobOptions{ + ImageID: core.StringPtr(imageID), + ID: core.StringPtr(id), + } +} + +// SetImageID : Allow user to set ImageID +func (_options *GetImageExportJobOptions) SetImageID(imageID string) *GetImageExportJobOptions { + _options.ImageID = core.StringPtr(imageID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetImageExportJobOptions) SetID(id string) *GetImageExportJobOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetImageExportJobOptions) SetHeaders(param map[string]string) *GetImageExportJobOptions { + options.Headers = param + return options +} + +// GetImageOptions : The GetImage options. +type GetImageOptions struct { + // The image identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetImageOptions : Instantiate GetImageOptions +func (*VpcV1) NewGetImageOptions(id string) *GetImageOptions { + return &GetImageOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetImageOptions) SetID(id string) *GetImageOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetImageOptions) SetHeaders(param map[string]string) *GetImageOptions { + options.Headers = param + return options +} + +// GetInstanceDiskOptions : The GetInstanceDisk options. +type GetInstanceDiskOptions struct { + // The virtual server instance identifier. + InstanceID *string `json:"instance_id" validate:"required,ne="` + + // The instance disk identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetInstanceDiskOptions : Instantiate GetInstanceDiskOptions +func (*VpcV1) NewGetInstanceDiskOptions(instanceID string, id string) *GetInstanceDiskOptions { + return &GetInstanceDiskOptions{ + InstanceID: core.StringPtr(instanceID), + ID: core.StringPtr(id), + } +} + +// SetInstanceID : Allow user to set InstanceID +func (_options *GetInstanceDiskOptions) SetInstanceID(instanceID string) *GetInstanceDiskOptions { + _options.InstanceID = core.StringPtr(instanceID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetInstanceDiskOptions) SetID(id string) *GetInstanceDiskOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetInstanceDiskOptions) SetHeaders(param map[string]string) *GetInstanceDiskOptions { + options.Headers = param + return options +} + +// GetInstanceGroupManagerActionOptions : The GetInstanceGroupManagerAction options. +type GetInstanceGroupManagerActionOptions struct { + // The instance group identifier. + InstanceGroupID *string `json:"instance_group_id" validate:"required,ne="` + + // The instance group manager identifier. + InstanceGroupManagerID *string `json:"instance_group_manager_id" validate:"required,ne="` + + // The instance group manager action identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetInstanceGroupManagerActionOptions : Instantiate GetInstanceGroupManagerActionOptions +func (*VpcV1) NewGetInstanceGroupManagerActionOptions(instanceGroupID string, instanceGroupManagerID string, id string) *GetInstanceGroupManagerActionOptions { + return &GetInstanceGroupManagerActionOptions{ + InstanceGroupID: core.StringPtr(instanceGroupID), + InstanceGroupManagerID: core.StringPtr(instanceGroupManagerID), + ID: core.StringPtr(id), + } +} + +// SetInstanceGroupID : Allow user to set InstanceGroupID +func (_options *GetInstanceGroupManagerActionOptions) SetInstanceGroupID(instanceGroupID string) *GetInstanceGroupManagerActionOptions { + _options.InstanceGroupID = core.StringPtr(instanceGroupID) + return _options +} + +// SetInstanceGroupManagerID : Allow user to set InstanceGroupManagerID +func (_options *GetInstanceGroupManagerActionOptions) SetInstanceGroupManagerID(instanceGroupManagerID string) *GetInstanceGroupManagerActionOptions { + _options.InstanceGroupManagerID = core.StringPtr(instanceGroupManagerID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetInstanceGroupManagerActionOptions) SetID(id string) *GetInstanceGroupManagerActionOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetInstanceGroupManagerActionOptions) SetHeaders(param map[string]string) *GetInstanceGroupManagerActionOptions { + options.Headers = param + return options +} + +// GetInstanceGroupManagerOptions : The GetInstanceGroupManager options. +type GetInstanceGroupManagerOptions struct { + // The instance group identifier. + InstanceGroupID *string `json:"instance_group_id" validate:"required,ne="` + + // The instance group manager identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetInstanceGroupManagerOptions : Instantiate GetInstanceGroupManagerOptions +func (*VpcV1) NewGetInstanceGroupManagerOptions(instanceGroupID string, id string) *GetInstanceGroupManagerOptions { + return &GetInstanceGroupManagerOptions{ + InstanceGroupID: core.StringPtr(instanceGroupID), + ID: core.StringPtr(id), + } +} + +// SetInstanceGroupID : Allow user to set InstanceGroupID +func (_options *GetInstanceGroupManagerOptions) SetInstanceGroupID(instanceGroupID string) *GetInstanceGroupManagerOptions { + _options.InstanceGroupID = core.StringPtr(instanceGroupID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetInstanceGroupManagerOptions) SetID(id string) *GetInstanceGroupManagerOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetInstanceGroupManagerOptions) SetHeaders(param map[string]string) *GetInstanceGroupManagerOptions { + options.Headers = param + return options +} + +// GetInstanceGroupManagerPolicyOptions : The GetInstanceGroupManagerPolicy options. +type GetInstanceGroupManagerPolicyOptions struct { + // The instance group identifier. + InstanceGroupID *string `json:"instance_group_id" validate:"required,ne="` + + // The instance group manager identifier. + InstanceGroupManagerID *string `json:"instance_group_manager_id" validate:"required,ne="` + + // The instance group manager policy identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetInstanceGroupManagerPolicyOptions : Instantiate GetInstanceGroupManagerPolicyOptions +func (*VpcV1) NewGetInstanceGroupManagerPolicyOptions(instanceGroupID string, instanceGroupManagerID string, id string) *GetInstanceGroupManagerPolicyOptions { + return &GetInstanceGroupManagerPolicyOptions{ + InstanceGroupID: core.StringPtr(instanceGroupID), + InstanceGroupManagerID: core.StringPtr(instanceGroupManagerID), + ID: core.StringPtr(id), + } +} + +// SetInstanceGroupID : Allow user to set InstanceGroupID +func (_options *GetInstanceGroupManagerPolicyOptions) SetInstanceGroupID(instanceGroupID string) *GetInstanceGroupManagerPolicyOptions { + _options.InstanceGroupID = core.StringPtr(instanceGroupID) + return _options +} + +// SetInstanceGroupManagerID : Allow user to set InstanceGroupManagerID +func (_options *GetInstanceGroupManagerPolicyOptions) SetInstanceGroupManagerID(instanceGroupManagerID string) *GetInstanceGroupManagerPolicyOptions { + _options.InstanceGroupManagerID = core.StringPtr(instanceGroupManagerID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetInstanceGroupManagerPolicyOptions) SetID(id string) *GetInstanceGroupManagerPolicyOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetInstanceGroupManagerPolicyOptions) SetHeaders(param map[string]string) *GetInstanceGroupManagerPolicyOptions { + options.Headers = param + return options +} + +// GetInstanceGroupMembershipOptions : The GetInstanceGroupMembership options. +type GetInstanceGroupMembershipOptions struct { + // The instance group identifier. + InstanceGroupID *string `json:"instance_group_id" validate:"required,ne="` + + // The instance group membership identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetInstanceGroupMembershipOptions : Instantiate GetInstanceGroupMembershipOptions +func (*VpcV1) NewGetInstanceGroupMembershipOptions(instanceGroupID string, id string) *GetInstanceGroupMembershipOptions { + return &GetInstanceGroupMembershipOptions{ + InstanceGroupID: core.StringPtr(instanceGroupID), + ID: core.StringPtr(id), + } +} + +// SetInstanceGroupID : Allow user to set InstanceGroupID +func (_options *GetInstanceGroupMembershipOptions) SetInstanceGroupID(instanceGroupID string) *GetInstanceGroupMembershipOptions { + _options.InstanceGroupID = core.StringPtr(instanceGroupID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetInstanceGroupMembershipOptions) SetID(id string) *GetInstanceGroupMembershipOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetInstanceGroupMembershipOptions) SetHeaders(param map[string]string) *GetInstanceGroupMembershipOptions { + options.Headers = param + return options +} + +// GetInstanceGroupOptions : The GetInstanceGroup options. +type GetInstanceGroupOptions struct { + // The instance group identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetInstanceGroupOptions : Instantiate GetInstanceGroupOptions +func (*VpcV1) NewGetInstanceGroupOptions(id string) *GetInstanceGroupOptions { + return &GetInstanceGroupOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetInstanceGroupOptions) SetID(id string) *GetInstanceGroupOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetInstanceGroupOptions) SetHeaders(param map[string]string) *GetInstanceGroupOptions { + options.Headers = param + return options +} + +// GetInstanceInitializationOptions : The GetInstanceInitialization options. +type GetInstanceInitializationOptions struct { + // The instance identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetInstanceInitializationOptions : Instantiate GetInstanceInitializationOptions +func (*VpcV1) NewGetInstanceInitializationOptions(id string) *GetInstanceInitializationOptions { + return &GetInstanceInitializationOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetInstanceInitializationOptions) SetID(id string) *GetInstanceInitializationOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetInstanceInitializationOptions) SetHeaders(param map[string]string) *GetInstanceInitializationOptions { + options.Headers = param + return options +} + +// GetInstanceNetworkInterfaceFloatingIPOptions : The GetInstanceNetworkInterfaceFloatingIP options. +type GetInstanceNetworkInterfaceFloatingIPOptions struct { + // The virtual server instance identifier. + InstanceID *string `json:"instance_id" validate:"required,ne="` + + // The instance network interface identifier. + NetworkInterfaceID *string `json:"network_interface_id" validate:"required,ne="` + + // The floating IP identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetInstanceNetworkInterfaceFloatingIPOptions : Instantiate GetInstanceNetworkInterfaceFloatingIPOptions +func (*VpcV1) NewGetInstanceNetworkInterfaceFloatingIPOptions(instanceID string, networkInterfaceID string, id string) *GetInstanceNetworkInterfaceFloatingIPOptions { + return &GetInstanceNetworkInterfaceFloatingIPOptions{ + InstanceID: core.StringPtr(instanceID), + NetworkInterfaceID: core.StringPtr(networkInterfaceID), + ID: core.StringPtr(id), + } +} + +// SetInstanceID : Allow user to set InstanceID +func (_options *GetInstanceNetworkInterfaceFloatingIPOptions) SetInstanceID(instanceID string) *GetInstanceNetworkInterfaceFloatingIPOptions { + _options.InstanceID = core.StringPtr(instanceID) + return _options +} + +// SetNetworkInterfaceID : Allow user to set NetworkInterfaceID +func (_options *GetInstanceNetworkInterfaceFloatingIPOptions) SetNetworkInterfaceID(networkInterfaceID string) *GetInstanceNetworkInterfaceFloatingIPOptions { + _options.NetworkInterfaceID = core.StringPtr(networkInterfaceID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetInstanceNetworkInterfaceFloatingIPOptions) SetID(id string) *GetInstanceNetworkInterfaceFloatingIPOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetInstanceNetworkInterfaceFloatingIPOptions) SetHeaders(param map[string]string) *GetInstanceNetworkInterfaceFloatingIPOptions { + options.Headers = param + return options +} + +// GetInstanceNetworkInterfaceIPOptions : The GetInstanceNetworkInterfaceIP options. +type GetInstanceNetworkInterfaceIPOptions struct { + // The virtual server instance identifier. + InstanceID *string `json:"instance_id" validate:"required,ne="` + + // The instance network interface identifier. + NetworkInterfaceID *string `json:"network_interface_id" validate:"required,ne="` + + // The reserved IP identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetInstanceNetworkInterfaceIPOptions : Instantiate GetInstanceNetworkInterfaceIPOptions +func (*VpcV1) NewGetInstanceNetworkInterfaceIPOptions(instanceID string, networkInterfaceID string, id string) *GetInstanceNetworkInterfaceIPOptions { + return &GetInstanceNetworkInterfaceIPOptions{ + InstanceID: core.StringPtr(instanceID), + NetworkInterfaceID: core.StringPtr(networkInterfaceID), + ID: core.StringPtr(id), + } +} + +// SetInstanceID : Allow user to set InstanceID +func (_options *GetInstanceNetworkInterfaceIPOptions) SetInstanceID(instanceID string) *GetInstanceNetworkInterfaceIPOptions { + _options.InstanceID = core.StringPtr(instanceID) + return _options +} + +// SetNetworkInterfaceID : Allow user to set NetworkInterfaceID +func (_options *GetInstanceNetworkInterfaceIPOptions) SetNetworkInterfaceID(networkInterfaceID string) *GetInstanceNetworkInterfaceIPOptions { + _options.NetworkInterfaceID = core.StringPtr(networkInterfaceID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetInstanceNetworkInterfaceIPOptions) SetID(id string) *GetInstanceNetworkInterfaceIPOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetInstanceNetworkInterfaceIPOptions) SetHeaders(param map[string]string) *GetInstanceNetworkInterfaceIPOptions { + options.Headers = param + return options +} + +// GetInstanceNetworkInterfaceOptions : The GetInstanceNetworkInterface options. +type GetInstanceNetworkInterfaceOptions struct { + // The virtual server instance identifier. + InstanceID *string `json:"instance_id" validate:"required,ne="` + + // The instance network interface identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetInstanceNetworkInterfaceOptions : Instantiate GetInstanceNetworkInterfaceOptions +func (*VpcV1) NewGetInstanceNetworkInterfaceOptions(instanceID string, id string) *GetInstanceNetworkInterfaceOptions { + return &GetInstanceNetworkInterfaceOptions{ + InstanceID: core.StringPtr(instanceID), + ID: core.StringPtr(id), + } +} + +// SetInstanceID : Allow user to set InstanceID +func (_options *GetInstanceNetworkInterfaceOptions) SetInstanceID(instanceID string) *GetInstanceNetworkInterfaceOptions { + _options.InstanceID = core.StringPtr(instanceID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetInstanceNetworkInterfaceOptions) SetID(id string) *GetInstanceNetworkInterfaceOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetInstanceNetworkInterfaceOptions) SetHeaders(param map[string]string) *GetInstanceNetworkInterfaceOptions { + options.Headers = param + return options +} + +// GetInstanceOptions : The GetInstance options. +type GetInstanceOptions struct { + // The virtual server instance identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetInstanceOptions : Instantiate GetInstanceOptions +func (*VpcV1) NewGetInstanceOptions(id string) *GetInstanceOptions { + return &GetInstanceOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetInstanceOptions) SetID(id string) *GetInstanceOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetInstanceOptions) SetHeaders(param map[string]string) *GetInstanceOptions { + options.Headers = param + return options +} + +// GetInstanceProfileOptions : The GetInstanceProfile options. +type GetInstanceProfileOptions struct { + // The instance profile name. + Name *string `json:"name" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetInstanceProfileOptions : Instantiate GetInstanceProfileOptions +func (*VpcV1) NewGetInstanceProfileOptions(name string) *GetInstanceProfileOptions { + return &GetInstanceProfileOptions{ + Name: core.StringPtr(name), + } +} + +// SetName : Allow user to set Name +func (_options *GetInstanceProfileOptions) SetName(name string) *GetInstanceProfileOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetInstanceProfileOptions) SetHeaders(param map[string]string) *GetInstanceProfileOptions { + options.Headers = param + return options +} + +// GetInstanceTemplateOptions : The GetInstanceTemplate options. +type GetInstanceTemplateOptions struct { + // The instance template identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetInstanceTemplateOptions : Instantiate GetInstanceTemplateOptions +func (*VpcV1) NewGetInstanceTemplateOptions(id string) *GetInstanceTemplateOptions { + return &GetInstanceTemplateOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetInstanceTemplateOptions) SetID(id string) *GetInstanceTemplateOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetInstanceTemplateOptions) SetHeaders(param map[string]string) *GetInstanceTemplateOptions { + options.Headers = param + return options +} + +// GetInstanceVolumeAttachmentOptions : The GetInstanceVolumeAttachment options. +type GetInstanceVolumeAttachmentOptions struct { + // The virtual server instance identifier. + InstanceID *string `json:"instance_id" validate:"required,ne="` + + // The volume attachment identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetInstanceVolumeAttachmentOptions : Instantiate GetInstanceVolumeAttachmentOptions +func (*VpcV1) NewGetInstanceVolumeAttachmentOptions(instanceID string, id string) *GetInstanceVolumeAttachmentOptions { + return &GetInstanceVolumeAttachmentOptions{ + InstanceID: core.StringPtr(instanceID), + ID: core.StringPtr(id), + } +} + +// SetInstanceID : Allow user to set InstanceID +func (_options *GetInstanceVolumeAttachmentOptions) SetInstanceID(instanceID string) *GetInstanceVolumeAttachmentOptions { + _options.InstanceID = core.StringPtr(instanceID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetInstanceVolumeAttachmentOptions) SetID(id string) *GetInstanceVolumeAttachmentOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetInstanceVolumeAttachmentOptions) SetHeaders(param map[string]string) *GetInstanceVolumeAttachmentOptions { + options.Headers = param + return options +} + +// GetIpsecPolicyOptions : The GetIpsecPolicy options. +type GetIpsecPolicyOptions struct { + // The IPsec policy identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetIpsecPolicyOptions : Instantiate GetIpsecPolicyOptions +func (*VpcV1) NewGetIpsecPolicyOptions(id string) *GetIpsecPolicyOptions { + return &GetIpsecPolicyOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetIpsecPolicyOptions) SetID(id string) *GetIpsecPolicyOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetIpsecPolicyOptions) SetHeaders(param map[string]string) *GetIpsecPolicyOptions { + options.Headers = param + return options +} + +// GetKeyOptions : The GetKey options. +type GetKeyOptions struct { + // The key identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetKeyOptions : Instantiate GetKeyOptions +func (*VpcV1) NewGetKeyOptions(id string) *GetKeyOptions { + return &GetKeyOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetKeyOptions) SetID(id string) *GetKeyOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetKeyOptions) SetHeaders(param map[string]string) *GetKeyOptions { + options.Headers = param + return options +} + +// GetLoadBalancerListenerOptions : The GetLoadBalancerListener options. +type GetLoadBalancerListenerOptions struct { + // The load balancer identifier. + LoadBalancerID *string `json:"load_balancer_id" validate:"required,ne="` + + // The listener identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetLoadBalancerListenerOptions : Instantiate GetLoadBalancerListenerOptions +func (*VpcV1) NewGetLoadBalancerListenerOptions(loadBalancerID string, id string) *GetLoadBalancerListenerOptions { + return &GetLoadBalancerListenerOptions{ + LoadBalancerID: core.StringPtr(loadBalancerID), + ID: core.StringPtr(id), + } +} + +// SetLoadBalancerID : Allow user to set LoadBalancerID +func (_options *GetLoadBalancerListenerOptions) SetLoadBalancerID(loadBalancerID string) *GetLoadBalancerListenerOptions { + _options.LoadBalancerID = core.StringPtr(loadBalancerID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetLoadBalancerListenerOptions) SetID(id string) *GetLoadBalancerListenerOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetLoadBalancerListenerOptions) SetHeaders(param map[string]string) *GetLoadBalancerListenerOptions { + options.Headers = param + return options +} + +// GetLoadBalancerListenerPolicyOptions : The GetLoadBalancerListenerPolicy options. +type GetLoadBalancerListenerPolicyOptions struct { + // The load balancer identifier. + LoadBalancerID *string `json:"load_balancer_id" validate:"required,ne="` + + // The listener identifier. + ListenerID *string `json:"listener_id" validate:"required,ne="` + + // The policy identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetLoadBalancerListenerPolicyOptions : Instantiate GetLoadBalancerListenerPolicyOptions +func (*VpcV1) NewGetLoadBalancerListenerPolicyOptions(loadBalancerID string, listenerID string, id string) *GetLoadBalancerListenerPolicyOptions { + return &GetLoadBalancerListenerPolicyOptions{ + LoadBalancerID: core.StringPtr(loadBalancerID), + ListenerID: core.StringPtr(listenerID), + ID: core.StringPtr(id), + } +} + +// SetLoadBalancerID : Allow user to set LoadBalancerID +func (_options *GetLoadBalancerListenerPolicyOptions) SetLoadBalancerID(loadBalancerID string) *GetLoadBalancerListenerPolicyOptions { + _options.LoadBalancerID = core.StringPtr(loadBalancerID) + return _options +} + +// SetListenerID : Allow user to set ListenerID +func (_options *GetLoadBalancerListenerPolicyOptions) SetListenerID(listenerID string) *GetLoadBalancerListenerPolicyOptions { + _options.ListenerID = core.StringPtr(listenerID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetLoadBalancerListenerPolicyOptions) SetID(id string) *GetLoadBalancerListenerPolicyOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetLoadBalancerListenerPolicyOptions) SetHeaders(param map[string]string) *GetLoadBalancerListenerPolicyOptions { + options.Headers = param + return options +} + +// GetLoadBalancerListenerPolicyRuleOptions : The GetLoadBalancerListenerPolicyRule options. +type GetLoadBalancerListenerPolicyRuleOptions struct { + // The load balancer identifier. + LoadBalancerID *string `json:"load_balancer_id" validate:"required,ne="` + + // The listener identifier. + ListenerID *string `json:"listener_id" validate:"required,ne="` + + // The policy identifier. + PolicyID *string `json:"policy_id" validate:"required,ne="` + + // The rule identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetLoadBalancerListenerPolicyRuleOptions : Instantiate GetLoadBalancerListenerPolicyRuleOptions +func (*VpcV1) NewGetLoadBalancerListenerPolicyRuleOptions(loadBalancerID string, listenerID string, policyID string, id string) *GetLoadBalancerListenerPolicyRuleOptions { + return &GetLoadBalancerListenerPolicyRuleOptions{ + LoadBalancerID: core.StringPtr(loadBalancerID), + ListenerID: core.StringPtr(listenerID), + PolicyID: core.StringPtr(policyID), + ID: core.StringPtr(id), + } +} + +// SetLoadBalancerID : Allow user to set LoadBalancerID +func (_options *GetLoadBalancerListenerPolicyRuleOptions) SetLoadBalancerID(loadBalancerID string) *GetLoadBalancerListenerPolicyRuleOptions { + _options.LoadBalancerID = core.StringPtr(loadBalancerID) + return _options +} + +// SetListenerID : Allow user to set ListenerID +func (_options *GetLoadBalancerListenerPolicyRuleOptions) SetListenerID(listenerID string) *GetLoadBalancerListenerPolicyRuleOptions { + _options.ListenerID = core.StringPtr(listenerID) + return _options +} + +// SetPolicyID : Allow user to set PolicyID +func (_options *GetLoadBalancerListenerPolicyRuleOptions) SetPolicyID(policyID string) *GetLoadBalancerListenerPolicyRuleOptions { + _options.PolicyID = core.StringPtr(policyID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetLoadBalancerListenerPolicyRuleOptions) SetID(id string) *GetLoadBalancerListenerPolicyRuleOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetLoadBalancerListenerPolicyRuleOptions) SetHeaders(param map[string]string) *GetLoadBalancerListenerPolicyRuleOptions { + options.Headers = param + return options +} + +// GetLoadBalancerOptions : The GetLoadBalancer options. +type GetLoadBalancerOptions struct { + // The load balancer identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetLoadBalancerOptions : Instantiate GetLoadBalancerOptions +func (*VpcV1) NewGetLoadBalancerOptions(id string) *GetLoadBalancerOptions { + return &GetLoadBalancerOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetLoadBalancerOptions) SetID(id string) *GetLoadBalancerOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetLoadBalancerOptions) SetHeaders(param map[string]string) *GetLoadBalancerOptions { + options.Headers = param + return options +} + +// GetLoadBalancerPoolMemberOptions : The GetLoadBalancerPoolMember options. +type GetLoadBalancerPoolMemberOptions struct { + // The load balancer identifier. + LoadBalancerID *string `json:"load_balancer_id" validate:"required,ne="` + + // The pool identifier. + PoolID *string `json:"pool_id" validate:"required,ne="` + + // The member identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetLoadBalancerPoolMemberOptions : Instantiate GetLoadBalancerPoolMemberOptions +func (*VpcV1) NewGetLoadBalancerPoolMemberOptions(loadBalancerID string, poolID string, id string) *GetLoadBalancerPoolMemberOptions { + return &GetLoadBalancerPoolMemberOptions{ + LoadBalancerID: core.StringPtr(loadBalancerID), + PoolID: core.StringPtr(poolID), + ID: core.StringPtr(id), + } +} + +// SetLoadBalancerID : Allow user to set LoadBalancerID +func (_options *GetLoadBalancerPoolMemberOptions) SetLoadBalancerID(loadBalancerID string) *GetLoadBalancerPoolMemberOptions { + _options.LoadBalancerID = core.StringPtr(loadBalancerID) + return _options +} + +// SetPoolID : Allow user to set PoolID +func (_options *GetLoadBalancerPoolMemberOptions) SetPoolID(poolID string) *GetLoadBalancerPoolMemberOptions { + _options.PoolID = core.StringPtr(poolID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetLoadBalancerPoolMemberOptions) SetID(id string) *GetLoadBalancerPoolMemberOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetLoadBalancerPoolMemberOptions) SetHeaders(param map[string]string) *GetLoadBalancerPoolMemberOptions { + options.Headers = param + return options +} + +// GetLoadBalancerPoolOptions : The GetLoadBalancerPool options. +type GetLoadBalancerPoolOptions struct { + // The load balancer identifier. + LoadBalancerID *string `json:"load_balancer_id" validate:"required,ne="` + + // The pool identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetLoadBalancerPoolOptions : Instantiate GetLoadBalancerPoolOptions +func (*VpcV1) NewGetLoadBalancerPoolOptions(loadBalancerID string, id string) *GetLoadBalancerPoolOptions { + return &GetLoadBalancerPoolOptions{ + LoadBalancerID: core.StringPtr(loadBalancerID), + ID: core.StringPtr(id), + } +} + +// SetLoadBalancerID : Allow user to set LoadBalancerID +func (_options *GetLoadBalancerPoolOptions) SetLoadBalancerID(loadBalancerID string) *GetLoadBalancerPoolOptions { + _options.LoadBalancerID = core.StringPtr(loadBalancerID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetLoadBalancerPoolOptions) SetID(id string) *GetLoadBalancerPoolOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetLoadBalancerPoolOptions) SetHeaders(param map[string]string) *GetLoadBalancerPoolOptions { + options.Headers = param + return options +} + +// GetLoadBalancerProfileOptions : The GetLoadBalancerProfile options. +type GetLoadBalancerProfileOptions struct { + // The load balancer profile name. + Name *string `json:"name" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetLoadBalancerProfileOptions : Instantiate GetLoadBalancerProfileOptions +func (*VpcV1) NewGetLoadBalancerProfileOptions(name string) *GetLoadBalancerProfileOptions { + return &GetLoadBalancerProfileOptions{ + Name: core.StringPtr(name), + } +} + +// SetName : Allow user to set Name +func (_options *GetLoadBalancerProfileOptions) SetName(name string) *GetLoadBalancerProfileOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetLoadBalancerProfileOptions) SetHeaders(param map[string]string) *GetLoadBalancerProfileOptions { + options.Headers = param + return options +} + +// GetLoadBalancerStatisticsOptions : The GetLoadBalancerStatistics options. +type GetLoadBalancerStatisticsOptions struct { + // The load balancer identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetLoadBalancerStatisticsOptions : Instantiate GetLoadBalancerStatisticsOptions +func (*VpcV1) NewGetLoadBalancerStatisticsOptions(id string) *GetLoadBalancerStatisticsOptions { + return &GetLoadBalancerStatisticsOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetLoadBalancerStatisticsOptions) SetID(id string) *GetLoadBalancerStatisticsOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetLoadBalancerStatisticsOptions) SetHeaders(param map[string]string) *GetLoadBalancerStatisticsOptions { + options.Headers = param + return options +} + +// GetNetworkACLOptions : The GetNetworkACL options. +type GetNetworkACLOptions struct { + // The network ACL identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetNetworkACLOptions : Instantiate GetNetworkACLOptions +func (*VpcV1) NewGetNetworkACLOptions(id string) *GetNetworkACLOptions { + return &GetNetworkACLOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetNetworkACLOptions) SetID(id string) *GetNetworkACLOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetNetworkACLOptions) SetHeaders(param map[string]string) *GetNetworkACLOptions { + options.Headers = param + return options +} + +// GetNetworkACLRuleOptions : The GetNetworkACLRule options. +type GetNetworkACLRuleOptions struct { + // The network ACL identifier. + NetworkACLID *string `json:"network_acl_id" validate:"required,ne="` + + // The rule identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetNetworkACLRuleOptions : Instantiate GetNetworkACLRuleOptions +func (*VpcV1) NewGetNetworkACLRuleOptions(networkACLID string, id string) *GetNetworkACLRuleOptions { + return &GetNetworkACLRuleOptions{ + NetworkACLID: core.StringPtr(networkACLID), + ID: core.StringPtr(id), + } +} + +// SetNetworkACLID : Allow user to set NetworkACLID +func (_options *GetNetworkACLRuleOptions) SetNetworkACLID(networkACLID string) *GetNetworkACLRuleOptions { + _options.NetworkACLID = core.StringPtr(networkACLID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetNetworkACLRuleOptions) SetID(id string) *GetNetworkACLRuleOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetNetworkACLRuleOptions) SetHeaders(param map[string]string) *GetNetworkACLRuleOptions { + options.Headers = param + return options +} + +// GetOperatingSystemOptions : The GetOperatingSystem options. +type GetOperatingSystemOptions struct { + // The operating system name. + Name *string `json:"name" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetOperatingSystemOptions : Instantiate GetOperatingSystemOptions +func (*VpcV1) NewGetOperatingSystemOptions(name string) *GetOperatingSystemOptions { + return &GetOperatingSystemOptions{ + Name: core.StringPtr(name), + } +} + +// SetName : Allow user to set Name +func (_options *GetOperatingSystemOptions) SetName(name string) *GetOperatingSystemOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetOperatingSystemOptions) SetHeaders(param map[string]string) *GetOperatingSystemOptions { + options.Headers = param + return options +} + +// GetPlacementGroupOptions : The GetPlacementGroup options. +type GetPlacementGroupOptions struct { + // The placement group identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetPlacementGroupOptions : Instantiate GetPlacementGroupOptions +func (*VpcV1) NewGetPlacementGroupOptions(id string) *GetPlacementGroupOptions { + return &GetPlacementGroupOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetPlacementGroupOptions) SetID(id string) *GetPlacementGroupOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetPlacementGroupOptions) SetHeaders(param map[string]string) *GetPlacementGroupOptions { + options.Headers = param + return options +} + +// GetPublicGatewayOptions : The GetPublicGateway options. +type GetPublicGatewayOptions struct { + // The public gateway identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetPublicGatewayOptions : Instantiate GetPublicGatewayOptions +func (*VpcV1) NewGetPublicGatewayOptions(id string) *GetPublicGatewayOptions { + return &GetPublicGatewayOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetPublicGatewayOptions) SetID(id string) *GetPublicGatewayOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetPublicGatewayOptions) SetHeaders(param map[string]string) *GetPublicGatewayOptions { + options.Headers = param + return options +} + +// GetRegionOptions : The GetRegion options. +type GetRegionOptions struct { + // The region name. + Name *string `json:"name" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetRegionOptions : Instantiate GetRegionOptions +func (*VpcV1) NewGetRegionOptions(name string) *GetRegionOptions { + return &GetRegionOptions{ + Name: core.StringPtr(name), + } +} + +// SetName : Allow user to set Name +func (_options *GetRegionOptions) SetName(name string) *GetRegionOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetRegionOptions) SetHeaders(param map[string]string) *GetRegionOptions { + options.Headers = param + return options +} + +// GetRegionZoneOptions : The GetRegionZone options. +type GetRegionZoneOptions struct { + // The region name. + RegionName *string `json:"region_name" validate:"required,ne="` + + // The zone name. + Name *string `json:"name" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetRegionZoneOptions : Instantiate GetRegionZoneOptions +func (*VpcV1) NewGetRegionZoneOptions(regionName string, name string) *GetRegionZoneOptions { + return &GetRegionZoneOptions{ + RegionName: core.StringPtr(regionName), + Name: core.StringPtr(name), + } +} + +// SetRegionName : Allow user to set RegionName +func (_options *GetRegionZoneOptions) SetRegionName(regionName string) *GetRegionZoneOptions { + _options.RegionName = core.StringPtr(regionName) + return _options +} + +// SetName : Allow user to set Name +func (_options *GetRegionZoneOptions) SetName(name string) *GetRegionZoneOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetRegionZoneOptions) SetHeaders(param map[string]string) *GetRegionZoneOptions { + options.Headers = param + return options +} + +// GetSecurityGroupOptions : The GetSecurityGroup options. +type GetSecurityGroupOptions struct { + // The security group identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetSecurityGroupOptions : Instantiate GetSecurityGroupOptions +func (*VpcV1) NewGetSecurityGroupOptions(id string) *GetSecurityGroupOptions { + return &GetSecurityGroupOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetSecurityGroupOptions) SetID(id string) *GetSecurityGroupOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetSecurityGroupOptions) SetHeaders(param map[string]string) *GetSecurityGroupOptions { + options.Headers = param + return options +} + +// GetSecurityGroupRuleOptions : The GetSecurityGroupRule options. +type GetSecurityGroupRuleOptions struct { + // The security group identifier. + SecurityGroupID *string `json:"security_group_id" validate:"required,ne="` + + // The rule identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetSecurityGroupRuleOptions : Instantiate GetSecurityGroupRuleOptions +func (*VpcV1) NewGetSecurityGroupRuleOptions(securityGroupID string, id string) *GetSecurityGroupRuleOptions { + return &GetSecurityGroupRuleOptions{ + SecurityGroupID: core.StringPtr(securityGroupID), + ID: core.StringPtr(id), + } +} + +// SetSecurityGroupID : Allow user to set SecurityGroupID +func (_options *GetSecurityGroupRuleOptions) SetSecurityGroupID(securityGroupID string) *GetSecurityGroupRuleOptions { + _options.SecurityGroupID = core.StringPtr(securityGroupID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetSecurityGroupRuleOptions) SetID(id string) *GetSecurityGroupRuleOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetSecurityGroupRuleOptions) SetHeaders(param map[string]string) *GetSecurityGroupRuleOptions { + options.Headers = param + return options +} + +// GetSecurityGroupTargetOptions : The GetSecurityGroupTarget options. +type GetSecurityGroupTargetOptions struct { + // The security group identifier. + SecurityGroupID *string `json:"security_group_id" validate:"required,ne="` + + // The security group target identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetSecurityGroupTargetOptions : Instantiate GetSecurityGroupTargetOptions +func (*VpcV1) NewGetSecurityGroupTargetOptions(securityGroupID string, id string) *GetSecurityGroupTargetOptions { + return &GetSecurityGroupTargetOptions{ + SecurityGroupID: core.StringPtr(securityGroupID), + ID: core.StringPtr(id), + } +} + +// SetSecurityGroupID : Allow user to set SecurityGroupID +func (_options *GetSecurityGroupTargetOptions) SetSecurityGroupID(securityGroupID string) *GetSecurityGroupTargetOptions { + _options.SecurityGroupID = core.StringPtr(securityGroupID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetSecurityGroupTargetOptions) SetID(id string) *GetSecurityGroupTargetOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetSecurityGroupTargetOptions) SetHeaders(param map[string]string) *GetSecurityGroupTargetOptions { + options.Headers = param + return options +} + +// GetShareMountTargetOptions : The GetShareMountTarget options. +type GetShareMountTargetOptions struct { + // The file share identifier. + ShareID *string `json:"share_id" validate:"required,ne="` + + // The share mount target identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetShareMountTargetOptions : Instantiate GetShareMountTargetOptions +func (*VpcV1) NewGetShareMountTargetOptions(shareID string, id string) *GetShareMountTargetOptions { + return &GetShareMountTargetOptions{ + ShareID: core.StringPtr(shareID), + ID: core.StringPtr(id), + } +} + +// SetShareID : Allow user to set ShareID +func (_options *GetShareMountTargetOptions) SetShareID(shareID string) *GetShareMountTargetOptions { + _options.ShareID = core.StringPtr(shareID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetShareMountTargetOptions) SetID(id string) *GetShareMountTargetOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetShareMountTargetOptions) SetHeaders(param map[string]string) *GetShareMountTargetOptions { + options.Headers = param + return options +} + +// GetShareOptions : The GetShare options. +type GetShareOptions struct { + // The file share identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetShareOptions : Instantiate GetShareOptions +func (*VpcV1) NewGetShareOptions(id string) *GetShareOptions { + return &GetShareOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetShareOptions) SetID(id string) *GetShareOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetShareOptions) SetHeaders(param map[string]string) *GetShareOptions { + options.Headers = param + return options +} + +// GetShareProfileOptions : The GetShareProfile options. +type GetShareProfileOptions struct { + // The file share profile name. + Name *string `json:"name" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetShareProfileOptions : Instantiate GetShareProfileOptions +func (*VpcV1) NewGetShareProfileOptions(name string) *GetShareProfileOptions { + return &GetShareProfileOptions{ + Name: core.StringPtr(name), + } +} + +// SetName : Allow user to set Name +func (_options *GetShareProfileOptions) SetName(name string) *GetShareProfileOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetShareProfileOptions) SetHeaders(param map[string]string) *GetShareProfileOptions { + options.Headers = param + return options +} + +// GetShareSourceOptions : The GetShareSource options. +type GetShareSourceOptions struct { + // The file share identifier. + ShareID *string `json:"share_id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetShareSourceOptions : Instantiate GetShareSourceOptions +func (*VpcV1) NewGetShareSourceOptions(shareID string) *GetShareSourceOptions { + return &GetShareSourceOptions{ + ShareID: core.StringPtr(shareID), + } +} + +// SetShareID : Allow user to set ShareID +func (_options *GetShareSourceOptions) SetShareID(shareID string) *GetShareSourceOptions { + _options.ShareID = core.StringPtr(shareID) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetShareSourceOptions) SetHeaders(param map[string]string) *GetShareSourceOptions { + options.Headers = param + return options +} + +// GetSnapshotCloneOptions : The GetSnapshotClone options. +type GetSnapshotCloneOptions struct { + // The snapshot identifier. + ID *string `json:"id" validate:"required,ne="` + + // The zone name. + ZoneName *string `json:"zone_name" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetSnapshotCloneOptions : Instantiate GetSnapshotCloneOptions +func (*VpcV1) NewGetSnapshotCloneOptions(id string, zoneName string) *GetSnapshotCloneOptions { + return &GetSnapshotCloneOptions{ + ID: core.StringPtr(id), + ZoneName: core.StringPtr(zoneName), + } +} + +// SetID : Allow user to set ID +func (_options *GetSnapshotCloneOptions) SetID(id string) *GetSnapshotCloneOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetZoneName : Allow user to set ZoneName +func (_options *GetSnapshotCloneOptions) SetZoneName(zoneName string) *GetSnapshotCloneOptions { + _options.ZoneName = core.StringPtr(zoneName) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetSnapshotCloneOptions) SetHeaders(param map[string]string) *GetSnapshotCloneOptions { + options.Headers = param + return options +} + +// GetSnapshotOptions : The GetSnapshot options. +type GetSnapshotOptions struct { + // The snapshot identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetSnapshotOptions : Instantiate GetSnapshotOptions +func (*VpcV1) NewGetSnapshotOptions(id string) *GetSnapshotOptions { + return &GetSnapshotOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetSnapshotOptions) SetID(id string) *GetSnapshotOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetSnapshotOptions) SetHeaders(param map[string]string) *GetSnapshotOptions { + options.Headers = param + return options +} + +// GetSubnetNetworkACLOptions : The GetSubnetNetworkACL options. +type GetSubnetNetworkACLOptions struct { + // The subnet identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetSubnetNetworkACLOptions : Instantiate GetSubnetNetworkACLOptions +func (*VpcV1) NewGetSubnetNetworkACLOptions(id string) *GetSubnetNetworkACLOptions { + return &GetSubnetNetworkACLOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetSubnetNetworkACLOptions) SetID(id string) *GetSubnetNetworkACLOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetSubnetNetworkACLOptions) SetHeaders(param map[string]string) *GetSubnetNetworkACLOptions { + options.Headers = param + return options +} + +// GetSubnetOptions : The GetSubnet options. +type GetSubnetOptions struct { + // The subnet identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetSubnetOptions : Instantiate GetSubnetOptions +func (*VpcV1) NewGetSubnetOptions(id string) *GetSubnetOptions { + return &GetSubnetOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetSubnetOptions) SetID(id string) *GetSubnetOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetSubnetOptions) SetHeaders(param map[string]string) *GetSubnetOptions { + options.Headers = param + return options +} + +// GetSubnetPublicGatewayOptions : The GetSubnetPublicGateway options. +type GetSubnetPublicGatewayOptions struct { + // The subnet identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetSubnetPublicGatewayOptions : Instantiate GetSubnetPublicGatewayOptions +func (*VpcV1) NewGetSubnetPublicGatewayOptions(id string) *GetSubnetPublicGatewayOptions { + return &GetSubnetPublicGatewayOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetSubnetPublicGatewayOptions) SetID(id string) *GetSubnetPublicGatewayOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetSubnetPublicGatewayOptions) SetHeaders(param map[string]string) *GetSubnetPublicGatewayOptions { + options.Headers = param + return options +} + +// GetSubnetReservedIPOptions : The GetSubnetReservedIP options. +type GetSubnetReservedIPOptions struct { + // The subnet identifier. + SubnetID *string `json:"subnet_id" validate:"required,ne="` + + // The reserved IP identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetSubnetReservedIPOptions : Instantiate GetSubnetReservedIPOptions +func (*VpcV1) NewGetSubnetReservedIPOptions(subnetID string, id string) *GetSubnetReservedIPOptions { + return &GetSubnetReservedIPOptions{ + SubnetID: core.StringPtr(subnetID), + ID: core.StringPtr(id), + } +} + +// SetSubnetID : Allow user to set SubnetID +func (_options *GetSubnetReservedIPOptions) SetSubnetID(subnetID string) *GetSubnetReservedIPOptions { + _options.SubnetID = core.StringPtr(subnetID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetSubnetReservedIPOptions) SetID(id string) *GetSubnetReservedIPOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetSubnetReservedIPOptions) SetHeaders(param map[string]string) *GetSubnetReservedIPOptions { + options.Headers = param + return options +} + +// GetSubnetRoutingTableOptions : The GetSubnetRoutingTable options. +type GetSubnetRoutingTableOptions struct { + // The subnet identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetSubnetRoutingTableOptions : Instantiate GetSubnetRoutingTableOptions +func (*VpcV1) NewGetSubnetRoutingTableOptions(id string) *GetSubnetRoutingTableOptions { + return &GetSubnetRoutingTableOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetSubnetRoutingTableOptions) SetID(id string) *GetSubnetRoutingTableOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetSubnetRoutingTableOptions) SetHeaders(param map[string]string) *GetSubnetRoutingTableOptions { + options.Headers = param + return options +} + +// GetVirtualNetworkInterfaceOptions : The GetVirtualNetworkInterface options. +type GetVirtualNetworkInterfaceOptions struct { + // The virtual network interface identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetVirtualNetworkInterfaceOptions : Instantiate GetVirtualNetworkInterfaceOptions +func (*VpcV1) NewGetVirtualNetworkInterfaceOptions(id string) *GetVirtualNetworkInterfaceOptions { + return &GetVirtualNetworkInterfaceOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetVirtualNetworkInterfaceOptions) SetID(id string) *GetVirtualNetworkInterfaceOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetVirtualNetworkInterfaceOptions) SetHeaders(param map[string]string) *GetVirtualNetworkInterfaceOptions { + options.Headers = param + return options +} + +// GetVolumeOptions : The GetVolume options. +type GetVolumeOptions struct { + // The volume identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetVolumeOptions : Instantiate GetVolumeOptions +func (*VpcV1) NewGetVolumeOptions(id string) *GetVolumeOptions { + return &GetVolumeOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetVolumeOptions) SetID(id string) *GetVolumeOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetVolumeOptions) SetHeaders(param map[string]string) *GetVolumeOptions { + options.Headers = param + return options +} + +// GetVolumeProfileOptions : The GetVolumeProfile options. +type GetVolumeProfileOptions struct { + // The volume profile name. + Name *string `json:"name" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetVolumeProfileOptions : Instantiate GetVolumeProfileOptions +func (*VpcV1) NewGetVolumeProfileOptions(name string) *GetVolumeProfileOptions { + return &GetVolumeProfileOptions{ + Name: core.StringPtr(name), + } +} + +// SetName : Allow user to set Name +func (_options *GetVolumeProfileOptions) SetName(name string) *GetVolumeProfileOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetVolumeProfileOptions) SetHeaders(param map[string]string) *GetVolumeProfileOptions { + options.Headers = param + return options +} + +// GetVPCAddressPrefixOptions : The GetVPCAddressPrefix options. +type GetVPCAddressPrefixOptions struct { + // The VPC identifier. + VPCID *string `json:"vpc_id" validate:"required,ne="` + + // The prefix identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetVPCAddressPrefixOptions : Instantiate GetVPCAddressPrefixOptions +func (*VpcV1) NewGetVPCAddressPrefixOptions(vpcID string, id string) *GetVPCAddressPrefixOptions { + return &GetVPCAddressPrefixOptions{ + VPCID: core.StringPtr(vpcID), + ID: core.StringPtr(id), + } +} + +// SetVPCID : Allow user to set VPCID +func (_options *GetVPCAddressPrefixOptions) SetVPCID(vpcID string) *GetVPCAddressPrefixOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetVPCAddressPrefixOptions) SetID(id string) *GetVPCAddressPrefixOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetVPCAddressPrefixOptions) SetHeaders(param map[string]string) *GetVPCAddressPrefixOptions { + options.Headers = param + return options +} + +// GetVPCDefaultNetworkACLOptions : The GetVPCDefaultNetworkACL options. +type GetVPCDefaultNetworkACLOptions struct { + // The VPC identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetVPCDefaultNetworkACLOptions : Instantiate GetVPCDefaultNetworkACLOptions +func (*VpcV1) NewGetVPCDefaultNetworkACLOptions(id string) *GetVPCDefaultNetworkACLOptions { + return &GetVPCDefaultNetworkACLOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetVPCDefaultNetworkACLOptions) SetID(id string) *GetVPCDefaultNetworkACLOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetVPCDefaultNetworkACLOptions) SetHeaders(param map[string]string) *GetVPCDefaultNetworkACLOptions { + options.Headers = param + return options +} + +// GetVPCDefaultRoutingTableOptions : The GetVPCDefaultRoutingTable options. +type GetVPCDefaultRoutingTableOptions struct { + // The VPC identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetVPCDefaultRoutingTableOptions : Instantiate GetVPCDefaultRoutingTableOptions +func (*VpcV1) NewGetVPCDefaultRoutingTableOptions(id string) *GetVPCDefaultRoutingTableOptions { + return &GetVPCDefaultRoutingTableOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetVPCDefaultRoutingTableOptions) SetID(id string) *GetVPCDefaultRoutingTableOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetVPCDefaultRoutingTableOptions) SetHeaders(param map[string]string) *GetVPCDefaultRoutingTableOptions { + options.Headers = param + return options +} + +// GetVPCDefaultSecurityGroupOptions : The GetVPCDefaultSecurityGroup options. +type GetVPCDefaultSecurityGroupOptions struct { + // The VPC identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetVPCDefaultSecurityGroupOptions : Instantiate GetVPCDefaultSecurityGroupOptions +func (*VpcV1) NewGetVPCDefaultSecurityGroupOptions(id string) *GetVPCDefaultSecurityGroupOptions { + return &GetVPCDefaultSecurityGroupOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetVPCDefaultSecurityGroupOptions) SetID(id string) *GetVPCDefaultSecurityGroupOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetVPCDefaultSecurityGroupOptions) SetHeaders(param map[string]string) *GetVPCDefaultSecurityGroupOptions { + options.Headers = param + return options +} + +// GetVPCDnsResolutionBindingOptions : The GetVPCDnsResolutionBinding options. +type GetVPCDnsResolutionBindingOptions struct { + // The VPC identifier. + VPCID *string `json:"vpc_id" validate:"required,ne="` + + // The DNS resolution binding identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetVPCDnsResolutionBindingOptions : Instantiate GetVPCDnsResolutionBindingOptions +func (*VpcV1) NewGetVPCDnsResolutionBindingOptions(vpcID string, id string) *GetVPCDnsResolutionBindingOptions { + return &GetVPCDnsResolutionBindingOptions{ + VPCID: core.StringPtr(vpcID), + ID: core.StringPtr(id), + } +} + +// SetVPCID : Allow user to set VPCID +func (_options *GetVPCDnsResolutionBindingOptions) SetVPCID(vpcID string) *GetVPCDnsResolutionBindingOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetVPCDnsResolutionBindingOptions) SetID(id string) *GetVPCDnsResolutionBindingOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetVPCDnsResolutionBindingOptions) SetHeaders(param map[string]string) *GetVPCDnsResolutionBindingOptions { + options.Headers = param + return options +} + +// GetVPCOptions : The GetVPC options. +type GetVPCOptions struct { + // The VPC identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetVPCOptions : Instantiate GetVPCOptions +func (*VpcV1) NewGetVPCOptions(id string) *GetVPCOptions { + return &GetVPCOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetVPCOptions) SetID(id string) *GetVPCOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetVPCOptions) SetHeaders(param map[string]string) *GetVPCOptions { + options.Headers = param + return options +} + +// GetVPCRouteOptions : The GetVPCRoute options. +type GetVPCRouteOptions struct { + // The VPC identifier. + VPCID *string `json:"vpc_id" validate:"required,ne="` + + // The route identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetVPCRouteOptions : Instantiate GetVPCRouteOptions +func (*VpcV1) NewGetVPCRouteOptions(vpcID string, id string) *GetVPCRouteOptions { + return &GetVPCRouteOptions{ + VPCID: core.StringPtr(vpcID), + ID: core.StringPtr(id), + } +} + +// SetVPCID : Allow user to set VPCID +func (_options *GetVPCRouteOptions) SetVPCID(vpcID string) *GetVPCRouteOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetVPCRouteOptions) SetID(id string) *GetVPCRouteOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetVPCRouteOptions) SetHeaders(param map[string]string) *GetVPCRouteOptions { + options.Headers = param + return options +} + +// GetVPCRoutingTableOptions : The GetVPCRoutingTable options. +type GetVPCRoutingTableOptions struct { + // The VPC identifier. + VPCID *string `json:"vpc_id" validate:"required,ne="` + + // The routing table identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetVPCRoutingTableOptions : Instantiate GetVPCRoutingTableOptions +func (*VpcV1) NewGetVPCRoutingTableOptions(vpcID string, id string) *GetVPCRoutingTableOptions { + return &GetVPCRoutingTableOptions{ + VPCID: core.StringPtr(vpcID), + ID: core.StringPtr(id), + } +} + +// SetVPCID : Allow user to set VPCID +func (_options *GetVPCRoutingTableOptions) SetVPCID(vpcID string) *GetVPCRoutingTableOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetVPCRoutingTableOptions) SetID(id string) *GetVPCRoutingTableOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetVPCRoutingTableOptions) SetHeaders(param map[string]string) *GetVPCRoutingTableOptions { + options.Headers = param + return options +} + +// GetVPCRoutingTableRouteOptions : The GetVPCRoutingTableRoute options. +type GetVPCRoutingTableRouteOptions struct { + // The VPC identifier. + VPCID *string `json:"vpc_id" validate:"required,ne="` + + // The routing table identifier. + RoutingTableID *string `json:"routing_table_id" validate:"required,ne="` + + // The VPC routing table route identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetVPCRoutingTableRouteOptions : Instantiate GetVPCRoutingTableRouteOptions +func (*VpcV1) NewGetVPCRoutingTableRouteOptions(vpcID string, routingTableID string, id string) *GetVPCRoutingTableRouteOptions { + return &GetVPCRoutingTableRouteOptions{ + VPCID: core.StringPtr(vpcID), + RoutingTableID: core.StringPtr(routingTableID), + ID: core.StringPtr(id), + } +} + +// SetVPCID : Allow user to set VPCID +func (_options *GetVPCRoutingTableRouteOptions) SetVPCID(vpcID string) *GetVPCRoutingTableRouteOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetRoutingTableID : Allow user to set RoutingTableID +func (_options *GetVPCRoutingTableRouteOptions) SetRoutingTableID(routingTableID string) *GetVPCRoutingTableRouteOptions { + _options.RoutingTableID = core.StringPtr(routingTableID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetVPCRoutingTableRouteOptions) SetID(id string) *GetVPCRoutingTableRouteOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetVPCRoutingTableRouteOptions) SetHeaders(param map[string]string) *GetVPCRoutingTableRouteOptions { + options.Headers = param + return options +} + +// GetVPNGatewayConnectionOptions : The GetVPNGatewayConnection options. +type GetVPNGatewayConnectionOptions struct { + // The VPN gateway identifier. + VPNGatewayID *string `json:"vpn_gateway_id" validate:"required,ne="` + + // The VPN gateway connection identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetVPNGatewayConnectionOptions : Instantiate GetVPNGatewayConnectionOptions +func (*VpcV1) NewGetVPNGatewayConnectionOptions(vpnGatewayID string, id string) *GetVPNGatewayConnectionOptions { + return &GetVPNGatewayConnectionOptions{ + VPNGatewayID: core.StringPtr(vpnGatewayID), + ID: core.StringPtr(id), + } +} + +// SetVPNGatewayID : Allow user to set VPNGatewayID +func (_options *GetVPNGatewayConnectionOptions) SetVPNGatewayID(vpnGatewayID string) *GetVPNGatewayConnectionOptions { + _options.VPNGatewayID = core.StringPtr(vpnGatewayID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetVPNGatewayConnectionOptions) SetID(id string) *GetVPNGatewayConnectionOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetVPNGatewayConnectionOptions) SetHeaders(param map[string]string) *GetVPNGatewayConnectionOptions { + options.Headers = param + return options +} + +// GetVPNGatewayOptions : The GetVPNGateway options. +type GetVPNGatewayOptions struct { + // The VPN gateway identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetVPNGatewayOptions : Instantiate GetVPNGatewayOptions +func (*VpcV1) NewGetVPNGatewayOptions(id string) *GetVPNGatewayOptions { + return &GetVPNGatewayOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetVPNGatewayOptions) SetID(id string) *GetVPNGatewayOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetVPNGatewayOptions) SetHeaders(param map[string]string) *GetVPNGatewayOptions { + options.Headers = param + return options +} + +// GetVPNServerClientConfigurationOptions : The GetVPNServerClientConfiguration options. +type GetVPNServerClientConfigurationOptions struct { + // The VPN server identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetVPNServerClientConfigurationOptions : Instantiate GetVPNServerClientConfigurationOptions +func (*VpcV1) NewGetVPNServerClientConfigurationOptions(id string) *GetVPNServerClientConfigurationOptions { + return &GetVPNServerClientConfigurationOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetVPNServerClientConfigurationOptions) SetID(id string) *GetVPNServerClientConfigurationOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetVPNServerClientConfigurationOptions) SetHeaders(param map[string]string) *GetVPNServerClientConfigurationOptions { + options.Headers = param + return options +} + +// GetVPNServerClientOptions : The GetVPNServerClient options. +type GetVPNServerClientOptions struct { + // The VPN server identifier. + VPNServerID *string `json:"vpn_server_id" validate:"required,ne="` + + // The VPN client identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetVPNServerClientOptions : Instantiate GetVPNServerClientOptions +func (*VpcV1) NewGetVPNServerClientOptions(vpnServerID string, id string) *GetVPNServerClientOptions { + return &GetVPNServerClientOptions{ + VPNServerID: core.StringPtr(vpnServerID), + ID: core.StringPtr(id), + } +} + +// SetVPNServerID : Allow user to set VPNServerID +func (_options *GetVPNServerClientOptions) SetVPNServerID(vpnServerID string) *GetVPNServerClientOptions { + _options.VPNServerID = core.StringPtr(vpnServerID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetVPNServerClientOptions) SetID(id string) *GetVPNServerClientOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetVPNServerClientOptions) SetHeaders(param map[string]string) *GetVPNServerClientOptions { + options.Headers = param + return options +} + +// GetVPNServerOptions : The GetVPNServer options. +type GetVPNServerOptions struct { + // The VPN server identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetVPNServerOptions : Instantiate GetVPNServerOptions +func (*VpcV1) NewGetVPNServerOptions(id string) *GetVPNServerOptions { + return &GetVPNServerOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *GetVPNServerOptions) SetID(id string) *GetVPNServerOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetVPNServerOptions) SetHeaders(param map[string]string) *GetVPNServerOptions { + options.Headers = param + return options +} + +// GetVPNServerRouteOptions : The GetVPNServerRoute options. +type GetVPNServerRouteOptions struct { + // The VPN server identifier. + VPNServerID *string `json:"vpn_server_id" validate:"required,ne="` + + // The VPN route identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewGetVPNServerRouteOptions : Instantiate GetVPNServerRouteOptions +func (*VpcV1) NewGetVPNServerRouteOptions(vpnServerID string, id string) *GetVPNServerRouteOptions { + return &GetVPNServerRouteOptions{ + VPNServerID: core.StringPtr(vpnServerID), + ID: core.StringPtr(id), + } +} + +// SetVPNServerID : Allow user to set VPNServerID +func (_options *GetVPNServerRouteOptions) SetVPNServerID(vpnServerID string) *GetVPNServerRouteOptions { + _options.VPNServerID = core.StringPtr(vpnServerID) + return _options +} + +// SetID : Allow user to set ID +func (_options *GetVPNServerRouteOptions) SetID(id string) *GetVPNServerRouteOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *GetVPNServerRouteOptions) SetHeaders(param map[string]string) *GetVPNServerRouteOptions { + options.Headers = param + return options +} + +// IkePolicy : IkePolicy struct +type IkePolicy struct { + // The authentication algorithm + // + // The `md5` and `sha1` algorithms have been deprecated. + AuthenticationAlgorithm *string `json:"authentication_algorithm" validate:"required"` + + // The VPN gateway connections that use this IKE policy. + Connections []VPNGatewayConnectionReference `json:"connections" validate:"required"` + + // The date and time that this IKE policy was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The Diffie-Hellman group + // + // Groups `2` and `5` have been deprecated. + DhGroup *int64 `json:"dh_group" validate:"required"` + + // The encryption algorithm + // + // The `triple_des` algorithm has been deprecated. + EncryptionAlgorithm *string `json:"encryption_algorithm" validate:"required"` + + // The IKE policy's canonical URL. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this IKE policy. + ID *string `json:"id" validate:"required"` + + // The IKE protocol version. + IkeVersion *int64 `json:"ike_version" validate:"required"` + + // The key lifetime in seconds. + KeyLifetime *int64 `json:"key_lifetime" validate:"required"` + + // The name for this IKE policy. The name is unique across all IKE policies in the region. + Name *string `json:"name" validate:"required"` + + // The IKE negotiation mode. Only `main` is supported. + NegotiationMode *string `json:"negotiation_mode" validate:"required"` + + // The resource group for this IKE policy. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the IkePolicy.AuthenticationAlgorithm property. +// The authentication algorithm +// +// The `md5` and `sha1` algorithms have been deprecated. +const ( + IkePolicyAuthenticationAlgorithmMd5Const = "md5" + IkePolicyAuthenticationAlgorithmSha1Const = "sha1" + IkePolicyAuthenticationAlgorithmSha256Const = "sha256" + IkePolicyAuthenticationAlgorithmSha384Const = "sha384" + IkePolicyAuthenticationAlgorithmSha512Const = "sha512" +) + +// Constants associated with the IkePolicy.EncryptionAlgorithm property. +// The encryption algorithm +// +// The `triple_des` algorithm has been deprecated. +const ( + IkePolicyEncryptionAlgorithmAes128Const = "aes128" + IkePolicyEncryptionAlgorithmAes192Const = "aes192" + IkePolicyEncryptionAlgorithmAes256Const = "aes256" + IkePolicyEncryptionAlgorithmTripleDesConst = "triple_des" +) + +// Constants associated with the IkePolicy.NegotiationMode property. +// The IKE negotiation mode. Only `main` is supported. +const ( + IkePolicyNegotiationModeMainConst = "main" +) + +// Constants associated with the IkePolicy.ResourceType property. +// The resource type. +const ( + IkePolicyResourceTypeIkePolicyConst = "ike_policy" +) + +// UnmarshalIkePolicy unmarshals an instance of IkePolicy from the specified map of raw messages. +func UnmarshalIkePolicy(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(IkePolicy) + err = core.UnmarshalPrimitive(m, "authentication_algorithm", &obj.AuthenticationAlgorithm) + if err != nil { + return + } + err = core.UnmarshalModel(m, "connections", &obj.Connections, UnmarshalVPNGatewayConnectionReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "dh_group", &obj.DhGroup) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "encryption_algorithm", &obj.EncryptionAlgorithm) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "ike_version", &obj.IkeVersion) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "key_lifetime", &obj.KeyLifetime) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "negotiation_mode", &obj.NegotiationMode) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// IkePolicyCollection : IkePolicyCollection struct +type IkePolicyCollection struct { + // A link to the first page of resources. + First *IkePolicyCollectionFirst `json:"first" validate:"required"` + + // Collection of IKE policies. + IkePolicies []IkePolicy `json:"ike_policies" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *IkePolicyCollectionNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalIkePolicyCollection unmarshals an instance of IkePolicyCollection from the specified map of raw messages. +func UnmarshalIkePolicyCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(IkePolicyCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalIkePolicyCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalModel(m, "ike_policies", &obj.IkePolicies, UnmarshalIkePolicy) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalIkePolicyCollectionNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *IkePolicyCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// IkePolicyPatch : IkePolicyPatch struct +type IkePolicyPatch struct { + // The authentication algorithm. + AuthenticationAlgorithm *string `json:"authentication_algorithm,omitempty"` + + // The Diffie-Hellman group. + DhGroup *int64 `json:"dh_group,omitempty"` + + // The encryption algorithm. + EncryptionAlgorithm *string `json:"encryption_algorithm,omitempty"` + + // The IKE protocol version. + IkeVersion *int64 `json:"ike_version,omitempty"` + + // The key lifetime in seconds. + KeyLifetime *int64 `json:"key_lifetime,omitempty"` + + // The name for this IKE policy. The name must not be used by another IKE policy in the region. + Name *string `json:"name,omitempty"` +} + +// Constants associated with the IkePolicyPatch.AuthenticationAlgorithm property. +// The authentication algorithm. +const ( + IkePolicyPatchAuthenticationAlgorithmSha256Const = "sha256" + IkePolicyPatchAuthenticationAlgorithmSha384Const = "sha384" + IkePolicyPatchAuthenticationAlgorithmSha512Const = "sha512" +) + +// Constants associated with the IkePolicyPatch.EncryptionAlgorithm property. +// The encryption algorithm. +const ( + IkePolicyPatchEncryptionAlgorithmAes128Const = "aes128" + IkePolicyPatchEncryptionAlgorithmAes192Const = "aes192" + IkePolicyPatchEncryptionAlgorithmAes256Const = "aes256" +) + +// UnmarshalIkePolicyPatch unmarshals an instance of IkePolicyPatch from the specified map of raw messages. +func UnmarshalIkePolicyPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(IkePolicyPatch) + err = core.UnmarshalPrimitive(m, "authentication_algorithm", &obj.AuthenticationAlgorithm) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "dh_group", &obj.DhGroup) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "encryption_algorithm", &obj.EncryptionAlgorithm) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "ike_version", &obj.IkeVersion) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "key_lifetime", &obj.KeyLifetime) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the IkePolicyPatch +func (ikePolicyPatch *IkePolicyPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(ikePolicyPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// IkePolicyReference : IkePolicyReference struct +type IkePolicyReference struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *IkePolicyReferenceDeleted `json:"deleted,omitempty"` + + // The IKE policy's canonical URL. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this IKE policy. + ID *string `json:"id" validate:"required"` + + // The name for this IKE policy. The name is unique across all IKE policies in the region. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the IkePolicyReference.ResourceType property. +// The resource type. +const ( + IkePolicyReferenceResourceTypeIkePolicyConst = "ike_policy" +) + +// UnmarshalIkePolicyReference unmarshals an instance of IkePolicyReference from the specified map of raw messages. +func UnmarshalIkePolicyReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(IkePolicyReference) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalIkePolicyReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// IP : IP struct +type IP struct { + // The IP address. + // + // This property may add support for IPv6 addresses in the future. When processing a value in this property, verify + // that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the + // error, or bypass the resource on which the unexpected IP address format was encountered. + Address *string `json:"address" validate:"required"` +} + +// NewIP : Instantiate IP (Generic Model Constructor) +func (*VpcV1) NewIP(address string) (_model *IP, err error) { + _model = &IP{ + Address: core.StringPtr(address), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalIP unmarshals an instance of IP from the specified map of raw messages. +func UnmarshalIP(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(IP) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// IPsecPolicy : IPsecPolicy struct +type IPsecPolicy struct { + // The authentication algorithm + // + // The `md5` and `sha1` algorithms have been deprecated + // + // Must be `disabled` if and only if the `encryption_algorithm` is + // `aes128gcm16`, `aes192gcm16`, or `aes256gcm16`. + AuthenticationAlgorithm *string `json:"authentication_algorithm" validate:"required"` + + // The VPN gateway connections that use this IPsec policy. + Connections []VPNGatewayConnectionReference `json:"connections" validate:"required"` + + // The date and time that this IPsec policy was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The encapsulation mode used. Only `tunnel` is supported. + EncapsulationMode *string `json:"encapsulation_mode" validate:"required"` + + // The encryption algorithm + // + // The `triple_des` algorithm has been deprecated + // + // The `authentication_algorithm` must be `disabled` if and only if + // `encryption_algorithm` is `aes128gcm16`, `aes192gcm16`, or + // `aes256gcm16`. + EncryptionAlgorithm *string `json:"encryption_algorithm" validate:"required"` + + // The IPsec policy's canonical URL. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this IPsec policy. + ID *string `json:"id" validate:"required"` + + // The key lifetime in seconds. + KeyLifetime *int64 `json:"key_lifetime" validate:"required"` + + // The name for this IPsec policy. The name is unique across all IPsec policies in the region. + Name *string `json:"name" validate:"required"` + + // Perfect Forward Secrecy + // + // Groups `group_2` and `group_5` have been deprecated. + Pfs *string `json:"pfs" validate:"required"` + + // The resource group for this IPsec policy. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The transform protocol used. Only `esp` is supported. + TransformProtocol *string `json:"transform_protocol" validate:"required"` +} + +// Constants associated with the IPsecPolicy.AuthenticationAlgorithm property. +// The authentication algorithm +// +// # The `md5` and `sha1` algorithms have been deprecated +// +// Must be `disabled` if and only if the `encryption_algorithm` is +// `aes128gcm16`, `aes192gcm16`, or `aes256gcm16`. +const ( + IPsecPolicyAuthenticationAlgorithmDisabledConst = "disabled" + IPsecPolicyAuthenticationAlgorithmMd5Const = "md5" + IPsecPolicyAuthenticationAlgorithmSha1Const = "sha1" + IPsecPolicyAuthenticationAlgorithmSha256Const = "sha256" + IPsecPolicyAuthenticationAlgorithmSha384Const = "sha384" + IPsecPolicyAuthenticationAlgorithmSha512Const = "sha512" +) + +// Constants associated with the IPsecPolicy.EncapsulationMode property. +// The encapsulation mode used. Only `tunnel` is supported. +const ( + IPsecPolicyEncapsulationModeTunnelConst = "tunnel" +) + +// Constants associated with the IPsecPolicy.EncryptionAlgorithm property. +// The encryption algorithm +// +// The `triple_des` algorithm has been deprecated +// +// The `authentication_algorithm` must be `disabled` if and only if +// `encryption_algorithm` is `aes128gcm16`, `aes192gcm16`, or +// `aes256gcm16`. +const ( + IPsecPolicyEncryptionAlgorithmAes128Const = "aes128" + IPsecPolicyEncryptionAlgorithmAes128gcm16Const = "aes128gcm16" + IPsecPolicyEncryptionAlgorithmAes192Const = "aes192" + IPsecPolicyEncryptionAlgorithmAes192gcm16Const = "aes192gcm16" + IPsecPolicyEncryptionAlgorithmAes256Const = "aes256" + IPsecPolicyEncryptionAlgorithmAes256gcm16Const = "aes256gcm16" + IPsecPolicyEncryptionAlgorithmTripleDesConst = "triple_des" +) + +// Constants associated with the IPsecPolicy.Pfs property. +// Perfect Forward Secrecy +// +// Groups `group_2` and `group_5` have been deprecated. +const ( + IPsecPolicyPfsDisabledConst = "disabled" + IPsecPolicyPfsGroup14Const = "group_14" + IPsecPolicyPfsGroup15Const = "group_15" + IPsecPolicyPfsGroup16Const = "group_16" + IPsecPolicyPfsGroup17Const = "group_17" + IPsecPolicyPfsGroup18Const = "group_18" + IPsecPolicyPfsGroup19Const = "group_19" + IPsecPolicyPfsGroup2Const = "group_2" + IPsecPolicyPfsGroup20Const = "group_20" + IPsecPolicyPfsGroup21Const = "group_21" + IPsecPolicyPfsGroup22Const = "group_22" + IPsecPolicyPfsGroup23Const = "group_23" + IPsecPolicyPfsGroup24Const = "group_24" + IPsecPolicyPfsGroup31Const = "group_31" + IPsecPolicyPfsGroup5Const = "group_5" +) + +// Constants associated with the IPsecPolicy.ResourceType property. +// The resource type. +const ( + IPsecPolicyResourceTypeIpsecPolicyConst = "ipsec_policy" +) + +// Constants associated with the IPsecPolicy.TransformProtocol property. +// The transform protocol used. Only `esp` is supported. +const ( + IPsecPolicyTransformProtocolEspConst = "esp" +) + +// UnmarshalIPsecPolicy unmarshals an instance of IPsecPolicy from the specified map of raw messages. +func UnmarshalIPsecPolicy(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(IPsecPolicy) + err = core.UnmarshalPrimitive(m, "authentication_algorithm", &obj.AuthenticationAlgorithm) + if err != nil { + return + } + err = core.UnmarshalModel(m, "connections", &obj.Connections, UnmarshalVPNGatewayConnectionReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "encapsulation_mode", &obj.EncapsulationMode) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "encryption_algorithm", &obj.EncryptionAlgorithm) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "key_lifetime", &obj.KeyLifetime) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "pfs", &obj.Pfs) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "transform_protocol", &obj.TransformProtocol) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// IPsecPolicyCollection : IPsecPolicyCollection struct +type IPsecPolicyCollection struct { + // A link to the first page of resources. + First *IPsecPolicyCollectionFirst `json:"first" validate:"required"` + + // Collection of IPsec policies. + IpsecPolicies []IPsecPolicy `json:"ipsec_policies" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *IPsecPolicyCollectionNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalIPsecPolicyCollection unmarshals an instance of IPsecPolicyCollection from the specified map of raw messages. +func UnmarshalIPsecPolicyCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(IPsecPolicyCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalIPsecPolicyCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalModel(m, "ipsec_policies", &obj.IpsecPolicies, UnmarshalIPsecPolicy) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalIPsecPolicyCollectionNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *IPsecPolicyCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// IPsecPolicyCollectionFirst : A link to the first page of resources. +type IPsecPolicyCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalIPsecPolicyCollectionFirst unmarshals an instance of IPsecPolicyCollectionFirst from the specified map of raw messages. +func UnmarshalIPsecPolicyCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(IPsecPolicyCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// IPsecPolicyCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type IPsecPolicyCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalIPsecPolicyCollectionNext unmarshals an instance of IPsecPolicyCollectionNext from the specified map of raw messages. +func UnmarshalIPsecPolicyCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(IPsecPolicyCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// IPsecPolicyPatch : IPsecPolicyPatch struct +type IPsecPolicyPatch struct { + // The authentication algorithm + // + // Must be `disabled` if and only if the `encryption_algorithm` is + // `aes128gcm16`, `aes192gcm16`, or `aes256gcm16`. + AuthenticationAlgorithm *string `json:"authentication_algorithm,omitempty"` + + // The encryption algorithm + // + // The `authentication_algorithm` must be `disabled` if and only if + // `encryption_algorithm` is `aes128gcm16`, `aes192gcm16`, or + // `aes256gcm16`. + EncryptionAlgorithm *string `json:"encryption_algorithm,omitempty"` + + // The key lifetime in seconds. + KeyLifetime *int64 `json:"key_lifetime,omitempty"` + + // The name for this IPsec policy. The name must not be used by another IPsec policy in the region. + Name *string `json:"name,omitempty"` + + // Perfect Forward Secrecy. + Pfs *string `json:"pfs,omitempty"` +} + +// Constants associated with the IPsecPolicyPatch.AuthenticationAlgorithm property. +// The authentication algorithm +// +// Must be `disabled` if and only if the `encryption_algorithm` is +// `aes128gcm16`, `aes192gcm16`, or `aes256gcm16`. +const ( + IPsecPolicyPatchAuthenticationAlgorithmDisabledConst = "disabled" + IPsecPolicyPatchAuthenticationAlgorithmSha256Const = "sha256" + IPsecPolicyPatchAuthenticationAlgorithmSha384Const = "sha384" + IPsecPolicyPatchAuthenticationAlgorithmSha512Const = "sha512" +) + +// Constants associated with the IPsecPolicyPatch.EncryptionAlgorithm property. +// The encryption algorithm +// +// The `authentication_algorithm` must be `disabled` if and only if +// `encryption_algorithm` is `aes128gcm16`, `aes192gcm16`, or +// `aes256gcm16`. +const ( + IPsecPolicyPatchEncryptionAlgorithmAes128Const = "aes128" + IPsecPolicyPatchEncryptionAlgorithmAes128gcm16Const = "aes128gcm16" + IPsecPolicyPatchEncryptionAlgorithmAes192Const = "aes192" + IPsecPolicyPatchEncryptionAlgorithmAes192gcm16Const = "aes192gcm16" + IPsecPolicyPatchEncryptionAlgorithmAes256Const = "aes256" + IPsecPolicyPatchEncryptionAlgorithmAes256gcm16Const = "aes256gcm16" +) + +// Constants associated with the IPsecPolicyPatch.Pfs property. +// Perfect Forward Secrecy. +const ( + IPsecPolicyPatchPfsDisabledConst = "disabled" + IPsecPolicyPatchPfsGroup14Const = "group_14" + IPsecPolicyPatchPfsGroup15Const = "group_15" + IPsecPolicyPatchPfsGroup16Const = "group_16" + IPsecPolicyPatchPfsGroup17Const = "group_17" + IPsecPolicyPatchPfsGroup18Const = "group_18" + IPsecPolicyPatchPfsGroup19Const = "group_19" + IPsecPolicyPatchPfsGroup20Const = "group_20" + IPsecPolicyPatchPfsGroup21Const = "group_21" + IPsecPolicyPatchPfsGroup22Const = "group_22" + IPsecPolicyPatchPfsGroup23Const = "group_23" + IPsecPolicyPatchPfsGroup24Const = "group_24" + IPsecPolicyPatchPfsGroup31Const = "group_31" +) + +// UnmarshalIPsecPolicyPatch unmarshals an instance of IPsecPolicyPatch from the specified map of raw messages. +func UnmarshalIPsecPolicyPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(IPsecPolicyPatch) + err = core.UnmarshalPrimitive(m, "authentication_algorithm", &obj.AuthenticationAlgorithm) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "encryption_algorithm", &obj.EncryptionAlgorithm) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "key_lifetime", &obj.KeyLifetime) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "pfs", &obj.Pfs) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the IPsecPolicyPatch +func (iPsecPolicyPatch *IPsecPolicyPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(iPsecPolicyPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// IPsecPolicyReference : IPsecPolicyReference struct +type IPsecPolicyReference struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *IPsecPolicyReferenceDeleted `json:"deleted,omitempty"` + + // The IPsec policy's canonical URL. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this IPsec policy. + ID *string `json:"id" validate:"required"` + + // The name for this IPsec policy. The name is unique across all IPsec policies in the region. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the IPsecPolicyReference.ResourceType property. +// The resource type. +const ( + IPsecPolicyReferenceResourceTypeIpsecPolicyConst = "ipsec_policy" +) + +// UnmarshalIPsecPolicyReference unmarshals an instance of IPsecPolicyReference from the specified map of raw messages. +func UnmarshalIPsecPolicyReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(IPsecPolicyReference) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalIPsecPolicyReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// IPsecPolicyReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type IPsecPolicyReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalIPsecPolicyReferenceDeleted unmarshals an instance of IPsecPolicyReferenceDeleted from the specified map of raw messages. +func UnmarshalIPsecPolicyReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(IPsecPolicyReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// IkePolicyCollectionFirst : A link to the first page of resources. +type IkePolicyCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalIkePolicyCollectionFirst unmarshals an instance of IkePolicyCollectionFirst from the specified map of raw messages. +func UnmarshalIkePolicyCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(IkePolicyCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// IkePolicyCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type IkePolicyCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalIkePolicyCollectionNext unmarshals an instance of IkePolicyCollectionNext from the specified map of raw messages. +func UnmarshalIkePolicyCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(IkePolicyCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// IkePolicyReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type IkePolicyReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalIkePolicyReferenceDeleted unmarshals an instance of IkePolicyReferenceDeleted from the specified map of raw messages. +func UnmarshalIkePolicyReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(IkePolicyReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Image : Image struct +type Image struct { + CatalogOffering *ImageCatalogOffering `json:"catalog_offering" validate:"required"` + + // The date and time that the image was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The CRN for this image. + CRN *string `json:"crn" validate:"required"` + + // The deprecation date and time (UTC) for this image. + // + // If absent, no deprecation date and time has been set. + DeprecationAt *strfmt.DateTime `json:"deprecation_at,omitempty"` + + // The type of encryption used on the image. + Encryption *string `json:"encryption" validate:"required"` + + // The key that will be used to encrypt volumes created from this image (unless an + // alternate `encryption_key` is specified at volume creation). + // + // This property will be present for images with an `encryption` type of `user_managed`. + EncryptionKey *EncryptionKeyReference `json:"encryption_key,omitempty"` + + // Details for the stored image file. + File *ImageFile `json:"file" validate:"required"` + + // The URL for this image. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this image. + ID *string `json:"id" validate:"required"` + + // The minimum size (in gigabytes) of a volume onto which this image may be provisioned. + // + // This property may be absent if the image has a `status` of `pending` or `failed`. + MinimumProvisionedSize *int64 `json:"minimum_provisioned_size,omitempty"` + + // The name for this image. The name is unique across all images in the region. + Name *string `json:"name" validate:"required"` + + // The obsolescence date and time (UTC) for this image. + // + // If absent, no obsolescence date and time has been set. + ObsolescenceAt *strfmt.DateTime `json:"obsolescence_at,omitempty"` + + // The operating system included in this image. + OperatingSystem *OperatingSystem `json:"operating_system,omitempty"` + + // The resource group for this image. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The volume used to create this image (this may be + // [deleted](https://cloud.ibm.com/apidocs/vpc#deleted-resources)). + // If absent, this image was not created from a volume. + SourceVolume *VolumeReference `json:"source_volume,omitempty"` + + // The status of this image + // - available: image can be used (provisionable) + // - deleting: image is being deleted, and can no longer be used to provision new + // resources + // - deprecated: image is administratively slated to become `obsolete` + // - failed: image is corrupt or did not pass validation + // - obsolete: image administratively set to not be used for new resources + // - pending: image is being imported and is not yet `available` + // - unusable: image cannot be used (see `status_reasons[]` for possible remediation) + // + // The enumerated values for this property are expected to expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the image on which the + // unexpected property value was encountered. + Status *string `json:"status" validate:"required"` + + // The reasons for the current status (if any): + // - `encrypted_data_key_invalid`: image cannot be decrypted with the specified + // `encryption_key` + // - `encryption_key_deleted`: image unusable because its `encryption_key` was deleted + // - `encryption_key_disabled`: image unusable until its `encryption_key` is re-enabled + // - `image_data_corrupted`: image data is corrupt, or is not in the specified format + // - `image_provisioned_size_unsupported`: image requires a boot volume size greater + // than the maximum supported value + // - `image_request_in_progress`: image operation is in progress (such as an import from + // Cloud Object Storage) + // - `image_request_queued`: image request has been accepted but the requested + // operation has not started + // + // The enumerated reason code values for this property will expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the + // unexpected reason code was encountered. + StatusReasons []ImageStatusReason `json:"status_reasons" validate:"required"` + + // The visibility of this image. + // - `private`: Visible only to this account + // - `public`: Visible to all accounts. + Visibility *string `json:"visibility" validate:"required"` +} + +// Constants associated with the Image.Encryption property. +// The type of encryption used on the image. +const ( + ImageEncryptionNoneConst = "none" + ImageEncryptionUserManagedConst = "user_managed" +) + +// Constants associated with the Image.ResourceType property. +// The resource type. +const ( + ImageResourceTypeImageConst = "image" +) + +// Constants associated with the Image.Status property. +// The status of this image +// - available: image can be used (provisionable) +// - deleting: image is being deleted, and can no longer be used to provision new +// resources +// - deprecated: image is administratively slated to become `obsolete` +// - failed: image is corrupt or did not pass validation +// - obsolete: image administratively set to not be used for new resources +// - pending: image is being imported and is not yet `available` +// - unusable: image cannot be used (see `status_reasons[]` for possible remediation) +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the image on which the +// unexpected property value was encountered. +const ( + ImageStatusAvailableConst = "available" + ImageStatusDeletingConst = "deleting" + ImageStatusDeprecatedConst = "deprecated" + ImageStatusFailedConst = "failed" + ImageStatusObsoleteConst = "obsolete" + ImageStatusPendingConst = "pending" + ImageStatusUnusableConst = "unusable" +) + +// Constants associated with the Image.Visibility property. +// The visibility of this image. +// - `private`: Visible only to this account +// - `public`: Visible to all accounts. +const ( + ImageVisibilityPrivateConst = "private" + ImageVisibilityPublicConst = "public" +) + +// UnmarshalImage unmarshals an instance of Image from the specified map of raw messages. +func UnmarshalImage(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(Image) + err = core.UnmarshalModel(m, "catalog_offering", &obj.CatalogOffering, UnmarshalImageCatalogOffering) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "deprecation_at", &obj.DeprecationAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "encryption", &obj.Encryption) + if err != nil { + return + } + err = core.UnmarshalModel(m, "encryption_key", &obj.EncryptionKey, UnmarshalEncryptionKeyReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "file", &obj.File, UnmarshalImageFile) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "minimum_provisioned_size", &obj.MinimumProvisionedSize) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "obsolescence_at", &obj.ObsolescenceAt) + if err != nil { + return + } + err = core.UnmarshalModel(m, "operating_system", &obj.OperatingSystem, UnmarshalOperatingSystem) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalModel(m, "source_volume", &obj.SourceVolume, UnmarshalVolumeReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + err = core.UnmarshalModel(m, "status_reasons", &obj.StatusReasons, UnmarshalImageStatusReason) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "visibility", &obj.Visibility) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ImageCatalogOffering : ImageCatalogOffering struct +type ImageCatalogOffering struct { + // Indicates whether this image is managed as part of a + // [catalog](https://cloud.ibm.com/docs/account?topic=account-restrict-by-user) offering. If an image is managed, + // accounts in the same + // [enterprise](https://cloud.ibm.com/docs/account?topic=account-what-is-enterprise) with access to that catalog can + // specify the image's catalog offering version CRN to provision virtual server instances using the image. + Managed *bool `json:"managed" validate:"required"` + + // The [catalog](https://cloud.ibm.com/docs/account?topic=account-restrict-by-user) + // offering version associated with this image. + // + // If absent, this image is not associated with a cloud catalog offering. + Version *CatalogOfferingVersionReference `json:"version,omitempty"` +} + +// UnmarshalImageCatalogOffering unmarshals an instance of ImageCatalogOffering from the specified map of raw messages. +func UnmarshalImageCatalogOffering(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ImageCatalogOffering) + err = core.UnmarshalPrimitive(m, "managed", &obj.Managed) + if err != nil { + return + } + err = core.UnmarshalModel(m, "version", &obj.Version, UnmarshalCatalogOfferingVersionReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ImageCollection : ImageCollection struct +type ImageCollection struct { + // A link to the first page of resources. + First *ImageCollectionFirst `json:"first" validate:"required"` + + // Collection of images. + Images []Image `json:"images" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *ImageCollectionNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalImageCollection unmarshals an instance of ImageCollection from the specified map of raw messages. +func UnmarshalImageCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ImageCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalImageCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalModel(m, "images", &obj.Images, UnmarshalImage) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalImageCollectionNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *ImageCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// ImageCollectionFirst : A link to the first page of resources. +type ImageCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalImageCollectionFirst unmarshals an instance of ImageCollectionFirst from the specified map of raw messages. +func UnmarshalImageCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ImageCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ImageCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type ImageCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalImageCollectionNext unmarshals an instance of ImageCollectionNext from the specified map of raw messages. +func UnmarshalImageCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ImageCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ImageExportJob : ImageExportJob struct +type ImageExportJob struct { + // The date and time that the image export job was completed. + // + // If absent, the export job has not yet completed. + CompletedAt *strfmt.DateTime `json:"completed_at,omitempty"` + + // The date and time that the image export job was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // A base64-encoded, encrypted representation of the key that was used to encrypt the data for the exported image. This + // key can be unwrapped with the image's `encryption_key` root key using either Key Protect or Hyper Protect Crypto + // Services. + // + // If absent, the export job is for an unencrypted image. + EncryptedDataKey *[]byte `json:"encrypted_data_key,omitempty"` + + // The format of the exported image. + Format *string `json:"format" validate:"required"` + + // The URL for this image export job. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this image export job. + ID *string `json:"id" validate:"required"` + + // The name for this image export job. The name must not be used by another export job for the image. Changing the name + // will not affect the exported image name, + // `storage_object.name`, or `storage_href` values. + Name *string `json:"name" validate:"required"` + + // The type of resource referenced. + ResourceType *string `json:"resource_type" validate:"required"` + + // The date and time that the image export job started running. + // + // If absent, the export job has not yet started. + StartedAt *strfmt.DateTime `json:"started_at,omitempty"` + + // The status of this image export job: + // - `deleting`: Export job is being deleted + // - `failed`: Export job could not be completed successfully + // - `queued`: Export job is queued + // - `running`: Export job is in progress + // - `succeeded`: Export job was completed successfully + // + // The exported image object is automatically deleted for `failed` jobs. + Status *string `json:"status" validate:"required"` + + // The reasons for the current status (if any). + // + // The enumerated reason code values for this property will expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the + // unexpected reason code was encountered. + StatusReasons []ImageExportJobStatusReason `json:"status_reasons" validate:"required"` + + // The Cloud Object Storage bucket of the exported image object. + StorageBucket *CloudObjectStorageBucketReference `json:"storage_bucket" validate:"required"` + + // The Cloud Object Storage location of the exported image object. The object at this location will not exist until the + // job completes successfully. The exported image object is not managed by the IBM VPC service, and may be removed or + // replaced with a different object by any user or service with IAM authorization to the storage bucket. + StorageHref *string `json:"storage_href" validate:"required"` + + // The Cloud Object Storage object for the exported image. This object will not exist until + // the job completes successfully. The exported image object is not managed by the IBM VPC + // service, and may be removed or replaced with a different object by any user or service + // with IAM authorization to the storage bucket. + StorageObject *CloudObjectStorageObjectReference `json:"storage_object" validate:"required"` +} + +// Constants associated with the ImageExportJob.Format property. +// The format of the exported image. +const ( + ImageExportJobFormatQcow2Const = "qcow2" + ImageExportJobFormatVhdConst = "vhd" +) + +// Constants associated with the ImageExportJob.ResourceType property. +// The type of resource referenced. +const ( + ImageExportJobResourceTypeImageExportJobConst = "image_export_job" +) + +// Constants associated with the ImageExportJob.Status property. +// The status of this image export job: +// - `deleting`: Export job is being deleted +// - `failed`: Export job could not be completed successfully +// - `queued`: Export job is queued +// - `running`: Export job is in progress +// - `succeeded`: Export job was completed successfully +// +// The exported image object is automatically deleted for `failed` jobs. +const ( + ImageExportJobStatusDeletingConst = "deleting" + ImageExportJobStatusFailedConst = "failed" + ImageExportJobStatusQueuedConst = "queued" + ImageExportJobStatusRunningConst = "running" + ImageExportJobStatusSucceededConst = "succeeded" +) + +// UnmarshalImageExportJob unmarshals an instance of ImageExportJob from the specified map of raw messages. +func UnmarshalImageExportJob(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ImageExportJob) + err = core.UnmarshalPrimitive(m, "completed_at", &obj.CompletedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "encrypted_data_key", &obj.EncryptedDataKey) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "format", &obj.Format) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "started_at", &obj.StartedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + err = core.UnmarshalModel(m, "status_reasons", &obj.StatusReasons, UnmarshalImageExportJobStatusReason) + if err != nil { + return + } + err = core.UnmarshalModel(m, "storage_bucket", &obj.StorageBucket, UnmarshalCloudObjectStorageBucketReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "storage_href", &obj.StorageHref) + if err != nil { + return + } + err = core.UnmarshalModel(m, "storage_object", &obj.StorageObject, UnmarshalCloudObjectStorageObjectReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ImageExportJobPatch : ImageExportJobPatch struct +type ImageExportJobPatch struct { + // The name for this image export job. The name must not be used by another export job for the image. Changing the name + // will not affect the exported image name, + // `storage_object.name`, or `storage_href` values. + Name *string `json:"name,omitempty"` +} + +// UnmarshalImageExportJobPatch unmarshals an instance of ImageExportJobPatch from the specified map of raw messages. +func UnmarshalImageExportJobPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ImageExportJobPatch) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the ImageExportJobPatch +func (imageExportJobPatch *ImageExportJobPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(imageExportJobPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// ImageExportJobStatusReason : ImageExportJobStatusReason struct +type ImageExportJobStatusReason struct { + // A snake case string succinctly identifying the status reason. + Code *string `json:"code" validate:"required"` + + // An explanation of the status reason. + Message *string `json:"message" validate:"required"` + + // Link to documentation about this status reason. + MoreInfo *string `json:"more_info,omitempty"` +} + +// Constants associated with the ImageExportJobStatusReason.Code property. +// A snake case string succinctly identifying the status reason. +const ( + ImageExportJobStatusReasonCodeCannotAccessStorageBucketConst = "cannot_access_storage_bucket" + ImageExportJobStatusReasonCodeInternalErrorConst = "internal_error" +) + +// UnmarshalImageExportJobStatusReason unmarshals an instance of ImageExportJobStatusReason from the specified map of raw messages. +func UnmarshalImageExportJobStatusReason(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ImageExportJobStatusReason) + err = core.UnmarshalPrimitive(m, "code", &obj.Code) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "message", &obj.Message) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ImageExportJobUnpaginatedCollection : ImageExportJobUnpaginatedCollection struct +type ImageExportJobUnpaginatedCollection struct { + // Collection of image export jobs. + ExportJobs []ImageExportJob `json:"export_jobs" validate:"required"` +} + +// UnmarshalImageExportJobUnpaginatedCollection unmarshals an instance of ImageExportJobUnpaginatedCollection from the specified map of raw messages. +func UnmarshalImageExportJobUnpaginatedCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ImageExportJobUnpaginatedCollection) + err = core.UnmarshalModel(m, "export_jobs", &obj.ExportJobs, UnmarshalImageExportJob) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ImageFile : ImageFile struct +type ImageFile struct { + // Checksums for this image file. + // + // This property may be absent if the associated image has a `status` of `pending` or + // `failed`. + Checksums *ImageFileChecksums `json:"checksums,omitempty"` + + // The size of the stored image file rounded up to the next gigabyte. + // + // This property may be absent if the associated image has a `status` of `pending` or + // `failed`. + Size *int64 `json:"size,omitempty"` +} + +// UnmarshalImageFile unmarshals an instance of ImageFile from the specified map of raw messages. +func UnmarshalImageFile(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ImageFile) + err = core.UnmarshalModel(m, "checksums", &obj.Checksums, UnmarshalImageFileChecksums) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "size", &obj.Size) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ImageFileChecksums : ImageFileChecksums struct +type ImageFileChecksums struct { + // The SHA256 fingerprint of the image file. + Sha256 *string `json:"sha256,omitempty"` +} + +// UnmarshalImageFileChecksums unmarshals an instance of ImageFileChecksums from the specified map of raw messages. +func UnmarshalImageFileChecksums(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ImageFileChecksums) + err = core.UnmarshalPrimitive(m, "sha256", &obj.Sha256) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ImageFilePrototype : ImageFilePrototype struct +type ImageFilePrototype struct { + // The Cloud Object Storage location of the image file. + // + // The image file format is specified by the file's extension, which must be either + // `qcow2` or `vhd`. + Href *string `json:"href" validate:"required"` +} + +// NewImageFilePrototype : Instantiate ImageFilePrototype (Generic Model Constructor) +func (*VpcV1) NewImageFilePrototype(href string) (_model *ImageFilePrototype, err error) { + _model = &ImageFilePrototype{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalImageFilePrototype unmarshals an instance of ImageFilePrototype from the specified map of raw messages. +func UnmarshalImageFilePrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ImageFilePrototype) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ImageIdentity : Identifies an image by a unique property. +// Models which "extend" this model: +// - ImageIdentityByID +// - ImageIdentityByCRN +// - ImageIdentityByHref +type ImageIdentity struct { + // The unique identifier for this image. + ID *string `json:"id,omitempty"` + + // The CRN for this image. + CRN *string `json:"crn,omitempty"` + + // The URL for this image. + Href *string `json:"href,omitempty"` +} + +func (*ImageIdentity) isaImageIdentity() bool { + return true +} + +type ImageIdentityIntf interface { + isaImageIdentity() bool +} + +// UnmarshalImageIdentity unmarshals an instance of ImageIdentity from the specified map of raw messages. +func UnmarshalImageIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ImageIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ImagePatch : ImagePatch struct +type ImagePatch struct { + // The deprecation date and time to set for this image. + // + // This cannot be set if the image has a `status` of `failed` or `deleting`, or if + // `catalog_offering.managed` is `true`. + // + // The date and time must not be in the past, and must be earlier than `obsolescence_at` + // (if `obsolescence_at` is set). Additionally, if the image status is currently + // `deprecated`, the value cannot be changed (but may be removed). + // + // Specify `null` to remove an existing deprecation date and time. If the image status is currently `deprecated`, it + // will become `available`. + // + // If the deprecation date and time is reached while the image has a status of `pending`, the image's status will + // transition to `deprecated` upon its successful creation (or + // `obsolete` if the obsolescence date and time was also reached). + DeprecationAt *strfmt.DateTime `json:"deprecation_at,omitempty"` + + // The name for this image. The name must not be used by another image in the region. Names starting with `ibm-` are + // reserved for system-provided images, and are not allowed. + Name *string `json:"name,omitempty"` + + // The obsolescence date and time to set for this image. + // + // This cannot be set if the image has a `status` of `failed` or `deleting`, or if + // `catalog_offering.managed` is `true`. + // + // The date and time must not be in the past, and must be later than `deprecation_at` (if + // `deprecation_at` is set). Additionally, if the image status is currently `obsolete`, the value cannot be changed + // (but may be removed). + // + // Specify `null` to remove an existing obsolescence date and time. If the image status is currently `obsolete`, it + // will become `deprecated` if `deprecation_at` is in the past. Otherwise, it will become `available`. + // + // If the obsolescence date and time is reached while the image has a status of `pending`, the image's status will + // transition to `obsolete` upon its successful creation. + ObsolescenceAt *strfmt.DateTime `json:"obsolescence_at,omitempty"` +} + +// UnmarshalImagePatch unmarshals an instance of ImagePatch from the specified map of raw messages. +func UnmarshalImagePatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ImagePatch) + err = core.UnmarshalPrimitive(m, "deprecation_at", &obj.DeprecationAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "obsolescence_at", &obj.ObsolescenceAt) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the ImagePatch +func (imagePatch *ImagePatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(imagePatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// ImagePrototype : ImagePrototype struct +// Models which "extend" this model: +// - ImagePrototypeImageByFile +// - ImagePrototypeImageBySourceVolume +type ImagePrototype struct { + // The deprecation date and time to set for this image. + // + // The date and time must not be in the past, and must be earlier than `obsolescence_at` + // (if `obsolescence_at` is set). + // + // If unspecified, no deprecation date and time will be set. + // + // If the deprecation date and time is reached while the image has a status of `pending`, the image's status will + // transition to `deprecated` upon its successful creation (or + // `obsolete` if the obsolescence date and time was also reached). + DeprecationAt *strfmt.DateTime `json:"deprecation_at,omitempty"` + + // The name for this image. The name must not be used by another image in the region. Names starting with `ibm-` are + // reserved for system-provided images, and are not allowed. If unspecified, the name will be a hyphenated list of + // randomly-selected words. + Name *string `json:"name,omitempty"` + + // The obsolescence date and time to set for this image. + // + // The date and time must not be in the past, and must be later than `deprecation_at` (if + // `deprecation_at` is set). + // + // If unspecified, no obsolescence date and time will be set. + // + // If the obsolescence date and time is reached while the image has a status of + // `pending`, the image's status will transition to `obsolete` upon its successful creation. + ObsolescenceAt *strfmt.DateTime `json:"obsolescence_at,omitempty"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // A base64-encoded, encrypted representation of the key that was used to encrypt the data for this image. + // + // That representation is created by wrapping the key's value with the `encryption_key` root key (which must also be + // specified), using either [Key Protect](https://cloud.ibm.com/docs/key-protect?topic=key-protect-wrap-keys) or the + // [Hyper Protect Crypto Services](https://cloud.ibm.com/docs/services/hs-crypto?topic=hs-crypto-wrap-keys). + // + // If unspecified, the imported image is treated as unencrypted. + EncryptedDataKey *string `json:"encrypted_data_key,omitempty"` + + // The root key that was used to wrap the data key (which is ultimately represented as + // `encrypted_data_key`). Additionally, the root key will be used to encrypt volumes + // created from this image (unless an alternate `encryption_key` is specified at volume + // creation). + // + // If unspecified, the imported image is treated as unencrypted. + EncryptionKey EncryptionKeyIdentityIntf `json:"encryption_key,omitempty"` + + // The file from which to create the image. + File *ImageFilePrototype `json:"file,omitempty"` + + // The [supported operating + // system](https://cloud.ibm.com/apidocs/vpc#list-operating-systems) included in this + // image. + OperatingSystem OperatingSystemIdentityIntf `json:"operating_system,omitempty"` + + // The volume from which to create the image. The specified volume must: + // - Have an `operating_system`, which will be used to populate this image's + // operating system information. + // - Not be `active` or `busy`. + // + // During image creation, the specified volume may briefly become `busy`. + SourceVolume VolumeIdentityIntf `json:"source_volume,omitempty"` +} + +func (*ImagePrototype) isaImagePrototype() bool { + return true +} + +type ImagePrototypeIntf interface { + isaImagePrototype() bool +} + +// UnmarshalImagePrototype unmarshals an instance of ImagePrototype from the specified map of raw messages. +func UnmarshalImagePrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ImagePrototype) + err = core.UnmarshalPrimitive(m, "deprecation_at", &obj.DeprecationAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "obsolescence_at", &obj.ObsolescenceAt) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "encrypted_data_key", &obj.EncryptedDataKey) + if err != nil { + return + } + err = core.UnmarshalModel(m, "encryption_key", &obj.EncryptionKey, UnmarshalEncryptionKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "file", &obj.File, UnmarshalImageFilePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "operating_system", &obj.OperatingSystem, UnmarshalOperatingSystemIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "source_volume", &obj.SourceVolume, UnmarshalVolumeIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ImageReference : ImageReference struct +type ImageReference struct { + // The CRN for this image. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *ImageReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this image. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this image. + ID *string `json:"id" validate:"required"` + + // The name for this image. The name is unique across all images in the region. + Name *string `json:"name" validate:"required"` + + // If present, this property indicates that the resource associated with this reference + // is remote and therefore may not be directly retrievable. + Remote *ImageRemote `json:"remote,omitempty"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the ImageReference.ResourceType property. +// The resource type. +const ( + ImageReferenceResourceTypeImageConst = "image" +) + +// UnmarshalImageReference unmarshals an instance of ImageReference from the specified map of raw messages. +func UnmarshalImageReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ImageReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalImageReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "remote", &obj.Remote, UnmarshalImageRemote) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ImageReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type ImageReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalImageReferenceDeleted unmarshals an instance of ImageReferenceDeleted from the specified map of raw messages. +func UnmarshalImageReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ImageReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ImageRemote : If present, this property indicates that the resource associated with this reference is remote and therefore may not +// be directly retrievable. +type ImageRemote struct { + // If present, this property indicates that the referenced resource is remote to this + // account, and identifies the owning account. + Account *AccountReference `json:"account,omitempty"` + + // If present, this property indicates that the referenced resource is remote to this + // region, and identifies the native region. + Region *RegionReference `json:"region,omitempty"` +} + +// UnmarshalImageRemote unmarshals an instance of ImageRemote from the specified map of raw messages. +func UnmarshalImageRemote(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ImageRemote) + err = core.UnmarshalModel(m, "account", &obj.Account, UnmarshalAccountReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "region", &obj.Region, UnmarshalRegionReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ImageStatusReason : ImageStatusReason struct +type ImageStatusReason struct { + // A snake case string succinctly identifying the status reason. + Code *string `json:"code" validate:"required"` + + // An explanation of the status reason. + Message *string `json:"message" validate:"required"` + + // Link to documentation about this status reason. + MoreInfo *string `json:"more_info,omitempty"` +} + +// Constants associated with the ImageStatusReason.Code property. +// A snake case string succinctly identifying the status reason. +const ( + ImageStatusReasonCodeEncryptedDataKeyInvalidConst = "encrypted_data_key_invalid" + ImageStatusReasonCodeEncryptionKeyDeletedConst = "encryption_key_deleted" + ImageStatusReasonCodeEncryptionKeyDisabledConst = "encryption_key_disabled" + ImageStatusReasonCodeImageDataCorruptedConst = "image_data_corrupted" + ImageStatusReasonCodeImageProvisionedSizeUnsupportedConst = "image_provisioned_size_unsupported" + ImageStatusReasonCodeImageRequestInProgressConst = "image_request_in_progress" + ImageStatusReasonCodeImageRequestQueuedConst = "image_request_queued" +) + +// UnmarshalImageStatusReason unmarshals an instance of ImageStatusReason from the specified map of raw messages. +func UnmarshalImageStatusReason(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ImageStatusReason) + err = core.UnmarshalPrimitive(m, "code", &obj.Code) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "message", &obj.Message) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Instance : Instance struct +type Instance struct { + // The availability policy for this virtual server instance. + AvailabilityPolicy *InstanceAvailabilityPolicy `json:"availability_policy" validate:"required"` + + // The total bandwidth (in megabits per second) shared across the instance network interfaces and storage volumes of + // virtual server instance. + Bandwidth *int64 `json:"bandwidth" validate:"required"` + + // Boot volume attachment. + BootVolumeAttachment *VolumeAttachmentReferenceInstanceContext `json:"boot_volume_attachment" validate:"required"` + + // If present, this virtual server instance was provisioned from a + // [catalog](https://cloud.ibm.com/docs/account?topic=account-restrict-by-user). + CatalogOffering *InstanceCatalogOffering `json:"catalog_offering,omitempty"` + + // The date and time that the virtual server instance was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The CRN for this virtual server instance. + CRN *string `json:"crn" validate:"required"` + + // If present, the dedicated host this virtual server instance has been placed on. + DedicatedHost *DedicatedHostReference `json:"dedicated_host,omitempty"` + + // The instance disks for this virtual server instance. + Disks []InstanceDisk `json:"disks" validate:"required"` + + // The virtual server instance GPU configuration. + Gpu *InstanceGpu `json:"gpu,omitempty"` + + // The URL for this virtual server instance. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this virtual server instance. + ID *string `json:"id" validate:"required"` + + // The image the virtual server instance was provisioned from. + Image *ImageReference `json:"image,omitempty"` + + // The reasons for the current `lifecycle_state` (if any). + // + // The enumerated reason code values for this property will expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the + // unexpected reason code was encountered. + LifecycleReasons []InstanceLifecycleReason `json:"lifecycle_reasons" validate:"required"` + + // The lifecycle state of the virtual server instance. + LifecycleState *string `json:"lifecycle_state" validate:"required"` + + // The amount of memory, truncated to whole gibibytes. + Memory *int64 `json:"memory" validate:"required"` + + // The metadata service configuration. + MetadataService *InstanceMetadataService `json:"metadata_service" validate:"required"` + + // The name for this virtual server instance. The name is unique across all virtual server instances in the region. + Name *string `json:"name" validate:"required"` + + // The network interfaces for this instance, including the primary network interface. + NetworkInterfaces []NetworkInterfaceInstanceContextReference `json:"network_interfaces" validate:"required"` + + // The placement restrictions for the virtual server instance. + PlacementTarget InstancePlacementTargetIntf `json:"placement_target,omitempty"` + + // The primary network interface for this virtual server instance. + PrimaryNetworkInterface *NetworkInterfaceInstanceContextReference `json:"primary_network_interface" validate:"required"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-profiles) for this virtual + // server instance. + Profile *InstanceProfileReference `json:"profile" validate:"required"` + + // The resource group for this instance. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // Indicates whether the state of the virtual server instance permits a start request. + Startable *bool `json:"startable" validate:"required"` + + // The status of the virtual server instance. + // + // The enumerated values for this property will expand in the future. When processing this property, check for and log + // unknown values. Optionally halt processing and surface the error, or bypass the instance on which the unexpected + // property value was encountered. + Status *string `json:"status" validate:"required"` + + // The reasons for the current status (if any). + // + // The enumerated reason code values for this property will expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the + // unexpected reason code was encountered. + StatusReasons []InstanceStatusReason `json:"status_reasons" validate:"required"` + + // The amount of bandwidth (in megabits per second) allocated exclusively to instance network interfaces. + TotalNetworkBandwidth *int64 `json:"total_network_bandwidth" validate:"required"` + + // The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes. An increase in + // this value will result in a corresponding decrease to + // `total_network_bandwidth`. + TotalVolumeBandwidth *int64 `json:"total_volume_bandwidth" validate:"required"` + + // The virtual server instance VCPU configuration. + Vcpu *InstanceVcpu `json:"vcpu" validate:"required"` + + // The volume attachments for this virtual server instance, including the boot volume attachment. + VolumeAttachments []VolumeAttachmentReferenceInstanceContext `json:"volume_attachments" validate:"required"` + + // The VPC this virtual server instance resides in. + VPC *VPCReference `json:"vpc" validate:"required"` + + // The zone this virtual server instance resides in. + Zone *ZoneReference `json:"zone" validate:"required"` +} + +// Constants associated with the Instance.LifecycleState property. +// The lifecycle state of the virtual server instance. +const ( + InstanceLifecycleStateDeletingConst = "deleting" + InstanceLifecycleStateFailedConst = "failed" + InstanceLifecycleStatePendingConst = "pending" + InstanceLifecycleStateStableConst = "stable" + InstanceLifecycleStateSuspendedConst = "suspended" + InstanceLifecycleStateUpdatingConst = "updating" + InstanceLifecycleStateWaitingConst = "waiting" +) + +// Constants associated with the Instance.ResourceType property. +// The resource type. +const ( + InstanceResourceTypeInstanceConst = "instance" +) + +// Constants associated with the Instance.Status property. +// The status of the virtual server instance. +// +// The enumerated values for this property will expand in the future. When processing this property, check for and log +// unknown values. Optionally halt processing and surface the error, or bypass the instance on which the unexpected +// property value was encountered. +const ( + InstanceStatusDeletingConst = "deleting" + InstanceStatusFailedConst = "failed" + InstanceStatusPendingConst = "pending" + InstanceStatusRestartingConst = "restarting" + InstanceStatusRunningConst = "running" + InstanceStatusStartingConst = "starting" + InstanceStatusStoppedConst = "stopped" + InstanceStatusStoppingConst = "stopping" +) + +// UnmarshalInstance unmarshals an instance of Instance from the specified map of raw messages. +func UnmarshalInstance(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(Instance) + err = core.UnmarshalModel(m, "availability_policy", &obj.AvailabilityPolicy, UnmarshalInstanceAvailabilityPolicy) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "bandwidth", &obj.Bandwidth) + if err != nil { + return + } + err = core.UnmarshalModel(m, "boot_volume_attachment", &obj.BootVolumeAttachment, UnmarshalVolumeAttachmentReferenceInstanceContext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "catalog_offering", &obj.CatalogOffering, UnmarshalInstanceCatalogOffering) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "dedicated_host", &obj.DedicatedHost, UnmarshalDedicatedHostReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "disks", &obj.Disks, UnmarshalInstanceDisk) + if err != nil { + return + } + err = core.UnmarshalModel(m, "gpu", &obj.Gpu, UnmarshalInstanceGpu) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalModel(m, "image", &obj.Image, UnmarshalImageReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "lifecycle_reasons", &obj.LifecycleReasons, UnmarshalInstanceLifecycleReason) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "lifecycle_state", &obj.LifecycleState) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "memory", &obj.Memory) + if err != nil { + return + } + err = core.UnmarshalModel(m, "metadata_service", &obj.MetadataService, UnmarshalInstanceMetadataService) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "network_interfaces", &obj.NetworkInterfaces, UnmarshalNetworkInterfaceInstanceContextReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "placement_target", &obj.PlacementTarget, UnmarshalInstancePlacementTarget) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_network_interface", &obj.PrimaryNetworkInterface, UnmarshalNetworkInterfaceInstanceContextReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalInstanceProfileReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "startable", &obj.Startable) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + err = core.UnmarshalModel(m, "status_reasons", &obj.StatusReasons, UnmarshalInstanceStatusReason) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_network_bandwidth", &obj.TotalNetworkBandwidth) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_volume_bandwidth", &obj.TotalVolumeBandwidth) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vcpu", &obj.Vcpu, UnmarshalInstanceVcpu) + if err != nil { + return + } + err = core.UnmarshalModel(m, "volume_attachments", &obj.VolumeAttachments, UnmarshalVolumeAttachmentReferenceInstanceContext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceAction : InstanceAction struct +type InstanceAction struct { + // The date and time that the action was completed. + // Deprecated: this field is deprecated and may be removed in a future release. + CompletedAt *strfmt.DateTime `json:"completed_at,omitempty"` + + // The date and time that the action was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // If set to true, the action will be forced immediately, and all queued actions deleted. Ignored for the start action. + Force *bool `json:"force,omitempty"` + + // The URL for this instance action. + // Deprecated: this field is deprecated and may be removed in a future release. + Href *string `json:"href" validate:"required"` + + // The identifier for this instance action. + // Deprecated: this field is deprecated and may be removed in a future release. + ID *string `json:"id" validate:"required"` + + // The date and time that the action was started. + // Deprecated: this field is deprecated and may be removed in a future release. + StartedAt *strfmt.DateTime `json:"started_at,omitempty"` + + // The current status of this action. + // Deprecated: this field is deprecated and may be removed in a future release. + Status *string `json:"status" validate:"required"` + + // The type of action. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the InstanceAction.Status property. +// The current status of this action. +const ( + InstanceActionStatusCompletedConst = "completed" + InstanceActionStatusFailedConst = "failed" + InstanceActionStatusPendingConst = "pending" + InstanceActionStatusRunningConst = "running" +) + +// Constants associated with the InstanceAction.Type property. +// The type of action. +const ( + InstanceActionTypeRebootConst = "reboot" + InstanceActionTypeStartConst = "start" + InstanceActionTypeStopConst = "stop" +) + +// UnmarshalInstanceAction unmarshals an instance of InstanceAction from the specified map of raw messages. +func UnmarshalInstanceAction(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceAction) + err = core.UnmarshalPrimitive(m, "completed_at", &obj.CompletedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "force", &obj.Force) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "started_at", &obj.StartedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceAvailabilityPolicy : InstanceAvailabilityPolicy struct +type InstanceAvailabilityPolicy struct { + // The action to perform if the compute host experiences a failure. + // - `restart`: Automatically restart the virtual server instance after host failure + // - `stop`: Leave the virtual server instance stopped after host failure + // + // The enumerated values for this property are expected to expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the instance on which the + // unexpected property value was encountered. + HostFailure *string `json:"host_failure" validate:"required"` +} + +// Constants associated with the InstanceAvailabilityPolicy.HostFailure property. +// The action to perform if the compute host experiences a failure. +// - `restart`: Automatically restart the virtual server instance after host failure +// - `stop`: Leave the virtual server instance stopped after host failure +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the instance on which the +// unexpected property value was encountered. +const ( + InstanceAvailabilityPolicyHostFailureRestartConst = "restart" + InstanceAvailabilityPolicyHostFailureStopConst = "stop" +) + +// UnmarshalInstanceAvailabilityPolicy unmarshals an instance of InstanceAvailabilityPolicy from the specified map of raw messages. +func UnmarshalInstanceAvailabilityPolicy(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceAvailabilityPolicy) + err = core.UnmarshalPrimitive(m, "host_failure", &obj.HostFailure) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceAvailabilityPolicyPatch : InstanceAvailabilityPolicyPatch struct +type InstanceAvailabilityPolicyPatch struct { + // The action to perform if the compute host experiences a failure. + // - `restart`: Automatically restart the virtual server instance after host failure + // - `stop`: Leave the virtual server instance stopped after host failure. + HostFailure *string `json:"host_failure,omitempty"` +} + +// Constants associated with the InstanceAvailabilityPolicyPatch.HostFailure property. +// The action to perform if the compute host experiences a failure. +// - `restart`: Automatically restart the virtual server instance after host failure +// - `stop`: Leave the virtual server instance stopped after host failure. +const ( + InstanceAvailabilityPolicyPatchHostFailureRestartConst = "restart" + InstanceAvailabilityPolicyPatchHostFailureStopConst = "stop" +) + +// UnmarshalInstanceAvailabilityPolicyPatch unmarshals an instance of InstanceAvailabilityPolicyPatch from the specified map of raw messages. +func UnmarshalInstanceAvailabilityPolicyPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceAvailabilityPolicyPatch) + err = core.UnmarshalPrimitive(m, "host_failure", &obj.HostFailure) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceAvailabilityPolicyPrototype : InstanceAvailabilityPolicyPrototype struct +type InstanceAvailabilityPolicyPrototype struct { + // The action to perform if the compute host experiences a failure. + // - `restart`: Automatically restart the virtual server instance after host failure + // - `stop`: Leave the virtual server instance stopped after host failure. + HostFailure *string `json:"host_failure,omitempty"` +} + +// Constants associated with the InstanceAvailabilityPolicyPrototype.HostFailure property. +// The action to perform if the compute host experiences a failure. +// - `restart`: Automatically restart the virtual server instance after host failure +// - `stop`: Leave the virtual server instance stopped after host failure. +const ( + InstanceAvailabilityPolicyPrototypeHostFailureRestartConst = "restart" + InstanceAvailabilityPolicyPrototypeHostFailureStopConst = "stop" +) + +// UnmarshalInstanceAvailabilityPolicyPrototype unmarshals an instance of InstanceAvailabilityPolicyPrototype from the specified map of raw messages. +func UnmarshalInstanceAvailabilityPolicyPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceAvailabilityPolicyPrototype) + err = core.UnmarshalPrimitive(m, "host_failure", &obj.HostFailure) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceCatalogOffering : InstanceCatalogOffering struct +type InstanceCatalogOffering struct { + // The catalog offering version this virtual server instance was provisioned from. + // + // The catalog offering version is not managed by the IBM VPC service, and may no longer + // exist, or may refer to a different image CRN than the `image.crn` for this virtual + // server instance. However, all images associated with a catalog offering version will + // have the same checksum, and therefore will have the same data. + Version *CatalogOfferingVersionReference `json:"version" validate:"required"` +} + +// UnmarshalInstanceCatalogOffering unmarshals an instance of InstanceCatalogOffering from the specified map of raw messages. +func UnmarshalInstanceCatalogOffering(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceCatalogOffering) + err = core.UnmarshalModel(m, "version", &obj.Version, UnmarshalCatalogOfferingVersionReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceCatalogOfferingPrototype : The [catalog](https://cloud.ibm.com/docs/account?topic=account-restrict-by-user) offering or offering version to use +// when provisioning this virtual server instance. +// +// If an offering is specified, the latest version of that offering will be used. +// +// The specified offering or offering version may be in a different account in the same +// [enterprise](https://cloud.ibm.com/docs/account?topic=account-what-is-enterprise), subject to IAM policies. +// Models which "extend" this model: +// - InstanceCatalogOfferingPrototypeCatalogOfferingByOffering +// - InstanceCatalogOfferingPrototypeCatalogOfferingByVersion +type InstanceCatalogOfferingPrototype struct { + // Identifies a [catalog](https://cloud.ibm.com/docs/account?topic=account-restrict-by-user) + // offering by a unique property. + Offering CatalogOfferingIdentityIntf `json:"offering,omitempty"` + + // Identifies a version of a + // [catalog](https://cloud.ibm.com/docs/account?topic=account-restrict-by-user) offering by a + // unique property. + Version CatalogOfferingVersionIdentityIntf `json:"version,omitempty"` +} + +func (*InstanceCatalogOfferingPrototype) isaInstanceCatalogOfferingPrototype() bool { + return true +} + +type InstanceCatalogOfferingPrototypeIntf interface { + isaInstanceCatalogOfferingPrototype() bool +} + +// UnmarshalInstanceCatalogOfferingPrototype unmarshals an instance of InstanceCatalogOfferingPrototype from the specified map of raw messages. +func UnmarshalInstanceCatalogOfferingPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceCatalogOfferingPrototype) + err = core.UnmarshalModel(m, "offering", &obj.Offering, UnmarshalCatalogOfferingIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "version", &obj.Version, UnmarshalCatalogOfferingVersionIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceCollection : InstanceCollection struct +type InstanceCollection struct { + // A link to the first page of resources. + First *InstanceCollectionFirst `json:"first" validate:"required"` + + // Collection of virtual server instances. + Instances []Instance `json:"instances" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *InstanceCollectionNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalInstanceCollection unmarshals an instance of InstanceCollection from the specified map of raw messages. +func UnmarshalInstanceCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalInstanceCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalModel(m, "instances", &obj.Instances, UnmarshalInstance) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalInstanceCollectionNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *InstanceCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// InstanceCollectionFirst : A link to the first page of resources. +type InstanceCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalInstanceCollectionFirst unmarshals an instance of InstanceCollectionFirst from the specified map of raw messages. +func UnmarshalInstanceCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type InstanceCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalInstanceCollectionNext unmarshals an instance of InstanceCollectionNext from the specified map of raw messages. +func UnmarshalInstanceCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceConsoleAccessToken : The instance console access token information. +type InstanceConsoleAccessToken struct { + // A URL safe single-use token used to access the console WebSocket. + AccessToken *string `json:"access_token" validate:"required"` + + // The instance console type for which this token may be used. + ConsoleType *string `json:"console_type" validate:"required"` + + // The date and time that the access token was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The date and time that the access token will expire. + ExpiresAt *strfmt.DateTime `json:"expires_at" validate:"required"` + + // Indicates whether to disconnect an existing serial console session as the serial console cannot be shared. This has + // no effect on VNC consoles. + Force *bool `json:"force" validate:"required"` + + // The URL to access this instance console. + Href *string `json:"href" validate:"required"` +} + +// Constants associated with the InstanceConsoleAccessToken.ConsoleType property. +// The instance console type for which this token may be used. +const ( + InstanceConsoleAccessTokenConsoleTypeSerialConst = "serial" + InstanceConsoleAccessTokenConsoleTypeVncConst = "vnc" +) + +// UnmarshalInstanceConsoleAccessToken unmarshals an instance of InstanceConsoleAccessToken from the specified map of raw messages. +func UnmarshalInstanceConsoleAccessToken(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceConsoleAccessToken) + err = core.UnmarshalPrimitive(m, "access_token", &obj.AccessToken) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "console_type", &obj.ConsoleType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "expires_at", &obj.ExpiresAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "force", &obj.Force) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceDefaultTrustedProfilePrototype : InstanceDefaultTrustedProfilePrototype struct +type InstanceDefaultTrustedProfilePrototype struct { + // If set to `true`, the system will create a link to the specified `target` trusted profile during instance creation. + // Regardless of whether a link is created by the system or manually using the IAM Identity service, it will be + // automatically deleted when the instance is deleted. + AutoLink *bool `json:"auto_link,omitempty"` + + // The default IAM trusted profile to use for this virtual server instance. + Target TrustedProfileIdentityIntf `json:"target" validate:"required"` +} + +// NewInstanceDefaultTrustedProfilePrototype : Instantiate InstanceDefaultTrustedProfilePrototype (Generic Model Constructor) +func (*VpcV1) NewInstanceDefaultTrustedProfilePrototype(target TrustedProfileIdentityIntf) (_model *InstanceDefaultTrustedProfilePrototype, err error) { + _model = &InstanceDefaultTrustedProfilePrototype{ + Target: target, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalInstanceDefaultTrustedProfilePrototype unmarshals an instance of InstanceDefaultTrustedProfilePrototype from the specified map of raw messages. +func UnmarshalInstanceDefaultTrustedProfilePrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceDefaultTrustedProfilePrototype) + err = core.UnmarshalPrimitive(m, "auto_link", &obj.AutoLink) + if err != nil { + return + } + err = core.UnmarshalModel(m, "target", &obj.Target, UnmarshalTrustedProfileIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceDisk : InstanceDisk struct +type InstanceDisk struct { + // The date and time that the disk was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The URL for this instance disk. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this instance disk. + ID *string `json:"id" validate:"required"` + + // The disk interface used for attaching the disk. + // + // The enumerated values for this property are expected to expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the + // unexpected property value was encountered. + InterfaceType *string `json:"interface_type" validate:"required"` + + // The name for this instance disk. The name is unique across all disks on the instance. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The size of the disk in GB (gigabytes). + Size *int64 `json:"size" validate:"required"` +} + +// Constants associated with the InstanceDisk.InterfaceType property. +// The disk interface used for attaching the disk. +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the +// unexpected property value was encountered. +const ( + InstanceDiskInterfaceTypeNvmeConst = "nvme" + InstanceDiskInterfaceTypeVirtioBlkConst = "virtio_blk" +) + +// Constants associated with the InstanceDisk.ResourceType property. +// The resource type. +const ( + InstanceDiskResourceTypeInstanceDiskConst = "instance_disk" +) + +// UnmarshalInstanceDisk unmarshals an instance of InstanceDisk from the specified map of raw messages. +func UnmarshalInstanceDisk(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceDisk) + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "interface_type", &obj.InterfaceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "size", &obj.Size) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceDiskCollection : InstanceDiskCollection struct +type InstanceDiskCollection struct { + // Collection of the instance's disks. + Disks []InstanceDisk `json:"disks" validate:"required"` +} + +// UnmarshalInstanceDiskCollection unmarshals an instance of InstanceDiskCollection from the specified map of raw messages. +func UnmarshalInstanceDiskCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceDiskCollection) + err = core.UnmarshalModel(m, "disks", &obj.Disks, UnmarshalInstanceDisk) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceDiskPatch : InstanceDiskPatch struct +type InstanceDiskPatch struct { + // The name for this instance disk. The name must not be used by another disk on the instance. + Name *string `json:"name,omitempty"` +} + +// UnmarshalInstanceDiskPatch unmarshals an instance of InstanceDiskPatch from the specified map of raw messages. +func UnmarshalInstanceDiskPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceDiskPatch) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the InstanceDiskPatch +func (instanceDiskPatch *InstanceDiskPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(instanceDiskPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// InstanceDiskReference : InstanceDiskReference struct +type InstanceDiskReference struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *InstanceDiskReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this instance disk. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this instance disk. + ID *string `json:"id" validate:"required"` + + // The name for this instance disk. The name is unique across all disks on the instance. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the InstanceDiskReference.ResourceType property. +// The resource type. +const ( + InstanceDiskReferenceResourceTypeInstanceDiskConst = "instance_disk" +) + +// UnmarshalInstanceDiskReference unmarshals an instance of InstanceDiskReference from the specified map of raw messages. +func UnmarshalInstanceDiskReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceDiskReference) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalInstanceDiskReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceDiskReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type InstanceDiskReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalInstanceDiskReferenceDeleted unmarshals an instance of InstanceDiskReferenceDeleted from the specified map of raw messages. +func UnmarshalInstanceDiskReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceDiskReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGpu : The virtual server instance GPU configuration. +type InstanceGpu struct { + // The number of GPUs assigned to the instance. + Count *int64 `json:"count" validate:"required"` + + // The GPU manufacturer. + Manufacturer *string `json:"manufacturer" validate:"required"` + + // The overall amount of GPU memory in GiB (gibibytes). + Memory *int64 `json:"memory" validate:"required"` + + // The GPU model. + Model *string `json:"model" validate:"required"` +} + +// UnmarshalInstanceGpu unmarshals an instance of InstanceGpu from the specified map of raw messages. +func UnmarshalInstanceGpu(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGpu) + err = core.UnmarshalPrimitive(m, "count", &obj.Count) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "manufacturer", &obj.Manufacturer) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "memory", &obj.Memory) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "model", &obj.Model) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroup : InstanceGroup struct +type InstanceGroup struct { + // The port used for new load balancer pool members created by this instance group. + // + // This property will be present if and only if `load_balancer_pool` is present. + ApplicationPort *int64 `json:"application_port,omitempty"` + + // The date and time that the instance group was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The CRN for this instance group. + CRN *string `json:"crn" validate:"required"` + + // The URL for this instance group. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this instance group. + ID *string `json:"id" validate:"required"` + + // The template used to create new instances for this group. + InstanceTemplate *InstanceTemplateReference `json:"instance_template" validate:"required"` + + // If present, the load balancer pool this instance group manages. A pool member will + // be created for each instance created by this group. + LoadBalancerPool *LoadBalancerPoolReference `json:"load_balancer_pool,omitempty"` + + // The managers for the instance group. + Managers []InstanceGroupManagerReference `json:"managers" validate:"required"` + + // The number of instances in the instance group. + MembershipCount *int64 `json:"membership_count" validate:"required"` + + // The name for this instance group. The name is unique across all instance groups in the region. + Name *string `json:"name" validate:"required"` + + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The status of the instance group + // - `deleting`: Group is being deleted + // - `healthy`: Group has `membership_count` instances + // - `scaling`: Instances in the group are being created or deleted to reach + // `membership_count` + // - `unhealthy`: Group is unable to reach `membership_count` instances. + Status *string `json:"status" validate:"required"` + + // The subnets to use when creating new instances. + Subnets []SubnetReference `json:"subnets" validate:"required"` + + // The date and time that the instance group was updated. + UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"` + + // The VPC the instance group resides in. + VPC *VPCReference `json:"vpc" validate:"required"` +} + +// Constants associated with the InstanceGroup.Status property. +// The status of the instance group +// - `deleting`: Group is being deleted +// - `healthy`: Group has `membership_count` instances +// - `scaling`: Instances in the group are being created or deleted to reach +// `membership_count` +// - `unhealthy`: Group is unable to reach `membership_count` instances. +const ( + InstanceGroupStatusDeletingConst = "deleting" + InstanceGroupStatusHealthyConst = "healthy" + InstanceGroupStatusScalingConst = "scaling" + InstanceGroupStatusUnhealthyConst = "unhealthy" +) + +// UnmarshalInstanceGroup unmarshals an instance of InstanceGroup from the specified map of raw messages. +func UnmarshalInstanceGroup(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroup) + err = core.UnmarshalPrimitive(m, "application_port", &obj.ApplicationPort) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalModel(m, "instance_template", &obj.InstanceTemplate, UnmarshalInstanceTemplateReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "load_balancer_pool", &obj.LoadBalancerPool, UnmarshalLoadBalancerPoolReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "managers", &obj.Managers, UnmarshalInstanceGroupManagerReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "membership_count", &obj.MembershipCount) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnets", &obj.Subnets, UnmarshalSubnetReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "updated_at", &obj.UpdatedAt) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupCollection : InstanceGroupCollection struct +type InstanceGroupCollection struct { + // A link to the first page of resources. + First *InstanceGroupCollectionFirst `json:"first" validate:"required"` + + // Collection of instance groups. + InstanceGroups []InstanceGroup `json:"instance_groups" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *InstanceGroupCollectionNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalInstanceGroupCollection unmarshals an instance of InstanceGroupCollection from the specified map of raw messages. +func UnmarshalInstanceGroupCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalInstanceGroupCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalModel(m, "instance_groups", &obj.InstanceGroups, UnmarshalInstanceGroup) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalInstanceGroupCollectionNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *InstanceGroupCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// InstanceGroupCollectionFirst : A link to the first page of resources. +type InstanceGroupCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalInstanceGroupCollectionFirst unmarshals an instance of InstanceGroupCollectionFirst from the specified map of raw messages. +func UnmarshalInstanceGroupCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type InstanceGroupCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalInstanceGroupCollectionNext unmarshals an instance of InstanceGroupCollectionNext from the specified map of raw messages. +func UnmarshalInstanceGroupCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManager : InstanceGroupManager struct +// Models which "extend" this model: +// - InstanceGroupManagerAutoScale +// - InstanceGroupManagerScheduled +type InstanceGroupManager struct { + // The date and time that the instance group manager was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The URL for this instance group manager. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this instance group manager. + ID *string `json:"id" validate:"required"` + + // Indicates whether this manager will control the instance group. + ManagementEnabled *bool `json:"management_enabled" validate:"required"` + + // The name for this instance group manager. The name is unique across all managers for the instance group. + Name *string `json:"name" validate:"required"` + + // The date and time that the instance group manager was updated. + UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"` + + // The time window in seconds to aggregate metrics prior to evaluation. + AggregationWindow *int64 `json:"aggregation_window,omitempty"` + + // The duration of time in seconds to pause further scale actions after scaling has taken place. + Cooldown *int64 `json:"cooldown,omitempty"` + + // The type of instance group manager. + ManagerType *string `json:"manager_type,omitempty"` + + // The maximum number of members in a managed instance group. + MaxMembershipCount *int64 `json:"max_membership_count,omitempty"` + + // The minimum number of members in a managed instance group. + MinMembershipCount *int64 `json:"min_membership_count,omitempty"` + + // The policies of the instance group manager. + Policies []InstanceGroupManagerPolicyReference `json:"policies,omitempty"` + + // The actions of the instance group manager. + Actions []InstanceGroupManagerActionReference `json:"actions,omitempty"` +} + +// Constants associated with the InstanceGroupManager.ManagerType property. +// The type of instance group manager. +const ( + InstanceGroupManagerManagerTypeAutoscaleConst = "autoscale" +) + +func (*InstanceGroupManager) isaInstanceGroupManager() bool { + return true +} + +type InstanceGroupManagerIntf interface { + isaInstanceGroupManager() bool +} + +// UnmarshalInstanceGroupManager unmarshals an instance of InstanceGroupManager from the specified map of raw messages. +func UnmarshalInstanceGroupManager(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManager) + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "management_enabled", &obj.ManagementEnabled) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "updated_at", &obj.UpdatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "aggregation_window", &obj.AggregationWindow) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "cooldown", &obj.Cooldown) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "manager_type", &obj.ManagerType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max_membership_count", &obj.MaxMembershipCount) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min_membership_count", &obj.MinMembershipCount) + if err != nil { + return + } + err = core.UnmarshalModel(m, "policies", &obj.Policies, UnmarshalInstanceGroupManagerPolicyReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "actions", &obj.Actions, UnmarshalInstanceGroupManagerActionReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerAction : InstanceGroupManagerAction struct +// Models which "extend" this model: +// - InstanceGroupManagerActionScheduledAction +type InstanceGroupManagerAction struct { + // Indicates whether this scheduled action will be automatically deleted after it has completed and + // `auto_delete_timeout` hours have passed. At present, this is always + // `true`, but may be modifiable in the future. + AutoDelete *bool `json:"auto_delete" validate:"required"` + + // If `auto_delete` is `true`, and this scheduled action has finished, the hours after which it will be automatically + // deleted. If the value is `0`, the action will be deleted once it has finished. This value may be modifiable in the + // future. + AutoDeleteTimeout *int64 `json:"auto_delete_timeout" validate:"required"` + + // The date and time that the instance group manager action was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The URL for this instance group manager action. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this instance group manager action. + ID *string `json:"id" validate:"required"` + + // The name for this instance group manager action. The name is unique across all actions for the instance group + // manager. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The status of the instance group action + // - `active`: Action is ready to be run + // - `completed`: Action was completed successfully + // - `failed`: Action could not be completed successfully + // - `incompatible`: Action parameters are not compatible with the group or manager + // - `omitted`: Action was not applied because this action's manager was disabled. + Status *string `json:"status" validate:"required"` + + // The date and time that the instance group manager action was updated. + UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"` + + // The type of action for the instance group. + ActionType *string `json:"action_type,omitempty"` + + // The cron specification for a recurring scheduled action. Actions can be applied a maximum of one time within a 5 min + // period. + CronSpec *string `json:"cron_spec,omitempty"` + + // The date and time the scheduled action was last applied. If absent, the action has never been applied. + LastAppliedAt *strfmt.DateTime `json:"last_applied_at,omitempty"` + + // The date and time the scheduled action will next run. If absent, the system is currently calculating the next run + // time. + NextRunAt *strfmt.DateTime `json:"next_run_at,omitempty"` + + Group *InstanceGroupManagerScheduledActionGroup `json:"group,omitempty"` + + Manager InstanceGroupManagerScheduledActionManagerIntf `json:"manager,omitempty"` +} + +// Constants associated with the InstanceGroupManagerAction.ResourceType property. +// The resource type. +const ( + InstanceGroupManagerActionResourceTypeInstanceGroupManagerActionConst = "instance_group_manager_action" +) + +// Constants associated with the InstanceGroupManagerAction.Status property. +// The status of the instance group action +// - `active`: Action is ready to be run +// - `completed`: Action was completed successfully +// - `failed`: Action could not be completed successfully +// - `incompatible`: Action parameters are not compatible with the group or manager +// - `omitted`: Action was not applied because this action's manager was disabled. +const ( + InstanceGroupManagerActionStatusActiveConst = "active" + InstanceGroupManagerActionStatusCompletedConst = "completed" + InstanceGroupManagerActionStatusFailedConst = "failed" + InstanceGroupManagerActionStatusIncompatibleConst = "incompatible" + InstanceGroupManagerActionStatusOmittedConst = "omitted" +) + +// Constants associated with the InstanceGroupManagerAction.ActionType property. +// The type of action for the instance group. +const ( + InstanceGroupManagerActionActionTypeScheduledConst = "scheduled" +) + +func (*InstanceGroupManagerAction) isaInstanceGroupManagerAction() bool { + return true +} + +type InstanceGroupManagerActionIntf interface { + isaInstanceGroupManagerAction() bool +} + +// UnmarshalInstanceGroupManagerAction unmarshals an instance of InstanceGroupManagerAction from the specified map of raw messages. +func UnmarshalInstanceGroupManagerAction(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerAction) + err = core.UnmarshalPrimitive(m, "auto_delete", &obj.AutoDelete) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "auto_delete_timeout", &obj.AutoDeleteTimeout) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "updated_at", &obj.UpdatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "action_type", &obj.ActionType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "cron_spec", &obj.CronSpec) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "last_applied_at", &obj.LastAppliedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "next_run_at", &obj.NextRunAt) + if err != nil { + return + } + err = core.UnmarshalModel(m, "group", &obj.Group, UnmarshalInstanceGroupManagerScheduledActionGroup) + if err != nil { + return + } + err = core.UnmarshalModel(m, "manager", &obj.Manager, UnmarshalInstanceGroupManagerScheduledActionManager) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerActionGroupPatch : InstanceGroupManagerActionGroupPatch struct +type InstanceGroupManagerActionGroupPatch struct { + // The desired number of instance group members at the scheduled time. + MembershipCount *int64 `json:"membership_count,omitempty"` +} + +// UnmarshalInstanceGroupManagerActionGroupPatch unmarshals an instance of InstanceGroupManagerActionGroupPatch from the specified map of raw messages. +func UnmarshalInstanceGroupManagerActionGroupPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerActionGroupPatch) + err = core.UnmarshalPrimitive(m, "membership_count", &obj.MembershipCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerActionManagerPatch : InstanceGroupManagerActionManagerPatch struct +type InstanceGroupManagerActionManagerPatch struct { + // The desired maximum number of instance group members at the scheduled time. + MaxMembershipCount *int64 `json:"max_membership_count,omitempty"` + + // The desired minimum number of instance group members at the scheduled time. + MinMembershipCount *int64 `json:"min_membership_count,omitempty"` +} + +// UnmarshalInstanceGroupManagerActionManagerPatch unmarshals an instance of InstanceGroupManagerActionManagerPatch from the specified map of raw messages. +func UnmarshalInstanceGroupManagerActionManagerPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerActionManagerPatch) + err = core.UnmarshalPrimitive(m, "max_membership_count", &obj.MaxMembershipCount) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min_membership_count", &obj.MinMembershipCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerActionPatch : InstanceGroupManagerActionPatch struct +type InstanceGroupManagerActionPatch struct { + // The cron specification for a recurring scheduled action. Actions can be applied a maximum of one time within a 5 min + // period. + CronSpec *string `json:"cron_spec,omitempty"` + + Group *InstanceGroupManagerActionGroupPatch `json:"group,omitempty"` + + Manager *InstanceGroupManagerActionManagerPatch `json:"manager,omitempty"` + + // The name for this instance group manager action. The name must not be used by another action for the instance group + // manager. + Name *string `json:"name,omitempty"` + + // The date and time the scheduled action will run. + RunAt *strfmt.DateTime `json:"run_at,omitempty"` +} + +// UnmarshalInstanceGroupManagerActionPatch unmarshals an instance of InstanceGroupManagerActionPatch from the specified map of raw messages. +func UnmarshalInstanceGroupManagerActionPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerActionPatch) + err = core.UnmarshalPrimitive(m, "cron_spec", &obj.CronSpec) + if err != nil { + return + } + err = core.UnmarshalModel(m, "group", &obj.Group, UnmarshalInstanceGroupManagerActionGroupPatch) + if err != nil { + return + } + err = core.UnmarshalModel(m, "manager", &obj.Manager, UnmarshalInstanceGroupManagerActionManagerPatch) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "run_at", &obj.RunAt) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the InstanceGroupManagerActionPatch +func (instanceGroupManagerActionPatch *InstanceGroupManagerActionPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(instanceGroupManagerActionPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// InstanceGroupManagerActionPrototype : InstanceGroupManagerActionPrototype struct +// Models which "extend" this model: +// - InstanceGroupManagerActionPrototypeScheduledActionPrototype +type InstanceGroupManagerActionPrototype struct { + // The name for this instance group manager action. The name must not be used by another action for the instance group + // manager. If unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The date and time the scheduled action will run. + RunAt *strfmt.DateTime `json:"run_at,omitempty"` + + Group *InstanceGroupManagerScheduledActionGroupPrototype `json:"group,omitempty"` + + Manager InstanceGroupManagerScheduledActionManagerPrototypeIntf `json:"manager,omitempty"` + + // The cron specification for a recurring scheduled action. Actions can be applied a maximum of one time within a 5 min + // period. + CronSpec *string `json:"cron_spec,omitempty"` +} + +func (*InstanceGroupManagerActionPrototype) isaInstanceGroupManagerActionPrototype() bool { + return true +} + +type InstanceGroupManagerActionPrototypeIntf interface { + isaInstanceGroupManagerActionPrototype() bool +} + +// UnmarshalInstanceGroupManagerActionPrototype unmarshals an instance of InstanceGroupManagerActionPrototype from the specified map of raw messages. +func UnmarshalInstanceGroupManagerActionPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerActionPrototype) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "run_at", &obj.RunAt) + if err != nil { + return + } + err = core.UnmarshalModel(m, "group", &obj.Group, UnmarshalInstanceGroupManagerScheduledActionGroupPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "manager", &obj.Manager, UnmarshalInstanceGroupManagerScheduledActionManagerPrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "cron_spec", &obj.CronSpec) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerActionReference : InstanceGroupManagerActionReference struct +type InstanceGroupManagerActionReference struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *InstanceGroupManagerActionReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this instance group manager action. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this instance group manager action. + ID *string `json:"id" validate:"required"` + + // The name for this instance group manager action. The name is unique across all actions for the instance group + // manager. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the InstanceGroupManagerActionReference.ResourceType property. +// The resource type. +const ( + InstanceGroupManagerActionReferenceResourceTypeInstanceGroupManagerActionConst = "instance_group_manager_action" +) + +// UnmarshalInstanceGroupManagerActionReference unmarshals an instance of InstanceGroupManagerActionReference from the specified map of raw messages. +func UnmarshalInstanceGroupManagerActionReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerActionReference) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalInstanceGroupManagerActionReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerActionReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type InstanceGroupManagerActionReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalInstanceGroupManagerActionReferenceDeleted unmarshals an instance of InstanceGroupManagerActionReferenceDeleted from the specified map of raw messages. +func UnmarshalInstanceGroupManagerActionReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerActionReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerActionsCollection : InstanceGroupManagerActionsCollection struct +type InstanceGroupManagerActionsCollection struct { + // Collection of instance group manager actions. + Actions []InstanceGroupManagerActionIntf `json:"actions" validate:"required"` + + // A link to the first page of resources. + First *InstanceGroupManagerActionsCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *InstanceGroupManagerActionsCollectionNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalInstanceGroupManagerActionsCollection unmarshals an instance of InstanceGroupManagerActionsCollection from the specified map of raw messages. +func UnmarshalInstanceGroupManagerActionsCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerActionsCollection) + err = core.UnmarshalModel(m, "actions", &obj.Actions, UnmarshalInstanceGroupManagerAction) + if err != nil { + return + } + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalInstanceGroupManagerActionsCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalInstanceGroupManagerActionsCollectionNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *InstanceGroupManagerActionsCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// InstanceGroupManagerActionsCollectionFirst : A link to the first page of resources. +type InstanceGroupManagerActionsCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalInstanceGroupManagerActionsCollectionFirst unmarshals an instance of InstanceGroupManagerActionsCollectionFirst from the specified map of raw messages. +func UnmarshalInstanceGroupManagerActionsCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerActionsCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerActionsCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type InstanceGroupManagerActionsCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalInstanceGroupManagerActionsCollectionNext unmarshals an instance of InstanceGroupManagerActionsCollectionNext from the specified map of raw messages. +func UnmarshalInstanceGroupManagerActionsCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerActionsCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerCollection : InstanceGroupManagerCollection struct +type InstanceGroupManagerCollection struct { + // A link to the first page of resources. + First *InstanceGroupManagerCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // Collection of instance group managers. + Managers []InstanceGroupManagerIntf `json:"managers" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *InstanceGroupManagerCollectionNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalInstanceGroupManagerCollection unmarshals an instance of InstanceGroupManagerCollection from the specified map of raw messages. +func UnmarshalInstanceGroupManagerCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalInstanceGroupManagerCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "managers", &obj.Managers, UnmarshalInstanceGroupManager) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalInstanceGroupManagerCollectionNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *InstanceGroupManagerCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// InstanceGroupManagerCollectionFirst : A link to the first page of resources. +type InstanceGroupManagerCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalInstanceGroupManagerCollectionFirst unmarshals an instance of InstanceGroupManagerCollectionFirst from the specified map of raw messages. +func UnmarshalInstanceGroupManagerCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type InstanceGroupManagerCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalInstanceGroupManagerCollectionNext unmarshals an instance of InstanceGroupManagerCollectionNext from the specified map of raw messages. +func UnmarshalInstanceGroupManagerCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerPatch : InstanceGroupManagerPatch struct +type InstanceGroupManagerPatch struct { + // The time window in seconds to aggregate metrics prior to evaluation. + AggregationWindow *int64 `json:"aggregation_window,omitempty"` + + // The duration of time in seconds to pause further scale actions after scaling has taken place. + Cooldown *int64 `json:"cooldown,omitempty"` + + // Indicates whether this manager will control the instance group. + ManagementEnabled *bool `json:"management_enabled,omitempty"` + + // The maximum number of members in a managed instance group. + MaxMembershipCount *int64 `json:"max_membership_count,omitempty"` + + // The minimum number of members in a managed instance group. + MinMembershipCount *int64 `json:"min_membership_count,omitempty"` + + // The name for this instance group manager. The name must not be used by another manager for the instance group. + Name *string `json:"name,omitempty"` +} + +// UnmarshalInstanceGroupManagerPatch unmarshals an instance of InstanceGroupManagerPatch from the specified map of raw messages. +func UnmarshalInstanceGroupManagerPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerPatch) + err = core.UnmarshalPrimitive(m, "aggregation_window", &obj.AggregationWindow) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "cooldown", &obj.Cooldown) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "management_enabled", &obj.ManagementEnabled) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max_membership_count", &obj.MaxMembershipCount) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min_membership_count", &obj.MinMembershipCount) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the InstanceGroupManagerPatch +func (instanceGroupManagerPatch *InstanceGroupManagerPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(instanceGroupManagerPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// InstanceGroupManagerPolicy : InstanceGroupManagerPolicy struct +// Models which "extend" this model: +// - InstanceGroupManagerPolicyInstanceGroupManagerTargetPolicy +type InstanceGroupManagerPolicy struct { + // The date and time that the instance group manager policy was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The URL for this instance group manager policy. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this instance group manager policy. + ID *string `json:"id" validate:"required"` + + // The name for this instance group manager policy. The name is unique across all policies for the instance group + // manager. + Name *string `json:"name" validate:"required"` + + // The date and time that the instance group manager policy was updated. + UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"` + + // The type of metric to be evaluated. + MetricType *string `json:"metric_type,omitempty"` + + // The metric value to be evaluated. + MetricValue *int64 `json:"metric_value,omitempty"` + + // The type of policy for the instance group. + PolicyType *string `json:"policy_type,omitempty"` +} + +// Constants associated with the InstanceGroupManagerPolicy.MetricType property. +// The type of metric to be evaluated. +const ( + InstanceGroupManagerPolicyMetricTypeCpuConst = "cpu" + InstanceGroupManagerPolicyMetricTypeMemoryConst = "memory" + InstanceGroupManagerPolicyMetricTypeNetworkInConst = "network_in" + InstanceGroupManagerPolicyMetricTypeNetworkOutConst = "network_out" +) + +// Constants associated with the InstanceGroupManagerPolicy.PolicyType property. +// The type of policy for the instance group. +const ( + InstanceGroupManagerPolicyPolicyTypeTargetConst = "target" +) + +func (*InstanceGroupManagerPolicy) isaInstanceGroupManagerPolicy() bool { + return true +} + +type InstanceGroupManagerPolicyIntf interface { + isaInstanceGroupManagerPolicy() bool +} + +// UnmarshalInstanceGroupManagerPolicy unmarshals an instance of InstanceGroupManagerPolicy from the specified map of raw messages. +func UnmarshalInstanceGroupManagerPolicy(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerPolicy) + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "updated_at", &obj.UpdatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "metric_type", &obj.MetricType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "metric_value", &obj.MetricValue) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "policy_type", &obj.PolicyType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerPolicyCollection : InstanceGroupManagerPolicyCollection struct +type InstanceGroupManagerPolicyCollection struct { + // A link to the first page of resources. + First *InstanceGroupManagerPolicyCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *InstanceGroupManagerPolicyCollectionNext `json:"next,omitempty"` + + // Collection of instance group manager policies. + Policies []InstanceGroupManagerPolicyIntf `json:"policies" validate:"required"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalInstanceGroupManagerPolicyCollection unmarshals an instance of InstanceGroupManagerPolicyCollection from the specified map of raw messages. +func UnmarshalInstanceGroupManagerPolicyCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerPolicyCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalInstanceGroupManagerPolicyCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalInstanceGroupManagerPolicyCollectionNext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "policies", &obj.Policies, UnmarshalInstanceGroupManagerPolicy) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *InstanceGroupManagerPolicyCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// InstanceGroupManagerPolicyCollectionFirst : A link to the first page of resources. +type InstanceGroupManagerPolicyCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalInstanceGroupManagerPolicyCollectionFirst unmarshals an instance of InstanceGroupManagerPolicyCollectionFirst from the specified map of raw messages. +func UnmarshalInstanceGroupManagerPolicyCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerPolicyCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerPolicyCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type InstanceGroupManagerPolicyCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalInstanceGroupManagerPolicyCollectionNext unmarshals an instance of InstanceGroupManagerPolicyCollectionNext from the specified map of raw messages. +func UnmarshalInstanceGroupManagerPolicyCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerPolicyCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerPolicyPatch : InstanceGroupManagerPolicyPatch struct +type InstanceGroupManagerPolicyPatch struct { + // The type of metric to be evaluated. + MetricType *string `json:"metric_type,omitempty"` + + // The metric value to be evaluated. + MetricValue *int64 `json:"metric_value,omitempty"` + + // The name for this instance group manager policy. The name must not be used by another policy for the instance group + // manager. + Name *string `json:"name,omitempty"` +} + +// Constants associated with the InstanceGroupManagerPolicyPatch.MetricType property. +// The type of metric to be evaluated. +const ( + InstanceGroupManagerPolicyPatchMetricTypeCpuConst = "cpu" + InstanceGroupManagerPolicyPatchMetricTypeMemoryConst = "memory" + InstanceGroupManagerPolicyPatchMetricTypeNetworkInConst = "network_in" + InstanceGroupManagerPolicyPatchMetricTypeNetworkOutConst = "network_out" +) + +// UnmarshalInstanceGroupManagerPolicyPatch unmarshals an instance of InstanceGroupManagerPolicyPatch from the specified map of raw messages. +func UnmarshalInstanceGroupManagerPolicyPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerPolicyPatch) + err = core.UnmarshalPrimitive(m, "metric_type", &obj.MetricType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "metric_value", &obj.MetricValue) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the InstanceGroupManagerPolicyPatch +func (instanceGroupManagerPolicyPatch *InstanceGroupManagerPolicyPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(instanceGroupManagerPolicyPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// InstanceGroupManagerPolicyPrototype : InstanceGroupManagerPolicyPrototype struct +// Models which "extend" this model: +// - InstanceGroupManagerPolicyPrototypeInstanceGroupManagerTargetPolicyPrototype +type InstanceGroupManagerPolicyPrototype struct { + // The name for this instance group manager policy. The name must not be used by another policy for the instance group + // manager. If unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The type of metric to be evaluated. + MetricType *string `json:"metric_type,omitempty"` + + // The metric value to be evaluated. + MetricValue *int64 `json:"metric_value,omitempty"` + + // The type of policy for the instance group. + PolicyType *string `json:"policy_type,omitempty"` +} + +// Constants associated with the InstanceGroupManagerPolicyPrototype.MetricType property. +// The type of metric to be evaluated. +const ( + InstanceGroupManagerPolicyPrototypeMetricTypeCpuConst = "cpu" + InstanceGroupManagerPolicyPrototypeMetricTypeMemoryConst = "memory" + InstanceGroupManagerPolicyPrototypeMetricTypeNetworkInConst = "network_in" + InstanceGroupManagerPolicyPrototypeMetricTypeNetworkOutConst = "network_out" +) + +// Constants associated with the InstanceGroupManagerPolicyPrototype.PolicyType property. +// The type of policy for the instance group. +const ( + InstanceGroupManagerPolicyPrototypePolicyTypeTargetConst = "target" +) + +func (*InstanceGroupManagerPolicyPrototype) isaInstanceGroupManagerPolicyPrototype() bool { + return true +} + +type InstanceGroupManagerPolicyPrototypeIntf interface { + isaInstanceGroupManagerPolicyPrototype() bool +} + +// UnmarshalInstanceGroupManagerPolicyPrototype unmarshals an instance of InstanceGroupManagerPolicyPrototype from the specified map of raw messages. +func UnmarshalInstanceGroupManagerPolicyPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerPolicyPrototype) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "metric_type", &obj.MetricType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "metric_value", &obj.MetricValue) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "policy_type", &obj.PolicyType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerPolicyReference : InstanceGroupManagerPolicyReference struct +type InstanceGroupManagerPolicyReference struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *InstanceGroupManagerPolicyReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this instance group manager policy. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this instance group manager policy. + ID *string `json:"id" validate:"required"` + + // The name for this instance group manager policy. The name is unique across all policies for the instance group + // manager. + Name *string `json:"name" validate:"required"` +} + +// UnmarshalInstanceGroupManagerPolicyReference unmarshals an instance of InstanceGroupManagerPolicyReference from the specified map of raw messages. +func UnmarshalInstanceGroupManagerPolicyReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerPolicyReference) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalInstanceGroupManagerPolicyReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerPolicyReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type InstanceGroupManagerPolicyReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalInstanceGroupManagerPolicyReferenceDeleted unmarshals an instance of InstanceGroupManagerPolicyReferenceDeleted from the specified map of raw messages. +func UnmarshalInstanceGroupManagerPolicyReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerPolicyReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerPrototype : InstanceGroupManagerPrototype struct +// Models which "extend" this model: +// - InstanceGroupManagerPrototypeInstanceGroupManagerAutoScalePrototype +// - InstanceGroupManagerPrototypeInstanceGroupManagerScheduledPrototype +type InstanceGroupManagerPrototype struct { + // Indicates whether this manager will control the instance group. + ManagementEnabled *bool `json:"management_enabled,omitempty"` + + // The name for this instance group manager. The name must not be used by another manager for the instance group. If + // unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The time window in seconds to aggregate metrics prior to evaluation. + AggregationWindow *int64 `json:"aggregation_window,omitempty"` + + // The duration of time in seconds to pause further scale actions after scaling has taken place. + Cooldown *int64 `json:"cooldown,omitempty"` + + // The type of instance group manager. + ManagerType *string `json:"manager_type,omitempty"` + + // The maximum number of members in a managed instance group. + MaxMembershipCount *int64 `json:"max_membership_count,omitempty"` + + // The minimum number of members in a managed instance group. + MinMembershipCount *int64 `json:"min_membership_count,omitempty"` +} + +// Constants associated with the InstanceGroupManagerPrototype.ManagerType property. +// The type of instance group manager. +const ( + InstanceGroupManagerPrototypeManagerTypeAutoscaleConst = "autoscale" +) + +func (*InstanceGroupManagerPrototype) isaInstanceGroupManagerPrototype() bool { + return true +} + +type InstanceGroupManagerPrototypeIntf interface { + isaInstanceGroupManagerPrototype() bool +} + +// UnmarshalInstanceGroupManagerPrototype unmarshals an instance of InstanceGroupManagerPrototype from the specified map of raw messages. +func UnmarshalInstanceGroupManagerPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerPrototype) + err = core.UnmarshalPrimitive(m, "management_enabled", &obj.ManagementEnabled) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "aggregation_window", &obj.AggregationWindow) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "cooldown", &obj.Cooldown) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "manager_type", &obj.ManagerType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max_membership_count", &obj.MaxMembershipCount) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min_membership_count", &obj.MinMembershipCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerReference : InstanceGroupManagerReference struct +type InstanceGroupManagerReference struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *InstanceGroupManagerReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this instance group manager. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this instance group manager. + ID *string `json:"id" validate:"required"` + + // The name for this instance group manager. The name is unique across all managers for the instance group. + Name *string `json:"name" validate:"required"` +} + +// UnmarshalInstanceGroupManagerReference unmarshals an instance of InstanceGroupManagerReference from the specified map of raw messages. +func UnmarshalInstanceGroupManagerReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerReference) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalInstanceGroupManagerReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type InstanceGroupManagerReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalInstanceGroupManagerReferenceDeleted unmarshals an instance of InstanceGroupManagerReferenceDeleted from the specified map of raw messages. +func UnmarshalInstanceGroupManagerReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerScheduledActionGroup : InstanceGroupManagerScheduledActionGroup struct +type InstanceGroupManagerScheduledActionGroup struct { + // The desired number of instance group members at the scheduled time. + MembershipCount *int64 `json:"membership_count" validate:"required"` +} + +// UnmarshalInstanceGroupManagerScheduledActionGroup unmarshals an instance of InstanceGroupManagerScheduledActionGroup from the specified map of raw messages. +func UnmarshalInstanceGroupManagerScheduledActionGroup(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerScheduledActionGroup) + err = core.UnmarshalPrimitive(m, "membership_count", &obj.MembershipCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerScheduledActionGroupPrototype : InstanceGroupManagerScheduledActionGroupPrototype struct +type InstanceGroupManagerScheduledActionGroupPrototype struct { + // The desired number of instance group members at the scheduled time. + MembershipCount *int64 `json:"membership_count" validate:"required"` +} + +// NewInstanceGroupManagerScheduledActionGroupPrototype : Instantiate InstanceGroupManagerScheduledActionGroupPrototype (Generic Model Constructor) +func (*VpcV1) NewInstanceGroupManagerScheduledActionGroupPrototype(membershipCount int64) (_model *InstanceGroupManagerScheduledActionGroupPrototype, err error) { + _model = &InstanceGroupManagerScheduledActionGroupPrototype{ + MembershipCount: core.Int64Ptr(membershipCount), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalInstanceGroupManagerScheduledActionGroupPrototype unmarshals an instance of InstanceGroupManagerScheduledActionGroupPrototype from the specified map of raw messages. +func UnmarshalInstanceGroupManagerScheduledActionGroupPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerScheduledActionGroupPrototype) + err = core.UnmarshalPrimitive(m, "membership_count", &obj.MembershipCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerScheduledActionManager : InstanceGroupManagerScheduledActionManager struct +// Models which "extend" this model: +// - InstanceGroupManagerScheduledActionManagerAutoScale +type InstanceGroupManagerScheduledActionManager struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *InstanceGroupManagerReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this instance group manager. + Href *string `json:"href,omitempty"` + + // The unique identifier for this instance group manager. + ID *string `json:"id,omitempty"` + + // The name for this instance group manager. The name is unique across all managers for the instance group. + Name *string `json:"name,omitempty"` + + // The desired maximum number of instance group members at the scheduled time. + MaxMembershipCount *int64 `json:"max_membership_count,omitempty"` + + // The desired minimum number of instance group members at the scheduled time. + MinMembershipCount *int64 `json:"min_membership_count,omitempty"` +} + +func (*InstanceGroupManagerScheduledActionManager) isaInstanceGroupManagerScheduledActionManager() bool { + return true +} + +type InstanceGroupManagerScheduledActionManagerIntf interface { + isaInstanceGroupManagerScheduledActionManager() bool +} + +// UnmarshalInstanceGroupManagerScheduledActionManager unmarshals an instance of InstanceGroupManagerScheduledActionManager from the specified map of raw messages. +func UnmarshalInstanceGroupManagerScheduledActionManager(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerScheduledActionManager) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalInstanceGroupManagerReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max_membership_count", &obj.MaxMembershipCount) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min_membership_count", &obj.MinMembershipCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerScheduledActionManagerPrototype : InstanceGroupManagerScheduledActionManagerPrototype struct +// Models which "extend" this model: +// - InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototype +type InstanceGroupManagerScheduledActionManagerPrototype struct { + // The desired maximum number of instance group members at the scheduled time. + MaxMembershipCount *int64 `json:"max_membership_count,omitempty"` + + // The desired minimum number of instance group members at the scheduled time. + MinMembershipCount *int64 `json:"min_membership_count,omitempty"` + + // The unique identifier for this instance group manager. + ID *string `json:"id,omitempty"` + + // The URL for this instance group manager. + Href *string `json:"href,omitempty"` +} + +func (*InstanceGroupManagerScheduledActionManagerPrototype) isaInstanceGroupManagerScheduledActionManagerPrototype() bool { + return true +} + +type InstanceGroupManagerScheduledActionManagerPrototypeIntf interface { + isaInstanceGroupManagerScheduledActionManagerPrototype() bool +} + +// UnmarshalInstanceGroupManagerScheduledActionManagerPrototype unmarshals an instance of InstanceGroupManagerScheduledActionManagerPrototype from the specified map of raw messages. +func UnmarshalInstanceGroupManagerScheduledActionManagerPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerScheduledActionManagerPrototype) + err = core.UnmarshalPrimitive(m, "max_membership_count", &obj.MaxMembershipCount) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min_membership_count", &obj.MinMembershipCount) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupMembership : InstanceGroupMembership struct +type InstanceGroupMembership struct { + // The date and time that the instance group manager policy was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // If set to true, when deleting the membership the instance will also be deleted. + DeleteInstanceOnMembershipDelete *bool `json:"delete_instance_on_membership_delete" validate:"required"` + + // The URL for this instance group membership. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this instance group membership. + ID *string `json:"id" validate:"required"` + + Instance *InstanceReference `json:"instance" validate:"required"` + + InstanceTemplate *InstanceTemplateReference `json:"instance_template" validate:"required"` + + // The name for this instance group membership. The name is unique across all memberships for the instance group. + Name *string `json:"name" validate:"required"` + + PoolMember *LoadBalancerPoolMemberReference `json:"pool_member,omitempty"` + + // The status of the instance group membership + // - `deleting`: Membership is deleting dependent resources + // - `failed`: Membership was unable to maintain dependent resources + // - `healthy`: Membership is active and serving in the group + // - `pending`: Membership is waiting for dependent resources + // - `unhealthy`: Membership has unhealthy dependent resources. + Status *string `json:"status" validate:"required"` + + // The date and time that the instance group membership was updated. + UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"` +} + +// Constants associated with the InstanceGroupMembership.Status property. +// The status of the instance group membership +// - `deleting`: Membership is deleting dependent resources +// - `failed`: Membership was unable to maintain dependent resources +// - `healthy`: Membership is active and serving in the group +// - `pending`: Membership is waiting for dependent resources +// - `unhealthy`: Membership has unhealthy dependent resources. +const ( + InstanceGroupMembershipStatusDeletingConst = "deleting" + InstanceGroupMembershipStatusFailedConst = "failed" + InstanceGroupMembershipStatusHealthyConst = "healthy" + InstanceGroupMembershipStatusPendingConst = "pending" + InstanceGroupMembershipStatusUnhealthyConst = "unhealthy" +) + +// UnmarshalInstanceGroupMembership unmarshals an instance of InstanceGroupMembership from the specified map of raw messages. +func UnmarshalInstanceGroupMembership(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupMembership) + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "delete_instance_on_membership_delete", &obj.DeleteInstanceOnMembershipDelete) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalModel(m, "instance", &obj.Instance, UnmarshalInstanceReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "instance_template", &obj.InstanceTemplate, UnmarshalInstanceTemplateReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "pool_member", &obj.PoolMember, UnmarshalLoadBalancerPoolMemberReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "updated_at", &obj.UpdatedAt) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupMembershipCollection : InstanceGroupMembershipCollection struct +type InstanceGroupMembershipCollection struct { + // A link to the first page of resources. + First *InstanceGroupMembershipCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // Collection of instance group memberships. + Memberships []InstanceGroupMembership `json:"memberships" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *InstanceGroupMembershipCollectionNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalInstanceGroupMembershipCollection unmarshals an instance of InstanceGroupMembershipCollection from the specified map of raw messages. +func UnmarshalInstanceGroupMembershipCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupMembershipCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalInstanceGroupMembershipCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "memberships", &obj.Memberships, UnmarshalInstanceGroupMembership) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalInstanceGroupMembershipCollectionNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *InstanceGroupMembershipCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// InstanceGroupMembershipCollectionFirst : A link to the first page of resources. +type InstanceGroupMembershipCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalInstanceGroupMembershipCollectionFirst unmarshals an instance of InstanceGroupMembershipCollectionFirst from the specified map of raw messages. +func UnmarshalInstanceGroupMembershipCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupMembershipCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupMembershipCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type InstanceGroupMembershipCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalInstanceGroupMembershipCollectionNext unmarshals an instance of InstanceGroupMembershipCollectionNext from the specified map of raw messages. +func UnmarshalInstanceGroupMembershipCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupMembershipCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupMembershipPatch : InstanceGroupMembershipPatch struct +type InstanceGroupMembershipPatch struct { + // The name for this instance group membership. The name must not be used by another membership for the instance group + // manager. + Name *string `json:"name,omitempty"` +} + +// UnmarshalInstanceGroupMembershipPatch unmarshals an instance of InstanceGroupMembershipPatch from the specified map of raw messages. +func UnmarshalInstanceGroupMembershipPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupMembershipPatch) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the InstanceGroupMembershipPatch +func (instanceGroupMembershipPatch *InstanceGroupMembershipPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(instanceGroupMembershipPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// InstanceGroupPatch : To add or update load balancer specification for an instance group the `membership_count` must first be set to 0. +type InstanceGroupPatch struct { + // The port to use for new load balancer pool members created by this instance group. + // + // This property must be set if and only if `load_balancer_pool` has been set. + ApplicationPort *int64 `json:"application_port,omitempty"` + + // Instance template to use when creating new instances. + // + // Instance groups are not compatible with instance templates that specify `true` for + // `default_trusted_profile.auto_link`. + InstanceTemplate InstanceTemplateIdentityIntf `json:"instance_template,omitempty"` + + // The load balancer associated with `load_balancer_pool`. + // The load balancer must have `instance_groups_supported` set to `true`. + // + // This property must be set if and only if `load_balancer_pool` has been set. + LoadBalancer LoadBalancerIdentityIntf `json:"load_balancer,omitempty"` + + // If specified, this instance group will manage the load balancer pool. A pool member + // will be created for each instance created by this group. The specified load + // balancer pool must not be used by another instance group in the VPC. + // + // If set, `load_balancer` and `application_port` must also be set. + LoadBalancerPool LoadBalancerPoolIdentityIntf `json:"load_balancer_pool,omitempty"` + + // The number of instances in the instance group. + MembershipCount *int64 `json:"membership_count,omitempty"` + + // The name for this instance group. The name must not be used by another instance group in the region. + Name *string `json:"name,omitempty"` + + // The subnets to use when creating new instances. + Subnets []SubnetIdentityIntf `json:"subnets,omitempty"` +} + +// UnmarshalInstanceGroupPatch unmarshals an instance of InstanceGroupPatch from the specified map of raw messages. +func UnmarshalInstanceGroupPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupPatch) + err = core.UnmarshalPrimitive(m, "application_port", &obj.ApplicationPort) + if err != nil { + return + } + err = core.UnmarshalModel(m, "instance_template", &obj.InstanceTemplate, UnmarshalInstanceTemplateIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "load_balancer", &obj.LoadBalancer, UnmarshalLoadBalancerIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "load_balancer_pool", &obj.LoadBalancerPool, UnmarshalLoadBalancerPoolIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "membership_count", &obj.MembershipCount) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnets", &obj.Subnets, UnmarshalSubnetIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the InstanceGroupPatch +func (instanceGroupPatch *InstanceGroupPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(instanceGroupPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// InstanceGroupReference : InstanceGroupReference struct +type InstanceGroupReference struct { + // The CRN for this instance group. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *InstanceGroupReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this instance group. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this instance group. + ID *string `json:"id" validate:"required"` + + // The name for this instance group. The name is unique across all instance groups in the region. + Name *string `json:"name" validate:"required"` +} + +// UnmarshalInstanceGroupReference unmarshals an instance of InstanceGroupReference from the specified map of raw messages. +func UnmarshalInstanceGroupReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalInstanceGroupReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type InstanceGroupReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalInstanceGroupReferenceDeleted unmarshals an instance of InstanceGroupReferenceDeleted from the specified map of raw messages. +func UnmarshalInstanceGroupReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceInitialization : InstanceInitialization struct +type InstanceInitialization struct { + // The default trusted profile configuration specified at virtual server instance + // creation. If absent, no default trusted profile was specified. + DefaultTrustedProfile *InstanceInitializationDefaultTrustedProfile `json:"default_trusted_profile,omitempty"` + + // The public SSH keys used at instance initialization. + Keys []KeyReference `json:"keys" validate:"required"` + + Password *InstanceInitializationPassword `json:"password,omitempty"` +} + +// UnmarshalInstanceInitialization unmarshals an instance of InstanceInitialization from the specified map of raw messages. +func UnmarshalInstanceInitialization(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceInitialization) + err = core.UnmarshalModel(m, "default_trusted_profile", &obj.DefaultTrustedProfile, UnmarshalInstanceInitializationDefaultTrustedProfile) + if err != nil { + return + } + err = core.UnmarshalModel(m, "keys", &obj.Keys, UnmarshalKeyReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "password", &obj.Password, UnmarshalInstanceInitializationPassword) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceInitializationDefaultTrustedProfile : InstanceInitializationDefaultTrustedProfile struct +type InstanceInitializationDefaultTrustedProfile struct { + // If set to `true`, the system created a link to the specified `target` trusted profile during instance creation. + // Regardless of whether a link was created by the system or manually using the IAM Identity service, it will be + // automatically deleted when the instance is deleted. + AutoLink *bool `json:"auto_link" validate:"required"` + + // The default IAM trusted profile to use for this virtual server instance. + Target *TrustedProfileReference `json:"target" validate:"required"` +} + +// UnmarshalInstanceInitializationDefaultTrustedProfile unmarshals an instance of InstanceInitializationDefaultTrustedProfile from the specified map of raw messages. +func UnmarshalInstanceInitializationDefaultTrustedProfile(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceInitializationDefaultTrustedProfile) + err = core.UnmarshalPrimitive(m, "auto_link", &obj.AutoLink) + if err != nil { + return + } + err = core.UnmarshalModel(m, "target", &obj.Target, UnmarshalTrustedProfileReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +type InstanceInitializationPassword struct { + // The administrator password at initialization, encrypted using `encryption_key`, and returned base64-encoded. + EncryptedPassword *[]byte `json:"encrypted_password" validate:"required"` + + // The public SSH key used to encrypt the administrator password. + EncryptionKey *KeyIdentityByFingerprint `json:"encryption_key" validate:"required"` +} + +// UnmarshalInstanceInitializationPassword unmarshals an instance of InstanceInitializationPassword from the specified map of raw messages. +func UnmarshalInstanceInitializationPassword(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceInitializationPassword) + err = core.UnmarshalPrimitive(m, "encrypted_password", &obj.EncryptedPassword) + if err != nil { + return + } + err = core.UnmarshalModel(m, "encryption_key", &obj.EncryptionKey, UnmarshalKeyIdentityByFingerprint) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceLifecycleReason : InstanceLifecycleReason struct +type InstanceLifecycleReason struct { + // A snake case string succinctly identifying the reason for this lifecycle state. + Code *string `json:"code" validate:"required"` + + // An explanation of the reason for this lifecycle state. + Message *string `json:"message" validate:"required"` + + // Link to documentation about the reason for this lifecycle state. + MoreInfo *string `json:"more_info,omitempty"` +} + +// Constants associated with the InstanceLifecycleReason.Code property. +// A snake case string succinctly identifying the reason for this lifecycle state. +const ( + InstanceLifecycleReasonCodeResourceSuspendedByProviderConst = "resource_suspended_by_provider" +) + +// UnmarshalInstanceLifecycleReason unmarshals an instance of InstanceLifecycleReason from the specified map of raw messages. +func UnmarshalInstanceLifecycleReason(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceLifecycleReason) + err = core.UnmarshalPrimitive(m, "code", &obj.Code) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "message", &obj.Message) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceMetadataService : The metadata service configuration. +type InstanceMetadataService struct { + // Indicates whether the metadata service endpoint is available to the virtual server instance. + Enabled *bool `json:"enabled" validate:"required"` + + // The communication protocol to use for the metadata service endpoint. Applies only when the metadata service is + // enabled. + // - `http`: HTTP protocol (unencrypted) + // - `https`: HTTP Secure protocol. + Protocol *string `json:"protocol" validate:"required"` + + // The hop limit (IP time to live) for IP response packets from the metadata service. Applies only when the metadata + // service is enabled. + ResponseHopLimit *int64 `json:"response_hop_limit" validate:"required"` +} + +// Constants associated with the InstanceMetadataService.Protocol property. +// The communication protocol to use for the metadata service endpoint. Applies only when the metadata service is +// enabled. +// - `http`: HTTP protocol (unencrypted) +// - `https`: HTTP Secure protocol. +const ( + InstanceMetadataServiceProtocolHTTPConst = "http" + InstanceMetadataServiceProtocolHTTPSConst = "https" +) + +// UnmarshalInstanceMetadataService unmarshals an instance of InstanceMetadataService from the specified map of raw messages. +func UnmarshalInstanceMetadataService(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceMetadataService) + err = core.UnmarshalPrimitive(m, "enabled", &obj.Enabled) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "protocol", &obj.Protocol) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "response_hop_limit", &obj.ResponseHopLimit) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceMetadataServicePatch : The metadata service configuration. +type InstanceMetadataServicePatch struct { + // Indicates whether the metadata service endpoint will be available to the virtual server instance. + Enabled *bool `json:"enabled,omitempty"` + + // The communication protocol to use for the metadata service endpoint. Applies only when the metadata service is + // enabled. + // - `http`: HTTP protocol (unencrypted) + // - `https`: HTTP Secure protocol. + Protocol *string `json:"protocol,omitempty"` + + // The hop limit (IP time to live) for IP response packets from the metadata service. Applies only when the metadata + // service is enabled. + ResponseHopLimit *int64 `json:"response_hop_limit,omitempty"` +} + +// Constants associated with the InstanceMetadataServicePatch.Protocol property. +// The communication protocol to use for the metadata service endpoint. Applies only when the metadata service is +// enabled. +// - `http`: HTTP protocol (unencrypted) +// - `https`: HTTP Secure protocol. +const ( + InstanceMetadataServicePatchProtocolHTTPConst = "http" + InstanceMetadataServicePatchProtocolHTTPSConst = "https" +) + +// UnmarshalInstanceMetadataServicePatch unmarshals an instance of InstanceMetadataServicePatch from the specified map of raw messages. +func UnmarshalInstanceMetadataServicePatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceMetadataServicePatch) + err = core.UnmarshalPrimitive(m, "enabled", &obj.Enabled) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "protocol", &obj.Protocol) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "response_hop_limit", &obj.ResponseHopLimit) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceMetadataServicePrototype : The metadata service configuration. +type InstanceMetadataServicePrototype struct { + // Indicates whether the metadata service endpoint will be available to the virtual server instance. + Enabled *bool `json:"enabled,omitempty"` + + // The communication protocol to use for the metadata service endpoint. Applies only when the metadata service is + // enabled. + // - `http`: HTTP protocol (unencrypted) + // - `https`: HTTP Secure protocol. + Protocol *string `json:"protocol,omitempty"` + + // The hop limit (IP time to live) for IP response packets from the metadata service. Applies only when the metadata + // service is enabled. + ResponseHopLimit *int64 `json:"response_hop_limit,omitempty"` +} + +// Constants associated with the InstanceMetadataServicePrototype.Protocol property. +// The communication protocol to use for the metadata service endpoint. Applies only when the metadata service is +// enabled. +// - `http`: HTTP protocol (unencrypted) +// - `https`: HTTP Secure protocol. +const ( + InstanceMetadataServicePrototypeProtocolHTTPConst = "http" + InstanceMetadataServicePrototypeProtocolHTTPSConst = "https" +) + +// UnmarshalInstanceMetadataServicePrototype unmarshals an instance of InstanceMetadataServicePrototype from the specified map of raw messages. +func UnmarshalInstanceMetadataServicePrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceMetadataServicePrototype) + err = core.UnmarshalPrimitive(m, "enabled", &obj.Enabled) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "protocol", &obj.Protocol) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "response_hop_limit", &obj.ResponseHopLimit) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePatch : InstancePatch struct +type InstancePatch struct { + // The availability policy for this virtual server instance. + AvailabilityPolicy *InstanceAvailabilityPolicyPatch `json:"availability_policy,omitempty"` + + // The metadata service configuration. + MetadataService *InstanceMetadataServicePatch `json:"metadata_service,omitempty"` + + // The name for this virtual server instance. The name must not be used by another virtual server instance in the + // region. Changing the name will not affect the system hostname. + Name *string `json:"name,omitempty"` + + // The placement restrictions to use for the virtual server instance. For the placement + // restrictions to be changed, the instance `status` must be `stopping` or `stopped`. + PlacementTarget InstancePlacementTargetPatchIntf `json:"placement_target,omitempty"` + + // The profile to use for this virtual server instance. For the profile to be changed, + // the instance `status` must be `stopping` or `stopped`. In addition, the requested + // profile must: + // - Have matching instance disk support. Any disks associated with the current profile + // will be deleted, and any disks associated with the requested profile will be + // created. + // - Be compatible with any `placement_target` constraints. For example, if the + // instance is placed on a dedicated host, the requested profile `family` must be + // the same as the dedicated host `family`. + // - Have the same `vcpu.architecture`. + // - Support the number of network interfaces the instance currently has. + Profile InstancePatchProfileIntf `json:"profile,omitempty"` + + // The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes. An increase in + // this value will result in a corresponding decrease to + // `total_network_bandwidth`. + TotalVolumeBandwidth *int64 `json:"total_volume_bandwidth,omitempty"` +} + +// UnmarshalInstancePatch unmarshals an instance of InstancePatch from the specified map of raw messages. +func UnmarshalInstancePatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePatch) + err = core.UnmarshalModel(m, "availability_policy", &obj.AvailabilityPolicy, UnmarshalInstanceAvailabilityPolicyPatch) + if err != nil { + return + } + err = core.UnmarshalModel(m, "metadata_service", &obj.MetadataService, UnmarshalInstanceMetadataServicePatch) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "placement_target", &obj.PlacementTarget, UnmarshalInstancePlacementTargetPatch) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalInstancePatchProfile) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_volume_bandwidth", &obj.TotalVolumeBandwidth) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the InstancePatch +func (instancePatch *InstancePatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(instancePatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// InstancePatchProfile : The profile to use for this virtual server instance. For the profile to be changed, the instance `status` must be +// `stopping` or `stopped`. In addition, the requested profile must: +// - Have matching instance disk support. Any disks associated with the current profile +// will be deleted, and any disks associated with the requested profile will be +// created. +// - Be compatible with any `placement_target` constraints. For example, if the +// instance is placed on a dedicated host, the requested profile `family` must be +// the same as the dedicated host `family`. +// - Have the same `vcpu.architecture`. +// - Support the number of network interfaces the instance currently has. +// +// Models which "extend" this model: +// - InstancePatchProfileInstanceProfileIdentityByName +// - InstancePatchProfileInstanceProfileIdentityByHref +type InstancePatchProfile struct { + // The globally unique name for this virtual server instance profile. + Name *string `json:"name,omitempty"` + + // The URL for this virtual server instance profile. + Href *string `json:"href,omitempty"` +} + +func (*InstancePatchProfile) isaInstancePatchProfile() bool { + return true +} + +type InstancePatchProfileIntf interface { + isaInstancePatchProfile() bool +} + +// UnmarshalInstancePatchProfile unmarshals an instance of InstancePatchProfile from the specified map of raw messages. +func UnmarshalInstancePatchProfile(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePatchProfile) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePlacementTarget : InstancePlacementTarget struct +// Models which "extend" this model: +// - InstancePlacementTargetDedicatedHostGroupReference +// - InstancePlacementTargetDedicatedHostReference +// - InstancePlacementTargetPlacementGroupReference +type InstancePlacementTarget struct { + // The CRN for this dedicated host group. + CRN *string `json:"crn,omitempty"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *DedicatedHostGroupReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this dedicated host group. + Href *string `json:"href,omitempty"` + + // The unique identifier for this dedicated host group. + ID *string `json:"id,omitempty"` + + // The name for this dedicated host group. The name is unique across all dedicated host groups in the region. + Name *string `json:"name,omitempty"` + + // The resource type. + ResourceType *string `json:"resource_type,omitempty"` +} + +// Constants associated with the InstancePlacementTarget.ResourceType property. +// The resource type. +const ( + InstancePlacementTargetResourceTypeDedicatedHostGroupConst = "dedicated_host_group" +) + +func (*InstancePlacementTarget) isaInstancePlacementTarget() bool { + return true +} + +type InstancePlacementTargetIntf interface { + isaInstancePlacementTarget() bool +} + +// UnmarshalInstancePlacementTarget unmarshals an instance of InstancePlacementTarget from the specified map of raw messages. +func UnmarshalInstancePlacementTarget(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePlacementTarget) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalDedicatedHostGroupReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePlacementTargetPatch : InstancePlacementTargetPatch struct +// Models which "extend" this model: +// - InstancePlacementTargetPatchDedicatedHostIdentity +// - InstancePlacementTargetPatchDedicatedHostGroupIdentity +type InstancePlacementTargetPatch struct { + // The unique identifier for this dedicated host. + ID *string `json:"id,omitempty"` + + // The CRN for this dedicated host. + CRN *string `json:"crn,omitempty"` + + // The URL for this dedicated host. + Href *string `json:"href,omitempty"` +} + +func (*InstancePlacementTargetPatch) isaInstancePlacementTargetPatch() bool { + return true +} + +type InstancePlacementTargetPatchIntf interface { + isaInstancePlacementTargetPatch() bool +} + +// UnmarshalInstancePlacementTargetPatch unmarshals an instance of InstancePlacementTargetPatch from the specified map of raw messages. +func UnmarshalInstancePlacementTargetPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePlacementTargetPatch) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePlacementTargetPrototype : InstancePlacementTargetPrototype struct +// Models which "extend" this model: +// - InstancePlacementTargetPrototypeDedicatedHostIdentity +// - InstancePlacementTargetPrototypeDedicatedHostGroupIdentity +// - InstancePlacementTargetPrototypePlacementGroupIdentity +type InstancePlacementTargetPrototype struct { + // The unique identifier for this dedicated host. + ID *string `json:"id,omitempty"` + + // The CRN for this dedicated host. + CRN *string `json:"crn,omitempty"` + + // The URL for this dedicated host. + Href *string `json:"href,omitempty"` +} + +func (*InstancePlacementTargetPrototype) isaInstancePlacementTargetPrototype() bool { + return true +} + +type InstancePlacementTargetPrototypeIntf interface { + isaInstancePlacementTargetPrototype() bool +} + +// UnmarshalInstancePlacementTargetPrototype unmarshals an instance of InstancePlacementTargetPrototype from the specified map of raw messages. +func UnmarshalInstancePlacementTargetPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePlacementTargetPrototype) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfile : InstanceProfile struct +type InstanceProfile struct { + Bandwidth InstanceProfileBandwidthIntf `json:"bandwidth" validate:"required"` + + // Collection of the instance profile's disks. + Disks []InstanceProfileDisk `json:"disks" validate:"required"` + + // The product family this virtual server instance profile belongs to. + Family *string `json:"family" validate:"required"` + + GpuCount InstanceProfileGpuIntf `json:"gpu_count,omitempty"` + + GpuManufacturer *InstanceProfileGpuManufacturer `json:"gpu_manufacturer,omitempty"` + + GpuMemory InstanceProfileGpuMemoryIntf `json:"gpu_memory,omitempty"` + + GpuModel *InstanceProfileGpuModel `json:"gpu_model,omitempty"` + + // The URL for this virtual server instance profile. + Href *string `json:"href" validate:"required"` + + Memory InstanceProfileMemoryIntf `json:"memory" validate:"required"` + + // The globally unique name for this virtual server instance profile. + Name *string `json:"name" validate:"required"` + + NetworkInterfaceCount InstanceProfileNetworkInterfaceCountIntf `json:"network_interface_count" validate:"required"` + + OsArchitecture *InstanceProfileOsArchitecture `json:"os_architecture" validate:"required"` + + PortSpeed InstanceProfilePortSpeedIntf `json:"port_speed" validate:"required"` + + TotalVolumeBandwidth InstanceProfileVolumeBandwidthIntf `json:"total_volume_bandwidth" validate:"required"` + + VcpuArchitecture *InstanceProfileVcpuArchitecture `json:"vcpu_architecture" validate:"required"` + + VcpuCount InstanceProfileVcpuIntf `json:"vcpu_count" validate:"required"` + + VcpuManufacturer *InstanceProfileVcpuManufacturer `json:"vcpu_manufacturer" validate:"required"` +} + +// UnmarshalInstanceProfile unmarshals an instance of InstanceProfile from the specified map of raw messages. +func UnmarshalInstanceProfile(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfile) + err = core.UnmarshalModel(m, "bandwidth", &obj.Bandwidth, UnmarshalInstanceProfileBandwidth) + if err != nil { + return + } + err = core.UnmarshalModel(m, "disks", &obj.Disks, UnmarshalInstanceProfileDisk) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "family", &obj.Family) + if err != nil { + return + } + err = core.UnmarshalModel(m, "gpu_count", &obj.GpuCount, UnmarshalInstanceProfileGpu) + if err != nil { + return + } + err = core.UnmarshalModel(m, "gpu_manufacturer", &obj.GpuManufacturer, UnmarshalInstanceProfileGpuManufacturer) + if err != nil { + return + } + err = core.UnmarshalModel(m, "gpu_memory", &obj.GpuMemory, UnmarshalInstanceProfileGpuMemory) + if err != nil { + return + } + err = core.UnmarshalModel(m, "gpu_model", &obj.GpuModel, UnmarshalInstanceProfileGpuModel) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalModel(m, "memory", &obj.Memory, UnmarshalInstanceProfileMemory) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "network_interface_count", &obj.NetworkInterfaceCount, UnmarshalInstanceProfileNetworkInterfaceCount) + if err != nil { + return + } + err = core.UnmarshalModel(m, "os_architecture", &obj.OsArchitecture, UnmarshalInstanceProfileOsArchitecture) + if err != nil { + return + } + err = core.UnmarshalModel(m, "port_speed", &obj.PortSpeed, UnmarshalInstanceProfilePortSpeed) + if err != nil { + return + } + err = core.UnmarshalModel(m, "total_volume_bandwidth", &obj.TotalVolumeBandwidth, UnmarshalInstanceProfileVolumeBandwidth) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vcpu_architecture", &obj.VcpuArchitecture, UnmarshalInstanceProfileVcpuArchitecture) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vcpu_count", &obj.VcpuCount, UnmarshalInstanceProfileVcpu) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vcpu_manufacturer", &obj.VcpuManufacturer, UnmarshalInstanceProfileVcpuManufacturer) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileBandwidth : InstanceProfileBandwidth struct +// Models which "extend" this model: +// - InstanceProfileBandwidthFixed +// - InstanceProfileBandwidthRange +// - InstanceProfileBandwidthEnum +// - InstanceProfileBandwidthDependent +type InstanceProfileBandwidth struct { + // The type for this profile field. + Type *string `json:"type,omitempty"` + + // The value for this profile field. + Value *int64 `json:"value,omitempty"` + + // The default value for this profile field. + Default *int64 `json:"default,omitempty"` + + // The maximum value for this profile field. + Max *int64 `json:"max,omitempty"` + + // The minimum value for this profile field. + Min *int64 `json:"min,omitempty"` + + // The increment step value for this profile field. + Step *int64 `json:"step,omitempty"` + + // The permitted values for this profile field. + Values []int64 `json:"values,omitempty"` +} + +// Constants associated with the InstanceProfileBandwidth.Type property. +// The type for this profile field. +const ( + InstanceProfileBandwidthTypeFixedConst = "fixed" +) + +func (*InstanceProfileBandwidth) isaInstanceProfileBandwidth() bool { + return true +} + +type InstanceProfileBandwidthIntf interface { + isaInstanceProfileBandwidth() bool +} + +// UnmarshalInstanceProfileBandwidth unmarshals an instance of InstanceProfileBandwidth from the specified map of raw messages. +func UnmarshalInstanceProfileBandwidth(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileBandwidth) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileCollection : InstanceProfileCollection struct +type InstanceProfileCollection struct { + // Collection of virtual server instance profiles. + Profiles []InstanceProfile `json:"profiles" validate:"required"` +} + +// UnmarshalInstanceProfileCollection unmarshals an instance of InstanceProfileCollection from the specified map of raw messages. +func UnmarshalInstanceProfileCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileCollection) + err = core.UnmarshalModel(m, "profiles", &obj.Profiles, UnmarshalInstanceProfile) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileDisk : Disks provided by this profile. +type InstanceProfileDisk struct { + Quantity InstanceProfileDiskQuantityIntf `json:"quantity" validate:"required"` + + Size InstanceProfileDiskSizeIntf `json:"size" validate:"required"` + + SupportedInterfaceTypes *InstanceProfileDiskSupportedInterfaces `json:"supported_interface_types" validate:"required"` +} + +// UnmarshalInstanceProfileDisk unmarshals an instance of InstanceProfileDisk from the specified map of raw messages. +func UnmarshalInstanceProfileDisk(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileDisk) + err = core.UnmarshalModel(m, "quantity", &obj.Quantity, UnmarshalInstanceProfileDiskQuantity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "size", &obj.Size, UnmarshalInstanceProfileDiskSize) + if err != nil { + return + } + err = core.UnmarshalModel(m, "supported_interface_types", &obj.SupportedInterfaceTypes, UnmarshalInstanceProfileDiskSupportedInterfaces) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileDiskQuantity : InstanceProfileDiskQuantity struct +// Models which "extend" this model: +// - InstanceProfileDiskQuantityFixed +// - InstanceProfileDiskQuantityRange +// - InstanceProfileDiskQuantityEnum +// - InstanceProfileDiskQuantityDependent +type InstanceProfileDiskQuantity struct { + // The type for this profile field. + Type *string `json:"type,omitempty"` + + // The value for this profile field. + Value *int64 `json:"value,omitempty"` + + // The default value for this profile field. + Default *int64 `json:"default,omitempty"` + + // The maximum value for this profile field. + Max *int64 `json:"max,omitempty"` + + // The minimum value for this profile field. + Min *int64 `json:"min,omitempty"` + + // The increment step value for this profile field. + Step *int64 `json:"step,omitempty"` + + // The permitted values for this profile field. + Values []int64 `json:"values,omitempty"` +} + +// Constants associated with the InstanceProfileDiskQuantity.Type property. +// The type for this profile field. +const ( + InstanceProfileDiskQuantityTypeFixedConst = "fixed" +) + +func (*InstanceProfileDiskQuantity) isaInstanceProfileDiskQuantity() bool { + return true +} + +type InstanceProfileDiskQuantityIntf interface { + isaInstanceProfileDiskQuantity() bool +} + +// UnmarshalInstanceProfileDiskQuantity unmarshals an instance of InstanceProfileDiskQuantity from the specified map of raw messages. +func UnmarshalInstanceProfileDiskQuantity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileDiskQuantity) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileDiskSize : InstanceProfileDiskSize struct +// Models which "extend" this model: +// - InstanceProfileDiskSizeFixed +// - InstanceProfileDiskSizeRange +// - InstanceProfileDiskSizeEnum +// - InstanceProfileDiskSizeDependent +type InstanceProfileDiskSize struct { + // The type for this profile field. + Type *string `json:"type,omitempty"` + + // The value for this profile field. + Value *int64 `json:"value,omitempty"` + + // The default value for this profile field. + Default *int64 `json:"default,omitempty"` + + // The maximum value for this profile field. + Max *int64 `json:"max,omitempty"` + + // The minimum value for this profile field. + Min *int64 `json:"min,omitempty"` + + // The increment step value for this profile field. + Step *int64 `json:"step,omitempty"` + + // The permitted values for this profile field. + Values []int64 `json:"values,omitempty"` +} + +// Constants associated with the InstanceProfileDiskSize.Type property. +// The type for this profile field. +const ( + InstanceProfileDiskSizeTypeFixedConst = "fixed" +) + +func (*InstanceProfileDiskSize) isaInstanceProfileDiskSize() bool { + return true +} + +type InstanceProfileDiskSizeIntf interface { + isaInstanceProfileDiskSize() bool +} + +// UnmarshalInstanceProfileDiskSize unmarshals an instance of InstanceProfileDiskSize from the specified map of raw messages. +func UnmarshalInstanceProfileDiskSize(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileDiskSize) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileDiskSupportedInterfaces : InstanceProfileDiskSupportedInterfaces struct +type InstanceProfileDiskSupportedInterfaces struct { + // The disk interface used for attaching the disk. + // + // The enumerated values for this property are expected to expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the + // unexpected property value was encountered. + Default *string `json:"default" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The supported disk interfaces used for attaching the disk. + Values []string `json:"values" validate:"required"` +} + +// Constants associated with the InstanceProfileDiskSupportedInterfaces.Default property. +// The disk interface used for attaching the disk. +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the +// unexpected property value was encountered. +const ( + InstanceProfileDiskSupportedInterfacesDefaultNvmeConst = "nvme" + InstanceProfileDiskSupportedInterfacesDefaultVirtioBlkConst = "virtio_blk" +) + +// Constants associated with the InstanceProfileDiskSupportedInterfaces.Type property. +// The type for this profile field. +const ( + InstanceProfileDiskSupportedInterfacesTypeEnumConst = "enum" +) + +// Constants associated with the InstanceProfileDiskSupportedInterfaces.Values property. +// The disk interface used for attaching the disk. +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the +// unexpected property value was encountered. +const ( + InstanceProfileDiskSupportedInterfacesValuesNvmeConst = "nvme" + InstanceProfileDiskSupportedInterfacesValuesVirtioBlkConst = "virtio_blk" +) + +// UnmarshalInstanceProfileDiskSupportedInterfaces unmarshals an instance of InstanceProfileDiskSupportedInterfaces from the specified map of raw messages. +func UnmarshalInstanceProfileDiskSupportedInterfaces(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileDiskSupportedInterfaces) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileGpu : InstanceProfileGpu struct +// Models which "extend" this model: +// - InstanceProfileGpuFixed +// - InstanceProfileGpuRange +// - InstanceProfileGpuEnum +// - InstanceProfileGpuDependent +type InstanceProfileGpu struct { + // The type for this profile field. + Type *string `json:"type,omitempty"` + + // The value for this profile field. + Value *int64 `json:"value,omitempty"` + + // The default value for this profile field. + Default *int64 `json:"default,omitempty"` + + // The maximum value for this profile field. + Max *int64 `json:"max,omitempty"` + + // The minimum value for this profile field. + Min *int64 `json:"min,omitempty"` + + // The increment step value for this profile field. + Step *int64 `json:"step,omitempty"` + + // The permitted values for this profile field. + Values []int64 `json:"values,omitempty"` +} + +// Constants associated with the InstanceProfileGpu.Type property. +// The type for this profile field. +const ( + InstanceProfileGpuTypeFixedConst = "fixed" +) + +func (*InstanceProfileGpu) isaInstanceProfileGpu() bool { + return true +} + +type InstanceProfileGpuIntf interface { + isaInstanceProfileGpu() bool +} + +// UnmarshalInstanceProfileGpu unmarshals an instance of InstanceProfileGpu from the specified map of raw messages. +func UnmarshalInstanceProfileGpu(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileGpu) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileGpuManufacturer : InstanceProfileGpuManufacturer struct +type InstanceProfileGpuManufacturer struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The possible GPU manufacturer(s) for an instance with this profile. + Values []string `json:"values" validate:"required"` +} + +// Constants associated with the InstanceProfileGpuManufacturer.Type property. +// The type for this profile field. +const ( + InstanceProfileGpuManufacturerTypeEnumConst = "enum" +) + +// UnmarshalInstanceProfileGpuManufacturer unmarshals an instance of InstanceProfileGpuManufacturer from the specified map of raw messages. +func UnmarshalInstanceProfileGpuManufacturer(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileGpuManufacturer) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileGpuMemory : InstanceProfileGpuMemory struct +// Models which "extend" this model: +// - InstanceProfileGpuMemoryFixed +// - InstanceProfileGpuMemoryRange +// - InstanceProfileGpuMemoryEnum +// - InstanceProfileGpuMemoryDependent +type InstanceProfileGpuMemory struct { + // The type for this profile field. + Type *string `json:"type,omitempty"` + + // The value for this profile field. + Value *int64 `json:"value,omitempty"` + + // The default value for this profile field. + Default *int64 `json:"default,omitempty"` + + // The maximum value for this profile field. + Max *int64 `json:"max,omitempty"` + + // The minimum value for this profile field. + Min *int64 `json:"min,omitempty"` + + // The increment step value for this profile field. + Step *int64 `json:"step,omitempty"` + + // The permitted values for this profile field. + Values []int64 `json:"values,omitempty"` +} + +// Constants associated with the InstanceProfileGpuMemory.Type property. +// The type for this profile field. +const ( + InstanceProfileGpuMemoryTypeFixedConst = "fixed" +) + +func (*InstanceProfileGpuMemory) isaInstanceProfileGpuMemory() bool { + return true +} + +type InstanceProfileGpuMemoryIntf interface { + isaInstanceProfileGpuMemory() bool +} + +// UnmarshalInstanceProfileGpuMemory unmarshals an instance of InstanceProfileGpuMemory from the specified map of raw messages. +func UnmarshalInstanceProfileGpuMemory(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileGpuMemory) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileGpuModel : InstanceProfileGpuModel struct +type InstanceProfileGpuModel struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The possible GPU model(s) for an instance with this profile. + Values []string `json:"values" validate:"required"` +} + +// Constants associated with the InstanceProfileGpuModel.Type property. +// The type for this profile field. +const ( + InstanceProfileGpuModelTypeEnumConst = "enum" +) + +// UnmarshalInstanceProfileGpuModel unmarshals an instance of InstanceProfileGpuModel from the specified map of raw messages. +func UnmarshalInstanceProfileGpuModel(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileGpuModel) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileIdentity : Identifies an instance profile by a unique property. +// Models which "extend" this model: +// - InstanceProfileIdentityByName +// - InstanceProfileIdentityByHref +type InstanceProfileIdentity struct { + // The globally unique name for this virtual server instance profile. + Name *string `json:"name,omitempty"` + + // The URL for this virtual server instance profile. + Href *string `json:"href,omitempty"` +} + +func (*InstanceProfileIdentity) isaInstanceProfileIdentity() bool { + return true +} + +type InstanceProfileIdentityIntf interface { + isaInstanceProfileIdentity() bool +} + +// UnmarshalInstanceProfileIdentity unmarshals an instance of InstanceProfileIdentity from the specified map of raw messages. +func UnmarshalInstanceProfileIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileIdentity) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileMemory : InstanceProfileMemory struct +// Models which "extend" this model: +// - InstanceProfileMemoryFixed +// - InstanceProfileMemoryRange +// - InstanceProfileMemoryEnum +// - InstanceProfileMemoryDependent +type InstanceProfileMemory struct { + // The type for this profile field. + Type *string `json:"type,omitempty"` + + // The value for this profile field. + Value *int64 `json:"value,omitempty"` + + // The default value for this profile field. + Default *int64 `json:"default,omitempty"` + + // The maximum value for this profile field. + Max *int64 `json:"max,omitempty"` + + // The minimum value for this profile field. + Min *int64 `json:"min,omitempty"` + + // The increment step value for this profile field. + Step *int64 `json:"step,omitempty"` + + // The permitted values for this profile field. + Values []int64 `json:"values,omitempty"` +} + +// Constants associated with the InstanceProfileMemory.Type property. +// The type for this profile field. +const ( + InstanceProfileMemoryTypeFixedConst = "fixed" +) + +func (*InstanceProfileMemory) isaInstanceProfileMemory() bool { + return true +} + +type InstanceProfileMemoryIntf interface { + isaInstanceProfileMemory() bool +} + +// UnmarshalInstanceProfileMemory unmarshals an instance of InstanceProfileMemory from the specified map of raw messages. +func UnmarshalInstanceProfileMemory(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileMemory) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileNetworkInterfaceCount : InstanceProfileNetworkInterfaceCount struct +// Models which "extend" this model: +// - InstanceProfileNetworkInterfaceCountRange +// - InstanceProfileNetworkInterfaceCountDependent +type InstanceProfileNetworkInterfaceCount struct { + // The maximum value for this profile field. + Max *int64 `json:"max,omitempty"` + + // The minimum value for this profile field. + Min *int64 `json:"min,omitempty"` + + // The type for this profile field. + Type *string `json:"type,omitempty"` +} + +// Constants associated with the InstanceProfileNetworkInterfaceCount.Type property. +// The type for this profile field. +const ( + InstanceProfileNetworkInterfaceCountTypeRangeConst = "range" +) + +func (*InstanceProfileNetworkInterfaceCount) isaInstanceProfileNetworkInterfaceCount() bool { + return true +} + +type InstanceProfileNetworkInterfaceCountIntf interface { + isaInstanceProfileNetworkInterfaceCount() bool +} + +// UnmarshalInstanceProfileNetworkInterfaceCount unmarshals an instance of InstanceProfileNetworkInterfaceCount from the specified map of raw messages. +func UnmarshalInstanceProfileNetworkInterfaceCount(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileNetworkInterfaceCount) + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileOsArchitecture : InstanceProfileOsArchitecture struct +type InstanceProfileOsArchitecture struct { + // The default OS architecture for an instance with this profile. + Default *string `json:"default" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The supported OS architecture(s) for an instance with this profile. + Values []string `json:"values" validate:"required"` +} + +// Constants associated with the InstanceProfileOsArchitecture.Type property. +// The type for this profile field. +const ( + InstanceProfileOsArchitectureTypeEnumConst = "enum" +) + +// UnmarshalInstanceProfileOsArchitecture unmarshals an instance of InstanceProfileOsArchitecture from the specified map of raw messages. +func UnmarshalInstanceProfileOsArchitecture(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileOsArchitecture) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfilePortSpeed : InstanceProfilePortSpeed struct +// Models which "extend" this model: +// - InstanceProfilePortSpeedFixed +// - InstanceProfilePortSpeedDependent +type InstanceProfilePortSpeed struct { + // The type for this profile field. + Type *string `json:"type,omitempty"` + + // The value for this profile field. + Value *int64 `json:"value,omitempty"` +} + +// Constants associated with the InstanceProfilePortSpeed.Type property. +// The type for this profile field. +const ( + InstanceProfilePortSpeedTypeFixedConst = "fixed" +) + +func (*InstanceProfilePortSpeed) isaInstanceProfilePortSpeed() bool { + return true +} + +type InstanceProfilePortSpeedIntf interface { + isaInstanceProfilePortSpeed() bool +} + +// UnmarshalInstanceProfilePortSpeed unmarshals an instance of InstanceProfilePortSpeed from the specified map of raw messages. +func UnmarshalInstanceProfilePortSpeed(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfilePortSpeed) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileReference : InstanceProfileReference struct +type InstanceProfileReference struct { + // The URL for this virtual server instance profile. + Href *string `json:"href" validate:"required"` + + // The globally unique name for this virtual server instance profile. + Name *string `json:"name" validate:"required"` +} + +// UnmarshalInstanceProfileReference unmarshals an instance of InstanceProfileReference from the specified map of raw messages. +func UnmarshalInstanceProfileReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileReference) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileVcpu : InstanceProfileVcpu struct +// Models which "extend" this model: +// - InstanceProfileVcpuFixed +// - InstanceProfileVcpuRange +// - InstanceProfileVcpuEnum +// - InstanceProfileVcpuDependent +type InstanceProfileVcpu struct { + // The type for this profile field. + Type *string `json:"type,omitempty"` + + // The value for this profile field. + Value *int64 `json:"value,omitempty"` + + // The default value for this profile field. + Default *int64 `json:"default,omitempty"` + + // The maximum value for this profile field. + Max *int64 `json:"max,omitempty"` + + // The minimum value for this profile field. + Min *int64 `json:"min,omitempty"` + + // The increment step value for this profile field. + Step *int64 `json:"step,omitempty"` + + // The permitted values for this profile field. + Values []int64 `json:"values,omitempty"` +} + +// Constants associated with the InstanceProfileVcpu.Type property. +// The type for this profile field. +const ( + InstanceProfileVcpuTypeFixedConst = "fixed" +) + +func (*InstanceProfileVcpu) isaInstanceProfileVcpu() bool { + return true +} + +type InstanceProfileVcpuIntf interface { + isaInstanceProfileVcpu() bool +} + +// UnmarshalInstanceProfileVcpu unmarshals an instance of InstanceProfileVcpu from the specified map of raw messages. +func UnmarshalInstanceProfileVcpu(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileVcpu) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileVcpuArchitecture : InstanceProfileVcpuArchitecture struct +type InstanceProfileVcpuArchitecture struct { + // The default VCPU architecture for an instance with this profile. + Default *string `json:"default,omitempty"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The VCPU architecture for an instance with this profile. + Value *string `json:"value" validate:"required"` +} + +// Constants associated with the InstanceProfileVcpuArchitecture.Type property. +// The type for this profile field. +const ( + InstanceProfileVcpuArchitectureTypeFixedConst = "fixed" +) + +// UnmarshalInstanceProfileVcpuArchitecture unmarshals an instance of InstanceProfileVcpuArchitecture from the specified map of raw messages. +func UnmarshalInstanceProfileVcpuArchitecture(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileVcpuArchitecture) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileVcpuManufacturer : InstanceProfileVcpuManufacturer struct +type InstanceProfileVcpuManufacturer struct { + // The default VCPU manufacturer for an instance with this profile. + Default *string `json:"default,omitempty"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The VCPU manufacturer for an instance with this profile. + Value *string `json:"value" validate:"required"` +} + +// Constants associated with the InstanceProfileVcpuManufacturer.Type property. +// The type for this profile field. +const ( + InstanceProfileVcpuManufacturerTypeFixedConst = "fixed" +) + +// UnmarshalInstanceProfileVcpuManufacturer unmarshals an instance of InstanceProfileVcpuManufacturer from the specified map of raw messages. +func UnmarshalInstanceProfileVcpuManufacturer(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileVcpuManufacturer) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileVolumeBandwidth : InstanceProfileVolumeBandwidth struct +// Models which "extend" this model: +// - InstanceProfileVolumeBandwidthFixed +// - InstanceProfileVolumeBandwidthRange +// - InstanceProfileVolumeBandwidthEnum +// - InstanceProfileVolumeBandwidthDependent +type InstanceProfileVolumeBandwidth struct { + // The type for this profile field. + Type *string `json:"type,omitempty"` + + // The value for this profile field. + Value *int64 `json:"value,omitempty"` + + // The default value for this profile field. + Default *int64 `json:"default,omitempty"` + + // The maximum value for this profile field. + Max *int64 `json:"max,omitempty"` + + // The minimum value for this profile field. + Min *int64 `json:"min,omitempty"` + + // The increment step value for this profile field. + Step *int64 `json:"step,omitempty"` + + // The permitted values for this profile field. + Values []int64 `json:"values,omitempty"` +} + +// Constants associated with the InstanceProfileVolumeBandwidth.Type property. +// The type for this profile field. +const ( + InstanceProfileVolumeBandwidthTypeFixedConst = "fixed" +) + +func (*InstanceProfileVolumeBandwidth) isaInstanceProfileVolumeBandwidth() bool { + return true +} + +type InstanceProfileVolumeBandwidthIntf interface { + isaInstanceProfileVolumeBandwidth() bool +} + +// UnmarshalInstanceProfileVolumeBandwidth unmarshals an instance of InstanceProfileVolumeBandwidth from the specified map of raw messages. +func UnmarshalInstanceProfileVolumeBandwidth(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileVolumeBandwidth) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePrototype : InstancePrototype struct +// Models which "extend" this model: +// - InstancePrototypeInstanceByImage +// - InstancePrototypeInstanceByCatalogOffering +// - InstancePrototypeInstanceByVolume +// - InstancePrototypeInstanceBySourceSnapshot +// - InstancePrototypeInstanceBySourceTemplate +type InstancePrototype struct { + // The availability policy to use for this virtual server instance. + AvailabilityPolicy *InstanceAvailabilityPolicyPrototype `json:"availability_policy,omitempty"` + + // The default trusted profile configuration to use for this virtual server instance + // + // This property's value is used when provisioning the virtual server instance, but not + // subsequently managed. Accordingly, it is reflected as an [instance + // initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) + // property. + DefaultTrustedProfile *InstanceDefaultTrustedProfilePrototype `json:"default_trusted_profile,omitempty"` + + // The public SSH keys for the administrative user of the virtual server instance. Keys will be made available to the + // virtual server instance as cloud-init vendor data. For cloud-init enabled images, these keys will also be added as + // SSH authorized keys for the administrative user. + // + // For Windows images, the keys of type `rsa` must be specified, and one will be selected to encrypt [the administrator + // password](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization). Keys are optional for other images, but if + // no keys are specified, the instance will be inaccessible unless the specified image provides another means of + // access. + // + // This property's value is used when provisioning the virtual server instance, but not subsequently managed. + // Accordingly, it is reflected as an [instance + // initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) property. + Keys []KeyIdentityIntf `json:"keys,omitempty"` + + // The metadata service configuration. + MetadataService *InstanceMetadataServicePrototype `json:"metadata_service,omitempty"` + + // The name for this virtual server instance. The name must not be used by another virtual server instance in the + // region. If unspecified, the name will be a hyphenated list of randomly-selected words. + // + // The system hostname will be based on this name. + Name *string `json:"name,omitempty"` + + // The placement restrictions to use for the virtual server instance. + PlacementTarget InstancePlacementTargetPrototypeIntf `json:"placement_target,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-profiles) to use for this + // virtual server instance. + // + // If unspecified, `bx2-2x8` will be used, but this default value is expected to change + // in the future. + Profile InstanceProfileIdentityIntf `json:"profile,omitempty"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes. An increase in + // this value will result in a corresponding decrease to + // `total_network_bandwidth`. + TotalVolumeBandwidth *int64 `json:"total_volume_bandwidth,omitempty"` + + // [User data](https://cloud.ibm.com/docs/vpc?topic=vpc-user-data) to make available when setting up the virtual server + // instance. + UserData *string `json:"user_data,omitempty"` + + // The additional volume attachments to create for the virtual server instance. + VolumeAttachments []VolumeAttachmentPrototype `json:"volume_attachments,omitempty"` + + // The VPC this virtual server instance will reside in. + // + // If specified, it must match the VPC for the subnets of the instance network + // interfaces. + VPC VPCIdentityIntf `json:"vpc,omitempty"` + + // The boot volume attachment to create for the virtual server instance. + BootVolumeAttachment *VolumeAttachmentPrototypeInstanceByImageContext `json:"boot_volume_attachment,omitempty"` + + // The image to use when provisioning the virtual server instance. + Image ImageIdentityIntf `json:"image,omitempty"` + + // The additional instance network interfaces to create. + NetworkInterfaces []NetworkInterfacePrototype `json:"network_interfaces,omitempty"` + + // The primary instance network interface to create. + PrimaryNetworkInterface *NetworkInterfacePrototype `json:"primary_network_interface,omitempty"` + + // The zone this virtual server instance will reside in. + Zone ZoneIdentityIntf `json:"zone,omitempty"` + + // The [catalog](https://cloud.ibm.com/docs/account?topic=account-restrict-by-user) offering + // or offering version to use when provisioning this virtual server instance. + // + // If an offering is specified, the latest version of that offering will be used. + // + // The specified offering or offering version may be in a different account in the same + // [enterprise](https://cloud.ibm.com/docs/account?topic=account-what-is-enterprise), subject + // to IAM policies. + CatalogOffering InstanceCatalogOfferingPrototypeIntf `json:"catalog_offering,omitempty"` + + // The template to create this virtual server instance from. + SourceTemplate InstanceTemplateIdentityIntf `json:"source_template,omitempty"` +} + +func (*InstancePrototype) isaInstancePrototype() bool { + return true +} + +type InstancePrototypeIntf interface { + isaInstancePrototype() bool +} + +// UnmarshalInstancePrototype unmarshals an instance of InstancePrototype from the specified map of raw messages. +func UnmarshalInstancePrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePrototype) + err = core.UnmarshalModel(m, "availability_policy", &obj.AvailabilityPolicy, UnmarshalInstanceAvailabilityPolicyPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "default_trusted_profile", &obj.DefaultTrustedProfile, UnmarshalInstanceDefaultTrustedProfilePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "keys", &obj.Keys, UnmarshalKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "metadata_service", &obj.MetadataService, UnmarshalInstanceMetadataServicePrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "placement_target", &obj.PlacementTarget, UnmarshalInstancePlacementTargetPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalInstanceProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_volume_bandwidth", &obj.TotalVolumeBandwidth) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_data", &obj.UserData) + if err != nil { + return + } + err = core.UnmarshalModel(m, "volume_attachments", &obj.VolumeAttachments, UnmarshalVolumeAttachmentPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "boot_volume_attachment", &obj.BootVolumeAttachment, UnmarshalVolumeAttachmentPrototypeInstanceByImageContext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "image", &obj.Image, UnmarshalImageIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "network_interfaces", &obj.NetworkInterfaces, UnmarshalNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_network_interface", &obj.PrimaryNetworkInterface, UnmarshalNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "catalog_offering", &obj.CatalogOffering, UnmarshalInstanceCatalogOfferingPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "source_template", &obj.SourceTemplate, UnmarshalInstanceTemplateIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceReference : InstanceReference struct +type InstanceReference struct { + // The CRN for this virtual server instance. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *InstanceReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this virtual server instance. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this virtual server instance. + ID *string `json:"id" validate:"required"` + + // The name for this virtual server instance. The name is unique across all virtual server instances in the region. + Name *string `json:"name" validate:"required"` +} + +// UnmarshalInstanceReference unmarshals an instance of InstanceReference from the specified map of raw messages. +func UnmarshalInstanceReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalInstanceReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type InstanceReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalInstanceReferenceDeleted unmarshals an instance of InstanceReferenceDeleted from the specified map of raw messages. +func UnmarshalInstanceReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceStatusReason : InstanceStatusReason struct +type InstanceStatusReason struct { + // A snake case string succinctly identifying the status reason. + Code *string `json:"code" validate:"required"` + + // An explanation of the status reason. + Message *string `json:"message" validate:"required"` + + // Link to documentation about this status reason. + MoreInfo *string `json:"more_info,omitempty"` +} + +// Constants associated with the InstanceStatusReason.Code property. +// A snake case string succinctly identifying the status reason. +const ( + InstanceStatusReasonCodeCannotStartConst = "cannot_start" + InstanceStatusReasonCodeCannotStartCapacityConst = "cannot_start_capacity" + InstanceStatusReasonCodeCannotStartComputeConst = "cannot_start_compute" + InstanceStatusReasonCodeCannotStartIPAddressConst = "cannot_start_ip_address" + InstanceStatusReasonCodeCannotStartNetworkConst = "cannot_start_network" + InstanceStatusReasonCodeCannotStartPlacementGroupConst = "cannot_start_placement_group" + InstanceStatusReasonCodeCannotStartStorageConst = "cannot_start_storage" + InstanceStatusReasonCodeEncryptionKeyDeletedConst = "encryption_key_deleted" + InstanceStatusReasonCodeStoppedByHostFailureConst = "stopped_by_host_failure" + InstanceStatusReasonCodeStoppedForImageCreationConst = "stopped_for_image_creation" +) + +// UnmarshalInstanceStatusReason unmarshals an instance of InstanceStatusReason from the specified map of raw messages. +func UnmarshalInstanceStatusReason(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceStatusReason) + err = core.UnmarshalPrimitive(m, "code", &obj.Code) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "message", &obj.Message) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceTemplate : InstanceTemplate struct +// Models which "extend" this model: +// - InstanceTemplateInstanceByImageInstanceTemplateContext +// - InstanceTemplateInstanceBySourceSnapshotInstanceTemplateContext +// - InstanceTemplateInstanceByCatalogOfferingInstanceTemplateContext +type InstanceTemplate struct { + // The availability policy to use for this virtual server instance. + AvailabilityPolicy *InstanceAvailabilityPolicyPrototype `json:"availability_policy,omitempty"` + + // The date and time that the instance template was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The CRN for this instance template. + CRN *string `json:"crn" validate:"required"` + + // The default trusted profile configuration to use for this virtual server instance + // + // This property's value is used when provisioning the virtual server instance, but not + // subsequently managed. Accordingly, it is reflected as an [instance + // initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) + // property. + DefaultTrustedProfile *InstanceDefaultTrustedProfilePrototype `json:"default_trusted_profile,omitempty"` + + // The URL for this instance template. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this instance template. + ID *string `json:"id" validate:"required"` + + // The public SSH keys for the administrative user of the virtual server instance. Keys will be made available to the + // virtual server instance as cloud-init vendor data. For cloud-init enabled images, these keys will also be added as + // SSH authorized keys for the administrative user. + // + // For Windows images, the keys of type `rsa` must be specified, and one will be selected to encrypt [the administrator + // password](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization). Keys are optional for other images, but if + // no keys are specified, the instance will be inaccessible unless the specified image provides another means of + // access. + // + // This property's value is used when provisioning the virtual server instance, but not subsequently managed. + // Accordingly, it is reflected as an [instance + // initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) property. + Keys []KeyIdentityIntf `json:"keys,omitempty"` + + // The metadata service configuration. + MetadataService *InstanceMetadataServicePrototype `json:"metadata_service,omitempty"` + + // The name for this instance template. The name is unique across all instance templates in the region. + Name *string `json:"name" validate:"required"` + + // The placement restrictions to use for the virtual server instance. + PlacementTarget InstancePlacementTargetPrototypeIntf `json:"placement_target,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-profiles) to use for this + // virtual server instance. + // + // If unspecified, `bx2-2x8` will be used, but this default value is expected to change + // in the future. + Profile InstanceProfileIdentityIntf `json:"profile,omitempty"` + + // The resource group for this instance template. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes. An increase in + // this value will result in a corresponding decrease to + // `total_network_bandwidth`. + TotalVolumeBandwidth *int64 `json:"total_volume_bandwidth,omitempty"` + + // [User data](https://cloud.ibm.com/docs/vpc?topic=vpc-user-data) to make available when setting up the virtual server + // instance. + UserData *string `json:"user_data,omitempty"` + + // The additional volume attachments to create for the virtual server instance. + VolumeAttachments []VolumeAttachmentPrototype `json:"volume_attachments,omitempty"` + + // The VPC this virtual server instance will reside in. + // + // If specified, it must match the VPC for the subnets of the instance network + // interfaces. + VPC VPCIdentityIntf `json:"vpc,omitempty"` + + // The boot volume attachment to create for the virtual server instance. + BootVolumeAttachment *VolumeAttachmentPrototypeInstanceByImageContext `json:"boot_volume_attachment,omitempty"` + + // The image to use when provisioning the virtual server instance. + Image ImageIdentityIntf `json:"image,omitempty"` + + // The additional instance network interfaces to create. + NetworkInterfaces []NetworkInterfacePrototype `json:"network_interfaces,omitempty"` + + // The primary instance network interface to create. + PrimaryNetworkInterface *NetworkInterfacePrototype `json:"primary_network_interface,omitempty"` + + // The zone this virtual server instance will reside in. + Zone ZoneIdentityIntf `json:"zone,omitempty"` + + // The [catalog](https://cloud.ibm.com/docs/account?topic=account-restrict-by-user) offering + // or offering version to use when provisioning this virtual server instance. + // + // If an offering is specified, the latest version of that offering will be used. + // + // The specified offering or offering version may be in a different account in the same + // [enterprise](https://cloud.ibm.com/docs/account?topic=account-what-is-enterprise), subject + // to IAM policies. + CatalogOffering InstanceCatalogOfferingPrototypeIntf `json:"catalog_offering,omitempty"` +} + +func (*InstanceTemplate) isaInstanceTemplate() bool { + return true +} + +type InstanceTemplateIntf interface { + isaInstanceTemplate() bool +} + +// UnmarshalInstanceTemplate unmarshals an instance of InstanceTemplate from the specified map of raw messages. +func UnmarshalInstanceTemplate(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceTemplate) + err = core.UnmarshalModel(m, "availability_policy", &obj.AvailabilityPolicy, UnmarshalInstanceAvailabilityPolicyPrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "default_trusted_profile", &obj.DefaultTrustedProfile, UnmarshalInstanceDefaultTrustedProfilePrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalModel(m, "keys", &obj.Keys, UnmarshalKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "metadata_service", &obj.MetadataService, UnmarshalInstanceMetadataServicePrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "placement_target", &obj.PlacementTarget, UnmarshalInstancePlacementTargetPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalInstanceProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_volume_bandwidth", &obj.TotalVolumeBandwidth) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_data", &obj.UserData) + if err != nil { + return + } + err = core.UnmarshalModel(m, "volume_attachments", &obj.VolumeAttachments, UnmarshalVolumeAttachmentPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "boot_volume_attachment", &obj.BootVolumeAttachment, UnmarshalVolumeAttachmentPrototypeInstanceByImageContext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "image", &obj.Image, UnmarshalImageIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "network_interfaces", &obj.NetworkInterfaces, UnmarshalNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_network_interface", &obj.PrimaryNetworkInterface, UnmarshalNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "catalog_offering", &obj.CatalogOffering, UnmarshalInstanceCatalogOfferingPrototype) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceTemplateCollection : InstanceTemplateCollection struct +type InstanceTemplateCollection struct { + // A link to the first page of resources. + First *InstanceTemplateCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *InstanceTemplateCollectionNext `json:"next,omitempty"` + + // Collection of instance templates. + Templates []InstanceTemplateIntf `json:"templates" validate:"required"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalInstanceTemplateCollection unmarshals an instance of InstanceTemplateCollection from the specified map of raw messages. +func UnmarshalInstanceTemplateCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceTemplateCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalInstanceTemplateCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalInstanceTemplateCollectionNext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "templates", &obj.Templates, UnmarshalInstanceTemplate) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceTemplateCollectionFirst : A link to the first page of resources. +type InstanceTemplateCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalInstanceTemplateCollectionFirst unmarshals an instance of InstanceTemplateCollectionFirst from the specified map of raw messages. +func UnmarshalInstanceTemplateCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceTemplateCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceTemplateCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type InstanceTemplateCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalInstanceTemplateCollectionNext unmarshals an instance of InstanceTemplateCollectionNext from the specified map of raw messages. +func UnmarshalInstanceTemplateCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceTemplateCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceTemplateIdentity : Identifies an instance template by a unique property. +// Models which "extend" this model: +// - InstanceTemplateIdentityByID +// - InstanceTemplateIdentityByHref +// - InstanceTemplateIdentityByCRN +type InstanceTemplateIdentity struct { + // The unique identifier for this instance template. + ID *string `json:"id,omitempty"` + + // The URL for this instance template. + Href *string `json:"href,omitempty"` + + // The CRN for this instance template. + CRN *string `json:"crn,omitempty"` +} + +func (*InstanceTemplateIdentity) isaInstanceTemplateIdentity() bool { + return true +} + +type InstanceTemplateIdentityIntf interface { + isaInstanceTemplateIdentity() bool +} + +// UnmarshalInstanceTemplateIdentity unmarshals an instance of InstanceTemplateIdentity from the specified map of raw messages. +func UnmarshalInstanceTemplateIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceTemplateIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceTemplatePatch : InstanceTemplatePatch struct +type InstanceTemplatePatch struct { + // The name for this instance template. The name must not be used by another instance template in the region. + Name *string `json:"name,omitempty"` +} + +// UnmarshalInstanceTemplatePatch unmarshals an instance of InstanceTemplatePatch from the specified map of raw messages. +func UnmarshalInstanceTemplatePatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceTemplatePatch) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the InstanceTemplatePatch +func (instanceTemplatePatch *InstanceTemplatePatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(instanceTemplatePatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// InstanceTemplatePrototype : InstanceTemplatePrototype struct +// Models which "extend" this model: +// - InstanceTemplatePrototypeInstanceTemplateByImage +// - InstanceTemplatePrototypeInstanceTemplateBySourceTemplate +// - InstanceTemplatePrototypeInstanceTemplateBySourceSnapshot +// - InstanceTemplatePrototypeInstanceTemplateByCatalogOffering +type InstanceTemplatePrototype struct { + // The availability policy to use for this virtual server instance. + AvailabilityPolicy *InstanceAvailabilityPolicyPrototype `json:"availability_policy,omitempty"` + + // The default trusted profile configuration to use for this virtual server instance + // + // This property's value is used when provisioning the virtual server instance, but not + // subsequently managed. Accordingly, it is reflected as an [instance + // initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) + // property. + DefaultTrustedProfile *InstanceDefaultTrustedProfilePrototype `json:"default_trusted_profile,omitempty"` + + // The public SSH keys for the administrative user of the virtual server instance. Keys will be made available to the + // virtual server instance as cloud-init vendor data. For cloud-init enabled images, these keys will also be added as + // SSH authorized keys for the administrative user. + // + // For Windows images, the keys of type `rsa` must be specified, and one will be selected to encrypt [the administrator + // password](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization). Keys are optional for other images, but if + // no keys are specified, the instance will be inaccessible unless the specified image provides another means of + // access. + // + // This property's value is used when provisioning the virtual server instance, but not subsequently managed. + // Accordingly, it is reflected as an [instance + // initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) property. + Keys []KeyIdentityIntf `json:"keys,omitempty"` + + // The metadata service configuration. + MetadataService *InstanceMetadataServicePrototype `json:"metadata_service,omitempty"` + + // The name for this instance template. The name must not be used by another instance template in the region. If + // unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The placement restrictions to use for the virtual server instance. + PlacementTarget InstancePlacementTargetPrototypeIntf `json:"placement_target,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-profiles) to use for this + // virtual server instance. + // + // If unspecified, `bx2-2x8` will be used, but this default value is expected to change + // in the future. + Profile InstanceProfileIdentityIntf `json:"profile,omitempty"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes. An increase in + // this value will result in a corresponding decrease to + // `total_network_bandwidth`. + TotalVolumeBandwidth *int64 `json:"total_volume_bandwidth,omitempty"` + + // [User data](https://cloud.ibm.com/docs/vpc?topic=vpc-user-data) to make available when setting up the virtual server + // instance. + UserData *string `json:"user_data,omitempty"` + + // The additional volume attachments to create for the virtual server instance. + VolumeAttachments []VolumeAttachmentPrototype `json:"volume_attachments,omitempty"` + + // The VPC this virtual server instance will reside in. + // + // If specified, it must match the VPC for the subnets of the instance network + // interfaces. + VPC VPCIdentityIntf `json:"vpc,omitempty"` + + // The boot volume attachment to create for the virtual server instance. + BootVolumeAttachment *VolumeAttachmentPrototypeInstanceByImageContext `json:"boot_volume_attachment,omitempty"` + + // The image to use when provisioning the virtual server instance. + Image ImageIdentityIntf `json:"image,omitempty"` + + // The additional instance network interfaces to create. + NetworkInterfaces []NetworkInterfacePrototype `json:"network_interfaces,omitempty"` + + // The primary instance network interface to create. + PrimaryNetworkInterface *NetworkInterfacePrototype `json:"primary_network_interface,omitempty"` + + // The zone this virtual server instance will reside in. + Zone ZoneIdentityIntf `json:"zone,omitempty"` + + // The [catalog](https://cloud.ibm.com/docs/account?topic=account-restrict-by-user) + // offering version to use when provisioning this virtual server instance. + // If an offering is specified, the latest version of that offering will be used. + // + // The specified offering or offering version may be in a different account, subject to + // IAM policies. + // + // If specified, `image` must not be specified, and `source_template` must not have + // `image` specified. + CatalogOffering InstanceCatalogOfferingPrototypeIntf `json:"catalog_offering,omitempty"` + + // The template to create this virtual server instance from. + SourceTemplate InstanceTemplateIdentityIntf `json:"source_template,omitempty"` +} + +func (*InstanceTemplatePrototype) isaInstanceTemplatePrototype() bool { + return true +} + +type InstanceTemplatePrototypeIntf interface { + isaInstanceTemplatePrototype() bool +} + +// UnmarshalInstanceTemplatePrototype unmarshals an instance of InstanceTemplatePrototype from the specified map of raw messages. +func UnmarshalInstanceTemplatePrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceTemplatePrototype) + err = core.UnmarshalModel(m, "availability_policy", &obj.AvailabilityPolicy, UnmarshalInstanceAvailabilityPolicyPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "default_trusted_profile", &obj.DefaultTrustedProfile, UnmarshalInstanceDefaultTrustedProfilePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "keys", &obj.Keys, UnmarshalKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "metadata_service", &obj.MetadataService, UnmarshalInstanceMetadataServicePrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "placement_target", &obj.PlacementTarget, UnmarshalInstancePlacementTargetPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalInstanceProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_volume_bandwidth", &obj.TotalVolumeBandwidth) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_data", &obj.UserData) + if err != nil { + return + } + err = core.UnmarshalModel(m, "volume_attachments", &obj.VolumeAttachments, UnmarshalVolumeAttachmentPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "boot_volume_attachment", &obj.BootVolumeAttachment, UnmarshalVolumeAttachmentPrototypeInstanceByImageContext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "image", &obj.Image, UnmarshalImageIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "network_interfaces", &obj.NetworkInterfaces, UnmarshalNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_network_interface", &obj.PrimaryNetworkInterface, UnmarshalNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "catalog_offering", &obj.CatalogOffering, UnmarshalInstanceCatalogOfferingPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "source_template", &obj.SourceTemplate, UnmarshalInstanceTemplateIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceTemplateReference : InstanceTemplateReference struct +type InstanceTemplateReference struct { + // The CRN for this instance template. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *InstanceTemplateReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this instance template. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this instance template. + ID *string `json:"id" validate:"required"` + + // The name for this instance template. The name is unique across all instance templates in the region. + Name *string `json:"name" validate:"required"` +} + +// UnmarshalInstanceTemplateReference unmarshals an instance of InstanceTemplateReference from the specified map of raw messages. +func UnmarshalInstanceTemplateReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceTemplateReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalInstanceTemplateReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceTemplateReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type InstanceTemplateReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalInstanceTemplateReferenceDeleted unmarshals an instance of InstanceTemplateReferenceDeleted from the specified map of raw messages. +func UnmarshalInstanceTemplateReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceTemplateReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceVcpu : The virtual server instance VCPU configuration. +type InstanceVcpu struct { + // The VCPU architecture. + Architecture *string `json:"architecture" validate:"required"` + + // The number of VCPUs assigned. + Count *int64 `json:"count" validate:"required"` + + // The VCPU manufacturer. + Manufacturer *string `json:"manufacturer" validate:"required"` +} + +// UnmarshalInstanceVcpu unmarshals an instance of InstanceVcpu from the specified map of raw messages. +func UnmarshalInstanceVcpu(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceVcpu) + err = core.UnmarshalPrimitive(m, "architecture", &obj.Architecture) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "count", &obj.Count) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "manufacturer", &obj.Manufacturer) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Key : Key struct +type Key struct { + // The date and time that the key was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The CRN for this key. + CRN *string `json:"crn" validate:"required"` + + // The fingerprint for this key. The value is returned base64-encoded and prefixed with the hash algorithm (always + // `SHA256`). + Fingerprint *string `json:"fingerprint" validate:"required"` + + // The URL for this key. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this key. + ID *string `json:"id" validate:"required"` + + // The length of this key (in bits). + Length *int64 `json:"length" validate:"required"` + + // The name for this key. The name must not be used by another key in the region. If unspecified, the name will be a + // hyphenated list of randomly-selected words. + Name *string `json:"name" validate:"required"` + + // The public SSH key, consisting of two space-separated fields: the algorithm name, and the base64-encoded key. + PublicKey *string `json:"public_key" validate:"required"` + + // The resource group for this key. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The crypto-system used by this key. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the Key.Type property. +// The crypto-system used by this key. +const ( + KeyTypeEd25519Const = "ed25519" + KeyTypeRsaConst = "rsa" +) + +// UnmarshalKey unmarshals an instance of Key from the specified map of raw messages. +func UnmarshalKey(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(Key) + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "fingerprint", &obj.Fingerprint) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "length", &obj.Length) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "public_key", &obj.PublicKey) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// KeyCollection : KeyCollection struct +type KeyCollection struct { + // A link to the first page of resources. + First *KeyCollectionFirst `json:"first" validate:"required"` + + // Collection of keys. + Keys []Key `json:"keys" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *KeyCollectionNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalKeyCollection unmarshals an instance of KeyCollection from the specified map of raw messages. +func UnmarshalKeyCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(KeyCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalKeyCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalModel(m, "keys", &obj.Keys, UnmarshalKey) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalKeyCollectionNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *KeyCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// KeyCollectionFirst : A link to the first page of resources. +type KeyCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalKeyCollectionFirst unmarshals an instance of KeyCollectionFirst from the specified map of raw messages. +func UnmarshalKeyCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(KeyCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// KeyCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type KeyCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalKeyCollectionNext unmarshals an instance of KeyCollectionNext from the specified map of raw messages. +func UnmarshalKeyCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(KeyCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// KeyIdentity : Identifies a key by a unique property. +// Models which "extend" this model: +// - KeyIdentityByID +// - KeyIdentityByCRN +// - KeyIdentityByHref +// - KeyIdentityByFingerprint +type KeyIdentity struct { + // The unique identifier for this key. + ID *string `json:"id,omitempty"` + + // The CRN for this key. + CRN *string `json:"crn,omitempty"` + + // The URL for this key. + Href *string `json:"href,omitempty"` + + // The fingerprint for this key. The value is returned base64-encoded and prefixed with the hash algorithm (always + // `SHA256`). + Fingerprint *string `json:"fingerprint,omitempty"` +} + +func (*KeyIdentity) isaKeyIdentity() bool { + return true +} + +type KeyIdentityIntf interface { + isaKeyIdentity() bool +} + +// UnmarshalKeyIdentity unmarshals an instance of KeyIdentity from the specified map of raw messages. +func UnmarshalKeyIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(KeyIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "fingerprint", &obj.Fingerprint) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// KeyPatch : KeyPatch struct +type KeyPatch struct { + // The name for this key. The name must not be used by another key in the region. + Name *string `json:"name,omitempty"` +} + +// UnmarshalKeyPatch unmarshals an instance of KeyPatch from the specified map of raw messages. +func UnmarshalKeyPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(KeyPatch) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the KeyPatch +func (keyPatch *KeyPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(keyPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// KeyReference : KeyReference struct +type KeyReference struct { + // The CRN for this key. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *KeyReferenceDeleted `json:"deleted,omitempty"` + + // The fingerprint for this key. The value is returned base64-encoded and prefixed with the hash algorithm (always + // `SHA256`). + Fingerprint *string `json:"fingerprint" validate:"required"` + + // The URL for this key. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this key. + ID *string `json:"id" validate:"required"` + + // The name for this key. The name is unique across all keys in the region. + Name *string `json:"name" validate:"required"` +} + +// UnmarshalKeyReference unmarshals an instance of KeyReference from the specified map of raw messages. +func UnmarshalKeyReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(KeyReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalKeyReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "fingerprint", &obj.Fingerprint) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// KeyReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type KeyReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalKeyReferenceDeleted unmarshals an instance of KeyReferenceDeleted from the specified map of raw messages. +func UnmarshalKeyReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(KeyReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LegacyCloudObjectStorageBucketIdentity : Identifies a Cloud Object Storage bucket by a unique property. +// Models which "extend" this model: +// - LegacyCloudObjectStorageBucketIdentityCloudObjectStorageBucketIdentityByName +type LegacyCloudObjectStorageBucketIdentity struct { + // The globally unique name of this Cloud Object Storage bucket. + Name *string `json:"name,omitempty"` +} + +func (*LegacyCloudObjectStorageBucketIdentity) isaLegacyCloudObjectStorageBucketIdentity() bool { + return true +} + +type LegacyCloudObjectStorageBucketIdentityIntf interface { + isaLegacyCloudObjectStorageBucketIdentity() bool +} + +// UnmarshalLegacyCloudObjectStorageBucketIdentity unmarshals an instance of LegacyCloudObjectStorageBucketIdentity from the specified map of raw messages. +func UnmarshalLegacyCloudObjectStorageBucketIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LegacyCloudObjectStorageBucketIdentity) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LegacyCloudObjectStorageBucketReference : LegacyCloudObjectStorageBucketReference struct +type LegacyCloudObjectStorageBucketReference struct { + // The globally unique name of this Cloud Object Storage bucket. + Name *string `json:"name" validate:"required"` +} + +// UnmarshalLegacyCloudObjectStorageBucketReference unmarshals an instance of LegacyCloudObjectStorageBucketReference from the specified map of raw messages. +func UnmarshalLegacyCloudObjectStorageBucketReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LegacyCloudObjectStorageBucketReference) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ListBackupPoliciesOptions : The ListBackupPolicies options. +type ListBackupPoliciesOptions struct { + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Filters the collection to resources with a `resource_group.id` property matching the specified identifier. + ResourceGroupID *string `json:"resource_group.id,omitempty"` + + // Filters the collection to resources with a `name` property matching the exact specified name. + Name *string `json:"name,omitempty"` + + // Filters the collection to resources with an item in the `tags` property matching the exact specified tag. + Tag *string `json:"tag,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListBackupPoliciesOptions : Instantiate ListBackupPoliciesOptions +func (*VpcV1) NewListBackupPoliciesOptions() *ListBackupPoliciesOptions { + return &ListBackupPoliciesOptions{} +} + +// SetStart : Allow user to set Start +func (_options *ListBackupPoliciesOptions) SetStart(start string) *ListBackupPoliciesOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListBackupPoliciesOptions) SetLimit(limit int64) *ListBackupPoliciesOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetResourceGroupID : Allow user to set ResourceGroupID +func (_options *ListBackupPoliciesOptions) SetResourceGroupID(resourceGroupID string) *ListBackupPoliciesOptions { + _options.ResourceGroupID = core.StringPtr(resourceGroupID) + return _options +} + +// SetName : Allow user to set Name +func (_options *ListBackupPoliciesOptions) SetName(name string) *ListBackupPoliciesOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetTag : Allow user to set Tag +func (_options *ListBackupPoliciesOptions) SetTag(tag string) *ListBackupPoliciesOptions { + _options.Tag = core.StringPtr(tag) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListBackupPoliciesOptions) SetHeaders(param map[string]string) *ListBackupPoliciesOptions { + options.Headers = param + return options +} + +// ListBackupPolicyJobsOptions : The ListBackupPolicyJobs options. +type ListBackupPolicyJobsOptions struct { + // The backup policy identifier. + BackupPolicyID *string `json:"backup_policy_id" validate:"required,ne="` + + // Filters the collection to backup policy jobs with a `status` property matching the specified value. + Status *string `json:"status,omitempty"` + + // Filters the collection to backup policy jobs with a `backup_policy_plan.id` property matching the specified + // identifier. + BackupPolicyPlanID *string `json:"backup_policy_plan.id,omitempty"` + + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Sorts the returned collection by the specified property name in ascending order. A `-` may be prepended to the name + // to sort in descending order. For example, the value `-created_at` sorts the collection by the `created_at` property + // in descending order, and the value `name` sorts it by the `name` property in ascending order. + Sort *string `json:"sort,omitempty"` + + // Filters the collection to backup policy jobs with a `source.id` property matching the specified identifier. + SourceID *string `json:"source.id,omitempty"` + + // Filters the collection to backup policy jobs with an item in the `target_snapshots` property with an `id` property + // matching the specified identifier. + TargetSnapshotsID *string `json:"target_snapshots[].id,omitempty"` + + // Filters the collection to backup policy jobs with an item in the `target_snapshots` property with a `crn` property + // matching the specified CRN. + TargetSnapshotsCRN *string `json:"target_snapshots[].crn,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the ListBackupPolicyJobsOptions.Status property. +// Filters the collection to backup policy jobs with a `status` property matching the specified value. +const ( + ListBackupPolicyJobsOptionsStatusFailedConst = "failed" + ListBackupPolicyJobsOptionsStatusRunningConst = "running" + ListBackupPolicyJobsOptionsStatusSucceededConst = "succeeded" +) + +// Constants associated with the ListBackupPolicyJobsOptions.Sort property. +// Sorts the returned collection by the specified property name in ascending order. A `-` may be prepended to the name +// to sort in descending order. For example, the value `-created_at` sorts the collection by the `created_at` property +// in descending order, and the value `name` sorts it by the `name` property in ascending order. +const ( + ListBackupPolicyJobsOptionsSortCreatedAtConst = "created_at" + ListBackupPolicyJobsOptionsSortNameConst = "name" +) + +// NewListBackupPolicyJobsOptions : Instantiate ListBackupPolicyJobsOptions +func (*VpcV1) NewListBackupPolicyJobsOptions(backupPolicyID string) *ListBackupPolicyJobsOptions { + return &ListBackupPolicyJobsOptions{ + BackupPolicyID: core.StringPtr(backupPolicyID), + } +} + +// SetBackupPolicyID : Allow user to set BackupPolicyID +func (_options *ListBackupPolicyJobsOptions) SetBackupPolicyID(backupPolicyID string) *ListBackupPolicyJobsOptions { + _options.BackupPolicyID = core.StringPtr(backupPolicyID) + return _options +} + +// SetStatus : Allow user to set Status +func (_options *ListBackupPolicyJobsOptions) SetStatus(status string) *ListBackupPolicyJobsOptions { + _options.Status = core.StringPtr(status) + return _options +} + +// SetBackupPolicyPlanID : Allow user to set BackupPolicyPlanID +func (_options *ListBackupPolicyJobsOptions) SetBackupPolicyPlanID(backupPolicyPlanID string) *ListBackupPolicyJobsOptions { + _options.BackupPolicyPlanID = core.StringPtr(backupPolicyPlanID) + return _options +} + +// SetStart : Allow user to set Start +func (_options *ListBackupPolicyJobsOptions) SetStart(start string) *ListBackupPolicyJobsOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListBackupPolicyJobsOptions) SetLimit(limit int64) *ListBackupPolicyJobsOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetSort : Allow user to set Sort +func (_options *ListBackupPolicyJobsOptions) SetSort(sort string) *ListBackupPolicyJobsOptions { + _options.Sort = core.StringPtr(sort) + return _options +} + +// SetSourceID : Allow user to set SourceID +func (_options *ListBackupPolicyJobsOptions) SetSourceID(sourceID string) *ListBackupPolicyJobsOptions { + _options.SourceID = core.StringPtr(sourceID) + return _options +} + +// SetTargetSnapshotsID : Allow user to set TargetSnapshotsID +func (_options *ListBackupPolicyJobsOptions) SetTargetSnapshotsID(targetSnapshotsID string) *ListBackupPolicyJobsOptions { + _options.TargetSnapshotsID = core.StringPtr(targetSnapshotsID) + return _options +} + +// SetTargetSnapshotsCRN : Allow user to set TargetSnapshotsCRN +func (_options *ListBackupPolicyJobsOptions) SetTargetSnapshotsCRN(targetSnapshotsCRN string) *ListBackupPolicyJobsOptions { + _options.TargetSnapshotsCRN = core.StringPtr(targetSnapshotsCRN) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListBackupPolicyJobsOptions) SetHeaders(param map[string]string) *ListBackupPolicyJobsOptions { + options.Headers = param + return options +} + +// ListBackupPolicyPlansOptions : The ListBackupPolicyPlans options. +type ListBackupPolicyPlansOptions struct { + // The backup policy identifier. + BackupPolicyID *string `json:"backup_policy_id" validate:"required,ne="` + + // Filters the collection to resources with a `name` property matching the exact specified name. + Name *string `json:"name,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListBackupPolicyPlansOptions : Instantiate ListBackupPolicyPlansOptions +func (*VpcV1) NewListBackupPolicyPlansOptions(backupPolicyID string) *ListBackupPolicyPlansOptions { + return &ListBackupPolicyPlansOptions{ + BackupPolicyID: core.StringPtr(backupPolicyID), + } +} + +// SetBackupPolicyID : Allow user to set BackupPolicyID +func (_options *ListBackupPolicyPlansOptions) SetBackupPolicyID(backupPolicyID string) *ListBackupPolicyPlansOptions { + _options.BackupPolicyID = core.StringPtr(backupPolicyID) + return _options +} + +// SetName : Allow user to set Name +func (_options *ListBackupPolicyPlansOptions) SetName(name string) *ListBackupPolicyPlansOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListBackupPolicyPlansOptions) SetHeaders(param map[string]string) *ListBackupPolicyPlansOptions { + options.Headers = param + return options +} + +// ListBareMetalServerDisksOptions : The ListBareMetalServerDisks options. +type ListBareMetalServerDisksOptions struct { + // The bare metal server identifier. + BareMetalServerID *string `json:"bare_metal_server_id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListBareMetalServerDisksOptions : Instantiate ListBareMetalServerDisksOptions +func (*VpcV1) NewListBareMetalServerDisksOptions(bareMetalServerID string) *ListBareMetalServerDisksOptions { + return &ListBareMetalServerDisksOptions{ + BareMetalServerID: core.StringPtr(bareMetalServerID), + } +} + +// SetBareMetalServerID : Allow user to set BareMetalServerID +func (_options *ListBareMetalServerDisksOptions) SetBareMetalServerID(bareMetalServerID string) *ListBareMetalServerDisksOptions { + _options.BareMetalServerID = core.StringPtr(bareMetalServerID) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListBareMetalServerDisksOptions) SetHeaders(param map[string]string) *ListBareMetalServerDisksOptions { + options.Headers = param + return options +} + +// ListBareMetalServerNetworkInterfaceFloatingIpsOptions : The ListBareMetalServerNetworkInterfaceFloatingIps options. +type ListBareMetalServerNetworkInterfaceFloatingIpsOptions struct { + // The bare metal server identifier. + BareMetalServerID *string `json:"bare_metal_server_id" validate:"required,ne="` + + // The bare metal server network interface identifier. + NetworkInterfaceID *string `json:"network_interface_id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListBareMetalServerNetworkInterfaceFloatingIpsOptions : Instantiate ListBareMetalServerNetworkInterfaceFloatingIpsOptions +func (*VpcV1) NewListBareMetalServerNetworkInterfaceFloatingIpsOptions(bareMetalServerID string, networkInterfaceID string) *ListBareMetalServerNetworkInterfaceFloatingIpsOptions { + return &ListBareMetalServerNetworkInterfaceFloatingIpsOptions{ + BareMetalServerID: core.StringPtr(bareMetalServerID), + NetworkInterfaceID: core.StringPtr(networkInterfaceID), + } +} + +// SetBareMetalServerID : Allow user to set BareMetalServerID +func (_options *ListBareMetalServerNetworkInterfaceFloatingIpsOptions) SetBareMetalServerID(bareMetalServerID string) *ListBareMetalServerNetworkInterfaceFloatingIpsOptions { + _options.BareMetalServerID = core.StringPtr(bareMetalServerID) + return _options +} + +// SetNetworkInterfaceID : Allow user to set NetworkInterfaceID +func (_options *ListBareMetalServerNetworkInterfaceFloatingIpsOptions) SetNetworkInterfaceID(networkInterfaceID string) *ListBareMetalServerNetworkInterfaceFloatingIpsOptions { + _options.NetworkInterfaceID = core.StringPtr(networkInterfaceID) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListBareMetalServerNetworkInterfaceFloatingIpsOptions) SetHeaders(param map[string]string) *ListBareMetalServerNetworkInterfaceFloatingIpsOptions { + options.Headers = param + return options +} + +// ListBareMetalServerNetworkInterfaceIpsOptions : The ListBareMetalServerNetworkInterfaceIps options. +type ListBareMetalServerNetworkInterfaceIpsOptions struct { + // The bare metal server identifier. + BareMetalServerID *string `json:"bare_metal_server_id" validate:"required,ne="` + + // The bare metal server network interface identifier. + NetworkInterfaceID *string `json:"network_interface_id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListBareMetalServerNetworkInterfaceIpsOptions : Instantiate ListBareMetalServerNetworkInterfaceIpsOptions +func (*VpcV1) NewListBareMetalServerNetworkInterfaceIpsOptions(bareMetalServerID string, networkInterfaceID string) *ListBareMetalServerNetworkInterfaceIpsOptions { + return &ListBareMetalServerNetworkInterfaceIpsOptions{ + BareMetalServerID: core.StringPtr(bareMetalServerID), + NetworkInterfaceID: core.StringPtr(networkInterfaceID), + } +} + +// SetBareMetalServerID : Allow user to set BareMetalServerID +func (_options *ListBareMetalServerNetworkInterfaceIpsOptions) SetBareMetalServerID(bareMetalServerID string) *ListBareMetalServerNetworkInterfaceIpsOptions { + _options.BareMetalServerID = core.StringPtr(bareMetalServerID) + return _options +} + +// SetNetworkInterfaceID : Allow user to set NetworkInterfaceID +func (_options *ListBareMetalServerNetworkInterfaceIpsOptions) SetNetworkInterfaceID(networkInterfaceID string) *ListBareMetalServerNetworkInterfaceIpsOptions { + _options.NetworkInterfaceID = core.StringPtr(networkInterfaceID) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListBareMetalServerNetworkInterfaceIpsOptions) SetHeaders(param map[string]string) *ListBareMetalServerNetworkInterfaceIpsOptions { + options.Headers = param + return options +} + +// ListBareMetalServerNetworkInterfacesOptions : The ListBareMetalServerNetworkInterfaces options. +type ListBareMetalServerNetworkInterfacesOptions struct { + // The bare metal server identifier. + BareMetalServerID *string `json:"bare_metal_server_id" validate:"required,ne="` + + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListBareMetalServerNetworkInterfacesOptions : Instantiate ListBareMetalServerNetworkInterfacesOptions +func (*VpcV1) NewListBareMetalServerNetworkInterfacesOptions(bareMetalServerID string) *ListBareMetalServerNetworkInterfacesOptions { + return &ListBareMetalServerNetworkInterfacesOptions{ + BareMetalServerID: core.StringPtr(bareMetalServerID), + } +} + +// SetBareMetalServerID : Allow user to set BareMetalServerID +func (_options *ListBareMetalServerNetworkInterfacesOptions) SetBareMetalServerID(bareMetalServerID string) *ListBareMetalServerNetworkInterfacesOptions { + _options.BareMetalServerID = core.StringPtr(bareMetalServerID) + return _options +} + +// SetStart : Allow user to set Start +func (_options *ListBareMetalServerNetworkInterfacesOptions) SetStart(start string) *ListBareMetalServerNetworkInterfacesOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListBareMetalServerNetworkInterfacesOptions) SetLimit(limit int64) *ListBareMetalServerNetworkInterfacesOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListBareMetalServerNetworkInterfacesOptions) SetHeaders(param map[string]string) *ListBareMetalServerNetworkInterfacesOptions { + options.Headers = param + return options +} + +// ListBareMetalServerProfilesOptions : The ListBareMetalServerProfiles options. +type ListBareMetalServerProfilesOptions struct { + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListBareMetalServerProfilesOptions : Instantiate ListBareMetalServerProfilesOptions +func (*VpcV1) NewListBareMetalServerProfilesOptions() *ListBareMetalServerProfilesOptions { + return &ListBareMetalServerProfilesOptions{} +} + +// SetStart : Allow user to set Start +func (_options *ListBareMetalServerProfilesOptions) SetStart(start string) *ListBareMetalServerProfilesOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListBareMetalServerProfilesOptions) SetLimit(limit int64) *ListBareMetalServerProfilesOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListBareMetalServerProfilesOptions) SetHeaders(param map[string]string) *ListBareMetalServerProfilesOptions { + options.Headers = param + return options +} + +// ListBareMetalServersOptions : The ListBareMetalServers options. +type ListBareMetalServersOptions struct { + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Filters the collection to resources with a `resource_group.id` property matching the specified identifier. + ResourceGroupID *string `json:"resource_group.id,omitempty"` + + // Filters the collection to resources with a `name` property matching the exact specified name. + Name *string `json:"name,omitempty"` + + // Filters the collection to resources with a `vpc.id` property matching the specified identifier. + VPCID *string `json:"vpc.id,omitempty"` + + // Filters the collection to resources with a `vpc.crn` property matching the specified CRN. + VPCCRN *string `json:"vpc.crn,omitempty"` + + // Filters the collection to resources with a `vpc.name` property matching the exact specified name. + VPCName *string `json:"vpc.name,omitempty"` + + // Filters the collection to bare metal servers with an item in the `network_interfaces` property with a `subnet.id` + // property matching the specified identifier. + NetworkInterfacesSubnetID *string `json:"network_interfaces.subnet.id,omitempty"` + + // Filters the collection to bare metal servers with an item in the `network_interfaces` property with a `subnet.crn` + // property matching the specified CRN. + NetworkInterfacesSubnetCRN *string `json:"network_interfaces.subnet.crn,omitempty"` + + // Filters the collection to bare metal servers with an item in the `network_interfaces` property with a `subnet.name` + // property matching the exact specified name. + NetworkInterfacesSubnetName *string `json:"network_interfaces.subnet.name,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListBareMetalServersOptions : Instantiate ListBareMetalServersOptions +func (*VpcV1) NewListBareMetalServersOptions() *ListBareMetalServersOptions { + return &ListBareMetalServersOptions{} +} + +// SetStart : Allow user to set Start +func (_options *ListBareMetalServersOptions) SetStart(start string) *ListBareMetalServersOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListBareMetalServersOptions) SetLimit(limit int64) *ListBareMetalServersOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetResourceGroupID : Allow user to set ResourceGroupID +func (_options *ListBareMetalServersOptions) SetResourceGroupID(resourceGroupID string) *ListBareMetalServersOptions { + _options.ResourceGroupID = core.StringPtr(resourceGroupID) + return _options +} + +// SetName : Allow user to set Name +func (_options *ListBareMetalServersOptions) SetName(name string) *ListBareMetalServersOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetVPCID : Allow user to set VPCID +func (_options *ListBareMetalServersOptions) SetVPCID(vpcID string) *ListBareMetalServersOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetVPCCRN : Allow user to set VPCCRN +func (_options *ListBareMetalServersOptions) SetVPCCRN(vpcCRN string) *ListBareMetalServersOptions { + _options.VPCCRN = core.StringPtr(vpcCRN) + return _options +} + +// SetVPCName : Allow user to set VPCName +func (_options *ListBareMetalServersOptions) SetVPCName(vpcName string) *ListBareMetalServersOptions { + _options.VPCName = core.StringPtr(vpcName) + return _options +} + +// SetNetworkInterfacesSubnetID : Allow user to set NetworkInterfacesSubnetID +func (_options *ListBareMetalServersOptions) SetNetworkInterfacesSubnetID(networkInterfacesSubnetID string) *ListBareMetalServersOptions { + _options.NetworkInterfacesSubnetID = core.StringPtr(networkInterfacesSubnetID) + return _options +} + +// SetNetworkInterfacesSubnetCRN : Allow user to set NetworkInterfacesSubnetCRN +func (_options *ListBareMetalServersOptions) SetNetworkInterfacesSubnetCRN(networkInterfacesSubnetCRN string) *ListBareMetalServersOptions { + _options.NetworkInterfacesSubnetCRN = core.StringPtr(networkInterfacesSubnetCRN) + return _options +} + +// SetNetworkInterfacesSubnetName : Allow user to set NetworkInterfacesSubnetName +func (_options *ListBareMetalServersOptions) SetNetworkInterfacesSubnetName(networkInterfacesSubnetName string) *ListBareMetalServersOptions { + _options.NetworkInterfacesSubnetName = core.StringPtr(networkInterfacesSubnetName) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListBareMetalServersOptions) SetHeaders(param map[string]string) *ListBareMetalServersOptions { + options.Headers = param + return options +} + +// ListDedicatedHostDisksOptions : The ListDedicatedHostDisks options. +type ListDedicatedHostDisksOptions struct { + // The dedicated host identifier. + DedicatedHostID *string `json:"dedicated_host_id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListDedicatedHostDisksOptions : Instantiate ListDedicatedHostDisksOptions +func (*VpcV1) NewListDedicatedHostDisksOptions(dedicatedHostID string) *ListDedicatedHostDisksOptions { + return &ListDedicatedHostDisksOptions{ + DedicatedHostID: core.StringPtr(dedicatedHostID), + } +} + +// SetDedicatedHostID : Allow user to set DedicatedHostID +func (_options *ListDedicatedHostDisksOptions) SetDedicatedHostID(dedicatedHostID string) *ListDedicatedHostDisksOptions { + _options.DedicatedHostID = core.StringPtr(dedicatedHostID) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListDedicatedHostDisksOptions) SetHeaders(param map[string]string) *ListDedicatedHostDisksOptions { + options.Headers = param + return options +} + +// ListDedicatedHostGroupsOptions : The ListDedicatedHostGroups options. +type ListDedicatedHostGroupsOptions struct { + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Filters the collection to resources with a `resource_group.id` property matching the specified identifier. + ResourceGroupID *string `json:"resource_group.id,omitempty"` + + // Filters the collection to resources with a `zone.name` property matching the exact specified name. + ZoneName *string `json:"zone.name,omitempty"` + + // Filters the collection to resources with a `name` property matching the exact specified name. + Name *string `json:"name,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListDedicatedHostGroupsOptions : Instantiate ListDedicatedHostGroupsOptions +func (*VpcV1) NewListDedicatedHostGroupsOptions() *ListDedicatedHostGroupsOptions { + return &ListDedicatedHostGroupsOptions{} +} + +// SetStart : Allow user to set Start +func (_options *ListDedicatedHostGroupsOptions) SetStart(start string) *ListDedicatedHostGroupsOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListDedicatedHostGroupsOptions) SetLimit(limit int64) *ListDedicatedHostGroupsOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetResourceGroupID : Allow user to set ResourceGroupID +func (_options *ListDedicatedHostGroupsOptions) SetResourceGroupID(resourceGroupID string) *ListDedicatedHostGroupsOptions { + _options.ResourceGroupID = core.StringPtr(resourceGroupID) + return _options +} + +// SetZoneName : Allow user to set ZoneName +func (_options *ListDedicatedHostGroupsOptions) SetZoneName(zoneName string) *ListDedicatedHostGroupsOptions { + _options.ZoneName = core.StringPtr(zoneName) + return _options +} + +// SetName : Allow user to set Name +func (_options *ListDedicatedHostGroupsOptions) SetName(name string) *ListDedicatedHostGroupsOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListDedicatedHostGroupsOptions) SetHeaders(param map[string]string) *ListDedicatedHostGroupsOptions { + options.Headers = param + return options +} + +// ListDedicatedHostProfilesOptions : The ListDedicatedHostProfiles options. +type ListDedicatedHostProfilesOptions struct { + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListDedicatedHostProfilesOptions : Instantiate ListDedicatedHostProfilesOptions +func (*VpcV1) NewListDedicatedHostProfilesOptions() *ListDedicatedHostProfilesOptions { + return &ListDedicatedHostProfilesOptions{} +} + +// SetStart : Allow user to set Start +func (_options *ListDedicatedHostProfilesOptions) SetStart(start string) *ListDedicatedHostProfilesOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListDedicatedHostProfilesOptions) SetLimit(limit int64) *ListDedicatedHostProfilesOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListDedicatedHostProfilesOptions) SetHeaders(param map[string]string) *ListDedicatedHostProfilesOptions { + options.Headers = param + return options +} + +// ListDedicatedHostsOptions : The ListDedicatedHosts options. +type ListDedicatedHostsOptions struct { + // Filters the collection to dedicated hosts with a `group.id` property matching the specified identifier. + DedicatedHostGroupID *string `json:"dedicated_host_group.id,omitempty"` + + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Filters the collection to resources with a `resource_group.id` property matching the specified identifier. + ResourceGroupID *string `json:"resource_group.id,omitempty"` + + // Filters the collection to resources with a `zone.name` property matching the exact specified name. + ZoneName *string `json:"zone.name,omitempty"` + + // Filters the collection to resources with a `name` property matching the exact specified name. + Name *string `json:"name,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListDedicatedHostsOptions : Instantiate ListDedicatedHostsOptions +func (*VpcV1) NewListDedicatedHostsOptions() *ListDedicatedHostsOptions { + return &ListDedicatedHostsOptions{} +} + +// SetDedicatedHostGroupID : Allow user to set DedicatedHostGroupID +func (_options *ListDedicatedHostsOptions) SetDedicatedHostGroupID(dedicatedHostGroupID string) *ListDedicatedHostsOptions { + _options.DedicatedHostGroupID = core.StringPtr(dedicatedHostGroupID) + return _options +} + +// SetStart : Allow user to set Start +func (_options *ListDedicatedHostsOptions) SetStart(start string) *ListDedicatedHostsOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListDedicatedHostsOptions) SetLimit(limit int64) *ListDedicatedHostsOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetResourceGroupID : Allow user to set ResourceGroupID +func (_options *ListDedicatedHostsOptions) SetResourceGroupID(resourceGroupID string) *ListDedicatedHostsOptions { + _options.ResourceGroupID = core.StringPtr(resourceGroupID) + return _options +} + +// SetZoneName : Allow user to set ZoneName +func (_options *ListDedicatedHostsOptions) SetZoneName(zoneName string) *ListDedicatedHostsOptions { + _options.ZoneName = core.StringPtr(zoneName) + return _options +} + +// SetName : Allow user to set Name +func (_options *ListDedicatedHostsOptions) SetName(name string) *ListDedicatedHostsOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListDedicatedHostsOptions) SetHeaders(param map[string]string) *ListDedicatedHostsOptions { + options.Headers = param + return options +} + +// ListEndpointGatewayIpsOptions : The ListEndpointGatewayIps options. +type ListEndpointGatewayIpsOptions struct { + // The endpoint gateway identifier. + EndpointGatewayID *string `json:"endpoint_gateway_id" validate:"required,ne="` + + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Sorts the returned collection by the specified property name in ascending order. A `-` may be prepended to the name + // to sort in descending order. For example, the value `-created_at` sorts the collection by the `created_at` property + // in descending order, and the value `name` sorts it by the `name` property in ascending order. + Sort *string `json:"sort,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the ListEndpointGatewayIpsOptions.Sort property. +// Sorts the returned collection by the specified property name in ascending order. A `-` may be prepended to the name +// to sort in descending order. For example, the value `-created_at` sorts the collection by the `created_at` property +// in descending order, and the value `name` sorts it by the `name` property in ascending order. +const ( + ListEndpointGatewayIpsOptionsSortAddressConst = "address" + ListEndpointGatewayIpsOptionsSortCreatedAtConst = "created_at" + ListEndpointGatewayIpsOptionsSortNameConst = "name" +) + +// NewListEndpointGatewayIpsOptions : Instantiate ListEndpointGatewayIpsOptions +func (*VpcV1) NewListEndpointGatewayIpsOptions(endpointGatewayID string) *ListEndpointGatewayIpsOptions { + return &ListEndpointGatewayIpsOptions{ + EndpointGatewayID: core.StringPtr(endpointGatewayID), + } +} + +// SetEndpointGatewayID : Allow user to set EndpointGatewayID +func (_options *ListEndpointGatewayIpsOptions) SetEndpointGatewayID(endpointGatewayID string) *ListEndpointGatewayIpsOptions { + _options.EndpointGatewayID = core.StringPtr(endpointGatewayID) + return _options +} + +// SetStart : Allow user to set Start +func (_options *ListEndpointGatewayIpsOptions) SetStart(start string) *ListEndpointGatewayIpsOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListEndpointGatewayIpsOptions) SetLimit(limit int64) *ListEndpointGatewayIpsOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetSort : Allow user to set Sort +func (_options *ListEndpointGatewayIpsOptions) SetSort(sort string) *ListEndpointGatewayIpsOptions { + _options.Sort = core.StringPtr(sort) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListEndpointGatewayIpsOptions) SetHeaders(param map[string]string) *ListEndpointGatewayIpsOptions { + options.Headers = param + return options +} + +// ListEndpointGatewaysOptions : The ListEndpointGateways options. +type ListEndpointGatewaysOptions struct { + // Filters the collection to resources with a `name` property matching the exact specified name. + Name *string `json:"name,omitempty"` + + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Filters the collection to resources with a `resource_group.id` property matching the specified identifier. + ResourceGroupID *string `json:"resource_group.id,omitempty"` + + // Filters the collection to resources with a `vpc.id` property matching the specified identifier. + VPCID *string `json:"vpc.id,omitempty"` + + // Filters the collection to resources with a `vpc.crn` property matching the specified CRN. + VPCCRN *string `json:"vpc.crn,omitempty"` + + // Filters the collection to resources with a `vpc.name` property matching the exact specified name. + VPCName *string `json:"vpc.name,omitempty"` + + // Filters the collection to endpoint gateways with an `allow_dns_resolution_binding` property matching the specified + // value. + AllowDnsResolutionBinding *bool `json:"allow_dns_resolution_binding,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListEndpointGatewaysOptions : Instantiate ListEndpointGatewaysOptions +func (*VpcV1) NewListEndpointGatewaysOptions() *ListEndpointGatewaysOptions { + return &ListEndpointGatewaysOptions{} +} + +// SetName : Allow user to set Name +func (_options *ListEndpointGatewaysOptions) SetName(name string) *ListEndpointGatewaysOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetStart : Allow user to set Start +func (_options *ListEndpointGatewaysOptions) SetStart(start string) *ListEndpointGatewaysOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListEndpointGatewaysOptions) SetLimit(limit int64) *ListEndpointGatewaysOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetResourceGroupID : Allow user to set ResourceGroupID +func (_options *ListEndpointGatewaysOptions) SetResourceGroupID(resourceGroupID string) *ListEndpointGatewaysOptions { + _options.ResourceGroupID = core.StringPtr(resourceGroupID) + return _options +} + +// SetVPCID : Allow user to set VPCID +func (_options *ListEndpointGatewaysOptions) SetVPCID(vpcID string) *ListEndpointGatewaysOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetVPCCRN : Allow user to set VPCCRN +func (_options *ListEndpointGatewaysOptions) SetVPCCRN(vpcCRN string) *ListEndpointGatewaysOptions { + _options.VPCCRN = core.StringPtr(vpcCRN) + return _options +} + +// SetVPCName : Allow user to set VPCName +func (_options *ListEndpointGatewaysOptions) SetVPCName(vpcName string) *ListEndpointGatewaysOptions { + _options.VPCName = core.StringPtr(vpcName) + return _options +} + +// SetAllowDnsResolutionBinding : Allow user to set AllowDnsResolutionBinding +func (_options *ListEndpointGatewaysOptions) SetAllowDnsResolutionBinding(allowDnsResolutionBinding bool) *ListEndpointGatewaysOptions { + _options.AllowDnsResolutionBinding = core.BoolPtr(allowDnsResolutionBinding) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListEndpointGatewaysOptions) SetHeaders(param map[string]string) *ListEndpointGatewaysOptions { + options.Headers = param + return options +} + +// ListFloatingIpsOptions : The ListFloatingIps options. +type ListFloatingIpsOptions struct { + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Filters the collection to resources with a `resource_group.id` property matching the specified identifier. + ResourceGroupID *string `json:"resource_group.id,omitempty"` + + // Sorts the returned collection by the specified property name in ascending order. A `-` may be prepended to the name + // to sort in descending order. For example, the value `-created_at` sorts the collection by the `created_at` property + // in descending order, and the value `name` sorts it by the `name` property in ascending order. + Sort *string `json:"sort,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the ListFloatingIpsOptions.Sort property. +// Sorts the returned collection by the specified property name in ascending order. A `-` may be prepended to the name +// to sort in descending order. For example, the value `-created_at` sorts the collection by the `created_at` property +// in descending order, and the value `name` sorts it by the `name` property in ascending order. +const ( + ListFloatingIpsOptionsSortCreatedAtConst = "created_at" + ListFloatingIpsOptionsSortNameConst = "name" +) + +// NewListFloatingIpsOptions : Instantiate ListFloatingIpsOptions +func (*VpcV1) NewListFloatingIpsOptions() *ListFloatingIpsOptions { + return &ListFloatingIpsOptions{} +} + +// SetStart : Allow user to set Start +func (_options *ListFloatingIpsOptions) SetStart(start string) *ListFloatingIpsOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListFloatingIpsOptions) SetLimit(limit int64) *ListFloatingIpsOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetResourceGroupID : Allow user to set ResourceGroupID +func (_options *ListFloatingIpsOptions) SetResourceGroupID(resourceGroupID string) *ListFloatingIpsOptions { + _options.ResourceGroupID = core.StringPtr(resourceGroupID) + return _options +} + +// SetSort : Allow user to set Sort +func (_options *ListFloatingIpsOptions) SetSort(sort string) *ListFloatingIpsOptions { + _options.Sort = core.StringPtr(sort) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListFloatingIpsOptions) SetHeaders(param map[string]string) *ListFloatingIpsOptions { + options.Headers = param + return options +} + +// ListFlowLogCollectorsOptions : The ListFlowLogCollectors options. +type ListFlowLogCollectorsOptions struct { + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Filters the collection to resources with a `resource_group.id` property matching the specified identifier. + ResourceGroupID *string `json:"resource_group.id,omitempty"` + + // Filters the collection to resources with a `name` property matching the exact specified name. + Name *string `json:"name,omitempty"` + + // Filters the collection to resources with a `vpc.id` property matching the specified identifier. + VPCID *string `json:"vpc.id,omitempty"` + + // Filters the collection to resources with a `vpc.crn` property matching the specified CRN. + VPCCRN *string `json:"vpc.crn,omitempty"` + + // Filters the collection to resources with a `vpc.name` property matching the exact specified name. + VPCName *string `json:"vpc.name,omitempty"` + + // Filters the collection to resources with a `target.id` property matching the specified identifier. + TargetID *string `json:"target.id,omitempty"` + + // Filters the collection to resources with a `target.resource_type` property matching the specified value. + TargetResourceType *string `json:"target.resource_type,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListFlowLogCollectorsOptions : Instantiate ListFlowLogCollectorsOptions +func (*VpcV1) NewListFlowLogCollectorsOptions() *ListFlowLogCollectorsOptions { + return &ListFlowLogCollectorsOptions{} +} + +// SetStart : Allow user to set Start +func (_options *ListFlowLogCollectorsOptions) SetStart(start string) *ListFlowLogCollectorsOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListFlowLogCollectorsOptions) SetLimit(limit int64) *ListFlowLogCollectorsOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetResourceGroupID : Allow user to set ResourceGroupID +func (_options *ListFlowLogCollectorsOptions) SetResourceGroupID(resourceGroupID string) *ListFlowLogCollectorsOptions { + _options.ResourceGroupID = core.StringPtr(resourceGroupID) + return _options +} + +// SetName : Allow user to set Name +func (_options *ListFlowLogCollectorsOptions) SetName(name string) *ListFlowLogCollectorsOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetVPCID : Allow user to set VPCID +func (_options *ListFlowLogCollectorsOptions) SetVPCID(vpcID string) *ListFlowLogCollectorsOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetVPCCRN : Allow user to set VPCCRN +func (_options *ListFlowLogCollectorsOptions) SetVPCCRN(vpcCRN string) *ListFlowLogCollectorsOptions { + _options.VPCCRN = core.StringPtr(vpcCRN) + return _options +} + +// SetVPCName : Allow user to set VPCName +func (_options *ListFlowLogCollectorsOptions) SetVPCName(vpcName string) *ListFlowLogCollectorsOptions { + _options.VPCName = core.StringPtr(vpcName) + return _options +} + +// SetTargetID : Allow user to set TargetID +func (_options *ListFlowLogCollectorsOptions) SetTargetID(targetID string) *ListFlowLogCollectorsOptions { + _options.TargetID = core.StringPtr(targetID) + return _options +} + +// SetTargetResourceType : Allow user to set TargetResourceType +func (_options *ListFlowLogCollectorsOptions) SetTargetResourceType(targetResourceType string) *ListFlowLogCollectorsOptions { + _options.TargetResourceType = core.StringPtr(targetResourceType) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListFlowLogCollectorsOptions) SetHeaders(param map[string]string) *ListFlowLogCollectorsOptions { + options.Headers = param + return options +} + +// ListIkePoliciesOptions : The ListIkePolicies options. +type ListIkePoliciesOptions struct { + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListIkePoliciesOptions : Instantiate ListIkePoliciesOptions +func (*VpcV1) NewListIkePoliciesOptions() *ListIkePoliciesOptions { + return &ListIkePoliciesOptions{} +} + +// SetStart : Allow user to set Start +func (_options *ListIkePoliciesOptions) SetStart(start string) *ListIkePoliciesOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListIkePoliciesOptions) SetLimit(limit int64) *ListIkePoliciesOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListIkePoliciesOptions) SetHeaders(param map[string]string) *ListIkePoliciesOptions { + options.Headers = param + return options +} + +// ListIkePolicyConnectionsOptions : The ListIkePolicyConnections options. +type ListIkePolicyConnectionsOptions struct { + // The IKE policy identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListIkePolicyConnectionsOptions : Instantiate ListIkePolicyConnectionsOptions +func (*VpcV1) NewListIkePolicyConnectionsOptions(id string) *ListIkePolicyConnectionsOptions { + return &ListIkePolicyConnectionsOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *ListIkePolicyConnectionsOptions) SetID(id string) *ListIkePolicyConnectionsOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListIkePolicyConnectionsOptions) SetHeaders(param map[string]string) *ListIkePolicyConnectionsOptions { + options.Headers = param + return options +} + +// ListImageExportJobsOptions : The ListImageExportJobs options. +type ListImageExportJobsOptions struct { + // The image identifier. + ImageID *string `json:"image_id" validate:"required,ne="` + + // Filters the collection to resources with a `name` property matching the exact specified name. + Name *string `json:"name,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListImageExportJobsOptions : Instantiate ListImageExportJobsOptions +func (*VpcV1) NewListImageExportJobsOptions(imageID string) *ListImageExportJobsOptions { + return &ListImageExportJobsOptions{ + ImageID: core.StringPtr(imageID), + } +} + +// SetImageID : Allow user to set ImageID +func (_options *ListImageExportJobsOptions) SetImageID(imageID string) *ListImageExportJobsOptions { + _options.ImageID = core.StringPtr(imageID) + return _options +} + +// SetName : Allow user to set Name +func (_options *ListImageExportJobsOptions) SetName(name string) *ListImageExportJobsOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListImageExportJobsOptions) SetHeaders(param map[string]string) *ListImageExportJobsOptions { + options.Headers = param + return options +} + +// ListImagesOptions : The ListImages options. +type ListImagesOptions struct { + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Filters the collection to resources with a `resource_group.id` property matching the specified identifier. + ResourceGroupID *string `json:"resource_group.id,omitempty"` + + // Filters the collection to resources with a `name` property matching the exact specified name. + Name *string `json:"name,omitempty"` + + // Filters the collection to images with a `status` property matching one of the specified comma-separated values. + Status []string `json:"status,omitempty"` + + // Filters the collection to images with a `visibility` property matching the specified value. + Visibility *string `json:"visibility,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the ListImagesOptions.Status property. +const ( + ListImagesOptionsStatusAvailableConst = "available" + ListImagesOptionsStatusDeletingConst = "deleting" + ListImagesOptionsStatusDeprecatedConst = "deprecated" + ListImagesOptionsStatusFailedConst = "failed" + ListImagesOptionsStatusObsoleteConst = "obsolete" + ListImagesOptionsStatusPendingConst = "pending" + ListImagesOptionsStatusUnusableConst = "unusable" +) + +// Constants associated with the ListImagesOptions.Visibility property. +// Filters the collection to images with a `visibility` property matching the specified value. +const ( + ListImagesOptionsVisibilityPrivateConst = "private" + ListImagesOptionsVisibilityPublicConst = "public" +) + +// NewListImagesOptions : Instantiate ListImagesOptions +func (*VpcV1) NewListImagesOptions() *ListImagesOptions { + return &ListImagesOptions{} +} + +// SetStart : Allow user to set Start +func (_options *ListImagesOptions) SetStart(start string) *ListImagesOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListImagesOptions) SetLimit(limit int64) *ListImagesOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetResourceGroupID : Allow user to set ResourceGroupID +func (_options *ListImagesOptions) SetResourceGroupID(resourceGroupID string) *ListImagesOptions { + _options.ResourceGroupID = core.StringPtr(resourceGroupID) + return _options +} + +// SetName : Allow user to set Name +func (_options *ListImagesOptions) SetName(name string) *ListImagesOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetStatus : Allow user to set Status +func (_options *ListImagesOptions) SetStatus(status []string) *ListImagesOptions { + _options.Status = status + return _options +} + +// SetVisibility : Allow user to set Visibility +func (_options *ListImagesOptions) SetVisibility(visibility string) *ListImagesOptions { + _options.Visibility = core.StringPtr(visibility) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListImagesOptions) SetHeaders(param map[string]string) *ListImagesOptions { + options.Headers = param + return options +} + +// ListInstanceDisksOptions : The ListInstanceDisks options. +type ListInstanceDisksOptions struct { + // The virtual server instance identifier. + InstanceID *string `json:"instance_id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListInstanceDisksOptions : Instantiate ListInstanceDisksOptions +func (*VpcV1) NewListInstanceDisksOptions(instanceID string) *ListInstanceDisksOptions { + return &ListInstanceDisksOptions{ + InstanceID: core.StringPtr(instanceID), + } +} + +// SetInstanceID : Allow user to set InstanceID +func (_options *ListInstanceDisksOptions) SetInstanceID(instanceID string) *ListInstanceDisksOptions { + _options.InstanceID = core.StringPtr(instanceID) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListInstanceDisksOptions) SetHeaders(param map[string]string) *ListInstanceDisksOptions { + options.Headers = param + return options +} + +// ListInstanceGroupManagerActionsOptions : The ListInstanceGroupManagerActions options. +type ListInstanceGroupManagerActionsOptions struct { + // The instance group identifier. + InstanceGroupID *string `json:"instance_group_id" validate:"required,ne="` + + // The instance group manager identifier. + InstanceGroupManagerID *string `json:"instance_group_manager_id" validate:"required,ne="` + + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListInstanceGroupManagerActionsOptions : Instantiate ListInstanceGroupManagerActionsOptions +func (*VpcV1) NewListInstanceGroupManagerActionsOptions(instanceGroupID string, instanceGroupManagerID string) *ListInstanceGroupManagerActionsOptions { + return &ListInstanceGroupManagerActionsOptions{ + InstanceGroupID: core.StringPtr(instanceGroupID), + InstanceGroupManagerID: core.StringPtr(instanceGroupManagerID), + } +} + +// SetInstanceGroupID : Allow user to set InstanceGroupID +func (_options *ListInstanceGroupManagerActionsOptions) SetInstanceGroupID(instanceGroupID string) *ListInstanceGroupManagerActionsOptions { + _options.InstanceGroupID = core.StringPtr(instanceGroupID) + return _options +} + +// SetInstanceGroupManagerID : Allow user to set InstanceGroupManagerID +func (_options *ListInstanceGroupManagerActionsOptions) SetInstanceGroupManagerID(instanceGroupManagerID string) *ListInstanceGroupManagerActionsOptions { + _options.InstanceGroupManagerID = core.StringPtr(instanceGroupManagerID) + return _options +} + +// SetStart : Allow user to set Start +func (_options *ListInstanceGroupManagerActionsOptions) SetStart(start string) *ListInstanceGroupManagerActionsOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListInstanceGroupManagerActionsOptions) SetLimit(limit int64) *ListInstanceGroupManagerActionsOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListInstanceGroupManagerActionsOptions) SetHeaders(param map[string]string) *ListInstanceGroupManagerActionsOptions { + options.Headers = param + return options +} + +// ListInstanceGroupManagerPoliciesOptions : The ListInstanceGroupManagerPolicies options. +type ListInstanceGroupManagerPoliciesOptions struct { + // The instance group identifier. + InstanceGroupID *string `json:"instance_group_id" validate:"required,ne="` + + // The instance group manager identifier. + InstanceGroupManagerID *string `json:"instance_group_manager_id" validate:"required,ne="` + + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListInstanceGroupManagerPoliciesOptions : Instantiate ListInstanceGroupManagerPoliciesOptions +func (*VpcV1) NewListInstanceGroupManagerPoliciesOptions(instanceGroupID string, instanceGroupManagerID string) *ListInstanceGroupManagerPoliciesOptions { + return &ListInstanceGroupManagerPoliciesOptions{ + InstanceGroupID: core.StringPtr(instanceGroupID), + InstanceGroupManagerID: core.StringPtr(instanceGroupManagerID), + } +} + +// SetInstanceGroupID : Allow user to set InstanceGroupID +func (_options *ListInstanceGroupManagerPoliciesOptions) SetInstanceGroupID(instanceGroupID string) *ListInstanceGroupManagerPoliciesOptions { + _options.InstanceGroupID = core.StringPtr(instanceGroupID) + return _options +} + +// SetInstanceGroupManagerID : Allow user to set InstanceGroupManagerID +func (_options *ListInstanceGroupManagerPoliciesOptions) SetInstanceGroupManagerID(instanceGroupManagerID string) *ListInstanceGroupManagerPoliciesOptions { + _options.InstanceGroupManagerID = core.StringPtr(instanceGroupManagerID) + return _options +} + +// SetStart : Allow user to set Start +func (_options *ListInstanceGroupManagerPoliciesOptions) SetStart(start string) *ListInstanceGroupManagerPoliciesOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListInstanceGroupManagerPoliciesOptions) SetLimit(limit int64) *ListInstanceGroupManagerPoliciesOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListInstanceGroupManagerPoliciesOptions) SetHeaders(param map[string]string) *ListInstanceGroupManagerPoliciesOptions { + options.Headers = param + return options +} + +// ListInstanceGroupManagersOptions : The ListInstanceGroupManagers options. +type ListInstanceGroupManagersOptions struct { + // The instance group identifier. + InstanceGroupID *string `json:"instance_group_id" validate:"required,ne="` + + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListInstanceGroupManagersOptions : Instantiate ListInstanceGroupManagersOptions +func (*VpcV1) NewListInstanceGroupManagersOptions(instanceGroupID string) *ListInstanceGroupManagersOptions { + return &ListInstanceGroupManagersOptions{ + InstanceGroupID: core.StringPtr(instanceGroupID), + } +} + +// SetInstanceGroupID : Allow user to set InstanceGroupID +func (_options *ListInstanceGroupManagersOptions) SetInstanceGroupID(instanceGroupID string) *ListInstanceGroupManagersOptions { + _options.InstanceGroupID = core.StringPtr(instanceGroupID) + return _options +} + +// SetStart : Allow user to set Start +func (_options *ListInstanceGroupManagersOptions) SetStart(start string) *ListInstanceGroupManagersOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListInstanceGroupManagersOptions) SetLimit(limit int64) *ListInstanceGroupManagersOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListInstanceGroupManagersOptions) SetHeaders(param map[string]string) *ListInstanceGroupManagersOptions { + options.Headers = param + return options +} + +// ListInstanceGroupMembershipsOptions : The ListInstanceGroupMemberships options. +type ListInstanceGroupMembershipsOptions struct { + // The instance group identifier. + InstanceGroupID *string `json:"instance_group_id" validate:"required,ne="` + + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListInstanceGroupMembershipsOptions : Instantiate ListInstanceGroupMembershipsOptions +func (*VpcV1) NewListInstanceGroupMembershipsOptions(instanceGroupID string) *ListInstanceGroupMembershipsOptions { + return &ListInstanceGroupMembershipsOptions{ + InstanceGroupID: core.StringPtr(instanceGroupID), + } +} + +// SetInstanceGroupID : Allow user to set InstanceGroupID +func (_options *ListInstanceGroupMembershipsOptions) SetInstanceGroupID(instanceGroupID string) *ListInstanceGroupMembershipsOptions { + _options.InstanceGroupID = core.StringPtr(instanceGroupID) + return _options +} + +// SetStart : Allow user to set Start +func (_options *ListInstanceGroupMembershipsOptions) SetStart(start string) *ListInstanceGroupMembershipsOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListInstanceGroupMembershipsOptions) SetLimit(limit int64) *ListInstanceGroupMembershipsOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListInstanceGroupMembershipsOptions) SetHeaders(param map[string]string) *ListInstanceGroupMembershipsOptions { + options.Headers = param + return options +} + +// ListInstanceGroupsOptions : The ListInstanceGroups options. +type ListInstanceGroupsOptions struct { + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListInstanceGroupsOptions : Instantiate ListInstanceGroupsOptions +func (*VpcV1) NewListInstanceGroupsOptions() *ListInstanceGroupsOptions { + return &ListInstanceGroupsOptions{} +} + +// SetStart : Allow user to set Start +func (_options *ListInstanceGroupsOptions) SetStart(start string) *ListInstanceGroupsOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListInstanceGroupsOptions) SetLimit(limit int64) *ListInstanceGroupsOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListInstanceGroupsOptions) SetHeaders(param map[string]string) *ListInstanceGroupsOptions { + options.Headers = param + return options +} + +// ListInstanceNetworkInterfaceFloatingIpsOptions : The ListInstanceNetworkInterfaceFloatingIps options. +type ListInstanceNetworkInterfaceFloatingIpsOptions struct { + // The virtual server instance identifier. + InstanceID *string `json:"instance_id" validate:"required,ne="` + + // The instance network interface identifier. + NetworkInterfaceID *string `json:"network_interface_id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListInstanceNetworkInterfaceFloatingIpsOptions : Instantiate ListInstanceNetworkInterfaceFloatingIpsOptions +func (*VpcV1) NewListInstanceNetworkInterfaceFloatingIpsOptions(instanceID string, networkInterfaceID string) *ListInstanceNetworkInterfaceFloatingIpsOptions { + return &ListInstanceNetworkInterfaceFloatingIpsOptions{ + InstanceID: core.StringPtr(instanceID), + NetworkInterfaceID: core.StringPtr(networkInterfaceID), + } +} + +// SetInstanceID : Allow user to set InstanceID +func (_options *ListInstanceNetworkInterfaceFloatingIpsOptions) SetInstanceID(instanceID string) *ListInstanceNetworkInterfaceFloatingIpsOptions { + _options.InstanceID = core.StringPtr(instanceID) + return _options +} + +// SetNetworkInterfaceID : Allow user to set NetworkInterfaceID +func (_options *ListInstanceNetworkInterfaceFloatingIpsOptions) SetNetworkInterfaceID(networkInterfaceID string) *ListInstanceNetworkInterfaceFloatingIpsOptions { + _options.NetworkInterfaceID = core.StringPtr(networkInterfaceID) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListInstanceNetworkInterfaceFloatingIpsOptions) SetHeaders(param map[string]string) *ListInstanceNetworkInterfaceFloatingIpsOptions { + options.Headers = param + return options +} + +// ListInstanceNetworkInterfaceIpsOptions : The ListInstanceNetworkInterfaceIps options. +type ListInstanceNetworkInterfaceIpsOptions struct { + // The virtual server instance identifier. + InstanceID *string `json:"instance_id" validate:"required,ne="` + + // The instance network interface identifier. + NetworkInterfaceID *string `json:"network_interface_id" validate:"required,ne="` + + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListInstanceNetworkInterfaceIpsOptions : Instantiate ListInstanceNetworkInterfaceIpsOptions +func (*VpcV1) NewListInstanceNetworkInterfaceIpsOptions(instanceID string, networkInterfaceID string) *ListInstanceNetworkInterfaceIpsOptions { + return &ListInstanceNetworkInterfaceIpsOptions{ + InstanceID: core.StringPtr(instanceID), + NetworkInterfaceID: core.StringPtr(networkInterfaceID), + } +} + +// SetInstanceID : Allow user to set InstanceID +func (_options *ListInstanceNetworkInterfaceIpsOptions) SetInstanceID(instanceID string) *ListInstanceNetworkInterfaceIpsOptions { + _options.InstanceID = core.StringPtr(instanceID) + return _options +} + +// SetNetworkInterfaceID : Allow user to set NetworkInterfaceID +func (_options *ListInstanceNetworkInterfaceIpsOptions) SetNetworkInterfaceID(networkInterfaceID string) *ListInstanceNetworkInterfaceIpsOptions { + _options.NetworkInterfaceID = core.StringPtr(networkInterfaceID) + return _options +} + +// SetStart : Allow user to set Start +func (_options *ListInstanceNetworkInterfaceIpsOptions) SetStart(start string) *ListInstanceNetworkInterfaceIpsOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListInstanceNetworkInterfaceIpsOptions) SetLimit(limit int64) *ListInstanceNetworkInterfaceIpsOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListInstanceNetworkInterfaceIpsOptions) SetHeaders(param map[string]string) *ListInstanceNetworkInterfaceIpsOptions { + options.Headers = param + return options +} + +// ListInstanceNetworkInterfacesOptions : The ListInstanceNetworkInterfaces options. +type ListInstanceNetworkInterfacesOptions struct { + // The virtual server instance identifier. + InstanceID *string `json:"instance_id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListInstanceNetworkInterfacesOptions : Instantiate ListInstanceNetworkInterfacesOptions +func (*VpcV1) NewListInstanceNetworkInterfacesOptions(instanceID string) *ListInstanceNetworkInterfacesOptions { + return &ListInstanceNetworkInterfacesOptions{ + InstanceID: core.StringPtr(instanceID), + } +} + +// SetInstanceID : Allow user to set InstanceID +func (_options *ListInstanceNetworkInterfacesOptions) SetInstanceID(instanceID string) *ListInstanceNetworkInterfacesOptions { + _options.InstanceID = core.StringPtr(instanceID) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListInstanceNetworkInterfacesOptions) SetHeaders(param map[string]string) *ListInstanceNetworkInterfacesOptions { + options.Headers = param + return options +} + +// ListInstanceProfilesOptions : The ListInstanceProfiles options. +type ListInstanceProfilesOptions struct { + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListInstanceProfilesOptions : Instantiate ListInstanceProfilesOptions +func (*VpcV1) NewListInstanceProfilesOptions() *ListInstanceProfilesOptions { + return &ListInstanceProfilesOptions{} +} + +// SetHeaders : Allow user to set Headers +func (options *ListInstanceProfilesOptions) SetHeaders(param map[string]string) *ListInstanceProfilesOptions { + options.Headers = param + return options +} + +// ListInstanceTemplatesOptions : The ListInstanceTemplates options. +type ListInstanceTemplatesOptions struct { + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListInstanceTemplatesOptions : Instantiate ListInstanceTemplatesOptions +func (*VpcV1) NewListInstanceTemplatesOptions() *ListInstanceTemplatesOptions { + return &ListInstanceTemplatesOptions{} +} + +// SetHeaders : Allow user to set Headers +func (options *ListInstanceTemplatesOptions) SetHeaders(param map[string]string) *ListInstanceTemplatesOptions { + options.Headers = param + return options +} + +// ListInstanceVolumeAttachmentsOptions : The ListInstanceVolumeAttachments options. +type ListInstanceVolumeAttachmentsOptions struct { + // The virtual server instance identifier. + InstanceID *string `json:"instance_id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListInstanceVolumeAttachmentsOptions : Instantiate ListInstanceVolumeAttachmentsOptions +func (*VpcV1) NewListInstanceVolumeAttachmentsOptions(instanceID string) *ListInstanceVolumeAttachmentsOptions { + return &ListInstanceVolumeAttachmentsOptions{ + InstanceID: core.StringPtr(instanceID), + } +} + +// SetInstanceID : Allow user to set InstanceID +func (_options *ListInstanceVolumeAttachmentsOptions) SetInstanceID(instanceID string) *ListInstanceVolumeAttachmentsOptions { + _options.InstanceID = core.StringPtr(instanceID) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListInstanceVolumeAttachmentsOptions) SetHeaders(param map[string]string) *ListInstanceVolumeAttachmentsOptions { + options.Headers = param + return options +} + +// ListInstancesOptions : The ListInstances options. +type ListInstancesOptions struct { + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Filters the collection to resources with a `resource_group.id` property matching the specified identifier. + ResourceGroupID *string `json:"resource_group.id,omitempty"` + + // Filters the collection to resources with a `name` property matching the exact specified name. + Name *string `json:"name,omitempty"` + + // Filters the collection to resources with a `vpc.id` property matching the specified identifier. + VPCID *string `json:"vpc.id,omitempty"` + + // Filters the collection to resources with a `vpc.crn` property matching the specified CRN. + VPCCRN *string `json:"vpc.crn,omitempty"` + + // Filters the collection to resources with a `vpc.name` property matching the exact specified name. + VPCName *string `json:"vpc.name,omitempty"` + + // Filters the collection to instances with a `dedicated_host.id` property matching the specified identifier. + DedicatedHostID *string `json:"dedicated_host.id,omitempty"` + + // Filters the collection to instances with a `dedicated_host.crn` property matching the specified CRN. + DedicatedHostCRN *string `json:"dedicated_host.crn,omitempty"` + + // Filters the collection to instances with a `dedicated_host.name` property matching the exact specified name. + DedicatedHostName *string `json:"dedicated_host.name,omitempty"` + + // Filters the collection to instances with a `placement_target.id` property matching the specified placement group + // identifier. + PlacementGroupID *string `json:"placement_group.id,omitempty"` + + // Filters the collection to instances with a `placement_target.crn` property matching the specified placement group + // CRN. + PlacementGroupCRN *string `json:"placement_group.crn,omitempty"` + + // Filters the collection to instances with a `placement_target.name` property matching the exact specified placement + // group name. + PlacementGroupName *string `json:"placement_group.name,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListInstancesOptions : Instantiate ListInstancesOptions +func (*VpcV1) NewListInstancesOptions() *ListInstancesOptions { + return &ListInstancesOptions{} +} + +// SetStart : Allow user to set Start +func (_options *ListInstancesOptions) SetStart(start string) *ListInstancesOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListInstancesOptions) SetLimit(limit int64) *ListInstancesOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetResourceGroupID : Allow user to set ResourceGroupID +func (_options *ListInstancesOptions) SetResourceGroupID(resourceGroupID string) *ListInstancesOptions { + _options.ResourceGroupID = core.StringPtr(resourceGroupID) + return _options +} + +// SetName : Allow user to set Name +func (_options *ListInstancesOptions) SetName(name string) *ListInstancesOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetVPCID : Allow user to set VPCID +func (_options *ListInstancesOptions) SetVPCID(vpcID string) *ListInstancesOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetVPCCRN : Allow user to set VPCCRN +func (_options *ListInstancesOptions) SetVPCCRN(vpcCRN string) *ListInstancesOptions { + _options.VPCCRN = core.StringPtr(vpcCRN) + return _options +} + +// SetVPCName : Allow user to set VPCName +func (_options *ListInstancesOptions) SetVPCName(vpcName string) *ListInstancesOptions { + _options.VPCName = core.StringPtr(vpcName) + return _options +} + +// SetDedicatedHostID : Allow user to set DedicatedHostID +func (_options *ListInstancesOptions) SetDedicatedHostID(dedicatedHostID string) *ListInstancesOptions { + _options.DedicatedHostID = core.StringPtr(dedicatedHostID) + return _options +} + +// SetDedicatedHostCRN : Allow user to set DedicatedHostCRN +func (_options *ListInstancesOptions) SetDedicatedHostCRN(dedicatedHostCRN string) *ListInstancesOptions { + _options.DedicatedHostCRN = core.StringPtr(dedicatedHostCRN) + return _options +} + +// SetDedicatedHostName : Allow user to set DedicatedHostName +func (_options *ListInstancesOptions) SetDedicatedHostName(dedicatedHostName string) *ListInstancesOptions { + _options.DedicatedHostName = core.StringPtr(dedicatedHostName) + return _options +} + +// SetPlacementGroupID : Allow user to set PlacementGroupID +func (_options *ListInstancesOptions) SetPlacementGroupID(placementGroupID string) *ListInstancesOptions { + _options.PlacementGroupID = core.StringPtr(placementGroupID) + return _options +} + +// SetPlacementGroupCRN : Allow user to set PlacementGroupCRN +func (_options *ListInstancesOptions) SetPlacementGroupCRN(placementGroupCRN string) *ListInstancesOptions { + _options.PlacementGroupCRN = core.StringPtr(placementGroupCRN) + return _options +} + +// SetPlacementGroupName : Allow user to set PlacementGroupName +func (_options *ListInstancesOptions) SetPlacementGroupName(placementGroupName string) *ListInstancesOptions { + _options.PlacementGroupName = core.StringPtr(placementGroupName) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListInstancesOptions) SetHeaders(param map[string]string) *ListInstancesOptions { + options.Headers = param + return options +} + +// ListIpsecPoliciesOptions : The ListIpsecPolicies options. +type ListIpsecPoliciesOptions struct { + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListIpsecPoliciesOptions : Instantiate ListIpsecPoliciesOptions +func (*VpcV1) NewListIpsecPoliciesOptions() *ListIpsecPoliciesOptions { + return &ListIpsecPoliciesOptions{} +} + +// SetStart : Allow user to set Start +func (_options *ListIpsecPoliciesOptions) SetStart(start string) *ListIpsecPoliciesOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListIpsecPoliciesOptions) SetLimit(limit int64) *ListIpsecPoliciesOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListIpsecPoliciesOptions) SetHeaders(param map[string]string) *ListIpsecPoliciesOptions { + options.Headers = param + return options +} + +// ListIpsecPolicyConnectionsOptions : The ListIpsecPolicyConnections options. +type ListIpsecPolicyConnectionsOptions struct { + // The IPsec policy identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListIpsecPolicyConnectionsOptions : Instantiate ListIpsecPolicyConnectionsOptions +func (*VpcV1) NewListIpsecPolicyConnectionsOptions(id string) *ListIpsecPolicyConnectionsOptions { + return &ListIpsecPolicyConnectionsOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *ListIpsecPolicyConnectionsOptions) SetID(id string) *ListIpsecPolicyConnectionsOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListIpsecPolicyConnectionsOptions) SetHeaders(param map[string]string) *ListIpsecPolicyConnectionsOptions { + options.Headers = param + return options +} + +// ListKeysOptions : The ListKeys options. +type ListKeysOptions struct { + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListKeysOptions : Instantiate ListKeysOptions +func (*VpcV1) NewListKeysOptions() *ListKeysOptions { + return &ListKeysOptions{} +} + +// SetStart : Allow user to set Start +func (_options *ListKeysOptions) SetStart(start string) *ListKeysOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListKeysOptions) SetLimit(limit int64) *ListKeysOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListKeysOptions) SetHeaders(param map[string]string) *ListKeysOptions { + options.Headers = param + return options +} + +// ListLoadBalancerListenerPoliciesOptions : The ListLoadBalancerListenerPolicies options. +type ListLoadBalancerListenerPoliciesOptions struct { + // The load balancer identifier. + LoadBalancerID *string `json:"load_balancer_id" validate:"required,ne="` + + // The listener identifier. + ListenerID *string `json:"listener_id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListLoadBalancerListenerPoliciesOptions : Instantiate ListLoadBalancerListenerPoliciesOptions +func (*VpcV1) NewListLoadBalancerListenerPoliciesOptions(loadBalancerID string, listenerID string) *ListLoadBalancerListenerPoliciesOptions { + return &ListLoadBalancerListenerPoliciesOptions{ + LoadBalancerID: core.StringPtr(loadBalancerID), + ListenerID: core.StringPtr(listenerID), + } +} + +// SetLoadBalancerID : Allow user to set LoadBalancerID +func (_options *ListLoadBalancerListenerPoliciesOptions) SetLoadBalancerID(loadBalancerID string) *ListLoadBalancerListenerPoliciesOptions { + _options.LoadBalancerID = core.StringPtr(loadBalancerID) + return _options +} + +// SetListenerID : Allow user to set ListenerID +func (_options *ListLoadBalancerListenerPoliciesOptions) SetListenerID(listenerID string) *ListLoadBalancerListenerPoliciesOptions { + _options.ListenerID = core.StringPtr(listenerID) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListLoadBalancerListenerPoliciesOptions) SetHeaders(param map[string]string) *ListLoadBalancerListenerPoliciesOptions { + options.Headers = param + return options +} + +// ListLoadBalancerListenerPolicyRulesOptions : The ListLoadBalancerListenerPolicyRules options. +type ListLoadBalancerListenerPolicyRulesOptions struct { + // The load balancer identifier. + LoadBalancerID *string `json:"load_balancer_id" validate:"required,ne="` + + // The listener identifier. + ListenerID *string `json:"listener_id" validate:"required,ne="` + + // The policy identifier. + PolicyID *string `json:"policy_id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListLoadBalancerListenerPolicyRulesOptions : Instantiate ListLoadBalancerListenerPolicyRulesOptions +func (*VpcV1) NewListLoadBalancerListenerPolicyRulesOptions(loadBalancerID string, listenerID string, policyID string) *ListLoadBalancerListenerPolicyRulesOptions { + return &ListLoadBalancerListenerPolicyRulesOptions{ + LoadBalancerID: core.StringPtr(loadBalancerID), + ListenerID: core.StringPtr(listenerID), + PolicyID: core.StringPtr(policyID), + } +} + +// SetLoadBalancerID : Allow user to set LoadBalancerID +func (_options *ListLoadBalancerListenerPolicyRulesOptions) SetLoadBalancerID(loadBalancerID string) *ListLoadBalancerListenerPolicyRulesOptions { + _options.LoadBalancerID = core.StringPtr(loadBalancerID) + return _options +} + +// SetListenerID : Allow user to set ListenerID +func (_options *ListLoadBalancerListenerPolicyRulesOptions) SetListenerID(listenerID string) *ListLoadBalancerListenerPolicyRulesOptions { + _options.ListenerID = core.StringPtr(listenerID) + return _options +} + +// SetPolicyID : Allow user to set PolicyID +func (_options *ListLoadBalancerListenerPolicyRulesOptions) SetPolicyID(policyID string) *ListLoadBalancerListenerPolicyRulesOptions { + _options.PolicyID = core.StringPtr(policyID) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListLoadBalancerListenerPolicyRulesOptions) SetHeaders(param map[string]string) *ListLoadBalancerListenerPolicyRulesOptions { + options.Headers = param + return options +} + +// ListLoadBalancerListenersOptions : The ListLoadBalancerListeners options. +type ListLoadBalancerListenersOptions struct { + // The load balancer identifier. + LoadBalancerID *string `json:"load_balancer_id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListLoadBalancerListenersOptions : Instantiate ListLoadBalancerListenersOptions +func (*VpcV1) NewListLoadBalancerListenersOptions(loadBalancerID string) *ListLoadBalancerListenersOptions { + return &ListLoadBalancerListenersOptions{ + LoadBalancerID: core.StringPtr(loadBalancerID), + } +} + +// SetLoadBalancerID : Allow user to set LoadBalancerID +func (_options *ListLoadBalancerListenersOptions) SetLoadBalancerID(loadBalancerID string) *ListLoadBalancerListenersOptions { + _options.LoadBalancerID = core.StringPtr(loadBalancerID) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListLoadBalancerListenersOptions) SetHeaders(param map[string]string) *ListLoadBalancerListenersOptions { + options.Headers = param + return options +} + +// ListLoadBalancerPoolMembersOptions : The ListLoadBalancerPoolMembers options. +type ListLoadBalancerPoolMembersOptions struct { + // The load balancer identifier. + LoadBalancerID *string `json:"load_balancer_id" validate:"required,ne="` + + // The pool identifier. + PoolID *string `json:"pool_id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListLoadBalancerPoolMembersOptions : Instantiate ListLoadBalancerPoolMembersOptions +func (*VpcV1) NewListLoadBalancerPoolMembersOptions(loadBalancerID string, poolID string) *ListLoadBalancerPoolMembersOptions { + return &ListLoadBalancerPoolMembersOptions{ + LoadBalancerID: core.StringPtr(loadBalancerID), + PoolID: core.StringPtr(poolID), + } +} + +// SetLoadBalancerID : Allow user to set LoadBalancerID +func (_options *ListLoadBalancerPoolMembersOptions) SetLoadBalancerID(loadBalancerID string) *ListLoadBalancerPoolMembersOptions { + _options.LoadBalancerID = core.StringPtr(loadBalancerID) + return _options +} + +// SetPoolID : Allow user to set PoolID +func (_options *ListLoadBalancerPoolMembersOptions) SetPoolID(poolID string) *ListLoadBalancerPoolMembersOptions { + _options.PoolID = core.StringPtr(poolID) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListLoadBalancerPoolMembersOptions) SetHeaders(param map[string]string) *ListLoadBalancerPoolMembersOptions { + options.Headers = param + return options +} + +// ListLoadBalancerPoolsOptions : The ListLoadBalancerPools options. +type ListLoadBalancerPoolsOptions struct { + // The load balancer identifier. + LoadBalancerID *string `json:"load_balancer_id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListLoadBalancerPoolsOptions : Instantiate ListLoadBalancerPoolsOptions +func (*VpcV1) NewListLoadBalancerPoolsOptions(loadBalancerID string) *ListLoadBalancerPoolsOptions { + return &ListLoadBalancerPoolsOptions{ + LoadBalancerID: core.StringPtr(loadBalancerID), + } +} + +// SetLoadBalancerID : Allow user to set LoadBalancerID +func (_options *ListLoadBalancerPoolsOptions) SetLoadBalancerID(loadBalancerID string) *ListLoadBalancerPoolsOptions { + _options.LoadBalancerID = core.StringPtr(loadBalancerID) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListLoadBalancerPoolsOptions) SetHeaders(param map[string]string) *ListLoadBalancerPoolsOptions { + options.Headers = param + return options +} + +// ListLoadBalancerProfilesOptions : The ListLoadBalancerProfiles options. +type ListLoadBalancerProfilesOptions struct { + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListLoadBalancerProfilesOptions : Instantiate ListLoadBalancerProfilesOptions +func (*VpcV1) NewListLoadBalancerProfilesOptions() *ListLoadBalancerProfilesOptions { + return &ListLoadBalancerProfilesOptions{} +} + +// SetStart : Allow user to set Start +func (_options *ListLoadBalancerProfilesOptions) SetStart(start string) *ListLoadBalancerProfilesOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListLoadBalancerProfilesOptions) SetLimit(limit int64) *ListLoadBalancerProfilesOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListLoadBalancerProfilesOptions) SetHeaders(param map[string]string) *ListLoadBalancerProfilesOptions { + options.Headers = param + return options +} + +// ListLoadBalancersOptions : The ListLoadBalancers options. +type ListLoadBalancersOptions struct { + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListLoadBalancersOptions : Instantiate ListLoadBalancersOptions +func (*VpcV1) NewListLoadBalancersOptions() *ListLoadBalancersOptions { + return &ListLoadBalancersOptions{} +} + +// SetStart : Allow user to set Start +func (_options *ListLoadBalancersOptions) SetStart(start string) *ListLoadBalancersOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListLoadBalancersOptions) SetLimit(limit int64) *ListLoadBalancersOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListLoadBalancersOptions) SetHeaders(param map[string]string) *ListLoadBalancersOptions { + options.Headers = param + return options +} + +// ListNetworkACLRulesOptions : The ListNetworkACLRules options. +type ListNetworkACLRulesOptions struct { + // The network ACL identifier. + NetworkACLID *string `json:"network_acl_id" validate:"required,ne="` + + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Filters the collection to rules with a `direction` property matching the specified value. + Direction *string `json:"direction,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the ListNetworkACLRulesOptions.Direction property. +// Filters the collection to rules with a `direction` property matching the specified value. +const ( + ListNetworkACLRulesOptionsDirectionInboundConst = "inbound" + ListNetworkACLRulesOptionsDirectionOutboundConst = "outbound" +) + +// NewListNetworkACLRulesOptions : Instantiate ListNetworkACLRulesOptions +func (*VpcV1) NewListNetworkACLRulesOptions(networkACLID string) *ListNetworkACLRulesOptions { + return &ListNetworkACLRulesOptions{ + NetworkACLID: core.StringPtr(networkACLID), + } +} + +// SetNetworkACLID : Allow user to set NetworkACLID +func (_options *ListNetworkACLRulesOptions) SetNetworkACLID(networkACLID string) *ListNetworkACLRulesOptions { + _options.NetworkACLID = core.StringPtr(networkACLID) + return _options +} + +// SetStart : Allow user to set Start +func (_options *ListNetworkACLRulesOptions) SetStart(start string) *ListNetworkACLRulesOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListNetworkACLRulesOptions) SetLimit(limit int64) *ListNetworkACLRulesOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetDirection : Allow user to set Direction +func (_options *ListNetworkACLRulesOptions) SetDirection(direction string) *ListNetworkACLRulesOptions { + _options.Direction = core.StringPtr(direction) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListNetworkACLRulesOptions) SetHeaders(param map[string]string) *ListNetworkACLRulesOptions { + options.Headers = param + return options +} + +// ListNetworkAclsOptions : The ListNetworkAcls options. +type ListNetworkAclsOptions struct { + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Filters the collection to resources with a `resource_group.id` property matching the specified identifier. + ResourceGroupID *string `json:"resource_group.id,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListNetworkAclsOptions : Instantiate ListNetworkAclsOptions +func (*VpcV1) NewListNetworkAclsOptions() *ListNetworkAclsOptions { + return &ListNetworkAclsOptions{} +} + +// SetStart : Allow user to set Start +func (_options *ListNetworkAclsOptions) SetStart(start string) *ListNetworkAclsOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListNetworkAclsOptions) SetLimit(limit int64) *ListNetworkAclsOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetResourceGroupID : Allow user to set ResourceGroupID +func (_options *ListNetworkAclsOptions) SetResourceGroupID(resourceGroupID string) *ListNetworkAclsOptions { + _options.ResourceGroupID = core.StringPtr(resourceGroupID) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListNetworkAclsOptions) SetHeaders(param map[string]string) *ListNetworkAclsOptions { + options.Headers = param + return options +} + +// ListOperatingSystemsOptions : The ListOperatingSystems options. +type ListOperatingSystemsOptions struct { + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListOperatingSystemsOptions : Instantiate ListOperatingSystemsOptions +func (*VpcV1) NewListOperatingSystemsOptions() *ListOperatingSystemsOptions { + return &ListOperatingSystemsOptions{} +} + +// SetStart : Allow user to set Start +func (_options *ListOperatingSystemsOptions) SetStart(start string) *ListOperatingSystemsOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListOperatingSystemsOptions) SetLimit(limit int64) *ListOperatingSystemsOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListOperatingSystemsOptions) SetHeaders(param map[string]string) *ListOperatingSystemsOptions { + options.Headers = param + return options +} + +// ListPlacementGroupsOptions : The ListPlacementGroups options. +type ListPlacementGroupsOptions struct { + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListPlacementGroupsOptions : Instantiate ListPlacementGroupsOptions +func (*VpcV1) NewListPlacementGroupsOptions() *ListPlacementGroupsOptions { + return &ListPlacementGroupsOptions{} +} + +// SetStart : Allow user to set Start +func (_options *ListPlacementGroupsOptions) SetStart(start string) *ListPlacementGroupsOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListPlacementGroupsOptions) SetLimit(limit int64) *ListPlacementGroupsOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListPlacementGroupsOptions) SetHeaders(param map[string]string) *ListPlacementGroupsOptions { + options.Headers = param + return options +} + +// ListPublicGatewaysOptions : The ListPublicGateways options. +type ListPublicGatewaysOptions struct { + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Filters the collection to resources with a `resource_group.id` property matching the specified identifier. + ResourceGroupID *string `json:"resource_group.id,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListPublicGatewaysOptions : Instantiate ListPublicGatewaysOptions +func (*VpcV1) NewListPublicGatewaysOptions() *ListPublicGatewaysOptions { + return &ListPublicGatewaysOptions{} +} + +// SetStart : Allow user to set Start +func (_options *ListPublicGatewaysOptions) SetStart(start string) *ListPublicGatewaysOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListPublicGatewaysOptions) SetLimit(limit int64) *ListPublicGatewaysOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetResourceGroupID : Allow user to set ResourceGroupID +func (_options *ListPublicGatewaysOptions) SetResourceGroupID(resourceGroupID string) *ListPublicGatewaysOptions { + _options.ResourceGroupID = core.StringPtr(resourceGroupID) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListPublicGatewaysOptions) SetHeaders(param map[string]string) *ListPublicGatewaysOptions { + options.Headers = param + return options +} + +// ListRegionZonesOptions : The ListRegionZones options. +type ListRegionZonesOptions struct { + // The region name. + RegionName *string `json:"region_name" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListRegionZonesOptions : Instantiate ListRegionZonesOptions +func (*VpcV1) NewListRegionZonesOptions(regionName string) *ListRegionZonesOptions { + return &ListRegionZonesOptions{ + RegionName: core.StringPtr(regionName), + } +} + +// SetRegionName : Allow user to set RegionName +func (_options *ListRegionZonesOptions) SetRegionName(regionName string) *ListRegionZonesOptions { + _options.RegionName = core.StringPtr(regionName) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListRegionZonesOptions) SetHeaders(param map[string]string) *ListRegionZonesOptions { + options.Headers = param + return options +} + +// ListRegionsOptions : The ListRegions options. +type ListRegionsOptions struct { + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListRegionsOptions : Instantiate ListRegionsOptions +func (*VpcV1) NewListRegionsOptions() *ListRegionsOptions { + return &ListRegionsOptions{} +} + +// SetHeaders : Allow user to set Headers +func (options *ListRegionsOptions) SetHeaders(param map[string]string) *ListRegionsOptions { + options.Headers = param + return options +} + +// ListSecurityGroupRulesOptions : The ListSecurityGroupRules options. +type ListSecurityGroupRulesOptions struct { + // The security group identifier. + SecurityGroupID *string `json:"security_group_id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListSecurityGroupRulesOptions : Instantiate ListSecurityGroupRulesOptions +func (*VpcV1) NewListSecurityGroupRulesOptions(securityGroupID string) *ListSecurityGroupRulesOptions { + return &ListSecurityGroupRulesOptions{ + SecurityGroupID: core.StringPtr(securityGroupID), + } +} + +// SetSecurityGroupID : Allow user to set SecurityGroupID +func (_options *ListSecurityGroupRulesOptions) SetSecurityGroupID(securityGroupID string) *ListSecurityGroupRulesOptions { + _options.SecurityGroupID = core.StringPtr(securityGroupID) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListSecurityGroupRulesOptions) SetHeaders(param map[string]string) *ListSecurityGroupRulesOptions { + options.Headers = param + return options +} + +// ListSecurityGroupTargetsOptions : The ListSecurityGroupTargets options. +type ListSecurityGroupTargetsOptions struct { + // The security group identifier. + SecurityGroupID *string `json:"security_group_id" validate:"required,ne="` + + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListSecurityGroupTargetsOptions : Instantiate ListSecurityGroupTargetsOptions +func (*VpcV1) NewListSecurityGroupTargetsOptions(securityGroupID string) *ListSecurityGroupTargetsOptions { + return &ListSecurityGroupTargetsOptions{ + SecurityGroupID: core.StringPtr(securityGroupID), + } +} + +// SetSecurityGroupID : Allow user to set SecurityGroupID +func (_options *ListSecurityGroupTargetsOptions) SetSecurityGroupID(securityGroupID string) *ListSecurityGroupTargetsOptions { + _options.SecurityGroupID = core.StringPtr(securityGroupID) + return _options +} + +// SetStart : Allow user to set Start +func (_options *ListSecurityGroupTargetsOptions) SetStart(start string) *ListSecurityGroupTargetsOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListSecurityGroupTargetsOptions) SetLimit(limit int64) *ListSecurityGroupTargetsOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListSecurityGroupTargetsOptions) SetHeaders(param map[string]string) *ListSecurityGroupTargetsOptions { + options.Headers = param + return options +} + +// ListSecurityGroupsOptions : The ListSecurityGroups options. +type ListSecurityGroupsOptions struct { + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Filters the collection to resources with a `resource_group.id` property matching the specified identifier. + ResourceGroupID *string `json:"resource_group.id,omitempty"` + + // Filters the collection to resources with a `vpc.id` property matching the specified identifier. + VPCID *string `json:"vpc.id,omitempty"` + + // Filters the collection to resources with a `vpc.crn` property matching the specified CRN. + VPCCRN *string `json:"vpc.crn,omitempty"` + + // Filters the collection to resources with a `vpc.name` property matching the exact specified name. + VPCName *string `json:"vpc.name,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListSecurityGroupsOptions : Instantiate ListSecurityGroupsOptions +func (*VpcV1) NewListSecurityGroupsOptions() *ListSecurityGroupsOptions { + return &ListSecurityGroupsOptions{} +} + +// SetStart : Allow user to set Start +func (_options *ListSecurityGroupsOptions) SetStart(start string) *ListSecurityGroupsOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListSecurityGroupsOptions) SetLimit(limit int64) *ListSecurityGroupsOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetResourceGroupID : Allow user to set ResourceGroupID +func (_options *ListSecurityGroupsOptions) SetResourceGroupID(resourceGroupID string) *ListSecurityGroupsOptions { + _options.ResourceGroupID = core.StringPtr(resourceGroupID) + return _options +} + +// SetVPCID : Allow user to set VPCID +func (_options *ListSecurityGroupsOptions) SetVPCID(vpcID string) *ListSecurityGroupsOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetVPCCRN : Allow user to set VPCCRN +func (_options *ListSecurityGroupsOptions) SetVPCCRN(vpcCRN string) *ListSecurityGroupsOptions { + _options.VPCCRN = core.StringPtr(vpcCRN) + return _options +} + +// SetVPCName : Allow user to set VPCName +func (_options *ListSecurityGroupsOptions) SetVPCName(vpcName string) *ListSecurityGroupsOptions { + _options.VPCName = core.StringPtr(vpcName) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListSecurityGroupsOptions) SetHeaders(param map[string]string) *ListSecurityGroupsOptions { + options.Headers = param + return options +} + +// ListShareMountTargetsOptions : The ListShareMountTargets options. +type ListShareMountTargetsOptions struct { + // The file share identifier. + ShareID *string `json:"share_id" validate:"required,ne="` + + // Filters the collection to resources with a `name` property matching the exact specified name. + Name *string `json:"name,omitempty"` + + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListShareMountTargetsOptions : Instantiate ListShareMountTargetsOptions +func (*VpcV1) NewListShareMountTargetsOptions(shareID string) *ListShareMountTargetsOptions { + return &ListShareMountTargetsOptions{ + ShareID: core.StringPtr(shareID), + } +} + +// SetShareID : Allow user to set ShareID +func (_options *ListShareMountTargetsOptions) SetShareID(shareID string) *ListShareMountTargetsOptions { + _options.ShareID = core.StringPtr(shareID) + return _options +} + +// SetName : Allow user to set Name +func (_options *ListShareMountTargetsOptions) SetName(name string) *ListShareMountTargetsOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetStart : Allow user to set Start +func (_options *ListShareMountTargetsOptions) SetStart(start string) *ListShareMountTargetsOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListShareMountTargetsOptions) SetLimit(limit int64) *ListShareMountTargetsOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListShareMountTargetsOptions) SetHeaders(param map[string]string) *ListShareMountTargetsOptions { + options.Headers = param + return options +} + +// ListShareProfilesOptions : The ListShareProfiles options. +type ListShareProfilesOptions struct { + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Sorts the returned collection by the specified property name in ascending order. A `-` may be prepended to the name + // to sort in descending order. For example, the value `-created_at` sorts the collection by the `created_at` property + // in descending order, and the value `name` sorts it by the `name` property in ascending order. + Sort *string `json:"sort,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the ListShareProfilesOptions.Sort property. +// Sorts the returned collection by the specified property name in ascending order. A `-` may be prepended to the name +// to sort in descending order. For example, the value `-created_at` sorts the collection by the `created_at` property +// in descending order, and the value `name` sorts it by the `name` property in ascending order. +const ( + ListShareProfilesOptionsSortCreatedAtConst = "created_at" + ListShareProfilesOptionsSortNameConst = "name" +) + +// NewListShareProfilesOptions : Instantiate ListShareProfilesOptions +func (*VpcV1) NewListShareProfilesOptions() *ListShareProfilesOptions { + return &ListShareProfilesOptions{} +} + +// SetStart : Allow user to set Start +func (_options *ListShareProfilesOptions) SetStart(start string) *ListShareProfilesOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListShareProfilesOptions) SetLimit(limit int64) *ListShareProfilesOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetSort : Allow user to set Sort +func (_options *ListShareProfilesOptions) SetSort(sort string) *ListShareProfilesOptions { + _options.Sort = core.StringPtr(sort) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListShareProfilesOptions) SetHeaders(param map[string]string) *ListShareProfilesOptions { + options.Headers = param + return options +} + +// ListSharesOptions : The ListShares options. +type ListSharesOptions struct { + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Filters the collection to resources with a `resource_group.id` property matching the specified identifier. + ResourceGroupID *string `json:"resource_group.id,omitempty"` + + // Filters the collection to resources with a `name` property matching the exact specified name. + Name *string `json:"name,omitempty"` + + // Sorts the returned collection by the specified property name in ascending order. A `-` may be prepended to the name + // to sort in descending order. For example, the value `-created_at` sorts the collection by the `created_at` property + // in descending order, and the value `name` sorts it by the `name` property in ascending order. + Sort *string `json:"sort,omitempty"` + + // Filters the collection to file shares with a `replication_role` property matching the specified value. + ReplicationRole *string `json:"replication_role,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the ListSharesOptions.Sort property. +// Sorts the returned collection by the specified property name in ascending order. A `-` may be prepended to the name +// to sort in descending order. For example, the value `-created_at` sorts the collection by the `created_at` property +// in descending order, and the value `name` sorts it by the `name` property in ascending order. +const ( + ListSharesOptionsSortCreatedAtConst = "created_at" + ListSharesOptionsSortNameConst = "name" +) + +// Constants associated with the ListSharesOptions.ReplicationRole property. +// Filters the collection to file shares with a `replication_role` property matching the specified value. +const ( + ListSharesOptionsReplicationRoleNoneConst = "none" + ListSharesOptionsReplicationRoleReplicaConst = "replica" + ListSharesOptionsReplicationRoleSourceConst = "source" +) + +// NewListSharesOptions : Instantiate ListSharesOptions +func (*VpcV1) NewListSharesOptions() *ListSharesOptions { + return &ListSharesOptions{} +} + +// SetStart : Allow user to set Start +func (_options *ListSharesOptions) SetStart(start string) *ListSharesOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListSharesOptions) SetLimit(limit int64) *ListSharesOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetResourceGroupID : Allow user to set ResourceGroupID +func (_options *ListSharesOptions) SetResourceGroupID(resourceGroupID string) *ListSharesOptions { + _options.ResourceGroupID = core.StringPtr(resourceGroupID) + return _options +} + +// SetName : Allow user to set Name +func (_options *ListSharesOptions) SetName(name string) *ListSharesOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetSort : Allow user to set Sort +func (_options *ListSharesOptions) SetSort(sort string) *ListSharesOptions { + _options.Sort = core.StringPtr(sort) + return _options +} + +// SetReplicationRole : Allow user to set ReplicationRole +func (_options *ListSharesOptions) SetReplicationRole(replicationRole string) *ListSharesOptions { + _options.ReplicationRole = core.StringPtr(replicationRole) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListSharesOptions) SetHeaders(param map[string]string) *ListSharesOptions { + options.Headers = param + return options +} + +// ListSnapshotClonesOptions : The ListSnapshotClones options. +type ListSnapshotClonesOptions struct { + // The snapshot identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListSnapshotClonesOptions : Instantiate ListSnapshotClonesOptions +func (*VpcV1) NewListSnapshotClonesOptions(id string) *ListSnapshotClonesOptions { + return &ListSnapshotClonesOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *ListSnapshotClonesOptions) SetID(id string) *ListSnapshotClonesOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListSnapshotClonesOptions) SetHeaders(param map[string]string) *ListSnapshotClonesOptions { + options.Headers = param + return options +} + +// ListSnapshotsOptions : The ListSnapshots options. +type ListSnapshotsOptions struct { + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Filters the collection to resources with an item in the `tags` property matching the exact specified tag. + Tag *string `json:"tag,omitempty"` + + // Filters the collection to resources with a `resource_group.id` property matching the specified identifier. + ResourceGroupID *string `json:"resource_group.id,omitempty"` + + // Filters the collection to resources with a `name` property matching the exact specified name. + Name *string `json:"name,omitempty"` + + // Filters the collection to resources with a `source_volume.id` property matching the specified identifier. + SourceVolumeID *string `json:"source_volume.id,omitempty"` + + // Filters the collection to resources with a `source_volume.crn` property matching the specified CRN. + SourceVolumeCRN *string `json:"source_volume.crn,omitempty"` + + // Filters the collection to resources with a `source_image.id` property matching the specified identifier. + // + // This parameter also supports the values `null` and `not:null` which filter the collection to resources which have no + // source image or any existent source image, respectively. + SourceImageID *string `json:"source_image.id,omitempty"` + + // Filters the collection to resources with a `source_image.crn` property matching the specified CRN. + // + // This parameter also supports the values `null` and `not:null` which filter the collection to resources which have no + // source image or any existent source image, respectively. + SourceImageCRN *string `json:"source_image.crn,omitempty"` + + // Sorts the returned collection by the specified property name in ascending order. A `-` may be prepended to the name + // to sort in descending order. For example, the value `-created_at` sorts the collection by the `created_at` property + // in descending order, and the value `name` sorts it by the `name` property in ascending order. + Sort *string `json:"sort,omitempty"` + + // Filters the collection to backup policy jobs with a `backup_policy_plan.id` property matching the specified + // identifier. + BackupPolicyPlanID *string `json:"backup_policy_plan.id,omitempty"` + + // Filters the collection to snapshots with an item in the `copies` property with an `id` property matching the + // specified identifier. + CopiesID *string `json:"copies[].id,omitempty"` + + // Filters the collection to snapshots with an item in the `copies` property with a `name` property matching the exact + // specified name. + CopiesName *string `json:"copies[].name,omitempty"` + + // Filters the collection to snapshots with an item in the `copies` property with an `id` property matching the + // specified CRN. + CopiesCRN *string `json:"copies[].crn,omitempty"` + + // Filters the collection to snapshots with an item in the `copies` property with a + // `remote.region.name` property matching the exact specified name. + CopiesRemoteRegionName *string `json:"copies[].remote.region.name,omitempty"` + + // Filters the collection to resources with a `source_snapshot.id` property matching the specified identifier. + SourceSnapshotID *string `json:"source_snapshot.id,omitempty"` + + // Filters the collection to resources with a `source_snapshot.remote.region.name` property matching the exact + // specified name. + SourceSnapshotRemoteRegionName *string `json:"source_snapshot.remote.region.name,omitempty"` + + // Filters the collection to resources with a `source_volume.remote.region.name` property matching the exact specified + // name. + SourceVolumeRemoteRegionName *string `json:"source_volume.remote.region.name,omitempty"` + + // Filters the collection to resources with a `source_image.remote.region.name` property matching the exact specified + // name. + SourceImageRemoteRegionName *string `json:"source_image.remote.region.name,omitempty"` + + // Filters the collection to snapshots with an item in the `clones` property with a `zone.name` property matching the + // exact specified name. + ClonesZoneName *string `json:"clones[].zone.name,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the ListSnapshotsOptions.Sort property. +// Sorts the returned collection by the specified property name in ascending order. A `-` may be prepended to the name +// to sort in descending order. For example, the value `-created_at` sorts the collection by the `created_at` property +// in descending order, and the value `name` sorts it by the `name` property in ascending order. +const ( + ListSnapshotsOptionsSortCreatedAtConst = "created_at" + ListSnapshotsOptionsSortNameConst = "name" +) + +// NewListSnapshotsOptions : Instantiate ListSnapshotsOptions +func (*VpcV1) NewListSnapshotsOptions() *ListSnapshotsOptions { + return &ListSnapshotsOptions{} +} + +// SetStart : Allow user to set Start +func (_options *ListSnapshotsOptions) SetStart(start string) *ListSnapshotsOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListSnapshotsOptions) SetLimit(limit int64) *ListSnapshotsOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetTag : Allow user to set Tag +func (_options *ListSnapshotsOptions) SetTag(tag string) *ListSnapshotsOptions { + _options.Tag = core.StringPtr(tag) + return _options +} + +// SetResourceGroupID : Allow user to set ResourceGroupID +func (_options *ListSnapshotsOptions) SetResourceGroupID(resourceGroupID string) *ListSnapshotsOptions { + _options.ResourceGroupID = core.StringPtr(resourceGroupID) + return _options +} + +// SetName : Allow user to set Name +func (_options *ListSnapshotsOptions) SetName(name string) *ListSnapshotsOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetSourceVolumeID : Allow user to set SourceVolumeID +func (_options *ListSnapshotsOptions) SetSourceVolumeID(sourceVolumeID string) *ListSnapshotsOptions { + _options.SourceVolumeID = core.StringPtr(sourceVolumeID) + return _options +} + +// SetSourceVolumeCRN : Allow user to set SourceVolumeCRN +func (_options *ListSnapshotsOptions) SetSourceVolumeCRN(sourceVolumeCRN string) *ListSnapshotsOptions { + _options.SourceVolumeCRN = core.StringPtr(sourceVolumeCRN) + return _options +} + +// SetSourceImageID : Allow user to set SourceImageID +func (_options *ListSnapshotsOptions) SetSourceImageID(sourceImageID string) *ListSnapshotsOptions { + _options.SourceImageID = core.StringPtr(sourceImageID) + return _options +} + +// SetSourceImageCRN : Allow user to set SourceImageCRN +func (_options *ListSnapshotsOptions) SetSourceImageCRN(sourceImageCRN string) *ListSnapshotsOptions { + _options.SourceImageCRN = core.StringPtr(sourceImageCRN) + return _options +} + +// SetSort : Allow user to set Sort +func (_options *ListSnapshotsOptions) SetSort(sort string) *ListSnapshotsOptions { + _options.Sort = core.StringPtr(sort) + return _options +} + +// SetBackupPolicyPlanID : Allow user to set BackupPolicyPlanID +func (_options *ListSnapshotsOptions) SetBackupPolicyPlanID(backupPolicyPlanID string) *ListSnapshotsOptions { + _options.BackupPolicyPlanID = core.StringPtr(backupPolicyPlanID) + return _options +} + +// SetCopiesID : Allow user to set CopiesID +func (_options *ListSnapshotsOptions) SetCopiesID(copiesID string) *ListSnapshotsOptions { + _options.CopiesID = core.StringPtr(copiesID) + return _options +} + +// SetCopiesName : Allow user to set CopiesName +func (_options *ListSnapshotsOptions) SetCopiesName(copiesName string) *ListSnapshotsOptions { + _options.CopiesName = core.StringPtr(copiesName) + return _options +} + +// SetCopiesCRN : Allow user to set CopiesCRN +func (_options *ListSnapshotsOptions) SetCopiesCRN(copiesCRN string) *ListSnapshotsOptions { + _options.CopiesCRN = core.StringPtr(copiesCRN) + return _options +} + +// SetCopiesRemoteRegionName : Allow user to set CopiesRemoteRegionName +func (_options *ListSnapshotsOptions) SetCopiesRemoteRegionName(copiesRemoteRegionName string) *ListSnapshotsOptions { + _options.CopiesRemoteRegionName = core.StringPtr(copiesRemoteRegionName) + return _options +} + +// SetSourceSnapshotID : Allow user to set SourceSnapshotID +func (_options *ListSnapshotsOptions) SetSourceSnapshotID(sourceSnapshotID string) *ListSnapshotsOptions { + _options.SourceSnapshotID = core.StringPtr(sourceSnapshotID) + return _options +} + +// SetSourceSnapshotRemoteRegionName : Allow user to set SourceSnapshotRemoteRegionName +func (_options *ListSnapshotsOptions) SetSourceSnapshotRemoteRegionName(sourceSnapshotRemoteRegionName string) *ListSnapshotsOptions { + _options.SourceSnapshotRemoteRegionName = core.StringPtr(sourceSnapshotRemoteRegionName) + return _options +} + +// SetSourceVolumeRemoteRegionName : Allow user to set SourceVolumeRemoteRegionName +func (_options *ListSnapshotsOptions) SetSourceVolumeRemoteRegionName(sourceVolumeRemoteRegionName string) *ListSnapshotsOptions { + _options.SourceVolumeRemoteRegionName = core.StringPtr(sourceVolumeRemoteRegionName) + return _options +} + +// SetSourceImageRemoteRegionName : Allow user to set SourceImageRemoteRegionName +func (_options *ListSnapshotsOptions) SetSourceImageRemoteRegionName(sourceImageRemoteRegionName string) *ListSnapshotsOptions { + _options.SourceImageRemoteRegionName = core.StringPtr(sourceImageRemoteRegionName) + return _options +} + +// SetClonesZoneName : Allow user to set ClonesZoneName +func (_options *ListSnapshotsOptions) SetClonesZoneName(clonesZoneName string) *ListSnapshotsOptions { + _options.ClonesZoneName = core.StringPtr(clonesZoneName) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListSnapshotsOptions) SetHeaders(param map[string]string) *ListSnapshotsOptions { + options.Headers = param + return options +} + +// ListSubnetReservedIpsOptions : The ListSubnetReservedIps options. +type ListSubnetReservedIpsOptions struct { + // The subnet identifier. + SubnetID *string `json:"subnet_id" validate:"required,ne="` + + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Sorts the returned collection by the specified property name in ascending order. A `-` may be prepended to the name + // to sort in descending order. For example, the value `-created_at` sorts the collection by the `created_at` property + // in descending order, and the value `name` sorts it by the `name` property in ascending order. + Sort *string `json:"sort,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the ListSubnetReservedIpsOptions.Sort property. +// Sorts the returned collection by the specified property name in ascending order. A `-` may be prepended to the name +// to sort in descending order. For example, the value `-created_at` sorts the collection by the `created_at` property +// in descending order, and the value `name` sorts it by the `name` property in ascending order. +const ( + ListSubnetReservedIpsOptionsSortAddressConst = "address" + ListSubnetReservedIpsOptionsSortCreatedAtConst = "created_at" + ListSubnetReservedIpsOptionsSortNameConst = "name" +) + +// NewListSubnetReservedIpsOptions : Instantiate ListSubnetReservedIpsOptions +func (*VpcV1) NewListSubnetReservedIpsOptions(subnetID string) *ListSubnetReservedIpsOptions { + return &ListSubnetReservedIpsOptions{ + SubnetID: core.StringPtr(subnetID), + } +} + +// SetSubnetID : Allow user to set SubnetID +func (_options *ListSubnetReservedIpsOptions) SetSubnetID(subnetID string) *ListSubnetReservedIpsOptions { + _options.SubnetID = core.StringPtr(subnetID) + return _options +} + +// SetStart : Allow user to set Start +func (_options *ListSubnetReservedIpsOptions) SetStart(start string) *ListSubnetReservedIpsOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListSubnetReservedIpsOptions) SetLimit(limit int64) *ListSubnetReservedIpsOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetSort : Allow user to set Sort +func (_options *ListSubnetReservedIpsOptions) SetSort(sort string) *ListSubnetReservedIpsOptions { + _options.Sort = core.StringPtr(sort) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListSubnetReservedIpsOptions) SetHeaders(param map[string]string) *ListSubnetReservedIpsOptions { + options.Headers = param + return options +} + +// ListSubnetsOptions : The ListSubnets options. +type ListSubnetsOptions struct { + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Filters the collection to resources with a `resource_group.id` property matching the specified identifier. + ResourceGroupID *string `json:"resource_group.id,omitempty"` + + // Filters the collection to resources with a `zone.name` property matching the exact specified name. + ZoneName *string `json:"zone.name,omitempty"` + + // Filters the collection to resources with a `vpc.id` property matching the specified identifier. + VPCID *string `json:"vpc.id,omitempty"` + + // Filters the collection to resources with a `vpc.crn` property matching the specified CRN. + VPCCRN *string `json:"vpc.crn,omitempty"` + + // Filters the collection to resources with a `vpc.name` property matching the exact specified name. + VPCName *string `json:"vpc.name,omitempty"` + + // Filters the collection to subnets with a `routing_table.id` property matching the specified identifier. + RoutingTableID *string `json:"routing_table.id,omitempty"` + + // Filters the collection to subnets with a `routing_table.name` property matching the exact specified name. + RoutingTableName *string `json:"routing_table.name,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListSubnetsOptions : Instantiate ListSubnetsOptions +func (*VpcV1) NewListSubnetsOptions() *ListSubnetsOptions { + return &ListSubnetsOptions{} +} + +// SetStart : Allow user to set Start +func (_options *ListSubnetsOptions) SetStart(start string) *ListSubnetsOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListSubnetsOptions) SetLimit(limit int64) *ListSubnetsOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetResourceGroupID : Allow user to set ResourceGroupID +func (_options *ListSubnetsOptions) SetResourceGroupID(resourceGroupID string) *ListSubnetsOptions { + _options.ResourceGroupID = core.StringPtr(resourceGroupID) + return _options +} + +// SetZoneName : Allow user to set ZoneName +func (_options *ListSubnetsOptions) SetZoneName(zoneName string) *ListSubnetsOptions { + _options.ZoneName = core.StringPtr(zoneName) + return _options +} + +// SetVPCID : Allow user to set VPCID +func (_options *ListSubnetsOptions) SetVPCID(vpcID string) *ListSubnetsOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetVPCCRN : Allow user to set VPCCRN +func (_options *ListSubnetsOptions) SetVPCCRN(vpcCRN string) *ListSubnetsOptions { + _options.VPCCRN = core.StringPtr(vpcCRN) + return _options +} + +// SetVPCName : Allow user to set VPCName +func (_options *ListSubnetsOptions) SetVPCName(vpcName string) *ListSubnetsOptions { + _options.VPCName = core.StringPtr(vpcName) + return _options +} + +// SetRoutingTableID : Allow user to set RoutingTableID +func (_options *ListSubnetsOptions) SetRoutingTableID(routingTableID string) *ListSubnetsOptions { + _options.RoutingTableID = core.StringPtr(routingTableID) + return _options +} + +// SetRoutingTableName : Allow user to set RoutingTableName +func (_options *ListSubnetsOptions) SetRoutingTableName(routingTableName string) *ListSubnetsOptions { + _options.RoutingTableName = core.StringPtr(routingTableName) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListSubnetsOptions) SetHeaders(param map[string]string) *ListSubnetsOptions { + options.Headers = param + return options +} + +// ListVirtualNetworkInterfacesOptions : The ListVirtualNetworkInterfaces options. +type ListVirtualNetworkInterfacesOptions struct { + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Filters the collection to resources with a `resource_group.id` property matching the specified identifier. + ResourceGroupID *string `json:"resource_group.id,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListVirtualNetworkInterfacesOptions : Instantiate ListVirtualNetworkInterfacesOptions +func (*VpcV1) NewListVirtualNetworkInterfacesOptions() *ListVirtualNetworkInterfacesOptions { + return &ListVirtualNetworkInterfacesOptions{} +} + +// SetStart : Allow user to set Start +func (_options *ListVirtualNetworkInterfacesOptions) SetStart(start string) *ListVirtualNetworkInterfacesOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListVirtualNetworkInterfacesOptions) SetLimit(limit int64) *ListVirtualNetworkInterfacesOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetResourceGroupID : Allow user to set ResourceGroupID +func (_options *ListVirtualNetworkInterfacesOptions) SetResourceGroupID(resourceGroupID string) *ListVirtualNetworkInterfacesOptions { + _options.ResourceGroupID = core.StringPtr(resourceGroupID) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListVirtualNetworkInterfacesOptions) SetHeaders(param map[string]string) *ListVirtualNetworkInterfacesOptions { + options.Headers = param + return options +} + +// ListVolumeProfilesOptions : The ListVolumeProfiles options. +type ListVolumeProfilesOptions struct { + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListVolumeProfilesOptions : Instantiate ListVolumeProfilesOptions +func (*VpcV1) NewListVolumeProfilesOptions() *ListVolumeProfilesOptions { + return &ListVolumeProfilesOptions{} +} + +// SetStart : Allow user to set Start +func (_options *ListVolumeProfilesOptions) SetStart(start string) *ListVolumeProfilesOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListVolumeProfilesOptions) SetLimit(limit int64) *ListVolumeProfilesOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListVolumeProfilesOptions) SetHeaders(param map[string]string) *ListVolumeProfilesOptions { + options.Headers = param + return options +} + +// ListVolumesOptions : The ListVolumes options. +type ListVolumesOptions struct { + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Filters the collection to resources with a `name` property matching the exact specified name. + Name *string `json:"name,omitempty"` + + // Filters the collection to volumes with an `attachment_state` property matching the specified value. + AttachmentState *string `json:"attachment_state,omitempty"` + + // Filters the collection to resources with an `encryption` property matching the specified value. + Encryption *string `json:"encryption,omitempty"` + + // Filters the collection to resources with an `operating_system.family` property matching the specified operating + // system family. + // + // This parameter also supports the values `null` and `not:null` which filter the collection to resources which have no + // operating system or any operating system, respectively. + OperatingSystemFamily *string `json:"operating_system.family,omitempty"` + + // Filters the collection to resources with an `operating_system.architecture` property matching the specified + // operating system architecture. + // + // This parameter also supports the values `null` and `not:null` which filter the collection to resources which have no + // operating system or any operating system, respectively. + OperatingSystemArchitecture *string `json:"operating_system.architecture,omitempty"` + + // Filters the collection to resources with a `zone.name` property matching the exact specified name. + ZoneName *string `json:"zone.name,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the ListVolumesOptions.AttachmentState property. +// Filters the collection to volumes with an `attachment_state` property matching the specified value. +const ( + ListVolumesOptionsAttachmentStateAttachedConst = "attached" + ListVolumesOptionsAttachmentStateUnattachedConst = "unattached" + ListVolumesOptionsAttachmentStateUnusableConst = "unusable" +) + +// Constants associated with the ListVolumesOptions.Encryption property. +// Filters the collection to resources with an `encryption` property matching the specified value. +const ( + ListVolumesOptionsEncryptionProviderManagedConst = "provider_managed" + ListVolumesOptionsEncryptionUserManagedConst = "user_managed" +) + +// NewListVolumesOptions : Instantiate ListVolumesOptions +func (*VpcV1) NewListVolumesOptions() *ListVolumesOptions { + return &ListVolumesOptions{} +} + +// SetStart : Allow user to set Start +func (_options *ListVolumesOptions) SetStart(start string) *ListVolumesOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListVolumesOptions) SetLimit(limit int64) *ListVolumesOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetName : Allow user to set Name +func (_options *ListVolumesOptions) SetName(name string) *ListVolumesOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetAttachmentState : Allow user to set AttachmentState +func (_options *ListVolumesOptions) SetAttachmentState(attachmentState string) *ListVolumesOptions { + _options.AttachmentState = core.StringPtr(attachmentState) + return _options +} + +// SetEncryption : Allow user to set Encryption +func (_options *ListVolumesOptions) SetEncryption(encryption string) *ListVolumesOptions { + _options.Encryption = core.StringPtr(encryption) + return _options +} + +// SetOperatingSystemFamily : Allow user to set OperatingSystemFamily +func (_options *ListVolumesOptions) SetOperatingSystemFamily(operatingSystemFamily string) *ListVolumesOptions { + _options.OperatingSystemFamily = core.StringPtr(operatingSystemFamily) + return _options +} + +// SetOperatingSystemArchitecture : Allow user to set OperatingSystemArchitecture +func (_options *ListVolumesOptions) SetOperatingSystemArchitecture(operatingSystemArchitecture string) *ListVolumesOptions { + _options.OperatingSystemArchitecture = core.StringPtr(operatingSystemArchitecture) + return _options +} + +// SetZoneName : Allow user to set ZoneName +func (_options *ListVolumesOptions) SetZoneName(zoneName string) *ListVolumesOptions { + _options.ZoneName = core.StringPtr(zoneName) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListVolumesOptions) SetHeaders(param map[string]string) *ListVolumesOptions { + options.Headers = param + return options +} + +// ListVPCAddressPrefixesOptions : The ListVPCAddressPrefixes options. +type ListVPCAddressPrefixesOptions struct { + // The VPC identifier. + VPCID *string `json:"vpc_id" validate:"required,ne="` + + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListVPCAddressPrefixesOptions : Instantiate ListVPCAddressPrefixesOptions +func (*VpcV1) NewListVPCAddressPrefixesOptions(vpcID string) *ListVPCAddressPrefixesOptions { + return &ListVPCAddressPrefixesOptions{ + VPCID: core.StringPtr(vpcID), + } +} + +// SetVPCID : Allow user to set VPCID +func (_options *ListVPCAddressPrefixesOptions) SetVPCID(vpcID string) *ListVPCAddressPrefixesOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetStart : Allow user to set Start +func (_options *ListVPCAddressPrefixesOptions) SetStart(start string) *ListVPCAddressPrefixesOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListVPCAddressPrefixesOptions) SetLimit(limit int64) *ListVPCAddressPrefixesOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListVPCAddressPrefixesOptions) SetHeaders(param map[string]string) *ListVPCAddressPrefixesOptions { + options.Headers = param + return options +} + +// ListVPCDnsResolutionBindingsOptions : The ListVPCDnsResolutionBindings options. +type ListVPCDnsResolutionBindingsOptions struct { + // The VPC identifier. + VPCID *string `json:"vpc_id" validate:"required,ne="` + + // Sorts the returned collection by the specified property name in ascending order. A `-` may be prepended to the name + // to sort in descending order. For example, the value `-created_at` sorts the collection by the `created_at` property + // in descending order, and the value `name` sorts it by the `name` property in ascending order. + Sort *string `json:"sort,omitempty"` + + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Filters the collection to resources with a `name` property matching the exact specified name. + Name *string `json:"name,omitempty"` + + // Filters the collection to resources with a `vpc.crn` property matching the specified CRN. + VPCCRN *string `json:"vpc.crn,omitempty"` + + // Filters the collection to resources with a `vpc.name` property matching the exact specified name. + VPCName *string `json:"vpc.name,omitempty"` + + // Filters the collection to resources with a `vpc.remote.account.id` property matching the specified account + // identifier. + AccountID *string `json:"account.id,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the ListVPCDnsResolutionBindingsOptions.Sort property. +// Sorts the returned collection by the specified property name in ascending order. A `-` may be prepended to the name +// to sort in descending order. For example, the value `-created_at` sorts the collection by the `created_at` property +// in descending order, and the value `name` sorts it by the `name` property in ascending order. +const ( + ListVPCDnsResolutionBindingsOptionsSortCreatedAtConst = "created_at" + ListVPCDnsResolutionBindingsOptionsSortNameConst = "name" +) + +// NewListVPCDnsResolutionBindingsOptions : Instantiate ListVPCDnsResolutionBindingsOptions +func (*VpcV1) NewListVPCDnsResolutionBindingsOptions(vpcID string) *ListVPCDnsResolutionBindingsOptions { + return &ListVPCDnsResolutionBindingsOptions{ + VPCID: core.StringPtr(vpcID), + } +} + +// SetVPCID : Allow user to set VPCID +func (_options *ListVPCDnsResolutionBindingsOptions) SetVPCID(vpcID string) *ListVPCDnsResolutionBindingsOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetSort : Allow user to set Sort +func (_options *ListVPCDnsResolutionBindingsOptions) SetSort(sort string) *ListVPCDnsResolutionBindingsOptions { + _options.Sort = core.StringPtr(sort) + return _options +} + +// SetStart : Allow user to set Start +func (_options *ListVPCDnsResolutionBindingsOptions) SetStart(start string) *ListVPCDnsResolutionBindingsOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListVPCDnsResolutionBindingsOptions) SetLimit(limit int64) *ListVPCDnsResolutionBindingsOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetName : Allow user to set Name +func (_options *ListVPCDnsResolutionBindingsOptions) SetName(name string) *ListVPCDnsResolutionBindingsOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetVPCCRN : Allow user to set VPCCRN +func (_options *ListVPCDnsResolutionBindingsOptions) SetVPCCRN(vpcCRN string) *ListVPCDnsResolutionBindingsOptions { + _options.VPCCRN = core.StringPtr(vpcCRN) + return _options +} + +// SetVPCName : Allow user to set VPCName +func (_options *ListVPCDnsResolutionBindingsOptions) SetVPCName(vpcName string) *ListVPCDnsResolutionBindingsOptions { + _options.VPCName = core.StringPtr(vpcName) + return _options +} + +// SetAccountID : Allow user to set AccountID +func (_options *ListVPCDnsResolutionBindingsOptions) SetAccountID(accountID string) *ListVPCDnsResolutionBindingsOptions { + _options.AccountID = core.StringPtr(accountID) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListVPCDnsResolutionBindingsOptions) SetHeaders(param map[string]string) *ListVPCDnsResolutionBindingsOptions { + options.Headers = param + return options +} + +// ListVPCRoutesOptions : The ListVPCRoutes options. +type ListVPCRoutesOptions struct { + // The VPC identifier. + VPCID *string `json:"vpc_id" validate:"required,ne="` + + // Filters the collection to resources with a `zone.name` property matching the exact specified name. + ZoneName *string `json:"zone.name,omitempty"` + + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListVPCRoutesOptions : Instantiate ListVPCRoutesOptions +func (*VpcV1) NewListVPCRoutesOptions(vpcID string) *ListVPCRoutesOptions { + return &ListVPCRoutesOptions{ + VPCID: core.StringPtr(vpcID), + } +} + +// SetVPCID : Allow user to set VPCID +func (_options *ListVPCRoutesOptions) SetVPCID(vpcID string) *ListVPCRoutesOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetZoneName : Allow user to set ZoneName +func (_options *ListVPCRoutesOptions) SetZoneName(zoneName string) *ListVPCRoutesOptions { + _options.ZoneName = core.StringPtr(zoneName) + return _options +} + +// SetStart : Allow user to set Start +func (_options *ListVPCRoutesOptions) SetStart(start string) *ListVPCRoutesOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListVPCRoutesOptions) SetLimit(limit int64) *ListVPCRoutesOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListVPCRoutesOptions) SetHeaders(param map[string]string) *ListVPCRoutesOptions { + options.Headers = param + return options +} + +// ListVPCRoutingTableRoutesOptions : The ListVPCRoutingTableRoutes options. +type ListVPCRoutingTableRoutesOptions struct { + // The VPC identifier. + VPCID *string `json:"vpc_id" validate:"required,ne="` + + // The routing table identifier. + RoutingTableID *string `json:"routing_table_id" validate:"required,ne="` + + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListVPCRoutingTableRoutesOptions : Instantiate ListVPCRoutingTableRoutesOptions +func (*VpcV1) NewListVPCRoutingTableRoutesOptions(vpcID string, routingTableID string) *ListVPCRoutingTableRoutesOptions { + return &ListVPCRoutingTableRoutesOptions{ + VPCID: core.StringPtr(vpcID), + RoutingTableID: core.StringPtr(routingTableID), + } +} + +// SetVPCID : Allow user to set VPCID +func (_options *ListVPCRoutingTableRoutesOptions) SetVPCID(vpcID string) *ListVPCRoutingTableRoutesOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetRoutingTableID : Allow user to set RoutingTableID +func (_options *ListVPCRoutingTableRoutesOptions) SetRoutingTableID(routingTableID string) *ListVPCRoutingTableRoutesOptions { + _options.RoutingTableID = core.StringPtr(routingTableID) + return _options +} + +// SetStart : Allow user to set Start +func (_options *ListVPCRoutingTableRoutesOptions) SetStart(start string) *ListVPCRoutingTableRoutesOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListVPCRoutingTableRoutesOptions) SetLimit(limit int64) *ListVPCRoutingTableRoutesOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListVPCRoutingTableRoutesOptions) SetHeaders(param map[string]string) *ListVPCRoutingTableRoutesOptions { + options.Headers = param + return options +} + +// ListVPCRoutingTablesOptions : The ListVPCRoutingTables options. +type ListVPCRoutingTablesOptions struct { + // The VPC identifier. + VPCID *string `json:"vpc_id" validate:"required,ne="` + + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Filters the collection to routing tables with an `is_default` property matching the specified value. + IsDefault *bool `json:"is_default,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListVPCRoutingTablesOptions : Instantiate ListVPCRoutingTablesOptions +func (*VpcV1) NewListVPCRoutingTablesOptions(vpcID string) *ListVPCRoutingTablesOptions { + return &ListVPCRoutingTablesOptions{ + VPCID: core.StringPtr(vpcID), + } +} + +// SetVPCID : Allow user to set VPCID +func (_options *ListVPCRoutingTablesOptions) SetVPCID(vpcID string) *ListVPCRoutingTablesOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetStart : Allow user to set Start +func (_options *ListVPCRoutingTablesOptions) SetStart(start string) *ListVPCRoutingTablesOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListVPCRoutingTablesOptions) SetLimit(limit int64) *ListVPCRoutingTablesOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetIsDefault : Allow user to set IsDefault +func (_options *ListVPCRoutingTablesOptions) SetIsDefault(isDefault bool) *ListVPCRoutingTablesOptions { + _options.IsDefault = core.BoolPtr(isDefault) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListVPCRoutingTablesOptions) SetHeaders(param map[string]string) *ListVPCRoutingTablesOptions { + options.Headers = param + return options +} + +// ListVpcsOptions : The ListVpcs options. +type ListVpcsOptions struct { + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Filters the collection to resources with a `resource_group.id` property matching the specified identifier. + ResourceGroupID *string `json:"resource_group.id,omitempty"` + + // Filters the collection to VPCs with a `classic_access` property matching the specified value. + ClassicAccess *bool `json:"classic_access,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListVpcsOptions : Instantiate ListVpcsOptions +func (*VpcV1) NewListVpcsOptions() *ListVpcsOptions { + return &ListVpcsOptions{} +} + +// SetStart : Allow user to set Start +func (_options *ListVpcsOptions) SetStart(start string) *ListVpcsOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListVpcsOptions) SetLimit(limit int64) *ListVpcsOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetResourceGroupID : Allow user to set ResourceGroupID +func (_options *ListVpcsOptions) SetResourceGroupID(resourceGroupID string) *ListVpcsOptions { + _options.ResourceGroupID = core.StringPtr(resourceGroupID) + return _options +} + +// SetClassicAccess : Allow user to set ClassicAccess +func (_options *ListVpcsOptions) SetClassicAccess(classicAccess bool) *ListVpcsOptions { + _options.ClassicAccess = core.BoolPtr(classicAccess) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListVpcsOptions) SetHeaders(param map[string]string) *ListVpcsOptions { + options.Headers = param + return options +} + +// ListVPNGatewayConnectionLocalCIDRsOptions : The ListVPNGatewayConnectionLocalCIDRs options. +type ListVPNGatewayConnectionLocalCIDRsOptions struct { + // The VPN gateway identifier. + VPNGatewayID *string `json:"vpn_gateway_id" validate:"required,ne="` + + // The VPN gateway connection identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListVPNGatewayConnectionLocalCIDRsOptions : Instantiate ListVPNGatewayConnectionLocalCIDRsOptions +func (*VpcV1) NewListVPNGatewayConnectionLocalCIDRsOptions(vpnGatewayID string, id string) *ListVPNGatewayConnectionLocalCIDRsOptions { + return &ListVPNGatewayConnectionLocalCIDRsOptions{ + VPNGatewayID: core.StringPtr(vpnGatewayID), + ID: core.StringPtr(id), + } +} + +// SetVPNGatewayID : Allow user to set VPNGatewayID +func (_options *ListVPNGatewayConnectionLocalCIDRsOptions) SetVPNGatewayID(vpnGatewayID string) *ListVPNGatewayConnectionLocalCIDRsOptions { + _options.VPNGatewayID = core.StringPtr(vpnGatewayID) + return _options +} + +// SetID : Allow user to set ID +func (_options *ListVPNGatewayConnectionLocalCIDRsOptions) SetID(id string) *ListVPNGatewayConnectionLocalCIDRsOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListVPNGatewayConnectionLocalCIDRsOptions) SetHeaders(param map[string]string) *ListVPNGatewayConnectionLocalCIDRsOptions { + options.Headers = param + return options +} + +// ListVPNGatewayConnectionPeerCIDRsOptions : The ListVPNGatewayConnectionPeerCIDRs options. +type ListVPNGatewayConnectionPeerCIDRsOptions struct { + // The VPN gateway identifier. + VPNGatewayID *string `json:"vpn_gateway_id" validate:"required,ne="` + + // The VPN gateway connection identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewListVPNGatewayConnectionPeerCIDRsOptions : Instantiate ListVPNGatewayConnectionPeerCIDRsOptions +func (*VpcV1) NewListVPNGatewayConnectionPeerCIDRsOptions(vpnGatewayID string, id string) *ListVPNGatewayConnectionPeerCIDRsOptions { + return &ListVPNGatewayConnectionPeerCIDRsOptions{ + VPNGatewayID: core.StringPtr(vpnGatewayID), + ID: core.StringPtr(id), + } +} + +// SetVPNGatewayID : Allow user to set VPNGatewayID +func (_options *ListVPNGatewayConnectionPeerCIDRsOptions) SetVPNGatewayID(vpnGatewayID string) *ListVPNGatewayConnectionPeerCIDRsOptions { + _options.VPNGatewayID = core.StringPtr(vpnGatewayID) + return _options +} + +// SetID : Allow user to set ID +func (_options *ListVPNGatewayConnectionPeerCIDRsOptions) SetID(id string) *ListVPNGatewayConnectionPeerCIDRsOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListVPNGatewayConnectionPeerCIDRsOptions) SetHeaders(param map[string]string) *ListVPNGatewayConnectionPeerCIDRsOptions { + options.Headers = param + return options +} + +// ListVPNGatewayConnectionsOptions : The ListVPNGatewayConnections options. +type ListVPNGatewayConnectionsOptions struct { + // The VPN gateway identifier. + VPNGatewayID *string `json:"vpn_gateway_id" validate:"required,ne="` + + // Filters the collection to VPN gateway connections with a `status` property matching the specified value. + Status *string `json:"status,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the ListVPNGatewayConnectionsOptions.Status property. +// Filters the collection to VPN gateway connections with a `status` property matching the specified value. +const ( + ListVPNGatewayConnectionsOptionsStatusDownConst = "down" + ListVPNGatewayConnectionsOptionsStatusUpConst = "up" +) + +// NewListVPNGatewayConnectionsOptions : Instantiate ListVPNGatewayConnectionsOptions +func (*VpcV1) NewListVPNGatewayConnectionsOptions(vpnGatewayID string) *ListVPNGatewayConnectionsOptions { + return &ListVPNGatewayConnectionsOptions{ + VPNGatewayID: core.StringPtr(vpnGatewayID), + } +} + +// SetVPNGatewayID : Allow user to set VPNGatewayID +func (_options *ListVPNGatewayConnectionsOptions) SetVPNGatewayID(vpnGatewayID string) *ListVPNGatewayConnectionsOptions { + _options.VPNGatewayID = core.StringPtr(vpnGatewayID) + return _options +} + +// SetStatus : Allow user to set Status +func (_options *ListVPNGatewayConnectionsOptions) SetStatus(status string) *ListVPNGatewayConnectionsOptions { + _options.Status = core.StringPtr(status) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListVPNGatewayConnectionsOptions) SetHeaders(param map[string]string) *ListVPNGatewayConnectionsOptions { + options.Headers = param + return options +} + +// ListVPNGatewaysOptions : The ListVPNGateways options. +type ListVPNGatewaysOptions struct { + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Filters the collection to resources with a `resource_group.id` property matching the specified identifier. + ResourceGroupID *string `json:"resource_group.id,omitempty"` + + // Sorts the returned collection by the specified property name in ascending order. A `-` may be prepended to the name + // to sort in descending order. For example, the value `-created_at` sorts the collection by the `created_at` property + // in descending order, and the value `name` sorts it by the `name` property in ascending order. + Sort *string `json:"sort,omitempty"` + + // Filters the collection to VPN gateways with a `mode` property matching the specified value. + Mode *string `json:"mode,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the ListVPNGatewaysOptions.Sort property. +// Sorts the returned collection by the specified property name in ascending order. A `-` may be prepended to the name +// to sort in descending order. For example, the value `-created_at` sorts the collection by the `created_at` property +// in descending order, and the value `name` sorts it by the `name` property in ascending order. +const ( + ListVPNGatewaysOptionsSortCreatedAtConst = "created_at" + ListVPNGatewaysOptionsSortNameConst = "name" +) + +// Constants associated with the ListVPNGatewaysOptions.Mode property. +// Filters the collection to VPN gateways with a `mode` property matching the specified value. +const ( + ListVPNGatewaysOptionsModePolicyConst = "policy" + ListVPNGatewaysOptionsModeRouteConst = "route" +) + +// NewListVPNGatewaysOptions : Instantiate ListVPNGatewaysOptions +func (*VpcV1) NewListVPNGatewaysOptions() *ListVPNGatewaysOptions { + return &ListVPNGatewaysOptions{} +} + +// SetStart : Allow user to set Start +func (_options *ListVPNGatewaysOptions) SetStart(start string) *ListVPNGatewaysOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListVPNGatewaysOptions) SetLimit(limit int64) *ListVPNGatewaysOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetResourceGroupID : Allow user to set ResourceGroupID +func (_options *ListVPNGatewaysOptions) SetResourceGroupID(resourceGroupID string) *ListVPNGatewaysOptions { + _options.ResourceGroupID = core.StringPtr(resourceGroupID) + return _options +} + +// SetSort : Allow user to set Sort +func (_options *ListVPNGatewaysOptions) SetSort(sort string) *ListVPNGatewaysOptions { + _options.Sort = core.StringPtr(sort) + return _options +} + +// SetMode : Allow user to set Mode +func (_options *ListVPNGatewaysOptions) SetMode(mode string) *ListVPNGatewaysOptions { + _options.Mode = core.StringPtr(mode) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListVPNGatewaysOptions) SetHeaders(param map[string]string) *ListVPNGatewaysOptions { + options.Headers = param + return options +} + +// ListVPNServerClientsOptions : The ListVPNServerClients options. +type ListVPNServerClientsOptions struct { + // The VPN server identifier. + VPNServerID *string `json:"vpn_server_id" validate:"required,ne="` + + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Sorts the returned collection by the specified property name in ascending order. A `-` may be prepended to the name + // to sort in descending order. For example, the value `-created_at` sorts the collection by the `created_at` property + // in descending order. + Sort *string `json:"sort,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the ListVPNServerClientsOptions.Sort property. +// Sorts the returned collection by the specified property name in ascending order. A `-` may be prepended to the name +// to sort in descending order. For example, the value `-created_at` sorts the collection by the `created_at` property +// in descending order. +const ( + ListVPNServerClientsOptionsSortCreatedAtConst = "created_at" +) + +// NewListVPNServerClientsOptions : Instantiate ListVPNServerClientsOptions +func (*VpcV1) NewListVPNServerClientsOptions(vpnServerID string) *ListVPNServerClientsOptions { + return &ListVPNServerClientsOptions{ + VPNServerID: core.StringPtr(vpnServerID), + } +} + +// SetVPNServerID : Allow user to set VPNServerID +func (_options *ListVPNServerClientsOptions) SetVPNServerID(vpnServerID string) *ListVPNServerClientsOptions { + _options.VPNServerID = core.StringPtr(vpnServerID) + return _options +} + +// SetStart : Allow user to set Start +func (_options *ListVPNServerClientsOptions) SetStart(start string) *ListVPNServerClientsOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListVPNServerClientsOptions) SetLimit(limit int64) *ListVPNServerClientsOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetSort : Allow user to set Sort +func (_options *ListVPNServerClientsOptions) SetSort(sort string) *ListVPNServerClientsOptions { + _options.Sort = core.StringPtr(sort) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListVPNServerClientsOptions) SetHeaders(param map[string]string) *ListVPNServerClientsOptions { + options.Headers = param + return options +} + +// ListVPNServerRoutesOptions : The ListVPNServerRoutes options. +type ListVPNServerRoutesOptions struct { + // The VPN server identifier. + VPNServerID *string `json:"vpn_server_id" validate:"required,ne="` + + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Sorts the returned collection by the specified property name in ascending order. A `-` may be prepended to the name + // to sort in descending order. For example, the value `-created_at` sorts the collection by the `created_at` property + // in descending order, and the value `name` sorts it by the `name` property in ascending order. + Sort *string `json:"sort,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the ListVPNServerRoutesOptions.Sort property. +// Sorts the returned collection by the specified property name in ascending order. A `-` may be prepended to the name +// to sort in descending order. For example, the value `-created_at` sorts the collection by the `created_at` property +// in descending order, and the value `name` sorts it by the `name` property in ascending order. +const ( + ListVPNServerRoutesOptionsSortCreatedAtConst = "created_at" + ListVPNServerRoutesOptionsSortNameConst = "name" +) + +// NewListVPNServerRoutesOptions : Instantiate ListVPNServerRoutesOptions +func (*VpcV1) NewListVPNServerRoutesOptions(vpnServerID string) *ListVPNServerRoutesOptions { + return &ListVPNServerRoutesOptions{ + VPNServerID: core.StringPtr(vpnServerID), + } +} + +// SetVPNServerID : Allow user to set VPNServerID +func (_options *ListVPNServerRoutesOptions) SetVPNServerID(vpnServerID string) *ListVPNServerRoutesOptions { + _options.VPNServerID = core.StringPtr(vpnServerID) + return _options +} + +// SetStart : Allow user to set Start +func (_options *ListVPNServerRoutesOptions) SetStart(start string) *ListVPNServerRoutesOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListVPNServerRoutesOptions) SetLimit(limit int64) *ListVPNServerRoutesOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetSort : Allow user to set Sort +func (_options *ListVPNServerRoutesOptions) SetSort(sort string) *ListVPNServerRoutesOptions { + _options.Sort = core.StringPtr(sort) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListVPNServerRoutesOptions) SetHeaders(param map[string]string) *ListVPNServerRoutesOptions { + options.Headers = param + return options +} + +// ListVPNServersOptions : The ListVPNServers options. +type ListVPNServersOptions struct { + // Filters the collection to resources with a `name` property matching the exact specified name. + Name *string `json:"name,omitempty"` + + // A server-provided token determining what resource to start the page on. + Start *string `json:"start,omitempty"` + + // The number of resources to return on a page. + Limit *int64 `json:"limit,omitempty"` + + // Filters the collection to resources with a `resource_group.id` property matching the specified identifier. + ResourceGroupID *string `json:"resource_group.id,omitempty"` + + // Sorts the returned collection by the specified property name in ascending order. A `-` may be prepended to the name + // to sort in descending order. For example, the value `-created_at` sorts the collection by the `created_at` property + // in descending order, and the value `name` sorts it by the `name` property in ascending order. + Sort *string `json:"sort,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the ListVPNServersOptions.Sort property. +// Sorts the returned collection by the specified property name in ascending order. A `-` may be prepended to the name +// to sort in descending order. For example, the value `-created_at` sorts the collection by the `created_at` property +// in descending order, and the value `name` sorts it by the `name` property in ascending order. +const ( + ListVPNServersOptionsSortCreatedAtConst = "created_at" + ListVPNServersOptionsSortNameConst = "name" +) + +// NewListVPNServersOptions : Instantiate ListVPNServersOptions +func (*VpcV1) NewListVPNServersOptions() *ListVPNServersOptions { + return &ListVPNServersOptions{} +} + +// SetName : Allow user to set Name +func (_options *ListVPNServersOptions) SetName(name string) *ListVPNServersOptions { + _options.Name = core.StringPtr(name) + return _options +} + +// SetStart : Allow user to set Start +func (_options *ListVPNServersOptions) SetStart(start string) *ListVPNServersOptions { + _options.Start = core.StringPtr(start) + return _options +} + +// SetLimit : Allow user to set Limit +func (_options *ListVPNServersOptions) SetLimit(limit int64) *ListVPNServersOptions { + _options.Limit = core.Int64Ptr(limit) + return _options +} + +// SetResourceGroupID : Allow user to set ResourceGroupID +func (_options *ListVPNServersOptions) SetResourceGroupID(resourceGroupID string) *ListVPNServersOptions { + _options.ResourceGroupID = core.StringPtr(resourceGroupID) + return _options +} + +// SetSort : Allow user to set Sort +func (_options *ListVPNServersOptions) SetSort(sort string) *ListVPNServersOptions { + _options.Sort = core.StringPtr(sort) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ListVPNServersOptions) SetHeaders(param map[string]string) *ListVPNServersOptions { + options.Headers = param + return options +} + +// LoadBalancer : LoadBalancer struct +type LoadBalancer struct { + // The date and time that this load balancer was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The load balancer's CRN. + CRN *string `json:"crn" validate:"required"` + + // The DNS configuration for this load balancer. + // + // If absent, DNS `A` records for this load balancer's `hostname` property will be added to + // the public DNS zone `lb.appdomain.cloud`. + Dns *LoadBalancerDns `json:"dns,omitempty"` + + // Fully qualified domain name assigned to this load balancer. + Hostname *string `json:"hostname" validate:"required"` + + // The load balancer's canonical URL. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this load balancer. + ID *string `json:"id" validate:"required"` + + // Indicates whether this load balancer supports instance groups. + InstanceGroupsSupported *bool `json:"instance_groups_supported" validate:"required"` + + // The type of this load balancer, public or private. + IsPublic *bool `json:"is_public" validate:"required"` + + // The listeners of this load balancer. + Listeners []LoadBalancerListenerReference `json:"listeners" validate:"required"` + + // The logging configuration for this load balancer. + Logging *LoadBalancerLogging `json:"logging" validate:"required"` + + // The name for this load balancer. The name is unique across all load balancers in the VPC. + Name *string `json:"name" validate:"required"` + + // The operating status of this load balancer. + OperatingStatus *string `json:"operating_status" validate:"required"` + + // The pools of this load balancer. + Pools []LoadBalancerPoolReference `json:"pools" validate:"required"` + + // The private IP addresses assigned to this load balancer. + PrivateIps []LoadBalancerPrivateIpsItem `json:"private_ips" validate:"required"` + + // The profile for this load balancer. + Profile *LoadBalancerProfileReference `json:"profile" validate:"required"` + + // The provisioning status of this load balancer: + // + // - `active`: The load balancer is running. + // - `create_pending`: The load balancer is being created. + // - `delete_pending`: The load balancer is being deleted. + // - `maintenance_pending`: The load balancer is unavailable due to an internal + // error (contact IBM support). + // - `migrate_pending`: The load balancer is migrating to the requested configuration. + // Performance may be degraded. + // - `update_pending`: The load balancer is being updated + // to the requested configuration. + // + // The enumerated values for this property are expected to expand in the future. When + // processing this property, check for and log unknown values. Optionally halt + // processing and surface the error, or bypass the load balancer on which the + // unexpected property value was encountered. + ProvisioningStatus *string `json:"provisioning_status" validate:"required"` + + // The public IP addresses assigned to this load balancer. + // + // Applicable only for public load balancers. + PublicIps []IP `json:"public_ips" validate:"required"` + + // The resource group for this load balancer. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // Indicates whether route mode is enabled for this load balancer. + // + // At present, public load balancers are not supported with route mode enabled. + RouteMode *bool `json:"route_mode" validate:"required"` + + // The security groups targeting this load balancer. + // + // Applicable only for load balancers that support security groups. + SecurityGroups []SecurityGroupReference `json:"security_groups" validate:"required"` + + // Indicates whether this load balancer supports security groups. + SecurityGroupsSupported *bool `json:"security_groups_supported" validate:"required"` + + // The subnets this load balancer is provisioned in. The load balancer's availability depends on the availability of + // the zones that the subnets reside in. + // + // All subnets will be in the same VPC. + Subnets []SubnetReference `json:"subnets" validate:"required"` + + // Indicates whether this load balancer supports UDP. + UDPSupported *bool `json:"udp_supported" validate:"required"` +} + +// Constants associated with the LoadBalancer.OperatingStatus property. +// The operating status of this load balancer. +const ( + LoadBalancerOperatingStatusOfflineConst = "offline" + LoadBalancerOperatingStatusOnlineConst = "online" +) + +// Constants associated with the LoadBalancer.ProvisioningStatus property. +// The provisioning status of this load balancer: +// +// - `active`: The load balancer is running. +// +// - `create_pending`: The load balancer is being created. +// +// - `delete_pending`: The load balancer is being deleted. +// +// - `maintenance_pending`: The load balancer is unavailable due to an internal +// error (contact IBM support). +// +// - `migrate_pending`: The load balancer is migrating to the requested configuration. +// Performance may be degraded. +// +// - `update_pending`: The load balancer is being updated +// to the requested configuration. +// +// The enumerated values for this property are expected to expand in the future. When +// processing this property, check for and log unknown values. Optionally halt +// processing and surface the error, or bypass the load balancer on which the +// unexpected property value was encountered. +const ( + LoadBalancerProvisioningStatusActiveConst = "active" + LoadBalancerProvisioningStatusCreatePendingConst = "create_pending" + LoadBalancerProvisioningStatusDeletePendingConst = "delete_pending" + LoadBalancerProvisioningStatusFailedConst = "failed" + LoadBalancerProvisioningStatusMaintenancePendingConst = "maintenance_pending" + LoadBalancerProvisioningStatusMigratePendingConst = "migrate_pending" + LoadBalancerProvisioningStatusUpdatePendingConst = "update_pending" +) + +// Constants associated with the LoadBalancer.ResourceType property. +// The resource type. +const ( + LoadBalancerResourceTypeLoadBalancerConst = "load_balancer" +) + +// UnmarshalLoadBalancer unmarshals an instance of LoadBalancer from the specified map of raw messages. +func UnmarshalLoadBalancer(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancer) + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "dns", &obj.Dns, UnmarshalLoadBalancerDns) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "hostname", &obj.Hostname) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "instance_groups_supported", &obj.InstanceGroupsSupported) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "is_public", &obj.IsPublic) + if err != nil { + return + } + err = core.UnmarshalModel(m, "listeners", &obj.Listeners, UnmarshalLoadBalancerListenerReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "logging", &obj.Logging, UnmarshalLoadBalancerLogging) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "operating_status", &obj.OperatingStatus) + if err != nil { + return + } + err = core.UnmarshalModel(m, "pools", &obj.Pools, UnmarshalLoadBalancerPoolReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "private_ips", &obj.PrivateIps, UnmarshalLoadBalancerPrivateIpsItem) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalLoadBalancerProfileReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "provisioning_status", &obj.ProvisioningStatus) + if err != nil { + return + } + err = core.UnmarshalModel(m, "public_ips", &obj.PublicIps, UnmarshalIP) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "route_mode", &obj.RouteMode) + if err != nil { + return + } + err = core.UnmarshalModel(m, "security_groups", &obj.SecurityGroups, UnmarshalSecurityGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "security_groups_supported", &obj.SecurityGroupsSupported) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnets", &obj.Subnets, UnmarshalSubnetReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "udp_supported", &obj.UDPSupported) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerCollection : LoadBalancerCollection struct +type LoadBalancerCollection struct { + // A link to the first page of resources. + First *LoadBalancerCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // Collection of load balancers. + LoadBalancers []LoadBalancer `json:"load_balancers" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *LoadBalancerCollectionNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalLoadBalancerCollection unmarshals an instance of LoadBalancerCollection from the specified map of raw messages. +func UnmarshalLoadBalancerCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalLoadBalancerCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "load_balancers", &obj.LoadBalancers, UnmarshalLoadBalancer) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalLoadBalancerCollectionNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *LoadBalancerCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// LoadBalancerCollectionFirst : A link to the first page of resources. +type LoadBalancerCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalLoadBalancerCollectionFirst unmarshals an instance of LoadBalancerCollectionFirst from the specified map of raw messages. +func UnmarshalLoadBalancerCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type LoadBalancerCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalLoadBalancerCollectionNext unmarshals an instance of LoadBalancerCollectionNext from the specified map of raw messages. +func UnmarshalLoadBalancerCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerDns : The DNS configuration for this load balancer. +// +// If absent, DNS `A` records for this load balancer's `hostname` property will be added to the public DNS zone +// `lb.appdomain.cloud`. +type LoadBalancerDns struct { + // The DNS instance associated with this load balancer. + Instance *DnsInstanceReference `json:"instance" validate:"required"` + + // The DNS zone associated with this load balancer. + Zone *DnsZoneReference `json:"zone" validate:"required"` +} + +// UnmarshalLoadBalancerDns unmarshals an instance of LoadBalancerDns from the specified map of raw messages. +func UnmarshalLoadBalancerDns(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerDns) + err = core.UnmarshalModel(m, "instance", &obj.Instance, UnmarshalDnsInstanceReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalDnsZoneReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerDnsPatch : The DNS configuration for this load balancer. +// +// Specify `null` to remove the existing DNS configuration, which will remove all DNS `A` records for this load balancer +// that had been added to `zone`, and add equivalent `A` records to the public DNS zone `lb.appdomain.cloud`. +type LoadBalancerDnsPatch struct { + // The DNS instance to associate with this load balancer. + // + // The specified instance may be in a different region or account, subject to IAM + // policies. + Instance DnsInstanceIdentityIntf `json:"instance,omitempty"` + + // The DNS zone to associate with this load balancer. + // + // The specified zone may be in a different region or account, subject to IAM policies. + Zone DnsZoneIdentityIntf `json:"zone,omitempty"` +} + +// UnmarshalLoadBalancerDnsPatch unmarshals an instance of LoadBalancerDnsPatch from the specified map of raw messages. +func UnmarshalLoadBalancerDnsPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerDnsPatch) + err = core.UnmarshalModel(m, "instance", &obj.Instance, UnmarshalDnsInstanceIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalDnsZoneIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerDnsPrototype : The DNS configuration for this load balancer. +// +// If unspecified, DNS `A` records for this load balancer's `hostname` property will be added to the public DNS zone +// `lb.appdomain.cloud`. Otherwise, those DNS `A` records will be added to the specified `zone`. +type LoadBalancerDnsPrototype struct { + // The DNS instance to associate with this load balancer. + // + // The specified instance may be in a different region or account, subject to IAM + // policies. + Instance DnsInstanceIdentityIntf `json:"instance" validate:"required"` + + // The DNS zone to associate with this load balancer. + // + // The specified zone may be in a different region or account, subject to IAM policies. + Zone DnsZoneIdentityIntf `json:"zone" validate:"required"` +} + +// NewLoadBalancerDnsPrototype : Instantiate LoadBalancerDnsPrototype (Generic Model Constructor) +func (*VpcV1) NewLoadBalancerDnsPrototype(instance DnsInstanceIdentityIntf, zone DnsZoneIdentityIntf) (_model *LoadBalancerDnsPrototype, err error) { + _model = &LoadBalancerDnsPrototype{ + Instance: instance, + Zone: zone, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalLoadBalancerDnsPrototype unmarshals an instance of LoadBalancerDnsPrototype from the specified map of raw messages. +func UnmarshalLoadBalancerDnsPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerDnsPrototype) + err = core.UnmarshalModel(m, "instance", &obj.Instance, UnmarshalDnsInstanceIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalDnsZoneIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerIdentity : Identifies a load balancer by a unique property. +// Models which "extend" this model: +// - LoadBalancerIdentityByID +// - LoadBalancerIdentityByCRN +// - LoadBalancerIdentityByHref +type LoadBalancerIdentity struct { + // The unique identifier for this load balancer. + ID *string `json:"id,omitempty"` + + // The load balancer's CRN. + CRN *string `json:"crn,omitempty"` + + // The load balancer's canonical URL. + Href *string `json:"href,omitempty"` +} + +func (*LoadBalancerIdentity) isaLoadBalancerIdentity() bool { + return true +} + +type LoadBalancerIdentityIntf interface { + isaLoadBalancerIdentity() bool +} + +// UnmarshalLoadBalancerIdentity unmarshals an instance of LoadBalancerIdentity from the specified map of raw messages. +func UnmarshalLoadBalancerIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListener : LoadBalancerListener struct +type LoadBalancerListener struct { + // If set to `true`, this listener will accept and forward PROXY protocol information. Supported by load balancers in + // the `application` family (otherwise always `false`). Additional restrictions: + // - If this listener has `https_redirect` specified, its `accept_proxy_protocol` value must + // match the `accept_proxy_protocol` value of the `https_redirect` listener. + // - If this listener is the target of another listener's `https_redirect`, its + // `accept_proxy_protocol` value must match that listener's `accept_proxy_protocol` value. + AcceptProxyProtocol *bool `json:"accept_proxy_protocol" validate:"required"` + + // The certificate instance used for SSL termination. + // + // If absent, this listener is not using a certificate instance. + CertificateInstance *CertificateInstanceReference `json:"certificate_instance,omitempty"` + + // The connection limit of the listener. + ConnectionLimit *int64 `json:"connection_limit,omitempty"` + + // The date and time that this listener was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The default pool for this listener. If absent, this listener has no default pool. + DefaultPool *LoadBalancerPoolReference `json:"default_pool,omitempty"` + + // The listener's canonical URL. + Href *string `json:"href" validate:"required"` + + // If present, the target listener that requests are redirected to. + HTTPSRedirect *LoadBalancerListenerHTTPSRedirect `json:"https_redirect,omitempty"` + + // The unique identifier for this load balancer listener. + ID *string `json:"id" validate:"required"` + + // The idle connection timeout of the listener in seconds. This property will be present for load balancers in the + // `application` family. + IdleConnectionTimeout *int64 `json:"idle_connection_timeout,omitempty"` + + // The policies for this listener. + Policies []LoadBalancerListenerPolicyReference `json:"policies,omitempty"` + + // The listener port number, or the inclusive lower bound of the port range. + Port *int64 `json:"port" validate:"required"` + + // The inclusive upper bound of the range of ports used by this listener. + // + // At present, only load balancers in the `network` family support more than one port per listener. + PortMax *int64 `json:"port_max" validate:"required"` + + // The inclusive lower bound of the range of ports used by this listener. + // + // At present, only load balancers in the `network` family support more than one port per listener. + PortMin *int64 `json:"port_min" validate:"required"` + + // The listener protocol. + // + // The enumerated values for this property are expected to expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the listener on which the + // unexpected property value was encountered. + Protocol *string `json:"protocol" validate:"required"` + + // The provisioning status of this listener + // + // The enumerated values for this property are expected to expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the listener on which the + // unexpected property value was encountered. + ProvisioningStatus *string `json:"provisioning_status" validate:"required"` +} + +// Constants associated with the LoadBalancerListener.Protocol property. +// The listener protocol. +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the listener on which the +// unexpected property value was encountered. +const ( + LoadBalancerListenerProtocolHTTPConst = "http" + LoadBalancerListenerProtocolHTTPSConst = "https" + LoadBalancerListenerProtocolTCPConst = "tcp" + LoadBalancerListenerProtocolUDPConst = "udp" +) + +// Constants associated with the LoadBalancerListener.ProvisioningStatus property. +// The provisioning status of this listener +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the listener on which the +// unexpected property value was encountered. +const ( + LoadBalancerListenerProvisioningStatusActiveConst = "active" + LoadBalancerListenerProvisioningStatusCreatePendingConst = "create_pending" + LoadBalancerListenerProvisioningStatusDeletePendingConst = "delete_pending" + LoadBalancerListenerProvisioningStatusFailedConst = "failed" + LoadBalancerListenerProvisioningStatusUpdatePendingConst = "update_pending" +) + +// UnmarshalLoadBalancerListener unmarshals an instance of LoadBalancerListener from the specified map of raw messages. +func UnmarshalLoadBalancerListener(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListener) + err = core.UnmarshalPrimitive(m, "accept_proxy_protocol", &obj.AcceptProxyProtocol) + if err != nil { + return + } + err = core.UnmarshalModel(m, "certificate_instance", &obj.CertificateInstance, UnmarshalCertificateInstanceReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "connection_limit", &obj.ConnectionLimit) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalModel(m, "default_pool", &obj.DefaultPool, UnmarshalLoadBalancerPoolReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalModel(m, "https_redirect", &obj.HTTPSRedirect, UnmarshalLoadBalancerListenerHTTPSRedirect) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "idle_connection_timeout", &obj.IdleConnectionTimeout) + if err != nil { + return + } + err = core.UnmarshalModel(m, "policies", &obj.Policies, UnmarshalLoadBalancerListenerPolicyReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "port", &obj.Port) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "port_max", &obj.PortMax) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "port_min", &obj.PortMin) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "protocol", &obj.Protocol) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "provisioning_status", &obj.ProvisioningStatus) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerCollection : LoadBalancerListenerCollection struct +type LoadBalancerListenerCollection struct { + // Collection of listeners. + Listeners []LoadBalancerListener `json:"listeners" validate:"required"` +} + +// UnmarshalLoadBalancerListenerCollection unmarshals an instance of LoadBalancerListenerCollection from the specified map of raw messages. +func UnmarshalLoadBalancerListenerCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerCollection) + err = core.UnmarshalModel(m, "listeners", &obj.Listeners, UnmarshalLoadBalancerListener) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerHTTPSRedirect : LoadBalancerListenerHTTPSRedirect struct +type LoadBalancerListenerHTTPSRedirect struct { + // The HTTP status code for this redirect. + HTTPStatusCode *int64 `json:"http_status_code" validate:"required"` + + Listener *LoadBalancerListenerReference `json:"listener" validate:"required"` + + // The redirect relative target URI. + URI *string `json:"uri,omitempty"` +} + +// UnmarshalLoadBalancerListenerHTTPSRedirect unmarshals an instance of LoadBalancerListenerHTTPSRedirect from the specified map of raw messages. +func UnmarshalLoadBalancerListenerHTTPSRedirect(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerHTTPSRedirect) + err = core.UnmarshalPrimitive(m, "http_status_code", &obj.HTTPStatusCode) + if err != nil { + return + } + err = core.UnmarshalModel(m, "listener", &obj.Listener, UnmarshalLoadBalancerListenerReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "uri", &obj.URI) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerHTTPSRedirectPatch : LoadBalancerListenerHTTPSRedirectPatch struct +type LoadBalancerListenerHTTPSRedirectPatch struct { + // The HTTP status code for this redirect. + HTTPStatusCode *int64 `json:"http_status_code,omitempty"` + + // Identifies a load balancer listener by a unique property. + Listener LoadBalancerListenerIdentityIntf `json:"listener,omitempty"` + + // The redirect relative target URI. + URI *string `json:"uri,omitempty"` +} + +// UnmarshalLoadBalancerListenerHTTPSRedirectPatch unmarshals an instance of LoadBalancerListenerHTTPSRedirectPatch from the specified map of raw messages. +func UnmarshalLoadBalancerListenerHTTPSRedirectPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerHTTPSRedirectPatch) + err = core.UnmarshalPrimitive(m, "http_status_code", &obj.HTTPStatusCode) + if err != nil { + return + } + err = core.UnmarshalModel(m, "listener", &obj.Listener, UnmarshalLoadBalancerListenerIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "uri", &obj.URI) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerHTTPSRedirectPrototype : LoadBalancerListenerHTTPSRedirectPrototype struct +type LoadBalancerListenerHTTPSRedirectPrototype struct { + // The HTTP status code for this redirect. + HTTPStatusCode *int64 `json:"http_status_code" validate:"required"` + + // Identifies a load balancer listener by a unique property. + Listener LoadBalancerListenerIdentityIntf `json:"listener" validate:"required"` + + // The redirect relative target URI. + URI *string `json:"uri,omitempty"` +} + +// NewLoadBalancerListenerHTTPSRedirectPrototype : Instantiate LoadBalancerListenerHTTPSRedirectPrototype (Generic Model Constructor) +func (*VpcV1) NewLoadBalancerListenerHTTPSRedirectPrototype(httpStatusCode int64, listener LoadBalancerListenerIdentityIntf) (_model *LoadBalancerListenerHTTPSRedirectPrototype, err error) { + _model = &LoadBalancerListenerHTTPSRedirectPrototype{ + HTTPStatusCode: core.Int64Ptr(httpStatusCode), + Listener: listener, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalLoadBalancerListenerHTTPSRedirectPrototype unmarshals an instance of LoadBalancerListenerHTTPSRedirectPrototype from the specified map of raw messages. +func UnmarshalLoadBalancerListenerHTTPSRedirectPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerHTTPSRedirectPrototype) + err = core.UnmarshalPrimitive(m, "http_status_code", &obj.HTTPStatusCode) + if err != nil { + return + } + err = core.UnmarshalModel(m, "listener", &obj.Listener, UnmarshalLoadBalancerListenerIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "uri", &obj.URI) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerIdentity : Identifies a load balancer listener by a unique property. +// Models which "extend" this model: +// - LoadBalancerListenerIdentityByID +// - LoadBalancerListenerIdentityByHref +type LoadBalancerListenerIdentity struct { + // The unique identifier for this load balancer listener. + ID *string `json:"id,omitempty"` + + // The listener's canonical URL. + Href *string `json:"href,omitempty"` +} + +func (*LoadBalancerListenerIdentity) isaLoadBalancerListenerIdentity() bool { + return true +} + +type LoadBalancerListenerIdentityIntf interface { + isaLoadBalancerListenerIdentity() bool +} + +// UnmarshalLoadBalancerListenerIdentity unmarshals an instance of LoadBalancerListenerIdentity from the specified map of raw messages. +func UnmarshalLoadBalancerListenerIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerPatch : LoadBalancerListenerPatch struct +type LoadBalancerListenerPatch struct { + // If set to `true`, this listener will accept and forward PROXY protocol information. Supported by load balancers in + // the `application` family (otherwise always `false`). Additional restrictions: + // - If this listener has `https_redirect` specified, its `accept_proxy_protocol` value must + // match the `accept_proxy_protocol` value of the `https_redirect` listener. + // - If this listener is the target of another listener's `https_redirect`, its + // `accept_proxy_protocol` value must match that listener's `accept_proxy_protocol` value. + AcceptProxyProtocol *bool `json:"accept_proxy_protocol,omitempty"` + + // The certificate instance to use for SSL termination. The listener must have a + // `protocol` of `https`. + CertificateInstance CertificateInstanceIdentityIntf `json:"certificate_instance,omitempty"` + + // The connection limit of the listener. + ConnectionLimit *int64 `json:"connection_limit,omitempty"` + + // The default pool for this listener. The specified pool must: + // + // - Belong to this load balancer + // - Have the same `protocol` as this listener, or have a compatible protocol. + // At present, the compatible protocols are `http` and `https`. + // - Not already be the `default_pool` for another listener + // + // Specify `null` to remove an existing default pool. + DefaultPool LoadBalancerPoolIdentityIntf `json:"default_pool,omitempty"` + + // The target listener that requests will be redirected to. This listener must have a + // `protocol` of `http`, and the target listener must have a `protocol` of `https`. + // + // Specify `null` to remove any existing https redirect. + HTTPSRedirect *LoadBalancerListenerHTTPSRedirectPatch `json:"https_redirect,omitempty"` + + // The idle connection timeout of the listener in seconds. Supported for load balancers in the `application` family. + IdleConnectionTimeout *int64 `json:"idle_connection_timeout,omitempty"` + + // The listener port number, or the inclusive lower bound of the port range. Each listener in the load balancer must + // have a unique `port` and `protocol` combination. + // + // Not supported for load balancers operating with route mode enabled. + Port *int64 `json:"port,omitempty"` + + // The inclusive upper bound of the range of ports used by this listener. Must not be less than `port_min`. + // + // At present, only load balancers operating with route mode enabled, and public load balancers in the `network` family + // support different values for `port_min` and + // `port_max`. When route mode is enabled, the value `65535` must be specified. + // + // The specified port range must not overlap with port ranges used by other listeners for this load balancer using the + // same protocol. + PortMax *int64 `json:"port_max,omitempty"` + + // The inclusive lower bound of the range of ports used by this listener. Must not be greater than `port_max`. + // + // At present, only load balancers operating with route mode enabled, and public load balancers in the `network` family + // support different values for `port_min` and + // `port_max`. When route mode is enabled, the value `1` must be specified. + // + // The specified port range must not overlap with port ranges used by other listeners for this load balancer using the + // same protocol. + PortMin *int64 `json:"port_min,omitempty"` + + // The listener protocol. Each listener in the load balancer must have a unique `port` and `protocol` combination. + // + // Load balancers in the `network` family support `tcp` and `udp` (if `udp_supported` is `true`). Load balancers in the + // `application` family support `tcp`, `http` and + // `https`. + // + // Additional restrictions: + // - If `default_pool` is set, the protocol cannot be changed. + // - If `https_redirect` is set, the protocol must be `http`. + // - If another listener's `https_redirect` targets this listener, the protocol must be + // `https`. + Protocol *string `json:"protocol,omitempty"` +} + +// Constants associated with the LoadBalancerListenerPatch.Protocol property. +// The listener protocol. Each listener in the load balancer must have a unique `port` and `protocol` combination. +// +// Load balancers in the `network` family support `tcp` and `udp` (if `udp_supported` is `true`). Load balancers in the +// `application` family support `tcp`, `http` and +// `https`. +// +// Additional restrictions: +// - If `default_pool` is set, the protocol cannot be changed. +// - If `https_redirect` is set, the protocol must be `http`. +// - If another listener's `https_redirect` targets this listener, the protocol must be +// `https`. +const ( + LoadBalancerListenerPatchProtocolHTTPConst = "http" + LoadBalancerListenerPatchProtocolHTTPSConst = "https" + LoadBalancerListenerPatchProtocolTCPConst = "tcp" + LoadBalancerListenerPatchProtocolUDPConst = "udp" +) + +// UnmarshalLoadBalancerListenerPatch unmarshals an instance of LoadBalancerListenerPatch from the specified map of raw messages. +func UnmarshalLoadBalancerListenerPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerPatch) + err = core.UnmarshalPrimitive(m, "accept_proxy_protocol", &obj.AcceptProxyProtocol) + if err != nil { + return + } + err = core.UnmarshalModel(m, "certificate_instance", &obj.CertificateInstance, UnmarshalCertificateInstanceIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "connection_limit", &obj.ConnectionLimit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "default_pool", &obj.DefaultPool, UnmarshalLoadBalancerPoolIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "https_redirect", &obj.HTTPSRedirect, UnmarshalLoadBalancerListenerHTTPSRedirectPatch) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "idle_connection_timeout", &obj.IdleConnectionTimeout) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "port", &obj.Port) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "port_max", &obj.PortMax) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "port_min", &obj.PortMin) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "protocol", &obj.Protocol) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the LoadBalancerListenerPatch +func (loadBalancerListenerPatch *LoadBalancerListenerPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(loadBalancerListenerPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// LoadBalancerListenerPolicy : LoadBalancerListenerPolicy struct +type LoadBalancerListenerPolicy struct { + // The policy action. + // + // The enumerated values for this property are expected to expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the policy on which the + // unexpected property value was encountered. + Action *string `json:"action" validate:"required"` + + // The date and time that this policy was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The listener policy's canonical URL. + Href *string `json:"href" validate:"required"` + + // The policy's unique identifier. + ID *string `json:"id" validate:"required"` + + // The name for this load balancer listener policy. The name is unique across all policies for the load balancer + // listener. + Name *string `json:"name" validate:"required"` + + // Priority of the policy. Lower value indicates higher priority. + Priority *int64 `json:"priority" validate:"required"` + + // The provisioning status of this policy + // + // The enumerated values for this property are expected to expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the policy on which the + // unexpected property value was encountered. + ProvisioningStatus *string `json:"provisioning_status" validate:"required"` + + // The rules for this policy. + Rules []LoadBalancerListenerPolicyRuleReference `json:"rules" validate:"required"` + + // - If `action` is `forward`, the response is a `LoadBalancerPoolReference` + // - If `action` is `redirect`, the response is a `LoadBalancerListenerPolicyRedirectURL` + // - If `action` is `https_redirect`, the response is a `LoadBalancerListenerHTTPSRedirect`. + Target LoadBalancerListenerPolicyTargetIntf `json:"target,omitempty"` +} + +// Constants associated with the LoadBalancerListenerPolicy.Action property. +// The policy action. +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the policy on which the +// unexpected property value was encountered. +const ( + LoadBalancerListenerPolicyActionForwardConst = "forward" + LoadBalancerListenerPolicyActionHTTPSRedirectConst = "https_redirect" + LoadBalancerListenerPolicyActionRedirectConst = "redirect" + LoadBalancerListenerPolicyActionRejectConst = "reject" +) + +// Constants associated with the LoadBalancerListenerPolicy.ProvisioningStatus property. +// The provisioning status of this policy +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the policy on which the +// unexpected property value was encountered. +const ( + LoadBalancerListenerPolicyProvisioningStatusActiveConst = "active" + LoadBalancerListenerPolicyProvisioningStatusCreatePendingConst = "create_pending" + LoadBalancerListenerPolicyProvisioningStatusDeletePendingConst = "delete_pending" + LoadBalancerListenerPolicyProvisioningStatusFailedConst = "failed" + LoadBalancerListenerPolicyProvisioningStatusUpdatePendingConst = "update_pending" +) + +// UnmarshalLoadBalancerListenerPolicy unmarshals an instance of LoadBalancerListenerPolicy from the specified map of raw messages. +func UnmarshalLoadBalancerListenerPolicy(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerPolicy) + err = core.UnmarshalPrimitive(m, "action", &obj.Action) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "priority", &obj.Priority) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "provisioning_status", &obj.ProvisioningStatus) + if err != nil { + return + } + err = core.UnmarshalModel(m, "rules", &obj.Rules, UnmarshalLoadBalancerListenerPolicyRuleReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "target", &obj.Target, UnmarshalLoadBalancerListenerPolicyTarget) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerPolicyCollection : LoadBalancerListenerPolicyCollection struct +type LoadBalancerListenerPolicyCollection struct { + // Collection of policies. + Policies []LoadBalancerListenerPolicy `json:"policies" validate:"required"` +} + +// UnmarshalLoadBalancerListenerPolicyCollection unmarshals an instance of LoadBalancerListenerPolicyCollection from the specified map of raw messages. +func UnmarshalLoadBalancerListenerPolicyCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerPolicyCollection) + err = core.UnmarshalModel(m, "policies", &obj.Policies, UnmarshalLoadBalancerListenerPolicy) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerPolicyPatch : LoadBalancerListenerPolicyPatch struct +type LoadBalancerListenerPolicyPatch struct { + // The name for this policy. The name must not be used by another policy for the load balancer listener. + Name *string `json:"name,omitempty"` + + // Priority of the policy. Lower value indicates higher priority. + Priority *int64 `json:"priority,omitempty"` + + // - If `action` is `forward`, specify a `LoadBalancerPoolIdentity`. + // - If `action` is `redirect`, specify a `LoadBalancerListenerPolicyRedirectURLPatch`. + // - If `action` is `https_redirect`, specify a + // `LoadBalancerListenerPolicyHTTPSRedirectPatch`. + Target LoadBalancerListenerPolicyTargetPatchIntf `json:"target,omitempty"` +} + +// UnmarshalLoadBalancerListenerPolicyPatch unmarshals an instance of LoadBalancerListenerPolicyPatch from the specified map of raw messages. +func UnmarshalLoadBalancerListenerPolicyPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerPolicyPatch) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "priority", &obj.Priority) + if err != nil { + return + } + err = core.UnmarshalModel(m, "target", &obj.Target, UnmarshalLoadBalancerListenerPolicyTargetPatch) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the LoadBalancerListenerPolicyPatch +func (loadBalancerListenerPolicyPatch *LoadBalancerListenerPolicyPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(loadBalancerListenerPolicyPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// LoadBalancerListenerPolicyPrototype : LoadBalancerListenerPolicyPrototype struct +type LoadBalancerListenerPolicyPrototype struct { + // The policy action. + // + // The enumerated values for this property are expected to expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the policy on which the + // unexpected property value was encountered. + Action *string `json:"action" validate:"required"` + + // The name for this policy. The name must not be used by another policy for the load balancer listener. If + // unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // Priority of the policy. Lower value indicates higher priority. + Priority *int64 `json:"priority" validate:"required"` + + // The rule prototype objects for this policy. + Rules []LoadBalancerListenerPolicyRulePrototype `json:"rules,omitempty"` + + // - If `action` is `forward`, specify a `LoadBalancerPoolIdentity`. + // - If `action` is `redirect`, specify a `LoadBalancerListenerPolicyRedirectURLPrototype`. + // - If `action` is `https_redirect`, specify a + // `LoadBalancerListenerPolicyHTTPSRedirectPrototype`. + Target LoadBalancerListenerPolicyTargetPrototypeIntf `json:"target,omitempty"` +} + +// Constants associated with the LoadBalancerListenerPolicyPrototype.Action property. +// The policy action. +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the policy on which the +// unexpected property value was encountered. +const ( + LoadBalancerListenerPolicyPrototypeActionForwardConst = "forward" + LoadBalancerListenerPolicyPrototypeActionHTTPSRedirectConst = "https_redirect" + LoadBalancerListenerPolicyPrototypeActionRedirectConst = "redirect" + LoadBalancerListenerPolicyPrototypeActionRejectConst = "reject" +) + +// NewLoadBalancerListenerPolicyPrototype : Instantiate LoadBalancerListenerPolicyPrototype (Generic Model Constructor) +func (*VpcV1) NewLoadBalancerListenerPolicyPrototype(action string, priority int64) (_model *LoadBalancerListenerPolicyPrototype, err error) { + _model = &LoadBalancerListenerPolicyPrototype{ + Action: core.StringPtr(action), + Priority: core.Int64Ptr(priority), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalLoadBalancerListenerPolicyPrototype unmarshals an instance of LoadBalancerListenerPolicyPrototype from the specified map of raw messages. +func UnmarshalLoadBalancerListenerPolicyPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerPolicyPrototype) + err = core.UnmarshalPrimitive(m, "action", &obj.Action) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "priority", &obj.Priority) + if err != nil { + return + } + err = core.UnmarshalModel(m, "rules", &obj.Rules, UnmarshalLoadBalancerListenerPolicyRulePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "target", &obj.Target, UnmarshalLoadBalancerListenerPolicyTargetPrototype) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerPolicyReference : LoadBalancerListenerPolicyReference struct +type LoadBalancerListenerPolicyReference struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *LoadBalancerListenerPolicyReferenceDeleted `json:"deleted,omitempty"` + + // The listener policy's canonical URL. + Href *string `json:"href" validate:"required"` + + // The policy's unique identifier. + ID *string `json:"id" validate:"required"` + + Name interface{} `json:"name" validate:"required"` +} + +// UnmarshalLoadBalancerListenerPolicyReference unmarshals an instance of LoadBalancerListenerPolicyReference from the specified map of raw messages. +func UnmarshalLoadBalancerListenerPolicyReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerPolicyReference) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalLoadBalancerListenerPolicyReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerPolicyReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type LoadBalancerListenerPolicyReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalLoadBalancerListenerPolicyReferenceDeleted unmarshals an instance of LoadBalancerListenerPolicyReferenceDeleted from the specified map of raw messages. +func UnmarshalLoadBalancerListenerPolicyReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerPolicyReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerPolicyRule : LoadBalancerListenerPolicyRule struct +type LoadBalancerListenerPolicyRule struct { + // The condition of the rule. + Condition *string `json:"condition" validate:"required"` + + // The date and time that this rule was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The field. This is applicable to `header`, `query`, and `body` rule types. + // + // If the rule type is `header`, this property is required. + // + // If the rule type is `query`, this is optional. If specified and the rule condition is not + // `matches_regex`, the value must be percent-encoded. + // + // If the rule type is `body`, this is optional. + Field *string `json:"field,omitempty"` + + // The rule's canonical URL. + Href *string `json:"href" validate:"required"` + + // The rule's unique identifier. + ID *string `json:"id" validate:"required"` + + // The provisioning status of this rule + // + // The enumerated values for this property are expected to expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the rule on which the + // unexpected property value was encountered. + ProvisioningStatus *string `json:"provisioning_status" validate:"required"` + + // The type of the rule. + // + // Body rules are applied to form-encoded request bodies using the `UTF-8` character set. + Type *string `json:"type" validate:"required"` + + // Value to be matched for rule condition. + // + // If the rule type is `query` and the rule condition is not `matches_regex`, the value must be percent-encoded. + Value *string `json:"value" validate:"required"` +} + +// Constants associated with the LoadBalancerListenerPolicyRule.Condition property. +// The condition of the rule. +const ( + LoadBalancerListenerPolicyRuleConditionContainsConst = "contains" + LoadBalancerListenerPolicyRuleConditionEqualsConst = "equals" + LoadBalancerListenerPolicyRuleConditionMatchesRegexConst = "matches_regex" +) + +// Constants associated with the LoadBalancerListenerPolicyRule.ProvisioningStatus property. +// The provisioning status of this rule +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the rule on which the +// unexpected property value was encountered. +const ( + LoadBalancerListenerPolicyRuleProvisioningStatusActiveConst = "active" + LoadBalancerListenerPolicyRuleProvisioningStatusCreatePendingConst = "create_pending" + LoadBalancerListenerPolicyRuleProvisioningStatusDeletePendingConst = "delete_pending" + LoadBalancerListenerPolicyRuleProvisioningStatusFailedConst = "failed" + LoadBalancerListenerPolicyRuleProvisioningStatusUpdatePendingConst = "update_pending" +) + +// Constants associated with the LoadBalancerListenerPolicyRule.Type property. +// The type of the rule. +// +// Body rules are applied to form-encoded request bodies using the `UTF-8` character set. +const ( + LoadBalancerListenerPolicyRuleTypeBodyConst = "body" + LoadBalancerListenerPolicyRuleTypeHeaderConst = "header" + LoadBalancerListenerPolicyRuleTypeHostnameConst = "hostname" + LoadBalancerListenerPolicyRuleTypePathConst = "path" + LoadBalancerListenerPolicyRuleTypeQueryConst = "query" +) + +// UnmarshalLoadBalancerListenerPolicyRule unmarshals an instance of LoadBalancerListenerPolicyRule from the specified map of raw messages. +func UnmarshalLoadBalancerListenerPolicyRule(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerPolicyRule) + err = core.UnmarshalPrimitive(m, "condition", &obj.Condition) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "field", &obj.Field) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "provisioning_status", &obj.ProvisioningStatus) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerPolicyRuleCollection : LoadBalancerListenerPolicyRuleCollection struct +type LoadBalancerListenerPolicyRuleCollection struct { + // Collection of rules. + Rules []LoadBalancerListenerPolicyRule `json:"rules" validate:"required"` +} + +// UnmarshalLoadBalancerListenerPolicyRuleCollection unmarshals an instance of LoadBalancerListenerPolicyRuleCollection from the specified map of raw messages. +func UnmarshalLoadBalancerListenerPolicyRuleCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerPolicyRuleCollection) + err = core.UnmarshalModel(m, "rules", &obj.Rules, UnmarshalLoadBalancerListenerPolicyRule) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerPolicyRulePatch : LoadBalancerListenerPolicyRulePatch struct +type LoadBalancerListenerPolicyRulePatch struct { + // The condition of the rule. + Condition *string `json:"condition,omitempty"` + + // The field. This is applicable to `header`, `query`, and `body` rule types. + // + // If the rule type is `header`, this property is required. + // + // If the rule type is `query`, this is optional. If specified and the rule condition is not + // `matches_regex`, the value must be percent-encoded. + // + // If the rule type is `body`, this is optional. + Field *string `json:"field,omitempty"` + + // The type of the rule. + // + // Body rules are applied to form-encoded request bodies using the `UTF-8` character set. + Type *string `json:"type,omitempty"` + + // Value to be matched for rule condition. + // + // If the rule type is `query` and the rule condition is not `matches_regex`, the value must be percent-encoded. + Value *string `json:"value,omitempty"` +} + +// Constants associated with the LoadBalancerListenerPolicyRulePatch.Condition property. +// The condition of the rule. +const ( + LoadBalancerListenerPolicyRulePatchConditionContainsConst = "contains" + LoadBalancerListenerPolicyRulePatchConditionEqualsConst = "equals" + LoadBalancerListenerPolicyRulePatchConditionMatchesRegexConst = "matches_regex" +) + +// Constants associated with the LoadBalancerListenerPolicyRulePatch.Type property. +// The type of the rule. +// +// Body rules are applied to form-encoded request bodies using the `UTF-8` character set. +const ( + LoadBalancerListenerPolicyRulePatchTypeBodyConst = "body" + LoadBalancerListenerPolicyRulePatchTypeHeaderConst = "header" + LoadBalancerListenerPolicyRulePatchTypeHostnameConst = "hostname" + LoadBalancerListenerPolicyRulePatchTypePathConst = "path" + LoadBalancerListenerPolicyRulePatchTypeQueryConst = "query" +) + +// UnmarshalLoadBalancerListenerPolicyRulePatch unmarshals an instance of LoadBalancerListenerPolicyRulePatch from the specified map of raw messages. +func UnmarshalLoadBalancerListenerPolicyRulePatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerPolicyRulePatch) + err = core.UnmarshalPrimitive(m, "condition", &obj.Condition) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "field", &obj.Field) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the LoadBalancerListenerPolicyRulePatch +func (loadBalancerListenerPolicyRulePatch *LoadBalancerListenerPolicyRulePatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(loadBalancerListenerPolicyRulePatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// LoadBalancerListenerPolicyRulePrototype : LoadBalancerListenerPolicyRulePrototype struct +type LoadBalancerListenerPolicyRulePrototype struct { + // The condition of the rule. + Condition *string `json:"condition" validate:"required"` + + // The field. This is applicable to `header`, `query`, and `body` rule types. + // + // If the rule type is `header`, this property is required. + // + // If the rule type is `query`, this is optional. If specified and the rule condition is not + // `matches_regex`, the value must be percent-encoded. + // + // If the rule type is `body`, this is optional. + Field *string `json:"field,omitempty"` + + // The type of the rule. + // + // Body rules are applied to form-encoded request bodies using the `UTF-8` character set. + Type *string `json:"type" validate:"required"` + + // Value to be matched for rule condition. + // + // If the rule type is `query` and the rule condition is not `matches_regex`, the value must be percent-encoded. + Value *string `json:"value" validate:"required"` +} + +// Constants associated with the LoadBalancerListenerPolicyRulePrototype.Condition property. +// The condition of the rule. +const ( + LoadBalancerListenerPolicyRulePrototypeConditionContainsConst = "contains" + LoadBalancerListenerPolicyRulePrototypeConditionEqualsConst = "equals" + LoadBalancerListenerPolicyRulePrototypeConditionMatchesRegexConst = "matches_regex" +) + +// Constants associated with the LoadBalancerListenerPolicyRulePrototype.Type property. +// The type of the rule. +// +// Body rules are applied to form-encoded request bodies using the `UTF-8` character set. +const ( + LoadBalancerListenerPolicyRulePrototypeTypeBodyConst = "body" + LoadBalancerListenerPolicyRulePrototypeTypeHeaderConst = "header" + LoadBalancerListenerPolicyRulePrototypeTypeHostnameConst = "hostname" + LoadBalancerListenerPolicyRulePrototypeTypePathConst = "path" + LoadBalancerListenerPolicyRulePrototypeTypeQueryConst = "query" +) + +// NewLoadBalancerListenerPolicyRulePrototype : Instantiate LoadBalancerListenerPolicyRulePrototype (Generic Model Constructor) +func (*VpcV1) NewLoadBalancerListenerPolicyRulePrototype(condition string, typeVar string, value string) (_model *LoadBalancerListenerPolicyRulePrototype, err error) { + _model = &LoadBalancerListenerPolicyRulePrototype{ + Condition: core.StringPtr(condition), + Type: core.StringPtr(typeVar), + Value: core.StringPtr(value), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalLoadBalancerListenerPolicyRulePrototype unmarshals an instance of LoadBalancerListenerPolicyRulePrototype from the specified map of raw messages. +func UnmarshalLoadBalancerListenerPolicyRulePrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerPolicyRulePrototype) + err = core.UnmarshalPrimitive(m, "condition", &obj.Condition) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "field", &obj.Field) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerPolicyRuleReference : LoadBalancerListenerPolicyRuleReference struct +type LoadBalancerListenerPolicyRuleReference struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *LoadBalancerListenerPolicyRuleReferenceDeleted `json:"deleted,omitempty"` + + // The rule's canonical URL. + Href *string `json:"href" validate:"required"` + + // The rule's unique identifier. + ID *string `json:"id" validate:"required"` +} + +// UnmarshalLoadBalancerListenerPolicyRuleReference unmarshals an instance of LoadBalancerListenerPolicyRuleReference from the specified map of raw messages. +func UnmarshalLoadBalancerListenerPolicyRuleReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerPolicyRuleReference) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalLoadBalancerListenerPolicyRuleReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerPolicyRuleReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type LoadBalancerListenerPolicyRuleReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalLoadBalancerListenerPolicyRuleReferenceDeleted unmarshals an instance of LoadBalancerListenerPolicyRuleReferenceDeleted from the specified map of raw messages. +func UnmarshalLoadBalancerListenerPolicyRuleReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerPolicyRuleReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerPolicyTarget : - If `action` is `forward`, the response is a `LoadBalancerPoolReference` +// - If `action` is `redirect`, the response is a `LoadBalancerListenerPolicyRedirectURL` +// - If `action` is `https_redirect`, the response is a `LoadBalancerListenerHTTPSRedirect`. +// Models which "extend" this model: +// - LoadBalancerListenerPolicyTargetLoadBalancerPoolReference +// - LoadBalancerListenerPolicyTargetLoadBalancerListenerPolicyRedirectURL +// - LoadBalancerListenerPolicyTargetLoadBalancerListenerHTTPSRedirect +type LoadBalancerListenerPolicyTarget struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *LoadBalancerPoolReferenceDeleted `json:"deleted,omitempty"` + + // The pool's canonical URL. + Href *string `json:"href,omitempty"` + + // The unique identifier for this load balancer pool. + ID *string `json:"id,omitempty"` + + // The name for this load balancer pool. The name is unique across all pools for the load balancer. + Name *string `json:"name,omitempty"` + + // The HTTP status code for this redirect. + HTTPStatusCode *int64 `json:"http_status_code,omitempty"` + + // The redirect target URL. + URL *string `json:"url,omitempty"` + + Listener *LoadBalancerListenerReference `json:"listener,omitempty"` + + // The redirect relative target URI. + URI *string `json:"uri,omitempty"` +} + +func (*LoadBalancerListenerPolicyTarget) isaLoadBalancerListenerPolicyTarget() bool { + return true +} + +type LoadBalancerListenerPolicyTargetIntf interface { + isaLoadBalancerListenerPolicyTarget() bool +} + +// UnmarshalLoadBalancerListenerPolicyTarget unmarshals an instance of LoadBalancerListenerPolicyTarget from the specified map of raw messages. +func UnmarshalLoadBalancerListenerPolicyTarget(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerPolicyTarget) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalLoadBalancerPoolReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "http_status_code", &obj.HTTPStatusCode) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "url", &obj.URL) + if err != nil { + return + } + err = core.UnmarshalModel(m, "listener", &obj.Listener, UnmarshalLoadBalancerListenerReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "uri", &obj.URI) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerPolicyTargetPatch : - If `action` is `forward`, specify a `LoadBalancerPoolIdentity`. +// - If `action` is `redirect`, specify a `LoadBalancerListenerPolicyRedirectURLPatch`. +// - If `action` is `https_redirect`, specify a +// `LoadBalancerListenerPolicyHTTPSRedirectPatch`. +// +// Models which "extend" this model: +// - LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentity +// - LoadBalancerListenerPolicyTargetPatchLoadBalancerListenerPolicyRedirectURLPatch +// - LoadBalancerListenerPolicyTargetPatchLoadBalancerListenerHTTPSRedirectPatch +type LoadBalancerListenerPolicyTargetPatch struct { + // The unique identifier for this load balancer pool. + ID *string `json:"id,omitempty"` + + // The pool's canonical URL. + Href *string `json:"href,omitempty"` + + // The HTTP status code for this redirect. + HTTPStatusCode *int64 `json:"http_status_code,omitempty"` + + // The redirect target URL. + URL *string `json:"url,omitempty"` + + // Identifies a load balancer listener by a unique property. + Listener LoadBalancerListenerIdentityIntf `json:"listener,omitempty"` + + // The redirect relative target URI. + URI *string `json:"uri,omitempty"` +} + +func (*LoadBalancerListenerPolicyTargetPatch) isaLoadBalancerListenerPolicyTargetPatch() bool { + return true +} + +type LoadBalancerListenerPolicyTargetPatchIntf interface { + isaLoadBalancerListenerPolicyTargetPatch() bool +} + +// UnmarshalLoadBalancerListenerPolicyTargetPatch unmarshals an instance of LoadBalancerListenerPolicyTargetPatch from the specified map of raw messages. +func UnmarshalLoadBalancerListenerPolicyTargetPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerPolicyTargetPatch) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "http_status_code", &obj.HTTPStatusCode) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "url", &obj.URL) + if err != nil { + return + } + err = core.UnmarshalModel(m, "listener", &obj.Listener, UnmarshalLoadBalancerListenerIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "uri", &obj.URI) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerPolicyTargetPrototype : - If `action` is `forward`, specify a `LoadBalancerPoolIdentity`. +// - If `action` is `redirect`, specify a `LoadBalancerListenerPolicyRedirectURLPrototype`. +// - If `action` is `https_redirect`, specify a +// `LoadBalancerListenerPolicyHTTPSRedirectPrototype`. +// +// Models which "extend" this model: +// - LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentity +// - LoadBalancerListenerPolicyTargetPrototypeLoadBalancerListenerPolicyRedirectURLPrototype +// - LoadBalancerListenerPolicyTargetPrototypeLoadBalancerListenerHTTPSRedirectPrototype +type LoadBalancerListenerPolicyTargetPrototype struct { + // The unique identifier for this load balancer pool. + ID *string `json:"id,omitempty"` + + // The pool's canonical URL. + Href *string `json:"href,omitempty"` + + // The HTTP status code for this redirect. + HTTPStatusCode *int64 `json:"http_status_code,omitempty"` + + // The redirect target URL. + URL *string `json:"url,omitempty"` + + // Identifies a load balancer listener by a unique property. + Listener LoadBalancerListenerIdentityIntf `json:"listener,omitempty"` + + // The redirect relative target URI. + URI *string `json:"uri,omitempty"` +} + +func (*LoadBalancerListenerPolicyTargetPrototype) isaLoadBalancerListenerPolicyTargetPrototype() bool { + return true +} + +type LoadBalancerListenerPolicyTargetPrototypeIntf interface { + isaLoadBalancerListenerPolicyTargetPrototype() bool +} + +// UnmarshalLoadBalancerListenerPolicyTargetPrototype unmarshals an instance of LoadBalancerListenerPolicyTargetPrototype from the specified map of raw messages. +func UnmarshalLoadBalancerListenerPolicyTargetPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerPolicyTargetPrototype) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "http_status_code", &obj.HTTPStatusCode) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "url", &obj.URL) + if err != nil { + return + } + err = core.UnmarshalModel(m, "listener", &obj.Listener, UnmarshalLoadBalancerListenerIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "uri", &obj.URI) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerPrototypeLoadBalancerContext : LoadBalancerListenerPrototypeLoadBalancerContext struct +type LoadBalancerListenerPrototypeLoadBalancerContext struct { + // If set to `true`, this listener will accept and forward PROXY protocol information. Supported by load balancers in + // the `application` family (otherwise always `false`). Additional restrictions: + // - If this listener has `https_redirect` specified, its `accept_proxy_protocol` value must + // match the `accept_proxy_protocol` value of the `https_redirect` listener. + // - If this listener is the target of another listener's `https_redirect`, its + // `accept_proxy_protocol` value must match that listener's `accept_proxy_protocol` value. + AcceptProxyProtocol *bool `json:"accept_proxy_protocol,omitempty"` + + // The certificate instance to use for SSL termination. The listener must have a + // `protocol` of `https`. + CertificateInstance CertificateInstanceIdentityIntf `json:"certificate_instance,omitempty"` + + // The connection limit of the listener. + ConnectionLimit *int64 `json:"connection_limit,omitempty"` + + // The default pool for this listener. If specified, the pool must: + // - Belong to this load balancer. + // - Have the same `protocol` as this listener, or have a compatible protocol. + // At present, the compatible protocols are `http` and `https`. + // - Not already be the `default_pool` for another listener. + // + // If unspecified, this listener will be created with no default pool, but one may be + // subsequently set. + DefaultPool *LoadBalancerPoolIdentityByName `json:"default_pool,omitempty"` + + // The target listener that requests will be redirected to. This listener must have a + // `protocol` of `http`, and the target listener must have a `protocol` of `https`. + HTTPSRedirect *LoadBalancerListenerHTTPSRedirectPrototype `json:"https_redirect,omitempty"` + + // The idle connection timeout of the listener in seconds. Supported for load balancers in the `application` family. + IdleConnectionTimeout *int64 `json:"idle_connection_timeout,omitempty"` + + // The listener port number, or the inclusive lower bound of the port range. Each listener in the load balancer must + // have a unique `port` and `protocol` combination. + // + // Not supported for load balancers operating with route mode enabled. + Port *int64 `json:"port,omitempty"` + + // The inclusive upper bound of the range of ports used by this listener. Must not be less than `port_min`. + // + // At present, only load balancers operating with route mode enabled, and public load balancers in the `network` family + // support different values for `port_min` and + // `port_max`. When route mode is enabled, the value `65535` must be specified. + // + // The specified port range must not overlap with port ranges used by other listeners for this load balancer using the + // same protocol. + PortMax *int64 `json:"port_max,omitempty"` + + // The inclusive lower bound of the range of ports used by this listener. Must not be greater than `port_max`. + // + // At present, only load balancers operating with route mode enabled, and public load balancers in the `network` family + // support different values for `port_min` and + // `port_max`. When route mode is enabled, the value `1` must be specified. + // + // The specified port range must not overlap with port ranges used by other listeners for this load balancer using the + // same protocol. + PortMin *int64 `json:"port_min,omitempty"` + + // The listener protocol. Each listener in the load balancer must have a unique `port` and `protocol` combination. + // + // Load balancers in the `network` family support `tcp` and `udp` (if `udp_supported` is `true`). Load balancers in the + // `application` family support `tcp`, `http` and + // `https`. + // + // Additional restrictions: + // - If `default_pool` is set, the pool's protocol must match, or be compatible with + // the listener's protocol. At present, the compatible protocols are `http` and + // `https`. + // - If `https_redirect` is set, the protocol must be `http`. + Protocol *string `json:"protocol" validate:"required"` +} + +// Constants associated with the LoadBalancerListenerPrototypeLoadBalancerContext.Protocol property. +// The listener protocol. Each listener in the load balancer must have a unique `port` and `protocol` combination. +// +// Load balancers in the `network` family support `tcp` and `udp` (if `udp_supported` is `true`). Load balancers in the +// `application` family support `tcp`, `http` and +// `https`. +// +// Additional restrictions: +// - If `default_pool` is set, the pool's protocol must match, or be compatible with +// the listener's protocol. At present, the compatible protocols are `http` and +// `https`. +// - If `https_redirect` is set, the protocol must be `http`. +const ( + LoadBalancerListenerPrototypeLoadBalancerContextProtocolHTTPConst = "http" + LoadBalancerListenerPrototypeLoadBalancerContextProtocolHTTPSConst = "https" + LoadBalancerListenerPrototypeLoadBalancerContextProtocolTCPConst = "tcp" + LoadBalancerListenerPrototypeLoadBalancerContextProtocolUDPConst = "udp" +) + +// NewLoadBalancerListenerPrototypeLoadBalancerContext : Instantiate LoadBalancerListenerPrototypeLoadBalancerContext (Generic Model Constructor) +func (*VpcV1) NewLoadBalancerListenerPrototypeLoadBalancerContext(protocol string) (_model *LoadBalancerListenerPrototypeLoadBalancerContext, err error) { + _model = &LoadBalancerListenerPrototypeLoadBalancerContext{ + Protocol: core.StringPtr(protocol), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalLoadBalancerListenerPrototypeLoadBalancerContext unmarshals an instance of LoadBalancerListenerPrototypeLoadBalancerContext from the specified map of raw messages. +func UnmarshalLoadBalancerListenerPrototypeLoadBalancerContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerPrototypeLoadBalancerContext) + err = core.UnmarshalPrimitive(m, "accept_proxy_protocol", &obj.AcceptProxyProtocol) + if err != nil { + return + } + err = core.UnmarshalModel(m, "certificate_instance", &obj.CertificateInstance, UnmarshalCertificateInstanceIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "connection_limit", &obj.ConnectionLimit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "default_pool", &obj.DefaultPool, UnmarshalLoadBalancerPoolIdentityByName) + if err != nil { + return + } + err = core.UnmarshalModel(m, "https_redirect", &obj.HTTPSRedirect, UnmarshalLoadBalancerListenerHTTPSRedirectPrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "idle_connection_timeout", &obj.IdleConnectionTimeout) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "port", &obj.Port) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "port_max", &obj.PortMax) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "port_min", &obj.PortMin) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "protocol", &obj.Protocol) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerReference : LoadBalancerListenerReference struct +type LoadBalancerListenerReference struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *LoadBalancerListenerReferenceDeleted `json:"deleted,omitempty"` + + // The listener's canonical URL. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this load balancer listener. + ID *string `json:"id" validate:"required"` +} + +// UnmarshalLoadBalancerListenerReference unmarshals an instance of LoadBalancerListenerReference from the specified map of raw messages. +func UnmarshalLoadBalancerListenerReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerReference) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalLoadBalancerListenerReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type LoadBalancerListenerReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalLoadBalancerListenerReferenceDeleted unmarshals an instance of LoadBalancerListenerReferenceDeleted from the specified map of raw messages. +func UnmarshalLoadBalancerListenerReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerLogging : LoadBalancerLogging struct +type LoadBalancerLogging struct { + // The datapath logging configuration for this load balancer. + Datapath *LoadBalancerLoggingDatapath `json:"datapath" validate:"required"` +} + +// UnmarshalLoadBalancerLogging unmarshals an instance of LoadBalancerLogging from the specified map of raw messages. +func UnmarshalLoadBalancerLogging(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerLogging) + err = core.UnmarshalModel(m, "datapath", &obj.Datapath, UnmarshalLoadBalancerLoggingDatapath) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerLoggingDatapath : The datapath logging configuration for this load balancer. +type LoadBalancerLoggingDatapath struct { + // Indicates whether datapath logging is active for this load balancer. + Active *bool `json:"active" validate:"required"` +} + +// UnmarshalLoadBalancerLoggingDatapath unmarshals an instance of LoadBalancerLoggingDatapath from the specified map of raw messages. +func UnmarshalLoadBalancerLoggingDatapath(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerLoggingDatapath) + err = core.UnmarshalPrimitive(m, "active", &obj.Active) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerLoggingDatapathPatch : The datapath logging configuration for this load balancer. +type LoadBalancerLoggingDatapathPatch struct { + // Indicates whether datapath logging will be active for this load balancer. + Active *bool `json:"active,omitempty"` +} + +// UnmarshalLoadBalancerLoggingDatapathPatch unmarshals an instance of LoadBalancerLoggingDatapathPatch from the specified map of raw messages. +func UnmarshalLoadBalancerLoggingDatapathPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerLoggingDatapathPatch) + err = core.UnmarshalPrimitive(m, "active", &obj.Active) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerLoggingDatapathPrototype : The datapath logging configuration for this load balancer. +type LoadBalancerLoggingDatapathPrototype struct { + // Indicates whether datapath logging will be active for this load balancer. + Active *bool `json:"active,omitempty"` +} + +// UnmarshalLoadBalancerLoggingDatapathPrototype unmarshals an instance of LoadBalancerLoggingDatapathPrototype from the specified map of raw messages. +func UnmarshalLoadBalancerLoggingDatapathPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerLoggingDatapathPrototype) + err = core.UnmarshalPrimitive(m, "active", &obj.Active) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerLoggingPatch : LoadBalancerLoggingPatch struct +type LoadBalancerLoggingPatch struct { + // The datapath logging configuration for this load balancer. + Datapath *LoadBalancerLoggingDatapathPatch `json:"datapath,omitempty"` +} + +// UnmarshalLoadBalancerLoggingPatch unmarshals an instance of LoadBalancerLoggingPatch from the specified map of raw messages. +func UnmarshalLoadBalancerLoggingPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerLoggingPatch) + err = core.UnmarshalModel(m, "datapath", &obj.Datapath, UnmarshalLoadBalancerLoggingDatapathPatch) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerLoggingPrototype : LoadBalancerLoggingPrototype struct +type LoadBalancerLoggingPrototype struct { + // The datapath logging configuration for this load balancer. + Datapath *LoadBalancerLoggingDatapathPrototype `json:"datapath,omitempty"` +} + +// UnmarshalLoadBalancerLoggingPrototype unmarshals an instance of LoadBalancerLoggingPrototype from the specified map of raw messages. +func UnmarshalLoadBalancerLoggingPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerLoggingPrototype) + err = core.UnmarshalModel(m, "datapath", &obj.Datapath, UnmarshalLoadBalancerLoggingDatapathPrototype) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerPatch : LoadBalancerPatch struct +type LoadBalancerPatch struct { + // The DNS configuration for this load balancer. + // + // Specify `null` to remove the existing DNS configuration, which will remove all DNS `A` + // records for this load balancer that had been added to `zone`, and add equivalent `A` + // records to the public DNS zone `lb.appdomain.cloud`. + Dns *LoadBalancerDnsPatch `json:"dns,omitempty"` + + // The logging configuration to use for this load balancer. + // + // To activate logging, the load balancer profile must support the specified logging type. + Logging *LoadBalancerLoggingPatch `json:"logging,omitempty"` + + // The name for this load balancer. The name must not be used by another load balancer in the VPC. + Name *string `json:"name,omitempty"` + + // The subnets to provision this load balancer in. The load balancer's availability will depend on the availability of + // the zones that the subnets reside in. + // + // The specified subnets must be in the same VPC as the existing subnets, and will completely replace the existing + // subnets. + // + // The load balancer must be in the `application` family. + Subnets []SubnetIdentityIntf `json:"subnets,omitempty"` +} + +// UnmarshalLoadBalancerPatch unmarshals an instance of LoadBalancerPatch from the specified map of raw messages. +func UnmarshalLoadBalancerPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPatch) + err = core.UnmarshalModel(m, "dns", &obj.Dns, UnmarshalLoadBalancerDnsPatch) + if err != nil { + return + } + err = core.UnmarshalModel(m, "logging", &obj.Logging, UnmarshalLoadBalancerLoggingPatch) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnets", &obj.Subnets, UnmarshalSubnetIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the LoadBalancerPatch +func (loadBalancerPatch *LoadBalancerPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(loadBalancerPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// LoadBalancerPool : LoadBalancerPool struct +type LoadBalancerPool struct { + // The load balancing algorithm. + Algorithm *string `json:"algorithm" validate:"required"` + + // The date and time that this pool was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The health monitor of this pool. + HealthMonitor *LoadBalancerPoolHealthMonitor `json:"health_monitor" validate:"required"` + + // The pool's canonical URL. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this load balancer pool. + ID *string `json:"id" validate:"required"` + + // The instance group that is managing this pool. + InstanceGroup *InstanceGroupReference `json:"instance_group,omitempty"` + + // The backend server members of the pool. + Members []LoadBalancerPoolMemberReference `json:"members,omitempty"` + + // The name for this load balancer pool. The name is unique across all pools for the load balancer. + Name *string `json:"name" validate:"required"` + + // The protocol for this load balancer pool. + // + // The enumerated values for this property are expected to expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the pool on which the + // unexpected property value was encountered. + Protocol *string `json:"protocol" validate:"required"` + + // The provisioning status of this pool + // + // The enumerated values for this property are expected to expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the pool on which the + // unexpected property value was encountered. + ProvisioningStatus *string `json:"provisioning_status" validate:"required"` + + // The PROXY protocol setting for this pool: + // - `v1`: Enabled with version 1 (human-readable header format) + // - `v2`: Enabled with version 2 (binary header format) + // - `disabled`: Disabled + // + // Supported by load balancers in the `application` family (otherwise always `disabled`). + ProxyProtocol *string `json:"proxy_protocol" validate:"required"` + + // The session persistence of this pool. + // + // The enumerated values for this property are expected to expand in the future. When + // processing this property, check for and log unknown values. Optionally halt + // processing and surface the error, or bypass the pool on which the unexpected + // property value was encountered. + SessionPersistence *LoadBalancerPoolSessionPersistence `json:"session_persistence,omitempty"` +} + +// Constants associated with the LoadBalancerPool.Algorithm property. +// The load balancing algorithm. +const ( + LoadBalancerPoolAlgorithmLeastConnectionsConst = "least_connections" + LoadBalancerPoolAlgorithmRoundRobinConst = "round_robin" + LoadBalancerPoolAlgorithmWeightedRoundRobinConst = "weighted_round_robin" +) + +// Constants associated with the LoadBalancerPool.Protocol property. +// The protocol for this load balancer pool. +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the pool on which the +// unexpected property value was encountered. +const ( + LoadBalancerPoolProtocolHTTPConst = "http" + LoadBalancerPoolProtocolHTTPSConst = "https" + LoadBalancerPoolProtocolTCPConst = "tcp" + LoadBalancerPoolProtocolUDPConst = "udp" +) + +// Constants associated with the LoadBalancerPool.ProvisioningStatus property. +// The provisioning status of this pool +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the pool on which the +// unexpected property value was encountered. +const ( + LoadBalancerPoolProvisioningStatusActiveConst = "active" + LoadBalancerPoolProvisioningStatusCreatePendingConst = "create_pending" + LoadBalancerPoolProvisioningStatusDeletePendingConst = "delete_pending" + LoadBalancerPoolProvisioningStatusFailedConst = "failed" + LoadBalancerPoolProvisioningStatusUpdatePendingConst = "update_pending" +) + +// Constants associated with the LoadBalancerPool.ProxyProtocol property. +// The PROXY protocol setting for this pool: +// - `v1`: Enabled with version 1 (human-readable header format) +// - `v2`: Enabled with version 2 (binary header format) +// - `disabled`: Disabled +// +// Supported by load balancers in the `application` family (otherwise always `disabled`). +const ( + LoadBalancerPoolProxyProtocolDisabledConst = "disabled" + LoadBalancerPoolProxyProtocolV1Const = "v1" + LoadBalancerPoolProxyProtocolV2Const = "v2" +) + +// UnmarshalLoadBalancerPool unmarshals an instance of LoadBalancerPool from the specified map of raw messages. +func UnmarshalLoadBalancerPool(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPool) + err = core.UnmarshalPrimitive(m, "algorithm", &obj.Algorithm) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalModel(m, "health_monitor", &obj.HealthMonitor, UnmarshalLoadBalancerPoolHealthMonitor) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalModel(m, "instance_group", &obj.InstanceGroup, UnmarshalInstanceGroupReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "members", &obj.Members, UnmarshalLoadBalancerPoolMemberReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "protocol", &obj.Protocol) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "provisioning_status", &obj.ProvisioningStatus) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "proxy_protocol", &obj.ProxyProtocol) + if err != nil { + return + } + err = core.UnmarshalModel(m, "session_persistence", &obj.SessionPersistence, UnmarshalLoadBalancerPoolSessionPersistence) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerPoolCollection : LoadBalancerPoolCollection struct +type LoadBalancerPoolCollection struct { + // Collection of pools. + Pools []LoadBalancerPool `json:"pools" validate:"required"` +} + +// UnmarshalLoadBalancerPoolCollection unmarshals an instance of LoadBalancerPoolCollection from the specified map of raw messages. +func UnmarshalLoadBalancerPoolCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPoolCollection) + err = core.UnmarshalModel(m, "pools", &obj.Pools, UnmarshalLoadBalancerPool) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerPoolHealthMonitor : LoadBalancerPoolHealthMonitor struct +type LoadBalancerPoolHealthMonitor struct { + // The seconds to wait between health checks. + Delay *int64 `json:"delay" validate:"required"` + + // The health check max retries. + MaxRetries *int64 `json:"max_retries" validate:"required"` + + // The health check port. + // + // If present, this overrides the pool member port values. + Port *int64 `json:"port,omitempty"` + + // The seconds to wait for a response to a health check. + Timeout *int64 `json:"timeout" validate:"required"` + + // The protocol type to use for health checks. + // + // The enumerated values for this property are expected to expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the health monitor on which + // the unexpected property value was encountered. + Type *string `json:"type" validate:"required"` + + // The health check URL path. Applicable when `type` is `http` or `https`. + // + // Must be in the format of an [origin-form request target](https://tools.ietf.org/html/rfc7230#section-5.3.1). + URLPath *string `json:"url_path,omitempty"` +} + +// Constants associated with the LoadBalancerPoolHealthMonitor.Type property. +// The protocol type to use for health checks. +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the health monitor on which +// the unexpected property value was encountered. +const ( + LoadBalancerPoolHealthMonitorTypeHTTPConst = "http" + LoadBalancerPoolHealthMonitorTypeHTTPSConst = "https" + LoadBalancerPoolHealthMonitorTypeTCPConst = "tcp" +) + +// UnmarshalLoadBalancerPoolHealthMonitor unmarshals an instance of LoadBalancerPoolHealthMonitor from the specified map of raw messages. +func UnmarshalLoadBalancerPoolHealthMonitor(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPoolHealthMonitor) + err = core.UnmarshalPrimitive(m, "delay", &obj.Delay) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max_retries", &obj.MaxRetries) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "port", &obj.Port) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "timeout", &obj.Timeout) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "url_path", &obj.URLPath) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerPoolHealthMonitorPatch : LoadBalancerPoolHealthMonitorPatch struct +type LoadBalancerPoolHealthMonitorPatch struct { + // The seconds to wait between health checks. Must be greater than `timeout`. + Delay *int64 `json:"delay" validate:"required"` + + // The health check max retries. + MaxRetries *int64 `json:"max_retries" validate:"required"` + + // The health check port. + // + // If set, this overrides the pool member port values. + // + // Specify `null` to remove an existing health check port. + Port *int64 `json:"port,omitempty"` + + // The seconds to wait for a response to a health check. Must be less than `delay`. + Timeout *int64 `json:"timeout" validate:"required"` + + // The protocol type to use for health checks. + Type *string `json:"type" validate:"required"` + + // The health check URL path. Applicable when `type` is `http` or `https`. + // + // Must be in the format of an [origin-form request target](https://tools.ietf.org/html/rfc7230#section-5.3.1). + URLPath *string `json:"url_path,omitempty"` +} + +// Constants associated with the LoadBalancerPoolHealthMonitorPatch.Type property. +// The protocol type to use for health checks. +const ( + LoadBalancerPoolHealthMonitorPatchTypeHTTPConst = "http" + LoadBalancerPoolHealthMonitorPatchTypeHTTPSConst = "https" + LoadBalancerPoolHealthMonitorPatchTypeTCPConst = "tcp" +) + +// NewLoadBalancerPoolHealthMonitorPatch : Instantiate LoadBalancerPoolHealthMonitorPatch (Generic Model Constructor) +func (*VpcV1) NewLoadBalancerPoolHealthMonitorPatch(delay int64, maxRetries int64, timeout int64, typeVar string) (_model *LoadBalancerPoolHealthMonitorPatch, err error) { + _model = &LoadBalancerPoolHealthMonitorPatch{ + Delay: core.Int64Ptr(delay), + MaxRetries: core.Int64Ptr(maxRetries), + Timeout: core.Int64Ptr(timeout), + Type: core.StringPtr(typeVar), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalLoadBalancerPoolHealthMonitorPatch unmarshals an instance of LoadBalancerPoolHealthMonitorPatch from the specified map of raw messages. +func UnmarshalLoadBalancerPoolHealthMonitorPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPoolHealthMonitorPatch) + err = core.UnmarshalPrimitive(m, "delay", &obj.Delay) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max_retries", &obj.MaxRetries) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "port", &obj.Port) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "timeout", &obj.Timeout) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "url_path", &obj.URLPath) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerPoolHealthMonitorPrototype : LoadBalancerPoolHealthMonitorPrototype struct +type LoadBalancerPoolHealthMonitorPrototype struct { + // The seconds to wait between health checks. Must be greater than `timeout`. + Delay *int64 `json:"delay" validate:"required"` + + // The health check max retries. + MaxRetries *int64 `json:"max_retries" validate:"required"` + + // The health check port. + // + // If specified, this overrides the pool member port values. + Port *int64 `json:"port,omitempty"` + + // The seconds to wait for a response to a health check. Must be less than `delay`. + Timeout *int64 `json:"timeout" validate:"required"` + + // The protocol type to use for health checks. + Type *string `json:"type" validate:"required"` + + // The health check URL path. Applicable when `type` is `http` or `https`. + // + // Must be in the format of an [origin-form request target](https://tools.ietf.org/html/rfc7230#section-5.3.1). + URLPath *string `json:"url_path,omitempty"` +} + +// Constants associated with the LoadBalancerPoolHealthMonitorPrototype.Type property. +// The protocol type to use for health checks. +const ( + LoadBalancerPoolHealthMonitorPrototypeTypeHTTPConst = "http" + LoadBalancerPoolHealthMonitorPrototypeTypeHTTPSConst = "https" + LoadBalancerPoolHealthMonitorPrototypeTypeTCPConst = "tcp" +) + +// NewLoadBalancerPoolHealthMonitorPrototype : Instantiate LoadBalancerPoolHealthMonitorPrototype (Generic Model Constructor) +func (*VpcV1) NewLoadBalancerPoolHealthMonitorPrototype(delay int64, maxRetries int64, timeout int64, typeVar string) (_model *LoadBalancerPoolHealthMonitorPrototype, err error) { + _model = &LoadBalancerPoolHealthMonitorPrototype{ + Delay: core.Int64Ptr(delay), + MaxRetries: core.Int64Ptr(maxRetries), + Timeout: core.Int64Ptr(timeout), + Type: core.StringPtr(typeVar), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalLoadBalancerPoolHealthMonitorPrototype unmarshals an instance of LoadBalancerPoolHealthMonitorPrototype from the specified map of raw messages. +func UnmarshalLoadBalancerPoolHealthMonitorPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPoolHealthMonitorPrototype) + err = core.UnmarshalPrimitive(m, "delay", &obj.Delay) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max_retries", &obj.MaxRetries) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "port", &obj.Port) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "timeout", &obj.Timeout) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "url_path", &obj.URLPath) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerPoolIdentity : Identifies a load balancer pool by a unique property. +// Models which "extend" this model: +// - LoadBalancerPoolIdentityByID +// - LoadBalancerPoolIdentityByHref +type LoadBalancerPoolIdentity struct { + // The unique identifier for this load balancer pool. + ID *string `json:"id,omitempty"` + + // The pool's canonical URL. + Href *string `json:"href,omitempty"` +} + +func (*LoadBalancerPoolIdentity) isaLoadBalancerPoolIdentity() bool { + return true +} + +type LoadBalancerPoolIdentityIntf interface { + isaLoadBalancerPoolIdentity() bool +} + +// UnmarshalLoadBalancerPoolIdentity unmarshals an instance of LoadBalancerPoolIdentity from the specified map of raw messages. +func UnmarshalLoadBalancerPoolIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPoolIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerPoolIdentityByName : LoadBalancerPoolIdentityByName struct +type LoadBalancerPoolIdentityByName struct { + // The name for this load balancer pool. The name is unique across all pools for the load balancer. + Name *string `json:"name" validate:"required"` +} + +// NewLoadBalancerPoolIdentityByName : Instantiate LoadBalancerPoolIdentityByName (Generic Model Constructor) +func (*VpcV1) NewLoadBalancerPoolIdentityByName(name string) (_model *LoadBalancerPoolIdentityByName, err error) { + _model = &LoadBalancerPoolIdentityByName{ + Name: core.StringPtr(name), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalLoadBalancerPoolIdentityByName unmarshals an instance of LoadBalancerPoolIdentityByName from the specified map of raw messages. +func UnmarshalLoadBalancerPoolIdentityByName(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPoolIdentityByName) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerPoolMember : LoadBalancerPoolMember struct +type LoadBalancerPoolMember struct { + // The date and time that this member was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // Health of the server member in the pool. + Health *string `json:"health" validate:"required"` + + // The member's canonical URL. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this load balancer pool member. + ID *string `json:"id" validate:"required"` + + // The port the member will receive load balancer traffic on. Applies only to load balancer traffic received on a + // listener with a single port. (If the traffic is received on a listener with a port range, the member will receive + // the traffic on the same port the listener received it on.) + // + // This port will also be used for health checks unless the `port` property of + // `health_monitor` property is specified. + Port *int64 `json:"port" validate:"required"` + + // The provisioning status of this member + // + // The enumerated values for this property are expected to expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the pool member on which the + // unexpected property value was encountered. + ProvisioningStatus *string `json:"provisioning_status" validate:"required"` + + // The pool member target. Load balancers in the `network` family support virtual server + // instances. Load balancers in the `application` family support IP addresses. If the load + // balancer has route mode enabled, the member must be in a zone the load balancer has a + // subnet in. + Target LoadBalancerPoolMemberTargetIntf `json:"target" validate:"required"` + + // Weight of the server member. Applicable only if the pool algorithm is + // `weighted_round_robin`. + Weight *int64 `json:"weight,omitempty"` +} + +// Constants associated with the LoadBalancerPoolMember.Health property. +// Health of the server member in the pool. +const ( + LoadBalancerPoolMemberHealthFaultedConst = "faulted" + LoadBalancerPoolMemberHealthOkConst = "ok" + LoadBalancerPoolMemberHealthUnknownConst = "unknown" +) + +// Constants associated with the LoadBalancerPoolMember.ProvisioningStatus property. +// The provisioning status of this member +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the pool member on which the +// unexpected property value was encountered. +const ( + LoadBalancerPoolMemberProvisioningStatusActiveConst = "active" + LoadBalancerPoolMemberProvisioningStatusCreatePendingConst = "create_pending" + LoadBalancerPoolMemberProvisioningStatusDeletePendingConst = "delete_pending" + LoadBalancerPoolMemberProvisioningStatusFailedConst = "failed" + LoadBalancerPoolMemberProvisioningStatusUpdatePendingConst = "update_pending" +) + +// UnmarshalLoadBalancerPoolMember unmarshals an instance of LoadBalancerPoolMember from the specified map of raw messages. +func UnmarshalLoadBalancerPoolMember(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPoolMember) + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "health", &obj.Health) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "port", &obj.Port) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "provisioning_status", &obj.ProvisioningStatus) + if err != nil { + return + } + err = core.UnmarshalModel(m, "target", &obj.Target, UnmarshalLoadBalancerPoolMemberTarget) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "weight", &obj.Weight) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerPoolMemberCollection : LoadBalancerPoolMemberCollection struct +type LoadBalancerPoolMemberCollection struct { + // Collection of members. + Members []LoadBalancerPoolMember `json:"members" validate:"required"` +} + +// UnmarshalLoadBalancerPoolMemberCollection unmarshals an instance of LoadBalancerPoolMemberCollection from the specified map of raw messages. +func UnmarshalLoadBalancerPoolMemberCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPoolMemberCollection) + err = core.UnmarshalModel(m, "members", &obj.Members, UnmarshalLoadBalancerPoolMember) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerPoolMemberPatch : LoadBalancerPoolMemberPatch struct +type LoadBalancerPoolMemberPatch struct { + // The port the member will receive load balancer traffic on. Applies only to load balancer traffic received on a + // listener with a single port. (If the traffic is received on a listener with a port range, the member will receive + // the traffic on the same port the listener received it on.) + // + // This port will also be used for health checks unless the `port` property of + // `health_monitor` property is specified. + // + // The port must be unique across all members for all pools associated with this pool's listener. + Port *int64 `json:"port,omitempty"` + + // The pool member target. Load balancers in the `network` family support virtual server + // instances. Load balancers in the `application` family support IP addresses. If the load + // balancer has route mode enabled, the member must be in a zone the load balancer has a + // subnet in. + Target LoadBalancerPoolMemberTargetPrototypeIntf `json:"target,omitempty"` + + // Weight of the server member. Applicable only if the pool algorithm is + // `weighted_round_robin`. + Weight *int64 `json:"weight,omitempty"` +} + +// UnmarshalLoadBalancerPoolMemberPatch unmarshals an instance of LoadBalancerPoolMemberPatch from the specified map of raw messages. +func UnmarshalLoadBalancerPoolMemberPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPoolMemberPatch) + err = core.UnmarshalPrimitive(m, "port", &obj.Port) + if err != nil { + return + } + err = core.UnmarshalModel(m, "target", &obj.Target, UnmarshalLoadBalancerPoolMemberTargetPrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "weight", &obj.Weight) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the LoadBalancerPoolMemberPatch +func (loadBalancerPoolMemberPatch *LoadBalancerPoolMemberPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(loadBalancerPoolMemberPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// LoadBalancerPoolMemberPrototype : LoadBalancerPoolMemberPrototype struct +type LoadBalancerPoolMemberPrototype struct { + // The port the member will receive load balancer traffic on. Applies only to load balancer traffic received on a + // listener with a single port. (If the traffic is received on a listener with a port range, the member will receive + // the traffic on the same port the listener received it on.) + // + // This port will also be used for health checks unless the `port` property of + // `health_monitor` property is specified. + // + // The port must be unique across all members for all pools associated with this pool's listener. + Port *int64 `json:"port" validate:"required"` + + // The pool member target. Load balancers in the `network` family support virtual server + // instances. Load balancers in the `application` family support IP addresses. If the load + // balancer has route mode enabled, the member must be in a zone the load balancer has a + // subnet in. + Target LoadBalancerPoolMemberTargetPrototypeIntf `json:"target" validate:"required"` + + // Weight of the server member. Applicable only if the pool algorithm is + // `weighted_round_robin`. + Weight *int64 `json:"weight,omitempty"` +} + +// NewLoadBalancerPoolMemberPrototype : Instantiate LoadBalancerPoolMemberPrototype (Generic Model Constructor) +func (*VpcV1) NewLoadBalancerPoolMemberPrototype(port int64, target LoadBalancerPoolMemberTargetPrototypeIntf) (_model *LoadBalancerPoolMemberPrototype, err error) { + _model = &LoadBalancerPoolMemberPrototype{ + Port: core.Int64Ptr(port), + Target: target, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalLoadBalancerPoolMemberPrototype unmarshals an instance of LoadBalancerPoolMemberPrototype from the specified map of raw messages. +func UnmarshalLoadBalancerPoolMemberPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPoolMemberPrototype) + err = core.UnmarshalPrimitive(m, "port", &obj.Port) + if err != nil { + return + } + err = core.UnmarshalModel(m, "target", &obj.Target, UnmarshalLoadBalancerPoolMemberTargetPrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "weight", &obj.Weight) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerPoolMemberReference : LoadBalancerPoolMemberReference struct +type LoadBalancerPoolMemberReference struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *LoadBalancerPoolMemberReferenceDeleted `json:"deleted,omitempty"` + + // The member's canonical URL. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this load balancer pool member. + ID *string `json:"id" validate:"required"` +} + +// UnmarshalLoadBalancerPoolMemberReference unmarshals an instance of LoadBalancerPoolMemberReference from the specified map of raw messages. +func UnmarshalLoadBalancerPoolMemberReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPoolMemberReference) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalLoadBalancerPoolMemberReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerPoolMemberReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type LoadBalancerPoolMemberReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalLoadBalancerPoolMemberReferenceDeleted unmarshals an instance of LoadBalancerPoolMemberReferenceDeleted from the specified map of raw messages. +func UnmarshalLoadBalancerPoolMemberReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPoolMemberReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerPoolMemberTarget : The pool member target. Load balancers in the `network` family support virtual server instances. Load balancers in +// the `application` family support IP addresses. If the load balancer has route mode enabled, the member must be in a +// zone the load balancer has a subnet in. +// Models which "extend" this model: +// - LoadBalancerPoolMemberTargetInstanceReference +// - LoadBalancerPoolMemberTargetIP +type LoadBalancerPoolMemberTarget struct { + // The CRN for this virtual server instance. + CRN *string `json:"crn,omitempty"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *InstanceReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this virtual server instance. + Href *string `json:"href,omitempty"` + + // The unique identifier for this virtual server instance. + ID *string `json:"id,omitempty"` + + // The name for this virtual server instance. The name is unique across all virtual server instances in the region. + Name *string `json:"name,omitempty"` + + // The IP address. + // + // This property may add support for IPv6 addresses in the future. When processing a value in this property, verify + // that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the + // error, or bypass the resource on which the unexpected IP address format was encountered. + Address *string `json:"address,omitempty"` +} + +func (*LoadBalancerPoolMemberTarget) isaLoadBalancerPoolMemberTarget() bool { + return true +} + +type LoadBalancerPoolMemberTargetIntf interface { + isaLoadBalancerPoolMemberTarget() bool +} + +// UnmarshalLoadBalancerPoolMemberTarget unmarshals an instance of LoadBalancerPoolMemberTarget from the specified map of raw messages. +func UnmarshalLoadBalancerPoolMemberTarget(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPoolMemberTarget) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalInstanceReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerPoolMemberTargetPrototype : The pool member target. Load balancers in the `network` family support virtual server instances. Load balancers in +// the `application` family support IP addresses. If the load balancer has route mode enabled, the member must be in a +// zone the load balancer has a subnet in. +// Models which "extend" this model: +// - LoadBalancerPoolMemberTargetPrototypeInstanceIdentity +// - LoadBalancerPoolMemberTargetPrototypeIP +type LoadBalancerPoolMemberTargetPrototype struct { + // The unique identifier for this virtual server instance. + ID *string `json:"id,omitempty"` + + // The CRN for this virtual server instance. + CRN *string `json:"crn,omitempty"` + + // The URL for this virtual server instance. + Href *string `json:"href,omitempty"` + + // The IP address. + // + // This property may add support for IPv6 addresses in the future. When processing a value in this property, verify + // that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the + // error, or bypass the resource on which the unexpected IP address format was encountered. + Address *string `json:"address,omitempty"` +} + +func (*LoadBalancerPoolMemberTargetPrototype) isaLoadBalancerPoolMemberTargetPrototype() bool { + return true +} + +type LoadBalancerPoolMemberTargetPrototypeIntf interface { + isaLoadBalancerPoolMemberTargetPrototype() bool +} + +// UnmarshalLoadBalancerPoolMemberTargetPrototype unmarshals an instance of LoadBalancerPoolMemberTargetPrototype from the specified map of raw messages. +func UnmarshalLoadBalancerPoolMemberTargetPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPoolMemberTargetPrototype) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerPoolPatch : LoadBalancerPoolPatch struct +type LoadBalancerPoolPatch struct { + // The load balancing algorithm. + Algorithm *string `json:"algorithm,omitempty"` + + // The health monitor of this pool. + HealthMonitor *LoadBalancerPoolHealthMonitorPatch `json:"health_monitor,omitempty"` + + // The name for this load balancer pool. The name must not be used by another pool for the load balancer. + Name *string `json:"name,omitempty"` + + // The protocol for this load balancer pool. + // + // Load balancers in the `network` family support `tcp` and `udp` (if `udp_supported` is `true`). Load balancers in the + // `application` family support `tcp`, `http` and + // `https`. + // + // If this pool is associated with a load balancer listener, the specified protocol must match, or be compatible with + // the listener's protocol. At present, the compatible protocols are `http` and `https`. + Protocol *string `json:"protocol,omitempty"` + + // The PROXY protocol setting for this pool: + // - `v1`: Enabled with version 1 (human-readable header format) + // - `v2`: Enabled with version 2 (binary header format) + // - `disabled`: Disabled + // + // Supported by load balancers in the `application` family (otherwise always `disabled`). + ProxyProtocol *string `json:"proxy_protocol,omitempty"` + + // The session persistence of this pool. + SessionPersistence *LoadBalancerPoolSessionPersistencePatch `json:"session_persistence,omitempty"` +} + +// Constants associated with the LoadBalancerPoolPatch.Algorithm property. +// The load balancing algorithm. +const ( + LoadBalancerPoolPatchAlgorithmLeastConnectionsConst = "least_connections" + LoadBalancerPoolPatchAlgorithmRoundRobinConst = "round_robin" + LoadBalancerPoolPatchAlgorithmWeightedRoundRobinConst = "weighted_round_robin" +) + +// Constants associated with the LoadBalancerPoolPatch.Protocol property. +// The protocol for this load balancer pool. +// +// Load balancers in the `network` family support `tcp` and `udp` (if `udp_supported` is `true`). Load balancers in the +// `application` family support `tcp`, `http` and +// `https`. +// +// If this pool is associated with a load balancer listener, the specified protocol must match, or be compatible with +// the listener's protocol. At present, the compatible protocols are `http` and `https`. +const ( + LoadBalancerPoolPatchProtocolHTTPConst = "http" + LoadBalancerPoolPatchProtocolHTTPSConst = "https" + LoadBalancerPoolPatchProtocolTCPConst = "tcp" + LoadBalancerPoolPatchProtocolUDPConst = "udp" +) + +// Constants associated with the LoadBalancerPoolPatch.ProxyProtocol property. +// The PROXY protocol setting for this pool: +// - `v1`: Enabled with version 1 (human-readable header format) +// - `v2`: Enabled with version 2 (binary header format) +// - `disabled`: Disabled +// +// Supported by load balancers in the `application` family (otherwise always `disabled`). +const ( + LoadBalancerPoolPatchProxyProtocolDisabledConst = "disabled" + LoadBalancerPoolPatchProxyProtocolV1Const = "v1" + LoadBalancerPoolPatchProxyProtocolV2Const = "v2" +) + +// UnmarshalLoadBalancerPoolPatch unmarshals an instance of LoadBalancerPoolPatch from the specified map of raw messages. +func UnmarshalLoadBalancerPoolPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPoolPatch) + err = core.UnmarshalPrimitive(m, "algorithm", &obj.Algorithm) + if err != nil { + return + } + err = core.UnmarshalModel(m, "health_monitor", &obj.HealthMonitor, UnmarshalLoadBalancerPoolHealthMonitorPatch) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "protocol", &obj.Protocol) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "proxy_protocol", &obj.ProxyProtocol) + if err != nil { + return + } + err = core.UnmarshalModel(m, "session_persistence", &obj.SessionPersistence, UnmarshalLoadBalancerPoolSessionPersistencePatch) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the LoadBalancerPoolPatch +func (loadBalancerPoolPatch *LoadBalancerPoolPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(loadBalancerPoolPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// LoadBalancerPoolPrototype : LoadBalancerPoolPrototype struct +type LoadBalancerPoolPrototype struct { + // The load balancing algorithm. + Algorithm *string `json:"algorithm" validate:"required"` + + // The health monitor of this pool. + HealthMonitor *LoadBalancerPoolHealthMonitorPrototype `json:"health_monitor" validate:"required"` + + // The members for this load balancer pool. For load balancers in the `network` family, the same `port` and `target` + // tuple cannot be shared by a pool member of any other load balancer in the same VPC. + Members []LoadBalancerPoolMemberPrototype `json:"members,omitempty"` + + // The name for this load balancer pool. The name must not be used by another pool for the load balancer. If + // unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The protocol used for this load balancer pool. Load balancers in the `network` family support `tcp` and `udp` (if + // `udp_supported` is `true`). Load balancers in the + // `application` family support `tcp`, `http`, and `https`. + Protocol *string `json:"protocol" validate:"required"` + + // The PROXY protocol setting for this pool: + // - `v1`: Enabled with version 1 (human-readable header format) + // - `v2`: Enabled with version 2 (binary header format) + // - `disabled`: Disabled + // + // Supported by load balancers in the `application` family (otherwise always `disabled`). + ProxyProtocol *string `json:"proxy_protocol,omitempty"` + + // The session persistence of this pool. + SessionPersistence *LoadBalancerPoolSessionPersistencePrototype `json:"session_persistence,omitempty"` +} + +// Constants associated with the LoadBalancerPoolPrototype.Algorithm property. +// The load balancing algorithm. +const ( + LoadBalancerPoolPrototypeAlgorithmLeastConnectionsConst = "least_connections" + LoadBalancerPoolPrototypeAlgorithmRoundRobinConst = "round_robin" + LoadBalancerPoolPrototypeAlgorithmWeightedRoundRobinConst = "weighted_round_robin" +) + +// Constants associated with the LoadBalancerPoolPrototype.Protocol property. +// The protocol used for this load balancer pool. Load balancers in the `network` family support `tcp` and `udp` (if +// `udp_supported` is `true`). Load balancers in the +// `application` family support `tcp`, `http`, and `https`. +const ( + LoadBalancerPoolPrototypeProtocolHTTPConst = "http" + LoadBalancerPoolPrototypeProtocolHTTPSConst = "https" + LoadBalancerPoolPrototypeProtocolTCPConst = "tcp" + LoadBalancerPoolPrototypeProtocolUDPConst = "udp" +) + +// Constants associated with the LoadBalancerPoolPrototype.ProxyProtocol property. +// The PROXY protocol setting for this pool: +// - `v1`: Enabled with version 1 (human-readable header format) +// - `v2`: Enabled with version 2 (binary header format) +// - `disabled`: Disabled +// +// Supported by load balancers in the `application` family (otherwise always `disabled`). +const ( + LoadBalancerPoolPrototypeProxyProtocolDisabledConst = "disabled" + LoadBalancerPoolPrototypeProxyProtocolV1Const = "v1" + LoadBalancerPoolPrototypeProxyProtocolV2Const = "v2" +) + +// NewLoadBalancerPoolPrototype : Instantiate LoadBalancerPoolPrototype (Generic Model Constructor) +func (*VpcV1) NewLoadBalancerPoolPrototype(algorithm string, healthMonitor *LoadBalancerPoolHealthMonitorPrototype, protocol string) (_model *LoadBalancerPoolPrototype, err error) { + _model = &LoadBalancerPoolPrototype{ + Algorithm: core.StringPtr(algorithm), + HealthMonitor: healthMonitor, + Protocol: core.StringPtr(protocol), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalLoadBalancerPoolPrototype unmarshals an instance of LoadBalancerPoolPrototype from the specified map of raw messages. +func UnmarshalLoadBalancerPoolPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPoolPrototype) + err = core.UnmarshalPrimitive(m, "algorithm", &obj.Algorithm) + if err != nil { + return + } + err = core.UnmarshalModel(m, "health_monitor", &obj.HealthMonitor, UnmarshalLoadBalancerPoolHealthMonitorPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "members", &obj.Members, UnmarshalLoadBalancerPoolMemberPrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "protocol", &obj.Protocol) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "proxy_protocol", &obj.ProxyProtocol) + if err != nil { + return + } + err = core.UnmarshalModel(m, "session_persistence", &obj.SessionPersistence, UnmarshalLoadBalancerPoolSessionPersistencePrototype) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerPoolReference : LoadBalancerPoolReference struct +type LoadBalancerPoolReference struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *LoadBalancerPoolReferenceDeleted `json:"deleted,omitempty"` + + // The pool's canonical URL. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this load balancer pool. + ID *string `json:"id" validate:"required"` + + // The name for this load balancer pool. The name is unique across all pools for the load balancer. + Name *string `json:"name" validate:"required"` +} + +// UnmarshalLoadBalancerPoolReference unmarshals an instance of LoadBalancerPoolReference from the specified map of raw messages. +func UnmarshalLoadBalancerPoolReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPoolReference) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalLoadBalancerPoolReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerPoolReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type LoadBalancerPoolReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalLoadBalancerPoolReferenceDeleted unmarshals an instance of LoadBalancerPoolReferenceDeleted from the specified map of raw messages. +func UnmarshalLoadBalancerPoolReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPoolReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerPoolSessionPersistence : LoadBalancerPoolSessionPersistence struct +type LoadBalancerPoolSessionPersistence struct { + // The session persistence cookie name. Applicable only for type `app_cookie`. Names starting with `IBM` are not + // allowed. + CookieName *string `json:"cookie_name,omitempty"` + + // The session persistence type. The `http_cookie` and `app_cookie` types are applicable only to the `http` and `https` + // protocols. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the LoadBalancerPoolSessionPersistence.Type property. +// The session persistence type. The `http_cookie` and `app_cookie` types are applicable only to the `http` and `https` +// protocols. +const ( + LoadBalancerPoolSessionPersistenceTypeAppCookieConst = "app_cookie" + LoadBalancerPoolSessionPersistenceTypeHTTPCookieConst = "http_cookie" + LoadBalancerPoolSessionPersistenceTypeSourceIPConst = "source_ip" +) + +// UnmarshalLoadBalancerPoolSessionPersistence unmarshals an instance of LoadBalancerPoolSessionPersistence from the specified map of raw messages. +func UnmarshalLoadBalancerPoolSessionPersistence(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPoolSessionPersistence) + err = core.UnmarshalPrimitive(m, "cookie_name", &obj.CookieName) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerPoolSessionPersistencePatch : The session persistence configuration. Specify `null` to remove any existing session persistence configuration. +type LoadBalancerPoolSessionPersistencePatch struct { + // The session persistence cookie name. Applicable only for type `app_cookie`. Names starting with `IBM` are not + // allowed. + CookieName *string `json:"cookie_name,omitempty"` + + // The session persistence type. The `http_cookie` and `app_cookie` types are applicable only to the `http` and `https` + // protocols. + Type *string `json:"type,omitempty"` +} + +// Constants associated with the LoadBalancerPoolSessionPersistencePatch.Type property. +// The session persistence type. The `http_cookie` and `app_cookie` types are applicable only to the `http` and `https` +// protocols. +const ( + LoadBalancerPoolSessionPersistencePatchTypeAppCookieConst = "app_cookie" + LoadBalancerPoolSessionPersistencePatchTypeHTTPCookieConst = "http_cookie" + LoadBalancerPoolSessionPersistencePatchTypeSourceIPConst = "source_ip" +) + +// UnmarshalLoadBalancerPoolSessionPersistencePatch unmarshals an instance of LoadBalancerPoolSessionPersistencePatch from the specified map of raw messages. +func UnmarshalLoadBalancerPoolSessionPersistencePatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPoolSessionPersistencePatch) + err = core.UnmarshalPrimitive(m, "cookie_name", &obj.CookieName) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerPoolSessionPersistencePrototype : LoadBalancerPoolSessionPersistencePrototype struct +type LoadBalancerPoolSessionPersistencePrototype struct { + // The session persistence cookie name. Applicable only for type `app_cookie`. Names starting with `IBM` are not + // allowed. + CookieName *string `json:"cookie_name,omitempty"` + + // The session persistence type. The `http_cookie` and `app_cookie` types are applicable only to the `http` and `https` + // protocols. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the LoadBalancerPoolSessionPersistencePrototype.Type property. +// The session persistence type. The `http_cookie` and `app_cookie` types are applicable only to the `http` and `https` +// protocols. +const ( + LoadBalancerPoolSessionPersistencePrototypeTypeAppCookieConst = "app_cookie" + LoadBalancerPoolSessionPersistencePrototypeTypeHTTPCookieConst = "http_cookie" + LoadBalancerPoolSessionPersistencePrototypeTypeSourceIPConst = "source_ip" +) + +// NewLoadBalancerPoolSessionPersistencePrototype : Instantiate LoadBalancerPoolSessionPersistencePrototype (Generic Model Constructor) +func (*VpcV1) NewLoadBalancerPoolSessionPersistencePrototype(typeVar string) (_model *LoadBalancerPoolSessionPersistencePrototype, err error) { + _model = &LoadBalancerPoolSessionPersistencePrototype{ + Type: core.StringPtr(typeVar), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalLoadBalancerPoolSessionPersistencePrototype unmarshals an instance of LoadBalancerPoolSessionPersistencePrototype from the specified map of raw messages. +func UnmarshalLoadBalancerPoolSessionPersistencePrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPoolSessionPersistencePrototype) + err = core.UnmarshalPrimitive(m, "cookie_name", &obj.CookieName) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerPrivateIpsItem : LoadBalancerPrivateIpsItem struct +type LoadBalancerPrivateIpsItem struct { + // The IP address. + // + // If the address has not yet been selected, the value will be `0.0.0.0`. + // + // This property may add support for IPv6 addresses in the future. When processing a value in this property, verify + // that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the + // error, or bypass the resource on which the unexpected IP address format was encountered. + Address *string `json:"address" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *ReservedIPReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this reserved IP. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this reserved IP. + ID *string `json:"id" validate:"required"` + + // The name for this reserved IP. The name is unique across all reserved IPs in a subnet. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the LoadBalancerPrivateIpsItem.ResourceType property. +// The resource type. +const ( + LoadBalancerPrivateIpsItemResourceTypeSubnetReservedIPConst = "subnet_reserved_ip" +) + +// UnmarshalLoadBalancerPrivateIpsItem unmarshals an instance of LoadBalancerPrivateIpsItem from the specified map of raw messages. +func UnmarshalLoadBalancerPrivateIpsItem(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPrivateIpsItem) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalReservedIPReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerProfile : LoadBalancerProfile struct +type LoadBalancerProfile struct { + // The product family this load balancer profile belongs to. + Family *string `json:"family" validate:"required"` + + // The URL for this load balancer profile. + Href *string `json:"href" validate:"required"` + + InstanceGroupsSupported LoadBalancerProfileInstanceGroupsSupportedIntf `json:"instance_groups_supported" validate:"required"` + + // Indicates which logging type(s) are supported for a load balancer with this profile. + LoggingSupported *LoadBalancerProfileLoggingSupported `json:"logging_supported" validate:"required"` + + // The globally unique name for this load balancer profile. + Name *string `json:"name" validate:"required"` + + RouteModeSupported LoadBalancerProfileRouteModeSupportedIntf `json:"route_mode_supported" validate:"required"` + + SecurityGroupsSupported LoadBalancerProfileSecurityGroupsSupportedIntf `json:"security_groups_supported" validate:"required"` + + UDPSupported LoadBalancerProfileUDPSupportedIntf `json:"udp_supported" validate:"required"` +} + +// UnmarshalLoadBalancerProfile unmarshals an instance of LoadBalancerProfile from the specified map of raw messages. +func UnmarshalLoadBalancerProfile(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerProfile) + err = core.UnmarshalPrimitive(m, "family", &obj.Family) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalModel(m, "instance_groups_supported", &obj.InstanceGroupsSupported, UnmarshalLoadBalancerProfileInstanceGroupsSupported) + if err != nil { + return + } + err = core.UnmarshalModel(m, "logging_supported", &obj.LoggingSupported, UnmarshalLoadBalancerProfileLoggingSupported) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "route_mode_supported", &obj.RouteModeSupported, UnmarshalLoadBalancerProfileRouteModeSupported) + if err != nil { + return + } + err = core.UnmarshalModel(m, "security_groups_supported", &obj.SecurityGroupsSupported, UnmarshalLoadBalancerProfileSecurityGroupsSupported) + if err != nil { + return + } + err = core.UnmarshalModel(m, "udp_supported", &obj.UDPSupported, UnmarshalLoadBalancerProfileUDPSupported) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerProfileCollection : LoadBalancerProfileCollection struct +type LoadBalancerProfileCollection struct { + // A link to the first page of resources. + First *LoadBalancerProfileCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *LoadBalancerProfileCollectionNext `json:"next,omitempty"` + + // Collection of load balancer profiles. + Profiles []LoadBalancerProfile `json:"profiles" validate:"required"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalLoadBalancerProfileCollection unmarshals an instance of LoadBalancerProfileCollection from the specified map of raw messages. +func UnmarshalLoadBalancerProfileCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerProfileCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalLoadBalancerProfileCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalLoadBalancerProfileCollectionNext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profiles", &obj.Profiles, UnmarshalLoadBalancerProfile) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *LoadBalancerProfileCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// LoadBalancerProfileCollectionFirst : A link to the first page of resources. +type LoadBalancerProfileCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalLoadBalancerProfileCollectionFirst unmarshals an instance of LoadBalancerProfileCollectionFirst from the specified map of raw messages. +func UnmarshalLoadBalancerProfileCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerProfileCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerProfileCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type LoadBalancerProfileCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalLoadBalancerProfileCollectionNext unmarshals an instance of LoadBalancerProfileCollectionNext from the specified map of raw messages. +func UnmarshalLoadBalancerProfileCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerProfileCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerProfileIdentity : Identifies a load balancer profile by a unique property. +// Models which "extend" this model: +// - LoadBalancerProfileIdentityByName +// - LoadBalancerProfileIdentityByHref +type LoadBalancerProfileIdentity struct { + // The globally unique name for this load balancer profile. + Name *string `json:"name,omitempty"` + + // The URL for this load balancer profile. + Href *string `json:"href,omitempty"` +} + +func (*LoadBalancerProfileIdentity) isaLoadBalancerProfileIdentity() bool { + return true +} + +type LoadBalancerProfileIdentityIntf interface { + isaLoadBalancerProfileIdentity() bool +} + +// UnmarshalLoadBalancerProfileIdentity unmarshals an instance of LoadBalancerProfileIdentity from the specified map of raw messages. +func UnmarshalLoadBalancerProfileIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerProfileIdentity) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerProfileInstanceGroupsSupported : LoadBalancerProfileInstanceGroupsSupported struct +// Models which "extend" this model: +// - LoadBalancerProfileInstanceGroupsSupportedFixed +// - LoadBalancerProfileInstanceGroupsSupportedDependent +type LoadBalancerProfileInstanceGroupsSupported struct { + // The type for this profile field. + Type *string `json:"type,omitempty"` + + // The value for this profile field. + Value *bool `json:"value,omitempty"` +} + +// Constants associated with the LoadBalancerProfileInstanceGroupsSupported.Type property. +// The type for this profile field. +const ( + LoadBalancerProfileInstanceGroupsSupportedTypeFixedConst = "fixed" +) + +func (*LoadBalancerProfileInstanceGroupsSupported) isaLoadBalancerProfileInstanceGroupsSupported() bool { + return true +} + +type LoadBalancerProfileInstanceGroupsSupportedIntf interface { + isaLoadBalancerProfileInstanceGroupsSupported() bool +} + +// UnmarshalLoadBalancerProfileInstanceGroupsSupported unmarshals an instance of LoadBalancerProfileInstanceGroupsSupported from the specified map of raw messages. +func UnmarshalLoadBalancerProfileInstanceGroupsSupported(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerProfileInstanceGroupsSupported) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerProfileLoggingSupported : Indicates which logging type(s) are supported for a load balancer with this profile. +type LoadBalancerProfileLoggingSupported struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The supported logging type(s) for a load balancer with this profile. + Value []string `json:"value" validate:"required"` +} + +// Constants associated with the LoadBalancerProfileLoggingSupported.Type property. +// The type for this profile field. +const ( + LoadBalancerProfileLoggingSupportedTypeFixedConst = "fixed" +) + +// UnmarshalLoadBalancerProfileLoggingSupported unmarshals an instance of LoadBalancerProfileLoggingSupported from the specified map of raw messages. +func UnmarshalLoadBalancerProfileLoggingSupported(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerProfileLoggingSupported) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerProfileReference : LoadBalancerProfileReference struct +type LoadBalancerProfileReference struct { + // The product family this load balancer profile belongs to. + Family *string `json:"family" validate:"required"` + + // The URL for this load balancer profile. + Href *string `json:"href" validate:"required"` + + // The globally unique name for this load balancer profile. + Name *string `json:"name" validate:"required"` +} + +// UnmarshalLoadBalancerProfileReference unmarshals an instance of LoadBalancerProfileReference from the specified map of raw messages. +func UnmarshalLoadBalancerProfileReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerProfileReference) + err = core.UnmarshalPrimitive(m, "family", &obj.Family) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerProfileRouteModeSupported : LoadBalancerProfileRouteModeSupported struct +// Models which "extend" this model: +// - LoadBalancerProfileRouteModeSupportedFixed +// - LoadBalancerProfileRouteModeSupportedDependent +type LoadBalancerProfileRouteModeSupported struct { + // The type for this profile field. + Type *string `json:"type,omitempty"` + + // The value for this profile field. + Value *bool `json:"value,omitempty"` +} + +// Constants associated with the LoadBalancerProfileRouteModeSupported.Type property. +// The type for this profile field. +const ( + LoadBalancerProfileRouteModeSupportedTypeFixedConst = "fixed" +) + +func (*LoadBalancerProfileRouteModeSupported) isaLoadBalancerProfileRouteModeSupported() bool { + return true +} + +type LoadBalancerProfileRouteModeSupportedIntf interface { + isaLoadBalancerProfileRouteModeSupported() bool +} + +// UnmarshalLoadBalancerProfileRouteModeSupported unmarshals an instance of LoadBalancerProfileRouteModeSupported from the specified map of raw messages. +func UnmarshalLoadBalancerProfileRouteModeSupported(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerProfileRouteModeSupported) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerProfileSecurityGroupsSupported : LoadBalancerProfileSecurityGroupsSupported struct +// Models which "extend" this model: +// - LoadBalancerProfileSecurityGroupsSupportedFixed +// - LoadBalancerProfileSecurityGroupsSupportedDependent +type LoadBalancerProfileSecurityGroupsSupported struct { + // The type for this profile field. + Type *string `json:"type,omitempty"` + + // The value for this profile field. + Value *bool `json:"value,omitempty"` +} + +// Constants associated with the LoadBalancerProfileSecurityGroupsSupported.Type property. +// The type for this profile field. +const ( + LoadBalancerProfileSecurityGroupsSupportedTypeFixedConst = "fixed" +) + +func (*LoadBalancerProfileSecurityGroupsSupported) isaLoadBalancerProfileSecurityGroupsSupported() bool { + return true +} + +type LoadBalancerProfileSecurityGroupsSupportedIntf interface { + isaLoadBalancerProfileSecurityGroupsSupported() bool +} + +// UnmarshalLoadBalancerProfileSecurityGroupsSupported unmarshals an instance of LoadBalancerProfileSecurityGroupsSupported from the specified map of raw messages. +func UnmarshalLoadBalancerProfileSecurityGroupsSupported(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerProfileSecurityGroupsSupported) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerProfileUDPSupported : LoadBalancerProfileUDPSupported struct +// Models which "extend" this model: +// - LoadBalancerProfileUDPSupportedFixed +// - LoadBalancerProfileUDPSupportedDependent +type LoadBalancerProfileUDPSupported struct { + // The type for this profile field. + Type *string `json:"type,omitempty"` + + // The value for this profile field. + Value *bool `json:"value,omitempty"` +} + +// Constants associated with the LoadBalancerProfileUDPSupported.Type property. +// The type for this profile field. +const ( + LoadBalancerProfileUDPSupportedTypeFixedConst = "fixed" +) + +func (*LoadBalancerProfileUDPSupported) isaLoadBalancerProfileUDPSupported() bool { + return true +} + +type LoadBalancerProfileUDPSupportedIntf interface { + isaLoadBalancerProfileUDPSupported() bool +} + +// UnmarshalLoadBalancerProfileUDPSupported unmarshals an instance of LoadBalancerProfileUDPSupported from the specified map of raw messages. +func UnmarshalLoadBalancerProfileUDPSupported(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerProfileUDPSupported) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type LoadBalancerReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalLoadBalancerReferenceDeleted unmarshals an instance of LoadBalancerReferenceDeleted from the specified map of raw messages. +func UnmarshalLoadBalancerReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerStatistics : LoadBalancerStatistics struct +type LoadBalancerStatistics struct { + // Number of active connections of this load balancer. + ActiveConnections *int64 `json:"active_connections" validate:"required"` + + // Current connection rate (connections per second) of this load balancer. + ConnectionRate *float32 `json:"connection_rate" validate:"required"` + + // Total number of data processed (bytes) of this load balancer within current calendar month. + DataProcessedThisMonth *int64 `json:"data_processed_this_month" validate:"required"` + + // Current throughput (Mbps) of this load balancer. + Throughput *float32 `json:"throughput" validate:"required"` +} + +// UnmarshalLoadBalancerStatistics unmarshals an instance of LoadBalancerStatistics from the specified map of raw messages. +func UnmarshalLoadBalancerStatistics(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerStatistics) + err = core.UnmarshalPrimitive(m, "active_connections", &obj.ActiveConnections) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "connection_rate", &obj.ConnectionRate) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "data_processed_this_month", &obj.DataProcessedThisMonth) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "throughput", &obj.Throughput) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACL : NetworkACL struct +type NetworkACL struct { + // The date and time that the network ACL was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The CRN for this network ACL. + CRN *string `json:"crn" validate:"required"` + + // The URL for this network ACL. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this network ACL. + ID *string `json:"id" validate:"required"` + + // The name for this network ACL. The name is unique across all network ACLs for the VPC. + Name *string `json:"name" validate:"required"` + + // The resource group for this network ACL. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The ordered rules for this network ACL. If no rules exist, all traffic will be denied. + Rules []NetworkACLRuleItemIntf `json:"rules" validate:"required"` + + // The subnets to which this network ACL is attached. + Subnets []SubnetReference `json:"subnets" validate:"required"` + + // The VPC this network ACL resides in. + VPC *VPCReference `json:"vpc" validate:"required"` +} + +// UnmarshalNetworkACL unmarshals an instance of NetworkACL from the specified map of raw messages. +func UnmarshalNetworkACL(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACL) + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "rules", &obj.Rules, UnmarshalNetworkACLRuleItem) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnets", &obj.Subnets, UnmarshalSubnetReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLCollection : NetworkACLCollection struct +type NetworkACLCollection struct { + // A link to the first page of resources. + First *NetworkACLCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // Collection of network ACLs. + NetworkAcls []NetworkACL `json:"network_acls" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *NetworkACLCollectionNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalNetworkACLCollection unmarshals an instance of NetworkACLCollection from the specified map of raw messages. +func UnmarshalNetworkACLCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalNetworkACLCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "network_acls", &obj.NetworkAcls, UnmarshalNetworkACL) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalNetworkACLCollectionNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *NetworkACLCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// NetworkACLCollectionFirst : A link to the first page of resources. +type NetworkACLCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalNetworkACLCollectionFirst unmarshals an instance of NetworkACLCollectionFirst from the specified map of raw messages. +func UnmarshalNetworkACLCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type NetworkACLCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalNetworkACLCollectionNext unmarshals an instance of NetworkACLCollectionNext from the specified map of raw messages. +func UnmarshalNetworkACLCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLIdentity : Identifies a network ACL by a unique property. +// Models which "extend" this model: +// - NetworkACLIdentityByID +// - NetworkACLIdentityByCRN +// - NetworkACLIdentityByHref +type NetworkACLIdentity struct { + // The unique identifier for this network ACL. + ID *string `json:"id,omitempty"` + + // The CRN for this network ACL. + CRN *string `json:"crn,omitempty"` + + // The URL for this network ACL. + Href *string `json:"href,omitempty"` +} + +func (*NetworkACLIdentity) isaNetworkACLIdentity() bool { + return true +} + +type NetworkACLIdentityIntf interface { + isaNetworkACLIdentity() bool +} + +// UnmarshalNetworkACLIdentity unmarshals an instance of NetworkACLIdentity from the specified map of raw messages. +func UnmarshalNetworkACLIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLPatch : NetworkACLPatch struct +type NetworkACLPatch struct { + // The name for this network ACL. The name must not be used by another network ACL for the VPC. + Name *string `json:"name,omitempty"` +} + +// UnmarshalNetworkACLPatch unmarshals an instance of NetworkACLPatch from the specified map of raw messages. +func UnmarshalNetworkACLPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLPatch) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the NetworkACLPatch +func (networkACLPatch *NetworkACLPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(networkACLPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// NetworkACLPrototype : NetworkACLPrototype struct +// Models which "extend" this model: +// - NetworkACLPrototypeNetworkACLByRules +// - NetworkACLPrototypeNetworkACLBySourceNetworkACL +type NetworkACLPrototype struct { + // The name for this network ACL. The name must not be used by another network ACL for the VPC. If unspecified, the + // name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The VPC this network ACL will reside in. + VPC VPCIdentityIntf `json:"vpc" validate:"required"` + + // The prototype objects for rules to create along with this network ACL. If unspecified, no rules will be created, + // resulting in all traffic being denied. + Rules []NetworkACLRulePrototypeNetworkACLContextIntf `json:"rules,omitempty"` + + // Network ACL to copy rules from. + SourceNetworkACL NetworkACLIdentityIntf `json:"source_network_acl,omitempty"` +} + +func (*NetworkACLPrototype) isaNetworkACLPrototype() bool { + return true +} + +type NetworkACLPrototypeIntf interface { + isaNetworkACLPrototype() bool +} + +// UnmarshalNetworkACLPrototype unmarshals an instance of NetworkACLPrototype from the specified map of raw messages. +func UnmarshalNetworkACLPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLPrototype) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "rules", &obj.Rules, UnmarshalNetworkACLRulePrototypeNetworkACLContext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "source_network_acl", &obj.SourceNetworkACL, UnmarshalNetworkACLIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLReference : NetworkACLReference struct +type NetworkACLReference struct { + // The CRN for this network ACL. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *NetworkACLReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this network ACL. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this network ACL. + ID *string `json:"id" validate:"required"` + + // The name for this network ACL. The name is unique across all network ACLs for the VPC. + Name *string `json:"name" validate:"required"` +} + +// UnmarshalNetworkACLReference unmarshals an instance of NetworkACLReference from the specified map of raw messages. +func UnmarshalNetworkACLReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalNetworkACLReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type NetworkACLReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalNetworkACLReferenceDeleted unmarshals an instance of NetworkACLReferenceDeleted from the specified map of raw messages. +func UnmarshalNetworkACLReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLRule : NetworkACLRule struct +// Models which "extend" this model: +// - NetworkACLRuleNetworkACLRuleProtocolTcpudp +// - NetworkACLRuleNetworkACLRuleProtocolIcmp +// - NetworkACLRuleNetworkACLRuleProtocolAll +type NetworkACLRule struct { + // The action to perform for a packet matching the rule. + Action *string `json:"action" validate:"required"` + + // The rule that this rule is immediately before. If absent, this is the last rule. + Before *NetworkACLRuleReference `json:"before,omitempty"` + + // The date and time that the rule was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The destination IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all destination addresses. + Destination *string `json:"destination" validate:"required"` + + // The direction of traffic to match. + Direction *string `json:"direction" validate:"required"` + + // The URL for this network ACL rule. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this network ACL rule. + ID *string `json:"id" validate:"required"` + + // The IP version for this rule. + IPVersion *string `json:"ip_version" validate:"required"` + + // The name for this network ACL rule. The name is unique across all rules for the network ACL. + Name *string `json:"name" validate:"required"` + + // The protocol to enforce. + Protocol *string `json:"protocol" validate:"required"` + + // The source IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all source addresses. + Source *string `json:"source" validate:"required"` + + // The inclusive upper bound of TCP/UDP destination port range. + DestinationPortMax *int64 `json:"destination_port_max,omitempty"` + + // The inclusive lower bound of TCP/UDP destination port range. + DestinationPortMin *int64 `json:"destination_port_min,omitempty"` + + // The inclusive upper bound of TCP/UDP source port range. + SourcePortMax *int64 `json:"source_port_max,omitempty"` + + // The inclusive lower bound of TCP/UDP source port range. + SourcePortMin *int64 `json:"source_port_min,omitempty"` + + // The ICMP traffic code to match. + // + // If absent, all codes are matched. + Code *int64 `json:"code,omitempty"` + + // The ICMP traffic type to match. + // + // If absent, all types are matched. + Type *int64 `json:"type,omitempty"` +} + +// Constants associated with the NetworkACLRule.Action property. +// The action to perform for a packet matching the rule. +const ( + NetworkACLRuleActionAllowConst = "allow" + NetworkACLRuleActionDenyConst = "deny" +) + +// Constants associated with the NetworkACLRule.Direction property. +// The direction of traffic to match. +const ( + NetworkACLRuleDirectionInboundConst = "inbound" + NetworkACLRuleDirectionOutboundConst = "outbound" +) + +// Constants associated with the NetworkACLRule.IPVersion property. +// The IP version for this rule. +const ( + NetworkACLRuleIPVersionIpv4Const = "ipv4" +) + +// Constants associated with the NetworkACLRule.Protocol property. +// The protocol to enforce. +const ( + NetworkACLRuleProtocolAllConst = "all" + NetworkACLRuleProtocolIcmpConst = "icmp" + NetworkACLRuleProtocolTCPConst = "tcp" + NetworkACLRuleProtocolUDPConst = "udp" +) + +func (*NetworkACLRule) isaNetworkACLRule() bool { + return true +} + +type NetworkACLRuleIntf interface { + isaNetworkACLRule() bool +} + +// UnmarshalNetworkACLRule unmarshals an instance of NetworkACLRule from the specified map of raw messages. +func UnmarshalNetworkACLRule(m map[string]json.RawMessage, result interface{}) (err error) { + // Retrieve discriminator value to determine correct "subclass". + var discValue string + err = core.UnmarshalPrimitive(m, "protocol", &discValue) + if err != nil { + err = fmt.Errorf("error unmarshalling discriminator property 'protocol': %s", err.Error()) + return + } + if discValue == "" { + err = fmt.Errorf("required discriminator property 'protocol' not found in JSON object") + return + } + if discValue == "all" { + err = core.UnmarshalModel(m, "", result, UnmarshalNetworkACLRuleNetworkACLRuleProtocolAll) + } else if discValue == "icmp" { + err = core.UnmarshalModel(m, "", result, UnmarshalNetworkACLRuleNetworkACLRuleProtocolIcmp) + } else if discValue == "tcp" { + err = core.UnmarshalModel(m, "", result, UnmarshalNetworkACLRuleNetworkACLRuleProtocolTcpudp) + } else if discValue == "udp" { + err = core.UnmarshalModel(m, "", result, UnmarshalNetworkACLRuleNetworkACLRuleProtocolTcpudp) + } else { + err = fmt.Errorf("unrecognized value for discriminator property 'protocol': %s", discValue) + } + return +} + +// NetworkACLRuleBeforePatch : The rule to move this rule immediately before. +// +// Specify `null` to move this rule after all existing rules. +// Models which "extend" this model: +// - NetworkACLRuleBeforePatchNetworkACLRuleIdentityByID +// - NetworkACLRuleBeforePatchNetworkACLRuleIdentityByHref +type NetworkACLRuleBeforePatch struct { + // The unique identifier for this network ACL rule. + ID *string `json:"id,omitempty"` + + // The URL for this network ACL rule. + Href *string `json:"href,omitempty"` +} + +func (*NetworkACLRuleBeforePatch) isaNetworkACLRuleBeforePatch() bool { + return true +} + +type NetworkACLRuleBeforePatchIntf interface { + isaNetworkACLRuleBeforePatch() bool +} + +// UnmarshalNetworkACLRuleBeforePatch unmarshals an instance of NetworkACLRuleBeforePatch from the specified map of raw messages. +func UnmarshalNetworkACLRuleBeforePatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLRuleBeforePatch) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLRuleBeforePrototype : The rule to insert this rule immediately before. +// +// If unspecified, this rule will be inserted after all existing rules. +// Models which "extend" this model: +// - NetworkACLRuleBeforePrototypeNetworkACLRuleIdentityByID +// - NetworkACLRuleBeforePrototypeNetworkACLRuleIdentityByHref +type NetworkACLRuleBeforePrototype struct { + // The unique identifier for this network ACL rule. + ID *string `json:"id,omitempty"` + + // The URL for this network ACL rule. + Href *string `json:"href,omitempty"` +} + +func (*NetworkACLRuleBeforePrototype) isaNetworkACLRuleBeforePrototype() bool { + return true +} + +type NetworkACLRuleBeforePrototypeIntf interface { + isaNetworkACLRuleBeforePrototype() bool +} + +// UnmarshalNetworkACLRuleBeforePrototype unmarshals an instance of NetworkACLRuleBeforePrototype from the specified map of raw messages. +func UnmarshalNetworkACLRuleBeforePrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLRuleBeforePrototype) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLRuleCollection : NetworkACLRuleCollection struct +type NetworkACLRuleCollection struct { + // A link to the first page of resources. + First *NetworkACLRuleCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *NetworkACLRuleCollectionNext `json:"next,omitempty"` + + // Ordered collection of network ACL rules. + Rules []NetworkACLRuleItemIntf `json:"rules" validate:"required"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalNetworkACLRuleCollection unmarshals an instance of NetworkACLRuleCollection from the specified map of raw messages. +func UnmarshalNetworkACLRuleCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLRuleCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalNetworkACLRuleCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalNetworkACLRuleCollectionNext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "rules", &obj.Rules, UnmarshalNetworkACLRuleItem) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *NetworkACLRuleCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// NetworkACLRuleCollectionFirst : A link to the first page of resources. +type NetworkACLRuleCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalNetworkACLRuleCollectionFirst unmarshals an instance of NetworkACLRuleCollectionFirst from the specified map of raw messages. +func UnmarshalNetworkACLRuleCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLRuleCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLRuleCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type NetworkACLRuleCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalNetworkACLRuleCollectionNext unmarshals an instance of NetworkACLRuleCollectionNext from the specified map of raw messages. +func UnmarshalNetworkACLRuleCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLRuleCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLRuleItem : NetworkACLRuleItem struct +// Models which "extend" this model: +// - NetworkACLRuleItemNetworkACLRuleProtocolTcpudp +// - NetworkACLRuleItemNetworkACLRuleProtocolIcmp +// - NetworkACLRuleItemNetworkACLRuleProtocolAll +type NetworkACLRuleItem struct { + // The action to perform for a packet matching the rule. + Action *string `json:"action" validate:"required"` + + // The rule that this rule is immediately before. In a rule collection, this always + // refers to the next item in the collection. If absent, this is the last rule. + Before *NetworkACLRuleReference `json:"before,omitempty"` + + // The date and time that the rule was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The destination IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all destination addresses. + Destination *string `json:"destination" validate:"required"` + + // The direction of traffic to match. + Direction *string `json:"direction" validate:"required"` + + // The URL for this network ACL rule. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this network ACL rule. + ID *string `json:"id" validate:"required"` + + // The IP version for this rule. + IPVersion *string `json:"ip_version" validate:"required"` + + // The name for this network ACL rule. The name is unique across all rules for the network ACL. + Name *string `json:"name" validate:"required"` + + // The protocol to enforce. + Protocol *string `json:"protocol" validate:"required"` + + // The source IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all source addresses. + Source *string `json:"source" validate:"required"` + + // The inclusive upper bound of TCP/UDP destination port range. + DestinationPortMax *int64 `json:"destination_port_max,omitempty"` + + // The inclusive lower bound of TCP/UDP destination port range. + DestinationPortMin *int64 `json:"destination_port_min,omitempty"` + + // The inclusive upper bound of TCP/UDP source port range. + SourcePortMax *int64 `json:"source_port_max,omitempty"` + + // The inclusive lower bound of TCP/UDP source port range. + SourcePortMin *int64 `json:"source_port_min,omitempty"` + + // The ICMP traffic code to match. + // + // If absent, all codes are matched. + Code *int64 `json:"code,omitempty"` + + // The ICMP traffic type to match. + // + // If absent, all types are matched. + Type *int64 `json:"type,omitempty"` +} + +// Constants associated with the NetworkACLRuleItem.Action property. +// The action to perform for a packet matching the rule. +const ( + NetworkACLRuleItemActionAllowConst = "allow" + NetworkACLRuleItemActionDenyConst = "deny" +) + +// Constants associated with the NetworkACLRuleItem.Direction property. +// The direction of traffic to match. +const ( + NetworkACLRuleItemDirectionInboundConst = "inbound" + NetworkACLRuleItemDirectionOutboundConst = "outbound" +) + +// Constants associated with the NetworkACLRuleItem.IPVersion property. +// The IP version for this rule. +const ( + NetworkACLRuleItemIPVersionIpv4Const = "ipv4" +) + +// Constants associated with the NetworkACLRuleItem.Protocol property. +// The protocol to enforce. +const ( + NetworkACLRuleItemProtocolAllConst = "all" + NetworkACLRuleItemProtocolIcmpConst = "icmp" + NetworkACLRuleItemProtocolTCPConst = "tcp" + NetworkACLRuleItemProtocolUDPConst = "udp" +) + +func (*NetworkACLRuleItem) isaNetworkACLRuleItem() bool { + return true +} + +type NetworkACLRuleItemIntf interface { + isaNetworkACLRuleItem() bool +} + +// UnmarshalNetworkACLRuleItem unmarshals an instance of NetworkACLRuleItem from the specified map of raw messages. +func UnmarshalNetworkACLRuleItem(m map[string]json.RawMessage, result interface{}) (err error) { + // Retrieve discriminator value to determine correct "subclass". + var discValue string + err = core.UnmarshalPrimitive(m, "protocol", &discValue) + if err != nil { + err = fmt.Errorf("error unmarshalling discriminator property 'protocol': %s", err.Error()) + return + } + if discValue == "" { + err = fmt.Errorf("required discriminator property 'protocol' not found in JSON object") + return + } + if discValue == "all" { + err = core.UnmarshalModel(m, "", result, UnmarshalNetworkACLRuleItemNetworkACLRuleProtocolAll) + } else if discValue == "icmp" { + err = core.UnmarshalModel(m, "", result, UnmarshalNetworkACLRuleItemNetworkACLRuleProtocolIcmp) + } else if discValue == "tcp" { + err = core.UnmarshalModel(m, "", result, UnmarshalNetworkACLRuleItemNetworkACLRuleProtocolTcpudp) + } else if discValue == "udp" { + err = core.UnmarshalModel(m, "", result, UnmarshalNetworkACLRuleItemNetworkACLRuleProtocolTcpudp) + } else { + err = fmt.Errorf("unrecognized value for discriminator property 'protocol': %s", discValue) + } + return +} + +// NetworkACLRulePatch : NetworkACLRulePatch struct +type NetworkACLRulePatch struct { + // The action to perform for a packet matching the rule. + Action *string `json:"action,omitempty"` + + // The rule to move this rule immediately before. + // + // Specify `null` to move this rule after all existing rules. + Before NetworkACLRuleBeforePatchIntf `json:"before,omitempty"` + + // The ICMP traffic code to match. If set, `type` must also be set. + // + // Specify `null` to remove an existing ICMP traffic code. + Code *int64 `json:"code,omitempty"` + + // The destination IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all destination addresses. + Destination *string `json:"destination,omitempty"` + + // The inclusive upper bound of TCP/UDP destination port range. + DestinationPortMax *int64 `json:"destination_port_max,omitempty"` + + // The inclusive lower bound of TCP/UDP destination port range. + DestinationPortMin *int64 `json:"destination_port_min,omitempty"` + + // The direction of traffic to match. + Direction *string `json:"direction,omitempty"` + + // The name for this network ACL rule. The name must not be used by another rule for the network ACL. + Name *string `json:"name,omitempty"` + + // The protocol to enforce. + Protocol *string `json:"protocol,omitempty"` + + // The source IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all source addresses. + Source *string `json:"source,omitempty"` + + // The inclusive upper bound of TCP/UDP source port range. + SourcePortMax *int64 `json:"source_port_max,omitempty"` + + // The inclusive lower bound of TCP/UDP source port range. + SourcePortMin *int64 `json:"source_port_min,omitempty"` + + // The ICMP traffic type to match. + // + // Specify `null` to remove an existing ICMP traffic type value. + Type *int64 `json:"type,omitempty"` +} + +// Constants associated with the NetworkACLRulePatch.Action property. +// The action to perform for a packet matching the rule. +const ( + NetworkACLRulePatchActionAllowConst = "allow" + NetworkACLRulePatchActionDenyConst = "deny" +) + +// Constants associated with the NetworkACLRulePatch.Direction property. +// The direction of traffic to match. +const ( + NetworkACLRulePatchDirectionInboundConst = "inbound" + NetworkACLRulePatchDirectionOutboundConst = "outbound" +) + +// Constants associated with the NetworkACLRulePatch.Protocol property. +// The protocol to enforce. +const ( + NetworkACLRulePatchProtocolAllConst = "all" + NetworkACLRulePatchProtocolIcmpConst = "icmp" + NetworkACLRulePatchProtocolTCPConst = "tcp" + NetworkACLRulePatchProtocolUDPConst = "udp" +) + +// UnmarshalNetworkACLRulePatch unmarshals an instance of NetworkACLRulePatch from the specified map of raw messages. +func UnmarshalNetworkACLRulePatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLRulePatch) + err = core.UnmarshalPrimitive(m, "action", &obj.Action) + if err != nil { + return + } + err = core.UnmarshalModel(m, "before", &obj.Before, UnmarshalNetworkACLRuleBeforePatch) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "code", &obj.Code) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "destination", &obj.Destination) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "destination_port_max", &obj.DestinationPortMax) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "destination_port_min", &obj.DestinationPortMin) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "direction", &obj.Direction) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "protocol", &obj.Protocol) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "source", &obj.Source) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "source_port_max", &obj.SourcePortMax) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "source_port_min", &obj.SourcePortMin) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the NetworkACLRulePatch +func (networkACLRulePatch *NetworkACLRulePatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(networkACLRulePatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// NetworkACLRulePrototype : NetworkACLRulePrototype struct +// Models which "extend" this model: +// - NetworkACLRulePrototypeNetworkACLRuleProtocolTcpudpPrototype +// - NetworkACLRulePrototypeNetworkACLRuleProtocolIcmpPrototype +// - NetworkACLRulePrototypeNetworkACLRuleProtocolAllPrototype +type NetworkACLRulePrototype struct { + // The action to perform for a packet matching the rule. + Action *string `json:"action" validate:"required"` + + // The rule to insert this rule immediately before. + // + // If unspecified, this rule will be inserted after all existing rules. + Before NetworkACLRuleBeforePrototypeIntf `json:"before,omitempty"` + + // The destination IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all destination addresses. + Destination *string `json:"destination" validate:"required"` + + // The direction of traffic to match. + Direction *string `json:"direction" validate:"required"` + + // The IP version for this rule. + IPVersion *string `json:"ip_version,omitempty"` + + // The name for this network ACL rule. The name must not be used by another rule for the network ACL. If unspecified, + // the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The protocol to enforce. + Protocol *string `json:"protocol" validate:"required"` + + // The source IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all source addresses. + Source *string `json:"source" validate:"required"` + + // The inclusive upper bound of TCP/UDP destination port range. + DestinationPortMax *int64 `json:"destination_port_max,omitempty"` + + // The inclusive lower bound of TCP/UDP destination port range. + DestinationPortMin *int64 `json:"destination_port_min,omitempty"` + + // The inclusive upper bound of TCP/UDP source port range. + SourcePortMax *int64 `json:"source_port_max,omitempty"` + + // The inclusive lower bound of TCP/UDP source port range. + SourcePortMin *int64 `json:"source_port_min,omitempty"` + + // The ICMP traffic code to match. + // + // If specified, `type` must also be specified. If unspecified, all codes are matched. + Code *int64 `json:"code,omitempty"` + + // The ICMP traffic type to match. + // + // If unspecified, all types are matched. + Type *int64 `json:"type,omitempty"` +} + +// Constants associated with the NetworkACLRulePrototype.Action property. +// The action to perform for a packet matching the rule. +const ( + NetworkACLRulePrototypeActionAllowConst = "allow" + NetworkACLRulePrototypeActionDenyConst = "deny" +) + +// Constants associated with the NetworkACLRulePrototype.Direction property. +// The direction of traffic to match. +const ( + NetworkACLRulePrototypeDirectionInboundConst = "inbound" + NetworkACLRulePrototypeDirectionOutboundConst = "outbound" +) + +// Constants associated with the NetworkACLRulePrototype.IPVersion property. +// The IP version for this rule. +const ( + NetworkACLRulePrototypeIPVersionIpv4Const = "ipv4" +) + +// Constants associated with the NetworkACLRulePrototype.Protocol property. +// The protocol to enforce. +const ( + NetworkACLRulePrototypeProtocolAllConst = "all" + NetworkACLRulePrototypeProtocolIcmpConst = "icmp" + NetworkACLRulePrototypeProtocolTCPConst = "tcp" + NetworkACLRulePrototypeProtocolUDPConst = "udp" +) + +func (*NetworkACLRulePrototype) isaNetworkACLRulePrototype() bool { + return true +} + +type NetworkACLRulePrototypeIntf interface { + isaNetworkACLRulePrototype() bool +} + +// UnmarshalNetworkACLRulePrototype unmarshals an instance of NetworkACLRulePrototype from the specified map of raw messages. +func UnmarshalNetworkACLRulePrototype(m map[string]json.RawMessage, result interface{}) (err error) { + // Retrieve discriminator value to determine correct "subclass". + var discValue string + err = core.UnmarshalPrimitive(m, "protocol", &discValue) + if err != nil { + err = fmt.Errorf("error unmarshalling discriminator property 'protocol': %s", err.Error()) + return + } + if discValue == "" { + err = fmt.Errorf("required discriminator property 'protocol' not found in JSON object") + return + } + if discValue == "all" { + err = core.UnmarshalModel(m, "", result, UnmarshalNetworkACLRulePrototypeNetworkACLRuleProtocolAllPrototype) + } else if discValue == "icmp" { + err = core.UnmarshalModel(m, "", result, UnmarshalNetworkACLRulePrototypeNetworkACLRuleProtocolIcmpPrototype) + } else if discValue == "tcp" { + err = core.UnmarshalModel(m, "", result, UnmarshalNetworkACLRulePrototypeNetworkACLRuleProtocolTcpudpPrototype) + } else if discValue == "udp" { + err = core.UnmarshalModel(m, "", result, UnmarshalNetworkACLRulePrototypeNetworkACLRuleProtocolTcpudpPrototype) + } else { + err = fmt.Errorf("unrecognized value for discriminator property 'protocol': %s", discValue) + } + return +} + +// NetworkACLRulePrototypeNetworkACLContext : NetworkACLRulePrototypeNetworkACLContext struct +// Models which "extend" this model: +// - NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolTcpudpPrototype +// - NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolIcmpPrototype +// - NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolAllPrototype +type NetworkACLRulePrototypeNetworkACLContext struct { + // The action to perform for a packet matching the rule. + Action *string `json:"action" validate:"required"` + + // The destination IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all destination addresses. + Destination *string `json:"destination" validate:"required"` + + // The direction of traffic to match. + Direction *string `json:"direction" validate:"required"` + + // The IP version for this rule. + IPVersion *string `json:"ip_version,omitempty"` + + // The name for this network ACL rule. The name must not be used by another rule for the network ACL. If unspecified, + // the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The protocol to enforce. + Protocol *string `json:"protocol" validate:"required"` + + // The source IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all source addresses. + Source *string `json:"source" validate:"required"` + + // The inclusive upper bound of TCP/UDP destination port range. + DestinationPortMax *int64 `json:"destination_port_max,omitempty"` + + // The inclusive lower bound of TCP/UDP destination port range. + DestinationPortMin *int64 `json:"destination_port_min,omitempty"` + + // The inclusive upper bound of TCP/UDP source port range. + SourcePortMax *int64 `json:"source_port_max,omitempty"` + + // The inclusive lower bound of TCP/UDP source port range. + SourcePortMin *int64 `json:"source_port_min,omitempty"` + + // The ICMP traffic code to match. + // + // If specified, `type` must also be specified. If unspecified, all codes are matched. + Code *int64 `json:"code,omitempty"` + + // The ICMP traffic type to match. + // + // If unspecified, all types are matched. + Type *int64 `json:"type,omitempty"` +} + +// Constants associated with the NetworkACLRulePrototypeNetworkACLContext.Action property. +// The action to perform for a packet matching the rule. +const ( + NetworkACLRulePrototypeNetworkACLContextActionAllowConst = "allow" + NetworkACLRulePrototypeNetworkACLContextActionDenyConst = "deny" +) + +// Constants associated with the NetworkACLRulePrototypeNetworkACLContext.Direction property. +// The direction of traffic to match. +const ( + NetworkACLRulePrototypeNetworkACLContextDirectionInboundConst = "inbound" + NetworkACLRulePrototypeNetworkACLContextDirectionOutboundConst = "outbound" +) + +// Constants associated with the NetworkACLRulePrototypeNetworkACLContext.IPVersion property. +// The IP version for this rule. +const ( + NetworkACLRulePrototypeNetworkACLContextIPVersionIpv4Const = "ipv4" +) + +// Constants associated with the NetworkACLRulePrototypeNetworkACLContext.Protocol property. +// The protocol to enforce. +const ( + NetworkACLRulePrototypeNetworkACLContextProtocolAllConst = "all" + NetworkACLRulePrototypeNetworkACLContextProtocolIcmpConst = "icmp" + NetworkACLRulePrototypeNetworkACLContextProtocolTCPConst = "tcp" + NetworkACLRulePrototypeNetworkACLContextProtocolUDPConst = "udp" +) + +func (*NetworkACLRulePrototypeNetworkACLContext) isaNetworkACLRulePrototypeNetworkACLContext() bool { + return true +} + +type NetworkACLRulePrototypeNetworkACLContextIntf interface { + isaNetworkACLRulePrototypeNetworkACLContext() bool +} + +// UnmarshalNetworkACLRulePrototypeNetworkACLContext unmarshals an instance of NetworkACLRulePrototypeNetworkACLContext from the specified map of raw messages. +func UnmarshalNetworkACLRulePrototypeNetworkACLContext(m map[string]json.RawMessage, result interface{}) (err error) { + // Retrieve discriminator value to determine correct "subclass". + var discValue string + err = core.UnmarshalPrimitive(m, "protocol", &discValue) + if err != nil { + err = fmt.Errorf("error unmarshalling discriminator property 'protocol': %s", err.Error()) + return + } + if discValue == "" { + err = fmt.Errorf("required discriminator property 'protocol' not found in JSON object") + return + } + if discValue == "all" { + err = core.UnmarshalModel(m, "", result, UnmarshalNetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolAllPrototype) + } else if discValue == "icmp" { + err = core.UnmarshalModel(m, "", result, UnmarshalNetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolIcmpPrototype) + } else if discValue == "tcp" { + err = core.UnmarshalModel(m, "", result, UnmarshalNetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolTcpudpPrototype) + } else if discValue == "udp" { + err = core.UnmarshalModel(m, "", result, UnmarshalNetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolTcpudpPrototype) + } else { + err = fmt.Errorf("unrecognized value for discriminator property 'protocol': %s", discValue) + } + return +} + +// NetworkACLRuleReference : NetworkACLRuleReference struct +type NetworkACLRuleReference struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *NetworkACLRuleReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this network ACL rule. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this network ACL rule. + ID *string `json:"id" validate:"required"` + + // The name for this network ACL rule. The name is unique across all rules for the network ACL. + Name *string `json:"name" validate:"required"` +} + +// UnmarshalNetworkACLRuleReference unmarshals an instance of NetworkACLRuleReference from the specified map of raw messages. +func UnmarshalNetworkACLRuleReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLRuleReference) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalNetworkACLRuleReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLRuleReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type NetworkACLRuleReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalNetworkACLRuleReferenceDeleted unmarshals an instance of NetworkACLRuleReferenceDeleted from the specified map of raw messages. +func UnmarshalNetworkACLRuleReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLRuleReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkInterface : NetworkInterface struct +type NetworkInterface struct { + // Indicates whether source IP spoofing is allowed on this instance interface. + AllowIPSpoofing *bool `json:"allow_ip_spoofing" validate:"required"` + + // The date and time that the instance network interface was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The floating IPs associated with this instance network interface. + FloatingIps []FloatingIPReference `json:"floating_ips" validate:"required"` + + // The URL for this instance network interface. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this instance network interface. + ID *string `json:"id" validate:"required"` + + // The name for this instance network interface. + Name *string `json:"name" validate:"required"` + + // The instance network interface port speed in Mbps. + PortSpeed *int64 `json:"port_speed" validate:"required"` + + PrimaryIP *ReservedIPReference `json:"primary_ip" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The security groups targeting this instance network interface. + SecurityGroups []SecurityGroupReference `json:"security_groups" validate:"required"` + + // The status of the instance network interface. + Status *string `json:"status" validate:"required"` + + // The associated subnet. + Subnet *SubnetReference `json:"subnet" validate:"required"` + + // The instance network interface type. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the NetworkInterface.ResourceType property. +// The resource type. +const ( + NetworkInterfaceResourceTypeNetworkInterfaceConst = "network_interface" +) + +// Constants associated with the NetworkInterface.Status property. +// The status of the instance network interface. +const ( + NetworkInterfaceStatusAvailableConst = "available" + NetworkInterfaceStatusDeletingConst = "deleting" + NetworkInterfaceStatusFailedConst = "failed" + NetworkInterfaceStatusPendingConst = "pending" +) + +// Constants associated with the NetworkInterface.Type property. +// The instance network interface type. +const ( + NetworkInterfaceTypePrimaryConst = "primary" + NetworkInterfaceTypeSecondaryConst = "secondary" +) + +// UnmarshalNetworkInterface unmarshals an instance of NetworkInterface from the specified map of raw messages. +func UnmarshalNetworkInterface(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkInterface) + err = core.UnmarshalPrimitive(m, "allow_ip_spoofing", &obj.AllowIPSpoofing) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalModel(m, "floating_ips", &obj.FloatingIps, UnmarshalFloatingIPReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "port_speed", &obj.PortSpeed) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_ip", &obj.PrimaryIP, UnmarshalReservedIPReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalModel(m, "security_groups", &obj.SecurityGroups, UnmarshalSecurityGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnet", &obj.Subnet, UnmarshalSubnetReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkInterfaceBareMetalServerContextReference : NetworkInterfaceBareMetalServerContextReference struct +type NetworkInterfaceBareMetalServerContextReference struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *NetworkInterfaceBareMetalServerContextReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this bare metal server network interface. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this bare metal server network interface. + ID *string `json:"id" validate:"required"` + + // The name for this bare metal server network interface. + Name *string `json:"name" validate:"required"` + + PrimaryIP *ReservedIPReference `json:"primary_ip" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The associated subnet. + Subnet *SubnetReference `json:"subnet" validate:"required"` +} + +// Constants associated with the NetworkInterfaceBareMetalServerContextReference.ResourceType property. +// The resource type. +const ( + NetworkInterfaceBareMetalServerContextReferenceResourceTypeNetworkInterfaceConst = "network_interface" +) + +// UnmarshalNetworkInterfaceBareMetalServerContextReference unmarshals an instance of NetworkInterfaceBareMetalServerContextReference from the specified map of raw messages. +func UnmarshalNetworkInterfaceBareMetalServerContextReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkInterfaceBareMetalServerContextReference) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalNetworkInterfaceBareMetalServerContextReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_ip", &obj.PrimaryIP, UnmarshalReservedIPReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnet", &obj.Subnet, UnmarshalSubnetReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkInterfaceBareMetalServerContextReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type NetworkInterfaceBareMetalServerContextReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalNetworkInterfaceBareMetalServerContextReferenceDeleted unmarshals an instance of NetworkInterfaceBareMetalServerContextReferenceDeleted from the specified map of raw messages. +func UnmarshalNetworkInterfaceBareMetalServerContextReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkInterfaceBareMetalServerContextReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkInterfaceIPPrototype : NetworkInterfaceIPPrototype struct +// Models which "extend" this model: +// - NetworkInterfaceIPPrototypeReservedIPIdentity +// - NetworkInterfaceIPPrototypeReservedIPPrototypeNetworkInterfaceContext +type NetworkInterfaceIPPrototype struct { + // The unique identifier for this reserved IP. + ID *string `json:"id,omitempty"` + + // The URL for this reserved IP. + Href *string `json:"href,omitempty"` + + // The IP address to reserve, which must not already be reserved on the subnet. + // + // If unspecified, an available address on the subnet will automatically be selected. + Address *string `json:"address,omitempty"` + + // Indicates whether this reserved IP member will be automatically deleted when either + // `target` is deleted, or the reserved IP is unbound. + AutoDelete *bool `json:"auto_delete,omitempty"` + + // The name for this reserved IP. The name must not be used by another reserved IP in the subnet. Names starting with + // `ibm-` are reserved for provider-owned resources, and are not allowed. If unspecified, the name will be a hyphenated + // list of randomly-selected words. + Name *string `json:"name,omitempty"` +} + +func (*NetworkInterfaceIPPrototype) isaNetworkInterfaceIPPrototype() bool { + return true +} + +type NetworkInterfaceIPPrototypeIntf interface { + isaNetworkInterfaceIPPrototype() bool +} + +// UnmarshalNetworkInterfaceIPPrototype unmarshals an instance of NetworkInterfaceIPPrototype from the specified map of raw messages. +func UnmarshalNetworkInterfaceIPPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkInterfaceIPPrototype) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "auto_delete", &obj.AutoDelete) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkInterfaceInstanceContextReference : NetworkInterfaceInstanceContextReference struct +type NetworkInterfaceInstanceContextReference struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *NetworkInterfaceInstanceContextReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this instance network interface. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this instance network interface. + ID *string `json:"id" validate:"required"` + + // The name for this instance network interface. + Name *string `json:"name" validate:"required"` + + PrimaryIP *ReservedIPReference `json:"primary_ip" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The associated subnet. + Subnet *SubnetReference `json:"subnet" validate:"required"` +} + +// Constants associated with the NetworkInterfaceInstanceContextReference.ResourceType property. +// The resource type. +const ( + NetworkInterfaceInstanceContextReferenceResourceTypeNetworkInterfaceConst = "network_interface" +) + +// UnmarshalNetworkInterfaceInstanceContextReference unmarshals an instance of NetworkInterfaceInstanceContextReference from the specified map of raw messages. +func UnmarshalNetworkInterfaceInstanceContextReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkInterfaceInstanceContextReference) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalNetworkInterfaceInstanceContextReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_ip", &obj.PrimaryIP, UnmarshalReservedIPReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnet", &obj.Subnet, UnmarshalSubnetReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkInterfaceInstanceContextReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type NetworkInterfaceInstanceContextReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalNetworkInterfaceInstanceContextReferenceDeleted unmarshals an instance of NetworkInterfaceInstanceContextReferenceDeleted from the specified map of raw messages. +func UnmarshalNetworkInterfaceInstanceContextReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkInterfaceInstanceContextReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkInterfacePatch : NetworkInterfacePatch struct +type NetworkInterfacePatch struct { + // Indicates whether source IP spoofing is allowed on this instance interface. + AllowIPSpoofing *bool `json:"allow_ip_spoofing,omitempty"` + + // The name for the instance network interface. The name must not be used by another network interface on the virtual + // server instance. + Name *string `json:"name,omitempty"` +} + +// UnmarshalNetworkInterfacePatch unmarshals an instance of NetworkInterfacePatch from the specified map of raw messages. +func UnmarshalNetworkInterfacePatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkInterfacePatch) + err = core.UnmarshalPrimitive(m, "allow_ip_spoofing", &obj.AllowIPSpoofing) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the NetworkInterfacePatch +func (networkInterfacePatch *NetworkInterfacePatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(networkInterfacePatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// NetworkInterfacePrototype : NetworkInterfacePrototype struct +type NetworkInterfacePrototype struct { + // Indicates whether source IP spoofing is allowed on this instance interface. + AllowIPSpoofing *bool `json:"allow_ip_spoofing,omitempty"` + + // The name for the instance network interface. The name must not be used by another network interface on the virtual + // server instance. If unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The primary IP address to bind to the instance network interface. This can be + // specified using an existing reserved IP, or a prototype object for a new reserved IP. + // + // If an existing reserved IP or a prototype object with an address is specified, it must + // be available on the instance network interface's subnet. Otherwise, an + // available address on the subnet will be automatically selected and reserved. + PrimaryIP NetworkInterfaceIPPrototypeIntf `json:"primary_ip,omitempty"` + + // The security groups to use for this instance network interface. If unspecified, the VPC's default security group is + // used. + SecurityGroups []SecurityGroupIdentityIntf `json:"security_groups,omitempty"` + + // The associated subnet. + Subnet SubnetIdentityIntf `json:"subnet" validate:"required"` +} + +// NewNetworkInterfacePrototype : Instantiate NetworkInterfacePrototype (Generic Model Constructor) +func (*VpcV1) NewNetworkInterfacePrototype(subnet SubnetIdentityIntf) (_model *NetworkInterfacePrototype, err error) { + _model = &NetworkInterfacePrototype{ + Subnet: subnet, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalNetworkInterfacePrototype unmarshals an instance of NetworkInterfacePrototype from the specified map of raw messages. +func UnmarshalNetworkInterfacePrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkInterfacePrototype) + err = core.UnmarshalPrimitive(m, "allow_ip_spoofing", &obj.AllowIPSpoofing) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_ip", &obj.PrimaryIP, UnmarshalNetworkInterfaceIPPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "security_groups", &obj.SecurityGroups, UnmarshalSecurityGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnet", &obj.Subnet, UnmarshalSubnetIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkInterfaceReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type NetworkInterfaceReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalNetworkInterfaceReferenceDeleted unmarshals an instance of NetworkInterfaceReferenceDeleted from the specified map of raw messages. +func UnmarshalNetworkInterfaceReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkInterfaceReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkInterfaceReferenceTargetContextDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type NetworkInterfaceReferenceTargetContextDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalNetworkInterfaceReferenceTargetContextDeleted unmarshals an instance of NetworkInterfaceReferenceTargetContextDeleted from the specified map of raw messages. +func UnmarshalNetworkInterfaceReferenceTargetContextDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkInterfaceReferenceTargetContextDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkInterfaceUnpaginatedCollection : NetworkInterfaceUnpaginatedCollection struct +type NetworkInterfaceUnpaginatedCollection struct { + // Collection of instance network interfaces. + NetworkInterfaces []NetworkInterface `json:"network_interfaces" validate:"required"` +} + +// UnmarshalNetworkInterfaceUnpaginatedCollection unmarshals an instance of NetworkInterfaceUnpaginatedCollection from the specified map of raw messages. +func UnmarshalNetworkInterfaceUnpaginatedCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkInterfaceUnpaginatedCollection) + err = core.UnmarshalModel(m, "network_interfaces", &obj.NetworkInterfaces, UnmarshalNetworkInterface) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ObsoleteImageOptions : The ObsoleteImage options. +type ObsoleteImageOptions struct { + // The image identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewObsoleteImageOptions : Instantiate ObsoleteImageOptions +func (*VpcV1) NewObsoleteImageOptions(id string) *ObsoleteImageOptions { + return &ObsoleteImageOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *ObsoleteImageOptions) SetID(id string) *ObsoleteImageOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ObsoleteImageOptions) SetHeaders(param map[string]string) *ObsoleteImageOptions { + options.Headers = param + return options +} + +// OperatingSystem : OperatingSystem struct +type OperatingSystem struct { + // The operating system architecture. + Architecture *string `json:"architecture" validate:"required"` + + // Images with this operating system can only be used on dedicated hosts or dedicated host groups. + DedicatedHostOnly *bool `json:"dedicated_host_only" validate:"required"` + + // A unique, display-friendly name for the operating system. + DisplayName *string `json:"display_name" validate:"required"` + + // The software family for this operating system. + Family *string `json:"family" validate:"required"` + + // The URL for this operating system. + Href *string `json:"href" validate:"required"` + + // The globally unique name for this operating system. + Name *string `json:"name" validate:"required"` + + // The vendor of the operating system. + Vendor *string `json:"vendor" validate:"required"` + + // The major release version of this operating system. + Version *string `json:"version" validate:"required"` +} + +// UnmarshalOperatingSystem unmarshals an instance of OperatingSystem from the specified map of raw messages. +func UnmarshalOperatingSystem(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(OperatingSystem) + err = core.UnmarshalPrimitive(m, "architecture", &obj.Architecture) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "dedicated_host_only", &obj.DedicatedHostOnly) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "display_name", &obj.DisplayName) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "family", &obj.Family) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "vendor", &obj.Vendor) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "version", &obj.Version) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// OperatingSystemCollection : OperatingSystemCollection struct +type OperatingSystemCollection struct { + // A link to the first page of resources. + First *OperatingSystemCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *OperatingSystemCollectionNext `json:"next,omitempty"` + + // Collection of operating systems. + OperatingSystems []OperatingSystem `json:"operating_systems" validate:"required"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalOperatingSystemCollection unmarshals an instance of OperatingSystemCollection from the specified map of raw messages. +func UnmarshalOperatingSystemCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(OperatingSystemCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalOperatingSystemCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalOperatingSystemCollectionNext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "operating_systems", &obj.OperatingSystems, UnmarshalOperatingSystem) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *OperatingSystemCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// OperatingSystemCollectionFirst : A link to the first page of resources. +type OperatingSystemCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalOperatingSystemCollectionFirst unmarshals an instance of OperatingSystemCollectionFirst from the specified map of raw messages. +func UnmarshalOperatingSystemCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(OperatingSystemCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// OperatingSystemCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type OperatingSystemCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalOperatingSystemCollectionNext unmarshals an instance of OperatingSystemCollectionNext from the specified map of raw messages. +func UnmarshalOperatingSystemCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(OperatingSystemCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// OperatingSystemIdentity : Identifies an operating system by a unique property. +// Models which "extend" this model: +// - OperatingSystemIdentityByName +// - OperatingSystemIdentityByHref +type OperatingSystemIdentity struct { + // The globally unique name for this operating system. + Name *string `json:"name,omitempty"` + + // The URL for this operating system. + Href *string `json:"href,omitempty"` +} + +func (*OperatingSystemIdentity) isaOperatingSystemIdentity() bool { + return true +} + +type OperatingSystemIdentityIntf interface { + isaOperatingSystemIdentity() bool +} + +// UnmarshalOperatingSystemIdentity unmarshals an instance of OperatingSystemIdentity from the specified map of raw messages. +func UnmarshalOperatingSystemIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(OperatingSystemIdentity) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// PlacementGroup : PlacementGroup struct +type PlacementGroup struct { + // The date and time that the placement group was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The CRN for this placement group. + CRN *string `json:"crn" validate:"required"` + + // The URL for this placement group. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this placement group. + ID *string `json:"id" validate:"required"` + + // The lifecycle state of the placement group. + LifecycleState *string `json:"lifecycle_state" validate:"required"` + + // The name for this placement group. The name is unique across all placement groups in the region. + Name *string `json:"name" validate:"required"` + + // The resource group for this placement group. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The strategy for this placement group + // - `host_spread`: place on different compute hosts + // - `power_spread`: place on compute hosts that use different power sources + // + // The enumerated values for this property may expand in the future. When processing this property, check for and log + // unknown values. Optionally halt processing and surface the error, or bypass the placement group on which the + // unexpected strategy was encountered. + Strategy *string `json:"strategy" validate:"required"` +} + +// Constants associated with the PlacementGroup.LifecycleState property. +// The lifecycle state of the placement group. +const ( + PlacementGroupLifecycleStateDeletingConst = "deleting" + PlacementGroupLifecycleStateFailedConst = "failed" + PlacementGroupLifecycleStatePendingConst = "pending" + PlacementGroupLifecycleStateStableConst = "stable" + PlacementGroupLifecycleStateSuspendedConst = "suspended" + PlacementGroupLifecycleStateUpdatingConst = "updating" + PlacementGroupLifecycleStateWaitingConst = "waiting" +) + +// Constants associated with the PlacementGroup.ResourceType property. +// The resource type. +const ( + PlacementGroupResourceTypePlacementGroupConst = "placement_group" +) + +// Constants associated with the PlacementGroup.Strategy property. +// The strategy for this placement group +// - `host_spread`: place on different compute hosts +// - `power_spread`: place on compute hosts that use different power sources +// +// The enumerated values for this property may expand in the future. When processing this property, check for and log +// unknown values. Optionally halt processing and surface the error, or bypass the placement group on which the +// unexpected strategy was encountered. +const ( + PlacementGroupStrategyHostSpreadConst = "host_spread" + PlacementGroupStrategyPowerSpreadConst = "power_spread" +) + +// UnmarshalPlacementGroup unmarshals an instance of PlacementGroup from the specified map of raw messages. +func UnmarshalPlacementGroup(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(PlacementGroup) + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "lifecycle_state", &obj.LifecycleState) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "strategy", &obj.Strategy) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// PlacementGroupCollection : PlacementGroupCollection struct +type PlacementGroupCollection struct { + // A link to the first page of resources. + First *PlacementGroupCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *PlacementGroupCollectionNext `json:"next,omitempty"` + + // Collection of placement groups. + PlacementGroups []PlacementGroup `json:"placement_groups" validate:"required"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalPlacementGroupCollection unmarshals an instance of PlacementGroupCollection from the specified map of raw messages. +func UnmarshalPlacementGroupCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(PlacementGroupCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalPlacementGroupCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalPlacementGroupCollectionNext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "placement_groups", &obj.PlacementGroups, UnmarshalPlacementGroup) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *PlacementGroupCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// PlacementGroupCollectionFirst : A link to the first page of resources. +type PlacementGroupCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalPlacementGroupCollectionFirst unmarshals an instance of PlacementGroupCollectionFirst from the specified map of raw messages. +func UnmarshalPlacementGroupCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(PlacementGroupCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// PlacementGroupCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type PlacementGroupCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalPlacementGroupCollectionNext unmarshals an instance of PlacementGroupCollectionNext from the specified map of raw messages. +func UnmarshalPlacementGroupCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(PlacementGroupCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// PlacementGroupPatch : PlacementGroupPatch struct +type PlacementGroupPatch struct { + // The name for this placement group. The name must not be used by another placement group in the region. + Name *string `json:"name,omitempty"` +} + +// UnmarshalPlacementGroupPatch unmarshals an instance of PlacementGroupPatch from the specified map of raw messages. +func UnmarshalPlacementGroupPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(PlacementGroupPatch) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the PlacementGroupPatch +func (placementGroupPatch *PlacementGroupPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(placementGroupPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// PlacementGroupReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type PlacementGroupReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalPlacementGroupReferenceDeleted unmarshals an instance of PlacementGroupReferenceDeleted from the specified map of raw messages. +func UnmarshalPlacementGroupReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(PlacementGroupReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// PublicGateway : PublicGateway struct +type PublicGateway struct { + // The date and time that the public gateway was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The CRN for this public gateway. + CRN *string `json:"crn" validate:"required"` + + // The floating IP bound to this public gateway. + FloatingIP *PublicGatewayFloatingIP `json:"floating_ip" validate:"required"` + + // The URL for this public gateway. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this public gateway. + ID *string `json:"id" validate:"required"` + + // The name for this public gateway. The name is unique across all public gateways in the VPC. + Name *string `json:"name" validate:"required"` + + // The resource group for this public gateway. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The status of this public gateway. + Status *string `json:"status" validate:"required"` + + // The VPC this public gateway resides in. + VPC *VPCReference `json:"vpc" validate:"required"` + + // The zone this public gateway resides in. + Zone *ZoneReference `json:"zone" validate:"required"` +} + +// Constants associated with the PublicGateway.ResourceType property. +// The resource type. +const ( + PublicGatewayResourceTypePublicGatewayConst = "public_gateway" +) + +// Constants associated with the PublicGateway.Status property. +// The status of this public gateway. +const ( + PublicGatewayStatusAvailableConst = "available" + PublicGatewayStatusDeletingConst = "deleting" + PublicGatewayStatusFailedConst = "failed" + PublicGatewayStatusPendingConst = "pending" +) + +// UnmarshalPublicGateway unmarshals an instance of PublicGateway from the specified map of raw messages. +func UnmarshalPublicGateway(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(PublicGateway) + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "floating_ip", &obj.FloatingIP, UnmarshalPublicGatewayFloatingIP) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// PublicGatewayCollection : PublicGatewayCollection struct +type PublicGatewayCollection struct { + // A link to the first page of resources. + First *PublicGatewayCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *PublicGatewayCollectionNext `json:"next,omitempty"` + + // Collection of public gateways. + PublicGateways []PublicGateway `json:"public_gateways" validate:"required"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalPublicGatewayCollection unmarshals an instance of PublicGatewayCollection from the specified map of raw messages. +func UnmarshalPublicGatewayCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(PublicGatewayCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalPublicGatewayCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalPublicGatewayCollectionNext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "public_gateways", &obj.PublicGateways, UnmarshalPublicGateway) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *PublicGatewayCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// PublicGatewayCollectionFirst : A link to the first page of resources. +type PublicGatewayCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalPublicGatewayCollectionFirst unmarshals an instance of PublicGatewayCollectionFirst from the specified map of raw messages. +func UnmarshalPublicGatewayCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(PublicGatewayCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// PublicGatewayCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type PublicGatewayCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalPublicGatewayCollectionNext unmarshals an instance of PublicGatewayCollectionNext from the specified map of raw messages. +func UnmarshalPublicGatewayCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(PublicGatewayCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// PublicGatewayFloatingIP : The floating IP bound to this public gateway. +type PublicGatewayFloatingIP struct { + // The globally unique IP address. + Address *string `json:"address" validate:"required"` + + // The CRN for this floating IP. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *FloatingIPReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this floating IP. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this floating IP. + ID *string `json:"id" validate:"required"` + + // The name for this floating IP. The name is unique across all floating IPs in the region. + Name *string `json:"name" validate:"required"` +} + +// UnmarshalPublicGatewayFloatingIP unmarshals an instance of PublicGatewayFloatingIP from the specified map of raw messages. +func UnmarshalPublicGatewayFloatingIP(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(PublicGatewayFloatingIP) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalFloatingIPReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// PublicGatewayFloatingIPPrototype : PublicGatewayFloatingIPPrototype struct +// Models which "extend" this model: +// - PublicGatewayFloatingIPPrototypeFloatingIPIdentity +// - PublicGatewayFloatingIPPrototypeFloatingIPPrototypeTargetContext +type PublicGatewayFloatingIPPrototype struct { + // The unique identifier for this floating IP. + ID *string `json:"id,omitempty"` + + // The CRN for this floating IP. + CRN *string `json:"crn,omitempty"` + + // The URL for this floating IP. + Href *string `json:"href,omitempty"` + + // The globally unique IP address. + Address *string `json:"address,omitempty"` + + // The name for this floating IP. The name must not be used by another floating IP in the region. If unspecified, the + // name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` +} + +func (*PublicGatewayFloatingIPPrototype) isaPublicGatewayFloatingIPPrototype() bool { + return true +} + +type PublicGatewayFloatingIPPrototypeIntf interface { + isaPublicGatewayFloatingIPPrototype() bool +} + +// UnmarshalPublicGatewayFloatingIPPrototype unmarshals an instance of PublicGatewayFloatingIPPrototype from the specified map of raw messages. +func UnmarshalPublicGatewayFloatingIPPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(PublicGatewayFloatingIPPrototype) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// PublicGatewayIdentity : Identifies a public gateway by a unique property. +// Models which "extend" this model: +// - PublicGatewayIdentityPublicGatewayIdentityByID +// - PublicGatewayIdentityPublicGatewayIdentityByCRN +// - PublicGatewayIdentityPublicGatewayIdentityByHref +type PublicGatewayIdentity struct { + // The unique identifier for this public gateway. + ID *string `json:"id,omitempty"` + + // The CRN for this public gateway. + CRN *string `json:"crn,omitempty"` + + // The URL for this public gateway. + Href *string `json:"href,omitempty"` +} + +func (*PublicGatewayIdentity) isaPublicGatewayIdentity() bool { + return true +} + +type PublicGatewayIdentityIntf interface { + isaPublicGatewayIdentity() bool +} + +// UnmarshalPublicGatewayIdentity unmarshals an instance of PublicGatewayIdentity from the specified map of raw messages. +func UnmarshalPublicGatewayIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(PublicGatewayIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// PublicGatewayPatch : PublicGatewayPatch struct +type PublicGatewayPatch struct { + // The name for this public gateway. The name must not be used by another public gateway in the VPC. + Name *string `json:"name,omitempty"` +} + +// UnmarshalPublicGatewayPatch unmarshals an instance of PublicGatewayPatch from the specified map of raw messages. +func UnmarshalPublicGatewayPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(PublicGatewayPatch) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the PublicGatewayPatch +func (publicGatewayPatch *PublicGatewayPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(publicGatewayPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// PublicGatewayReference : PublicGatewayReference struct +type PublicGatewayReference struct { + // The CRN for this public gateway. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *PublicGatewayReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this public gateway. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this public gateway. + ID *string `json:"id" validate:"required"` + + // The name for this public gateway. The name is unique across all public gateways in the VPC. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the PublicGatewayReference.ResourceType property. +// The resource type. +const ( + PublicGatewayReferenceResourceTypePublicGatewayConst = "public_gateway" +) + +// UnmarshalPublicGatewayReference unmarshals an instance of PublicGatewayReference from the specified map of raw messages. +func UnmarshalPublicGatewayReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(PublicGatewayReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalPublicGatewayReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// PublicGatewayReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type PublicGatewayReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalPublicGatewayReferenceDeleted unmarshals an instance of PublicGatewayReferenceDeleted from the specified map of raw messages. +func UnmarshalPublicGatewayReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(PublicGatewayReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Region : Region struct +type Region struct { + // The API endpoint for this region. + Endpoint *string `json:"endpoint" validate:"required"` + + // The URL for this region. + Href *string `json:"href" validate:"required"` + + // The globally unique name for this region. + Name *string `json:"name" validate:"required"` + + // The availability status of this region. + Status *string `json:"status" validate:"required"` +} + +// Constants associated with the Region.Status property. +// The availability status of this region. +const ( + RegionStatusAvailableConst = "available" + RegionStatusUnavailableConst = "unavailable" +) + +// UnmarshalRegion unmarshals an instance of Region from the specified map of raw messages. +func UnmarshalRegion(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(Region) + err = core.UnmarshalPrimitive(m, "endpoint", &obj.Endpoint) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RegionCollection : RegionCollection struct +type RegionCollection struct { + // Collection of regions. + Regions []Region `json:"regions" validate:"required"` +} + +// UnmarshalRegionCollection unmarshals an instance of RegionCollection from the specified map of raw messages. +func UnmarshalRegionCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RegionCollection) + err = core.UnmarshalModel(m, "regions", &obj.Regions, UnmarshalRegion) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RegionIdentity : Identifies a region by a unique property. +// Models which "extend" this model: +// - RegionIdentityByName +// - RegionIdentityByHref +type RegionIdentity struct { + // The globally unique name for this region. + Name *string `json:"name,omitempty"` + + // The URL for this region. + Href *string `json:"href,omitempty"` +} + +func (*RegionIdentity) isaRegionIdentity() bool { + return true +} + +type RegionIdentityIntf interface { + isaRegionIdentity() bool +} + +// UnmarshalRegionIdentity unmarshals an instance of RegionIdentity from the specified map of raw messages. +func UnmarshalRegionIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RegionIdentity) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RegionReference : RegionReference struct +type RegionReference struct { + // The URL for this region. + Href *string `json:"href" validate:"required"` + + // The globally unique name for this region. + Name *string `json:"name" validate:"required"` +} + +// UnmarshalRegionReference unmarshals an instance of RegionReference from the specified map of raw messages. +func UnmarshalRegionReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RegionReference) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RemoveBareMetalServerNetworkInterfaceFloatingIPOptions : The RemoveBareMetalServerNetworkInterfaceFloatingIP options. +type RemoveBareMetalServerNetworkInterfaceFloatingIPOptions struct { + // The bare metal server identifier. + BareMetalServerID *string `json:"bare_metal_server_id" validate:"required,ne="` + + // The bare metal server network interface identifier. + NetworkInterfaceID *string `json:"network_interface_id" validate:"required,ne="` + + // The floating IP identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewRemoveBareMetalServerNetworkInterfaceFloatingIPOptions : Instantiate RemoveBareMetalServerNetworkInterfaceFloatingIPOptions +func (*VpcV1) NewRemoveBareMetalServerNetworkInterfaceFloatingIPOptions(bareMetalServerID string, networkInterfaceID string, id string) *RemoveBareMetalServerNetworkInterfaceFloatingIPOptions { + return &RemoveBareMetalServerNetworkInterfaceFloatingIPOptions{ + BareMetalServerID: core.StringPtr(bareMetalServerID), + NetworkInterfaceID: core.StringPtr(networkInterfaceID), + ID: core.StringPtr(id), + } +} + +// SetBareMetalServerID : Allow user to set BareMetalServerID +func (_options *RemoveBareMetalServerNetworkInterfaceFloatingIPOptions) SetBareMetalServerID(bareMetalServerID string) *RemoveBareMetalServerNetworkInterfaceFloatingIPOptions { + _options.BareMetalServerID = core.StringPtr(bareMetalServerID) + return _options +} + +// SetNetworkInterfaceID : Allow user to set NetworkInterfaceID +func (_options *RemoveBareMetalServerNetworkInterfaceFloatingIPOptions) SetNetworkInterfaceID(networkInterfaceID string) *RemoveBareMetalServerNetworkInterfaceFloatingIPOptions { + _options.NetworkInterfaceID = core.StringPtr(networkInterfaceID) + return _options +} + +// SetID : Allow user to set ID +func (_options *RemoveBareMetalServerNetworkInterfaceFloatingIPOptions) SetID(id string) *RemoveBareMetalServerNetworkInterfaceFloatingIPOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *RemoveBareMetalServerNetworkInterfaceFloatingIPOptions) SetHeaders(param map[string]string) *RemoveBareMetalServerNetworkInterfaceFloatingIPOptions { + options.Headers = param + return options +} + +// RemoveEndpointGatewayIPOptions : The RemoveEndpointGatewayIP options. +type RemoveEndpointGatewayIPOptions struct { + // The endpoint gateway identifier. + EndpointGatewayID *string `json:"endpoint_gateway_id" validate:"required,ne="` + + // The reserved IP identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewRemoveEndpointGatewayIPOptions : Instantiate RemoveEndpointGatewayIPOptions +func (*VpcV1) NewRemoveEndpointGatewayIPOptions(endpointGatewayID string, id string) *RemoveEndpointGatewayIPOptions { + return &RemoveEndpointGatewayIPOptions{ + EndpointGatewayID: core.StringPtr(endpointGatewayID), + ID: core.StringPtr(id), + } +} + +// SetEndpointGatewayID : Allow user to set EndpointGatewayID +func (_options *RemoveEndpointGatewayIPOptions) SetEndpointGatewayID(endpointGatewayID string) *RemoveEndpointGatewayIPOptions { + _options.EndpointGatewayID = core.StringPtr(endpointGatewayID) + return _options +} + +// SetID : Allow user to set ID +func (_options *RemoveEndpointGatewayIPOptions) SetID(id string) *RemoveEndpointGatewayIPOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *RemoveEndpointGatewayIPOptions) SetHeaders(param map[string]string) *RemoveEndpointGatewayIPOptions { + options.Headers = param + return options +} + +// RemoveInstanceNetworkInterfaceFloatingIPOptions : The RemoveInstanceNetworkInterfaceFloatingIP options. +type RemoveInstanceNetworkInterfaceFloatingIPOptions struct { + // The virtual server instance identifier. + InstanceID *string `json:"instance_id" validate:"required,ne="` + + // The instance network interface identifier. + NetworkInterfaceID *string `json:"network_interface_id" validate:"required,ne="` + + // The floating IP identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewRemoveInstanceNetworkInterfaceFloatingIPOptions : Instantiate RemoveInstanceNetworkInterfaceFloatingIPOptions +func (*VpcV1) NewRemoveInstanceNetworkInterfaceFloatingIPOptions(instanceID string, networkInterfaceID string, id string) *RemoveInstanceNetworkInterfaceFloatingIPOptions { + return &RemoveInstanceNetworkInterfaceFloatingIPOptions{ + InstanceID: core.StringPtr(instanceID), + NetworkInterfaceID: core.StringPtr(networkInterfaceID), + ID: core.StringPtr(id), + } +} + +// SetInstanceID : Allow user to set InstanceID +func (_options *RemoveInstanceNetworkInterfaceFloatingIPOptions) SetInstanceID(instanceID string) *RemoveInstanceNetworkInterfaceFloatingIPOptions { + _options.InstanceID = core.StringPtr(instanceID) + return _options +} + +// SetNetworkInterfaceID : Allow user to set NetworkInterfaceID +func (_options *RemoveInstanceNetworkInterfaceFloatingIPOptions) SetNetworkInterfaceID(networkInterfaceID string) *RemoveInstanceNetworkInterfaceFloatingIPOptions { + _options.NetworkInterfaceID = core.StringPtr(networkInterfaceID) + return _options +} + +// SetID : Allow user to set ID +func (_options *RemoveInstanceNetworkInterfaceFloatingIPOptions) SetID(id string) *RemoveInstanceNetworkInterfaceFloatingIPOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *RemoveInstanceNetworkInterfaceFloatingIPOptions) SetHeaders(param map[string]string) *RemoveInstanceNetworkInterfaceFloatingIPOptions { + options.Headers = param + return options +} + +// RemoveVPNGatewayConnectionLocalCIDROptions : The RemoveVPNGatewayConnectionLocalCIDR options. +type RemoveVPNGatewayConnectionLocalCIDROptions struct { + // The VPN gateway identifier. + VPNGatewayID *string `json:"vpn_gateway_id" validate:"required,ne="` + + // The VPN gateway connection identifier. + ID *string `json:"id" validate:"required,ne="` + + // The address prefix part of the CIDR. + CIDRPrefix *string `json:"cidr_prefix" validate:"required,ne="` + + // The prefix length part of the CIDR. + PrefixLength *string `json:"prefix_length" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewRemoveVPNGatewayConnectionLocalCIDROptions : Instantiate RemoveVPNGatewayConnectionLocalCIDROptions +func (*VpcV1) NewRemoveVPNGatewayConnectionLocalCIDROptions(vpnGatewayID string, id string, cidrPrefix string, prefixLength string) *RemoveVPNGatewayConnectionLocalCIDROptions { + return &RemoveVPNGatewayConnectionLocalCIDROptions{ + VPNGatewayID: core.StringPtr(vpnGatewayID), + ID: core.StringPtr(id), + CIDRPrefix: core.StringPtr(cidrPrefix), + PrefixLength: core.StringPtr(prefixLength), + } +} + +// SetVPNGatewayID : Allow user to set VPNGatewayID +func (_options *RemoveVPNGatewayConnectionLocalCIDROptions) SetVPNGatewayID(vpnGatewayID string) *RemoveVPNGatewayConnectionLocalCIDROptions { + _options.VPNGatewayID = core.StringPtr(vpnGatewayID) + return _options +} + +// SetID : Allow user to set ID +func (_options *RemoveVPNGatewayConnectionLocalCIDROptions) SetID(id string) *RemoveVPNGatewayConnectionLocalCIDROptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetCIDRPrefix : Allow user to set CIDRPrefix +func (_options *RemoveVPNGatewayConnectionLocalCIDROptions) SetCIDRPrefix(cidrPrefix string) *RemoveVPNGatewayConnectionLocalCIDROptions { + _options.CIDRPrefix = core.StringPtr(cidrPrefix) + return _options +} + +// SetPrefixLength : Allow user to set PrefixLength +func (_options *RemoveVPNGatewayConnectionLocalCIDROptions) SetPrefixLength(prefixLength string) *RemoveVPNGatewayConnectionLocalCIDROptions { + _options.PrefixLength = core.StringPtr(prefixLength) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *RemoveVPNGatewayConnectionLocalCIDROptions) SetHeaders(param map[string]string) *RemoveVPNGatewayConnectionLocalCIDROptions { + options.Headers = param + return options +} + +// RemoveVPNGatewayConnectionPeerCIDROptions : The RemoveVPNGatewayConnectionPeerCIDR options. +type RemoveVPNGatewayConnectionPeerCIDROptions struct { + // The VPN gateway identifier. + VPNGatewayID *string `json:"vpn_gateway_id" validate:"required,ne="` + + // The VPN gateway connection identifier. + ID *string `json:"id" validate:"required,ne="` + + // The address prefix part of the CIDR. + CIDRPrefix *string `json:"cidr_prefix" validate:"required,ne="` + + // The prefix length part of the CIDR. + PrefixLength *string `json:"prefix_length" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewRemoveVPNGatewayConnectionPeerCIDROptions : Instantiate RemoveVPNGatewayConnectionPeerCIDROptions +func (*VpcV1) NewRemoveVPNGatewayConnectionPeerCIDROptions(vpnGatewayID string, id string, cidrPrefix string, prefixLength string) *RemoveVPNGatewayConnectionPeerCIDROptions { + return &RemoveVPNGatewayConnectionPeerCIDROptions{ + VPNGatewayID: core.StringPtr(vpnGatewayID), + ID: core.StringPtr(id), + CIDRPrefix: core.StringPtr(cidrPrefix), + PrefixLength: core.StringPtr(prefixLength), + } +} + +// SetVPNGatewayID : Allow user to set VPNGatewayID +func (_options *RemoveVPNGatewayConnectionPeerCIDROptions) SetVPNGatewayID(vpnGatewayID string) *RemoveVPNGatewayConnectionPeerCIDROptions { + _options.VPNGatewayID = core.StringPtr(vpnGatewayID) + return _options +} + +// SetID : Allow user to set ID +func (_options *RemoveVPNGatewayConnectionPeerCIDROptions) SetID(id string) *RemoveVPNGatewayConnectionPeerCIDROptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetCIDRPrefix : Allow user to set CIDRPrefix +func (_options *RemoveVPNGatewayConnectionPeerCIDROptions) SetCIDRPrefix(cidrPrefix string) *RemoveVPNGatewayConnectionPeerCIDROptions { + _options.CIDRPrefix = core.StringPtr(cidrPrefix) + return _options +} + +// SetPrefixLength : Allow user to set PrefixLength +func (_options *RemoveVPNGatewayConnectionPeerCIDROptions) SetPrefixLength(prefixLength string) *RemoveVPNGatewayConnectionPeerCIDROptions { + _options.PrefixLength = core.StringPtr(prefixLength) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *RemoveVPNGatewayConnectionPeerCIDROptions) SetHeaders(param map[string]string) *RemoveVPNGatewayConnectionPeerCIDROptions { + options.Headers = param + return options +} + +// ReplaceLoadBalancerPoolMembersOptions : The ReplaceLoadBalancerPoolMembers options. +type ReplaceLoadBalancerPoolMembersOptions struct { + // The load balancer identifier. + LoadBalancerID *string `json:"load_balancer_id" validate:"required,ne="` + + // The pool identifier. + PoolID *string `json:"pool_id" validate:"required,ne="` + + // The member prototype objects for this pool. + Members []LoadBalancerPoolMemberPrototype `json:"members" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewReplaceLoadBalancerPoolMembersOptions : Instantiate ReplaceLoadBalancerPoolMembersOptions +func (*VpcV1) NewReplaceLoadBalancerPoolMembersOptions(loadBalancerID string, poolID string, members []LoadBalancerPoolMemberPrototype) *ReplaceLoadBalancerPoolMembersOptions { + return &ReplaceLoadBalancerPoolMembersOptions{ + LoadBalancerID: core.StringPtr(loadBalancerID), + PoolID: core.StringPtr(poolID), + Members: members, + } +} + +// SetLoadBalancerID : Allow user to set LoadBalancerID +func (_options *ReplaceLoadBalancerPoolMembersOptions) SetLoadBalancerID(loadBalancerID string) *ReplaceLoadBalancerPoolMembersOptions { + _options.LoadBalancerID = core.StringPtr(loadBalancerID) + return _options +} + +// SetPoolID : Allow user to set PoolID +func (_options *ReplaceLoadBalancerPoolMembersOptions) SetPoolID(poolID string) *ReplaceLoadBalancerPoolMembersOptions { + _options.PoolID = core.StringPtr(poolID) + return _options +} + +// SetMembers : Allow user to set Members +func (_options *ReplaceLoadBalancerPoolMembersOptions) SetMembers(members []LoadBalancerPoolMemberPrototype) *ReplaceLoadBalancerPoolMembersOptions { + _options.Members = members + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ReplaceLoadBalancerPoolMembersOptions) SetHeaders(param map[string]string) *ReplaceLoadBalancerPoolMembersOptions { + options.Headers = param + return options +} + +// ReplaceSubnetNetworkACLOptions : The ReplaceSubnetNetworkACL options. +type ReplaceSubnetNetworkACLOptions struct { + // The subnet identifier. + ID *string `json:"id" validate:"required,ne="` + + // The network ACL identity. + NetworkACLIdentity NetworkACLIdentityIntf `json:"NetworkACLIdentity" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewReplaceSubnetNetworkACLOptions : Instantiate ReplaceSubnetNetworkACLOptions +func (*VpcV1) NewReplaceSubnetNetworkACLOptions(id string, networkACLIdentity NetworkACLIdentityIntf) *ReplaceSubnetNetworkACLOptions { + return &ReplaceSubnetNetworkACLOptions{ + ID: core.StringPtr(id), + NetworkACLIdentity: networkACLIdentity, + } +} + +// SetID : Allow user to set ID +func (_options *ReplaceSubnetNetworkACLOptions) SetID(id string) *ReplaceSubnetNetworkACLOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetNetworkACLIdentity : Allow user to set NetworkACLIdentity +func (_options *ReplaceSubnetNetworkACLOptions) SetNetworkACLIdentity(networkACLIdentity NetworkACLIdentityIntf) *ReplaceSubnetNetworkACLOptions { + _options.NetworkACLIdentity = networkACLIdentity + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ReplaceSubnetNetworkACLOptions) SetHeaders(param map[string]string) *ReplaceSubnetNetworkACLOptions { + options.Headers = param + return options +} + +// ReplaceSubnetRoutingTableOptions : The ReplaceSubnetRoutingTable options. +type ReplaceSubnetRoutingTableOptions struct { + // The subnet identifier. + ID *string `json:"id" validate:"required,ne="` + + // The routing table identity. + RoutingTableIdentity RoutingTableIdentityIntf `json:"RoutingTableIdentity" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewReplaceSubnetRoutingTableOptions : Instantiate ReplaceSubnetRoutingTableOptions +func (*VpcV1) NewReplaceSubnetRoutingTableOptions(id string, routingTableIdentity RoutingTableIdentityIntf) *ReplaceSubnetRoutingTableOptions { + return &ReplaceSubnetRoutingTableOptions{ + ID: core.StringPtr(id), + RoutingTableIdentity: routingTableIdentity, + } +} + +// SetID : Allow user to set ID +func (_options *ReplaceSubnetRoutingTableOptions) SetID(id string) *ReplaceSubnetRoutingTableOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetRoutingTableIdentity : Allow user to set RoutingTableIdentity +func (_options *ReplaceSubnetRoutingTableOptions) SetRoutingTableIdentity(routingTableIdentity RoutingTableIdentityIntf) *ReplaceSubnetRoutingTableOptions { + _options.RoutingTableIdentity = routingTableIdentity + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *ReplaceSubnetRoutingTableOptions) SetHeaders(param map[string]string) *ReplaceSubnetRoutingTableOptions { + options.Headers = param + return options +} + +// ReservedIP : ReservedIP struct +type ReservedIP struct { + // The IP address. + // + // If the address has not yet been selected, the value will be `0.0.0.0`. + // + // This property may add support for IPv6 addresses in the future. When processing a value in this property, verify + // that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the + // error, or bypass the resource on which the unexpected IP address format was encountered. + Address *string `json:"address" validate:"required"` + + // Indicates whether this reserved IP member will be automatically deleted when either + // `target` is deleted, or the reserved IP is unbound. + AutoDelete *bool `json:"auto_delete" validate:"required"` + + // The date and time that the reserved IP was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The URL for this reserved IP. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this reserved IP. + ID *string `json:"id" validate:"required"` + + // The lifecycle state of the reserved IP. + LifecycleState *string `json:"lifecycle_state" validate:"required"` + + // The name for this reserved IP. The name is unique across all reserved IPs in a subnet. + Name *string `json:"name" validate:"required"` + + // The owner of the reserved IP. + Owner *string `json:"owner" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The target this reserved IP is bound to. + // + // If absent, this reserved IP is provider-owned or unbound. + Target ReservedIPTargetIntf `json:"target,omitempty"` +} + +// Constants associated with the ReservedIP.LifecycleState property. +// The lifecycle state of the reserved IP. +const ( + ReservedIPLifecycleStateDeletingConst = "deleting" + ReservedIPLifecycleStateFailedConst = "failed" + ReservedIPLifecycleStatePendingConst = "pending" + ReservedIPLifecycleStateStableConst = "stable" + ReservedIPLifecycleStateSuspendedConst = "suspended" + ReservedIPLifecycleStateUpdatingConst = "updating" + ReservedIPLifecycleStateWaitingConst = "waiting" +) + +// Constants associated with the ReservedIP.Owner property. +// The owner of the reserved IP. +const ( + ReservedIPOwnerProviderConst = "provider" + ReservedIPOwnerUserConst = "user" +) + +// Constants associated with the ReservedIP.ResourceType property. +// The resource type. +const ( + ReservedIPResourceTypeSubnetReservedIPConst = "subnet_reserved_ip" +) + +// UnmarshalReservedIP unmarshals an instance of ReservedIP from the specified map of raw messages. +func UnmarshalReservedIP(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ReservedIP) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "auto_delete", &obj.AutoDelete) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "lifecycle_state", &obj.LifecycleState) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "owner", &obj.Owner) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalModel(m, "target", &obj.Target, UnmarshalReservedIPTarget) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ReservedIPCollection : ReservedIPCollection struct +type ReservedIPCollection struct { + // A link to the first page of resources. + First *ReservedIPCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *ReservedIPCollectionNext `json:"next,omitempty"` + + // Collection of reserved IPs in this subnet. + ReservedIps []ReservedIP `json:"reserved_ips" validate:"required"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalReservedIPCollection unmarshals an instance of ReservedIPCollection from the specified map of raw messages. +func UnmarshalReservedIPCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ReservedIPCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalReservedIPCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalReservedIPCollectionNext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "reserved_ips", &obj.ReservedIps, UnmarshalReservedIP) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *ReservedIPCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// ReservedIPCollectionBareMetalServerNetworkInterfaceContext : ReservedIPCollectionBareMetalServerNetworkInterfaceContext struct +type ReservedIPCollectionBareMetalServerNetworkInterfaceContext struct { + // A link to the first page of resources. + First *ReservedIPCollectionBareMetalServerNetworkInterfaceContextFirst `json:"first" validate:"required"` + + // Collection of reserved IPs bound to a bare metal server network interface. + Ips []ReservedIP `json:"ips" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *ReservedIPCollectionBareMetalServerNetworkInterfaceContextNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalReservedIPCollectionBareMetalServerNetworkInterfaceContext unmarshals an instance of ReservedIPCollectionBareMetalServerNetworkInterfaceContext from the specified map of raw messages. +func UnmarshalReservedIPCollectionBareMetalServerNetworkInterfaceContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ReservedIPCollectionBareMetalServerNetworkInterfaceContext) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalReservedIPCollectionBareMetalServerNetworkInterfaceContextFirst) + if err != nil { + return + } + err = core.UnmarshalModel(m, "ips", &obj.Ips, UnmarshalReservedIP) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalReservedIPCollectionBareMetalServerNetworkInterfaceContextNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ReservedIPCollectionBareMetalServerNetworkInterfaceContextFirst : A link to the first page of resources. +type ReservedIPCollectionBareMetalServerNetworkInterfaceContextFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalReservedIPCollectionBareMetalServerNetworkInterfaceContextFirst unmarshals an instance of ReservedIPCollectionBareMetalServerNetworkInterfaceContextFirst from the specified map of raw messages. +func UnmarshalReservedIPCollectionBareMetalServerNetworkInterfaceContextFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ReservedIPCollectionBareMetalServerNetworkInterfaceContextFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ReservedIPCollectionBareMetalServerNetworkInterfaceContextNext : A link to the next page of resources. This property is present for all pages except the last page. +type ReservedIPCollectionBareMetalServerNetworkInterfaceContextNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalReservedIPCollectionBareMetalServerNetworkInterfaceContextNext unmarshals an instance of ReservedIPCollectionBareMetalServerNetworkInterfaceContextNext from the specified map of raw messages. +func UnmarshalReservedIPCollectionBareMetalServerNetworkInterfaceContextNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ReservedIPCollectionBareMetalServerNetworkInterfaceContextNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ReservedIPCollectionEndpointGatewayContext : ReservedIPCollectionEndpointGatewayContext struct +type ReservedIPCollectionEndpointGatewayContext struct { + // A link to the first page of resources. + First *ReservedIPCollectionEndpointGatewayContextFirst `json:"first" validate:"required"` + + // Collection of reserved IPs bound to an endpoint gateway. + Ips []ReservedIP `json:"ips" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *ReservedIPCollectionEndpointGatewayContextNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalReservedIPCollectionEndpointGatewayContext unmarshals an instance of ReservedIPCollectionEndpointGatewayContext from the specified map of raw messages. +func UnmarshalReservedIPCollectionEndpointGatewayContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ReservedIPCollectionEndpointGatewayContext) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalReservedIPCollectionEndpointGatewayContextFirst) + if err != nil { + return + } + err = core.UnmarshalModel(m, "ips", &obj.Ips, UnmarshalReservedIP) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalReservedIPCollectionEndpointGatewayContextNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *ReservedIPCollectionEndpointGatewayContext) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// ReservedIPCollectionEndpointGatewayContextFirst : A link to the first page of resources. +type ReservedIPCollectionEndpointGatewayContextFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalReservedIPCollectionEndpointGatewayContextFirst unmarshals an instance of ReservedIPCollectionEndpointGatewayContextFirst from the specified map of raw messages. +func UnmarshalReservedIPCollectionEndpointGatewayContextFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ReservedIPCollectionEndpointGatewayContextFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ReservedIPCollectionEndpointGatewayContextNext : A link to the next page of resources. This property is present for all pages except the last page. +type ReservedIPCollectionEndpointGatewayContextNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalReservedIPCollectionEndpointGatewayContextNext unmarshals an instance of ReservedIPCollectionEndpointGatewayContextNext from the specified map of raw messages. +func UnmarshalReservedIPCollectionEndpointGatewayContextNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ReservedIPCollectionEndpointGatewayContextNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ReservedIPCollectionFirst : A link to the first page of resources. +type ReservedIPCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalReservedIPCollectionFirst unmarshals an instance of ReservedIPCollectionFirst from the specified map of raw messages. +func UnmarshalReservedIPCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ReservedIPCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ReservedIPCollectionInstanceNetworkInterfaceContext : ReservedIPCollectionInstanceNetworkInterfaceContext struct +type ReservedIPCollectionInstanceNetworkInterfaceContext struct { + // A link to the first page of resources. + First *ReservedIPCollectionInstanceNetworkInterfaceContextFirst `json:"first" validate:"required"` + + // Collection of reserved IPs bound to an instance network interface. + Ips []ReservedIP `json:"ips" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *ReservedIPCollectionInstanceNetworkInterfaceContextNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalReservedIPCollectionInstanceNetworkInterfaceContext unmarshals an instance of ReservedIPCollectionInstanceNetworkInterfaceContext from the specified map of raw messages. +func UnmarshalReservedIPCollectionInstanceNetworkInterfaceContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ReservedIPCollectionInstanceNetworkInterfaceContext) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalReservedIPCollectionInstanceNetworkInterfaceContextFirst) + if err != nil { + return + } + err = core.UnmarshalModel(m, "ips", &obj.Ips, UnmarshalReservedIP) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalReservedIPCollectionInstanceNetworkInterfaceContextNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *ReservedIPCollectionInstanceNetworkInterfaceContext) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// ReservedIPCollectionInstanceNetworkInterfaceContextFirst : A link to the first page of resources. +type ReservedIPCollectionInstanceNetworkInterfaceContextFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalReservedIPCollectionInstanceNetworkInterfaceContextFirst unmarshals an instance of ReservedIPCollectionInstanceNetworkInterfaceContextFirst from the specified map of raw messages. +func UnmarshalReservedIPCollectionInstanceNetworkInterfaceContextFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ReservedIPCollectionInstanceNetworkInterfaceContextFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ReservedIPCollectionInstanceNetworkInterfaceContextNext : A link to the next page of resources. This property is present for all pages except the last page. +type ReservedIPCollectionInstanceNetworkInterfaceContextNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalReservedIPCollectionInstanceNetworkInterfaceContextNext unmarshals an instance of ReservedIPCollectionInstanceNetworkInterfaceContextNext from the specified map of raw messages. +func UnmarshalReservedIPCollectionInstanceNetworkInterfaceContextNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ReservedIPCollectionInstanceNetworkInterfaceContextNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ReservedIPCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type ReservedIPCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalReservedIPCollectionNext unmarshals an instance of ReservedIPCollectionNext from the specified map of raw messages. +func UnmarshalReservedIPCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ReservedIPCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ReservedIPPatch : ReservedIPPatch struct +type ReservedIPPatch struct { + // Indicates whether this reserved IP member will be automatically deleted when either + // `target` is deleted, or the reserved IP is unbound. Must be `false` if the reserved IP is unbound. + AutoDelete *bool `json:"auto_delete,omitempty"` + + // The name for this reserved IP. The name must not be used by another reserved IP in the subnet. Names starting with + // `ibm-` are reserved for provider-owned resources, and are not allowed. + Name *string `json:"name,omitempty"` +} + +// UnmarshalReservedIPPatch unmarshals an instance of ReservedIPPatch from the specified map of raw messages. +func UnmarshalReservedIPPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ReservedIPPatch) + err = core.UnmarshalPrimitive(m, "auto_delete", &obj.AutoDelete) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the ReservedIPPatch +func (reservedIPPatch *ReservedIPPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(reservedIPPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// ReservedIPReference : ReservedIPReference struct +type ReservedIPReference struct { + // The IP address. + // + // If the address has not yet been selected, the value will be `0.0.0.0`. + // + // This property may add support for IPv6 addresses in the future. When processing a value in this property, verify + // that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the + // error, or bypass the resource on which the unexpected IP address format was encountered. + Address *string `json:"address" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *ReservedIPReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this reserved IP. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this reserved IP. + ID *string `json:"id" validate:"required"` + + // The name for this reserved IP. The name is unique across all reserved IPs in a subnet. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the ReservedIPReference.ResourceType property. +// The resource type. +const ( + ReservedIPReferenceResourceTypeSubnetReservedIPConst = "subnet_reserved_ip" +) + +// UnmarshalReservedIPReference unmarshals an instance of ReservedIPReference from the specified map of raw messages. +func UnmarshalReservedIPReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ReservedIPReference) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalReservedIPReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ReservedIPReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type ReservedIPReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalReservedIPReferenceDeleted unmarshals an instance of ReservedIPReferenceDeleted from the specified map of raw messages. +func UnmarshalReservedIPReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ReservedIPReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ReservedIPTarget : The target this reserved IP is bound to. +// +// If absent, this reserved IP is provider-owned or unbound. +// Models which "extend" this model: +// - ReservedIPTargetEndpointGatewayReference +// - ReservedIPTargetVirtualNetworkInterfaceReferenceReservedIPTargetContext +// - ReservedIPTargetNetworkInterfaceReferenceTargetContext +// - ReservedIPTargetBareMetalServerNetworkInterfaceReferenceTargetContext +// - ReservedIPTargetLoadBalancerReference +// - ReservedIPTargetVPNGatewayReference +// - ReservedIPTargetVPNServerReference +// - ReservedIPTargetGenericResourceReference +type ReservedIPTarget struct { + // The CRN for this endpoint gateway. + CRN *string `json:"crn,omitempty"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *EndpointGatewayReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this endpoint gateway. + Href *string `json:"href,omitempty"` + + // The unique identifier for this endpoint gateway. + ID *string `json:"id,omitempty"` + + // The name for this endpoint gateway. The name is unique across all endpoint gateways in the VPC. + Name *string `json:"name,omitempty"` + + // The resource type. + ResourceType *string `json:"resource_type,omitempty"` +} + +// Constants associated with the ReservedIPTarget.ResourceType property. +// The resource type. +const ( + ReservedIPTargetResourceTypeEndpointGatewayConst = "endpoint_gateway" +) + +func (*ReservedIPTarget) isaReservedIPTarget() bool { + return true +} + +type ReservedIPTargetIntf interface { + isaReservedIPTarget() bool +} + +// UnmarshalReservedIPTarget unmarshals an instance of ReservedIPTarget from the specified map of raw messages. +func UnmarshalReservedIPTarget(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ReservedIPTarget) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalEndpointGatewayReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ReservedIPTargetPrototype : The target to bind this reserved IP to. The target must be in the same VPC. +// +// At present, only endpoint gateway targets are supported. The endpoint gateway must not be already bound to a +// reserved IP in the subnet's zone. +// +// If unspecified, the reserved IP will be created unbound. +// Models which "extend" this model: +// - ReservedIPTargetPrototypeEndpointGatewayIdentity +type ReservedIPTargetPrototype struct { + // The unique identifier for this endpoint gateway. + ID *string `json:"id,omitempty"` + + // The CRN for this endpoint gateway. + CRN *string `json:"crn,omitempty"` + + // The URL for this endpoint gateway. + Href *string `json:"href,omitempty"` +} + +func (*ReservedIPTargetPrototype) isaReservedIPTargetPrototype() bool { + return true +} + +type ReservedIPTargetPrototypeIntf interface { + isaReservedIPTargetPrototype() bool +} + +// UnmarshalReservedIPTargetPrototype unmarshals an instance of ReservedIPTargetPrototype from the specified map of raw messages. +func UnmarshalReservedIPTargetPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ReservedIPTargetPrototype) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ResourceFilter : Identifies one or more resources according to the specified filter property. +type ResourceFilter struct { + // The resource type. + ResourceType *string `json:"resource_type,omitempty"` +} + +// UnmarshalResourceFilter unmarshals an instance of ResourceFilter from the specified map of raw messages. +func UnmarshalResourceFilter(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ResourceFilter) + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ResourceGroupIdentity : The resource group to use. If unspecified, the account's [default resource +// group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. +// Models which "extend" this model: +// - ResourceGroupIdentityByID +type ResourceGroupIdentity struct { + // The unique identifier for this resource group. + ID *string `json:"id,omitempty"` +} + +func (*ResourceGroupIdentity) isaResourceGroupIdentity() bool { + return true +} + +type ResourceGroupIdentityIntf interface { + isaResourceGroupIdentity() bool +} + +// UnmarshalResourceGroupIdentity unmarshals an instance of ResourceGroupIdentity from the specified map of raw messages. +func UnmarshalResourceGroupIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ResourceGroupIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ResourceGroupReference : ResourceGroupReference struct +type ResourceGroupReference struct { + // The URL for this resource group. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this resource group. + ID *string `json:"id" validate:"required"` + + // The name for this resource group. + Name *string `json:"name" validate:"required"` +} + +// UnmarshalResourceGroupReference unmarshals an instance of ResourceGroupReference from the specified map of raw messages. +func UnmarshalResourceGroupReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ResourceGroupReference) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RestartBareMetalServerOptions : The RestartBareMetalServer options. +type RestartBareMetalServerOptions struct { + // The bare metal server identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewRestartBareMetalServerOptions : Instantiate RestartBareMetalServerOptions +func (*VpcV1) NewRestartBareMetalServerOptions(id string) *RestartBareMetalServerOptions { + return &RestartBareMetalServerOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *RestartBareMetalServerOptions) SetID(id string) *RestartBareMetalServerOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *RestartBareMetalServerOptions) SetHeaders(param map[string]string) *RestartBareMetalServerOptions { + options.Headers = param + return options +} + +// Route : Route struct +type Route struct { + // The action to perform with a packet matching the route: + // - `delegate`: delegate to system-provided routes + // - `delegate_vpc`: delegate to system-provided routes, ignoring Internet-bound routes + // - `deliver`: deliver the packet to the specified `next_hop` + // - `drop`: drop the packet. + Action *string `json:"action" validate:"required"` + + // The date and time that the route was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // If present, the resource that created the route. Routes with this property present cannot + // be directly deleted. All routes with an `origin` of `service` will have this property set, + // and future `origin` values may also have this property set. + Creator RouteCreatorIntf `json:"creator,omitempty"` + + // The destination CIDR of the route. + Destination *string `json:"destination" validate:"required"` + + // The URL for this route. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this route. + ID *string `json:"id" validate:"required"` + + // The lifecycle state of the route. + LifecycleState *string `json:"lifecycle_state" validate:"required"` + + // The name for this route. The name is unique across all routes in the routing table. + Name *string `json:"name" validate:"required"` + + // If `action` is `deliver`, the next hop that packets will be delivered to. For + // other `action` values, its `address` will be `0.0.0.0`. + NextHop RouteNextHopIntf `json:"next_hop" validate:"required"` + + // The origin of this route: + // - `service`: route was directly created by a service + // - `user`: route was directly created by a user + // + // The enumerated values for this property are expected to expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the route on which the + // unexpected property value was encountered. + Origin *string `json:"origin,omitempty"` + + // The priority of this route. Smaller values have higher priority. + // + // If a routing table contains multiple routes with the same `zone` and `destination`, the route with the highest + // priority (smallest value) is selected. If two routes have the same `destination` and `priority`, traffic is + // distributed between them. + Priority *int64 `json:"priority" validate:"required"` + + // The zone the route applies to. (Traffic from subnets in this zone will be + // subject to this route.). + Zone *ZoneReference `json:"zone" validate:"required"` +} + +// Constants associated with the Route.Action property. +// The action to perform with a packet matching the route: +// - `delegate`: delegate to system-provided routes +// - `delegate_vpc`: delegate to system-provided routes, ignoring Internet-bound routes +// - `deliver`: deliver the packet to the specified `next_hop` +// - `drop`: drop the packet. +const ( + RouteActionDelegateConst = "delegate" + RouteActionDelegateVPCConst = "delegate_vpc" + RouteActionDeliverConst = "deliver" + RouteActionDropConst = "drop" +) + +// Constants associated with the Route.LifecycleState property. +// The lifecycle state of the route. +const ( + RouteLifecycleStateDeletingConst = "deleting" + RouteLifecycleStateFailedConst = "failed" + RouteLifecycleStatePendingConst = "pending" + RouteLifecycleStateStableConst = "stable" + RouteLifecycleStateSuspendedConst = "suspended" + RouteLifecycleStateUpdatingConst = "updating" + RouteLifecycleStateWaitingConst = "waiting" +) + +// Constants associated with the Route.Origin property. +// The origin of this route: +// - `service`: route was directly created by a service +// - `user`: route was directly created by a user +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the route on which the +// unexpected property value was encountered. +const ( + RouteOriginServiceConst = "service" + RouteOriginUserConst = "user" +) + +// UnmarshalRoute unmarshals an instance of Route from the specified map of raw messages. +func UnmarshalRoute(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(Route) + err = core.UnmarshalPrimitive(m, "action", &obj.Action) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalModel(m, "creator", &obj.Creator, UnmarshalRouteCreator) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "destination", &obj.Destination) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "lifecycle_state", &obj.LifecycleState) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next_hop", &obj.NextHop, UnmarshalRouteNextHop) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "origin", &obj.Origin) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "priority", &obj.Priority) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RouteCollection : RouteCollection struct +type RouteCollection struct { + // A link to the first page of resources. + First *RouteCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *RouteCollectionNext `json:"next,omitempty"` + + // Collection of routes. + Routes []Route `json:"routes" validate:"required"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalRouteCollection unmarshals an instance of RouteCollection from the specified map of raw messages. +func UnmarshalRouteCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RouteCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalRouteCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalRouteCollectionNext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "routes", &obj.Routes, UnmarshalRoute) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *RouteCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// RouteCollectionFirst : A link to the first page of resources. +type RouteCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalRouteCollectionFirst unmarshals an instance of RouteCollectionFirst from the specified map of raw messages. +func UnmarshalRouteCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RouteCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RouteCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type RouteCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalRouteCollectionNext unmarshals an instance of RouteCollectionNext from the specified map of raw messages. +func UnmarshalRouteCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RouteCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RouteCollectionVPCContext : RouteCollectionVPCContext struct +type RouteCollectionVPCContext struct { + // A link to the first page of resources. + First *RouteCollectionVPCContextFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *RouteCollectionVPCContextNext `json:"next,omitempty"` + + // Collection of routes. + Routes []RouteCollectionVPCContextRoutesItem `json:"routes" validate:"required"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalRouteCollectionVPCContext unmarshals an instance of RouteCollectionVPCContext from the specified map of raw messages. +func UnmarshalRouteCollectionVPCContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RouteCollectionVPCContext) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalRouteCollectionVPCContextFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalRouteCollectionVPCContextNext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "routes", &obj.Routes, UnmarshalRouteCollectionVPCContextRoutesItem) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *RouteCollectionVPCContext) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// RouteCollectionVPCContextFirst : A link to the first page of resources. +type RouteCollectionVPCContextFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalRouteCollectionVPCContextFirst unmarshals an instance of RouteCollectionVPCContextFirst from the specified map of raw messages. +func UnmarshalRouteCollectionVPCContextFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RouteCollectionVPCContextFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RouteCollectionVPCContextNext : A link to the next page of resources. This property is present for all pages except the last page. +type RouteCollectionVPCContextNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalRouteCollectionVPCContextNext unmarshals an instance of RouteCollectionVPCContextNext from the specified map of raw messages. +func UnmarshalRouteCollectionVPCContextNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RouteCollectionVPCContextNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RouteCollectionVPCContextRoutesItem : RouteCollectionVPCContextRoutesItem struct +type RouteCollectionVPCContextRoutesItem struct { + // The action to perform with a packet matching the route: + // - `delegate`: delegate to system-provided routes + // - `delegate_vpc`: delegate to system-provided routes, ignoring Internet-bound routes + // - `deliver`: deliver the packet to the specified `next_hop` + // - `drop`: drop the packet. + Action *string `json:"action" validate:"required"` + + // The date and time that the route was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // If present, the resource that created the route. Routes with this property present cannot + // be directly deleted. All routes with an `origin` of `service` will have this property set, + // and future `origin` values may also have this property set. + Creator RouteCreatorIntf `json:"creator,omitempty"` + + // The destination CIDR of the route. + Destination *string `json:"destination" validate:"required"` + + // The URL for this route. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this route. + ID *string `json:"id" validate:"required"` + + // The lifecycle state of the route. + LifecycleState *string `json:"lifecycle_state" validate:"required"` + + // The name for this route. The name is unique across all routes in the routing table. + Name *string `json:"name" validate:"required"` + + // If `action` is `deliver`, the next hop that packets will be delivered to. For + // other `action` values, its `address` will be `0.0.0.0`. + NextHop RouteNextHopIntf `json:"next_hop" validate:"required"` + + // The origin of this route: + // - `service`: route was directly created by a service + // - `user`: route was directly created by a user + // + // The enumerated values for this property are expected to expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the route on which the + // unexpected property value was encountered. + Origin *string `json:"origin,omitempty"` + + // The priority of this route. Smaller values have higher priority. + // + // If a routing table contains multiple routes with the same `zone` and `destination`, the route with the highest + // priority (smallest value) is selected. If two routes have the same `destination` and `priority`, traffic is + // distributed between them. + Priority *int64 `json:"priority" validate:"required"` + + // The zone the route applies to. (Traffic from subnets in this zone will be + // subject to this route.). + Zone *ZoneReference `json:"zone" validate:"required"` +} + +// Constants associated with the RouteCollectionVPCContextRoutesItem.Action property. +// The action to perform with a packet matching the route: +// - `delegate`: delegate to system-provided routes +// - `delegate_vpc`: delegate to system-provided routes, ignoring Internet-bound routes +// - `deliver`: deliver the packet to the specified `next_hop` +// - `drop`: drop the packet. +const ( + RouteCollectionVPCContextRoutesItemActionDelegateConst = "delegate" + RouteCollectionVPCContextRoutesItemActionDelegateVPCConst = "delegate_vpc" + RouteCollectionVPCContextRoutesItemActionDeliverConst = "deliver" + RouteCollectionVPCContextRoutesItemActionDropConst = "drop" +) + +// Constants associated with the RouteCollectionVPCContextRoutesItem.LifecycleState property. +// The lifecycle state of the route. +const ( + RouteCollectionVPCContextRoutesItemLifecycleStateDeletingConst = "deleting" + RouteCollectionVPCContextRoutesItemLifecycleStateFailedConst = "failed" + RouteCollectionVPCContextRoutesItemLifecycleStatePendingConst = "pending" + RouteCollectionVPCContextRoutesItemLifecycleStateStableConst = "stable" + RouteCollectionVPCContextRoutesItemLifecycleStateSuspendedConst = "suspended" + RouteCollectionVPCContextRoutesItemLifecycleStateUpdatingConst = "updating" + RouteCollectionVPCContextRoutesItemLifecycleStateWaitingConst = "waiting" +) + +// Constants associated with the RouteCollectionVPCContextRoutesItem.Origin property. +// The origin of this route: +// - `service`: route was directly created by a service +// - `user`: route was directly created by a user +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the route on which the +// unexpected property value was encountered. +const ( + RouteCollectionVPCContextRoutesItemOriginServiceConst = "service" + RouteCollectionVPCContextRoutesItemOriginUserConst = "user" +) + +// UnmarshalRouteCollectionVPCContextRoutesItem unmarshals an instance of RouteCollectionVPCContextRoutesItem from the specified map of raw messages. +func UnmarshalRouteCollectionVPCContextRoutesItem(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RouteCollectionVPCContextRoutesItem) + err = core.UnmarshalPrimitive(m, "action", &obj.Action) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalModel(m, "creator", &obj.Creator, UnmarshalRouteCreator) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "destination", &obj.Destination) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "lifecycle_state", &obj.LifecycleState) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next_hop", &obj.NextHop, UnmarshalRouteNextHop) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "origin", &obj.Origin) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "priority", &obj.Priority) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RouteCreator : If present, the resource that created the route. Routes with this property present cannot be directly deleted. All +// routes with an `origin` of `service` will have this property set, and future `origin` values may also have this +// property set. +// Models which "extend" this model: +// - RouteCreatorVPNGatewayReference +// - RouteCreatorVPNServerReference +type RouteCreator struct { + // The VPN gateway's CRN. + CRN *string `json:"crn,omitempty"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *VPNGatewayReferenceDeleted `json:"deleted,omitempty"` + + // The VPN gateway's canonical URL. + Href *string `json:"href,omitempty"` + + // The unique identifier for this VPN gateway. + ID *string `json:"id,omitempty"` + + // The name for this VPN gateway. The name is unique across all VPN gateways in the VPC. + Name *string `json:"name,omitempty"` + + // The resource type. + ResourceType *string `json:"resource_type,omitempty"` +} + +// Constants associated with the RouteCreator.ResourceType property. +// The resource type. +const ( + RouteCreatorResourceTypeVPNGatewayConst = "vpn_gateway" +) + +func (*RouteCreator) isaRouteCreator() bool { + return true +} + +type RouteCreatorIntf interface { + isaRouteCreator() bool +} + +// UnmarshalRouteCreator unmarshals an instance of RouteCreator from the specified map of raw messages. +func UnmarshalRouteCreator(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RouteCreator) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalVPNGatewayReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RouteNextHop : RouteNextHop struct +// Models which "extend" this model: +// - RouteNextHopIP +// - RouteNextHopVPNGatewayConnectionReference +type RouteNextHop struct { + // The IP address. + // + // This property may add support for IPv6 addresses in the future. When processing a value in this property, verify + // that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the + // error, or bypass the resource on which the unexpected IP address format was encountered. + Address *string `json:"address,omitempty"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *VPNGatewayConnectionReferenceDeleted `json:"deleted,omitempty"` + + // The VPN connection's canonical URL. + Href *string `json:"href,omitempty"` + + // The unique identifier for this VPN gateway connection. + ID *string `json:"id,omitempty"` + + // The name for this VPN gateway connection. The name is unique across all connections for the VPN gateway. + Name *string `json:"name,omitempty"` + + // The resource type. + ResourceType *string `json:"resource_type,omitempty"` +} + +// Constants associated with the RouteNextHop.ResourceType property. +// The resource type. +const ( + RouteNextHopResourceTypeVPNGatewayConnectionConst = "vpn_gateway_connection" +) + +func (*RouteNextHop) isaRouteNextHop() bool { + return true +} + +type RouteNextHopIntf interface { + isaRouteNextHop() bool +} + +// UnmarshalRouteNextHop unmarshals an instance of RouteNextHop from the specified map of raw messages. +func UnmarshalRouteNextHop(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RouteNextHop) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalVPNGatewayConnectionReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RouteNextHopPatch : If `action` is `deliver`, the next hop that packets will be delivered to. For other +// `action` values, specify `0.0.0.0` or remove it by specifying `null`. +// +// At most two routes per `zone` in a table can have the same `destination` and `priority`, and only when each route has +// an `action` of `deliver` and `next_hop` is an IP address. +// Models which "extend" this model: +// - RouteNextHopPatchRouteNextHopIP +// - RouteNextHopPatchVPNGatewayConnectionIdentity +type RouteNextHopPatch struct { + // The sentinel IP address (`0.0.0.0`). + // + // This property may add support for IPv6 addresses in the future. When processing a value in this property, verify + // that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the + // error, or bypass the resource on which the unexpected IP address format was encountered. + Address *string `json:"address,omitempty"` + + // The unique identifier for this VPN gateway connection. + ID *string `json:"id,omitempty"` + + // The VPN connection's canonical URL. + Href *string `json:"href,omitempty"` +} + +func (*RouteNextHopPatch) isaRouteNextHopPatch() bool { + return true +} + +type RouteNextHopPatchIntf interface { + isaRouteNextHopPatch() bool +} + +// UnmarshalRouteNextHopPatch unmarshals an instance of RouteNextHopPatch from the specified map of raw messages. +func UnmarshalRouteNextHopPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RouteNextHopPatch) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RoutePatch : RoutePatch struct +type RoutePatch struct { + // The name for this route. The name must not be used by another route in the routing table. Names starting with `ibm-` + // are reserved for system-provided routes, and are not allowed. + Name *string `json:"name,omitempty"` + + // If `action` is `deliver`, the next hop that packets will be delivered to. For other + // `action` values, specify `0.0.0.0` or remove it by specifying `null`. + // + // At most two routes per `zone` in a table can have the same `destination` and `priority`, + // and only when each route has an `action` of `deliver` and `next_hop` is an IP address. + NextHop RouteNextHopPatchIntf `json:"next_hop,omitempty"` + + // The priority of this route. Smaller values have higher priority. + // + // If a routing table contains multiple routes with the same `zone` and `destination`, the route with the highest + // priority (smallest value) is selected. If two routes have the same `destination` and `priority`, traffic is + // distributed between them. + Priority *int64 `json:"priority,omitempty"` +} + +// UnmarshalRoutePatch unmarshals an instance of RoutePatch from the specified map of raw messages. +func UnmarshalRoutePatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RoutePatch) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next_hop", &obj.NextHop, UnmarshalRouteNextHopPatch) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "priority", &obj.Priority) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the RoutePatch +func (routePatch *RoutePatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(routePatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// RoutePrototype : RoutePrototype struct +type RoutePrototype struct { + // The action to perform with a packet matching the route: + // - `delegate`: delegate to system-provided routes + // - `delegate_vpc`: delegate to system-provided routes, ignoring Internet-bound routes + // - `deliver`: deliver the packet to the specified `next_hop` + // - `drop`: drop the packet. + Action *string `json:"action,omitempty"` + + // The destination CIDR of the route. The host identifier in the CIDR must be zero. + // + // At most two routes per `zone` in a table can have the same `destination` and + // `priority`, and only if both routes have an `action` of `deliver` and the `next_hop` is an IP address. + Destination *string `json:"destination" validate:"required"` + + // The name for this route. The name must not be used by another route in the routing table. Names starting with `ibm-` + // are reserved for system-provided routes, and are not allowed. If unspecified, the name will be a hyphenated list of + // randomly-selected words. + Name *string `json:"name,omitempty"` + + // If `action` is `deliver`, the next hop that packets will be delivered to. For other + // `action` values, it must be omitted or specified as `0.0.0.0`. + // + // At most two routes per `zone` in a table can have the same `destination` and `priority`, + // and only when each route has an `action` of `deliver` and `next_hop` is an IP address. + NextHop RoutePrototypeNextHopIntf `json:"next_hop,omitempty"` + + // The priority of this route. Smaller values have higher priority. + // + // If a routing table contains multiple routes with the same `zone` and `destination`, the route with the highest + // priority (smallest value) is selected. If two routes have the same `destination` and `priority`, traffic is + // distributed between them. + Priority *int64 `json:"priority,omitempty"` + + // The zone to apply the route to. (Traffic from subnets in this zone will be + // subject to this route.). + Zone ZoneIdentityIntf `json:"zone" validate:"required"` +} + +// Constants associated with the RoutePrototype.Action property. +// The action to perform with a packet matching the route: +// - `delegate`: delegate to system-provided routes +// - `delegate_vpc`: delegate to system-provided routes, ignoring Internet-bound routes +// - `deliver`: deliver the packet to the specified `next_hop` +// - `drop`: drop the packet. +const ( + RoutePrototypeActionDelegateConst = "delegate" + RoutePrototypeActionDelegateVPCConst = "delegate_vpc" + RoutePrototypeActionDeliverConst = "deliver" + RoutePrototypeActionDropConst = "drop" +) + +// NewRoutePrototype : Instantiate RoutePrototype (Generic Model Constructor) +func (*VpcV1) NewRoutePrototype(destination string, zone ZoneIdentityIntf) (_model *RoutePrototype, err error) { + _model = &RoutePrototype{ + Destination: core.StringPtr(destination), + Zone: zone, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalRoutePrototype unmarshals an instance of RoutePrototype from the specified map of raw messages. +func UnmarshalRoutePrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RoutePrototype) + err = core.UnmarshalPrimitive(m, "action", &obj.Action) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "destination", &obj.Destination) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next_hop", &obj.NextHop, UnmarshalRoutePrototypeNextHop) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "priority", &obj.Priority) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RoutePrototypeNextHop : If `action` is `deliver`, the next hop that packets will be delivered to. For other +// `action` values, it must be omitted or specified as `0.0.0.0`. +// +// At most two routes per `zone` in a table can have the same `destination` and `priority`, and only when each route has +// an `action` of `deliver` and `next_hop` is an IP address. +// Models which "extend" this model: +// - RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIP +// - RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentity +type RoutePrototypeNextHop struct { + // The sentinel IP address (`0.0.0.0`). + // + // This property may add support for IPv6 addresses in the future. When processing a value in this property, verify + // that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the + // error, or bypass the resource on which the unexpected IP address format was encountered. + Address *string `json:"address,omitempty"` + + // The unique identifier for this VPN gateway connection. + ID *string `json:"id,omitempty"` + + // The VPN connection's canonical URL. + Href *string `json:"href,omitempty"` +} + +func (*RoutePrototypeNextHop) isaRoutePrototypeNextHop() bool { + return true +} + +type RoutePrototypeNextHopIntf interface { + isaRoutePrototypeNextHop() bool +} + +// UnmarshalRoutePrototypeNextHop unmarshals an instance of RoutePrototypeNextHop from the specified map of raw messages. +func UnmarshalRoutePrototypeNextHop(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RoutePrototypeNextHop) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RouteReference : RouteReference struct +type RouteReference struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *RouteReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this route. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this route. + ID *string `json:"id" validate:"required"` + + // The name for this route. The name is unique across all routes in the routing table. + Name *string `json:"name" validate:"required"` +} + +// UnmarshalRouteReference unmarshals an instance of RouteReference from the specified map of raw messages. +func UnmarshalRouteReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RouteReference) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalRouteReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RouteReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type RouteReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalRouteReferenceDeleted unmarshals an instance of RouteReferenceDeleted from the specified map of raw messages. +func UnmarshalRouteReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RouteReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RoutingTable : RoutingTable struct +type RoutingTable struct { + // The filters specifying the resources that may create routes in this routing table. + // + // At present, only the `resource_type` filter is permitted, and only the `vpn_server` value is supported, but filter + // support is expected to expand in the future. + AcceptRoutesFrom []ResourceFilter `json:"accept_routes_from" validate:"required"` + + // The date and time that this routing table was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The URL for this routing table. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this routing table. + ID *string `json:"id" validate:"required"` + + // Indicates whether this is the default routing table for this VPC. + IsDefault *bool `json:"is_default" validate:"required"` + + // The lifecycle state of the routing table. + LifecycleState *string `json:"lifecycle_state" validate:"required"` + + // The name for this routing table. The name is unique across all routing tables for the VPC. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // Indicates whether this routing table is used to route traffic that originates from + // [Direct Link](https://cloud.ibm.com/docs/dl) to this VPC. + // + // Incoming traffic will be routed according to the routing table with one exception: routes with an `action` of + // `deliver` are treated as `drop` unless the `next_hop` is an IP address in a subnet in the route's `zone` that is + // able to accept traffic. Therefore, if an incoming packet matches a route with a `next_hop` of a VPN gateway + // connection, the packet will be dropped. + RouteDirectLinkIngress *bool `json:"route_direct_link_ingress" validate:"required"` + + // Indicates whether this routing table is used to route traffic that originates from the internet. + // + // Incoming traffic will be routed according to the routing table with two exceptions: + // - Traffic destined for IP addresses associated with public gateways will not be + // subject to routes in this routing table. + // - Routes with an `action` of `deliver` are treated as `drop` unless the `next_hop` is + // an IP address in a subnet in the route's `zone` that is able to accept traffic. + // Therefore, if an incoming packet matches a route with a `next_hop` of a VPN gateway + // connection, the packet will be dropped. + RouteInternetIngress *bool `json:"route_internet_ingress" validate:"required"` + + // Indicates whether this routing table is used to route traffic that originates from from [Transit + // Gateway](https://cloud.ibm.com/docs/transit-gateway) to this VPC. + // + // Incoming traffic will be routed according to the routing table with one exception: routes with an `action` of + // `deliver` are treated as `drop` unless the `next_hop` is an IP address in a subnet in the route's `zone` that is + // able to accept traffic. Therefore, if an incoming packet matches a route with a `next_hop` of a VPN gateway + // connection, the packet will be dropped. + RouteTransitGatewayIngress *bool `json:"route_transit_gateway_ingress" validate:"required"` + + // Indicates whether this routing table is used to route traffic that originates from subnets in other zones in this + // VPC. + // + // Incoming traffic will be routed according to the routing table with one exception: routes with an `action` of + // `deliver` are treated as `drop` unless the `next_hop` is an IP address in a subnet in the route's `zone` that is + // able to accept traffic. Therefore, if an incoming packet matches a route with a `next_hop` of a VPN gateway + // connection, the packet will be dropped. + RouteVPCZoneIngress *bool `json:"route_vpc_zone_ingress" validate:"required"` + + // The routes for this routing table. + Routes []RouteReference `json:"routes" validate:"required"` + + // The subnets to which this routing table is attached. + Subnets []SubnetReference `json:"subnets" validate:"required"` +} + +// Constants associated with the RoutingTable.LifecycleState property. +// The lifecycle state of the routing table. +const ( + RoutingTableLifecycleStateDeletingConst = "deleting" + RoutingTableLifecycleStateFailedConst = "failed" + RoutingTableLifecycleStatePendingConst = "pending" + RoutingTableLifecycleStateStableConst = "stable" + RoutingTableLifecycleStateSuspendedConst = "suspended" + RoutingTableLifecycleStateUpdatingConst = "updating" + RoutingTableLifecycleStateWaitingConst = "waiting" +) + +// Constants associated with the RoutingTable.ResourceType property. +// The resource type. +const ( + RoutingTableResourceTypeRoutingTableConst = "routing_table" +) + +// UnmarshalRoutingTable unmarshals an instance of RoutingTable from the specified map of raw messages. +func UnmarshalRoutingTable(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RoutingTable) + err = core.UnmarshalModel(m, "accept_routes_from", &obj.AcceptRoutesFrom, UnmarshalResourceFilter) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "is_default", &obj.IsDefault) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "lifecycle_state", &obj.LifecycleState) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "route_direct_link_ingress", &obj.RouteDirectLinkIngress) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "route_internet_ingress", &obj.RouteInternetIngress) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "route_transit_gateway_ingress", &obj.RouteTransitGatewayIngress) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "route_vpc_zone_ingress", &obj.RouteVPCZoneIngress) + if err != nil { + return + } + err = core.UnmarshalModel(m, "routes", &obj.Routes, UnmarshalRouteReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnets", &obj.Subnets, UnmarshalSubnetReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RoutingTableCollection : RoutingTableCollection struct +type RoutingTableCollection struct { + // A link to the first page of resources. + First *RoutingTableCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *RoutingTableCollectionNext `json:"next,omitempty"` + + // Collection of routing tables. + RoutingTables []RoutingTable `json:"routing_tables" validate:"required"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalRoutingTableCollection unmarshals an instance of RoutingTableCollection from the specified map of raw messages. +func UnmarshalRoutingTableCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RoutingTableCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalRoutingTableCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalRoutingTableCollectionNext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "routing_tables", &obj.RoutingTables, UnmarshalRoutingTable) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *RoutingTableCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// RoutingTableCollectionFirst : A link to the first page of resources. +type RoutingTableCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalRoutingTableCollectionFirst unmarshals an instance of RoutingTableCollectionFirst from the specified map of raw messages. +func UnmarshalRoutingTableCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RoutingTableCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RoutingTableCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type RoutingTableCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalRoutingTableCollectionNext unmarshals an instance of RoutingTableCollectionNext from the specified map of raw messages. +func UnmarshalRoutingTableCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RoutingTableCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RoutingTableIdentity : Identifies a routing table by a unique property. +// Models which "extend" this model: +// - RoutingTableIdentityByID +// - RoutingTableIdentityByHref +type RoutingTableIdentity struct { + // The unique identifier for this routing table. + ID *string `json:"id,omitempty"` + + // The URL for this routing table. + Href *string `json:"href,omitempty"` +} + +func (*RoutingTableIdentity) isaRoutingTableIdentity() bool { + return true +} + +type RoutingTableIdentityIntf interface { + isaRoutingTableIdentity() bool +} + +// UnmarshalRoutingTableIdentity unmarshals an instance of RoutingTableIdentity from the specified map of raw messages. +func UnmarshalRoutingTableIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RoutingTableIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RoutingTablePatch : RoutingTablePatch struct +type RoutingTablePatch struct { + // The filters specifying the resources that may create routes in this routing table + // (replacing any existing filters). All routes created by resources that match a given filter will be removed when an + // existing filter is removed. Therefore, if an empty array is specified, all filters will be removed, resulting in all + // routes not directly created by the user being removed. + // + // At present, only the `resource_type` filter is permitted, and only the `vpn_server` value is supported, but filter + // support is expected to expand in the future. + AcceptRoutesFrom []ResourceFilter `json:"accept_routes_from,omitempty"` + + // The name for this routing table. The name must not be used by another routing table in the VPC. + Name *string `json:"name,omitempty"` + + // Indicates whether this routing table is used to route traffic that originates from + // [Direct Link](https://cloud.ibm.com/docs/dl/) to this VPC. Updating to `true` selects this routing table, provided + // no other routing table in the VPC already has this property set to `true`, and no subnets are attached to this + // routing table. Updating to + // `false` deselects this routing table. + // + // Incoming traffic will be routed according to the routing table with one exception: routes with an `action` of + // `deliver` are treated as `drop` unless the `next_hop` is an IP address in a subnet in the route's `zone` that is + // able to accept traffic. Therefore, if an incoming packet matches a route with a `next_hop` of a VPN gateway + // connection, the packet will be dropped. + RouteDirectLinkIngress *bool `json:"route_direct_link_ingress,omitempty"` + + // Indicates whether this routing table is used to route traffic that originates from the internet. Updating to `true` + // selects this routing table, provided no other routing table in the VPC already has this property set to `true`. + // Updating to `false` deselects this routing table. + // + // Incoming traffic will be routed according to the routing table with two exceptions: + // - Traffic destined for IP addresses associated with public gateways will not be subject + // to routes in this routing table. + // - Routes with an `action` of `deliver` are treated as `drop` unless the `next_hop` is an + // IP address in a subnet in the route's `zone` that is able to accept traffic. + // Therefore, if an incoming packet matches a route with a `next_hop` of a VPN gateway + // connection, the packet will be dropped. + RouteInternetIngress *bool `json:"route_internet_ingress,omitempty"` + + // Indicates whether this routing table is used to route traffic that originates from + // [Transit Gateway](https://cloud.ibm.com/docs/transit-gateway) to this VPC. Updating to + // `true` selects this routing table, provided no other routing table in the VPC already has this property set to + // `true`, and no subnets are attached to this routing table. Updating to `false` deselects this routing table. + // + // Incoming traffic will be routed according to the routing table with one exception: routes with an `action` of + // `deliver` are treated as `drop` unless the `next_hop` is an IP address in a subnet in the route's `zone` that is + // able to accept traffic. Therefore, if an incoming packet matches a route with a `next_hop` of a VPN gateway + // connection, the packet will be dropped. + // + // If [Classic Access](https://cloud.ibm.com/docs/vpc?topic=vpc-setting-up-access-to-classic-infrastructure) is enabled + // for this VPC, and this property is set to `true`, its incoming traffic will also be routed according to this routing + // table. + RouteTransitGatewayIngress *bool `json:"route_transit_gateway_ingress,omitempty"` + + // Indicates whether this routing table is used to route traffic that originates from subnets in other zones in this + // VPC. Updating to `true` selects this routing table, provided no other routing table in the VPC already has this + // property set to `true`, and no subnets are attached to this routing table. Updating to `false` deselects this + // routing table. + // + // Incoming traffic will be routed according to the routing table with one exception: routes with an `action` of + // `deliver` are treated as `drop` unless the `next_hop` is an IP address in a subnet in the route's `zone` that is + // able to accept traffic. Therefore, if an incoming packet matches a route with a `next_hop` of a VPN gateway + // connection, the packet will be dropped. + RouteVPCZoneIngress *bool `json:"route_vpc_zone_ingress,omitempty"` +} + +// UnmarshalRoutingTablePatch unmarshals an instance of RoutingTablePatch from the specified map of raw messages. +func UnmarshalRoutingTablePatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RoutingTablePatch) + err = core.UnmarshalModel(m, "accept_routes_from", &obj.AcceptRoutesFrom, UnmarshalResourceFilter) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "route_direct_link_ingress", &obj.RouteDirectLinkIngress) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "route_internet_ingress", &obj.RouteInternetIngress) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "route_transit_gateway_ingress", &obj.RouteTransitGatewayIngress) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "route_vpc_zone_ingress", &obj.RouteVPCZoneIngress) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the RoutingTablePatch +func (routingTablePatch *RoutingTablePatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(routingTablePatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// RoutingTableReference : RoutingTableReference struct +type RoutingTableReference struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *RoutingTableReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this routing table. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this routing table. + ID *string `json:"id" validate:"required"` + + // The name for this routing table. The name is unique across all routing tables for the VPC. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the RoutingTableReference.ResourceType property. +// The resource type. +const ( + RoutingTableReferenceResourceTypeRoutingTableConst = "routing_table" +) + +// UnmarshalRoutingTableReference unmarshals an instance of RoutingTableReference from the specified map of raw messages. +func UnmarshalRoutingTableReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RoutingTableReference) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalRoutingTableReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RoutingTableReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type RoutingTableReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalRoutingTableReferenceDeleted unmarshals an instance of RoutingTableReferenceDeleted from the specified map of raw messages. +func UnmarshalRoutingTableReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RoutingTableReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroup : SecurityGroup struct +type SecurityGroup struct { + // The date and time that this security group was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The security group's CRN. + CRN *string `json:"crn" validate:"required"` + + // The security group's canonical URL. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this security group. + ID *string `json:"id" validate:"required"` + + // The name for this security group. The name is unique across all security groups for the VPC. + Name *string `json:"name" validate:"required"` + + // The resource group for this security group. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The rules for this security group. If no rules exist, all traffic will be denied. + Rules []SecurityGroupRuleIntf `json:"rules" validate:"required"` + + // The targets for this security group. + Targets []SecurityGroupTargetReferenceIntf `json:"targets" validate:"required"` + + // The VPC this security group resides in. + VPC *VPCReference `json:"vpc" validate:"required"` +} + +// UnmarshalSecurityGroup unmarshals an instance of SecurityGroup from the specified map of raw messages. +func UnmarshalSecurityGroup(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroup) + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "rules", &obj.Rules, UnmarshalSecurityGroupRule) + if err != nil { + return + } + err = core.UnmarshalModel(m, "targets", &obj.Targets, UnmarshalSecurityGroupTargetReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupCollection : SecurityGroupCollection struct +type SecurityGroupCollection struct { + // A link to the first page of resources. + First *SecurityGroupCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *SecurityGroupCollectionNext `json:"next,omitempty"` + + // Collection of security groups. + SecurityGroups []SecurityGroup `json:"security_groups" validate:"required"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalSecurityGroupCollection unmarshals an instance of SecurityGroupCollection from the specified map of raw messages. +func UnmarshalSecurityGroupCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalSecurityGroupCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalSecurityGroupCollectionNext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "security_groups", &obj.SecurityGroups, UnmarshalSecurityGroup) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *SecurityGroupCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// SecurityGroupCollectionFirst : A link to the first page of resources. +type SecurityGroupCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalSecurityGroupCollectionFirst unmarshals an instance of SecurityGroupCollectionFirst from the specified map of raw messages. +func UnmarshalSecurityGroupCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type SecurityGroupCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalSecurityGroupCollectionNext unmarshals an instance of SecurityGroupCollectionNext from the specified map of raw messages. +func UnmarshalSecurityGroupCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupIdentity : Identifies a security group by a unique property. +// Models which "extend" this model: +// - SecurityGroupIdentityByID +// - SecurityGroupIdentityByCRN +// - SecurityGroupIdentityByHref +type SecurityGroupIdentity struct { + // The unique identifier for this security group. + ID *string `json:"id,omitempty"` + + // The security group's CRN. + CRN *string `json:"crn,omitempty"` + + // The security group's canonical URL. + Href *string `json:"href,omitempty"` +} + +func (*SecurityGroupIdentity) isaSecurityGroupIdentity() bool { + return true +} + +type SecurityGroupIdentityIntf interface { + isaSecurityGroupIdentity() bool +} + +// UnmarshalSecurityGroupIdentity unmarshals an instance of SecurityGroupIdentity from the specified map of raw messages. +func UnmarshalSecurityGroupIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupPatch : SecurityGroupPatch struct +type SecurityGroupPatch struct { + // The name for this security group. The name must not be used by another security group for the VPC. + Name *string `json:"name,omitempty"` +} + +// UnmarshalSecurityGroupPatch unmarshals an instance of SecurityGroupPatch from the specified map of raw messages. +func UnmarshalSecurityGroupPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupPatch) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the SecurityGroupPatch +func (securityGroupPatch *SecurityGroupPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(securityGroupPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// SecurityGroupReference : SecurityGroupReference struct +type SecurityGroupReference struct { + // The security group's CRN. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *SecurityGroupReferenceDeleted `json:"deleted,omitempty"` + + // The security group's canonical URL. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this security group. + ID *string `json:"id" validate:"required"` + + // The name for this security group. The name is unique across all security groups for the VPC. + Name *string `json:"name" validate:"required"` +} + +// UnmarshalSecurityGroupReference unmarshals an instance of SecurityGroupReference from the specified map of raw messages. +func UnmarshalSecurityGroupReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalSecurityGroupReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type SecurityGroupReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalSecurityGroupReferenceDeleted unmarshals an instance of SecurityGroupReferenceDeleted from the specified map of raw messages. +func UnmarshalSecurityGroupReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupRule : SecurityGroupRule struct +// Models which "extend" this model: +// - SecurityGroupRuleSecurityGroupRuleProtocolAll +// - SecurityGroupRuleSecurityGroupRuleProtocolIcmp +// - SecurityGroupRuleSecurityGroupRuleProtocolTcpudp +type SecurityGroupRule struct { + // The direction of traffic to enforce. + Direction *string `json:"direction" validate:"required"` + + // The URL for this security group rule. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this security group rule. + ID *string `json:"id" validate:"required"` + + // The IP version to enforce. The format of `remote.address` or `remote.cidr_block` must match this property, if they + // are used. Alternatively, if `remote` references a security group, then this rule only applies to IP addresses + // (network interfaces) in that group matching this IP version. + IPVersion *string `json:"ip_version" validate:"required"` + + // The protocol to enforce. + Protocol *string `json:"protocol" validate:"required"` + + // The remote IP addresses or security groups from which this rule allows traffic (or to + // which, for outbound rules). A CIDR block of `0.0.0.0/0` allows traffic from any source + // (or to any destination, for outbound rules). + Remote SecurityGroupRuleRemoteIntf `json:"remote" validate:"required"` + + // The ICMP traffic code to allow. If absent, all codes are allowed. + Code *int64 `json:"code,omitempty"` + + // The ICMP traffic type to allow. If absent, all types are allowed. + Type *int64 `json:"type,omitempty"` + + // The inclusive upper bound of TCP/UDP destination port range. + PortMax *int64 `json:"port_max,omitempty"` + + // The inclusive lower bound of TCP/UDP destination port range. + PortMin *int64 `json:"port_min,omitempty"` +} + +// Constants associated with the SecurityGroupRule.Direction property. +// The direction of traffic to enforce. +const ( + SecurityGroupRuleDirectionInboundConst = "inbound" + SecurityGroupRuleDirectionOutboundConst = "outbound" +) + +// Constants associated with the SecurityGroupRule.IPVersion property. +// The IP version to enforce. The format of `remote.address` or `remote.cidr_block` must match this property, if they +// are used. Alternatively, if `remote` references a security group, then this rule only applies to IP addresses +// (network interfaces) in that group matching this IP version. +const ( + SecurityGroupRuleIPVersionIpv4Const = "ipv4" +) + +// Constants associated with the SecurityGroupRule.Protocol property. +// The protocol to enforce. +const ( + SecurityGroupRuleProtocolAllConst = "all" + SecurityGroupRuleProtocolIcmpConst = "icmp" + SecurityGroupRuleProtocolTCPConst = "tcp" + SecurityGroupRuleProtocolUDPConst = "udp" +) + +func (*SecurityGroupRule) isaSecurityGroupRule() bool { + return true +} + +type SecurityGroupRuleIntf interface { + isaSecurityGroupRule() bool +} + +// UnmarshalSecurityGroupRule unmarshals an instance of SecurityGroupRule from the specified map of raw messages. +func UnmarshalSecurityGroupRule(m map[string]json.RawMessage, result interface{}) (err error) { + // Retrieve discriminator value to determine correct "subclass". + var discValue string + err = core.UnmarshalPrimitive(m, "protocol", &discValue) + if err != nil { + err = fmt.Errorf("error unmarshalling discriminator property 'protocol': %s", err.Error()) + return + } + if discValue == "" { + err = fmt.Errorf("required discriminator property 'protocol' not found in JSON object") + return + } + if discValue == "all" { + err = core.UnmarshalModel(m, "", result, UnmarshalSecurityGroupRuleSecurityGroupRuleProtocolAll) + } else if discValue == "icmp" { + err = core.UnmarshalModel(m, "", result, UnmarshalSecurityGroupRuleSecurityGroupRuleProtocolIcmp) + } else if discValue == "tcp" { + err = core.UnmarshalModel(m, "", result, UnmarshalSecurityGroupRuleSecurityGroupRuleProtocolTcpudp) + } else if discValue == "udp" { + err = core.UnmarshalModel(m, "", result, UnmarshalSecurityGroupRuleSecurityGroupRuleProtocolTcpudp) + } else { + err = fmt.Errorf("unrecognized value for discriminator property 'protocol': %s", discValue) + } + return +} + +// SecurityGroupRuleCollection : Collection of rules in a security group. +type SecurityGroupRuleCollection struct { + // Array of rules. + Rules []SecurityGroupRuleIntf `json:"rules" validate:"required"` +} + +// UnmarshalSecurityGroupRuleCollection unmarshals an instance of SecurityGroupRuleCollection from the specified map of raw messages. +func UnmarshalSecurityGroupRuleCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupRuleCollection) + err = core.UnmarshalModel(m, "rules", &obj.Rules, UnmarshalSecurityGroupRule) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupRulePatch : SecurityGroupRulePatch struct +type SecurityGroupRulePatch struct { + // The ICMP traffic code to allow. If set, `type` must also be set. + // + // Specify `null` to remove an existing ICMP traffic code. + Code *int64 `json:"code,omitempty"` + + // The direction of traffic to enforce. + Direction *string `json:"direction,omitempty"` + + // The IP version to enforce. The format of `remote.address` or `remote.cidr_block` must match this property, if they + // are used. Alternatively, if `remote` references a security group, then this rule only applies to IP addresses + // (network interfaces) in that group matching this IP version. + IPVersion *string `json:"ip_version,omitempty"` + + // The inclusive upper bound of the protocol destination port range. If set, `port_min` must also be set, and must not + // be larger. + // + // Specify `null` to remove an existing upper bound. + PortMax *int64 `json:"port_max,omitempty"` + + // The inclusive lower bound of the protocol destination port range. If set, `port_max` must also be set, and must not + // be smaller. + // + // Specify `null` to remove an existing lower bound. + PortMin *int64 `json:"port_min,omitempty"` + + // The remote IP addresses or security groups from which this rule will allow traffic (or to + // which, for outbound rules). Can be specified as an IP address, a CIDR block, or a + // security group. A CIDR block of `0.0.0.0/0` will allow traffic from any source (or to + // any destination, for outbound rules). + Remote SecurityGroupRuleRemotePatchIntf `json:"remote,omitempty"` + + // The ICMP traffic type to allow. + // + // Specify `null` to remove an existing ICMP traffic type value. + Type *int64 `json:"type,omitempty"` +} + +// Constants associated with the SecurityGroupRulePatch.Direction property. +// The direction of traffic to enforce. +const ( + SecurityGroupRulePatchDirectionInboundConst = "inbound" + SecurityGroupRulePatchDirectionOutboundConst = "outbound" +) + +// Constants associated with the SecurityGroupRulePatch.IPVersion property. +// The IP version to enforce. The format of `remote.address` or `remote.cidr_block` must match this property, if they +// are used. Alternatively, if `remote` references a security group, then this rule only applies to IP addresses +// (network interfaces) in that group matching this IP version. +const ( + SecurityGroupRulePatchIPVersionIpv4Const = "ipv4" +) + +// UnmarshalSecurityGroupRulePatch unmarshals an instance of SecurityGroupRulePatch from the specified map of raw messages. +func UnmarshalSecurityGroupRulePatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupRulePatch) + err = core.UnmarshalPrimitive(m, "code", &obj.Code) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "direction", &obj.Direction) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "ip_version", &obj.IPVersion) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "port_max", &obj.PortMax) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "port_min", &obj.PortMin) + if err != nil { + return + } + err = core.UnmarshalModel(m, "remote", &obj.Remote, UnmarshalSecurityGroupRuleRemotePatch) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the SecurityGroupRulePatch +func (securityGroupRulePatch *SecurityGroupRulePatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(securityGroupRulePatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// SecurityGroupRulePrototype : SecurityGroupRulePrototype struct +// Models which "extend" this model: +// - SecurityGroupRulePrototypeSecurityGroupRuleProtocolAll +// - SecurityGroupRulePrototypeSecurityGroupRuleProtocolIcmp +// - SecurityGroupRulePrototypeSecurityGroupRuleProtocolTcpudp +type SecurityGroupRulePrototype struct { + // The direction of traffic to enforce. + Direction *string `json:"direction" validate:"required"` + + // The IP version to enforce. The format of `remote.address` or `remote.cidr_block` must match this property, if they + // are used. Alternatively, if `remote` references a security group, then this rule only applies to IP addresses + // (network interfaces) in that group matching this IP version. + IPVersion *string `json:"ip_version,omitempty"` + + // The protocol to enforce. + Protocol *string `json:"protocol" validate:"required"` + + // The remote IP addresses or security groups from which this rule will allow traffic (or to + // which, for outbound rules). Can be specified as an IP address, a CIDR block, or a + // security group within the VPC. + // + // If unspecified, a CIDR block of `0.0.0.0/0` will be used to allow traffic from any source + // (or to any destination, for outbound rules). + Remote SecurityGroupRuleRemotePrototypeIntf `json:"remote,omitempty"` + + // The ICMP traffic code to allow. + // + // If specified, `type` must also be specified. If unspecified, all codes are allowed. + Code *int64 `json:"code,omitempty"` + + // The ICMP traffic type to allow. + // + // If unspecified, all types are allowed. + Type *int64 `json:"type,omitempty"` + + // The inclusive upper bound of TCP/UDP destination port range. + // + // If specified, `port_min` must also be specified, and must not be larger. If unspecified, + // `port_min` must also be unspecified, allowing traffic on all destination ports. + PortMax *int64 `json:"port_max,omitempty"` + + // The inclusive lower bound of TCP/UDP destination port range + // + // If specified, `port_max` must also be specified, and must not be smaller. If unspecified, `port_max` must also be + // unspecified, allowing traffic on all destination ports. + PortMin *int64 `json:"port_min,omitempty"` +} + +// Constants associated with the SecurityGroupRulePrototype.Direction property. +// The direction of traffic to enforce. +const ( + SecurityGroupRulePrototypeDirectionInboundConst = "inbound" + SecurityGroupRulePrototypeDirectionOutboundConst = "outbound" +) + +// Constants associated with the SecurityGroupRulePrototype.IPVersion property. +// The IP version to enforce. The format of `remote.address` or `remote.cidr_block` must match this property, if they +// are used. Alternatively, if `remote` references a security group, then this rule only applies to IP addresses +// (network interfaces) in that group matching this IP version. +const ( + SecurityGroupRulePrototypeIPVersionIpv4Const = "ipv4" +) + +// Constants associated with the SecurityGroupRulePrototype.Protocol property. +// The protocol to enforce. +const ( + SecurityGroupRulePrototypeProtocolAllConst = "all" + SecurityGroupRulePrototypeProtocolIcmpConst = "icmp" + SecurityGroupRulePrototypeProtocolTCPConst = "tcp" + SecurityGroupRulePrototypeProtocolUDPConst = "udp" +) + +func (*SecurityGroupRulePrototype) isaSecurityGroupRulePrototype() bool { + return true +} + +type SecurityGroupRulePrototypeIntf interface { + isaSecurityGroupRulePrototype() bool +} + +// UnmarshalSecurityGroupRulePrototype unmarshals an instance of SecurityGroupRulePrototype from the specified map of raw messages. +func UnmarshalSecurityGroupRulePrototype(m map[string]json.RawMessage, result interface{}) (err error) { + // Retrieve discriminator value to determine correct "subclass". + var discValue string + err = core.UnmarshalPrimitive(m, "protocol", &discValue) + if err != nil { + err = fmt.Errorf("error unmarshalling discriminator property 'protocol': %s", err.Error()) + return + } + if discValue == "" { + err = fmt.Errorf("required discriminator property 'protocol' not found in JSON object") + return + } + if discValue == "all" { + err = core.UnmarshalModel(m, "", result, UnmarshalSecurityGroupRulePrototypeSecurityGroupRuleProtocolAll) + } else if discValue == "icmp" { + err = core.UnmarshalModel(m, "", result, UnmarshalSecurityGroupRulePrototypeSecurityGroupRuleProtocolIcmp) + } else if discValue == "tcp" { + err = core.UnmarshalModel(m, "", result, UnmarshalSecurityGroupRulePrototypeSecurityGroupRuleProtocolTcpudp) + } else if discValue == "udp" { + err = core.UnmarshalModel(m, "", result, UnmarshalSecurityGroupRulePrototypeSecurityGroupRuleProtocolTcpudp) + } else { + err = fmt.Errorf("unrecognized value for discriminator property 'protocol': %s", discValue) + } + return +} + +// SecurityGroupRuleRemote : The remote IP addresses or security groups from which this rule allows traffic (or to which, for outbound rules). A +// CIDR block of `0.0.0.0/0` allows traffic from any source +// (or to any destination, for outbound rules). +// Models which "extend" this model: +// - SecurityGroupRuleRemoteIP +// - SecurityGroupRuleRemoteCIDR +// - SecurityGroupRuleRemoteSecurityGroupReference +type SecurityGroupRuleRemote struct { + // The IP address. + // + // This property may add support for IPv6 addresses in the future. When processing a value in this property, verify + // that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the + // error, or bypass the resource on which the unexpected IP address format was encountered. + Address *string `json:"address,omitempty"` + + // The CIDR block. This property may add support for IPv6 CIDR blocks in the future. When processing a value in this + // property, verify that the CIDR block is in an expected format. If it is not, log an error. Optionally halt + // processing and surface the error, or bypass the resource on which the unexpected CIDR block format was encountered. + CIDRBlock *string `json:"cidr_block,omitempty"` + + // The security group's CRN. + CRN *string `json:"crn,omitempty"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *SecurityGroupReferenceDeleted `json:"deleted,omitempty"` + + // The security group's canonical URL. + Href *string `json:"href,omitempty"` + + // The unique identifier for this security group. + ID *string `json:"id,omitempty"` + + // The name for this security group. The name is unique across all security groups for the VPC. + Name *string `json:"name,omitempty"` +} + +func (*SecurityGroupRuleRemote) isaSecurityGroupRuleRemote() bool { + return true +} + +type SecurityGroupRuleRemoteIntf interface { + isaSecurityGroupRuleRemote() bool +} + +// UnmarshalSecurityGroupRuleRemote unmarshals an instance of SecurityGroupRuleRemote from the specified map of raw messages. +func UnmarshalSecurityGroupRuleRemote(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupRuleRemote) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "cidr_block", &obj.CIDRBlock) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalSecurityGroupReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupRuleRemotePatch : The remote IP addresses or security groups from which this rule will allow traffic (or to which, for outbound rules). +// Can be specified as an IP address, a CIDR block, or a security group. A CIDR block of `0.0.0.0/0` will allow traffic +// from any source (or to any destination, for outbound rules). +// Models which "extend" this model: +// - SecurityGroupRuleRemotePatchIP +// - SecurityGroupRuleRemotePatchCIDR +// - SecurityGroupRuleRemotePatchSecurityGroupIdentity +type SecurityGroupRuleRemotePatch struct { + // The IP address. + // + // This property may add support for IPv6 addresses in the future. When processing a value in this property, verify + // that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the + // error, or bypass the resource on which the unexpected IP address format was encountered. + Address *string `json:"address,omitempty"` + + // The CIDR block. This property may add support for IPv6 CIDR blocks in the future. When processing a value in this + // property, verify that the CIDR block is in an expected format. If it is not, log an error. Optionally halt + // processing and surface the error, or bypass the resource on which the unexpected CIDR block format was encountered. + CIDRBlock *string `json:"cidr_block,omitempty"` + + // The unique identifier for this security group. + ID *string `json:"id,omitempty"` + + // The security group's CRN. + CRN *string `json:"crn,omitempty"` + + // The security group's canonical URL. + Href *string `json:"href,omitempty"` +} + +func (*SecurityGroupRuleRemotePatch) isaSecurityGroupRuleRemotePatch() bool { + return true +} + +type SecurityGroupRuleRemotePatchIntf interface { + isaSecurityGroupRuleRemotePatch() bool +} + +// UnmarshalSecurityGroupRuleRemotePatch unmarshals an instance of SecurityGroupRuleRemotePatch from the specified map of raw messages. +func UnmarshalSecurityGroupRuleRemotePatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupRuleRemotePatch) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "cidr_block", &obj.CIDRBlock) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupRuleRemotePrototype : The remote IP addresses or security groups from which this rule will allow traffic (or to which, for outbound rules). +// Can be specified as an IP address, a CIDR block, or a security group within the VPC. +// +// If unspecified, a CIDR block of `0.0.0.0/0` will be used to allow traffic from any source +// (or to any destination, for outbound rules). +// Models which "extend" this model: +// - SecurityGroupRuleRemotePrototypeIP +// - SecurityGroupRuleRemotePrototypeCIDR +// - SecurityGroupRuleRemotePrototypeSecurityGroupIdentity +type SecurityGroupRuleRemotePrototype struct { + // The IP address. + // + // This property may add support for IPv6 addresses in the future. When processing a value in this property, verify + // that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the + // error, or bypass the resource on which the unexpected IP address format was encountered. + Address *string `json:"address,omitempty"` + + // The CIDR block. This property may add support for IPv6 CIDR blocks in the future. When processing a value in this + // property, verify that the CIDR block is in an expected format. If it is not, log an error. Optionally halt + // processing and surface the error, or bypass the resource on which the unexpected CIDR block format was encountered. + CIDRBlock *string `json:"cidr_block,omitempty"` + + // The unique identifier for this security group. + ID *string `json:"id,omitempty"` + + // The security group's CRN. + CRN *string `json:"crn,omitempty"` + + // The security group's canonical URL. + Href *string `json:"href,omitempty"` +} + +func (*SecurityGroupRuleRemotePrototype) isaSecurityGroupRuleRemotePrototype() bool { + return true +} + +type SecurityGroupRuleRemotePrototypeIntf interface { + isaSecurityGroupRuleRemotePrototype() bool +} + +// UnmarshalSecurityGroupRuleRemotePrototype unmarshals an instance of SecurityGroupRuleRemotePrototype from the specified map of raw messages. +func UnmarshalSecurityGroupRuleRemotePrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupRuleRemotePrototype) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "cidr_block", &obj.CIDRBlock) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupTargetCollection : SecurityGroupTargetCollection struct +type SecurityGroupTargetCollection struct { + // A link to the first page of resources. + First *SecurityGroupTargetCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *SecurityGroupTargetCollectionNext `json:"next,omitempty"` + + // Collection of targets for this security group. + Targets []SecurityGroupTargetReferenceIntf `json:"targets" validate:"required"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalSecurityGroupTargetCollection unmarshals an instance of SecurityGroupTargetCollection from the specified map of raw messages. +func UnmarshalSecurityGroupTargetCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupTargetCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalSecurityGroupTargetCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalSecurityGroupTargetCollectionNext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "targets", &obj.Targets, UnmarshalSecurityGroupTargetReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *SecurityGroupTargetCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// SecurityGroupTargetCollectionFirst : A link to the first page of resources. +type SecurityGroupTargetCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalSecurityGroupTargetCollectionFirst unmarshals an instance of SecurityGroupTargetCollectionFirst from the specified map of raw messages. +func UnmarshalSecurityGroupTargetCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupTargetCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupTargetCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type SecurityGroupTargetCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalSecurityGroupTargetCollectionNext unmarshals an instance of SecurityGroupTargetCollectionNext from the specified map of raw messages. +func UnmarshalSecurityGroupTargetCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupTargetCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupTargetReference : The resource types that can be security group targets are expected to expand in the future. When iterating over +// security group targets, do not assume that every target resource will be from a known set of resource types. +// Optionally halt processing and surface an error, or bypass resources of unrecognized types. +// Models which "extend" this model: +// - SecurityGroupTargetReferenceNetworkInterfaceReferenceTargetContext +// - SecurityGroupTargetReferenceBareMetalServerNetworkInterfaceReferenceTargetContext +// - SecurityGroupTargetReferenceLoadBalancerReference +// - SecurityGroupTargetReferenceEndpointGatewayReference +// - SecurityGroupTargetReferenceVPNServerReference +// - SecurityGroupTargetReferenceVirtualNetworkInterfaceReference +type SecurityGroupTargetReference struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *NetworkInterfaceReferenceTargetContextDeleted `json:"deleted,omitempty"` + + // The URL for this instance network interface. + Href *string `json:"href,omitempty"` + + // The unique identifier for this instance network interface. + ID *string `json:"id,omitempty"` + + // The name for this instance network interface. + Name *string `json:"name,omitempty"` + + // The resource type. + ResourceType *string `json:"resource_type,omitempty"` + + // The load balancer's CRN. + CRN *string `json:"crn,omitempty"` + + // The primary IP for this virtual network interface. + PrimaryIP *ReservedIPReference `json:"primary_ip,omitempty"` + + // The associated subnet. + Subnet *SubnetReference `json:"subnet,omitempty"` +} + +// Constants associated with the SecurityGroupTargetReference.ResourceType property. +// The resource type. +const ( + SecurityGroupTargetReferenceResourceTypeNetworkInterfaceConst = "network_interface" +) + +func (*SecurityGroupTargetReference) isaSecurityGroupTargetReference() bool { + return true +} + +type SecurityGroupTargetReferenceIntf interface { + isaSecurityGroupTargetReference() bool +} + +// UnmarshalSecurityGroupTargetReference unmarshals an instance of SecurityGroupTargetReference from the specified map of raw messages. +func UnmarshalSecurityGroupTargetReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupTargetReference) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalNetworkInterfaceReferenceTargetContextDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_ip", &obj.PrimaryIP, UnmarshalReservedIPReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnet", &obj.Subnet, UnmarshalSubnetReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SetSubnetPublicGatewayOptions : The SetSubnetPublicGateway options. +type SetSubnetPublicGatewayOptions struct { + // The subnet identifier. + ID *string `json:"id" validate:"required,ne="` + + // The public gateway identity. + PublicGatewayIdentity PublicGatewayIdentityIntf `json:"PublicGatewayIdentity" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewSetSubnetPublicGatewayOptions : Instantiate SetSubnetPublicGatewayOptions +func (*VpcV1) NewSetSubnetPublicGatewayOptions(id string, publicGatewayIdentity PublicGatewayIdentityIntf) *SetSubnetPublicGatewayOptions { + return &SetSubnetPublicGatewayOptions{ + ID: core.StringPtr(id), + PublicGatewayIdentity: publicGatewayIdentity, + } +} + +// SetID : Allow user to set ID +func (_options *SetSubnetPublicGatewayOptions) SetID(id string) *SetSubnetPublicGatewayOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetPublicGatewayIdentity : Allow user to set PublicGatewayIdentity +func (_options *SetSubnetPublicGatewayOptions) SetPublicGatewayIdentity(publicGatewayIdentity PublicGatewayIdentityIntf) *SetSubnetPublicGatewayOptions { + _options.PublicGatewayIdentity = publicGatewayIdentity + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *SetSubnetPublicGatewayOptions) SetHeaders(param map[string]string) *SetSubnetPublicGatewayOptions { + options.Headers = param + return options +} + +// Share : Share struct +type Share struct { + // The access control mode for the share: + // + // - `security_group`: The security groups on the virtual network interface for a mount + // target control access to the mount target. + // - `vpc`: All clients in the VPC for a mount target have access to the mount target. + // + // The enumerated access control mode values for this property may expand in the future. When processing this property, + // check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which + // the unexpected access control mode was encountered. + AccessControlMode *string `json:"access_control_mode" validate:"required"` + + // The date and time that the file share is created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The CRN for this file share. + CRN *string `json:"crn" validate:"required"` + + // The type of encryption used for this file share. + Encryption *string `json:"encryption" validate:"required"` + + // The key used to encrypt this file share. + // + // This property will be present if `encryption_type` is `user_managed`. + EncryptionKey *EncryptionKeyReference `json:"encryption_key,omitempty"` + + // The URL for this file share. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this file share. + ID *string `json:"id" validate:"required"` + + // The maximum input/output operations per second (IOPS) for the file share. In addition, each client accessing the + // share will be restricted to 48,000 IOPS. + // + // The maximum IOPS for a share may increase in the future. + Iops *int64 `json:"iops" validate:"required"` + + // The latest job associated with this file share. + // + // This property will be absent if no jobs have been created for this file share. + LatestJob *ShareJob `json:"latest_job,omitempty"` + + // The lifecycle state of the file share. + LifecycleState *string `json:"lifecycle_state" validate:"required"` + + // The mount targets for the file share. + MountTargets []ShareMountTargetReference `json:"mount_targets" validate:"required"` + + // The name for this share. The name is unique across all shares in the region. + Name *string `json:"name" validate:"required"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-file-storage-profiles) for + // this file share. + Profile *ShareProfileReference `json:"profile" validate:"required"` + + // The replica file share for this source file share. + // + // This property will be present when the `replication_role` is `source`. + ReplicaShare *ShareReference `json:"replica_share,omitempty"` + + // The cron specification for the file share replication schedule. + // + // This property will be present when the `replication_role` is `replica`. + ReplicationCronSpec *string `json:"replication_cron_spec,omitempty"` + + // The replication role of the file share. + // + // * `none`: This share is not participating in replication. + // * `replica`: This share is a replication target. + // * `source`: This share is a replication source. + ReplicationRole *string `json:"replication_role" validate:"required"` + + // The replication status of the file share. + // + // * `active`: This share is actively participating in replication, and the replica's data is up-to-date with the + // replication schedule. + // * `failover_pending`: This share is performing a replication failover. + // * `initializing`: This share is initializing replication. + // * `none`: This share is not participating in replication. + // * `split_pending`: This share is performing a replication split. + ReplicationStatus *string `json:"replication_status" validate:"required"` + + // The reasons for the current replication status (if any). + // + // The enumerated reason code values for this property will expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the + // unexpected reason code was encountered. + ReplicationStatusReasons []ShareReplicationStatusReason `json:"replication_status_reasons" validate:"required"` + + // The resource group for this file share. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The size of the file share rounded up to the next gigabyte. + // + // The maximum size for a share may increase in the future. + Size *int64 `json:"size" validate:"required"` + + // The source file share for this replica file share. + // + // This property will be present when the `replication_role` is `replica`. + SourceShare *ShareReference `json:"source_share,omitempty"` + + // Tags for this resource. + UserTags []string `json:"user_tags" validate:"required"` + + // The zone this file share will reside in. + Zone *ZoneReference `json:"zone" validate:"required"` +} + +// Constants associated with the Share.AccessControlMode property. +// The access control mode for the share: +// +// - `security_group`: The security groups on the virtual network interface for a mount +// target control access to the mount target. +// - `vpc`: All clients in the VPC for a mount target have access to the mount target. +// +// The enumerated access control mode values for this property may expand in the future. When processing this property, +// check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which +// the unexpected access control mode was encountered. +const ( + ShareAccessControlModeSecurityGroupConst = "security_group" + ShareAccessControlModeVPCConst = "vpc" +) + +// Constants associated with the Share.Encryption property. +// The type of encryption used for this file share. +const ( + ShareEncryptionProviderManagedConst = "provider_managed" + ShareEncryptionUserManagedConst = "user_managed" +) + +// Constants associated with the Share.LifecycleState property. +// The lifecycle state of the file share. +const ( + ShareLifecycleStateDeletingConst = "deleting" + ShareLifecycleStateFailedConst = "failed" + ShareLifecycleStatePendingConst = "pending" + ShareLifecycleStateStableConst = "stable" + ShareLifecycleStateSuspendedConst = "suspended" + ShareLifecycleStateUpdatingConst = "updating" + ShareLifecycleStateWaitingConst = "waiting" +) + +// Constants associated with the Share.ReplicationRole property. +// The replication role of the file share. +// +// * `none`: This share is not participating in replication. +// * `replica`: This share is a replication target. +// * `source`: This share is a replication source. +const ( + ShareReplicationRoleNoneConst = "none" + ShareReplicationRoleReplicaConst = "replica" + ShareReplicationRoleSourceConst = "source" +) + +// Constants associated with the Share.ReplicationStatus property. +// The replication status of the file share. +// +// * `active`: This share is actively participating in replication, and the replica's data is up-to-date with the +// replication schedule. +// * `failover_pending`: This share is performing a replication failover. +// * `initializing`: This share is initializing replication. +// * `none`: This share is not participating in replication. +// * `split_pending`: This share is performing a replication split. +const ( + ShareReplicationStatusActiveConst = "active" + ShareReplicationStatusFailoverPendingConst = "failover_pending" + ShareReplicationStatusInitializingConst = "initializing" + ShareReplicationStatusNoneConst = "none" + ShareReplicationStatusSplitPendingConst = "split_pending" +) + +// Constants associated with the Share.ResourceType property. +// The resource type. +const ( + ShareResourceTypeShareConst = "share" +) + +// UnmarshalShare unmarshals an instance of Share from the specified map of raw messages. +func UnmarshalShare(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(Share) + err = core.UnmarshalPrimitive(m, "access_control_mode", &obj.AccessControlMode) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "encryption", &obj.Encryption) + if err != nil { + return + } + err = core.UnmarshalModel(m, "encryption_key", &obj.EncryptionKey, UnmarshalEncryptionKeyReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "iops", &obj.Iops) + if err != nil { + return + } + err = core.UnmarshalModel(m, "latest_job", &obj.LatestJob, UnmarshalShareJob) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "lifecycle_state", &obj.LifecycleState) + if err != nil { + return + } + err = core.UnmarshalModel(m, "mount_targets", &obj.MountTargets, UnmarshalShareMountTargetReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalShareProfileReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "replica_share", &obj.ReplicaShare, UnmarshalShareReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "replication_cron_spec", &obj.ReplicationCronSpec) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "replication_role", &obj.ReplicationRole) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "replication_status", &obj.ReplicationStatus) + if err != nil { + return + } + err = core.UnmarshalModel(m, "replication_status_reasons", &obj.ReplicationStatusReasons, UnmarshalShareReplicationStatusReason) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "size", &obj.Size) + if err != nil { + return + } + err = core.UnmarshalModel(m, "source_share", &obj.SourceShare, UnmarshalShareReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_tags", &obj.UserTags) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareCollection : ShareCollection struct +type ShareCollection struct { + // A link to the first page of resources. + First *ShareCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *ShareCollectionNext `json:"next,omitempty"` + + // Collection of file shares. + Shares []Share `json:"shares" validate:"required"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalShareCollection unmarshals an instance of ShareCollection from the specified map of raw messages. +func UnmarshalShareCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalShareCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalShareCollectionNext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "shares", &obj.Shares, UnmarshalShare) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *ShareCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// ShareCollectionFirst : A link to the first page of resources. +type ShareCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalShareCollectionFirst unmarshals an instance of ShareCollectionFirst from the specified map of raw messages. +func UnmarshalShareCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type ShareCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalShareCollectionNext unmarshals an instance of ShareCollectionNext from the specified map of raw messages. +func UnmarshalShareCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareIdentity : Identifies a file share by a unique property. +// Models which "extend" this model: +// - ShareIdentityByID +// - ShareIdentityByCRN +// - ShareIdentityByHref +type ShareIdentity struct { + // The unique identifier for this file share. + ID *string `json:"id,omitempty"` + + // The CRN for this file share. + CRN *string `json:"crn,omitempty"` + + // The URL for this file share. + Href *string `json:"href,omitempty"` +} + +func (*ShareIdentity) isaShareIdentity() bool { + return true +} + +type ShareIdentityIntf interface { + isaShareIdentity() bool +} + +// UnmarshalShareIdentity unmarshals an instance of ShareIdentity from the specified map of raw messages. +func UnmarshalShareIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareInitialOwner : ShareInitialOwner struct +type ShareInitialOwner struct { + // The initial group identifier for the file share. + Gid *int64 `json:"gid,omitempty"` + + // The initial user identifier for the file share. + Uid *int64 `json:"uid,omitempty"` +} + +// UnmarshalShareInitialOwner unmarshals an instance of ShareInitialOwner from the specified map of raw messages. +func UnmarshalShareInitialOwner(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareInitialOwner) + err = core.UnmarshalPrimitive(m, "gid", &obj.Gid) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "uid", &obj.Uid) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareJob : ShareJob struct +type ShareJob struct { + // The status of the file share job. + // + // The enumerated values for this property will expand in the future. When processing this property, check for and log + // unknown values. Optionally halt processing and surface the error, or bypass the file share job on which the + // unexpected property value was encountered. + // + // * `cancelled`: This job has been cancelled. + // * `failed`: This job has failed. + // * `queued`: This job is queued. + // * `running`: This job is running. + // * `succeeded`: This job completed successfully. + Status *string `json:"status" validate:"required"` + + // The reasons for the file share job status (if any). + // + // The enumerated reason code values for this property will expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the + // unexpected reason code was encountered. + StatusReasons []ShareJobStatusReason `json:"status_reasons" validate:"required"` + + // The type of the file share job. + // + // The enumerated values for this property will expand in the future. When processing this property, check for and log + // unknown values. Optionally halt processing and surface the error, or bypass the file share job on which the + // unexpected property value was encountered. + // + // * `replication_failover`: This is a share replication failover job. + // * `replication_init`: This is a share replication is initialization job. + // * `replication_split`: This is a share replication split job. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the ShareJob.Status property. +// The status of the file share job. +// +// The enumerated values for this property will expand in the future. When processing this property, check for and log +// unknown values. Optionally halt processing and surface the error, or bypass the file share job on which the +// unexpected property value was encountered. +// +// * `cancelled`: This job has been cancelled. +// * `failed`: This job has failed. +// * `queued`: This job is queued. +// * `running`: This job is running. +// * `succeeded`: This job completed successfully. +const ( + ShareJobStatusCancelledConst = "cancelled" + ShareJobStatusFailedConst = "failed" + ShareJobStatusQueuedConst = "queued" + ShareJobStatusRunningConst = "running" + ShareJobStatusSucceededConst = "succeeded" +) + +// Constants associated with the ShareJob.Type property. +// The type of the file share job. +// +// The enumerated values for this property will expand in the future. When processing this property, check for and log +// unknown values. Optionally halt processing and surface the error, or bypass the file share job on which the +// unexpected property value was encountered. +// +// * `replication_failover`: This is a share replication failover job. +// * `replication_init`: This is a share replication is initialization job. +// * `replication_split`: This is a share replication split job. +const ( + ShareJobTypeReplicationFailoverConst = "replication_failover" + ShareJobTypeReplicationInitConst = "replication_init" + ShareJobTypeReplicationSplitConst = "replication_split" +) + +// UnmarshalShareJob unmarshals an instance of ShareJob from the specified map of raw messages. +func UnmarshalShareJob(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareJob) + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + err = core.UnmarshalModel(m, "status_reasons", &obj.StatusReasons, UnmarshalShareJobStatusReason) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareJobStatusReason : ShareJobStatusReason struct +type ShareJobStatusReason struct { + // A snake case string succinctly identifying the status reason. + Code *string `json:"code" validate:"required"` + + // An explanation of the status reason. + Message *string `json:"message" validate:"required"` + + // Link to documentation about this status reason. + MoreInfo *string `json:"more_info,omitempty"` +} + +// Constants associated with the ShareJobStatusReason.Code property. +// A snake case string succinctly identifying the status reason. +const ( + ShareJobStatusReasonCodeCannotInitializeReplicationConst = "cannot_initialize_replication" + ShareJobStatusReasonCodeCannotReachReplicaShareConst = "cannot_reach_replica_share" + ShareJobStatusReasonCodeCannotReachSourceShareConst = "cannot_reach_source_share" +) + +// UnmarshalShareJobStatusReason unmarshals an instance of ShareJobStatusReason from the specified map of raw messages. +func UnmarshalShareJobStatusReason(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareJobStatusReason) + err = core.UnmarshalPrimitive(m, "code", &obj.Code) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "message", &obj.Message) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareMountTarget : ShareMountTarget struct +type ShareMountTarget struct { + // The access control mode for the share: + // + // - `security_group`: The security groups on the virtual network interface for a mount + // target control access to the mount target. + // - `vpc`: All clients in the VPC for a mount target have access to the mount target. + // + // The enumerated access control mode values for this property may expand in the future. When processing this property, + // check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which + // the unexpected access control mode was encountered. + AccessControlMode *string `json:"access_control_mode" validate:"required"` + + // The date and time that the share mount target was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The URL for this share mount target. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this share mount target. + ID *string `json:"id" validate:"required"` + + // The lifecycle state of the mount target. + LifecycleState *string `json:"lifecycle_state" validate:"required"` + + // The mount path for the share. The server component of the mount path may be either an IP address or a fully + // qualified domain name. + // + // This property will be absent if the `lifecycle_state` of the mount target is + // 'pending', `failed`, or `deleting`. + // + // If the share's `access_control_mode` is: + // + // - `security_group`: The IP address used in the mount path is the `primary_ip` + // address of the virtual network interface for this share mount target. + // - `vpc`: The fully-qualified domain name used in the mount path is an address that + // resolves to the share mount target. + MountPath *string `json:"mount_path,omitempty"` + + // The name for this share mount target. The name is unique across all mount targets for the file share. + Name *string `json:"name" validate:"required"` + + // The primary IP address of the virtual network interface for the share mount target. + // + // Absent if `access_control_mode` is `vpc`. + PrimaryIP *ReservedIPReference `json:"primary_ip,omitempty"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The subnet of the virtual network interface for the share mount target. + // + // Absent if `access_control_mode` is `vpc`. + Subnet *SubnetReference `json:"subnet,omitempty"` + + // The transit encryption mode for this share mount target: + // - `none`: Not encrypted in transit + // - `user_managed`: Encrypted in transit using an instance identity certificate + // + // The enumerated values for this property will expand in the future. When processing this property, check for and log + // unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected + // property value was encountered. + TransitEncryption *string `json:"transit_encryption" validate:"required"` + + // The virtual network interface for this file share mount target. + // + // This property will be present when the `access_control_mode` is `security_group`. + VirtualNetworkInterface *VirtualNetworkInterfaceReferenceAttachmentContext `json:"virtual_network_interface,omitempty"` + + // If `access_control_mode` is: + // + // - `security_group`: The VPC for the virtual network interface for this share mount + // target + // - `vpc`: The VPC in which clients can mount the file share using this share + // mount target. + VPC *VPCReference `json:"vpc" validate:"required"` +} + +// Constants associated with the ShareMountTarget.AccessControlMode property. +// The access control mode for the share: +// +// - `security_group`: The security groups on the virtual network interface for a mount +// target control access to the mount target. +// - `vpc`: All clients in the VPC for a mount target have access to the mount target. +// +// The enumerated access control mode values for this property may expand in the future. When processing this property, +// check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which +// the unexpected access control mode was encountered. +const ( + ShareMountTargetAccessControlModeSecurityGroupConst = "security_group" + ShareMountTargetAccessControlModeVPCConst = "vpc" +) + +// Constants associated with the ShareMountTarget.LifecycleState property. +// The lifecycle state of the mount target. +const ( + ShareMountTargetLifecycleStateDeletingConst = "deleting" + ShareMountTargetLifecycleStateFailedConst = "failed" + ShareMountTargetLifecycleStatePendingConst = "pending" + ShareMountTargetLifecycleStateStableConst = "stable" + ShareMountTargetLifecycleStateSuspendedConst = "suspended" + ShareMountTargetLifecycleStateUpdatingConst = "updating" + ShareMountTargetLifecycleStateWaitingConst = "waiting" +) + +// Constants associated with the ShareMountTarget.ResourceType property. +// The resource type. +const ( + ShareMountTargetResourceTypeShareMountTargetConst = "share_mount_target" +) + +// Constants associated with the ShareMountTarget.TransitEncryption property. +// The transit encryption mode for this share mount target: +// - `none`: Not encrypted in transit +// - `user_managed`: Encrypted in transit using an instance identity certificate +// +// The enumerated values for this property will expand in the future. When processing this property, check for and log +// unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected +// property value was encountered. +const ( + ShareMountTargetTransitEncryptionNoneConst = "none" + ShareMountTargetTransitEncryptionUserManagedConst = "user_managed" +) + +// UnmarshalShareMountTarget unmarshals an instance of ShareMountTarget from the specified map of raw messages. +func UnmarshalShareMountTarget(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareMountTarget) + err = core.UnmarshalPrimitive(m, "access_control_mode", &obj.AccessControlMode) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "lifecycle_state", &obj.LifecycleState) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "mount_path", &obj.MountPath) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_ip", &obj.PrimaryIP, UnmarshalReservedIPReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnet", &obj.Subnet, UnmarshalSubnetReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "transit_encryption", &obj.TransitEncryption) + if err != nil { + return + } + err = core.UnmarshalModel(m, "virtual_network_interface", &obj.VirtualNetworkInterface, UnmarshalVirtualNetworkInterfaceReferenceAttachmentContext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareMountTargetCollection : ShareMountTargetCollection struct +type ShareMountTargetCollection struct { + // A link to the first page of resources. + First *ShareMountTargetCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // Collection of share mount targets. + MountTargets []ShareMountTarget `json:"mount_targets" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *ShareMountTargetCollectionNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalShareMountTargetCollection unmarshals an instance of ShareMountTargetCollection from the specified map of raw messages. +func UnmarshalShareMountTargetCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareMountTargetCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalShareMountTargetCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "mount_targets", &obj.MountTargets, UnmarshalShareMountTarget) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalShareMountTargetCollectionNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *ShareMountTargetCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// ShareMountTargetCollectionFirst : A link to the first page of resources. +type ShareMountTargetCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalShareMountTargetCollectionFirst unmarshals an instance of ShareMountTargetCollectionFirst from the specified map of raw messages. +func UnmarshalShareMountTargetCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareMountTargetCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareMountTargetCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type ShareMountTargetCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalShareMountTargetCollectionNext unmarshals an instance of ShareMountTargetCollectionNext from the specified map of raw messages. +func UnmarshalShareMountTargetCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareMountTargetCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareMountTargetPatch : ShareMountTargetPatch struct +type ShareMountTargetPatch struct { + // The name for this share mount target. The name must not be used by another mount target for the file share. + Name *string `json:"name,omitempty"` +} + +// UnmarshalShareMountTargetPatch unmarshals an instance of ShareMountTargetPatch from the specified map of raw messages. +func UnmarshalShareMountTargetPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareMountTargetPatch) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the ShareMountTargetPatch +func (shareMountTargetPatch *ShareMountTargetPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(shareMountTargetPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// ShareMountTargetPrototype : ShareMountTargetPrototype struct +// Models which "extend" this model: +// - ShareMountTargetPrototypeShareMountTargetByAccessControlModeSecurityGroup +// - ShareMountTargetPrototypeShareMountTargetByAccessControlModeVPC +type ShareMountTargetPrototype struct { + // The name for this share mount target. The name must not be used by another mount target for the file share. + Name *string `json:"name,omitempty"` + + // The transit encryption mode to use for this share mount target: + // - `none`: Not encrypted in transit. + // - `user_managed`: Encrypted in transit using an instance identity certificate. The + // `access_control_mode` for the share must be `security_group`. + TransitEncryption *string `json:"transit_encryption,omitempty"` + + VirtualNetworkInterface ShareMountTargetVirtualNetworkInterfacePrototypeIntf `json:"virtual_network_interface,omitempty"` + + // Identifies a VPC by a unique property. + VPC VPCIdentityIntf `json:"vpc,omitempty"` +} + +// Constants associated with the ShareMountTargetPrototype.TransitEncryption property. +// The transit encryption mode to use for this share mount target: +// - `none`: Not encrypted in transit. +// - `user_managed`: Encrypted in transit using an instance identity certificate. The +// `access_control_mode` for the share must be `security_group`. +const ( + ShareMountTargetPrototypeTransitEncryptionNoneConst = "none" + ShareMountTargetPrototypeTransitEncryptionUserManagedConst = "user_managed" +) + +func (*ShareMountTargetPrototype) isaShareMountTargetPrototype() bool { + return true +} + +type ShareMountTargetPrototypeIntf interface { + isaShareMountTargetPrototype() bool +} + +// UnmarshalShareMountTargetPrototype unmarshals an instance of ShareMountTargetPrototype from the specified map of raw messages. +func UnmarshalShareMountTargetPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareMountTargetPrototype) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "transit_encryption", &obj.TransitEncryption) + if err != nil { + return + } + err = core.UnmarshalModel(m, "virtual_network_interface", &obj.VirtualNetworkInterface, UnmarshalShareMountTargetVirtualNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareMountTargetReference : ShareMountTargetReference struct +type ShareMountTargetReference struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *ShareMountTargetReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this share mount target. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this share mount target. + ID *string `json:"id" validate:"required"` + + // The name for this share mount target. The name is unique across all mount targets for the file share. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the ShareMountTargetReference.ResourceType property. +// The resource type. +const ( + ShareMountTargetReferenceResourceTypeShareMountTargetConst = "share_mount_target" +) + +// UnmarshalShareMountTargetReference unmarshals an instance of ShareMountTargetReference from the specified map of raw messages. +func UnmarshalShareMountTargetReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareMountTargetReference) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalShareMountTargetReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareMountTargetReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type ShareMountTargetReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalShareMountTargetReferenceDeleted unmarshals an instance of ShareMountTargetReferenceDeleted from the specified map of raw messages. +func UnmarshalShareMountTargetReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareMountTargetReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareMountTargetVirtualNetworkInterfacePrototype : ShareMountTargetVirtualNetworkInterfacePrototype struct +// Models which "extend" this model: +// - ShareMountTargetVirtualNetworkInterfacePrototypeVirtualNetworkInterfacePrototypeShareMountTargetContext +type ShareMountTargetVirtualNetworkInterfacePrototype struct { + // The name for this virtual network interface. The name must not be used by another virtual network interface in the + // VPC. If unspecified, the name will be a hyphenated list of randomly-selected words. Names beginning with `ibm-` are + // reserved for provider-owned resources, and are not allowed. + Name *string `json:"name,omitempty"` + + // The primary IP address to bind to the virtual network interface. May be either a + // reserved IP identity, or a reserved IP prototype object which will be used to create a + // new reserved IP. + // + // If a reserved IP identity is provided, the specified reserved IP must be unbound. + // + // If a reserved IP prototype object with an address is provided, the address must be + // available on the virtual network interface's subnet. If no address is specified, + // an available address on the subnet will be automatically selected and reserved. + PrimaryIP VirtualNetworkInterfacePrimaryIPPrototypeIntf `json:"primary_ip,omitempty"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The security groups to use for this virtual network interface. If unspecified, the default security group of the VPC + // for the subnet is used. + SecurityGroups []SecurityGroupIdentityIntf `json:"security_groups,omitempty"` + + // The associated subnet. Required if `primary_ip` does not specify a reserved IP and + // `primary_ip.address` is not specified. + Subnet SubnetIdentityIntf `json:"subnet,omitempty"` +} + +func (*ShareMountTargetVirtualNetworkInterfacePrototype) isaShareMountTargetVirtualNetworkInterfacePrototype() bool { + return true +} + +type ShareMountTargetVirtualNetworkInterfacePrototypeIntf interface { + isaShareMountTargetVirtualNetworkInterfacePrototype() bool +} + +// UnmarshalShareMountTargetVirtualNetworkInterfacePrototype unmarshals an instance of ShareMountTargetVirtualNetworkInterfacePrototype from the specified map of raw messages. +func UnmarshalShareMountTargetVirtualNetworkInterfacePrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareMountTargetVirtualNetworkInterfacePrototype) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_ip", &obj.PrimaryIP, UnmarshalVirtualNetworkInterfacePrimaryIPPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "security_groups", &obj.SecurityGroups, UnmarshalSecurityGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnet", &obj.Subnet, UnmarshalSubnetIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SharePatch : SharePatch struct +type SharePatch struct { + // The access control mode for the share: + // + // - `security_group`: The security groups on the virtual network interface for a + // mount target control access to the mount target. + // - `vpc`: All clients in the VPC for a mount target have access to the mount target. + // + // For this property to be changed, the share must have no mount targets and + // `replication_role` must be `none`. + AccessControlMode *string `json:"access_control_mode,omitempty"` + + // The maximum input/output operations per second (IOPS) for the file share. The value must be in the range supported + // by the share's size. + // + // For this property to be changed, the share `lifecycle_state` must be `stable`. + Iops *int64 `json:"iops,omitempty"` + + // The name for this share. The name must not be used by another share in the region. + Name *string `json:"name,omitempty"` + + // The profile to use for this file share. + // + // The requested profile must be in the same `family`. + Profile ShareProfileIdentityIntf `json:"profile,omitempty"` + + // The cron specification for the file share replication schedule. + // + // Replication of a share can be scheduled to occur at most once per hour. + // + // For this property to be changed, the share `replication_role` must be `replica`. + ReplicationCronSpec *string `json:"replication_cron_spec,omitempty"` + + // The size of the file share rounded up to the next gigabyte. The value must not be less than the share's current + // size, and must not exceed the maximum supported by the share's profile and IOPS. + // + // For this property to be changed, the share `lifecycle_state` must be `stable`. + Size *int64 `json:"size,omitempty"` + + // Tags for this resource. + UserTags []string `json:"user_tags,omitempty"` +} + +// Constants associated with the SharePatch.AccessControlMode property. +// The access control mode for the share: +// +// - `security_group`: The security groups on the virtual network interface for a +// mount target control access to the mount target. +// - `vpc`: All clients in the VPC for a mount target have access to the mount target. +// +// For this property to be changed, the share must have no mount targets and +// `replication_role` must be `none`. +const ( + SharePatchAccessControlModeSecurityGroupConst = "security_group" + SharePatchAccessControlModeVPCConst = "vpc" +) + +// UnmarshalSharePatch unmarshals an instance of SharePatch from the specified map of raw messages. +func UnmarshalSharePatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SharePatch) + err = core.UnmarshalPrimitive(m, "access_control_mode", &obj.AccessControlMode) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "iops", &obj.Iops) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalShareProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "replication_cron_spec", &obj.ReplicationCronSpec) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "size", &obj.Size) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_tags", &obj.UserTags) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the SharePatch +func (sharePatch *SharePatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(sharePatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// ShareProfile : ShareProfile struct +type ShareProfile struct { + // The permitted capacity range (in gigabytes) for a share with this profile. + Capacity ShareProfileCapacityIntf `json:"capacity" validate:"required"` + + // The product family this share profile belongs to. + Family *string `json:"family" validate:"required"` + + // The URL for this share profile. + Href *string `json:"href" validate:"required"` + + // The permitted IOPS range for a share with this profile. + Iops ShareProfileIopsIntf `json:"iops" validate:"required"` + + // The globally unique name for this share profile. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the ShareProfile.Family property. +// The product family this share profile belongs to. +const ( + ShareProfileFamilyDefinedPerformanceConst = "defined_performance" +) + +// Constants associated with the ShareProfile.ResourceType property. +// The resource type. +const ( + ShareProfileResourceTypeShareProfileConst = "share_profile" +) + +// UnmarshalShareProfile unmarshals an instance of ShareProfile from the specified map of raw messages. +func UnmarshalShareProfile(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareProfile) + err = core.UnmarshalModel(m, "capacity", &obj.Capacity, UnmarshalShareProfileCapacity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "family", &obj.Family) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalModel(m, "iops", &obj.Iops, UnmarshalShareProfileIops) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareProfileCapacity : ShareProfileCapacity struct +// Models which "extend" this model: +// - ShareProfileCapacityFixed +// - ShareProfileCapacityRange +// - ShareProfileCapacityEnum +// - ShareProfileCapacityDependentRange +type ShareProfileCapacity struct { + // The type for this profile field. + Type *string `json:"type,omitempty"` + + // The value for this profile field. + Value *int64 `json:"value,omitempty"` + + // The default value for this profile field. + Default *int64 `json:"default,omitempty"` + + // The maximum value for this profile field. + Max *int64 `json:"max,omitempty"` + + // The minimum value for this profile field. + Min *int64 `json:"min,omitempty"` + + // The increment step value for this profile field. + Step *int64 `json:"step,omitempty"` + + // The permitted values for this profile field. + Values []int64 `json:"values,omitempty"` +} + +// Constants associated with the ShareProfileCapacity.Type property. +// The type for this profile field. +const ( + ShareProfileCapacityTypeFixedConst = "fixed" +) + +func (*ShareProfileCapacity) isaShareProfileCapacity() bool { + return true +} + +type ShareProfileCapacityIntf interface { + isaShareProfileCapacity() bool +} + +// UnmarshalShareProfileCapacity unmarshals an instance of ShareProfileCapacity from the specified map of raw messages. +func UnmarshalShareProfileCapacity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareProfileCapacity) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareProfileCollection : ShareProfileCollection struct +type ShareProfileCollection struct { + // A link to the first page of resources. + First *ShareProfileCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *ShareProfileCollectionNext `json:"next,omitempty"` + + // Collection of share profiles. + Profiles []ShareProfile `json:"profiles" validate:"required"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalShareProfileCollection unmarshals an instance of ShareProfileCollection from the specified map of raw messages. +func UnmarshalShareProfileCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareProfileCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalShareProfileCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalShareProfileCollectionNext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profiles", &obj.Profiles, UnmarshalShareProfile) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *ShareProfileCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// ShareProfileCollectionFirst : A link to the first page of resources. +type ShareProfileCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalShareProfileCollectionFirst unmarshals an instance of ShareProfileCollectionFirst from the specified map of raw messages. +func UnmarshalShareProfileCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareProfileCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareProfileCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type ShareProfileCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalShareProfileCollectionNext unmarshals an instance of ShareProfileCollectionNext from the specified map of raw messages. +func UnmarshalShareProfileCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareProfileCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareProfileIops : ShareProfileIops struct +// Models which "extend" this model: +// - ShareProfileIopsFixed +// - ShareProfileIopsRange +// - ShareProfileIopsEnum +// - ShareProfileIopsDependentRange +type ShareProfileIops struct { + // The type for this profile field. + Type *string `json:"type,omitempty"` + + // The value for this profile field. + Value *int64 `json:"value,omitempty"` + + // The default value for this profile field. + Default *int64 `json:"default,omitempty"` + + // The maximum value for this profile field. + Max *int64 `json:"max,omitempty"` + + // The minimum value for this profile field. + Min *int64 `json:"min,omitempty"` + + // The increment step value for this profile field. + Step *int64 `json:"step,omitempty"` + + // The permitted values for this profile field. + Values []int64 `json:"values,omitempty"` +} + +// Constants associated with the ShareProfileIops.Type property. +// The type for this profile field. +const ( + ShareProfileIopsTypeFixedConst = "fixed" +) + +func (*ShareProfileIops) isaShareProfileIops() bool { + return true +} + +type ShareProfileIopsIntf interface { + isaShareProfileIops() bool +} + +// UnmarshalShareProfileIops unmarshals an instance of ShareProfileIops from the specified map of raw messages. +func UnmarshalShareProfileIops(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareProfileIops) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareProfileIdentity : Identifies a share profile by a unique property. +// Models which "extend" this model: +// - ShareProfileIdentityByName +// - ShareProfileIdentityByHref +type ShareProfileIdentity struct { + // The globally unique name for this share profile. + Name *string `json:"name,omitempty"` + + // The URL for this share profile. + Href *string `json:"href,omitempty"` +} + +func (*ShareProfileIdentity) isaShareProfileIdentity() bool { + return true +} + +type ShareProfileIdentityIntf interface { + isaShareProfileIdentity() bool +} + +// UnmarshalShareProfileIdentity unmarshals an instance of ShareProfileIdentity from the specified map of raw messages. +func UnmarshalShareProfileIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareProfileIdentity) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareProfileReference : ShareProfileReference struct +type ShareProfileReference struct { + // The URL for this share profile. + Href *string `json:"href" validate:"required"` + + // The globally unique name for this share profile. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the ShareProfileReference.ResourceType property. +// The resource type. +const ( + ShareProfileReferenceResourceTypeShareProfileConst = "share_profile" +) + +// UnmarshalShareProfileReference unmarshals an instance of ShareProfileReference from the specified map of raw messages. +func UnmarshalShareProfileReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareProfileReference) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SharePrototype : SharePrototype struct +// Models which "extend" this model: +// - SharePrototypeShareBySize +// - SharePrototypeShareBySourceShare +type SharePrototype struct { + // The maximum input/output operations per second (IOPS) for the file share. The share must be in the + // `defined_performance` profile family, and the value must be in the range supported by the share's specified size. + // + // In addition, each client accessing the share will be restricted to 48,000 IOPS. + Iops *int64 `json:"iops,omitempty"` + + // The mount targets for the file share. Each mount target must be in a unique VPC. + MountTargets []ShareMountTargetPrototypeIntf `json:"mount_targets,omitempty"` + + // The name for this share. The name must not be used by another share in the region. If unspecified, the name will be + // a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-file-storage-profiles) to use + // for this file share. The profile must support the share's specified IOPS and size. + Profile ShareProfileIdentityIntf `json:"profile" validate:"required"` + + // Configuration for a replica file share to create and associate with this file share. If + // unspecified, a replica may be subsequently added by creating a new file share with a + // `source_share` referencing this file share. + ReplicaShare *SharePrototypeShareContext `json:"replica_share,omitempty"` + + // Tags for this resource. + UserTags []string `json:"user_tags,omitempty"` + + // The zone this file share will reside in. + // For a replica share, this must be a different zone in the same region as the source share. + Zone ZoneIdentityIntf `json:"zone" validate:"required"` + + // The access control mode for the share: + // + // - `security_group`: The security groups on the virtual network interface for a + // mount target control access to the mount target. Mount targets for this share + // require a virtual network interface. + // - `vpc`: All clients in the VPC for a mount target have access to the mount target. + // Mount targets for this share require a VPC. + AccessControlMode *string `json:"access_control_mode,omitempty"` + + // The root key to use to wrap the data encryption key for the share. + // + // If unspecified, the `encryption` type for the share will be `provider_managed`. + // + // The specified key may be in a different account, subject to IAM policies. + EncryptionKey EncryptionKeyIdentityIntf `json:"encryption_key,omitempty"` + + // The owner assigned to the file share at creation. Subsequent changes to the owner + // must be performed by a client that has mounted the file share. + InitialOwner *ShareInitialOwner `json:"initial_owner,omitempty"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The size of the file share rounded up to the next gigabyte. + // + // The maximum size for a share may increase in the future. + Size *int64 `json:"size,omitempty"` + + // The cron specification for the file share replication schedule. + // + // Replication of a share can be scheduled to occur at most once per hour. + ReplicationCronSpec *string `json:"replication_cron_spec,omitempty"` + + // The source file share for this replica file share. The specified file share must not + // already have a replica, and must not be a replica. + SourceShare ShareIdentityIntf `json:"source_share,omitempty"` +} + +// Constants associated with the SharePrototype.AccessControlMode property. +// The access control mode for the share: +// +// - `security_group`: The security groups on the virtual network interface for a +// mount target control access to the mount target. Mount targets for this share +// require a virtual network interface. +// - `vpc`: All clients in the VPC for a mount target have access to the mount target. +// Mount targets for this share require a VPC. +const ( + SharePrototypeAccessControlModeSecurityGroupConst = "security_group" + SharePrototypeAccessControlModeVPCConst = "vpc" +) + +func (*SharePrototype) isaSharePrototype() bool { + return true +} + +type SharePrototypeIntf interface { + isaSharePrototype() bool +} + +// UnmarshalSharePrototype unmarshals an instance of SharePrototype from the specified map of raw messages. +func UnmarshalSharePrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SharePrototype) + err = core.UnmarshalPrimitive(m, "iops", &obj.Iops) + if err != nil { + return + } + err = core.UnmarshalModel(m, "mount_targets", &obj.MountTargets, UnmarshalShareMountTargetPrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalShareProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "replica_share", &obj.ReplicaShare, UnmarshalSharePrototypeShareContext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_tags", &obj.UserTags) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "access_control_mode", &obj.AccessControlMode) + if err != nil { + return + } + err = core.UnmarshalModel(m, "encryption_key", &obj.EncryptionKey, UnmarshalEncryptionKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "initial_owner", &obj.InitialOwner, UnmarshalShareInitialOwner) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "size", &obj.Size) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "replication_cron_spec", &obj.ReplicationCronSpec) + if err != nil { + return + } + err = core.UnmarshalModel(m, "source_share", &obj.SourceShare, UnmarshalShareIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SharePrototypeShareContext : Configuration for a replica file share to create and associate with this file share. If unspecified, a replica may be +// subsequently added by creating a new file share with a +// `source_share` referencing this file share. +type SharePrototypeShareContext struct { + // The maximum input/output operations per second (IOPS) for the file share. The share must be in the + // `defined_performance` profile family, and the value must be in the range supported by the share's specified size. + // + // In addition, each client accessing the share will be restricted to 48,000 IOPS. + Iops *int64 `json:"iops,omitempty"` + + // The mount targets for this replica file share. Each mount target must be in a unique VPC. + // + // A replica's mount targets must be mounted read-only. + MountTargets []ShareMountTargetPrototypeIntf `json:"mount_targets,omitempty"` + + // The name for this share. The name must not be used by another share in the region. If unspecified, the name will be + // a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-file-storage-profiles) to use + // for this file share. The profile must support the share's specified IOPS and size. + Profile ShareProfileIdentityIntf `json:"profile" validate:"required"` + + // The cron specification for the file share replication schedule. + // + // Replication of a share can be scheduled to occur at most once per hour. + ReplicationCronSpec *string `json:"replication_cron_spec" validate:"required"` + + // The resource group to use. If unspecified, the resource group from + // the source share will be used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // Tags for this resource. + UserTags []string `json:"user_tags,omitempty"` + + // The zone this replica file share will reside in. + // + // Must be a different zone in the same region as the source share. + Zone ZoneIdentityIntf `json:"zone" validate:"required"` +} + +// NewSharePrototypeShareContext : Instantiate SharePrototypeShareContext (Generic Model Constructor) +func (*VpcV1) NewSharePrototypeShareContext(profile ShareProfileIdentityIntf, replicationCronSpec string, zone ZoneIdentityIntf) (_model *SharePrototypeShareContext, err error) { + _model = &SharePrototypeShareContext{ + Profile: profile, + ReplicationCronSpec: core.StringPtr(replicationCronSpec), + Zone: zone, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalSharePrototypeShareContext unmarshals an instance of SharePrototypeShareContext from the specified map of raw messages. +func UnmarshalSharePrototypeShareContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SharePrototypeShareContext) + err = core.UnmarshalPrimitive(m, "iops", &obj.Iops) + if err != nil { + return + } + err = core.UnmarshalModel(m, "mount_targets", &obj.MountTargets, UnmarshalShareMountTargetPrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalShareProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "replication_cron_spec", &obj.ReplicationCronSpec) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_tags", &obj.UserTags) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareReference : ShareReference struct +type ShareReference struct { + // The CRN for this file share. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *ShareReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this file share. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this file share. + ID *string `json:"id" validate:"required"` + + // The name for this share. The name is unique across all shares in the region. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the ShareReference.ResourceType property. +// The resource type. +const ( + ShareReferenceResourceTypeShareConst = "share" +) + +// UnmarshalShareReference unmarshals an instance of ShareReference from the specified map of raw messages. +func UnmarshalShareReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalShareReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type ShareReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalShareReferenceDeleted unmarshals an instance of ShareReferenceDeleted from the specified map of raw messages. +func UnmarshalShareReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareReplicationStatusReason : ShareReplicationStatusReason struct +type ShareReplicationStatusReason struct { + // A snake case string succinctly identifying the status reason. + Code *string `json:"code" validate:"required"` + + // An explanation of the status reason. + Message *string `json:"message" validate:"required"` + + // Link to documentation about this status reason. + MoreInfo *string `json:"more_info,omitempty"` +} + +// Constants associated with the ShareReplicationStatusReason.Code property. +// A snake case string succinctly identifying the status reason. +const ( + ShareReplicationStatusReasonCodeCannotInitializeReplicationConst = "cannot_initialize_replication" + ShareReplicationStatusReasonCodeCannotReachReplicaShareConst = "cannot_reach_replica_share" + ShareReplicationStatusReasonCodeCannotReachSourceShareConst = "cannot_reach_source_share" +) + +// UnmarshalShareReplicationStatusReason unmarshals an instance of ShareReplicationStatusReason from the specified map of raw messages. +func UnmarshalShareReplicationStatusReason(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareReplicationStatusReason) + err = core.UnmarshalPrimitive(m, "code", &obj.Code) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "message", &obj.Message) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Snapshot : Snapshot struct +type Snapshot struct { + // If present, the backup policy plan which created this snapshot. + BackupPolicyPlan *BackupPolicyPlanReference `json:"backup_policy_plan,omitempty"` + + // Indicates if a boot volume attachment can be created with a volume created from this snapshot. + Bootable *bool `json:"bootable" validate:"required"` + + // The date and time the data capture for this snapshot was completed. + // + // If absent, this snapshot's data has not yet been captured. Additionally, this property may be absent for snapshots + // created before 1 January 2022. + CapturedAt *strfmt.DateTime `json:"captured_at,omitempty"` + + // Clones for this snapshot. + Clones []SnapshotClone `json:"clones" validate:"required"` + + // The copies of this snapshot. + Copies []SnapshotCopiesItem `json:"copies" validate:"required"` + + // The date and time that this snapshot was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The CRN of this snapshot. + CRN *string `json:"crn" validate:"required"` + + // Indicates whether this snapshot can be deleted. This value will always be `true`. + // Deprecated: this field is deprecated and may be removed in a future release. + Deletable *bool `json:"deletable" validate:"required"` + + // The type of encryption used on the source volume. + Encryption *string `json:"encryption" validate:"required"` + + // The root key used to wrap the data encryption key for the source volume. + // + // This property will be present for volumes with an `encryption` type of + // `user_managed`. + EncryptionKey *EncryptionKeyReference `json:"encryption_key,omitempty"` + + // The URL for this snapshot. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this snapshot. + ID *string `json:"id" validate:"required"` + + // The lifecycle state of this snapshot. + LifecycleState *string `json:"lifecycle_state" validate:"required"` + + // The minimum capacity of a volume created from this snapshot. When a snapshot is created, this will be set to the + // capacity of the `source_volume`. + MinimumCapacity *int64 `json:"minimum_capacity" validate:"required"` + + // The name for this snapshot. The name is unique across all snapshots in the region. + Name *string `json:"name" validate:"required"` + + // The operating system included in this snapshot. + OperatingSystem *OperatingSystem `json:"operating_system,omitempty"` + + // The resource group for this snapshot. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The [service tags](https://cloud.ibm.com/apidocs/tagging#types-of-tags) prefixed with `is.snapshot:` associated with + // this snapshot. + ServiceTags []string `json:"service_tags" validate:"required"` + + // The size of this snapshot rounded up to the next gigabyte. + Size *int64 `json:"size" validate:"required"` + + // If present, the image from which the data on this snapshot was most directly + // provisioned. + SourceImage *ImageReference `json:"source_image,omitempty"` + + // If present, the source snapshot this snapshot was created from. + SourceSnapshot *SnapshotSourceSnapshot `json:"source_snapshot,omitempty"` + + // The source volume this snapshot was created from (may be + // [deleted](https://cloud.ibm.com/apidocs/vpc#deleted-resources)). + SourceVolume *VolumeReference `json:"source_volume" validate:"required"` + + // The [user tags](https://cloud.ibm.com/apidocs/tagging#types-of-tags) associated with this snapshot. + UserTags []string `json:"user_tags" validate:"required"` +} + +// Constants associated with the Snapshot.Encryption property. +// The type of encryption used on the source volume. +const ( + SnapshotEncryptionProviderManagedConst = "provider_managed" + SnapshotEncryptionUserManagedConst = "user_managed" +) + +// Constants associated with the Snapshot.LifecycleState property. +// The lifecycle state of this snapshot. +const ( + SnapshotLifecycleStateDeletingConst = "deleting" + SnapshotLifecycleStateFailedConst = "failed" + SnapshotLifecycleStatePendingConst = "pending" + SnapshotLifecycleStateStableConst = "stable" + SnapshotLifecycleStateSuspendedConst = "suspended" + SnapshotLifecycleStateUpdatingConst = "updating" + SnapshotLifecycleStateWaitingConst = "waiting" +) + +// Constants associated with the Snapshot.ResourceType property. +// The resource type. +const ( + SnapshotResourceTypeSnapshotConst = "snapshot" +) + +// UnmarshalSnapshot unmarshals an instance of Snapshot from the specified map of raw messages. +func UnmarshalSnapshot(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(Snapshot) + err = core.UnmarshalModel(m, "backup_policy_plan", &obj.BackupPolicyPlan, UnmarshalBackupPolicyPlanReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "bootable", &obj.Bootable) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "captured_at", &obj.CapturedAt) + if err != nil { + return + } + err = core.UnmarshalModel(m, "clones", &obj.Clones, UnmarshalSnapshotClone) + if err != nil { + return + } + err = core.UnmarshalModel(m, "copies", &obj.Copies, UnmarshalSnapshotCopiesItem) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "deletable", &obj.Deletable) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "encryption", &obj.Encryption) + if err != nil { + return + } + err = core.UnmarshalModel(m, "encryption_key", &obj.EncryptionKey, UnmarshalEncryptionKeyReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "lifecycle_state", &obj.LifecycleState) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "minimum_capacity", &obj.MinimumCapacity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "operating_system", &obj.OperatingSystem, UnmarshalOperatingSystem) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "service_tags", &obj.ServiceTags) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "size", &obj.Size) + if err != nil { + return + } + err = core.UnmarshalModel(m, "source_image", &obj.SourceImage, UnmarshalImageReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "source_snapshot", &obj.SourceSnapshot, UnmarshalSnapshotSourceSnapshot) + if err != nil { + return + } + err = core.UnmarshalModel(m, "source_volume", &obj.SourceVolume, UnmarshalVolumeReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_tags", &obj.UserTags) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SnapshotClone : SnapshotClone struct +type SnapshotClone struct { + // Indicates whether this snapshot clone is available for use. + Available *bool `json:"available" validate:"required"` + + // The date and time that this snapshot clone was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The zone this snapshot clone resides in. + Zone *ZoneReference `json:"zone" validate:"required"` +} + +// UnmarshalSnapshotClone unmarshals an instance of SnapshotClone from the specified map of raw messages. +func UnmarshalSnapshotClone(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SnapshotClone) + err = core.UnmarshalPrimitive(m, "available", &obj.Available) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SnapshotCloneCollection : SnapshotCloneCollection struct +type SnapshotCloneCollection struct { + // Collection of snapshot clones. + Clones []SnapshotClone `json:"clones" validate:"required"` +} + +// UnmarshalSnapshotCloneCollection unmarshals an instance of SnapshotCloneCollection from the specified map of raw messages. +func UnmarshalSnapshotCloneCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SnapshotCloneCollection) + err = core.UnmarshalModel(m, "clones", &obj.Clones, UnmarshalSnapshotClone) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SnapshotClonePrototype : SnapshotClonePrototype struct +type SnapshotClonePrototype struct { + // The zone this snapshot clone will reside in. Must be in the same region as the + // snapshot. + Zone ZoneIdentityIntf `json:"zone" validate:"required"` +} + +// NewSnapshotClonePrototype : Instantiate SnapshotClonePrototype (Generic Model Constructor) +func (*VpcV1) NewSnapshotClonePrototype(zone ZoneIdentityIntf) (_model *SnapshotClonePrototype, err error) { + _model = &SnapshotClonePrototype{ + Zone: zone, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalSnapshotClonePrototype unmarshals an instance of SnapshotClonePrototype from the specified map of raw messages. +func UnmarshalSnapshotClonePrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SnapshotClonePrototype) + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SnapshotCollection : SnapshotCollection struct +type SnapshotCollection struct { + // A link to the first page of resources. + First *SnapshotCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *SnapshotCollectionNext `json:"next,omitempty"` + + // Collection of snapshots. + Snapshots []Snapshot `json:"snapshots" validate:"required"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalSnapshotCollection unmarshals an instance of SnapshotCollection from the specified map of raw messages. +func UnmarshalSnapshotCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SnapshotCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalSnapshotCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalSnapshotCollectionNext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "snapshots", &obj.Snapshots, UnmarshalSnapshot) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *SnapshotCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// SnapshotCollectionFirst : A link to the first page of resources. +type SnapshotCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalSnapshotCollectionFirst unmarshals an instance of SnapshotCollectionFirst from the specified map of raw messages. +func UnmarshalSnapshotCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SnapshotCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SnapshotCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type SnapshotCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalSnapshotCollectionNext unmarshals an instance of SnapshotCollectionNext from the specified map of raw messages. +func UnmarshalSnapshotCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SnapshotCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SnapshotCopiesItem : SnapshotCopiesItem struct +type SnapshotCopiesItem struct { + // The CRN for the copied snapshot. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *SnapshotReferenceDeleted `json:"deleted,omitempty"` + + // The URL for the copied snapshot. + Href *string `json:"href" validate:"required"` + + // The unique identifier for the copied snapshot. + ID *string `json:"id" validate:"required"` + + // The name for the copied snapshot. + Name *string `json:"name" validate:"required"` + + // If present, this property indicates that the resource associated with this reference + // is remote and therefore may not be directly retrievable. + Remote *SnapshotRemote `json:"remote,omitempty"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the SnapshotCopiesItem.ResourceType property. +// The resource type. +const ( + SnapshotCopiesItemResourceTypeSnapshotConst = "snapshot" +) + +// UnmarshalSnapshotCopiesItem unmarshals an instance of SnapshotCopiesItem from the specified map of raw messages. +func UnmarshalSnapshotCopiesItem(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SnapshotCopiesItem) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalSnapshotReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "remote", &obj.Remote, UnmarshalSnapshotRemote) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SnapshotIdentity : Identifies a snapshot by a unique property. +// Models which "extend" this model: +// - SnapshotIdentityByID +// - SnapshotIdentityByCRN +// - SnapshotIdentityByHref +type SnapshotIdentity struct { + // The unique identifier for this snapshot. + ID *string `json:"id,omitempty"` + + // The CRN of this snapshot. + CRN *string `json:"crn,omitempty"` + + // The URL for this snapshot. + Href *string `json:"href,omitempty"` +} + +func (*SnapshotIdentity) isaSnapshotIdentity() bool { + return true +} + +type SnapshotIdentityIntf interface { + isaSnapshotIdentity() bool +} + +// UnmarshalSnapshotIdentity unmarshals an instance of SnapshotIdentity from the specified map of raw messages. +func UnmarshalSnapshotIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SnapshotIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SnapshotPatch : SnapshotPatch struct +type SnapshotPatch struct { + // The name for this snapshot. The name must not be used by another snapshot in the region. + Name *string `json:"name,omitempty"` + + // The [user tags](https://cloud.ibm.com/apidocs/tagging#types-of-tags) associated with this snapshot. + UserTags []string `json:"user_tags,omitempty"` +} + +// UnmarshalSnapshotPatch unmarshals an instance of SnapshotPatch from the specified map of raw messages. +func UnmarshalSnapshotPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SnapshotPatch) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_tags", &obj.UserTags) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the SnapshotPatch +func (snapshotPatch *SnapshotPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(snapshotPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// SnapshotPrototype : SnapshotPrototype struct +// Models which "extend" this model: +// - SnapshotPrototypeSnapshotBySourceVolume +// - SnapshotPrototypeSnapshotBySourceSnapshot +type SnapshotPrototype struct { + // Clones to create for this snapshot. + Clones []SnapshotClonePrototype `json:"clones,omitempty"` + + // The name for this snapshot. The name must not be used by another snapshot in the region. If unspecified, the name + // will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The [user tags](https://cloud.ibm.com/apidocs/tagging#types-of-tags) associated with this snapshot. + UserTags []string `json:"user_tags,omitempty"` + + // The volume to create this snapshot from. + SourceVolume VolumeIdentityIntf `json:"source_volume,omitempty"` + + // The root key to use to wrap the data encryption key for this snapshot. + // + // A key must be specified if and only if the source snapshot has an `encryption` type of + // `user_managed`. To maximize snapshot availability and sharing of snapshot data, specify + // a key in the same region as the new snapshot, and use the same encryption key for all + // snapshots using the same source volume. + // + // The specified key may be in a different account, subject to IAM policies. + EncryptionKey EncryptionKeyIdentityIntf `json:"encryption_key,omitempty"` + + // The source snapshot (in another region) to create this snapshot from. + // The specified snapshot must not already be the source of another snapshot in this + // region. + SourceSnapshot *SnapshotIdentityByCRN `json:"source_snapshot,omitempty"` +} + +func (*SnapshotPrototype) isaSnapshotPrototype() bool { + return true +} + +type SnapshotPrototypeIntf interface { + isaSnapshotPrototype() bool +} + +// UnmarshalSnapshotPrototype unmarshals an instance of SnapshotPrototype from the specified map of raw messages. +func UnmarshalSnapshotPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SnapshotPrototype) + err = core.UnmarshalModel(m, "clones", &obj.Clones, UnmarshalSnapshotClonePrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_tags", &obj.UserTags) + if err != nil { + return + } + err = core.UnmarshalModel(m, "source_volume", &obj.SourceVolume, UnmarshalVolumeIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "encryption_key", &obj.EncryptionKey, UnmarshalEncryptionKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "source_snapshot", &obj.SourceSnapshot, UnmarshalSnapshotIdentityByCRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SnapshotReference : SnapshotReference struct +type SnapshotReference struct { + // The CRN of this snapshot. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *SnapshotReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this snapshot. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this snapshot. + ID *string `json:"id" validate:"required"` + + // The name for this snapshot. The name is unique across all snapshots in the region. + Name *string `json:"name" validate:"required"` + + // If present, this property indicates that the resource associated with this reference + // is remote and therefore may not be directly retrievable. + Remote *SnapshotRemote `json:"remote,omitempty"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the SnapshotReference.ResourceType property. +// The resource type. +const ( + SnapshotReferenceResourceTypeSnapshotConst = "snapshot" +) + +// UnmarshalSnapshotReference unmarshals an instance of SnapshotReference from the specified map of raw messages. +func UnmarshalSnapshotReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SnapshotReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalSnapshotReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "remote", &obj.Remote, UnmarshalSnapshotRemote) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SnapshotReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type SnapshotReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalSnapshotReferenceDeleted unmarshals an instance of SnapshotReferenceDeleted from the specified map of raw messages. +func UnmarshalSnapshotReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SnapshotReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SnapshotRemote : If present, this property indicates that the resource associated with this reference is remote and therefore may not +// be directly retrievable. +type SnapshotRemote struct { + // If present, this property indicates that the referenced resource is remote to this + // region, and identifies the native region. + Region *RegionReference `json:"region,omitempty"` +} + +// UnmarshalSnapshotRemote unmarshals an instance of SnapshotRemote from the specified map of raw messages. +func UnmarshalSnapshotRemote(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SnapshotRemote) + err = core.UnmarshalModel(m, "region", &obj.Region, UnmarshalRegionReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SnapshotSourceSnapshot : If present, the source snapshot this snapshot was created from. +type SnapshotSourceSnapshot struct { + // The CRN of the source snapshot. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *SnapshotReferenceDeleted `json:"deleted,omitempty"` + + // The URL for the source snapshot. + Href *string `json:"href" validate:"required"` + + // The unique identifier for the source snapshot. + ID *string `json:"id" validate:"required"` + + // The name for the source snapshot. The name is unique across all snapshots in the source snapshot's native region. + Name *string `json:"name" validate:"required"` + + // If present, this property indicates that the resource associated with this reference + // is remote and therefore may not be directly retrievable. + Remote *SnapshotRemote `json:"remote,omitempty"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the SnapshotSourceSnapshot.ResourceType property. +// The resource type. +const ( + SnapshotSourceSnapshotResourceTypeSnapshotConst = "snapshot" +) + +// UnmarshalSnapshotSourceSnapshot unmarshals an instance of SnapshotSourceSnapshot from the specified map of raw messages. +func UnmarshalSnapshotSourceSnapshot(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SnapshotSourceSnapshot) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalSnapshotReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "remote", &obj.Remote, UnmarshalSnapshotRemote) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// StartBareMetalServerOptions : The StartBareMetalServer options. +type StartBareMetalServerOptions struct { + // The bare metal server identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewStartBareMetalServerOptions : Instantiate StartBareMetalServerOptions +func (*VpcV1) NewStartBareMetalServerOptions(id string) *StartBareMetalServerOptions { + return &StartBareMetalServerOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *StartBareMetalServerOptions) SetID(id string) *StartBareMetalServerOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *StartBareMetalServerOptions) SetHeaders(param map[string]string) *StartBareMetalServerOptions { + options.Headers = param + return options +} + +// StopBareMetalServerOptions : The StopBareMetalServer options. +type StopBareMetalServerOptions struct { + // The bare metal server identifier. + ID *string `json:"id" validate:"required,ne="` + + // The type of stop operation: + // - `soft`: signal running operating system to quiesce and shutdown cleanly + // - `hard`: immediately stop the server. + Type *string `json:"type" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// Constants associated with the StopBareMetalServerOptions.Type property. +// The type of stop operation: +// - `soft`: signal running operating system to quiesce and shutdown cleanly +// - `hard`: immediately stop the server. +const ( + StopBareMetalServerOptionsTypeHardConst = "hard" + StopBareMetalServerOptionsTypeSoftConst = "soft" +) + +// NewStopBareMetalServerOptions : Instantiate StopBareMetalServerOptions +func (*VpcV1) NewStopBareMetalServerOptions(id string, typeVar string) *StopBareMetalServerOptions { + return &StopBareMetalServerOptions{ + ID: core.StringPtr(id), + Type: core.StringPtr(typeVar), + } +} + +// SetID : Allow user to set ID +func (_options *StopBareMetalServerOptions) SetID(id string) *StopBareMetalServerOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetType : Allow user to set Type +func (_options *StopBareMetalServerOptions) SetType(typeVar string) *StopBareMetalServerOptions { + _options.Type = core.StringPtr(typeVar) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *StopBareMetalServerOptions) SetHeaders(param map[string]string) *StopBareMetalServerOptions { + options.Headers = param + return options +} + +// Subnet : Subnet struct +type Subnet struct { + // The number of IPv4 addresses in this subnet that are not in-use, and have not been reserved by the user or the + // provider. + AvailableIpv4AddressCount *int64 `json:"available_ipv4_address_count" validate:"required"` + + // The date and time that the subnet was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The CRN for this subnet. + CRN *string `json:"crn" validate:"required"` + + // The URL for this subnet. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this subnet. + ID *string `json:"id" validate:"required"` + + // The IP version(s) supported by this subnet. + IPVersion *string `json:"ip_version" validate:"required"` + + // The IPv4 range of the subnet, expressed in CIDR format. + Ipv4CIDRBlock *string `json:"ipv4_cidr_block" validate:"required"` + + // The name for this subnet. The name is unique across all subnets in the VPC. + Name *string `json:"name" validate:"required"` + + // The network ACL for this subnet. + NetworkACL *NetworkACLReference `json:"network_acl" validate:"required"` + + // The public gateway to use for internet-bound traffic for this subnet. + PublicGateway *PublicGatewayReference `json:"public_gateway,omitempty"` + + // The resource group for this subnet. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The routing table for this subnet. + RoutingTable *RoutingTableReference `json:"routing_table" validate:"required"` + + // The status of the subnet. + Status *string `json:"status" validate:"required"` + + // The total number of IPv4 addresses in this subnet. + // + // Note: This is calculated as 2(32 - prefix length). For example, the prefix length `/24` gives:
+ // 2(32 - 24) = 28 = 256 addresses. + TotalIpv4AddressCount *int64 `json:"total_ipv4_address_count" validate:"required"` + + // The VPC this subnet resides in. + VPC *VPCReference `json:"vpc" validate:"required"` + + // The zone this subnet resides in. + Zone *ZoneReference `json:"zone" validate:"required"` +} + +// Constants associated with the Subnet.IPVersion property. +// The IP version(s) supported by this subnet. +const ( + SubnetIPVersionIpv4Const = "ipv4" +) + +// Constants associated with the Subnet.ResourceType property. +// The resource type. +const ( + SubnetResourceTypeSubnetConst = "subnet" +) + +// Constants associated with the Subnet.Status property. +// The status of the subnet. +const ( + SubnetStatusAvailableConst = "available" + SubnetStatusDeletingConst = "deleting" + SubnetStatusFailedConst = "failed" + SubnetStatusPendingConst = "pending" +) + +// UnmarshalSubnet unmarshals an instance of Subnet from the specified map of raw messages. +func UnmarshalSubnet(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(Subnet) + err = core.UnmarshalPrimitive(m, "available_ipv4_address_count", &obj.AvailableIpv4AddressCount) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "ip_version", &obj.IPVersion) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "ipv4_cidr_block", &obj.Ipv4CIDRBlock) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "network_acl", &obj.NetworkACL, UnmarshalNetworkACLReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "public_gateway", &obj.PublicGateway, UnmarshalPublicGatewayReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalModel(m, "routing_table", &obj.RoutingTable, UnmarshalRoutingTableReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_ipv4_address_count", &obj.TotalIpv4AddressCount) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SubnetCollection : SubnetCollection struct +type SubnetCollection struct { + // A link to the first page of resources. + First *SubnetCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *SubnetCollectionNext `json:"next,omitempty"` + + // Collection of subnets. + Subnets []Subnet `json:"subnets" validate:"required"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalSubnetCollection unmarshals an instance of SubnetCollection from the specified map of raw messages. +func UnmarshalSubnetCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SubnetCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalSubnetCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalSubnetCollectionNext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnets", &obj.Subnets, UnmarshalSubnet) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *SubnetCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// SubnetCollectionFirst : A link to the first page of resources. +type SubnetCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalSubnetCollectionFirst unmarshals an instance of SubnetCollectionFirst from the specified map of raw messages. +func UnmarshalSubnetCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SubnetCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SubnetCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type SubnetCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalSubnetCollectionNext unmarshals an instance of SubnetCollectionNext from the specified map of raw messages. +func UnmarshalSubnetCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SubnetCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SubnetIdentity : Identifies a subnet by a unique property. +// Models which "extend" this model: +// - SubnetIdentityByID +// - SubnetIdentityByCRN +// - SubnetIdentityByHref +type SubnetIdentity struct { + // The unique identifier for this subnet. + ID *string `json:"id,omitempty"` + + // The CRN for this subnet. + CRN *string `json:"crn,omitempty"` + + // The URL for this subnet. + Href *string `json:"href,omitempty"` +} + +func (*SubnetIdentity) isaSubnetIdentity() bool { + return true +} + +type SubnetIdentityIntf interface { + isaSubnetIdentity() bool +} + +// UnmarshalSubnetIdentity unmarshals an instance of SubnetIdentity from the specified map of raw messages. +func UnmarshalSubnetIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SubnetIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SubnetPatch : SubnetPatch struct +type SubnetPatch struct { + // The name for this subnet. The name must not be used by another subnet in the VPC. + Name *string `json:"name,omitempty"` + + // The network ACL to use for this subnet. + NetworkACL NetworkACLIdentityIntf `json:"network_acl,omitempty"` + + // The public gateway to use for internet-bound traffic for this subnet. + PublicGateway SubnetPublicGatewayPatchIntf `json:"public_gateway,omitempty"` + + // The routing table to use for this subnet. The routing table properties + // `route_direct_link_ingress`, `route_internet_ingress`, + // `route_transit_gateway_ingress`, and `route_vpc_zone_ingress` must be `false`. + RoutingTable RoutingTableIdentityIntf `json:"routing_table,omitempty"` +} + +// UnmarshalSubnetPatch unmarshals an instance of SubnetPatch from the specified map of raw messages. +func UnmarshalSubnetPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SubnetPatch) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "network_acl", &obj.NetworkACL, UnmarshalNetworkACLIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "public_gateway", &obj.PublicGateway, UnmarshalSubnetPublicGatewayPatch) + if err != nil { + return + } + err = core.UnmarshalModel(m, "routing_table", &obj.RoutingTable, UnmarshalRoutingTableIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the SubnetPatch +func (subnetPatch *SubnetPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(subnetPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// SubnetPrototype : SubnetPrototype struct +// Models which "extend" this model: +// - SubnetPrototypeSubnetByTotalCount +// - SubnetPrototypeSubnetByCIDR +type SubnetPrototype struct { + // The IP version(s) to support for this subnet. + IPVersion *string `json:"ip_version,omitempty"` + + // The name for this subnet. The name must not be used by another subnet in the VPC. If unspecified, the name will be a + // hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The network ACL to use for this subnet. + NetworkACL NetworkACLIdentityIntf `json:"network_acl,omitempty"` + + // The public gateway to use for internet-bound traffic for this subnet. If + // unspecified, the subnet will not be attached to a public gateway. + PublicGateway PublicGatewayIdentityIntf `json:"public_gateway,omitempty"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The routing table to use for this subnet. If unspecified, the default routing table + // for the VPC is used. The routing table properties `route_direct_link_ingress`, + // `route_internet_ingress`, `route_transit_gateway_ingress`, and + // `route_vpc_zone_ingress` must be `false`. + RoutingTable RoutingTableIdentityIntf `json:"routing_table,omitempty"` + + // The VPC the subnet will reside in. + VPC VPCIdentityIntf `json:"vpc" validate:"required"` + + // The total number of IPv4 addresses required. Must be a power of 2. The VPC must have a default address prefix in the + // specified zone, and that prefix must have a free CIDR range with at least this number of addresses. + TotalIpv4AddressCount *int64 `json:"total_ipv4_address_count,omitempty"` + + // The zone this subnet will reside in. + Zone ZoneIdentityIntf `json:"zone,omitempty"` + + // The IPv4 range of the subnet, expressed in CIDR format. The prefix length of the subnet's CIDR must be between `/9` + // (8,388,608 addresses) and `/29` (8 addresses). The IPv4 range of the subnet's CIDR must fall within an existing + // address prefix in the VPC and must not overlap with any existing subnet. The subnet will be created in the zone of + // the address prefix that contains the IPv4 CIDR. If zone is specified, it must match the zone of the address prefix + // that contains the subnet's IPv4 CIDR. + Ipv4CIDRBlock *string `json:"ipv4_cidr_block,omitempty"` +} + +// Constants associated with the SubnetPrototype.IPVersion property. +// The IP version(s) to support for this subnet. +const ( + SubnetPrototypeIPVersionIpv4Const = "ipv4" +) + +func (*SubnetPrototype) isaSubnetPrototype() bool { + return true +} + +type SubnetPrototypeIntf interface { + isaSubnetPrototype() bool +} + +// UnmarshalSubnetPrototype unmarshals an instance of SubnetPrototype from the specified map of raw messages. +func UnmarshalSubnetPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SubnetPrototype) + err = core.UnmarshalPrimitive(m, "ip_version", &obj.IPVersion) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "network_acl", &obj.NetworkACL, UnmarshalNetworkACLIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "public_gateway", &obj.PublicGateway, UnmarshalPublicGatewayIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "routing_table", &obj.RoutingTable, UnmarshalRoutingTableIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_ipv4_address_count", &obj.TotalIpv4AddressCount) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "ipv4_cidr_block", &obj.Ipv4CIDRBlock) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SubnetPublicGatewayPatch : The public gateway to use for internet-bound traffic for this subnet. +// Models which "extend" this model: +// - SubnetPublicGatewayPatchPublicGatewayIdentityByID +// - SubnetPublicGatewayPatchPublicGatewayIdentityByCRN +// - SubnetPublicGatewayPatchPublicGatewayIdentityByHref +type SubnetPublicGatewayPatch struct { + // The unique identifier for this public gateway. + ID *string `json:"id,omitempty"` + + // The CRN for this public gateway. + CRN *string `json:"crn,omitempty"` + + // The URL for this public gateway. + Href *string `json:"href,omitempty"` +} + +func (*SubnetPublicGatewayPatch) isaSubnetPublicGatewayPatch() bool { + return true +} + +type SubnetPublicGatewayPatchIntf interface { + isaSubnetPublicGatewayPatch() bool +} + +// UnmarshalSubnetPublicGatewayPatch unmarshals an instance of SubnetPublicGatewayPatch from the specified map of raw messages. +func UnmarshalSubnetPublicGatewayPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SubnetPublicGatewayPatch) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SubnetReference : SubnetReference struct +type SubnetReference struct { + // The CRN for this subnet. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *SubnetReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this subnet. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this subnet. + ID *string `json:"id" validate:"required"` + + // The name for this subnet. The name is unique across all subnets in the VPC. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the SubnetReference.ResourceType property. +// The resource type. +const ( + SubnetReferenceResourceTypeSubnetConst = "subnet" +) + +// UnmarshalSubnetReference unmarshals an instance of SubnetReference from the specified map of raw messages. +func UnmarshalSubnetReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SubnetReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalSubnetReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SubnetReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type SubnetReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalSubnetReferenceDeleted unmarshals an instance of SubnetReferenceDeleted from the specified map of raw messages. +func UnmarshalSubnetReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SubnetReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// TrustedProfileIdentity : Identifies a trusted profile by a unique property. +// Models which "extend" this model: +// - TrustedProfileIdentityTrustedProfileByID +// - TrustedProfileIdentityTrustedProfileByCRN +type TrustedProfileIdentity struct { + // The unique identifier for this trusted profile. + ID *string `json:"id,omitempty"` + + // The CRN for this trusted profile. + CRN *string `json:"crn,omitempty"` +} + +func (*TrustedProfileIdentity) isaTrustedProfileIdentity() bool { + return true +} + +type TrustedProfileIdentityIntf interface { + isaTrustedProfileIdentity() bool +} + +// UnmarshalTrustedProfileIdentity unmarshals an instance of TrustedProfileIdentity from the specified map of raw messages. +func UnmarshalTrustedProfileIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(TrustedProfileIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// TrustedProfileReference : TrustedProfileReference struct +type TrustedProfileReference struct { + // The CRN for this trusted profile. + CRN *string `json:"crn" validate:"required"` + + // The unique identifier for this trusted profile. + ID *string `json:"id" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the TrustedProfileReference.ResourceType property. +// The resource type. +const ( + TrustedProfileReferenceResourceTypeTrustedProfileConst = "trusted_profile" +) + +// UnmarshalTrustedProfileReference unmarshals an instance of TrustedProfileReference from the specified map of raw messages. +func UnmarshalTrustedProfileReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(TrustedProfileReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// UnsetSubnetPublicGatewayOptions : The UnsetSubnetPublicGateway options. +type UnsetSubnetPublicGatewayOptions struct { + // The subnet identifier. + ID *string `json:"id" validate:"required,ne="` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUnsetSubnetPublicGatewayOptions : Instantiate UnsetSubnetPublicGatewayOptions +func (*VpcV1) NewUnsetSubnetPublicGatewayOptions(id string) *UnsetSubnetPublicGatewayOptions { + return &UnsetSubnetPublicGatewayOptions{ + ID: core.StringPtr(id), + } +} + +// SetID : Allow user to set ID +func (_options *UnsetSubnetPublicGatewayOptions) SetID(id string) *UnsetSubnetPublicGatewayOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UnsetSubnetPublicGatewayOptions) SetHeaders(param map[string]string) *UnsetSubnetPublicGatewayOptions { + options.Headers = param + return options +} + +// UpdateBackupPolicyOptions : The UpdateBackupPolicy options. +type UpdateBackupPolicyOptions struct { + // The backup policy identifier. + ID *string `json:"id" validate:"required,ne="` + + // The backup policy patch. + BackupPolicyPatch map[string]interface{} `json:"BackupPolicy_patch" validate:"required"` + + // If present, the request will fail if the specified ETag value does not match the resource's current ETag value. + // Required if the request body includes an array. + IfMatch *string `json:"If-Match,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateBackupPolicyOptions : Instantiate UpdateBackupPolicyOptions +func (*VpcV1) NewUpdateBackupPolicyOptions(id string, backupPolicyPatch map[string]interface{}) *UpdateBackupPolicyOptions { + return &UpdateBackupPolicyOptions{ + ID: core.StringPtr(id), + BackupPolicyPatch: backupPolicyPatch, + } +} + +// SetID : Allow user to set ID +func (_options *UpdateBackupPolicyOptions) SetID(id string) *UpdateBackupPolicyOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetBackupPolicyPatch : Allow user to set BackupPolicyPatch +func (_options *UpdateBackupPolicyOptions) SetBackupPolicyPatch(backupPolicyPatch map[string]interface{}) *UpdateBackupPolicyOptions { + _options.BackupPolicyPatch = backupPolicyPatch + return _options +} + +// SetIfMatch : Allow user to set IfMatch +func (_options *UpdateBackupPolicyOptions) SetIfMatch(ifMatch string) *UpdateBackupPolicyOptions { + _options.IfMatch = core.StringPtr(ifMatch) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateBackupPolicyOptions) SetHeaders(param map[string]string) *UpdateBackupPolicyOptions { + options.Headers = param + return options +} + +// UpdateBackupPolicyPlanOptions : The UpdateBackupPolicyPlan options. +type UpdateBackupPolicyPlanOptions struct { + // The backup policy identifier. + BackupPolicyID *string `json:"backup_policy_id" validate:"required,ne="` + + // The backup policy plan identifier. + ID *string `json:"id" validate:"required,ne="` + + // The backup policy plan patch. + BackupPolicyPlanPatch map[string]interface{} `json:"BackupPolicyPlan_patch" validate:"required"` + + // If present, the request will fail if the specified ETag value does not match the resource's current ETag value. + // Required if the request body includes an array. + IfMatch *string `json:"If-Match,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateBackupPolicyPlanOptions : Instantiate UpdateBackupPolicyPlanOptions +func (*VpcV1) NewUpdateBackupPolicyPlanOptions(backupPolicyID string, id string, backupPolicyPlanPatch map[string]interface{}) *UpdateBackupPolicyPlanOptions { + return &UpdateBackupPolicyPlanOptions{ + BackupPolicyID: core.StringPtr(backupPolicyID), + ID: core.StringPtr(id), + BackupPolicyPlanPatch: backupPolicyPlanPatch, + } +} + +// SetBackupPolicyID : Allow user to set BackupPolicyID +func (_options *UpdateBackupPolicyPlanOptions) SetBackupPolicyID(backupPolicyID string) *UpdateBackupPolicyPlanOptions { + _options.BackupPolicyID = core.StringPtr(backupPolicyID) + return _options +} + +// SetID : Allow user to set ID +func (_options *UpdateBackupPolicyPlanOptions) SetID(id string) *UpdateBackupPolicyPlanOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetBackupPolicyPlanPatch : Allow user to set BackupPolicyPlanPatch +func (_options *UpdateBackupPolicyPlanOptions) SetBackupPolicyPlanPatch(backupPolicyPlanPatch map[string]interface{}) *UpdateBackupPolicyPlanOptions { + _options.BackupPolicyPlanPatch = backupPolicyPlanPatch + return _options +} + +// SetIfMatch : Allow user to set IfMatch +func (_options *UpdateBackupPolicyPlanOptions) SetIfMatch(ifMatch string) *UpdateBackupPolicyPlanOptions { + _options.IfMatch = core.StringPtr(ifMatch) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateBackupPolicyPlanOptions) SetHeaders(param map[string]string) *UpdateBackupPolicyPlanOptions { + options.Headers = param + return options +} + +// UpdateBareMetalServerDiskOptions : The UpdateBareMetalServerDisk options. +type UpdateBareMetalServerDiskOptions struct { + // The bare metal server identifier. + BareMetalServerID *string `json:"bare_metal_server_id" validate:"required,ne="` + + // The bare metal server disk identifier. + ID *string `json:"id" validate:"required,ne="` + + // The bare metal server disk patch. + BareMetalServerDiskPatch map[string]interface{} `json:"BareMetalServerDisk_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateBareMetalServerDiskOptions : Instantiate UpdateBareMetalServerDiskOptions +func (*VpcV1) NewUpdateBareMetalServerDiskOptions(bareMetalServerID string, id string, bareMetalServerDiskPatch map[string]interface{}) *UpdateBareMetalServerDiskOptions { + return &UpdateBareMetalServerDiskOptions{ + BareMetalServerID: core.StringPtr(bareMetalServerID), + ID: core.StringPtr(id), + BareMetalServerDiskPatch: bareMetalServerDiskPatch, + } +} + +// SetBareMetalServerID : Allow user to set BareMetalServerID +func (_options *UpdateBareMetalServerDiskOptions) SetBareMetalServerID(bareMetalServerID string) *UpdateBareMetalServerDiskOptions { + _options.BareMetalServerID = core.StringPtr(bareMetalServerID) + return _options +} + +// SetID : Allow user to set ID +func (_options *UpdateBareMetalServerDiskOptions) SetID(id string) *UpdateBareMetalServerDiskOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetBareMetalServerDiskPatch : Allow user to set BareMetalServerDiskPatch +func (_options *UpdateBareMetalServerDiskOptions) SetBareMetalServerDiskPatch(bareMetalServerDiskPatch map[string]interface{}) *UpdateBareMetalServerDiskOptions { + _options.BareMetalServerDiskPatch = bareMetalServerDiskPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateBareMetalServerDiskOptions) SetHeaders(param map[string]string) *UpdateBareMetalServerDiskOptions { + options.Headers = param + return options +} + +// UpdateBareMetalServerNetworkInterfaceOptions : The UpdateBareMetalServerNetworkInterface options. +type UpdateBareMetalServerNetworkInterfaceOptions struct { + // The bare metal server identifier. + BareMetalServerID *string `json:"bare_metal_server_id" validate:"required,ne="` + + // The bare metal server network interface identifier. + ID *string `json:"id" validate:"required,ne="` + + // The bare metal server network interface patch. + BareMetalServerNetworkInterfacePatch map[string]interface{} `json:"BareMetalServerNetworkInterface_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateBareMetalServerNetworkInterfaceOptions : Instantiate UpdateBareMetalServerNetworkInterfaceOptions +func (*VpcV1) NewUpdateBareMetalServerNetworkInterfaceOptions(bareMetalServerID string, id string, bareMetalServerNetworkInterfacePatch map[string]interface{}) *UpdateBareMetalServerNetworkInterfaceOptions { + return &UpdateBareMetalServerNetworkInterfaceOptions{ + BareMetalServerID: core.StringPtr(bareMetalServerID), + ID: core.StringPtr(id), + BareMetalServerNetworkInterfacePatch: bareMetalServerNetworkInterfacePatch, + } +} + +// SetBareMetalServerID : Allow user to set BareMetalServerID +func (_options *UpdateBareMetalServerNetworkInterfaceOptions) SetBareMetalServerID(bareMetalServerID string) *UpdateBareMetalServerNetworkInterfaceOptions { + _options.BareMetalServerID = core.StringPtr(bareMetalServerID) + return _options +} + +// SetID : Allow user to set ID +func (_options *UpdateBareMetalServerNetworkInterfaceOptions) SetID(id string) *UpdateBareMetalServerNetworkInterfaceOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetBareMetalServerNetworkInterfacePatch : Allow user to set BareMetalServerNetworkInterfacePatch +func (_options *UpdateBareMetalServerNetworkInterfaceOptions) SetBareMetalServerNetworkInterfacePatch(bareMetalServerNetworkInterfacePatch map[string]interface{}) *UpdateBareMetalServerNetworkInterfaceOptions { + _options.BareMetalServerNetworkInterfacePatch = bareMetalServerNetworkInterfacePatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateBareMetalServerNetworkInterfaceOptions) SetHeaders(param map[string]string) *UpdateBareMetalServerNetworkInterfaceOptions { + options.Headers = param + return options +} + +// UpdateBareMetalServerOptions : The UpdateBareMetalServer options. +type UpdateBareMetalServerOptions struct { + // The bare metal server identifier. + ID *string `json:"id" validate:"required,ne="` + + // The bare metal server patch. + BareMetalServerPatch map[string]interface{} `json:"BareMetalServer_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateBareMetalServerOptions : Instantiate UpdateBareMetalServerOptions +func (*VpcV1) NewUpdateBareMetalServerOptions(id string, bareMetalServerPatch map[string]interface{}) *UpdateBareMetalServerOptions { + return &UpdateBareMetalServerOptions{ + ID: core.StringPtr(id), + BareMetalServerPatch: bareMetalServerPatch, + } +} + +// SetID : Allow user to set ID +func (_options *UpdateBareMetalServerOptions) SetID(id string) *UpdateBareMetalServerOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetBareMetalServerPatch : Allow user to set BareMetalServerPatch +func (_options *UpdateBareMetalServerOptions) SetBareMetalServerPatch(bareMetalServerPatch map[string]interface{}) *UpdateBareMetalServerOptions { + _options.BareMetalServerPatch = bareMetalServerPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateBareMetalServerOptions) SetHeaders(param map[string]string) *UpdateBareMetalServerOptions { + options.Headers = param + return options +} + +// UpdateDedicatedHostDiskOptions : The UpdateDedicatedHostDisk options. +type UpdateDedicatedHostDiskOptions struct { + // The dedicated host identifier. + DedicatedHostID *string `json:"dedicated_host_id" validate:"required,ne="` + + // The dedicated host disk identifier. + ID *string `json:"id" validate:"required,ne="` + + // The dedicated host disk patch. + DedicatedHostDiskPatch map[string]interface{} `json:"DedicatedHostDisk_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateDedicatedHostDiskOptions : Instantiate UpdateDedicatedHostDiskOptions +func (*VpcV1) NewUpdateDedicatedHostDiskOptions(dedicatedHostID string, id string, dedicatedHostDiskPatch map[string]interface{}) *UpdateDedicatedHostDiskOptions { + return &UpdateDedicatedHostDiskOptions{ + DedicatedHostID: core.StringPtr(dedicatedHostID), + ID: core.StringPtr(id), + DedicatedHostDiskPatch: dedicatedHostDiskPatch, + } +} + +// SetDedicatedHostID : Allow user to set DedicatedHostID +func (_options *UpdateDedicatedHostDiskOptions) SetDedicatedHostID(dedicatedHostID string) *UpdateDedicatedHostDiskOptions { + _options.DedicatedHostID = core.StringPtr(dedicatedHostID) + return _options +} + +// SetID : Allow user to set ID +func (_options *UpdateDedicatedHostDiskOptions) SetID(id string) *UpdateDedicatedHostDiskOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetDedicatedHostDiskPatch : Allow user to set DedicatedHostDiskPatch +func (_options *UpdateDedicatedHostDiskOptions) SetDedicatedHostDiskPatch(dedicatedHostDiskPatch map[string]interface{}) *UpdateDedicatedHostDiskOptions { + _options.DedicatedHostDiskPatch = dedicatedHostDiskPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateDedicatedHostDiskOptions) SetHeaders(param map[string]string) *UpdateDedicatedHostDiskOptions { + options.Headers = param + return options +} + +// UpdateDedicatedHostGroupOptions : The UpdateDedicatedHostGroup options. +type UpdateDedicatedHostGroupOptions struct { + // The dedicated host group identifier. + ID *string `json:"id" validate:"required,ne="` + + // The dedicated host group patch. + DedicatedHostGroupPatch map[string]interface{} `json:"DedicatedHostGroup_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateDedicatedHostGroupOptions : Instantiate UpdateDedicatedHostGroupOptions +func (*VpcV1) NewUpdateDedicatedHostGroupOptions(id string, dedicatedHostGroupPatch map[string]interface{}) *UpdateDedicatedHostGroupOptions { + return &UpdateDedicatedHostGroupOptions{ + ID: core.StringPtr(id), + DedicatedHostGroupPatch: dedicatedHostGroupPatch, + } +} + +// SetID : Allow user to set ID +func (_options *UpdateDedicatedHostGroupOptions) SetID(id string) *UpdateDedicatedHostGroupOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetDedicatedHostGroupPatch : Allow user to set DedicatedHostGroupPatch +func (_options *UpdateDedicatedHostGroupOptions) SetDedicatedHostGroupPatch(dedicatedHostGroupPatch map[string]interface{}) *UpdateDedicatedHostGroupOptions { + _options.DedicatedHostGroupPatch = dedicatedHostGroupPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateDedicatedHostGroupOptions) SetHeaders(param map[string]string) *UpdateDedicatedHostGroupOptions { + options.Headers = param + return options +} + +// UpdateDedicatedHostOptions : The UpdateDedicatedHost options. +type UpdateDedicatedHostOptions struct { + // The dedicated host identifier. + ID *string `json:"id" validate:"required,ne="` + + // The dedicated host patch. + DedicatedHostPatch map[string]interface{} `json:"DedicatedHost_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateDedicatedHostOptions : Instantiate UpdateDedicatedHostOptions +func (*VpcV1) NewUpdateDedicatedHostOptions(id string, dedicatedHostPatch map[string]interface{}) *UpdateDedicatedHostOptions { + return &UpdateDedicatedHostOptions{ + ID: core.StringPtr(id), + DedicatedHostPatch: dedicatedHostPatch, + } +} + +// SetID : Allow user to set ID +func (_options *UpdateDedicatedHostOptions) SetID(id string) *UpdateDedicatedHostOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetDedicatedHostPatch : Allow user to set DedicatedHostPatch +func (_options *UpdateDedicatedHostOptions) SetDedicatedHostPatch(dedicatedHostPatch map[string]interface{}) *UpdateDedicatedHostOptions { + _options.DedicatedHostPatch = dedicatedHostPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateDedicatedHostOptions) SetHeaders(param map[string]string) *UpdateDedicatedHostOptions { + options.Headers = param + return options +} + +// UpdateEndpointGatewayOptions : The UpdateEndpointGateway options. +type UpdateEndpointGatewayOptions struct { + // The endpoint gateway identifier. + ID *string `json:"id" validate:"required,ne="` + + // The endpoint gateway patch. + EndpointGatewayPatch map[string]interface{} `json:"EndpointGateway_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateEndpointGatewayOptions : Instantiate UpdateEndpointGatewayOptions +func (*VpcV1) NewUpdateEndpointGatewayOptions(id string, endpointGatewayPatch map[string]interface{}) *UpdateEndpointGatewayOptions { + return &UpdateEndpointGatewayOptions{ + ID: core.StringPtr(id), + EndpointGatewayPatch: endpointGatewayPatch, + } +} + +// SetID : Allow user to set ID +func (_options *UpdateEndpointGatewayOptions) SetID(id string) *UpdateEndpointGatewayOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetEndpointGatewayPatch : Allow user to set EndpointGatewayPatch +func (_options *UpdateEndpointGatewayOptions) SetEndpointGatewayPatch(endpointGatewayPatch map[string]interface{}) *UpdateEndpointGatewayOptions { + _options.EndpointGatewayPatch = endpointGatewayPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateEndpointGatewayOptions) SetHeaders(param map[string]string) *UpdateEndpointGatewayOptions { + options.Headers = param + return options +} + +// UpdateFloatingIPOptions : The UpdateFloatingIP options. +type UpdateFloatingIPOptions struct { + // The floating IP identifier. + ID *string `json:"id" validate:"required,ne="` + + // The floating IP patch. + FloatingIPPatch map[string]interface{} `json:"FloatingIP_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateFloatingIPOptions : Instantiate UpdateFloatingIPOptions +func (*VpcV1) NewUpdateFloatingIPOptions(id string, floatingIPPatch map[string]interface{}) *UpdateFloatingIPOptions { + return &UpdateFloatingIPOptions{ + ID: core.StringPtr(id), + FloatingIPPatch: floatingIPPatch, + } +} + +// SetID : Allow user to set ID +func (_options *UpdateFloatingIPOptions) SetID(id string) *UpdateFloatingIPOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetFloatingIPPatch : Allow user to set FloatingIPPatch +func (_options *UpdateFloatingIPOptions) SetFloatingIPPatch(floatingIPPatch map[string]interface{}) *UpdateFloatingIPOptions { + _options.FloatingIPPatch = floatingIPPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateFloatingIPOptions) SetHeaders(param map[string]string) *UpdateFloatingIPOptions { + options.Headers = param + return options +} + +// UpdateFlowLogCollectorOptions : The UpdateFlowLogCollector options. +type UpdateFlowLogCollectorOptions struct { + // The flow log collector identifier. + ID *string `json:"id" validate:"required,ne="` + + // The flow log collector patch. + FlowLogCollectorPatch map[string]interface{} `json:"FlowLogCollector_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateFlowLogCollectorOptions : Instantiate UpdateFlowLogCollectorOptions +func (*VpcV1) NewUpdateFlowLogCollectorOptions(id string, flowLogCollectorPatch map[string]interface{}) *UpdateFlowLogCollectorOptions { + return &UpdateFlowLogCollectorOptions{ + ID: core.StringPtr(id), + FlowLogCollectorPatch: flowLogCollectorPatch, + } +} + +// SetID : Allow user to set ID +func (_options *UpdateFlowLogCollectorOptions) SetID(id string) *UpdateFlowLogCollectorOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetFlowLogCollectorPatch : Allow user to set FlowLogCollectorPatch +func (_options *UpdateFlowLogCollectorOptions) SetFlowLogCollectorPatch(flowLogCollectorPatch map[string]interface{}) *UpdateFlowLogCollectorOptions { + _options.FlowLogCollectorPatch = flowLogCollectorPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateFlowLogCollectorOptions) SetHeaders(param map[string]string) *UpdateFlowLogCollectorOptions { + options.Headers = param + return options +} + +// UpdateIkePolicyOptions : The UpdateIkePolicy options. +type UpdateIkePolicyOptions struct { + // The IKE policy identifier. + ID *string `json:"id" validate:"required,ne="` + + // The IKE policy patch. + IkePolicyPatch map[string]interface{} `json:"IkePolicy_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateIkePolicyOptions : Instantiate UpdateIkePolicyOptions +func (*VpcV1) NewUpdateIkePolicyOptions(id string, ikePolicyPatch map[string]interface{}) *UpdateIkePolicyOptions { + return &UpdateIkePolicyOptions{ + ID: core.StringPtr(id), + IkePolicyPatch: ikePolicyPatch, + } +} + +// SetID : Allow user to set ID +func (_options *UpdateIkePolicyOptions) SetID(id string) *UpdateIkePolicyOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetIkePolicyPatch : Allow user to set IkePolicyPatch +func (_options *UpdateIkePolicyOptions) SetIkePolicyPatch(ikePolicyPatch map[string]interface{}) *UpdateIkePolicyOptions { + _options.IkePolicyPatch = ikePolicyPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateIkePolicyOptions) SetHeaders(param map[string]string) *UpdateIkePolicyOptions { + options.Headers = param + return options +} + +// UpdateImageExportJobOptions : The UpdateImageExportJob options. +type UpdateImageExportJobOptions struct { + // The image identifier. + ImageID *string `json:"image_id" validate:"required,ne="` + + // The image export job identifier. + ID *string `json:"id" validate:"required,ne="` + + // The image export job patch. + ImageExportJobPatch map[string]interface{} `json:"ImageExportJob_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateImageExportJobOptions : Instantiate UpdateImageExportJobOptions +func (*VpcV1) NewUpdateImageExportJobOptions(imageID string, id string, imageExportJobPatch map[string]interface{}) *UpdateImageExportJobOptions { + return &UpdateImageExportJobOptions{ + ImageID: core.StringPtr(imageID), + ID: core.StringPtr(id), + ImageExportJobPatch: imageExportJobPatch, + } +} + +// SetImageID : Allow user to set ImageID +func (_options *UpdateImageExportJobOptions) SetImageID(imageID string) *UpdateImageExportJobOptions { + _options.ImageID = core.StringPtr(imageID) + return _options +} + +// SetID : Allow user to set ID +func (_options *UpdateImageExportJobOptions) SetID(id string) *UpdateImageExportJobOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetImageExportJobPatch : Allow user to set ImageExportJobPatch +func (_options *UpdateImageExportJobOptions) SetImageExportJobPatch(imageExportJobPatch map[string]interface{}) *UpdateImageExportJobOptions { + _options.ImageExportJobPatch = imageExportJobPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateImageExportJobOptions) SetHeaders(param map[string]string) *UpdateImageExportJobOptions { + options.Headers = param + return options +} + +// UpdateImageOptions : The UpdateImage options. +type UpdateImageOptions struct { + // The image identifier. + ID *string `json:"id" validate:"required,ne="` + + // The image patch. + ImagePatch map[string]interface{} `json:"Image_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateImageOptions : Instantiate UpdateImageOptions +func (*VpcV1) NewUpdateImageOptions(id string, imagePatch map[string]interface{}) *UpdateImageOptions { + return &UpdateImageOptions{ + ID: core.StringPtr(id), + ImagePatch: imagePatch, + } +} + +// SetID : Allow user to set ID +func (_options *UpdateImageOptions) SetID(id string) *UpdateImageOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetImagePatch : Allow user to set ImagePatch +func (_options *UpdateImageOptions) SetImagePatch(imagePatch map[string]interface{}) *UpdateImageOptions { + _options.ImagePatch = imagePatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateImageOptions) SetHeaders(param map[string]string) *UpdateImageOptions { + options.Headers = param + return options +} + +// UpdateInstanceDiskOptions : The UpdateInstanceDisk options. +type UpdateInstanceDiskOptions struct { + // The virtual server instance identifier. + InstanceID *string `json:"instance_id" validate:"required,ne="` + + // The instance disk identifier. + ID *string `json:"id" validate:"required,ne="` + + // The instance disk patch. + InstanceDiskPatch map[string]interface{} `json:"InstanceDisk_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateInstanceDiskOptions : Instantiate UpdateInstanceDiskOptions +func (*VpcV1) NewUpdateInstanceDiskOptions(instanceID string, id string, instanceDiskPatch map[string]interface{}) *UpdateInstanceDiskOptions { + return &UpdateInstanceDiskOptions{ + InstanceID: core.StringPtr(instanceID), + ID: core.StringPtr(id), + InstanceDiskPatch: instanceDiskPatch, + } +} + +// SetInstanceID : Allow user to set InstanceID +func (_options *UpdateInstanceDiskOptions) SetInstanceID(instanceID string) *UpdateInstanceDiskOptions { + _options.InstanceID = core.StringPtr(instanceID) + return _options +} + +// SetID : Allow user to set ID +func (_options *UpdateInstanceDiskOptions) SetID(id string) *UpdateInstanceDiskOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetInstanceDiskPatch : Allow user to set InstanceDiskPatch +func (_options *UpdateInstanceDiskOptions) SetInstanceDiskPatch(instanceDiskPatch map[string]interface{}) *UpdateInstanceDiskOptions { + _options.InstanceDiskPatch = instanceDiskPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateInstanceDiskOptions) SetHeaders(param map[string]string) *UpdateInstanceDiskOptions { + options.Headers = param + return options +} + +// UpdateInstanceGroupManagerActionOptions : The UpdateInstanceGroupManagerAction options. +type UpdateInstanceGroupManagerActionOptions struct { + // The instance group identifier. + InstanceGroupID *string `json:"instance_group_id" validate:"required,ne="` + + // The instance group manager identifier. + InstanceGroupManagerID *string `json:"instance_group_manager_id" validate:"required,ne="` + + // The instance group manager action identifier. + ID *string `json:"id" validate:"required,ne="` + + // The instance group manager action patch. + InstanceGroupManagerActionPatch map[string]interface{} `json:"InstanceGroupManagerAction_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateInstanceGroupManagerActionOptions : Instantiate UpdateInstanceGroupManagerActionOptions +func (*VpcV1) NewUpdateInstanceGroupManagerActionOptions(instanceGroupID string, instanceGroupManagerID string, id string, instanceGroupManagerActionPatch map[string]interface{}) *UpdateInstanceGroupManagerActionOptions { + return &UpdateInstanceGroupManagerActionOptions{ + InstanceGroupID: core.StringPtr(instanceGroupID), + InstanceGroupManagerID: core.StringPtr(instanceGroupManagerID), + ID: core.StringPtr(id), + InstanceGroupManagerActionPatch: instanceGroupManagerActionPatch, + } +} + +// SetInstanceGroupID : Allow user to set InstanceGroupID +func (_options *UpdateInstanceGroupManagerActionOptions) SetInstanceGroupID(instanceGroupID string) *UpdateInstanceGroupManagerActionOptions { + _options.InstanceGroupID = core.StringPtr(instanceGroupID) + return _options +} + +// SetInstanceGroupManagerID : Allow user to set InstanceGroupManagerID +func (_options *UpdateInstanceGroupManagerActionOptions) SetInstanceGroupManagerID(instanceGroupManagerID string) *UpdateInstanceGroupManagerActionOptions { + _options.InstanceGroupManagerID = core.StringPtr(instanceGroupManagerID) + return _options +} + +// SetID : Allow user to set ID +func (_options *UpdateInstanceGroupManagerActionOptions) SetID(id string) *UpdateInstanceGroupManagerActionOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetInstanceGroupManagerActionPatch : Allow user to set InstanceGroupManagerActionPatch +func (_options *UpdateInstanceGroupManagerActionOptions) SetInstanceGroupManagerActionPatch(instanceGroupManagerActionPatch map[string]interface{}) *UpdateInstanceGroupManagerActionOptions { + _options.InstanceGroupManagerActionPatch = instanceGroupManagerActionPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateInstanceGroupManagerActionOptions) SetHeaders(param map[string]string) *UpdateInstanceGroupManagerActionOptions { + options.Headers = param + return options +} + +// UpdateInstanceGroupManagerOptions : The UpdateInstanceGroupManager options. +type UpdateInstanceGroupManagerOptions struct { + // The instance group identifier. + InstanceGroupID *string `json:"instance_group_id" validate:"required,ne="` + + // The instance group manager identifier. + ID *string `json:"id" validate:"required,ne="` + + // The instance group manager patch. + InstanceGroupManagerPatch map[string]interface{} `json:"InstanceGroupManager_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateInstanceGroupManagerOptions : Instantiate UpdateInstanceGroupManagerOptions +func (*VpcV1) NewUpdateInstanceGroupManagerOptions(instanceGroupID string, id string, instanceGroupManagerPatch map[string]interface{}) *UpdateInstanceGroupManagerOptions { + return &UpdateInstanceGroupManagerOptions{ + InstanceGroupID: core.StringPtr(instanceGroupID), + ID: core.StringPtr(id), + InstanceGroupManagerPatch: instanceGroupManagerPatch, + } +} + +// SetInstanceGroupID : Allow user to set InstanceGroupID +func (_options *UpdateInstanceGroupManagerOptions) SetInstanceGroupID(instanceGroupID string) *UpdateInstanceGroupManagerOptions { + _options.InstanceGroupID = core.StringPtr(instanceGroupID) + return _options +} + +// SetID : Allow user to set ID +func (_options *UpdateInstanceGroupManagerOptions) SetID(id string) *UpdateInstanceGroupManagerOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetInstanceGroupManagerPatch : Allow user to set InstanceGroupManagerPatch +func (_options *UpdateInstanceGroupManagerOptions) SetInstanceGroupManagerPatch(instanceGroupManagerPatch map[string]interface{}) *UpdateInstanceGroupManagerOptions { + _options.InstanceGroupManagerPatch = instanceGroupManagerPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateInstanceGroupManagerOptions) SetHeaders(param map[string]string) *UpdateInstanceGroupManagerOptions { + options.Headers = param + return options +} + +// UpdateInstanceGroupManagerPolicyOptions : The UpdateInstanceGroupManagerPolicy options. +type UpdateInstanceGroupManagerPolicyOptions struct { + // The instance group identifier. + InstanceGroupID *string `json:"instance_group_id" validate:"required,ne="` + + // The instance group manager identifier. + InstanceGroupManagerID *string `json:"instance_group_manager_id" validate:"required,ne="` + + // The instance group manager policy identifier. + ID *string `json:"id" validate:"required,ne="` + + // The instance group manager policy patch. + InstanceGroupManagerPolicyPatch map[string]interface{} `json:"InstanceGroupManagerPolicy_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateInstanceGroupManagerPolicyOptions : Instantiate UpdateInstanceGroupManagerPolicyOptions +func (*VpcV1) NewUpdateInstanceGroupManagerPolicyOptions(instanceGroupID string, instanceGroupManagerID string, id string, instanceGroupManagerPolicyPatch map[string]interface{}) *UpdateInstanceGroupManagerPolicyOptions { + return &UpdateInstanceGroupManagerPolicyOptions{ + InstanceGroupID: core.StringPtr(instanceGroupID), + InstanceGroupManagerID: core.StringPtr(instanceGroupManagerID), + ID: core.StringPtr(id), + InstanceGroupManagerPolicyPatch: instanceGroupManagerPolicyPatch, + } +} + +// SetInstanceGroupID : Allow user to set InstanceGroupID +func (_options *UpdateInstanceGroupManagerPolicyOptions) SetInstanceGroupID(instanceGroupID string) *UpdateInstanceGroupManagerPolicyOptions { + _options.InstanceGroupID = core.StringPtr(instanceGroupID) + return _options +} + +// SetInstanceGroupManagerID : Allow user to set InstanceGroupManagerID +func (_options *UpdateInstanceGroupManagerPolicyOptions) SetInstanceGroupManagerID(instanceGroupManagerID string) *UpdateInstanceGroupManagerPolicyOptions { + _options.InstanceGroupManagerID = core.StringPtr(instanceGroupManagerID) + return _options +} + +// SetID : Allow user to set ID +func (_options *UpdateInstanceGroupManagerPolicyOptions) SetID(id string) *UpdateInstanceGroupManagerPolicyOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetInstanceGroupManagerPolicyPatch : Allow user to set InstanceGroupManagerPolicyPatch +func (_options *UpdateInstanceGroupManagerPolicyOptions) SetInstanceGroupManagerPolicyPatch(instanceGroupManagerPolicyPatch map[string]interface{}) *UpdateInstanceGroupManagerPolicyOptions { + _options.InstanceGroupManagerPolicyPatch = instanceGroupManagerPolicyPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateInstanceGroupManagerPolicyOptions) SetHeaders(param map[string]string) *UpdateInstanceGroupManagerPolicyOptions { + options.Headers = param + return options +} + +// UpdateInstanceGroupMembershipOptions : The UpdateInstanceGroupMembership options. +type UpdateInstanceGroupMembershipOptions struct { + // The instance group identifier. + InstanceGroupID *string `json:"instance_group_id" validate:"required,ne="` + + // The instance group membership identifier. + ID *string `json:"id" validate:"required,ne="` + + // The instance group membership patch. + InstanceGroupMembershipPatch map[string]interface{} `json:"InstanceGroupMembership_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateInstanceGroupMembershipOptions : Instantiate UpdateInstanceGroupMembershipOptions +func (*VpcV1) NewUpdateInstanceGroupMembershipOptions(instanceGroupID string, id string, instanceGroupMembershipPatch map[string]interface{}) *UpdateInstanceGroupMembershipOptions { + return &UpdateInstanceGroupMembershipOptions{ + InstanceGroupID: core.StringPtr(instanceGroupID), + ID: core.StringPtr(id), + InstanceGroupMembershipPatch: instanceGroupMembershipPatch, + } +} + +// SetInstanceGroupID : Allow user to set InstanceGroupID +func (_options *UpdateInstanceGroupMembershipOptions) SetInstanceGroupID(instanceGroupID string) *UpdateInstanceGroupMembershipOptions { + _options.InstanceGroupID = core.StringPtr(instanceGroupID) + return _options +} + +// SetID : Allow user to set ID +func (_options *UpdateInstanceGroupMembershipOptions) SetID(id string) *UpdateInstanceGroupMembershipOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetInstanceGroupMembershipPatch : Allow user to set InstanceGroupMembershipPatch +func (_options *UpdateInstanceGroupMembershipOptions) SetInstanceGroupMembershipPatch(instanceGroupMembershipPatch map[string]interface{}) *UpdateInstanceGroupMembershipOptions { + _options.InstanceGroupMembershipPatch = instanceGroupMembershipPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateInstanceGroupMembershipOptions) SetHeaders(param map[string]string) *UpdateInstanceGroupMembershipOptions { + options.Headers = param + return options +} + +// UpdateInstanceGroupOptions : The UpdateInstanceGroup options. +type UpdateInstanceGroupOptions struct { + // The instance group identifier. + ID *string `json:"id" validate:"required,ne="` + + // The instance group patch. + InstanceGroupPatch map[string]interface{} `json:"InstanceGroup_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateInstanceGroupOptions : Instantiate UpdateInstanceGroupOptions +func (*VpcV1) NewUpdateInstanceGroupOptions(id string, instanceGroupPatch map[string]interface{}) *UpdateInstanceGroupOptions { + return &UpdateInstanceGroupOptions{ + ID: core.StringPtr(id), + InstanceGroupPatch: instanceGroupPatch, + } +} + +// SetID : Allow user to set ID +func (_options *UpdateInstanceGroupOptions) SetID(id string) *UpdateInstanceGroupOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetInstanceGroupPatch : Allow user to set InstanceGroupPatch +func (_options *UpdateInstanceGroupOptions) SetInstanceGroupPatch(instanceGroupPatch map[string]interface{}) *UpdateInstanceGroupOptions { + _options.InstanceGroupPatch = instanceGroupPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateInstanceGroupOptions) SetHeaders(param map[string]string) *UpdateInstanceGroupOptions { + options.Headers = param + return options +} + +// UpdateInstanceNetworkInterfaceOptions : The UpdateInstanceNetworkInterface options. +type UpdateInstanceNetworkInterfaceOptions struct { + // The virtual server instance identifier. + InstanceID *string `json:"instance_id" validate:"required,ne="` + + // The instance network interface identifier. + ID *string `json:"id" validate:"required,ne="` + + // The instance network interface patch. + NetworkInterfacePatch map[string]interface{} `json:"NetworkInterface_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateInstanceNetworkInterfaceOptions : Instantiate UpdateInstanceNetworkInterfaceOptions +func (*VpcV1) NewUpdateInstanceNetworkInterfaceOptions(instanceID string, id string, networkInterfacePatch map[string]interface{}) *UpdateInstanceNetworkInterfaceOptions { + return &UpdateInstanceNetworkInterfaceOptions{ + InstanceID: core.StringPtr(instanceID), + ID: core.StringPtr(id), + NetworkInterfacePatch: networkInterfacePatch, + } +} + +// SetInstanceID : Allow user to set InstanceID +func (_options *UpdateInstanceNetworkInterfaceOptions) SetInstanceID(instanceID string) *UpdateInstanceNetworkInterfaceOptions { + _options.InstanceID = core.StringPtr(instanceID) + return _options +} + +// SetID : Allow user to set ID +func (_options *UpdateInstanceNetworkInterfaceOptions) SetID(id string) *UpdateInstanceNetworkInterfaceOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetNetworkInterfacePatch : Allow user to set NetworkInterfacePatch +func (_options *UpdateInstanceNetworkInterfaceOptions) SetNetworkInterfacePatch(networkInterfacePatch map[string]interface{}) *UpdateInstanceNetworkInterfaceOptions { + _options.NetworkInterfacePatch = networkInterfacePatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateInstanceNetworkInterfaceOptions) SetHeaders(param map[string]string) *UpdateInstanceNetworkInterfaceOptions { + options.Headers = param + return options +} + +// UpdateInstanceOptions : The UpdateInstance options. +type UpdateInstanceOptions struct { + // The virtual server instance identifier. + ID *string `json:"id" validate:"required,ne="` + + // The instance patch. + InstancePatch map[string]interface{} `json:"Instance_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateInstanceOptions : Instantiate UpdateInstanceOptions +func (*VpcV1) NewUpdateInstanceOptions(id string, instancePatch map[string]interface{}) *UpdateInstanceOptions { + return &UpdateInstanceOptions{ + ID: core.StringPtr(id), + InstancePatch: instancePatch, + } +} + +// SetID : Allow user to set ID +func (_options *UpdateInstanceOptions) SetID(id string) *UpdateInstanceOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetInstancePatch : Allow user to set InstancePatch +func (_options *UpdateInstanceOptions) SetInstancePatch(instancePatch map[string]interface{}) *UpdateInstanceOptions { + _options.InstancePatch = instancePatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateInstanceOptions) SetHeaders(param map[string]string) *UpdateInstanceOptions { + options.Headers = param + return options +} + +// UpdateInstanceTemplateOptions : The UpdateInstanceTemplate options. +type UpdateInstanceTemplateOptions struct { + // The instance template identifier. + ID *string `json:"id" validate:"required,ne="` + + // The instance template patch. + InstanceTemplatePatch map[string]interface{} `json:"InstanceTemplate_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateInstanceTemplateOptions : Instantiate UpdateInstanceTemplateOptions +func (*VpcV1) NewUpdateInstanceTemplateOptions(id string, instanceTemplatePatch map[string]interface{}) *UpdateInstanceTemplateOptions { + return &UpdateInstanceTemplateOptions{ + ID: core.StringPtr(id), + InstanceTemplatePatch: instanceTemplatePatch, + } +} + +// SetID : Allow user to set ID +func (_options *UpdateInstanceTemplateOptions) SetID(id string) *UpdateInstanceTemplateOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetInstanceTemplatePatch : Allow user to set InstanceTemplatePatch +func (_options *UpdateInstanceTemplateOptions) SetInstanceTemplatePatch(instanceTemplatePatch map[string]interface{}) *UpdateInstanceTemplateOptions { + _options.InstanceTemplatePatch = instanceTemplatePatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateInstanceTemplateOptions) SetHeaders(param map[string]string) *UpdateInstanceTemplateOptions { + options.Headers = param + return options +} + +// UpdateInstanceVolumeAttachmentOptions : The UpdateInstanceVolumeAttachment options. +type UpdateInstanceVolumeAttachmentOptions struct { + // The virtual server instance identifier. + InstanceID *string `json:"instance_id" validate:"required,ne="` + + // The volume attachment identifier. + ID *string `json:"id" validate:"required,ne="` + + // The volume attachment patch. + VolumeAttachmentPatch map[string]interface{} `json:"VolumeAttachment_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateInstanceVolumeAttachmentOptions : Instantiate UpdateInstanceVolumeAttachmentOptions +func (*VpcV1) NewUpdateInstanceVolumeAttachmentOptions(instanceID string, id string, volumeAttachmentPatch map[string]interface{}) *UpdateInstanceVolumeAttachmentOptions { + return &UpdateInstanceVolumeAttachmentOptions{ + InstanceID: core.StringPtr(instanceID), + ID: core.StringPtr(id), + VolumeAttachmentPatch: volumeAttachmentPatch, + } +} + +// SetInstanceID : Allow user to set InstanceID +func (_options *UpdateInstanceVolumeAttachmentOptions) SetInstanceID(instanceID string) *UpdateInstanceVolumeAttachmentOptions { + _options.InstanceID = core.StringPtr(instanceID) + return _options +} + +// SetID : Allow user to set ID +func (_options *UpdateInstanceVolumeAttachmentOptions) SetID(id string) *UpdateInstanceVolumeAttachmentOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetVolumeAttachmentPatch : Allow user to set VolumeAttachmentPatch +func (_options *UpdateInstanceVolumeAttachmentOptions) SetVolumeAttachmentPatch(volumeAttachmentPatch map[string]interface{}) *UpdateInstanceVolumeAttachmentOptions { + _options.VolumeAttachmentPatch = volumeAttachmentPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateInstanceVolumeAttachmentOptions) SetHeaders(param map[string]string) *UpdateInstanceVolumeAttachmentOptions { + options.Headers = param + return options +} + +// UpdateIpsecPolicyOptions : The UpdateIpsecPolicy options. +type UpdateIpsecPolicyOptions struct { + // The IPsec policy identifier. + ID *string `json:"id" validate:"required,ne="` + + // The IPsec policy patch. + IPsecPolicyPatch map[string]interface{} `json:"IPsecPolicy_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateIpsecPolicyOptions : Instantiate UpdateIpsecPolicyOptions +func (*VpcV1) NewUpdateIpsecPolicyOptions(id string, iPsecPolicyPatch map[string]interface{}) *UpdateIpsecPolicyOptions { + return &UpdateIpsecPolicyOptions{ + ID: core.StringPtr(id), + IPsecPolicyPatch: iPsecPolicyPatch, + } +} + +// SetID : Allow user to set ID +func (_options *UpdateIpsecPolicyOptions) SetID(id string) *UpdateIpsecPolicyOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetIPsecPolicyPatch : Allow user to set IPsecPolicyPatch +func (_options *UpdateIpsecPolicyOptions) SetIPsecPolicyPatch(iPsecPolicyPatch map[string]interface{}) *UpdateIpsecPolicyOptions { + _options.IPsecPolicyPatch = iPsecPolicyPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateIpsecPolicyOptions) SetHeaders(param map[string]string) *UpdateIpsecPolicyOptions { + options.Headers = param + return options +} + +// UpdateKeyOptions : The UpdateKey options. +type UpdateKeyOptions struct { + // The key identifier. + ID *string `json:"id" validate:"required,ne="` + + // The key patch. + KeyPatch map[string]interface{} `json:"Key_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateKeyOptions : Instantiate UpdateKeyOptions +func (*VpcV1) NewUpdateKeyOptions(id string, keyPatch map[string]interface{}) *UpdateKeyOptions { + return &UpdateKeyOptions{ + ID: core.StringPtr(id), + KeyPatch: keyPatch, + } +} + +// SetID : Allow user to set ID +func (_options *UpdateKeyOptions) SetID(id string) *UpdateKeyOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetKeyPatch : Allow user to set KeyPatch +func (_options *UpdateKeyOptions) SetKeyPatch(keyPatch map[string]interface{}) *UpdateKeyOptions { + _options.KeyPatch = keyPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateKeyOptions) SetHeaders(param map[string]string) *UpdateKeyOptions { + options.Headers = param + return options +} + +// UpdateLoadBalancerListenerOptions : The UpdateLoadBalancerListener options. +type UpdateLoadBalancerListenerOptions struct { + // The load balancer identifier. + LoadBalancerID *string `json:"load_balancer_id" validate:"required,ne="` + + // The listener identifier. + ID *string `json:"id" validate:"required,ne="` + + // The load balancer listener patch. + LoadBalancerListenerPatch map[string]interface{} `json:"LoadBalancerListener_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateLoadBalancerListenerOptions : Instantiate UpdateLoadBalancerListenerOptions +func (*VpcV1) NewUpdateLoadBalancerListenerOptions(loadBalancerID string, id string, loadBalancerListenerPatch map[string]interface{}) *UpdateLoadBalancerListenerOptions { + return &UpdateLoadBalancerListenerOptions{ + LoadBalancerID: core.StringPtr(loadBalancerID), + ID: core.StringPtr(id), + LoadBalancerListenerPatch: loadBalancerListenerPatch, + } +} + +// SetLoadBalancerID : Allow user to set LoadBalancerID +func (_options *UpdateLoadBalancerListenerOptions) SetLoadBalancerID(loadBalancerID string) *UpdateLoadBalancerListenerOptions { + _options.LoadBalancerID = core.StringPtr(loadBalancerID) + return _options +} + +// SetID : Allow user to set ID +func (_options *UpdateLoadBalancerListenerOptions) SetID(id string) *UpdateLoadBalancerListenerOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetLoadBalancerListenerPatch : Allow user to set LoadBalancerListenerPatch +func (_options *UpdateLoadBalancerListenerOptions) SetLoadBalancerListenerPatch(loadBalancerListenerPatch map[string]interface{}) *UpdateLoadBalancerListenerOptions { + _options.LoadBalancerListenerPatch = loadBalancerListenerPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateLoadBalancerListenerOptions) SetHeaders(param map[string]string) *UpdateLoadBalancerListenerOptions { + options.Headers = param + return options +} + +// UpdateLoadBalancerListenerPolicyOptions : The UpdateLoadBalancerListenerPolicy options. +type UpdateLoadBalancerListenerPolicyOptions struct { + // The load balancer identifier. + LoadBalancerID *string `json:"load_balancer_id" validate:"required,ne="` + + // The listener identifier. + ListenerID *string `json:"listener_id" validate:"required,ne="` + + // The policy identifier. + ID *string `json:"id" validate:"required,ne="` + + // The listener policy patch. + LoadBalancerListenerPolicyPatch map[string]interface{} `json:"LoadBalancerListenerPolicy_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateLoadBalancerListenerPolicyOptions : Instantiate UpdateLoadBalancerListenerPolicyOptions +func (*VpcV1) NewUpdateLoadBalancerListenerPolicyOptions(loadBalancerID string, listenerID string, id string, loadBalancerListenerPolicyPatch map[string]interface{}) *UpdateLoadBalancerListenerPolicyOptions { + return &UpdateLoadBalancerListenerPolicyOptions{ + LoadBalancerID: core.StringPtr(loadBalancerID), + ListenerID: core.StringPtr(listenerID), + ID: core.StringPtr(id), + LoadBalancerListenerPolicyPatch: loadBalancerListenerPolicyPatch, + } +} + +// SetLoadBalancerID : Allow user to set LoadBalancerID +func (_options *UpdateLoadBalancerListenerPolicyOptions) SetLoadBalancerID(loadBalancerID string) *UpdateLoadBalancerListenerPolicyOptions { + _options.LoadBalancerID = core.StringPtr(loadBalancerID) + return _options +} + +// SetListenerID : Allow user to set ListenerID +func (_options *UpdateLoadBalancerListenerPolicyOptions) SetListenerID(listenerID string) *UpdateLoadBalancerListenerPolicyOptions { + _options.ListenerID = core.StringPtr(listenerID) + return _options +} + +// SetID : Allow user to set ID +func (_options *UpdateLoadBalancerListenerPolicyOptions) SetID(id string) *UpdateLoadBalancerListenerPolicyOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetLoadBalancerListenerPolicyPatch : Allow user to set LoadBalancerListenerPolicyPatch +func (_options *UpdateLoadBalancerListenerPolicyOptions) SetLoadBalancerListenerPolicyPatch(loadBalancerListenerPolicyPatch map[string]interface{}) *UpdateLoadBalancerListenerPolicyOptions { + _options.LoadBalancerListenerPolicyPatch = loadBalancerListenerPolicyPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateLoadBalancerListenerPolicyOptions) SetHeaders(param map[string]string) *UpdateLoadBalancerListenerPolicyOptions { + options.Headers = param + return options +} + +// UpdateLoadBalancerListenerPolicyRuleOptions : The UpdateLoadBalancerListenerPolicyRule options. +type UpdateLoadBalancerListenerPolicyRuleOptions struct { + // The load balancer identifier. + LoadBalancerID *string `json:"load_balancer_id" validate:"required,ne="` + + // The listener identifier. + ListenerID *string `json:"listener_id" validate:"required,ne="` + + // The policy identifier. + PolicyID *string `json:"policy_id" validate:"required,ne="` + + // The rule identifier. + ID *string `json:"id" validate:"required,ne="` + + // The listener policy rule patch. + LoadBalancerListenerPolicyRulePatch map[string]interface{} `json:"LoadBalancerListenerPolicyRule_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateLoadBalancerListenerPolicyRuleOptions : Instantiate UpdateLoadBalancerListenerPolicyRuleOptions +func (*VpcV1) NewUpdateLoadBalancerListenerPolicyRuleOptions(loadBalancerID string, listenerID string, policyID string, id string, loadBalancerListenerPolicyRulePatch map[string]interface{}) *UpdateLoadBalancerListenerPolicyRuleOptions { + return &UpdateLoadBalancerListenerPolicyRuleOptions{ + LoadBalancerID: core.StringPtr(loadBalancerID), + ListenerID: core.StringPtr(listenerID), + PolicyID: core.StringPtr(policyID), + ID: core.StringPtr(id), + LoadBalancerListenerPolicyRulePatch: loadBalancerListenerPolicyRulePatch, + } +} + +// SetLoadBalancerID : Allow user to set LoadBalancerID +func (_options *UpdateLoadBalancerListenerPolicyRuleOptions) SetLoadBalancerID(loadBalancerID string) *UpdateLoadBalancerListenerPolicyRuleOptions { + _options.LoadBalancerID = core.StringPtr(loadBalancerID) + return _options +} + +// SetListenerID : Allow user to set ListenerID +func (_options *UpdateLoadBalancerListenerPolicyRuleOptions) SetListenerID(listenerID string) *UpdateLoadBalancerListenerPolicyRuleOptions { + _options.ListenerID = core.StringPtr(listenerID) + return _options +} + +// SetPolicyID : Allow user to set PolicyID +func (_options *UpdateLoadBalancerListenerPolicyRuleOptions) SetPolicyID(policyID string) *UpdateLoadBalancerListenerPolicyRuleOptions { + _options.PolicyID = core.StringPtr(policyID) + return _options +} + +// SetID : Allow user to set ID +func (_options *UpdateLoadBalancerListenerPolicyRuleOptions) SetID(id string) *UpdateLoadBalancerListenerPolicyRuleOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetLoadBalancerListenerPolicyRulePatch : Allow user to set LoadBalancerListenerPolicyRulePatch +func (_options *UpdateLoadBalancerListenerPolicyRuleOptions) SetLoadBalancerListenerPolicyRulePatch(loadBalancerListenerPolicyRulePatch map[string]interface{}) *UpdateLoadBalancerListenerPolicyRuleOptions { + _options.LoadBalancerListenerPolicyRulePatch = loadBalancerListenerPolicyRulePatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateLoadBalancerListenerPolicyRuleOptions) SetHeaders(param map[string]string) *UpdateLoadBalancerListenerPolicyRuleOptions { + options.Headers = param + return options +} + +// UpdateLoadBalancerOptions : The UpdateLoadBalancer options. +type UpdateLoadBalancerOptions struct { + // The load balancer identifier. + ID *string `json:"id" validate:"required,ne="` + + // The load balancer patch. + LoadBalancerPatch map[string]interface{} `json:"LoadBalancer_patch" validate:"required"` + + // If present, the request will fail if the specified ETag value does not match the resource's current ETag value. + // Required if the request body includes an array. + IfMatch *string `json:"If-Match,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateLoadBalancerOptions : Instantiate UpdateLoadBalancerOptions +func (*VpcV1) NewUpdateLoadBalancerOptions(id string, loadBalancerPatch map[string]interface{}) *UpdateLoadBalancerOptions { + return &UpdateLoadBalancerOptions{ + ID: core.StringPtr(id), + LoadBalancerPatch: loadBalancerPatch, + } +} + +// SetID : Allow user to set ID +func (_options *UpdateLoadBalancerOptions) SetID(id string) *UpdateLoadBalancerOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetLoadBalancerPatch : Allow user to set LoadBalancerPatch +func (_options *UpdateLoadBalancerOptions) SetLoadBalancerPatch(loadBalancerPatch map[string]interface{}) *UpdateLoadBalancerOptions { + _options.LoadBalancerPatch = loadBalancerPatch + return _options +} + +// SetIfMatch : Allow user to set IfMatch +func (_options *UpdateLoadBalancerOptions) SetIfMatch(ifMatch string) *UpdateLoadBalancerOptions { + _options.IfMatch = core.StringPtr(ifMatch) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateLoadBalancerOptions) SetHeaders(param map[string]string) *UpdateLoadBalancerOptions { + options.Headers = param + return options +} + +// UpdateLoadBalancerPoolMemberOptions : The UpdateLoadBalancerPoolMember options. +type UpdateLoadBalancerPoolMemberOptions struct { + // The load balancer identifier. + LoadBalancerID *string `json:"load_balancer_id" validate:"required,ne="` + + // The pool identifier. + PoolID *string `json:"pool_id" validate:"required,ne="` + + // The member identifier. + ID *string `json:"id" validate:"required,ne="` + + // The load balancer pool member patch. + LoadBalancerPoolMemberPatch map[string]interface{} `json:"LoadBalancerPoolMember_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateLoadBalancerPoolMemberOptions : Instantiate UpdateLoadBalancerPoolMemberOptions +func (*VpcV1) NewUpdateLoadBalancerPoolMemberOptions(loadBalancerID string, poolID string, id string, loadBalancerPoolMemberPatch map[string]interface{}) *UpdateLoadBalancerPoolMemberOptions { + return &UpdateLoadBalancerPoolMemberOptions{ + LoadBalancerID: core.StringPtr(loadBalancerID), + PoolID: core.StringPtr(poolID), + ID: core.StringPtr(id), + LoadBalancerPoolMemberPatch: loadBalancerPoolMemberPatch, + } +} + +// SetLoadBalancerID : Allow user to set LoadBalancerID +func (_options *UpdateLoadBalancerPoolMemberOptions) SetLoadBalancerID(loadBalancerID string) *UpdateLoadBalancerPoolMemberOptions { + _options.LoadBalancerID = core.StringPtr(loadBalancerID) + return _options +} + +// SetPoolID : Allow user to set PoolID +func (_options *UpdateLoadBalancerPoolMemberOptions) SetPoolID(poolID string) *UpdateLoadBalancerPoolMemberOptions { + _options.PoolID = core.StringPtr(poolID) + return _options +} + +// SetID : Allow user to set ID +func (_options *UpdateLoadBalancerPoolMemberOptions) SetID(id string) *UpdateLoadBalancerPoolMemberOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetLoadBalancerPoolMemberPatch : Allow user to set LoadBalancerPoolMemberPatch +func (_options *UpdateLoadBalancerPoolMemberOptions) SetLoadBalancerPoolMemberPatch(loadBalancerPoolMemberPatch map[string]interface{}) *UpdateLoadBalancerPoolMemberOptions { + _options.LoadBalancerPoolMemberPatch = loadBalancerPoolMemberPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateLoadBalancerPoolMemberOptions) SetHeaders(param map[string]string) *UpdateLoadBalancerPoolMemberOptions { + options.Headers = param + return options +} + +// UpdateLoadBalancerPoolOptions : The UpdateLoadBalancerPool options. +type UpdateLoadBalancerPoolOptions struct { + // The load balancer identifier. + LoadBalancerID *string `json:"load_balancer_id" validate:"required,ne="` + + // The pool identifier. + ID *string `json:"id" validate:"required,ne="` + + // The load balancer pool patch. + LoadBalancerPoolPatch map[string]interface{} `json:"LoadBalancerPool_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateLoadBalancerPoolOptions : Instantiate UpdateLoadBalancerPoolOptions +func (*VpcV1) NewUpdateLoadBalancerPoolOptions(loadBalancerID string, id string, loadBalancerPoolPatch map[string]interface{}) *UpdateLoadBalancerPoolOptions { + return &UpdateLoadBalancerPoolOptions{ + LoadBalancerID: core.StringPtr(loadBalancerID), + ID: core.StringPtr(id), + LoadBalancerPoolPatch: loadBalancerPoolPatch, + } +} + +// SetLoadBalancerID : Allow user to set LoadBalancerID +func (_options *UpdateLoadBalancerPoolOptions) SetLoadBalancerID(loadBalancerID string) *UpdateLoadBalancerPoolOptions { + _options.LoadBalancerID = core.StringPtr(loadBalancerID) + return _options +} + +// SetID : Allow user to set ID +func (_options *UpdateLoadBalancerPoolOptions) SetID(id string) *UpdateLoadBalancerPoolOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetLoadBalancerPoolPatch : Allow user to set LoadBalancerPoolPatch +func (_options *UpdateLoadBalancerPoolOptions) SetLoadBalancerPoolPatch(loadBalancerPoolPatch map[string]interface{}) *UpdateLoadBalancerPoolOptions { + _options.LoadBalancerPoolPatch = loadBalancerPoolPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateLoadBalancerPoolOptions) SetHeaders(param map[string]string) *UpdateLoadBalancerPoolOptions { + options.Headers = param + return options +} + +// UpdateNetworkACLOptions : The UpdateNetworkACL options. +type UpdateNetworkACLOptions struct { + // The network ACL identifier. + ID *string `json:"id" validate:"required,ne="` + + // The network ACL patch. + NetworkACLPatch map[string]interface{} `json:"NetworkACL_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateNetworkACLOptions : Instantiate UpdateNetworkACLOptions +func (*VpcV1) NewUpdateNetworkACLOptions(id string, networkACLPatch map[string]interface{}) *UpdateNetworkACLOptions { + return &UpdateNetworkACLOptions{ + ID: core.StringPtr(id), + NetworkACLPatch: networkACLPatch, + } +} + +// SetID : Allow user to set ID +func (_options *UpdateNetworkACLOptions) SetID(id string) *UpdateNetworkACLOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetNetworkACLPatch : Allow user to set NetworkACLPatch +func (_options *UpdateNetworkACLOptions) SetNetworkACLPatch(networkACLPatch map[string]interface{}) *UpdateNetworkACLOptions { + _options.NetworkACLPatch = networkACLPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateNetworkACLOptions) SetHeaders(param map[string]string) *UpdateNetworkACLOptions { + options.Headers = param + return options +} + +// UpdateNetworkACLRuleOptions : The UpdateNetworkACLRule options. +type UpdateNetworkACLRuleOptions struct { + // The network ACL identifier. + NetworkACLID *string `json:"network_acl_id" validate:"required,ne="` + + // The rule identifier. + ID *string `json:"id" validate:"required,ne="` + + // The network ACL rule patch. + NetworkACLRulePatch map[string]interface{} `json:"NetworkACLRule_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateNetworkACLRuleOptions : Instantiate UpdateNetworkACLRuleOptions +func (*VpcV1) NewUpdateNetworkACLRuleOptions(networkACLID string, id string, networkACLRulePatch map[string]interface{}) *UpdateNetworkACLRuleOptions { + return &UpdateNetworkACLRuleOptions{ + NetworkACLID: core.StringPtr(networkACLID), + ID: core.StringPtr(id), + NetworkACLRulePatch: networkACLRulePatch, + } +} + +// SetNetworkACLID : Allow user to set NetworkACLID +func (_options *UpdateNetworkACLRuleOptions) SetNetworkACLID(networkACLID string) *UpdateNetworkACLRuleOptions { + _options.NetworkACLID = core.StringPtr(networkACLID) + return _options +} + +// SetID : Allow user to set ID +func (_options *UpdateNetworkACLRuleOptions) SetID(id string) *UpdateNetworkACLRuleOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetNetworkACLRulePatch : Allow user to set NetworkACLRulePatch +func (_options *UpdateNetworkACLRuleOptions) SetNetworkACLRulePatch(networkACLRulePatch map[string]interface{}) *UpdateNetworkACLRuleOptions { + _options.NetworkACLRulePatch = networkACLRulePatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateNetworkACLRuleOptions) SetHeaders(param map[string]string) *UpdateNetworkACLRuleOptions { + options.Headers = param + return options +} + +// UpdatePlacementGroupOptions : The UpdatePlacementGroup options. +type UpdatePlacementGroupOptions struct { + // The placement group identifier. + ID *string `json:"id" validate:"required,ne="` + + // The placement group patch. + PlacementGroupPatch map[string]interface{} `json:"PlacementGroup_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdatePlacementGroupOptions : Instantiate UpdatePlacementGroupOptions +func (*VpcV1) NewUpdatePlacementGroupOptions(id string, placementGroupPatch map[string]interface{}) *UpdatePlacementGroupOptions { + return &UpdatePlacementGroupOptions{ + ID: core.StringPtr(id), + PlacementGroupPatch: placementGroupPatch, + } +} + +// SetID : Allow user to set ID +func (_options *UpdatePlacementGroupOptions) SetID(id string) *UpdatePlacementGroupOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetPlacementGroupPatch : Allow user to set PlacementGroupPatch +func (_options *UpdatePlacementGroupOptions) SetPlacementGroupPatch(placementGroupPatch map[string]interface{}) *UpdatePlacementGroupOptions { + _options.PlacementGroupPatch = placementGroupPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdatePlacementGroupOptions) SetHeaders(param map[string]string) *UpdatePlacementGroupOptions { + options.Headers = param + return options +} + +// UpdatePublicGatewayOptions : The UpdatePublicGateway options. +type UpdatePublicGatewayOptions struct { + // The public gateway identifier. + ID *string `json:"id" validate:"required,ne="` + + // The public gateway patch. + PublicGatewayPatch map[string]interface{} `json:"PublicGateway_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdatePublicGatewayOptions : Instantiate UpdatePublicGatewayOptions +func (*VpcV1) NewUpdatePublicGatewayOptions(id string, publicGatewayPatch map[string]interface{}) *UpdatePublicGatewayOptions { + return &UpdatePublicGatewayOptions{ + ID: core.StringPtr(id), + PublicGatewayPatch: publicGatewayPatch, + } +} + +// SetID : Allow user to set ID +func (_options *UpdatePublicGatewayOptions) SetID(id string) *UpdatePublicGatewayOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetPublicGatewayPatch : Allow user to set PublicGatewayPatch +func (_options *UpdatePublicGatewayOptions) SetPublicGatewayPatch(publicGatewayPatch map[string]interface{}) *UpdatePublicGatewayOptions { + _options.PublicGatewayPatch = publicGatewayPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdatePublicGatewayOptions) SetHeaders(param map[string]string) *UpdatePublicGatewayOptions { + options.Headers = param + return options +} + +// UpdateSecurityGroupOptions : The UpdateSecurityGroup options. +type UpdateSecurityGroupOptions struct { + // The security group identifier. + ID *string `json:"id" validate:"required,ne="` + + // The security group patch. + SecurityGroupPatch map[string]interface{} `json:"SecurityGroup_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateSecurityGroupOptions : Instantiate UpdateSecurityGroupOptions +func (*VpcV1) NewUpdateSecurityGroupOptions(id string, securityGroupPatch map[string]interface{}) *UpdateSecurityGroupOptions { + return &UpdateSecurityGroupOptions{ + ID: core.StringPtr(id), + SecurityGroupPatch: securityGroupPatch, + } +} + +// SetID : Allow user to set ID +func (_options *UpdateSecurityGroupOptions) SetID(id string) *UpdateSecurityGroupOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetSecurityGroupPatch : Allow user to set SecurityGroupPatch +func (_options *UpdateSecurityGroupOptions) SetSecurityGroupPatch(securityGroupPatch map[string]interface{}) *UpdateSecurityGroupOptions { + _options.SecurityGroupPatch = securityGroupPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateSecurityGroupOptions) SetHeaders(param map[string]string) *UpdateSecurityGroupOptions { + options.Headers = param + return options +} + +// UpdateSecurityGroupRuleOptions : The UpdateSecurityGroupRule options. +type UpdateSecurityGroupRuleOptions struct { + // The security group identifier. + SecurityGroupID *string `json:"security_group_id" validate:"required,ne="` + + // The rule identifier. + ID *string `json:"id" validate:"required,ne="` + + // The security group rule patch. + SecurityGroupRulePatch map[string]interface{} `json:"SecurityGroupRule_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateSecurityGroupRuleOptions : Instantiate UpdateSecurityGroupRuleOptions +func (*VpcV1) NewUpdateSecurityGroupRuleOptions(securityGroupID string, id string, securityGroupRulePatch map[string]interface{}) *UpdateSecurityGroupRuleOptions { + return &UpdateSecurityGroupRuleOptions{ + SecurityGroupID: core.StringPtr(securityGroupID), + ID: core.StringPtr(id), + SecurityGroupRulePatch: securityGroupRulePatch, + } +} + +// SetSecurityGroupID : Allow user to set SecurityGroupID +func (_options *UpdateSecurityGroupRuleOptions) SetSecurityGroupID(securityGroupID string) *UpdateSecurityGroupRuleOptions { + _options.SecurityGroupID = core.StringPtr(securityGroupID) + return _options +} + +// SetID : Allow user to set ID +func (_options *UpdateSecurityGroupRuleOptions) SetID(id string) *UpdateSecurityGroupRuleOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetSecurityGroupRulePatch : Allow user to set SecurityGroupRulePatch +func (_options *UpdateSecurityGroupRuleOptions) SetSecurityGroupRulePatch(securityGroupRulePatch map[string]interface{}) *UpdateSecurityGroupRuleOptions { + _options.SecurityGroupRulePatch = securityGroupRulePatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateSecurityGroupRuleOptions) SetHeaders(param map[string]string) *UpdateSecurityGroupRuleOptions { + options.Headers = param + return options +} + +// UpdateShareMountTargetOptions : The UpdateShareMountTarget options. +type UpdateShareMountTargetOptions struct { + // The file share identifier. + ShareID *string `json:"share_id" validate:"required,ne="` + + // The share mount target identifier. + ID *string `json:"id" validate:"required,ne="` + + // The share mount target patch. + ShareMountTargetPatch map[string]interface{} `json:"ShareMountTarget_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateShareMountTargetOptions : Instantiate UpdateShareMountTargetOptions +func (*VpcV1) NewUpdateShareMountTargetOptions(shareID string, id string, shareMountTargetPatch map[string]interface{}) *UpdateShareMountTargetOptions { + return &UpdateShareMountTargetOptions{ + ShareID: core.StringPtr(shareID), + ID: core.StringPtr(id), + ShareMountTargetPatch: shareMountTargetPatch, + } +} + +// SetShareID : Allow user to set ShareID +func (_options *UpdateShareMountTargetOptions) SetShareID(shareID string) *UpdateShareMountTargetOptions { + _options.ShareID = core.StringPtr(shareID) + return _options +} + +// SetID : Allow user to set ID +func (_options *UpdateShareMountTargetOptions) SetID(id string) *UpdateShareMountTargetOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetShareMountTargetPatch : Allow user to set ShareMountTargetPatch +func (_options *UpdateShareMountTargetOptions) SetShareMountTargetPatch(shareMountTargetPatch map[string]interface{}) *UpdateShareMountTargetOptions { + _options.ShareMountTargetPatch = shareMountTargetPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateShareMountTargetOptions) SetHeaders(param map[string]string) *UpdateShareMountTargetOptions { + options.Headers = param + return options +} + +// UpdateShareOptions : The UpdateShare options. +type UpdateShareOptions struct { + // The file share identifier. + ID *string `json:"id" validate:"required,ne="` + + // The file share patch. + SharePatch map[string]interface{} `json:"Share_patch" validate:"required"` + + // If present, the request will fail if the specified ETag value does not match the resource's current ETag value. + // Required if the request body includes an array. + IfMatch *string `json:"If-Match,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateShareOptions : Instantiate UpdateShareOptions +func (*VpcV1) NewUpdateShareOptions(id string, sharePatch map[string]interface{}) *UpdateShareOptions { + return &UpdateShareOptions{ + ID: core.StringPtr(id), + SharePatch: sharePatch, + } +} + +// SetID : Allow user to set ID +func (_options *UpdateShareOptions) SetID(id string) *UpdateShareOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetSharePatch : Allow user to set SharePatch +func (_options *UpdateShareOptions) SetSharePatch(sharePatch map[string]interface{}) *UpdateShareOptions { + _options.SharePatch = sharePatch + return _options +} + +// SetIfMatch : Allow user to set IfMatch +func (_options *UpdateShareOptions) SetIfMatch(ifMatch string) *UpdateShareOptions { + _options.IfMatch = core.StringPtr(ifMatch) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateShareOptions) SetHeaders(param map[string]string) *UpdateShareOptions { + options.Headers = param + return options +} + +// UpdateSnapshotOptions : The UpdateSnapshot options. +type UpdateSnapshotOptions struct { + // The snapshot identifier. + ID *string `json:"id" validate:"required,ne="` + + // The snapshot patch. + SnapshotPatch map[string]interface{} `json:"Snapshot_patch" validate:"required"` + + // If present, the request will fail if the specified ETag value does not match the resource's current ETag value. + // Required if the request body includes an array. + IfMatch *string `json:"If-Match,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateSnapshotOptions : Instantiate UpdateSnapshotOptions +func (*VpcV1) NewUpdateSnapshotOptions(id string, snapshotPatch map[string]interface{}) *UpdateSnapshotOptions { + return &UpdateSnapshotOptions{ + ID: core.StringPtr(id), + SnapshotPatch: snapshotPatch, + } +} + +// SetID : Allow user to set ID +func (_options *UpdateSnapshotOptions) SetID(id string) *UpdateSnapshotOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetSnapshotPatch : Allow user to set SnapshotPatch +func (_options *UpdateSnapshotOptions) SetSnapshotPatch(snapshotPatch map[string]interface{}) *UpdateSnapshotOptions { + _options.SnapshotPatch = snapshotPatch + return _options +} + +// SetIfMatch : Allow user to set IfMatch +func (_options *UpdateSnapshotOptions) SetIfMatch(ifMatch string) *UpdateSnapshotOptions { + _options.IfMatch = core.StringPtr(ifMatch) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateSnapshotOptions) SetHeaders(param map[string]string) *UpdateSnapshotOptions { + options.Headers = param + return options +} + +// UpdateSubnetOptions : The UpdateSubnet options. +type UpdateSubnetOptions struct { + // The subnet identifier. + ID *string `json:"id" validate:"required,ne="` + + // The subnet patch. + SubnetPatch map[string]interface{} `json:"Subnet_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateSubnetOptions : Instantiate UpdateSubnetOptions +func (*VpcV1) NewUpdateSubnetOptions(id string, subnetPatch map[string]interface{}) *UpdateSubnetOptions { + return &UpdateSubnetOptions{ + ID: core.StringPtr(id), + SubnetPatch: subnetPatch, + } +} + +// SetID : Allow user to set ID +func (_options *UpdateSubnetOptions) SetID(id string) *UpdateSubnetOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetSubnetPatch : Allow user to set SubnetPatch +func (_options *UpdateSubnetOptions) SetSubnetPatch(subnetPatch map[string]interface{}) *UpdateSubnetOptions { + _options.SubnetPatch = subnetPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateSubnetOptions) SetHeaders(param map[string]string) *UpdateSubnetOptions { + options.Headers = param + return options +} + +// UpdateSubnetReservedIPOptions : The UpdateSubnetReservedIP options. +type UpdateSubnetReservedIPOptions struct { + // The subnet identifier. + SubnetID *string `json:"subnet_id" validate:"required,ne="` + + // The reserved IP identifier. + ID *string `json:"id" validate:"required,ne="` + + // The reserved IP patch. + ReservedIPPatch map[string]interface{} `json:"ReservedIP_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateSubnetReservedIPOptions : Instantiate UpdateSubnetReservedIPOptions +func (*VpcV1) NewUpdateSubnetReservedIPOptions(subnetID string, id string, reservedIPPatch map[string]interface{}) *UpdateSubnetReservedIPOptions { + return &UpdateSubnetReservedIPOptions{ + SubnetID: core.StringPtr(subnetID), + ID: core.StringPtr(id), + ReservedIPPatch: reservedIPPatch, + } +} + +// SetSubnetID : Allow user to set SubnetID +func (_options *UpdateSubnetReservedIPOptions) SetSubnetID(subnetID string) *UpdateSubnetReservedIPOptions { + _options.SubnetID = core.StringPtr(subnetID) + return _options +} + +// SetID : Allow user to set ID +func (_options *UpdateSubnetReservedIPOptions) SetID(id string) *UpdateSubnetReservedIPOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetReservedIPPatch : Allow user to set ReservedIPPatch +func (_options *UpdateSubnetReservedIPOptions) SetReservedIPPatch(reservedIPPatch map[string]interface{}) *UpdateSubnetReservedIPOptions { + _options.ReservedIPPatch = reservedIPPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateSubnetReservedIPOptions) SetHeaders(param map[string]string) *UpdateSubnetReservedIPOptions { + options.Headers = param + return options +} + +// UpdateVirtualNetworkInterfaceOptions : The UpdateVirtualNetworkInterface options. +type UpdateVirtualNetworkInterfaceOptions struct { + // The virtual network interface identifier. + ID *string `json:"id" validate:"required,ne="` + + // The virtual network interface patch. + VirtualNetworkInterfacePatch map[string]interface{} `json:"VirtualNetworkInterface_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateVirtualNetworkInterfaceOptions : Instantiate UpdateVirtualNetworkInterfaceOptions +func (*VpcV1) NewUpdateVirtualNetworkInterfaceOptions(id string, virtualNetworkInterfacePatch map[string]interface{}) *UpdateVirtualNetworkInterfaceOptions { + return &UpdateVirtualNetworkInterfaceOptions{ + ID: core.StringPtr(id), + VirtualNetworkInterfacePatch: virtualNetworkInterfacePatch, + } +} + +// SetID : Allow user to set ID +func (_options *UpdateVirtualNetworkInterfaceOptions) SetID(id string) *UpdateVirtualNetworkInterfaceOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetVirtualNetworkInterfacePatch : Allow user to set VirtualNetworkInterfacePatch +func (_options *UpdateVirtualNetworkInterfaceOptions) SetVirtualNetworkInterfacePatch(virtualNetworkInterfacePatch map[string]interface{}) *UpdateVirtualNetworkInterfaceOptions { + _options.VirtualNetworkInterfacePatch = virtualNetworkInterfacePatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateVirtualNetworkInterfaceOptions) SetHeaders(param map[string]string) *UpdateVirtualNetworkInterfaceOptions { + options.Headers = param + return options +} + +// UpdateVolumeOptions : The UpdateVolume options. +type UpdateVolumeOptions struct { + // The volume identifier. + ID *string `json:"id" validate:"required,ne="` + + // The volume patch. + VolumePatch map[string]interface{} `json:"Volume_patch" validate:"required"` + + // If present, the request will fail if the specified ETag value does not match the resource's current ETag value. + // Required if the request body includes an array. + IfMatch *string `json:"If-Match,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateVolumeOptions : Instantiate UpdateVolumeOptions +func (*VpcV1) NewUpdateVolumeOptions(id string, volumePatch map[string]interface{}) *UpdateVolumeOptions { + return &UpdateVolumeOptions{ + ID: core.StringPtr(id), + VolumePatch: volumePatch, + } +} + +// SetID : Allow user to set ID +func (_options *UpdateVolumeOptions) SetID(id string) *UpdateVolumeOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetVolumePatch : Allow user to set VolumePatch +func (_options *UpdateVolumeOptions) SetVolumePatch(volumePatch map[string]interface{}) *UpdateVolumeOptions { + _options.VolumePatch = volumePatch + return _options +} + +// SetIfMatch : Allow user to set IfMatch +func (_options *UpdateVolumeOptions) SetIfMatch(ifMatch string) *UpdateVolumeOptions { + _options.IfMatch = core.StringPtr(ifMatch) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateVolumeOptions) SetHeaders(param map[string]string) *UpdateVolumeOptions { + options.Headers = param + return options +} + +// UpdateVPCAddressPrefixOptions : The UpdateVPCAddressPrefix options. +type UpdateVPCAddressPrefixOptions struct { + // The VPC identifier. + VPCID *string `json:"vpc_id" validate:"required,ne="` + + // The prefix identifier. + ID *string `json:"id" validate:"required,ne="` + + // The prefix patch. + AddressPrefixPatch map[string]interface{} `json:"AddressPrefix_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateVPCAddressPrefixOptions : Instantiate UpdateVPCAddressPrefixOptions +func (*VpcV1) NewUpdateVPCAddressPrefixOptions(vpcID string, id string, addressPrefixPatch map[string]interface{}) *UpdateVPCAddressPrefixOptions { + return &UpdateVPCAddressPrefixOptions{ + VPCID: core.StringPtr(vpcID), + ID: core.StringPtr(id), + AddressPrefixPatch: addressPrefixPatch, + } +} + +// SetVPCID : Allow user to set VPCID +func (_options *UpdateVPCAddressPrefixOptions) SetVPCID(vpcID string) *UpdateVPCAddressPrefixOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetID : Allow user to set ID +func (_options *UpdateVPCAddressPrefixOptions) SetID(id string) *UpdateVPCAddressPrefixOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetAddressPrefixPatch : Allow user to set AddressPrefixPatch +func (_options *UpdateVPCAddressPrefixOptions) SetAddressPrefixPatch(addressPrefixPatch map[string]interface{}) *UpdateVPCAddressPrefixOptions { + _options.AddressPrefixPatch = addressPrefixPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateVPCAddressPrefixOptions) SetHeaders(param map[string]string) *UpdateVPCAddressPrefixOptions { + options.Headers = param + return options +} + +// UpdateVPCDnsResolutionBindingOptions : The UpdateVPCDnsResolutionBinding options. +type UpdateVPCDnsResolutionBindingOptions struct { + // The VPC identifier. + VPCID *string `json:"vpc_id" validate:"required,ne="` + + // The DNS resolution binding identifier. + ID *string `json:"id" validate:"required,ne="` + + // The DNS resolution binding patch. + VpcdnsResolutionBindingPatch map[string]interface{} `json:"VpcdnsResolutionBinding_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateVPCDnsResolutionBindingOptions : Instantiate UpdateVPCDnsResolutionBindingOptions +func (*VpcV1) NewUpdateVPCDnsResolutionBindingOptions(vpcID string, id string, vpcdnsResolutionBindingPatch map[string]interface{}) *UpdateVPCDnsResolutionBindingOptions { + return &UpdateVPCDnsResolutionBindingOptions{ + VPCID: core.StringPtr(vpcID), + ID: core.StringPtr(id), + VpcdnsResolutionBindingPatch: vpcdnsResolutionBindingPatch, + } +} + +// SetVPCID : Allow user to set VPCID +func (_options *UpdateVPCDnsResolutionBindingOptions) SetVPCID(vpcID string) *UpdateVPCDnsResolutionBindingOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetID : Allow user to set ID +func (_options *UpdateVPCDnsResolutionBindingOptions) SetID(id string) *UpdateVPCDnsResolutionBindingOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetVpcdnsResolutionBindingPatch : Allow user to set VpcdnsResolutionBindingPatch +func (_options *UpdateVPCDnsResolutionBindingOptions) SetVpcdnsResolutionBindingPatch(vpcdnsResolutionBindingPatch map[string]interface{}) *UpdateVPCDnsResolutionBindingOptions { + _options.VpcdnsResolutionBindingPatch = vpcdnsResolutionBindingPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateVPCDnsResolutionBindingOptions) SetHeaders(param map[string]string) *UpdateVPCDnsResolutionBindingOptions { + options.Headers = param + return options +} + +// UpdateVPCOptions : The UpdateVPC options. +type UpdateVPCOptions struct { + // The VPC identifier. + ID *string `json:"id" validate:"required,ne="` + + // The VPC patch. + VPCPatch map[string]interface{} `json:"VPC_patch" validate:"required"` + + // If present, the request will fail if the specified ETag value does not match the resource's current ETag value. + IfMatch *string `json:"If-Match,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateVPCOptions : Instantiate UpdateVPCOptions +func (*VpcV1) NewUpdateVPCOptions(id string, vpcPatch map[string]interface{}) *UpdateVPCOptions { + return &UpdateVPCOptions{ + ID: core.StringPtr(id), + VPCPatch: vpcPatch, + } +} + +// SetID : Allow user to set ID +func (_options *UpdateVPCOptions) SetID(id string) *UpdateVPCOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetVPCPatch : Allow user to set VPCPatch +func (_options *UpdateVPCOptions) SetVPCPatch(vpcPatch map[string]interface{}) *UpdateVPCOptions { + _options.VPCPatch = vpcPatch + return _options +} + +// SetIfMatch : Allow user to set IfMatch +func (_options *UpdateVPCOptions) SetIfMatch(ifMatch string) *UpdateVPCOptions { + _options.IfMatch = core.StringPtr(ifMatch) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateVPCOptions) SetHeaders(param map[string]string) *UpdateVPCOptions { + options.Headers = param + return options +} + +// UpdateVPCRouteOptions : The UpdateVPCRoute options. +type UpdateVPCRouteOptions struct { + // The VPC identifier. + VPCID *string `json:"vpc_id" validate:"required,ne="` + + // The route identifier. + ID *string `json:"id" validate:"required,ne="` + + // The route patch. + RoutePatch map[string]interface{} `json:"Route_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateVPCRouteOptions : Instantiate UpdateVPCRouteOptions +func (*VpcV1) NewUpdateVPCRouteOptions(vpcID string, id string, routePatch map[string]interface{}) *UpdateVPCRouteOptions { + return &UpdateVPCRouteOptions{ + VPCID: core.StringPtr(vpcID), + ID: core.StringPtr(id), + RoutePatch: routePatch, + } +} + +// SetVPCID : Allow user to set VPCID +func (_options *UpdateVPCRouteOptions) SetVPCID(vpcID string) *UpdateVPCRouteOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetID : Allow user to set ID +func (_options *UpdateVPCRouteOptions) SetID(id string) *UpdateVPCRouteOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetRoutePatch : Allow user to set RoutePatch +func (_options *UpdateVPCRouteOptions) SetRoutePatch(routePatch map[string]interface{}) *UpdateVPCRouteOptions { + _options.RoutePatch = routePatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateVPCRouteOptions) SetHeaders(param map[string]string) *UpdateVPCRouteOptions { + options.Headers = param + return options +} + +// UpdateVPCRoutingTableOptions : The UpdateVPCRoutingTable options. +type UpdateVPCRoutingTableOptions struct { + // The VPC identifier. + VPCID *string `json:"vpc_id" validate:"required,ne="` + + // The routing table identifier. + ID *string `json:"id" validate:"required,ne="` + + // The routing table patch. + RoutingTablePatch map[string]interface{} `json:"RoutingTable_patch" validate:"required"` + + // If present, the request will fail if the specified ETag value does not match the resource's current ETag value. + // Required if the request body includes an array. + IfMatch *string `json:"If-Match,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateVPCRoutingTableOptions : Instantiate UpdateVPCRoutingTableOptions +func (*VpcV1) NewUpdateVPCRoutingTableOptions(vpcID string, id string, routingTablePatch map[string]interface{}) *UpdateVPCRoutingTableOptions { + return &UpdateVPCRoutingTableOptions{ + VPCID: core.StringPtr(vpcID), + ID: core.StringPtr(id), + RoutingTablePatch: routingTablePatch, + } +} + +// SetVPCID : Allow user to set VPCID +func (_options *UpdateVPCRoutingTableOptions) SetVPCID(vpcID string) *UpdateVPCRoutingTableOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetID : Allow user to set ID +func (_options *UpdateVPCRoutingTableOptions) SetID(id string) *UpdateVPCRoutingTableOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetRoutingTablePatch : Allow user to set RoutingTablePatch +func (_options *UpdateVPCRoutingTableOptions) SetRoutingTablePatch(routingTablePatch map[string]interface{}) *UpdateVPCRoutingTableOptions { + _options.RoutingTablePatch = routingTablePatch + return _options +} + +// SetIfMatch : Allow user to set IfMatch +func (_options *UpdateVPCRoutingTableOptions) SetIfMatch(ifMatch string) *UpdateVPCRoutingTableOptions { + _options.IfMatch = core.StringPtr(ifMatch) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateVPCRoutingTableOptions) SetHeaders(param map[string]string) *UpdateVPCRoutingTableOptions { + options.Headers = param + return options +} + +// UpdateVPCRoutingTableRouteOptions : The UpdateVPCRoutingTableRoute options. +type UpdateVPCRoutingTableRouteOptions struct { + // The VPC identifier. + VPCID *string `json:"vpc_id" validate:"required,ne="` + + // The routing table identifier. + RoutingTableID *string `json:"routing_table_id" validate:"required,ne="` + + // The VPC routing table route identifier. + ID *string `json:"id" validate:"required,ne="` + + // The VPC route patch. + RoutePatch map[string]interface{} `json:"Route_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateVPCRoutingTableRouteOptions : Instantiate UpdateVPCRoutingTableRouteOptions +func (*VpcV1) NewUpdateVPCRoutingTableRouteOptions(vpcID string, routingTableID string, id string, routePatch map[string]interface{}) *UpdateVPCRoutingTableRouteOptions { + return &UpdateVPCRoutingTableRouteOptions{ + VPCID: core.StringPtr(vpcID), + RoutingTableID: core.StringPtr(routingTableID), + ID: core.StringPtr(id), + RoutePatch: routePatch, + } +} + +// SetVPCID : Allow user to set VPCID +func (_options *UpdateVPCRoutingTableRouteOptions) SetVPCID(vpcID string) *UpdateVPCRoutingTableRouteOptions { + _options.VPCID = core.StringPtr(vpcID) + return _options +} + +// SetRoutingTableID : Allow user to set RoutingTableID +func (_options *UpdateVPCRoutingTableRouteOptions) SetRoutingTableID(routingTableID string) *UpdateVPCRoutingTableRouteOptions { + _options.RoutingTableID = core.StringPtr(routingTableID) + return _options +} + +// SetID : Allow user to set ID +func (_options *UpdateVPCRoutingTableRouteOptions) SetID(id string) *UpdateVPCRoutingTableRouteOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetRoutePatch : Allow user to set RoutePatch +func (_options *UpdateVPCRoutingTableRouteOptions) SetRoutePatch(routePatch map[string]interface{}) *UpdateVPCRoutingTableRouteOptions { + _options.RoutePatch = routePatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateVPCRoutingTableRouteOptions) SetHeaders(param map[string]string) *UpdateVPCRoutingTableRouteOptions { + options.Headers = param + return options +} + +// UpdateVPNGatewayConnectionOptions : The UpdateVPNGatewayConnection options. +type UpdateVPNGatewayConnectionOptions struct { + // The VPN gateway identifier. + VPNGatewayID *string `json:"vpn_gateway_id" validate:"required,ne="` + + // The VPN gateway connection identifier. + ID *string `json:"id" validate:"required,ne="` + + // The VPN gateway connection patch. + VPNGatewayConnectionPatch map[string]interface{} `json:"VPNGatewayConnection_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateVPNGatewayConnectionOptions : Instantiate UpdateVPNGatewayConnectionOptions +func (*VpcV1) NewUpdateVPNGatewayConnectionOptions(vpnGatewayID string, id string, vpnGatewayConnectionPatch map[string]interface{}) *UpdateVPNGatewayConnectionOptions { + return &UpdateVPNGatewayConnectionOptions{ + VPNGatewayID: core.StringPtr(vpnGatewayID), + ID: core.StringPtr(id), + VPNGatewayConnectionPatch: vpnGatewayConnectionPatch, + } +} + +// SetVPNGatewayID : Allow user to set VPNGatewayID +func (_options *UpdateVPNGatewayConnectionOptions) SetVPNGatewayID(vpnGatewayID string) *UpdateVPNGatewayConnectionOptions { + _options.VPNGatewayID = core.StringPtr(vpnGatewayID) + return _options +} + +// SetID : Allow user to set ID +func (_options *UpdateVPNGatewayConnectionOptions) SetID(id string) *UpdateVPNGatewayConnectionOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetVPNGatewayConnectionPatch : Allow user to set VPNGatewayConnectionPatch +func (_options *UpdateVPNGatewayConnectionOptions) SetVPNGatewayConnectionPatch(vpnGatewayConnectionPatch map[string]interface{}) *UpdateVPNGatewayConnectionOptions { + _options.VPNGatewayConnectionPatch = vpnGatewayConnectionPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateVPNGatewayConnectionOptions) SetHeaders(param map[string]string) *UpdateVPNGatewayConnectionOptions { + options.Headers = param + return options +} + +// UpdateVPNGatewayOptions : The UpdateVPNGateway options. +type UpdateVPNGatewayOptions struct { + // The VPN gateway identifier. + ID *string `json:"id" validate:"required,ne="` + + // The VPN gateway patch. + VPNGatewayPatch map[string]interface{} `json:"VPNGateway_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateVPNGatewayOptions : Instantiate UpdateVPNGatewayOptions +func (*VpcV1) NewUpdateVPNGatewayOptions(id string, vpnGatewayPatch map[string]interface{}) *UpdateVPNGatewayOptions { + return &UpdateVPNGatewayOptions{ + ID: core.StringPtr(id), + VPNGatewayPatch: vpnGatewayPatch, + } +} + +// SetID : Allow user to set ID +func (_options *UpdateVPNGatewayOptions) SetID(id string) *UpdateVPNGatewayOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetVPNGatewayPatch : Allow user to set VPNGatewayPatch +func (_options *UpdateVPNGatewayOptions) SetVPNGatewayPatch(vpnGatewayPatch map[string]interface{}) *UpdateVPNGatewayOptions { + _options.VPNGatewayPatch = vpnGatewayPatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateVPNGatewayOptions) SetHeaders(param map[string]string) *UpdateVPNGatewayOptions { + options.Headers = param + return options +} + +// UpdateVPNServerOptions : The UpdateVPNServer options. +type UpdateVPNServerOptions struct { + // The VPN server identifier. + ID *string `json:"id" validate:"required,ne="` + + // The VPN server patch. + VPNServerPatch map[string]interface{} `json:"VPNServer_patch" validate:"required"` + + // If present, the request will fail if the specified ETag value does not match the resource's current ETag value. + // Required if the request body includes an array. + IfMatch *string `json:"If-Match,omitempty"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateVPNServerOptions : Instantiate UpdateVPNServerOptions +func (*VpcV1) NewUpdateVPNServerOptions(id string, vpnServerPatch map[string]interface{}) *UpdateVPNServerOptions { + return &UpdateVPNServerOptions{ + ID: core.StringPtr(id), + VPNServerPatch: vpnServerPatch, + } +} + +// SetID : Allow user to set ID +func (_options *UpdateVPNServerOptions) SetID(id string) *UpdateVPNServerOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetVPNServerPatch : Allow user to set VPNServerPatch +func (_options *UpdateVPNServerOptions) SetVPNServerPatch(vpnServerPatch map[string]interface{}) *UpdateVPNServerOptions { + _options.VPNServerPatch = vpnServerPatch + return _options +} + +// SetIfMatch : Allow user to set IfMatch +func (_options *UpdateVPNServerOptions) SetIfMatch(ifMatch string) *UpdateVPNServerOptions { + _options.IfMatch = core.StringPtr(ifMatch) + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateVPNServerOptions) SetHeaders(param map[string]string) *UpdateVPNServerOptions { + options.Headers = param + return options +} + +// UpdateVPNServerRouteOptions : The UpdateVPNServerRoute options. +type UpdateVPNServerRouteOptions struct { + // The VPN server identifier. + VPNServerID *string `json:"vpn_server_id" validate:"required,ne="` + + // The VPN route identifier. + ID *string `json:"id" validate:"required,ne="` + + // The VPN route patch. + VPNServerRoutePatch map[string]interface{} `json:"VPNServerRoute_patch" validate:"required"` + + // Allows users to set headers on API requests + Headers map[string]string +} + +// NewUpdateVPNServerRouteOptions : Instantiate UpdateVPNServerRouteOptions +func (*VpcV1) NewUpdateVPNServerRouteOptions(vpnServerID string, id string, vpnServerRoutePatch map[string]interface{}) *UpdateVPNServerRouteOptions { + return &UpdateVPNServerRouteOptions{ + VPNServerID: core.StringPtr(vpnServerID), + ID: core.StringPtr(id), + VPNServerRoutePatch: vpnServerRoutePatch, + } +} + +// SetVPNServerID : Allow user to set VPNServerID +func (_options *UpdateVPNServerRouteOptions) SetVPNServerID(vpnServerID string) *UpdateVPNServerRouteOptions { + _options.VPNServerID = core.StringPtr(vpnServerID) + return _options +} + +// SetID : Allow user to set ID +func (_options *UpdateVPNServerRouteOptions) SetID(id string) *UpdateVPNServerRouteOptions { + _options.ID = core.StringPtr(id) + return _options +} + +// SetVPNServerRoutePatch : Allow user to set VPNServerRoutePatch +func (_options *UpdateVPNServerRouteOptions) SetVPNServerRoutePatch(vpnServerRoutePatch map[string]interface{}) *UpdateVPNServerRouteOptions { + _options.VPNServerRoutePatch = vpnServerRoutePatch + return _options +} + +// SetHeaders : Allow user to set Headers +func (options *UpdateVPNServerRouteOptions) SetHeaders(param map[string]string) *UpdateVPNServerRouteOptions { + options.Headers = param + return options +} + +// Vcpu : The VCPU configuration. +type Vcpu struct { + // The VCPU architecture. + Architecture *string `json:"architecture" validate:"required"` + + // The number of VCPUs assigned. + Count *int64 `json:"count" validate:"required"` + + // The VCPU manufacturer. + Manufacturer *string `json:"manufacturer" validate:"required"` +} + +// UnmarshalVcpu unmarshals an instance of Vcpu from the specified map of raw messages. +func UnmarshalVcpu(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(Vcpu) + err = core.UnmarshalPrimitive(m, "architecture", &obj.Architecture) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "count", &obj.Count) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "manufacturer", &obj.Manufacturer) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPC : VPC struct +type VPC struct { + // Indicates whether this VPC is connected to Classic Infrastructure. If true, this VPC's resources have private + // network connectivity to the account's Classic Infrastructure resources. Only one VPC, per region, may be connected + // in this way. This value is set at creation and subsequently immutable. + ClassicAccess *bool `json:"classic_access" validate:"required"` + + // The date and time that the VPC was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The CRN for this VPC. + CRN *string `json:"crn" validate:"required"` + + // The CSE ([Cloud Service Endpoint](https://cloud.ibm.com/docs/resources?topic=resources-service-endpoints)) source IP + // addresses for the VPC. The VPC will have one CSE source IP address per zone. + CseSourceIps []VpccseSourceIP `json:"cse_source_ips,omitempty"` + + // The default network ACL to use for subnets created in this VPC. + DefaultNetworkACL *NetworkACLReference `json:"default_network_acl" validate:"required"` + + // The default routing table to use for subnets created in this VPC. + DefaultRoutingTable *RoutingTableReference `json:"default_routing_table" validate:"required"` + + // The default security group for this VPC. Resources created in this VPC that allow + // a security group to be optionally specified will use this security group by + // default. + DefaultSecurityGroup *SecurityGroupReference `json:"default_security_group" validate:"required"` + + // The DNS configuration for this VPC. + Dns *Vpcdns `json:"dns" validate:"required"` + + // The reasons for the current `health_state` (if any). + // + // The enumerated reason code values for this property will expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the + // unexpected reason code was encountered. + HealthReasons []VPCHealthReason `json:"health_reasons" validate:"required"` + + // The health of this resource. + // - `ok`: No abnormal behavior detected + // - `degraded`: Experiencing compromised performance, capacity, or connectivity + // - `faulted`: Completely unreachable, inoperative, or otherwise entirely incapacitated + // - `inapplicable`: The health state does not apply because of the current lifecycle state. A resource with a + // lifecycle state of `failed` or `deleting` will have a health state of `inapplicable`. A `pending` resource may also + // have this state. + HealthState *string `json:"health_state" validate:"required"` + + // The URL for this VPC. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this VPC. + ID *string `json:"id" validate:"required"` + + // The name for this VPC. The name is unique across all VPCs in the region. + Name *string `json:"name" validate:"required"` + + // The resource group for this VPC. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The status of this VPC. + Status *string `json:"status" validate:"required"` +} + +// Constants associated with the VPC.HealthState property. +// The health of this resource. +// - `ok`: No abnormal behavior detected +// - `degraded`: Experiencing compromised performance, capacity, or connectivity +// - `faulted`: Completely unreachable, inoperative, or otherwise entirely incapacitated +// - `inapplicable`: The health state does not apply because of the current lifecycle state. A resource with a lifecycle +// state of `failed` or `deleting` will have a health state of `inapplicable`. A `pending` resource may also have this +// state. +const ( + VPCHealthStateDegradedConst = "degraded" + VPCHealthStateFaultedConst = "faulted" + VPCHealthStateInapplicableConst = "inapplicable" + VPCHealthStateOkConst = "ok" +) + +// Constants associated with the VPC.ResourceType property. +// The resource type. +const ( + VPCResourceTypeVPCConst = "vpc" +) + +// Constants associated with the VPC.Status property. +// The status of this VPC. +const ( + VPCStatusAvailableConst = "available" + VPCStatusDeletingConst = "deleting" + VPCStatusFailedConst = "failed" + VPCStatusPendingConst = "pending" +) + +// UnmarshalVPC unmarshals an instance of VPC from the specified map of raw messages. +func UnmarshalVPC(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPC) + err = core.UnmarshalPrimitive(m, "classic_access", &obj.ClassicAccess) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "cse_source_ips", &obj.CseSourceIps, UnmarshalVpccseSourceIP) + if err != nil { + return + } + err = core.UnmarshalModel(m, "default_network_acl", &obj.DefaultNetworkACL, UnmarshalNetworkACLReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "default_routing_table", &obj.DefaultRoutingTable, UnmarshalRoutingTableReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "default_security_group", &obj.DefaultSecurityGroup, UnmarshalSecurityGroupReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "dns", &obj.Dns, UnmarshalVpcdns) + if err != nil { + return + } + err = core.UnmarshalModel(m, "health_reasons", &obj.HealthReasons, UnmarshalVPCHealthReason) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "health_state", &obj.HealthState) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VpccseSourceIP : VpccseSourceIP struct +type VpccseSourceIP struct { + // The cloud service endpoint source IP address for this zone. + IP *IP `json:"ip" validate:"required"` + + // The zone this cloud service endpoint source IP resides in. + Zone *ZoneReference `json:"zone" validate:"required"` +} + +// UnmarshalVpccseSourceIP unmarshals an instance of VpccseSourceIP from the specified map of raw messages. +func UnmarshalVpccseSourceIP(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VpccseSourceIP) + err = core.UnmarshalModel(m, "ip", &obj.IP, UnmarshalIP) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPCCollection : VPCCollection struct +type VPCCollection struct { + // A link to the first page of resources. + First *VPCCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *VPCCollectionNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` + + // Collection of VPCs. + Vpcs []VPC `json:"vpcs" validate:"required"` +} + +// UnmarshalVPCCollection unmarshals an instance of VPCCollection from the specified map of raw messages. +func UnmarshalVPCCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPCCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalVPCCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalVPCCollectionNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpcs", &obj.Vpcs, UnmarshalVPC) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *VPCCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// VPCCollectionFirst : A link to the first page of resources. +type VPCCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalVPCCollectionFirst unmarshals an instance of VPCCollectionFirst from the specified map of raw messages. +func UnmarshalVPCCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPCCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPCCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type VPCCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalVPCCollectionNext unmarshals an instance of VPCCollectionNext from the specified map of raw messages. +func UnmarshalVPCCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPCCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Vpcdns : The DNS configuration for this VPC. +type Vpcdns struct { + // Indicates whether this VPC is enabled as a DNS name resolution hub. + EnableHub *bool `json:"enable_hub" validate:"required"` + + // The number of DNS resolution bindings for this VPC. + ResolutionBindingCount *int64 `json:"resolution_binding_count" validate:"required"` + + // The DNS resolver configuration for the VPC. + Resolver VpcdnsResolverIntf `json:"resolver" validate:"required"` +} + +// UnmarshalVpcdns unmarshals an instance of Vpcdns from the specified map of raw messages. +func UnmarshalVpcdns(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(Vpcdns) + err = core.UnmarshalPrimitive(m, "enable_hub", &obj.EnableHub) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resolution_binding_count", &obj.ResolutionBindingCount) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resolver", &obj.Resolver, UnmarshalVpcdnsResolver) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VpcdnsPatch : The DNS configuration for this VPC. +type VpcdnsPatch struct { + // Indicates whether this VPC is enabled as a DNS name resolution hub. + // + // Updating the value to `true` requires `allow_dns_resolution_binding` to be `true` for all endpoint gateways residing + // in this VPC. + // + // Changing the value requires `dns.resolution_binding_count` to be zero. + EnableHub *bool `json:"enable_hub,omitempty"` + + Resolver *VpcdnsResolverPatch `json:"resolver,omitempty"` +} + +// UnmarshalVpcdnsPatch unmarshals an instance of VpcdnsPatch from the specified map of raw messages. +func UnmarshalVpcdnsPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VpcdnsPatch) + err = core.UnmarshalPrimitive(m, "enable_hub", &obj.EnableHub) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resolver", &obj.Resolver, UnmarshalVpcdnsResolverPatch) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VpcdnsPrototype : The DNS configuration for this VPC. +// +// If unspecified, the system will assign DNS servers capable of resolving hosts and endpoint gateways within this VPC, +// and hosts on the internet. +type VpcdnsPrototype struct { + // Indicates whether this VPC is enabled as a DNS name resolution hub. + EnableHub *bool `json:"enable_hub,omitempty"` + + Resolver VpcdnsResolverPrototypeIntf `json:"resolver,omitempty"` +} + +// UnmarshalVpcdnsPrototype unmarshals an instance of VpcdnsPrototype from the specified map of raw messages. +func UnmarshalVpcdnsPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VpcdnsPrototype) + err = core.UnmarshalPrimitive(m, "enable_hub", &obj.EnableHub) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resolver", &obj.Resolver, UnmarshalVpcdnsResolverPrototype) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VpcdnsResolutionBinding : VpcdnsResolutionBinding struct +type VpcdnsResolutionBinding struct { + // The date and time that the DNS resolution binding was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The endpoint gateways that have `allow_dns_resolution_binding` set to `true` and reside in the VPC that has + // `dns.enable_hub` set to `false`. + // + // The endpoint gateways may be remote and therefore may not be directly retrievable. + EndpointGateways []EndpointGatewayReferenceRemote `json:"endpoint_gateways" validate:"required"` + + // The URL for this DNS resolution binding. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this DNS resolution binding. + ID *string `json:"id" validate:"required"` + + // The lifecycle state of the DNS resolution binding. + LifecycleState *string `json:"lifecycle_state" validate:"required"` + + // The name for this DNS resolution binding. The name is unique across all DNS resolution bindings for the VPC. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The VPC bound to for DNS resolution. + // + // The VPC may be remote and therefore may not be directly retrievable. + VPC *VPCReferenceRemote `json:"vpc" validate:"required"` +} + +// Constants associated with the VpcdnsResolutionBinding.LifecycleState property. +// The lifecycle state of the DNS resolution binding. +const ( + VpcdnsResolutionBindingLifecycleStateDeletingConst = "deleting" + VpcdnsResolutionBindingLifecycleStateFailedConst = "failed" + VpcdnsResolutionBindingLifecycleStatePendingConst = "pending" + VpcdnsResolutionBindingLifecycleStateStableConst = "stable" + VpcdnsResolutionBindingLifecycleStateSuspendedConst = "suspended" + VpcdnsResolutionBindingLifecycleStateUpdatingConst = "updating" + VpcdnsResolutionBindingLifecycleStateWaitingConst = "waiting" +) + +// Constants associated with the VpcdnsResolutionBinding.ResourceType property. +// The resource type. +const ( + VpcdnsResolutionBindingResourceTypeVPCDnsResolutionBindingConst = "vpc_dns_resolution_binding" +) + +// UnmarshalVpcdnsResolutionBinding unmarshals an instance of VpcdnsResolutionBinding from the specified map of raw messages. +func UnmarshalVpcdnsResolutionBinding(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VpcdnsResolutionBinding) + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalModel(m, "endpoint_gateways", &obj.EndpointGateways, UnmarshalEndpointGatewayReferenceRemote) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "lifecycle_state", &obj.LifecycleState) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCReferenceRemote) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VpcdnsResolutionBindingCollection : VpcdnsResolutionBindingCollection struct +type VpcdnsResolutionBindingCollection struct { + // Collection of DNS resolution bindings for this VPC. + DnsResolutionBindings []VpcdnsResolutionBinding `json:"dns_resolution_bindings" validate:"required"` + + // A link to the first page of resources. + First *VpcdnsResolutionBindingCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *VpcdnsResolutionBindingCollectionNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalVpcdnsResolutionBindingCollection unmarshals an instance of VpcdnsResolutionBindingCollection from the specified map of raw messages. +func UnmarshalVpcdnsResolutionBindingCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VpcdnsResolutionBindingCollection) + err = core.UnmarshalModel(m, "dns_resolution_bindings", &obj.DnsResolutionBindings, UnmarshalVpcdnsResolutionBinding) + if err != nil { + return + } + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalVpcdnsResolutionBindingCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalVpcdnsResolutionBindingCollectionNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *VpcdnsResolutionBindingCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// VpcdnsResolutionBindingPatch : VpcdnsResolutionBindingPatch struct +type VpcdnsResolutionBindingPatch struct { + // The name for this DNS resolution binding. The name must not be used by another DNS resolution binding for the VPC. + Name *string `json:"name,omitempty"` +} + +// UnmarshalVpcdnsResolutionBindingPatch unmarshals an instance of VpcdnsResolutionBindingPatch from the specified map of raw messages. +func UnmarshalVpcdnsResolutionBindingPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VpcdnsResolutionBindingPatch) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the VpcdnsResolutionBindingPatch +func (vpcdnsResolutionBindingPatch *VpcdnsResolutionBindingPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(vpcdnsResolutionBindingPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// VpcdnsResolver : VpcdnsResolver struct +// Models which "extend" this model: +// - VpcdnsResolverTypeDelegated +// - VpcdnsResolverTypeManual +// - VpcdnsResolverTypeSystem +type VpcdnsResolver struct { + // The DNS servers for this VPC. The servers are populated: + // + // - by the system when `dns.resolver.type` is `system` + // - using the DNS servers in `dns.resolver.vpc` when `dns.resolver.type` is `delegated` + // - using `dns.resolver.manual_servers` when the `dns.resolver.type` is `manual`. + Servers []DnsServer `json:"servers" validate:"required"` + + // The type of the DNS resolver used for the VPC. + // + // - `delegated`: DNS server addresses are provided by the DNS resolver of the VPC + // specified in `dns.resolver.vpc`. + // - `manual`: DNS server addresses are specified in `dns.resolver.manual_servers`. + // - `system`: DNS server addresses are provided by the system. + Type *string `json:"type" validate:"required"` + + // The VPC whose DNS resolver provides the DNS server addresses for this VPC. + // + // The VPC may be remote and therefore may not be directly retrievable. + VPC *VPCReferenceDnsResolverContext `json:"vpc,omitempty"` + + // The manually specified DNS servers for this VPC. + ManualServers []DnsServer `json:"manual_servers,omitempty"` + + // The configuration of the system DNS resolver for this VPC. + // + // - `custom_resolver`: A custom DNS resolver is configured for this VPC. + // + // - `private_resolver`: A private DNS resolver is configured for this VPC. Applicable when + // the VPC has either or both of the following: + // + // - at least one endpoint gateway residing in it + // - a [DNS Services](https://cloud.ibm.com/docs/dns-svcs) private zone configured for it + // + // - `default`: The provider default DNS resolvers are configured for this VPC. + // + // This system DNS resolver configuration is used when the VPC has: + // + // - no custom DNS resolver configured for it, and + // - no endpoint gateways residing in it, and + // - no [DNS Services](https://cloud.ibm.com/docs/dns-svcs) private zone configured for it. + Configuration *string `json:"configuration,omitempty"` +} + +// Constants associated with the VpcdnsResolver.Type property. +// The type of the DNS resolver used for the VPC. +// +// - `delegated`: DNS server addresses are provided by the DNS resolver of the VPC +// specified in `dns.resolver.vpc`. +// - `manual`: DNS server addresses are specified in `dns.resolver.manual_servers`. +// - `system`: DNS server addresses are provided by the system. +const ( + VpcdnsResolverTypeDelegatedConst = "delegated" + VpcdnsResolverTypeManualConst = "manual" + VpcdnsResolverTypeSystemConst = "system" +) + +// Constants associated with the VpcdnsResolver.Configuration property. +// The configuration of the system DNS resolver for this VPC. +// +// - `custom_resolver`: A custom DNS resolver is configured for this VPC. +// +// - `private_resolver`: A private DNS resolver is configured for this VPC. Applicable when +// the VPC has either or both of the following: +// +// - at least one endpoint gateway residing in it +// +// - a [DNS Services](https://cloud.ibm.com/docs/dns-svcs) private zone configured for it +// +// - `default`: The provider default DNS resolvers are configured for this VPC. +// +// This system DNS resolver configuration is used when the VPC has: +// +// - no custom DNS resolver configured for it, and +// - no endpoint gateways residing in it, and +// - no [DNS Services](https://cloud.ibm.com/docs/dns-svcs) private zone configured for it. +const ( + VpcdnsResolverConfigurationCustomResolverConst = "custom_resolver" + VpcdnsResolverConfigurationDefaultConst = "default" + VpcdnsResolverConfigurationPrivateResolverConst = "private_resolver" +) + +func (*VpcdnsResolver) isaVpcdnsResolver() bool { + return true +} + +type VpcdnsResolverIntf interface { + isaVpcdnsResolver() bool +} + +// UnmarshalVpcdnsResolver unmarshals an instance of VpcdnsResolver from the specified map of raw messages. +func UnmarshalVpcdnsResolver(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VpcdnsResolver) + err = core.UnmarshalModel(m, "servers", &obj.Servers, UnmarshalDnsServer) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCReferenceDnsResolverContext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "manual_servers", &obj.ManualServers, UnmarshalDnsServer) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "configuration", &obj.Configuration) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VpcdnsResolverPatch : VpcdnsResolverPatch struct +type VpcdnsResolverPatch struct { + // The DNS servers to use for this VPC, replacing any existing servers. All the DNS servers must either: + // + // - have a unique `zone_affinity`, or + // - not have a `zone_affinity`. + // + // `dns.resolver.manual_servers` must be set if and only if `dns.resolver.type` is `manual`. + ManualServers []DnsServerPrototype `json:"manual_servers,omitempty"` + + // The type of the DNS resolver to use. + // + // - `delegated`: DNS server addresses will be provided by the resolver for the VPC + // specified in `dns.resolver.vpc`. Requires `dns.enable_hub` to be + // `false`. + // - `manual`: DNS server addresses are specified in `dns.resolver.manual_servers`. + // - `system`: DNS server addresses will be provided by the system and depend on the + // configuration. + // + // Updating from `manual` requires `dns.resolver.manual_servers` to be specified as + // `null`. + // + // Updating to `manual` requires `dns.resolver.manual_servers` to be specified and not empty. + // + // Updating from `delegated` requires `dns.resolver.vpc` to be specified as `null`. + Type *string `json:"type,omitempty"` + + // The VPC to provide DNS server addresses for this VPC. The specified VPC must be configured + // with a [DNS Services](https://cloud.ibm.com/docs/dns-svcs) custom resolver and must be in + // one of this VPC's DNS resolution bindings. + // + // Specify `null` to remove an existing VPC. + // + // This property must be set if and only if `dns.resolver.type` is `delegated`. + VPC VpcdnsResolverVPCPatchIntf `json:"vpc,omitempty"` +} + +// Constants associated with the VpcdnsResolverPatch.Type property. +// The type of the DNS resolver to use. +// +// - `delegated`: DNS server addresses will be provided by the resolver for the VPC +// specified in `dns.resolver.vpc`. Requires `dns.enable_hub` to be +// `false`. +// - `manual`: DNS server addresses are specified in `dns.resolver.manual_servers`. +// - `system`: DNS server addresses will be provided by the system and depend on the +// configuration. +// +// Updating from `manual` requires `dns.resolver.manual_servers` to be specified as +// `null`. +// +// Updating to `manual` requires `dns.resolver.manual_servers` to be specified and not empty. +// +// Updating from `delegated` requires `dns.resolver.vpc` to be specified as `null`. +const ( + VpcdnsResolverPatchTypeDelegatedConst = "delegated" + VpcdnsResolverPatchTypeManualConst = "manual" + VpcdnsResolverPatchTypeSystemConst = "system" +) + +// UnmarshalVpcdnsResolverPatch unmarshals an instance of VpcdnsResolverPatch from the specified map of raw messages. +func UnmarshalVpcdnsResolverPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VpcdnsResolverPatch) + err = core.UnmarshalModel(m, "manual_servers", &obj.ManualServers, UnmarshalDnsServerPrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVpcdnsResolverVPCPatch) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VpcdnsResolverPrototype : VpcdnsResolverPrototype struct +// Models which "extend" this model: +// - VpcdnsResolverPrototypeVpcdnsResolverTypeManualPrototype +// - VpcdnsResolverPrototypeVpcdnsResolverTypeSystemPrototype +type VpcdnsResolverPrototype struct { + // The type of the DNS resolver to use. + // + // - `manual`: DNS server addresses are specified in `dns.resolver.manual_servers`. + // - `system`: DNS server addresses will be provided by the system and depend on the + // configuration. + Type *string `json:"type,omitempty"` + + // The DNS servers to use for this VPC. All the DNS servers must either: + // + // - have a unique `zone_affinity`, or + // - not have a `zone_affinity`. + ManualServers []DnsServerPrototype `json:"manual_servers,omitempty"` +} + +// Constants associated with the VpcdnsResolverPrototype.Type property. +// The type of the DNS resolver to use. +// +// - `manual`: DNS server addresses are specified in `dns.resolver.manual_servers`. +// - `system`: DNS server addresses will be provided by the system and depend on the +// configuration. +const ( + VpcdnsResolverPrototypeTypeManualConst = "manual" + VpcdnsResolverPrototypeTypeSystemConst = "system" +) + +func (*VpcdnsResolverPrototype) isaVpcdnsResolverPrototype() bool { + return true +} + +type VpcdnsResolverPrototypeIntf interface { + isaVpcdnsResolverPrototype() bool +} + +// UnmarshalVpcdnsResolverPrototype unmarshals an instance of VpcdnsResolverPrototype from the specified map of raw messages. +func UnmarshalVpcdnsResolverPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VpcdnsResolverPrototype) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalModel(m, "manual_servers", &obj.ManualServers, UnmarshalDnsServerPrototype) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VpcdnsResolverVPCPatch : The VPC to provide DNS server addresses for this VPC. The specified VPC must be configured with a [DNS +// Services](https://cloud.ibm.com/docs/dns-svcs) custom resolver and must be in one of this VPC's DNS resolution +// bindings. +// +// Specify `null` to remove an existing VPC. +// +// This property must be set if and only if `dns.resolver.type` is `delegated`. +// Models which "extend" this model: +// - VpcdnsResolverVPCPatchVPCIdentityByID +// - VpcdnsResolverVPCPatchVPCIdentityByCRN +// - VpcdnsResolverVPCPatchVPCIdentityByHref +type VpcdnsResolverVPCPatch struct { + // The unique identifier for this VPC. + ID *string `json:"id,omitempty"` + + // The CRN for this VPC. + CRN *string `json:"crn,omitempty"` + + // The URL for this VPC. + Href *string `json:"href,omitempty"` +} + +func (*VpcdnsResolverVPCPatch) isaVpcdnsResolverVPCPatch() bool { + return true +} + +type VpcdnsResolverVPCPatchIntf interface { + isaVpcdnsResolverVPCPatch() bool +} + +// UnmarshalVpcdnsResolverVPCPatch unmarshals an instance of VpcdnsResolverVPCPatch from the specified map of raw messages. +func UnmarshalVpcdnsResolverVPCPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VpcdnsResolverVPCPatch) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPCHealthReason : VPCHealthReason struct +type VPCHealthReason struct { + // A snake case string succinctly identifying the reason for this health state. + Code *string `json:"code" validate:"required"` + + // An explanation of the reason for this health state. + Message *string `json:"message" validate:"required"` + + // Link to documentation about the reason for this health state. + MoreInfo *string `json:"more_info,omitempty"` +} + +// Constants associated with the VPCHealthReason.Code property. +// A snake case string succinctly identifying the reason for this health state. +const ( + VPCHealthReasonCodeDnsResolutionBindingFailedConst = "dns_resolution_binding_failed" +) + +// UnmarshalVPCHealthReason unmarshals an instance of VPCHealthReason from the specified map of raw messages. +func UnmarshalVPCHealthReason(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPCHealthReason) + err = core.UnmarshalPrimitive(m, "code", &obj.Code) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "message", &obj.Message) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPCIdentity : Identifies a VPC by a unique property. +// Models which "extend" this model: +// - VPCIdentityByID +// - VPCIdentityByCRN +// - VPCIdentityByHref +type VPCIdentity struct { + // The unique identifier for this VPC. + ID *string `json:"id,omitempty"` + + // The CRN for this VPC. + CRN *string `json:"crn,omitempty"` + + // The URL for this VPC. + Href *string `json:"href,omitempty"` +} + +func (*VPCIdentity) isaVPCIdentity() bool { + return true +} + +type VPCIdentityIntf interface { + isaVPCIdentity() bool +} + +// UnmarshalVPCIdentity unmarshals an instance of VPCIdentity from the specified map of raw messages. +func UnmarshalVPCIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPCIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPCPatch : VPCPatch struct +type VPCPatch struct { + // The DNS configuration for this VPC. + Dns *VpcdnsPatch `json:"dns,omitempty"` + + // The name for this VPC. The name must not be used by another VPC in the region. + Name *string `json:"name,omitempty"` +} + +// UnmarshalVPCPatch unmarshals an instance of VPCPatch from the specified map of raw messages. +func UnmarshalVPCPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPCPatch) + err = core.UnmarshalModel(m, "dns", &obj.Dns, UnmarshalVpcdnsPatch) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the VPCPatch +func (vpcPatch *VPCPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(vpcPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// VPCReference : VPCReference struct +type VPCReference struct { + // The CRN for this VPC. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *VPCReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this VPC. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this VPC. + ID *string `json:"id" validate:"required"` + + // The name for this VPC. The name is unique across all VPCs in the region. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the VPCReference.ResourceType property. +// The resource type. +const ( + VPCReferenceResourceTypeVPCConst = "vpc" +) + +// UnmarshalVPCReference unmarshals an instance of VPCReference from the specified map of raw messages. +func UnmarshalVPCReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPCReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalVPCReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPCReferenceDnsResolverContext : A VPC whose DNS resolver is delegated to provide DNS servers for this VPC. +// +// The VPC may be remote and therefore may not be directly retrievable. +type VPCReferenceDnsResolverContext struct { + // The CRN for this VPC. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *VPCReferenceDnsResolverContextDeleted `json:"deleted,omitempty"` + + // The URL for this VPC. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this VPC. + ID *string `json:"id" validate:"required"` + + // The name for this VPC. The name is unique across all VPCs in the region. + Name *string `json:"name" validate:"required"` + + // If present, this property indicates that the resource associated with this reference + // is remote and therefore may not be directly retrievable. + Remote *VPCRemote `json:"remote,omitempty"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the VPCReferenceDnsResolverContext.ResourceType property. +// The resource type. +const ( + VPCReferenceDnsResolverContextResourceTypeVPCConst = "vpc" +) + +// UnmarshalVPCReferenceDnsResolverContext unmarshals an instance of VPCReferenceDnsResolverContext from the specified map of raw messages. +func UnmarshalVPCReferenceDnsResolverContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPCReferenceDnsResolverContext) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalVPCReferenceDnsResolverContextDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "remote", &obj.Remote, UnmarshalVPCRemote) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPCReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type VPCReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalVPCReferenceDeleted unmarshals an instance of VPCReferenceDeleted from the specified map of raw messages. +func UnmarshalVPCReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPCReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPCReferenceDnsResolverContextDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type VPCReferenceDnsResolverContextDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalVPCReferenceDnsResolverContextDeleted unmarshals an instance of VPCReferenceDnsResolverContextDeleted from the specified map of raw messages. +func UnmarshalVPCReferenceDnsResolverContextDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPCReferenceDnsResolverContextDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPCReferenceRemote : VPCReferenceRemote struct +type VPCReferenceRemote struct { + // The CRN for this VPC. + CRN *string `json:"crn" validate:"required"` + + // The URL for this VPC. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this VPC. + ID *string `json:"id" validate:"required"` + + // The name for this VPC. The name is unique across all VPCs in the region. + Name *string `json:"name" validate:"required"` + + // If present, this property indicates that the resource associated with this reference + // is remote and therefore may not be directly retrievable. + Remote *VPCRemote `json:"remote,omitempty"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the VPCReferenceRemote.ResourceType property. +// The resource type. +const ( + VPCReferenceRemoteResourceTypeVPCConst = "vpc" +) + +// UnmarshalVPCReferenceRemote unmarshals an instance of VPCReferenceRemote from the specified map of raw messages. +func UnmarshalVPCReferenceRemote(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPCReferenceRemote) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "remote", &obj.Remote, UnmarshalVPCRemote) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPCRemote : If present, this property indicates that the resource associated with this reference is remote and therefore may not +// be directly retrievable. +type VPCRemote struct { + // If present, this property indicates that the referenced resource is remote to this + // account, and identifies the owning account. + Account *AccountReference `json:"account,omitempty"` + + // If present, this property indicates that the referenced resource is remote to this + // region, and identifies the native region. + Region *RegionReference `json:"region,omitempty"` +} + +// UnmarshalVPCRemote unmarshals an instance of VPCRemote from the specified map of raw messages. +func UnmarshalVPCRemote(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPCRemote) + err = core.UnmarshalModel(m, "account", &obj.Account, UnmarshalAccountReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "region", &obj.Region, UnmarshalRegionReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGateway : VPNGateway struct +// Models which "extend" this model: +// - VPNGatewayRouteMode +// - VPNGatewayPolicyMode +type VPNGateway struct { + // Connections for this VPN gateway. + Connections []VPNGatewayConnectionReference `json:"connections" validate:"required"` + + // The date and time that this VPN gateway was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The VPN gateway's CRN. + CRN *string `json:"crn" validate:"required"` + + // The VPN gateway's canonical URL. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this VPN gateway. + ID *string `json:"id" validate:"required"` + + // Collection of VPN gateway members. + Members []VPNGatewayMember `json:"members" validate:"required"` + + // The name for this VPN gateway. The name is unique across all VPN gateways in the VPC. + Name *string `json:"name" validate:"required"` + + // The resource group for this VPN gateway. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The status of the VPN gateway. + Status *string `json:"status" validate:"required"` + + Subnet *SubnetReference `json:"subnet" validate:"required"` + + // The VPC this VPN gateway resides in. + VPC *VPCReference `json:"vpc" validate:"required"` + + // Route mode VPN gateway. + Mode *string `json:"mode,omitempty"` +} + +// Constants associated with the VPNGateway.ResourceType property. +// The resource type. +const ( + VPNGatewayResourceTypeVPNGatewayConst = "vpn_gateway" +) + +// Constants associated with the VPNGateway.Status property. +// The status of the VPN gateway. +const ( + VPNGatewayStatusAvailableConst = "available" + VPNGatewayStatusDeletingConst = "deleting" + VPNGatewayStatusFailedConst = "failed" + VPNGatewayStatusPendingConst = "pending" +) + +// Constants associated with the VPNGateway.Mode property. +// Route mode VPN gateway. +const ( + VPNGatewayModeRouteConst = "route" +) + +func (*VPNGateway) isaVPNGateway() bool { + return true +} + +type VPNGatewayIntf interface { + isaVPNGateway() bool +} + +// UnmarshalVPNGateway unmarshals an instance of VPNGateway from the specified map of raw messages. +func UnmarshalVPNGateway(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGateway) + err = core.UnmarshalModel(m, "connections", &obj.Connections, UnmarshalVPNGatewayConnectionReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalModel(m, "members", &obj.Members, UnmarshalVPNGatewayMember) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnet", &obj.Subnet, UnmarshalSubnetReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "mode", &obj.Mode) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayCollection : VPNGatewayCollection struct +type VPNGatewayCollection struct { + // A link to the first page of resources. + First *VPNGatewayCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *VPNGatewayCollectionNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` + + // Collection of VPN gateways. + VPNGateways []VPNGatewayIntf `json:"vpn_gateways" validate:"required"` +} + +// UnmarshalVPNGatewayCollection unmarshals an instance of VPNGatewayCollection from the specified map of raw messages. +func UnmarshalVPNGatewayCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalVPNGatewayCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalVPNGatewayCollectionNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpn_gateways", &obj.VPNGateways, UnmarshalVPNGateway) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *VPNGatewayCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// VPNGatewayCollectionFirst : A link to the first page of resources. +type VPNGatewayCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalVPNGatewayCollectionFirst unmarshals an instance of VPNGatewayCollectionFirst from the specified map of raw messages. +func UnmarshalVPNGatewayCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type VPNGatewayCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalVPNGatewayCollectionNext unmarshals an instance of VPNGatewayCollectionNext from the specified map of raw messages. +func UnmarshalVPNGatewayCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayConnection : VPNGatewayConnection struct +// Models which "extend" this model: +// - VPNGatewayConnectionStaticRouteMode +// - VPNGatewayConnectionPolicyMode +type VPNGatewayConnection struct { + // If set to false, the VPN gateway connection is shut down. + AdminStateUp *bool `json:"admin_state_up" validate:"required"` + + // The authentication mode. Only `psk` is currently supported. + AuthenticationMode *string `json:"authentication_mode" validate:"required"` + + // The date and time that this VPN gateway connection was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The Dead Peer Detection settings. + DeadPeerDetection *VPNGatewayConnectionDpd `json:"dead_peer_detection" validate:"required"` + + // The VPN connection's canonical URL. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this VPN gateway connection. + ID *string `json:"id" validate:"required"` + + // The IKE policy. If absent, [auto-negotiation is + // used](https://cloud.ibm.com/docs/vpc?topic=vpc-using-vpn&interface=ui#ike-auto-negotiation-phase-1). + IkePolicy *IkePolicyReference `json:"ike_policy,omitempty"` + + // The IPsec policy. If absent, [auto-negotiation is + // used](https://cloud.ibm.com/docs/vpc?topic=vpc-using-vpn&interface=ui#ipsec-auto-negotiation-phase-2). + IpsecPolicy *IPsecPolicyReference `json:"ipsec_policy,omitempty"` + + // The mode of the VPN gateway. + Mode *string `json:"mode" validate:"required"` + + // The name for this VPN gateway connection. The name is unique across all connections for the VPN gateway. + Name *string `json:"name" validate:"required"` + + // The IP address of the peer VPN gateway. + PeerAddress *string `json:"peer_address" validate:"required"` + + // The pre-shared key. + Psk *string `json:"psk" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The status of a VPN gateway connection. + Status *string `json:"status" validate:"required"` + + // Routing protocols are disabled for this VPN gateway connection. + RoutingProtocol *string `json:"routing_protocol,omitempty"` + + // The VPN tunnel configuration for this VPN gateway connection (in static route mode). + Tunnels []VPNGatewayConnectionStaticRouteModeTunnel `json:"tunnels,omitempty"` + + // The local CIDRs for this resource. + LocalCIDRs []string `json:"local_cidrs,omitempty"` + + // The peer CIDRs for this resource. + PeerCIDRs []string `json:"peer_cidrs,omitempty"` +} + +// Constants associated with the VPNGatewayConnection.AuthenticationMode property. +// The authentication mode. Only `psk` is currently supported. +const ( + VPNGatewayConnectionAuthenticationModePskConst = "psk" +) + +// Constants associated with the VPNGatewayConnection.Mode property. +// The mode of the VPN gateway. +const ( + VPNGatewayConnectionModePolicyConst = "policy" + VPNGatewayConnectionModeRouteConst = "route" +) + +// Constants associated with the VPNGatewayConnection.ResourceType property. +// The resource type. +const ( + VPNGatewayConnectionResourceTypeVPNGatewayConnectionConst = "vpn_gateway_connection" +) + +// Constants associated with the VPNGatewayConnection.Status property. +// The status of a VPN gateway connection. +const ( + VPNGatewayConnectionStatusDownConst = "down" + VPNGatewayConnectionStatusUpConst = "up" +) + +// Constants associated with the VPNGatewayConnection.RoutingProtocol property. +// Routing protocols are disabled for this VPN gateway connection. +const ( + VPNGatewayConnectionRoutingProtocolNoneConst = "none" +) + +func (*VPNGatewayConnection) isaVPNGatewayConnection() bool { + return true +} + +type VPNGatewayConnectionIntf interface { + isaVPNGatewayConnection() bool +} + +// UnmarshalVPNGatewayConnection unmarshals an instance of VPNGatewayConnection from the specified map of raw messages. +func UnmarshalVPNGatewayConnection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayConnection) + err = core.UnmarshalPrimitive(m, "admin_state_up", &obj.AdminStateUp) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "authentication_mode", &obj.AuthenticationMode) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalModel(m, "dead_peer_detection", &obj.DeadPeerDetection, UnmarshalVPNGatewayConnectionDpd) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalModel(m, "ike_policy", &obj.IkePolicy, UnmarshalIkePolicyReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "ipsec_policy", &obj.IpsecPolicy, UnmarshalIPsecPolicyReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "mode", &obj.Mode) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "peer_address", &obj.PeerAddress) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "psk", &obj.Psk) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "routing_protocol", &obj.RoutingProtocol) + if err != nil { + return + } + err = core.UnmarshalModel(m, "tunnels", &obj.Tunnels, UnmarshalVPNGatewayConnectionStaticRouteModeTunnel) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "local_cidrs", &obj.LocalCIDRs) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "peer_cidrs", &obj.PeerCIDRs) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayConnectionCollection : Collection of VPN gateway connections in a VPN gateway. +type VPNGatewayConnectionCollection struct { + // Array of VPN gateway connections. + Connections []VPNGatewayConnectionIntf `json:"connections" validate:"required"` +} + +// UnmarshalVPNGatewayConnectionCollection unmarshals an instance of VPNGatewayConnectionCollection from the specified map of raw messages. +func UnmarshalVPNGatewayConnectionCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayConnectionCollection) + err = core.UnmarshalModel(m, "connections", &obj.Connections, UnmarshalVPNGatewayConnection) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayConnectionDpd : The Dead Peer Detection settings. +type VPNGatewayConnectionDpd struct { + // Dead Peer Detection actions. + Action *string `json:"action" validate:"required"` + + // Dead Peer Detection interval in seconds. + Interval *int64 `json:"interval" validate:"required"` + + // Dead Peer Detection timeout in seconds. Must be at least the interval. + Timeout *int64 `json:"timeout" validate:"required"` +} + +// Constants associated with the VPNGatewayConnectionDpd.Action property. +// Dead Peer Detection actions. +const ( + VPNGatewayConnectionDpdActionClearConst = "clear" + VPNGatewayConnectionDpdActionHoldConst = "hold" + VPNGatewayConnectionDpdActionNoneConst = "none" + VPNGatewayConnectionDpdActionRestartConst = "restart" +) + +// UnmarshalVPNGatewayConnectionDpd unmarshals an instance of VPNGatewayConnectionDpd from the specified map of raw messages. +func UnmarshalVPNGatewayConnectionDpd(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayConnectionDpd) + err = core.UnmarshalPrimitive(m, "action", &obj.Action) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "interval", &obj.Interval) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "timeout", &obj.Timeout) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayConnectionDpdPatch : The Dead Peer Detection settings. +type VPNGatewayConnectionDpdPatch struct { + // Dead Peer Detection actions. + Action *string `json:"action,omitempty"` + + // Dead Peer Detection interval in seconds. + Interval *int64 `json:"interval,omitempty"` + + // Dead Peer Detection timeout in seconds. Must be at least the interval. + Timeout *int64 `json:"timeout,omitempty"` +} + +// Constants associated with the VPNGatewayConnectionDpdPatch.Action property. +// Dead Peer Detection actions. +const ( + VPNGatewayConnectionDpdPatchActionClearConst = "clear" + VPNGatewayConnectionDpdPatchActionHoldConst = "hold" + VPNGatewayConnectionDpdPatchActionNoneConst = "none" + VPNGatewayConnectionDpdPatchActionRestartConst = "restart" +) + +// UnmarshalVPNGatewayConnectionDpdPatch unmarshals an instance of VPNGatewayConnectionDpdPatch from the specified map of raw messages. +func UnmarshalVPNGatewayConnectionDpdPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayConnectionDpdPatch) + err = core.UnmarshalPrimitive(m, "action", &obj.Action) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "interval", &obj.Interval) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "timeout", &obj.Timeout) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayConnectionDpdPrototype : The Dead Peer Detection settings. +type VPNGatewayConnectionDpdPrototype struct { + // Dead Peer Detection actions. + Action *string `json:"action,omitempty"` + + // Dead Peer Detection interval in seconds. + Interval *int64 `json:"interval,omitempty"` + + // Dead Peer Detection timeout in seconds. Must be at least the interval. + Timeout *int64 `json:"timeout,omitempty"` +} + +// Constants associated with the VPNGatewayConnectionDpdPrototype.Action property. +// Dead Peer Detection actions. +const ( + VPNGatewayConnectionDpdPrototypeActionClearConst = "clear" + VPNGatewayConnectionDpdPrototypeActionHoldConst = "hold" + VPNGatewayConnectionDpdPrototypeActionNoneConst = "none" + VPNGatewayConnectionDpdPrototypeActionRestartConst = "restart" +) + +// UnmarshalVPNGatewayConnectionDpdPrototype unmarshals an instance of VPNGatewayConnectionDpdPrototype from the specified map of raw messages. +func UnmarshalVPNGatewayConnectionDpdPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayConnectionDpdPrototype) + err = core.UnmarshalPrimitive(m, "action", &obj.Action) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "interval", &obj.Interval) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "timeout", &obj.Timeout) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayConnectionIkePolicyPatch : The IKE policy to use. Specify `null` to remove any existing policy, [resulting in +// auto-negotiation](https://cloud.ibm.com/docs/vpc?topic=vpc-using-vpn&interface=ui#ike-auto-negotiation-phase-1). +// Models which "extend" this model: +// - VPNGatewayConnectionIkePolicyPatchIkePolicyIdentityByID +// - VPNGatewayConnectionIkePolicyPatchIkePolicyIdentityByHref +type VPNGatewayConnectionIkePolicyPatch struct { + // The unique identifier for this IKE policy. + ID *string `json:"id,omitempty"` + + // The IKE policy's canonical URL. + Href *string `json:"href,omitempty"` +} + +func (*VPNGatewayConnectionIkePolicyPatch) isaVPNGatewayConnectionIkePolicyPatch() bool { + return true +} + +type VPNGatewayConnectionIkePolicyPatchIntf interface { + isaVPNGatewayConnectionIkePolicyPatch() bool +} + +// UnmarshalVPNGatewayConnectionIkePolicyPatch unmarshals an instance of VPNGatewayConnectionIkePolicyPatch from the specified map of raw messages. +func UnmarshalVPNGatewayConnectionIkePolicyPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayConnectionIkePolicyPatch) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayConnectionIkePolicyPrototype : The IKE policy to use. If unspecified, [auto-negotiation will be +// used](https://cloud.ibm.com/docs/vpc?topic=vpc-using-vpn&interface=ui#ike-auto-negotiation-phase-1). +// Models which "extend" this model: +// - VPNGatewayConnectionIkePolicyPrototypeIkePolicyIdentityByID +// - VPNGatewayConnectionIkePolicyPrototypeIkePolicyIdentityByHref +type VPNGatewayConnectionIkePolicyPrototype struct { + // The unique identifier for this IKE policy. + ID *string `json:"id,omitempty"` + + // The IKE policy's canonical URL. + Href *string `json:"href,omitempty"` +} + +func (*VPNGatewayConnectionIkePolicyPrototype) isaVPNGatewayConnectionIkePolicyPrototype() bool { + return true +} + +type VPNGatewayConnectionIkePolicyPrototypeIntf interface { + isaVPNGatewayConnectionIkePolicyPrototype() bool +} + +// UnmarshalVPNGatewayConnectionIkePolicyPrototype unmarshals an instance of VPNGatewayConnectionIkePolicyPrototype from the specified map of raw messages. +func UnmarshalVPNGatewayConnectionIkePolicyPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayConnectionIkePolicyPrototype) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayConnectionIPsecPolicyPatch : The IPsec policy to use. Specify `null` to remove any existing policy, [resulting in +// auto-negotiation](https://cloud.ibm.com/docs/vpc?topic=vpc-using-vpn&interface=ui#ipsec-auto-negotiation-phase-2). +// Models which "extend" this model: +// - VPNGatewayConnectionIPsecPolicyPatchIPsecPolicyIdentityByID +// - VPNGatewayConnectionIPsecPolicyPatchIPsecPolicyIdentityByHref +type VPNGatewayConnectionIPsecPolicyPatch struct { + // The unique identifier for this IPsec policy. + ID *string `json:"id,omitempty"` + + // The IPsec policy's canonical URL. + Href *string `json:"href,omitempty"` +} + +func (*VPNGatewayConnectionIPsecPolicyPatch) isaVPNGatewayConnectionIPsecPolicyPatch() bool { + return true +} + +type VPNGatewayConnectionIPsecPolicyPatchIntf interface { + isaVPNGatewayConnectionIPsecPolicyPatch() bool +} + +// UnmarshalVPNGatewayConnectionIPsecPolicyPatch unmarshals an instance of VPNGatewayConnectionIPsecPolicyPatch from the specified map of raw messages. +func UnmarshalVPNGatewayConnectionIPsecPolicyPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayConnectionIPsecPolicyPatch) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayConnectionIPsecPolicyPrototype : The IPsec policy to use. If unspecified, [auto-negotiation will be +// used](https://cloud.ibm.com/docs/vpc?topic=vpc-using-vpn&interface=ui#ipsec-auto-negotiation-phase-2). +// Models which "extend" this model: +// - VPNGatewayConnectionIPsecPolicyPrototypeIPsecPolicyIdentityByID +// - VPNGatewayConnectionIPsecPolicyPrototypeIPsecPolicyIdentityByHref +type VPNGatewayConnectionIPsecPolicyPrototype struct { + // The unique identifier for this IPsec policy. + ID *string `json:"id,omitempty"` + + // The IPsec policy's canonical URL. + Href *string `json:"href,omitempty"` +} + +func (*VPNGatewayConnectionIPsecPolicyPrototype) isaVPNGatewayConnectionIPsecPolicyPrototype() bool { + return true +} + +type VPNGatewayConnectionIPsecPolicyPrototypeIntf interface { + isaVPNGatewayConnectionIPsecPolicyPrototype() bool +} + +// UnmarshalVPNGatewayConnectionIPsecPolicyPrototype unmarshals an instance of VPNGatewayConnectionIPsecPolicyPrototype from the specified map of raw messages. +func UnmarshalVPNGatewayConnectionIPsecPolicyPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayConnectionIPsecPolicyPrototype) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayConnectionLocalCIDRs : VPNGatewayConnectionLocalCIDRs struct +type VPNGatewayConnectionLocalCIDRs struct { + // The local CIDRs for this resource. + LocalCIDRs []string `json:"local_cidrs,omitempty"` +} + +// UnmarshalVPNGatewayConnectionLocalCIDRs unmarshals an instance of VPNGatewayConnectionLocalCIDRs from the specified map of raw messages. +func UnmarshalVPNGatewayConnectionLocalCIDRs(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayConnectionLocalCIDRs) + err = core.UnmarshalPrimitive(m, "local_cidrs", &obj.LocalCIDRs) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayConnectionPatch : VPNGatewayConnectionPatch struct +// Models which "extend" this model: +// - VPNGatewayConnectionPatchVPNGatewayConnectionStaticRouteModePatch +type VPNGatewayConnectionPatch struct { + // If set to false, the VPN gateway connection is shut down. + AdminStateUp *bool `json:"admin_state_up,omitempty"` + + // The Dead Peer Detection settings. + DeadPeerDetection *VPNGatewayConnectionDpdPatch `json:"dead_peer_detection,omitempty"` + + // The IKE policy to use. Specify `null` to remove any existing policy, [resulting in + // auto-negotiation](https://cloud.ibm.com/docs/vpc?topic=vpc-using-vpn&interface=ui#ike-auto-negotiation-phase-1). + IkePolicy VPNGatewayConnectionIkePolicyPatchIntf `json:"ike_policy,omitempty"` + + // The IPsec policy to use. Specify `null` to remove any existing policy, [resulting in + // auto-negotiation](https://cloud.ibm.com/docs/vpc?topic=vpc-using-vpn&interface=ui#ipsec-auto-negotiation-phase-2). + IpsecPolicy VPNGatewayConnectionIPsecPolicyPatchIntf `json:"ipsec_policy,omitempty"` + + // The name for this VPN gateway connection. The name must not be used by another connection for the VPN gateway. + Name *string `json:"name,omitempty"` + + // The IP address of the peer VPN gateway. + PeerAddress *string `json:"peer_address,omitempty"` + + // The pre-shared key. + Psk *string `json:"psk,omitempty"` + + // Routing protocols are disabled for this VPN gateway connection. + RoutingProtocol *string `json:"routing_protocol,omitempty"` +} + +// Constants associated with the VPNGatewayConnectionPatch.RoutingProtocol property. +// Routing protocols are disabled for this VPN gateway connection. +const ( + VPNGatewayConnectionPatchRoutingProtocolNoneConst = "none" +) + +func (*VPNGatewayConnectionPatch) isaVPNGatewayConnectionPatch() bool { + return true +} + +type VPNGatewayConnectionPatchIntf interface { + isaVPNGatewayConnectionPatch() bool +} + +// UnmarshalVPNGatewayConnectionPatch unmarshals an instance of VPNGatewayConnectionPatch from the specified map of raw messages. +func UnmarshalVPNGatewayConnectionPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayConnectionPatch) + err = core.UnmarshalPrimitive(m, "admin_state_up", &obj.AdminStateUp) + if err != nil { + return + } + err = core.UnmarshalModel(m, "dead_peer_detection", &obj.DeadPeerDetection, UnmarshalVPNGatewayConnectionDpdPatch) + if err != nil { + return + } + err = core.UnmarshalModel(m, "ike_policy", &obj.IkePolicy, UnmarshalVPNGatewayConnectionIkePolicyPatch) + if err != nil { + return + } + err = core.UnmarshalModel(m, "ipsec_policy", &obj.IpsecPolicy, UnmarshalVPNGatewayConnectionIPsecPolicyPatch) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "peer_address", &obj.PeerAddress) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "psk", &obj.Psk) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "routing_protocol", &obj.RoutingProtocol) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the VPNGatewayConnectionPatch +func (vpnGatewayConnectionPatch *VPNGatewayConnectionPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(vpnGatewayConnectionPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// VPNGatewayConnectionPeerCIDRs : VPNGatewayConnectionPeerCIDRs struct +type VPNGatewayConnectionPeerCIDRs struct { + // The peer CIDRs for this resource. + PeerCIDRs []string `json:"peer_cidrs,omitempty"` +} + +// UnmarshalVPNGatewayConnectionPeerCIDRs unmarshals an instance of VPNGatewayConnectionPeerCIDRs from the specified map of raw messages. +func UnmarshalVPNGatewayConnectionPeerCIDRs(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayConnectionPeerCIDRs) + err = core.UnmarshalPrimitive(m, "peer_cidrs", &obj.PeerCIDRs) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayConnectionPrototype : VPNGatewayConnectionPrototype struct +// Models which "extend" this model: +// - VPNGatewayConnectionPrototypeVPNGatewayConnectionStaticRouteModePrototype +// - VPNGatewayConnectionPrototypeVPNGatewayConnectionPolicyModePrototype +type VPNGatewayConnectionPrototype struct { + // If set to false, the VPN gateway connection is shut down. + AdminStateUp *bool `json:"admin_state_up,omitempty"` + + // The Dead Peer Detection settings. + DeadPeerDetection *VPNGatewayConnectionDpdPrototype `json:"dead_peer_detection,omitempty"` + + // The IKE policy to use. If unspecified, [auto-negotiation will be + // used](https://cloud.ibm.com/docs/vpc?topic=vpc-using-vpn&interface=ui#ike-auto-negotiation-phase-1). + IkePolicy VPNGatewayConnectionIkePolicyPrototypeIntf `json:"ike_policy,omitempty"` + + // The IPsec policy to use. If unspecified, [auto-negotiation will be + // used](https://cloud.ibm.com/docs/vpc?topic=vpc-using-vpn&interface=ui#ipsec-auto-negotiation-phase-2). + IpsecPolicy VPNGatewayConnectionIPsecPolicyPrototypeIntf `json:"ipsec_policy,omitempty"` + + // The name for this VPN gateway connection. The name must not be used by another connection for the VPN gateway. If + // unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The IP address of the peer VPN gateway. + PeerAddress *string `json:"peer_address" validate:"required"` + + // The pre-shared key. + Psk *string `json:"psk" validate:"required"` + + // Routing protocols are disabled for this VPN gateway connection. + RoutingProtocol *string `json:"routing_protocol,omitempty"` + + // The local CIDRs for this resource. + LocalCIDRs []string `json:"local_cidrs,omitempty"` + + // The peer CIDRs for this resource. + PeerCIDRs []string `json:"peer_cidrs,omitempty"` +} + +// Constants associated with the VPNGatewayConnectionPrototype.RoutingProtocol property. +// Routing protocols are disabled for this VPN gateway connection. +const ( + VPNGatewayConnectionPrototypeRoutingProtocolNoneConst = "none" +) + +func (*VPNGatewayConnectionPrototype) isaVPNGatewayConnectionPrototype() bool { + return true +} + +type VPNGatewayConnectionPrototypeIntf interface { + isaVPNGatewayConnectionPrototype() bool +} + +// UnmarshalVPNGatewayConnectionPrototype unmarshals an instance of VPNGatewayConnectionPrototype from the specified map of raw messages. +func UnmarshalVPNGatewayConnectionPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayConnectionPrototype) + err = core.UnmarshalPrimitive(m, "admin_state_up", &obj.AdminStateUp) + if err != nil { + return + } + err = core.UnmarshalModel(m, "dead_peer_detection", &obj.DeadPeerDetection, UnmarshalVPNGatewayConnectionDpdPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "ike_policy", &obj.IkePolicy, UnmarshalVPNGatewayConnectionIkePolicyPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "ipsec_policy", &obj.IpsecPolicy, UnmarshalVPNGatewayConnectionIPsecPolicyPrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "peer_address", &obj.PeerAddress) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "psk", &obj.Psk) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "routing_protocol", &obj.RoutingProtocol) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "local_cidrs", &obj.LocalCIDRs) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "peer_cidrs", &obj.PeerCIDRs) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayConnectionReference : VPNGatewayConnectionReference struct +type VPNGatewayConnectionReference struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *VPNGatewayConnectionReferenceDeleted `json:"deleted,omitempty"` + + // The VPN connection's canonical URL. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this VPN gateway connection. + ID *string `json:"id" validate:"required"` + + // The name for this VPN gateway connection. The name is unique across all connections for the VPN gateway. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the VPNGatewayConnectionReference.ResourceType property. +// The resource type. +const ( + VPNGatewayConnectionReferenceResourceTypeVPNGatewayConnectionConst = "vpn_gateway_connection" +) + +// UnmarshalVPNGatewayConnectionReference unmarshals an instance of VPNGatewayConnectionReference from the specified map of raw messages. +func UnmarshalVPNGatewayConnectionReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayConnectionReference) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalVPNGatewayConnectionReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayConnectionReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type VPNGatewayConnectionReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalVPNGatewayConnectionReferenceDeleted unmarshals an instance of VPNGatewayConnectionReferenceDeleted from the specified map of raw messages. +func UnmarshalVPNGatewayConnectionReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayConnectionReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayConnectionStaticRouteModeTunnel : VPNGatewayConnectionStaticRouteModeTunnel struct +type VPNGatewayConnectionStaticRouteModeTunnel struct { + // The IP address of the VPN gateway member in which the tunnel resides. + PublicIP *IP `json:"public_ip" validate:"required"` + + // The status of the VPN Tunnel. + Status *string `json:"status" validate:"required"` +} + +// Constants associated with the VPNGatewayConnectionStaticRouteModeTunnel.Status property. +// The status of the VPN Tunnel. +const ( + VPNGatewayConnectionStaticRouteModeTunnelStatusDownConst = "down" + VPNGatewayConnectionStaticRouteModeTunnelStatusUpConst = "up" +) + +// UnmarshalVPNGatewayConnectionStaticRouteModeTunnel unmarshals an instance of VPNGatewayConnectionStaticRouteModeTunnel from the specified map of raw messages. +func UnmarshalVPNGatewayConnectionStaticRouteModeTunnel(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayConnectionStaticRouteModeTunnel) + err = core.UnmarshalModel(m, "public_ip", &obj.PublicIP, UnmarshalIP) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayMember : VPNGatewayMember struct +type VPNGatewayMember struct { + // The reserved IP address assigned to the VPN gateway member. + // + // This property will be present only when the VPN gateway status is `available`. + PrivateIP *ReservedIPReference `json:"private_ip" validate:"required"` + + // The public IP address assigned to the VPN gateway member. + PublicIP *IP `json:"public_ip" validate:"required"` + + // The high availability role assigned to the VPN gateway member. + Role *string `json:"role" validate:"required"` + + // The status of the VPN gateway member. + Status *string `json:"status" validate:"required"` +} + +// Constants associated with the VPNGatewayMember.Role property. +// The high availability role assigned to the VPN gateway member. +const ( + VPNGatewayMemberRoleActiveConst = "active" + VPNGatewayMemberRoleStandbyConst = "standby" +) + +// Constants associated with the VPNGatewayMember.Status property. +// The status of the VPN gateway member. +const ( + VPNGatewayMemberStatusAvailableConst = "available" + VPNGatewayMemberStatusDeletingConst = "deleting" + VPNGatewayMemberStatusFailedConst = "failed" + VPNGatewayMemberStatusPendingConst = "pending" +) + +// UnmarshalVPNGatewayMember unmarshals an instance of VPNGatewayMember from the specified map of raw messages. +func UnmarshalVPNGatewayMember(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayMember) + err = core.UnmarshalModel(m, "private_ip", &obj.PrivateIP, UnmarshalReservedIPReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "public_ip", &obj.PublicIP, UnmarshalIP) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "role", &obj.Role) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayPatch : VPNGatewayPatch struct +type VPNGatewayPatch struct { + // The name for this VPN gateway. The name must not be used by another VPN gateway in the VPC. + Name *string `json:"name,omitempty"` +} + +// UnmarshalVPNGatewayPatch unmarshals an instance of VPNGatewayPatch from the specified map of raw messages. +func UnmarshalVPNGatewayPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayPatch) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the VPNGatewayPatch +func (vpnGatewayPatch *VPNGatewayPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(vpnGatewayPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// VPNGatewayPrototype : VPNGatewayPrototype struct +// Models which "extend" this model: +// - VPNGatewayPrototypeVPNGatewayRouteModePrototype +// - VPNGatewayPrototypeVPNGatewayPolicyModePrototype +type VPNGatewayPrototype struct { + // The name for this VPN gateway. The name must not be used by another VPN gateway in the VPC. If unspecified, the name + // will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // Identifies a subnet by a unique property. + Subnet SubnetIdentityIntf `json:"subnet" validate:"required"` + + // Route mode VPN gateway. + Mode *string `json:"mode,omitempty"` +} + +// Constants associated with the VPNGatewayPrototype.Mode property. +// Route mode VPN gateway. +const ( + VPNGatewayPrototypeModeRouteConst = "route" +) + +func (*VPNGatewayPrototype) isaVPNGatewayPrototype() bool { + return true +} + +type VPNGatewayPrototypeIntf interface { + isaVPNGatewayPrototype() bool +} + +// UnmarshalVPNGatewayPrototype unmarshals an instance of VPNGatewayPrototype from the specified map of raw messages. +func UnmarshalVPNGatewayPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayPrototype) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnet", &obj.Subnet, UnmarshalSubnetIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "mode", &obj.Mode) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type VPNGatewayReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalVPNGatewayReferenceDeleted unmarshals an instance of VPNGatewayReferenceDeleted from the specified map of raw messages. +func UnmarshalVPNGatewayReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNServer : VPNServer struct +type VPNServer struct { + // The certificate instance for this VPN server. + Certificate *CertificateInstanceReference `json:"certificate" validate:"required"` + + // The methods used to authenticate VPN clients to this VPN server. VPN clients must authenticate against all specified + // methods. + ClientAuthentication []VPNServerAuthenticationIntf `json:"client_authentication" validate:"required"` + + // Indicates whether disconnected VPN clients will be automatically deleted after + // `client_auto_delete_timeout` hours have passed. At present, this is always `true`, but may be modifiable in the + // future. + ClientAutoDelete *bool `json:"client_auto_delete" validate:"required"` + + // If `client_auto_delete` is `true`, the hours after which disconnected VPN clients will be automatically deleted. If + // the value is `0`, disconnected VPN clients will be deleted immediately. This value may be modifiable in the future. + ClientAutoDeleteTimeout *int64 `json:"client_auto_delete_timeout" validate:"required"` + + // The DNS server addresses that will be provided to VPN clients that are connected to this VPN server. + ClientDnsServerIps []IP `json:"client_dns_server_ips" validate:"required"` + + // The seconds a VPN client can be idle before this VPN server will disconnect it. If `0`, the server will not + // disconnect idle clients. + ClientIdleTimeout *int64 `json:"client_idle_timeout" validate:"required"` + + // The VPN client IPv4 address pool, expressed in CIDR format. + ClientIPPool *string `json:"client_ip_pool" validate:"required"` + + // The date and time that the VPN server was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The CRN for this VPN server. + CRN *string `json:"crn" validate:"required"` + + // Indicates whether the split tunneling is enabled on this VPN server. + EnableSplitTunneling *bool `json:"enable_split_tunneling" validate:"required"` + + // The health of this resource. + // - `ok`: No abnormal behavior detected + // - `degraded`: Experiencing compromised performance, capacity, or connectivity + // - `faulted`: Completely unreachable, inoperative, or otherwise entirely incapacitated + // - `inapplicable`: The health state does not apply because of the current lifecycle state. A resource with a + // lifecycle state of `failed` or `deleting` will have a health state of `inapplicable`. A `pending` resource may also + // have this state. + HealthState *string `json:"health_state" validate:"required"` + + // Fully qualified domain name assigned to this VPN server. + Hostname *string `json:"hostname" validate:"required"` + + // The URL for this VPN server. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this VPN server. + ID *string `json:"id" validate:"required"` + + // The lifecycle state of the VPN server. + LifecycleState *string `json:"lifecycle_state" validate:"required"` + + // The name for this VPN server. The name is unique across all VPN servers in the VPC. + Name *string `json:"name" validate:"required"` + + // The port number used by this VPN server. + Port *int64 `json:"port" validate:"required"` + + // The reserved IPs bound to this VPN server. + PrivateIps []ReservedIPReference `json:"private_ips" validate:"required"` + + // The transport protocol used by this VPN server. + Protocol *string `json:"protocol" validate:"required"` + + // The resource group for this VPN server. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The security groups targeting this VPN server. + SecurityGroups []SecurityGroupReference `json:"security_groups" validate:"required"` + + // The subnets this VPN server is provisioned in. + Subnets []SubnetReference `json:"subnets" validate:"required"` + + // The VPC this VPN server resides in. + VPC *VPCReference `json:"vpc" validate:"required"` +} + +// Constants associated with the VPNServer.HealthState property. +// The health of this resource. +// - `ok`: No abnormal behavior detected +// - `degraded`: Experiencing compromised performance, capacity, or connectivity +// - `faulted`: Completely unreachable, inoperative, or otherwise entirely incapacitated +// - `inapplicable`: The health state does not apply because of the current lifecycle state. A resource with a lifecycle +// state of `failed` or `deleting` will have a health state of `inapplicable`. A `pending` resource may also have this +// state. +const ( + VPNServerHealthStateDegradedConst = "degraded" + VPNServerHealthStateFaultedConst = "faulted" + VPNServerHealthStateInapplicableConst = "inapplicable" + VPNServerHealthStateOkConst = "ok" +) + +// Constants associated with the VPNServer.LifecycleState property. +// The lifecycle state of the VPN server. +const ( + VPNServerLifecycleStateDeletingConst = "deleting" + VPNServerLifecycleStateFailedConst = "failed" + VPNServerLifecycleStatePendingConst = "pending" + VPNServerLifecycleStateStableConst = "stable" + VPNServerLifecycleStateSuspendedConst = "suspended" + VPNServerLifecycleStateUpdatingConst = "updating" + VPNServerLifecycleStateWaitingConst = "waiting" +) + +// Constants associated with the VPNServer.Protocol property. +// The transport protocol used by this VPN server. +const ( + VPNServerProtocolTCPConst = "tcp" + VPNServerProtocolUDPConst = "udp" +) + +// Constants associated with the VPNServer.ResourceType property. +// The resource type. +const ( + VPNServerResourceTypeVPNServerConst = "vpn_server" +) + +// UnmarshalVPNServer unmarshals an instance of VPNServer from the specified map of raw messages. +func UnmarshalVPNServer(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNServer) + err = core.UnmarshalModel(m, "certificate", &obj.Certificate, UnmarshalCertificateInstanceReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "client_authentication", &obj.ClientAuthentication, UnmarshalVPNServerAuthentication) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "client_auto_delete", &obj.ClientAutoDelete) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "client_auto_delete_timeout", &obj.ClientAutoDeleteTimeout) + if err != nil { + return + } + err = core.UnmarshalModel(m, "client_dns_server_ips", &obj.ClientDnsServerIps, UnmarshalIP) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "client_idle_timeout", &obj.ClientIdleTimeout) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "client_ip_pool", &obj.ClientIPPool) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "enable_split_tunneling", &obj.EnableSplitTunneling) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "health_state", &obj.HealthState) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "hostname", &obj.Hostname) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "lifecycle_state", &obj.LifecycleState) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "port", &obj.Port) + if err != nil { + return + } + err = core.UnmarshalModel(m, "private_ips", &obj.PrivateIps, UnmarshalReservedIPReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "protocol", &obj.Protocol) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalModel(m, "security_groups", &obj.SecurityGroups, UnmarshalSecurityGroupReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnets", &obj.Subnets, UnmarshalSubnetReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNServerAuthentication : An authentication method for this VPN server. +// Models which "extend" this model: +// - VPNServerAuthenticationByUsername +// - VPNServerAuthenticationByCertificate +type VPNServerAuthentication struct { + // The type of authentication. + Method *string `json:"method" validate:"required"` + + // The type of identity provider to be used by VPN client. + IdentityProvider VPNServerAuthenticationByUsernameIDProviderIntf `json:"identity_provider,omitempty"` + + // The certificate instance used for the VPN client certificate authority (CA). + ClientCa *CertificateInstanceReference `json:"client_ca,omitempty"` + + // The certificate revocation list contents, encoded in PEM format. + Crl *string `json:"crl,omitempty"` +} + +// Constants associated with the VPNServerAuthentication.Method property. +// The type of authentication. +const ( + VPNServerAuthenticationMethodCertificateConst = "certificate" + VPNServerAuthenticationMethodUsernameConst = "username" +) + +func (*VPNServerAuthentication) isaVPNServerAuthentication() bool { + return true +} + +type VPNServerAuthenticationIntf interface { + isaVPNServerAuthentication() bool +} + +// UnmarshalVPNServerAuthentication unmarshals an instance of VPNServerAuthentication from the specified map of raw messages. +func UnmarshalVPNServerAuthentication(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNServerAuthentication) + err = core.UnmarshalPrimitive(m, "method", &obj.Method) + if err != nil { + return + } + err = core.UnmarshalModel(m, "identity_provider", &obj.IdentityProvider, UnmarshalVPNServerAuthenticationByUsernameIDProvider) + if err != nil { + return + } + err = core.UnmarshalModel(m, "client_ca", &obj.ClientCa, UnmarshalCertificateInstanceReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crl", &obj.Crl) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNServerAuthenticationByUsernameIDProvider : The type of identity provider to be used by VPN client. +// Models which "extend" this model: +// - VPNServerAuthenticationByUsernameIDProviderByIam +type VPNServerAuthenticationByUsernameIDProvider struct { + // The type of identity provider to be used by the VPN client. + // - `iam`: IBM identity and access management + // + // The enumerated values for this property are expected to expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the route on which the + // unexpected property value was encountered. + ProviderType *string `json:"provider_type,omitempty"` +} + +// Constants associated with the VPNServerAuthenticationByUsernameIDProvider.ProviderType property. +// The type of identity provider to be used by the VPN client. +// - `iam`: IBM identity and access management +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the route on which the +// unexpected property value was encountered. +const ( + VPNServerAuthenticationByUsernameIDProviderProviderTypeIamConst = "iam" +) + +func (*VPNServerAuthenticationByUsernameIDProvider) isaVPNServerAuthenticationByUsernameIDProvider() bool { + return true +} + +type VPNServerAuthenticationByUsernameIDProviderIntf interface { + isaVPNServerAuthenticationByUsernameIDProvider() bool +} + +// UnmarshalVPNServerAuthenticationByUsernameIDProvider unmarshals an instance of VPNServerAuthenticationByUsernameIDProvider from the specified map of raw messages. +func UnmarshalVPNServerAuthenticationByUsernameIDProvider(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNServerAuthenticationByUsernameIDProvider) + err = core.UnmarshalPrimitive(m, "provider_type", &obj.ProviderType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNServerAuthenticationPrototype : An authentication method for this VPN server. +// Models which "extend" this model: +// - VPNServerAuthenticationPrototypeVPNServerAuthenticationByUsernamePrototype +// - VPNServerAuthenticationPrototypeVPNServerAuthenticationByCertificatePrototype +type VPNServerAuthenticationPrototype struct { + // The type of authentication. + Method *string `json:"method" validate:"required"` + + // The type of identity provider to be used by VPN client. + IdentityProvider VPNServerAuthenticationByUsernameIDProviderIntf `json:"identity_provider,omitempty"` + + // The certificate instance to use for the VPN client certificate authority (CA). + ClientCa CertificateInstanceIdentityIntf `json:"client_ca,omitempty"` + + // The certificate revocation list contents, encoded in PEM format. + Crl *string `json:"crl,omitempty"` +} + +// Constants associated with the VPNServerAuthenticationPrototype.Method property. +// The type of authentication. +const ( + VPNServerAuthenticationPrototypeMethodCertificateConst = "certificate" + VPNServerAuthenticationPrototypeMethodUsernameConst = "username" +) + +func (*VPNServerAuthenticationPrototype) isaVPNServerAuthenticationPrototype() bool { + return true +} + +type VPNServerAuthenticationPrototypeIntf interface { + isaVPNServerAuthenticationPrototype() bool +} + +// UnmarshalVPNServerAuthenticationPrototype unmarshals an instance of VPNServerAuthenticationPrototype from the specified map of raw messages. +func UnmarshalVPNServerAuthenticationPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + // Retrieve discriminator value to determine correct "subclass". + var discValue string + err = core.UnmarshalPrimitive(m, "method", &discValue) + if err != nil { + err = fmt.Errorf("error unmarshalling discriminator property 'method': %s", err.Error()) + return + } + if discValue == "" { + err = fmt.Errorf("required discriminator property 'method' not found in JSON object") + return + } + if discValue == "certificate" { + err = core.UnmarshalModel(m, "", result, UnmarshalVPNServerAuthenticationPrototypeVPNServerAuthenticationByCertificatePrototype) + } else if discValue == "username" { + err = core.UnmarshalModel(m, "", result, UnmarshalVPNServerAuthenticationPrototypeVPNServerAuthenticationByUsernamePrototype) + } else { + err = fmt.Errorf("unrecognized value for discriminator property 'method': %s", discValue) + } + return +} + +// VPNServerClient : VPNServerClient struct +type VPNServerClient struct { + // The IP address assigned to this VPN client from `client_ip_pool`. + ClientIP *IP `json:"client_ip" validate:"required"` + + // The common name of client certificate that the VPN client provided when connecting to the server. + // + // This property will be present only when the `certificate` client authentication method is enabled on the VPN server. + CommonName *string `json:"common_name,omitempty"` + + // The date and time that the VPN client was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The date and time that the VPN client was disconnected. + // + // This property will be present only when the client `status` is `disconnected`. + DisconnectedAt *strfmt.DateTime `json:"disconnected_at,omitempty"` + + // The URL for this VPN client. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this VPN client. + ID *string `json:"id" validate:"required"` + + // The remote IP address of this VPN client. + RemoteIP *IP `json:"remote_ip" validate:"required"` + + // The remote port of this VPN client. + RemotePort *int64 `json:"remote_port" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The status of the VPN client: + // - `connected`: the VPN client is `connected` to this VPN server. + // - `disconnected`: the VPN client is `disconnected` from this VPN server. + // + // The enumerated values for this property are expected to expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the VPN client on which the + // unexpected property value was encountered. + Status *string `json:"status" validate:"required"` + + // The username that this VPN client provided when connecting to the VPN server. + // + // This property will be present only when the `username` client authentication method is enabled on the VPN server. + Username *string `json:"username,omitempty"` +} + +// Constants associated with the VPNServerClient.ResourceType property. +// The resource type. +const ( + VPNServerClientResourceTypeVPNServerClientConst = "vpn_server_client" +) + +// Constants associated with the VPNServerClient.Status property. +// The status of the VPN client: +// - `connected`: the VPN client is `connected` to this VPN server. +// - `disconnected`: the VPN client is `disconnected` from this VPN server. +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the VPN client on which the +// unexpected property value was encountered. +const ( + VPNServerClientStatusConnectedConst = "connected" + VPNServerClientStatusDisconnectedConst = "disconnected" +) + +// UnmarshalVPNServerClient unmarshals an instance of VPNServerClient from the specified map of raw messages. +func UnmarshalVPNServerClient(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNServerClient) + err = core.UnmarshalModel(m, "client_ip", &obj.ClientIP, UnmarshalIP) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "common_name", &obj.CommonName) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "disconnected_at", &obj.DisconnectedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalModel(m, "remote_ip", &obj.RemoteIP, UnmarshalIP) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "remote_port", &obj.RemotePort) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "username", &obj.Username) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNServerClientCollection : VPNServerClientCollection struct +type VPNServerClientCollection struct { + // Collection of VPN clients. + Clients []VPNServerClient `json:"clients" validate:"required"` + + // A link to the first page of resources. + First *VPNServerClientCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *VPNServerClientCollectionNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalVPNServerClientCollection unmarshals an instance of VPNServerClientCollection from the specified map of raw messages. +func UnmarshalVPNServerClientCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNServerClientCollection) + err = core.UnmarshalModel(m, "clients", &obj.Clients, UnmarshalVPNServerClient) + if err != nil { + return + } + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalVPNServerClientCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalVPNServerClientCollectionNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *VPNServerClientCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// VPNServerClientCollectionFirst : A link to the first page of resources. +type VPNServerClientCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalVPNServerClientCollectionFirst unmarshals an instance of VPNServerClientCollectionFirst from the specified map of raw messages. +func UnmarshalVPNServerClientCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNServerClientCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNServerClientCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type VPNServerClientCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalVPNServerClientCollectionNext unmarshals an instance of VPNServerClientCollectionNext from the specified map of raw messages. +func UnmarshalVPNServerClientCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNServerClientCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNServerCollection : VPNServerCollection struct +type VPNServerCollection struct { + // A link to the first page of resources. + First *VPNServerCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *VPNServerCollectionNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` + + // Collection of VPN servers. + VPNServers []VPNServer `json:"vpn_servers" validate:"required"` +} + +// UnmarshalVPNServerCollection unmarshals an instance of VPNServerCollection from the specified map of raw messages. +func UnmarshalVPNServerCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNServerCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalVPNServerCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalVPNServerCollectionNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpn_servers", &obj.VPNServers, UnmarshalVPNServer) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *VPNServerCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// VPNServerCollectionFirst : A link to the first page of resources. +type VPNServerCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalVPNServerCollectionFirst unmarshals an instance of VPNServerCollectionFirst from the specified map of raw messages. +func UnmarshalVPNServerCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNServerCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNServerCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type VPNServerCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalVPNServerCollectionNext unmarshals an instance of VPNServerCollectionNext from the specified map of raw messages. +func UnmarshalVPNServerCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNServerCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNServerPatch : VPNServerPatch struct +type VPNServerPatch struct { + // The certificate instance for this VPN server. + Certificate CertificateInstanceIdentityIntf `json:"certificate,omitempty"` + + // The authentication methods to use to authenticate VPN client on this VPN server + // (replacing any existing methods). + ClientAuthentication []VPNServerAuthenticationPrototypeIntf `json:"client_authentication,omitempty"` + + // The DNS server addresses that will be provided to VPN clients connected to this VPN server (replacing any existing + // addresses). + ClientDnsServerIps []IP `json:"client_dns_server_ips,omitempty"` + + // The seconds a VPN client can be idle before this VPN server will disconnect it. If `0`, the server will not + // disconnect idle clients. + ClientIdleTimeout *int64 `json:"client_idle_timeout,omitempty"` + + // The VPN client IPv4 address pool, expressed in CIDR format. The request must not overlap with any existing address + // prefixes in the VPC or any of the following reserved address ranges: + // - `127.0.0.0/8` (IPv4 loopback addresses) + // - `161.26.0.0/16` (IBM services) + // - `166.8.0.0/14` (Cloud Service Endpoints) + // - `169.254.0.0/16` (IPv4 link-local addresses) + // - `224.0.0.0/4` (IPv4 multicast addresses) + // + // The prefix length of the client IP address pool's CIDR must be between + // `/9` (8,388,608 addresses) and `/22` (1024 addresses). A CIDR block that contains twice the number of IP addresses + // that are required to enable the maximum number of concurrent connections is recommended. + ClientIPPool *string `json:"client_ip_pool,omitempty"` + + // Indicates whether the split tunneling is enabled on this VPN server. + EnableSplitTunneling *bool `json:"enable_split_tunneling,omitempty"` + + // The name for this VPN server. The name must not be used by another VPN server in the VPC. + Name *string `json:"name,omitempty"` + + // The port number used by this VPN server. + Port *int64 `json:"port,omitempty"` + + // The transport protocol used by this VPN server. + Protocol *string `json:"protocol,omitempty"` + + // The subnets to provision this VPN server in (replacing the existing subnets). + Subnets []SubnetIdentityIntf `json:"subnets,omitempty"` +} + +// Constants associated with the VPNServerPatch.Protocol property. +// The transport protocol used by this VPN server. +const ( + VPNServerPatchProtocolTCPConst = "tcp" + VPNServerPatchProtocolUDPConst = "udp" +) + +// UnmarshalVPNServerPatch unmarshals an instance of VPNServerPatch from the specified map of raw messages. +func UnmarshalVPNServerPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNServerPatch) + err = core.UnmarshalModel(m, "certificate", &obj.Certificate, UnmarshalCertificateInstanceIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "client_authentication", &obj.ClientAuthentication, UnmarshalVPNServerAuthenticationPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "client_dns_server_ips", &obj.ClientDnsServerIps, UnmarshalIP) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "client_idle_timeout", &obj.ClientIdleTimeout) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "client_ip_pool", &obj.ClientIPPool) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "enable_split_tunneling", &obj.EnableSplitTunneling) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "port", &obj.Port) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "protocol", &obj.Protocol) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnets", &obj.Subnets, UnmarshalSubnetIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the VPNServerPatch +func (vpnServerPatch *VPNServerPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(vpnServerPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// VPNServerReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type VPNServerReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalVPNServerReferenceDeleted unmarshals an instance of VPNServerReferenceDeleted from the specified map of raw messages. +func UnmarshalVPNServerReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNServerReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNServerRoute : VPNServerRoute struct +type VPNServerRoute struct { + // The action to perform with a packet matching the VPN route: + // - `translate`: translate the source IP address to one of the private IP addresses of the VPN server. + // - `deliver`: deliver the packet into the VPC. + // - `drop`: drop the packet + // + // The enumerated values for this property are expected to expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the VPN route on which the + // unexpected property value was encountered. + Action *string `json:"action" validate:"required"` + + // The date and time that the VPN route was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The destination for this VPN route in the VPN server. If an incoming packet does not match any destination, it will + // be dropped. + Destination *string `json:"destination" validate:"required"` + + // The URL for this VPN route. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this VPN route. + ID *string `json:"id" validate:"required"` + + // The lifecycle state of the VPN route. + LifecycleState *string `json:"lifecycle_state" validate:"required"` + + // The name for this VPN route. The name is unique across all routes for a VPN server. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the VPNServerRoute.Action property. +// The action to perform with a packet matching the VPN route: +// - `translate`: translate the source IP address to one of the private IP addresses of the VPN server. +// - `deliver`: deliver the packet into the VPC. +// - `drop`: drop the packet +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the VPN route on which the +// unexpected property value was encountered. +const ( + VPNServerRouteActionDeliverConst = "deliver" + VPNServerRouteActionDropConst = "drop" + VPNServerRouteActionTranslateConst = "translate" +) + +// Constants associated with the VPNServerRoute.LifecycleState property. +// The lifecycle state of the VPN route. +const ( + VPNServerRouteLifecycleStateDeletingConst = "deleting" + VPNServerRouteLifecycleStateFailedConst = "failed" + VPNServerRouteLifecycleStatePendingConst = "pending" + VPNServerRouteLifecycleStateStableConst = "stable" + VPNServerRouteLifecycleStateSuspendedConst = "suspended" + VPNServerRouteLifecycleStateUpdatingConst = "updating" + VPNServerRouteLifecycleStateWaitingConst = "waiting" +) + +// Constants associated with the VPNServerRoute.ResourceType property. +// The resource type. +const ( + VPNServerRouteResourceTypeVPNServerRouteConst = "vpn_server_route" +) + +// UnmarshalVPNServerRoute unmarshals an instance of VPNServerRoute from the specified map of raw messages. +func UnmarshalVPNServerRoute(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNServerRoute) + err = core.UnmarshalPrimitive(m, "action", &obj.Action) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "destination", &obj.Destination) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "lifecycle_state", &obj.LifecycleState) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNServerRouteCollection : VPNServerRouteCollection struct +type VPNServerRouteCollection struct { + // A link to the first page of resources. + First *VPNServerRouteCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *VPNServerRouteCollectionNext `json:"next,omitempty"` + + // Collection of VPN routes. + Routes []VPNServerRoute `json:"routes" validate:"required"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalVPNServerRouteCollection unmarshals an instance of VPNServerRouteCollection from the specified map of raw messages. +func UnmarshalVPNServerRouteCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNServerRouteCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalVPNServerRouteCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalVPNServerRouteCollectionNext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "routes", &obj.Routes, UnmarshalVPNServerRoute) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *VPNServerRouteCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// VPNServerRouteCollectionFirst : A link to the first page of resources. +type VPNServerRouteCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalVPNServerRouteCollectionFirst unmarshals an instance of VPNServerRouteCollectionFirst from the specified map of raw messages. +func UnmarshalVPNServerRouteCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNServerRouteCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNServerRouteCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type VPNServerRouteCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalVPNServerRouteCollectionNext unmarshals an instance of VPNServerRouteCollectionNext from the specified map of raw messages. +func UnmarshalVPNServerRouteCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNServerRouteCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNServerRoutePatch : VPNServerRoutePatch struct +type VPNServerRoutePatch struct { + // The name for this VPN server route. The name must not be used by another route for the VPN server. + Name *string `json:"name,omitempty"` +} + +// UnmarshalVPNServerRoutePatch unmarshals an instance of VPNServerRoutePatch from the specified map of raw messages. +func UnmarshalVPNServerRoutePatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNServerRoutePatch) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the VPNServerRoutePatch +func (vpnServerRoutePatch *VPNServerRoutePatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(vpnServerRoutePatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// VirtualNetworkInterface : VirtualNetworkInterface struct +type VirtualNetworkInterface struct { + // Indicates whether this virtual network interface will be automatically deleted when + // `target` is deleted. + AutoDelete *bool `json:"auto_delete" validate:"required"` + + // The date and time that the virtual network interface was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The CRN for this virtual network interface. + CRN *string `json:"crn" validate:"required"` + + // The URL for this virtual network interface. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this virtual network interface. + ID *string `json:"id" validate:"required"` + + // The lifecycle state of the virtual network interface. + LifecycleState *string `json:"lifecycle_state" validate:"required"` + + // The name for this virtual network interface. The name is unique across all virtual network interfaces in the VPC. + Name *string `json:"name" validate:"required"` + + // The reserved IP for this virtual network interface. + PrimaryIP *ReservedIPReference `json:"primary_ip" validate:"required"` + + // The resource group for this virtual network interface. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The security groups for this virtual network interface. + SecurityGroups []SecurityGroupReference `json:"security_groups" validate:"required"` + + // The associated subnet. + Subnet *SubnetReference `json:"subnet" validate:"required"` + + // The target of this virtual network interface. + // + // If absent, this virtual network interface is not attached to a target. + Target VirtualNetworkInterfaceTargetIntf `json:"target,omitempty"` + + // The VPC this virtual network interface resides in. + VPC *VPCReference `json:"vpc" validate:"required"` + + // The zone this virtual network interface resides in. + Zone *ZoneReference `json:"zone" validate:"required"` +} + +// Constants associated with the VirtualNetworkInterface.LifecycleState property. +// The lifecycle state of the virtual network interface. +const ( + VirtualNetworkInterfaceLifecycleStateDeletingConst = "deleting" + VirtualNetworkInterfaceLifecycleStateFailedConst = "failed" + VirtualNetworkInterfaceLifecycleStatePendingConst = "pending" + VirtualNetworkInterfaceLifecycleStateStableConst = "stable" + VirtualNetworkInterfaceLifecycleStateSuspendedConst = "suspended" + VirtualNetworkInterfaceLifecycleStateUpdatingConst = "updating" + VirtualNetworkInterfaceLifecycleStateWaitingConst = "waiting" +) + +// Constants associated with the VirtualNetworkInterface.ResourceType property. +// The resource type. +const ( + VirtualNetworkInterfaceResourceTypeVirtualNetworkInterfaceConst = "virtual_network_interface" +) + +// UnmarshalVirtualNetworkInterface unmarshals an instance of VirtualNetworkInterface from the specified map of raw messages. +func UnmarshalVirtualNetworkInterface(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VirtualNetworkInterface) + err = core.UnmarshalPrimitive(m, "auto_delete", &obj.AutoDelete) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "lifecycle_state", &obj.LifecycleState) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_ip", &obj.PrimaryIP, UnmarshalReservedIPReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalModel(m, "security_groups", &obj.SecurityGroups, UnmarshalSecurityGroupReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnet", &obj.Subnet, UnmarshalSubnetReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "target", &obj.Target, UnmarshalVirtualNetworkInterfaceTarget) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VirtualNetworkInterfaceCollection : VirtualNetworkInterfaceCollection struct +type VirtualNetworkInterfaceCollection struct { + // A link to the first page of resources. + First *VirtualNetworkInterfaceCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *VirtualNetworkInterfaceCollectionNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` + + // Collection of virtual network interfaces. + VirtualNetworkInterfaces []VirtualNetworkInterface `json:"virtual_network_interfaces" validate:"required"` +} + +// UnmarshalVirtualNetworkInterfaceCollection unmarshals an instance of VirtualNetworkInterfaceCollection from the specified map of raw messages. +func UnmarshalVirtualNetworkInterfaceCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VirtualNetworkInterfaceCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalVirtualNetworkInterfaceCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalVirtualNetworkInterfaceCollectionNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + err = core.UnmarshalModel(m, "virtual_network_interfaces", &obj.VirtualNetworkInterfaces, UnmarshalVirtualNetworkInterface) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *VirtualNetworkInterfaceCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// VirtualNetworkInterfaceCollectionFirst : A link to the first page of resources. +type VirtualNetworkInterfaceCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalVirtualNetworkInterfaceCollectionFirst unmarshals an instance of VirtualNetworkInterfaceCollectionFirst from the specified map of raw messages. +func UnmarshalVirtualNetworkInterfaceCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VirtualNetworkInterfaceCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VirtualNetworkInterfaceCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type VirtualNetworkInterfaceCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalVirtualNetworkInterfaceCollectionNext unmarshals an instance of VirtualNetworkInterfaceCollectionNext from the specified map of raw messages. +func UnmarshalVirtualNetworkInterfaceCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VirtualNetworkInterfaceCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VirtualNetworkInterfacePatch : VirtualNetworkInterfacePatch struct +type VirtualNetworkInterfacePatch struct { + // The name for this virtual network interface. The name is unique across all virtual network interfaces in the VPC. + Name *string `json:"name,omitempty"` +} + +// UnmarshalVirtualNetworkInterfacePatch unmarshals an instance of VirtualNetworkInterfacePatch from the specified map of raw messages. +func UnmarshalVirtualNetworkInterfacePatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VirtualNetworkInterfacePatch) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the VirtualNetworkInterfacePatch +func (virtualNetworkInterfacePatch *VirtualNetworkInterfacePatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(virtualNetworkInterfacePatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// VirtualNetworkInterfacePrimaryIPPrototype : VirtualNetworkInterfacePrimaryIPPrototype struct +// Models which "extend" this model: +// - VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContext +// - VirtualNetworkInterfacePrimaryIPPrototypeReservedIPPrototypeVirtualNetworkInterfacePrimaryIPContext +type VirtualNetworkInterfacePrimaryIPPrototype struct { + // The unique identifier for this reserved IP. + ID *string `json:"id,omitempty"` + + // The URL for this reserved IP. + Href *string `json:"href,omitempty"` + + // The IP address to reserve, which must not already be reserved on the subnet. + // + // If unspecified, an available address on the subnet will automatically be selected. + Address *string `json:"address,omitempty"` + + // Indicates whether this reserved IP member will be automatically deleted when either + // `target` is deleted, or the reserved IP is unbound. + AutoDelete *bool `json:"auto_delete,omitempty"` + + // The name for this reserved IP. The name must not be used by another reserved IP in the subnet. Names starting with + // `ibm-` are reserved for provider-owned resources, and are not allowed. If unspecified, the name will be a hyphenated + // list of randomly-selected words. + Name *string `json:"name,omitempty"` +} + +func (*VirtualNetworkInterfacePrimaryIPPrototype) isaVirtualNetworkInterfacePrimaryIPPrototype() bool { + return true +} + +type VirtualNetworkInterfacePrimaryIPPrototypeIntf interface { + isaVirtualNetworkInterfacePrimaryIPPrototype() bool +} + +// UnmarshalVirtualNetworkInterfacePrimaryIPPrototype unmarshals an instance of VirtualNetworkInterfacePrimaryIPPrototype from the specified map of raw messages. +func UnmarshalVirtualNetworkInterfacePrimaryIPPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VirtualNetworkInterfacePrimaryIPPrototype) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "auto_delete", &obj.AutoDelete) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VirtualNetworkInterfaceReferenceAttachmentContext : VirtualNetworkInterfaceReferenceAttachmentContext struct +type VirtualNetworkInterfaceReferenceAttachmentContext struct { + // The CRN for this virtual network interface. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *VirtualNetworkInterfaceReferenceAttachmentContextDeleted `json:"deleted,omitempty"` + + // The URL for this virtual network interface. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this virtual network interface. + ID *string `json:"id" validate:"required"` + + // The name for this virtual network interface. The name is unique across all virtual network interfaces in the VPC. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the VirtualNetworkInterfaceReferenceAttachmentContext.ResourceType property. +// The resource type. +const ( + VirtualNetworkInterfaceReferenceAttachmentContextResourceTypeVirtualNetworkInterfaceConst = "virtual_network_interface" +) + +// UnmarshalVirtualNetworkInterfaceReferenceAttachmentContext unmarshals an instance of VirtualNetworkInterfaceReferenceAttachmentContext from the specified map of raw messages. +func UnmarshalVirtualNetworkInterfaceReferenceAttachmentContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VirtualNetworkInterfaceReferenceAttachmentContext) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalVirtualNetworkInterfaceReferenceAttachmentContextDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VirtualNetworkInterfaceReferenceAttachmentContextDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type VirtualNetworkInterfaceReferenceAttachmentContextDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalVirtualNetworkInterfaceReferenceAttachmentContextDeleted unmarshals an instance of VirtualNetworkInterfaceReferenceAttachmentContextDeleted from the specified map of raw messages. +func UnmarshalVirtualNetworkInterfaceReferenceAttachmentContextDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VirtualNetworkInterfaceReferenceAttachmentContextDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VirtualNetworkInterfaceReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type VirtualNetworkInterfaceReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalVirtualNetworkInterfaceReferenceDeleted unmarshals an instance of VirtualNetworkInterfaceReferenceDeleted from the specified map of raw messages. +func UnmarshalVirtualNetworkInterfaceReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VirtualNetworkInterfaceReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VirtualNetworkInterfaceReferenceReservedIPTargetContextDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type VirtualNetworkInterfaceReferenceReservedIPTargetContextDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalVirtualNetworkInterfaceReferenceReservedIPTargetContextDeleted unmarshals an instance of VirtualNetworkInterfaceReferenceReservedIPTargetContextDeleted from the specified map of raw messages. +func UnmarshalVirtualNetworkInterfaceReferenceReservedIPTargetContextDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VirtualNetworkInterfaceReferenceReservedIPTargetContextDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VirtualNetworkInterfaceTarget : A virtual network interface target. +// +// The resource types that can be virtual network interface targets are expected to expand in the future. When iterating +// over virtual network interface targets, do not assume that every target resource will be from a known set of resource +// types. Optionally halt processing and surface an error, or bypass resources of unrecognized types. +// Models which "extend" this model: +// - VirtualNetworkInterfaceTargetShareMountTargetReference +type VirtualNetworkInterfaceTarget struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *ShareMountTargetReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this share mount target. + Href *string `json:"href,omitempty"` + + // The unique identifier for this share mount target. + ID *string `json:"id,omitempty"` + + // The name for this share mount target. The name is unique across all mount targets for the file share. + Name *string `json:"name,omitempty"` + + // The resource type. + ResourceType *string `json:"resource_type,omitempty"` +} + +// Constants associated with the VirtualNetworkInterfaceTarget.ResourceType property. +// The resource type. +const ( + VirtualNetworkInterfaceTargetResourceTypeShareMountTargetConst = "share_mount_target" +) + +func (*VirtualNetworkInterfaceTarget) isaVirtualNetworkInterfaceTarget() bool { + return true +} + +type VirtualNetworkInterfaceTargetIntf interface { + isaVirtualNetworkInterfaceTarget() bool +} + +// UnmarshalVirtualNetworkInterfaceTarget unmarshals an instance of VirtualNetworkInterfaceTarget from the specified map of raw messages. +func UnmarshalVirtualNetworkInterfaceTarget(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VirtualNetworkInterfaceTarget) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalShareMountTargetReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Volume : Volume struct +type Volume struct { + // Indicates whether a running virtual server instance has an attachment to this volume. + Active *bool `json:"active" validate:"required"` + + // The attachment state of the volume + // - `unattached`: Not attached to any virtual server instances + // - `attached`: Attached to a virtual server instance (even if the instance is stopped) + // - `unusable`: Not able to be attached to any virtual server instances. + AttachmentState *string `json:"attachment_state" validate:"required"` + + // The maximum bandwidth (in megabits per second) for the volume. + Bandwidth *int64 `json:"bandwidth" validate:"required"` + + // Indicates whether this volume is performing an operation that must be serialized. This must be `false` to perform an + // operation that is specified to require serialization. + Busy *bool `json:"busy" validate:"required"` + + // The capacity to use for the volume (in gigabytes). The specified minimum and maximum capacity values for creating or + // updating volumes may expand in the future. + Capacity *int64 `json:"capacity" validate:"required"` + + // The date and time that the volume was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The CRN for this volume. + CRN *string `json:"crn" validate:"required"` + + // The type of encryption used on the volume. + Encryption *string `json:"encryption" validate:"required"` + + // The root key used to wrap the data encryption key for the volume. + // + // This property will be present for volumes with an `encryption` type of + // `user_managed`. + EncryptionKey *EncryptionKeyReference `json:"encryption_key,omitempty"` + + // The reasons for the current `health_state` (if any). + // + // The enumerated reason code values for this property will expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the + // unexpected reason code was encountered. + HealthReasons []VolumeHealthReason `json:"health_reasons" validate:"required"` + + // The health of this resource. + // - `ok`: No abnormal behavior detected + // - `degraded`: Experiencing compromised performance, capacity, or connectivity + // - `faulted`: Completely unreachable, inoperative, or otherwise entirely incapacitated + // - `inapplicable`: The health state does not apply because of the current lifecycle state. A resource with a + // lifecycle state of `failed` or `deleting` will have a health state of `inapplicable`. A `pending` resource may also + // have this state. + HealthState *string `json:"health_state" validate:"required"` + + // The URL for this volume. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this volume. + ID *string `json:"id" validate:"required"` + + // The maximum I/O operations per second (IOPS) for this volume. + Iops *int64 `json:"iops" validate:"required"` + + // The name for this volume. The name is unique across all volumes in the region. + Name *string `json:"name" validate:"required"` + + // The operating system associated with this volume. If absent, this volume was not + // created from an image, or the image did not include an operating system. + OperatingSystem *OperatingSystem `json:"operating_system,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-block-storage-profiles) for + // this volume. + Profile *VolumeProfileReference `json:"profile" validate:"required"` + + // The resource group for this volume. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The image from which this volume was created (this may be + // [deleted](https://cloud.ibm.com/apidocs/vpc#deleted-resources)). + // If absent, this volume was not created from an image. + SourceImage *ImageReference `json:"source_image,omitempty"` + + // The snapshot from which this volume was cloned. + SourceSnapshot *SnapshotReference `json:"source_snapshot,omitempty"` + + // The status of the volume. + // + // The enumerated values for this property will expand in the future. When processing this property, check for and log + // unknown values. Optionally halt processing and surface the error, or bypass the volume on which the unexpected + // property value was encountered. + Status *string `json:"status" validate:"required"` + + // The reasons for the current status (if any). + // + // The enumerated reason code values for this property will expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the + // unexpected reason code was encountered. + StatusReasons []VolumeStatusReason `json:"status_reasons" validate:"required"` + + // The [user tags](https://cloud.ibm.com/apidocs/tagging#types-of-tags) associated with this volume. + UserTags []string `json:"user_tags" validate:"required"` + + // The volume attachments for this volume. + VolumeAttachments []VolumeAttachmentReferenceVolumeContext `json:"volume_attachments" validate:"required"` + + // The zone this volume resides in. + Zone *ZoneReference `json:"zone" validate:"required"` +} + +// Constants associated with the Volume.AttachmentState property. +// The attachment state of the volume +// - `unattached`: Not attached to any virtual server instances +// - `attached`: Attached to a virtual server instance (even if the instance is stopped) +// - `unusable`: Not able to be attached to any virtual server instances. +const ( + VolumeAttachmentStateAttachedConst = "attached" + VolumeAttachmentStateUnattachedConst = "unattached" + VolumeAttachmentStateUnusableConst = "unusable" +) + +// Constants associated with the Volume.Encryption property. +// The type of encryption used on the volume. +const ( + VolumeEncryptionProviderManagedConst = "provider_managed" + VolumeEncryptionUserManagedConst = "user_managed" +) + +// Constants associated with the Volume.HealthState property. +// The health of this resource. +// - `ok`: No abnormal behavior detected +// - `degraded`: Experiencing compromised performance, capacity, or connectivity +// - `faulted`: Completely unreachable, inoperative, or otherwise entirely incapacitated +// - `inapplicable`: The health state does not apply because of the current lifecycle state. A resource with a lifecycle +// state of `failed` or `deleting` will have a health state of `inapplicable`. A `pending` resource may also have this +// state. +const ( + VolumeHealthStateDegradedConst = "degraded" + VolumeHealthStateFaultedConst = "faulted" + VolumeHealthStateInapplicableConst = "inapplicable" + VolumeHealthStateOkConst = "ok" +) + +// Constants associated with the Volume.ResourceType property. +// The resource type. +const ( + VolumeResourceTypeVolumeConst = "volume" +) + +// Constants associated with the Volume.Status property. +// The status of the volume. +// +// The enumerated values for this property will expand in the future. When processing this property, check for and log +// unknown values. Optionally halt processing and surface the error, or bypass the volume on which the unexpected +// property value was encountered. +const ( + VolumeStatusAvailableConst = "available" + VolumeStatusFailedConst = "failed" + VolumeStatusPendingConst = "pending" + VolumeStatusPendingDeletionConst = "pending_deletion" + VolumeStatusUnusableConst = "unusable" + VolumeStatusUpdatingConst = "updating" +) + +// UnmarshalVolume unmarshals an instance of Volume from the specified map of raw messages. +func UnmarshalVolume(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(Volume) + err = core.UnmarshalPrimitive(m, "active", &obj.Active) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "attachment_state", &obj.AttachmentState) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "bandwidth", &obj.Bandwidth) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "busy", &obj.Busy) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "capacity", &obj.Capacity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "encryption", &obj.Encryption) + if err != nil { + return + } + err = core.UnmarshalModel(m, "encryption_key", &obj.EncryptionKey, UnmarshalEncryptionKeyReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "health_reasons", &obj.HealthReasons, UnmarshalVolumeHealthReason) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "health_state", &obj.HealthState) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "iops", &obj.Iops) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "operating_system", &obj.OperatingSystem, UnmarshalOperatingSystem) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalVolumeProfileReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalModel(m, "source_image", &obj.SourceImage, UnmarshalImageReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "source_snapshot", &obj.SourceSnapshot, UnmarshalSnapshotReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + err = core.UnmarshalModel(m, "status_reasons", &obj.StatusReasons, UnmarshalVolumeStatusReason) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_tags", &obj.UserTags) + if err != nil { + return + } + err = core.UnmarshalModel(m, "volume_attachments", &obj.VolumeAttachments, UnmarshalVolumeAttachmentReferenceVolumeContext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeAttachment : VolumeAttachment struct +type VolumeAttachment struct { + // The maximum bandwidth (in megabits per second) for the volume when attached to this instance. This may be lower than + // the volume bandwidth depending on the configuration of the instance. + Bandwidth *int64 `json:"bandwidth" validate:"required"` + + // The date and time that the volume was attached. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // Indicates whether deleting the instance will also delete the attached volume. + DeleteVolumeOnInstanceDelete *bool `json:"delete_volume_on_instance_delete" validate:"required"` + + // Information about how the volume is exposed to the instance operating system. + // + // This property may be absent if the volume attachment's `status` is not `attached`. + Device *VolumeAttachmentDevice `json:"device,omitempty"` + + // The URL for this volume attachment. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this volume attachment. + ID *string `json:"id" validate:"required"` + + // The name for this volume attachment. The name is unique across all volume attachments on the instance. + Name *string `json:"name" validate:"required"` + + // The status of this volume attachment. + Status *string `json:"status" validate:"required"` + + // The type of volume attachment. + Type *string `json:"type" validate:"required"` + + // The attached volume. + // + // This property will be absent if the volume has not yet been provisioned. + Volume *VolumeReferenceVolumeAttachmentContext `json:"volume,omitempty"` +} + +// Constants associated with the VolumeAttachment.Status property. +// The status of this volume attachment. +const ( + VolumeAttachmentStatusAttachedConst = "attached" + VolumeAttachmentStatusAttachingConst = "attaching" + VolumeAttachmentStatusDeletingConst = "deleting" + VolumeAttachmentStatusDetachingConst = "detaching" +) + +// Constants associated with the VolumeAttachment.Type property. +// The type of volume attachment. +const ( + VolumeAttachmentTypeBootConst = "boot" + VolumeAttachmentTypeDataConst = "data" +) + +// UnmarshalVolumeAttachment unmarshals an instance of VolumeAttachment from the specified map of raw messages. +func UnmarshalVolumeAttachment(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeAttachment) + err = core.UnmarshalPrimitive(m, "bandwidth", &obj.Bandwidth) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "delete_volume_on_instance_delete", &obj.DeleteVolumeOnInstanceDelete) + if err != nil { + return + } + err = core.UnmarshalModel(m, "device", &obj.Device, UnmarshalVolumeAttachmentDevice) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalModel(m, "volume", &obj.Volume, UnmarshalVolumeReferenceVolumeAttachmentContext) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeAttachmentCollection : VolumeAttachmentCollection struct +type VolumeAttachmentCollection struct { + // Collection of volume attachments. + VolumeAttachments []VolumeAttachment `json:"volume_attachments" validate:"required"` +} + +// UnmarshalVolumeAttachmentCollection unmarshals an instance of VolumeAttachmentCollection from the specified map of raw messages. +func UnmarshalVolumeAttachmentCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeAttachmentCollection) + err = core.UnmarshalModel(m, "volume_attachments", &obj.VolumeAttachments, UnmarshalVolumeAttachment) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeAttachmentDevice : VolumeAttachmentDevice struct +type VolumeAttachmentDevice struct { + // A unique identifier for the device which is exposed to the instance operating system. + ID *string `json:"id,omitempty"` +} + +// UnmarshalVolumeAttachmentDevice unmarshals an instance of VolumeAttachmentDevice from the specified map of raw messages. +func UnmarshalVolumeAttachmentDevice(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeAttachmentDevice) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeAttachmentPatch : VolumeAttachmentPatch struct +type VolumeAttachmentPatch struct { + // Indicates whether deleting the instance will also delete the attached volume. + DeleteVolumeOnInstanceDelete *bool `json:"delete_volume_on_instance_delete,omitempty"` + + // The name for this volume attachment. The name must not be used by another volume attachment on the instance. + Name *string `json:"name,omitempty"` +} + +// UnmarshalVolumeAttachmentPatch unmarshals an instance of VolumeAttachmentPatch from the specified map of raw messages. +func UnmarshalVolumeAttachmentPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeAttachmentPatch) + err = core.UnmarshalPrimitive(m, "delete_volume_on_instance_delete", &obj.DeleteVolumeOnInstanceDelete) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the VolumeAttachmentPatch +func (volumeAttachmentPatch *VolumeAttachmentPatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(volumeAttachmentPatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// VolumeAttachmentPrototype : VolumeAttachmentPrototype struct +type VolumeAttachmentPrototype struct { + // Indicates whether deleting the instance will also delete the attached volume. + DeleteVolumeOnInstanceDelete *bool `json:"delete_volume_on_instance_delete,omitempty"` + + // The name for this volume attachment. The name must not be used by another volume attachment on the instance. If + // unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // An existing volume to attach to the instance, or a prototype object for a new volume. + Volume VolumeAttachmentPrototypeVolumeIntf `json:"volume" validate:"required"` +} + +// NewVolumeAttachmentPrototype : Instantiate VolumeAttachmentPrototype (Generic Model Constructor) +func (*VpcV1) NewVolumeAttachmentPrototype(volume VolumeAttachmentPrototypeVolumeIntf) (_model *VolumeAttachmentPrototype, err error) { + _model = &VolumeAttachmentPrototype{ + Volume: volume, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalVolumeAttachmentPrototype unmarshals an instance of VolumeAttachmentPrototype from the specified map of raw messages. +func UnmarshalVolumeAttachmentPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeAttachmentPrototype) + err = core.UnmarshalPrimitive(m, "delete_volume_on_instance_delete", &obj.DeleteVolumeOnInstanceDelete) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "volume", &obj.Volume, UnmarshalVolumeAttachmentPrototypeVolume) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeAttachmentPrototypeInstanceByImageContext : VolumeAttachmentPrototypeInstanceByImageContext struct +type VolumeAttachmentPrototypeInstanceByImageContext struct { + // Indicates whether deleting the instance will also delete the attached volume. + DeleteVolumeOnInstanceDelete *bool `json:"delete_volume_on_instance_delete,omitempty"` + + // The name for this volume attachment. The name must not be used by another volume attachment on the instance. If + // unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // A prototype object for a new volume. + Volume *VolumePrototypeInstanceByImageContext `json:"volume" validate:"required"` +} + +// NewVolumeAttachmentPrototypeInstanceByImageContext : Instantiate VolumeAttachmentPrototypeInstanceByImageContext (Generic Model Constructor) +func (*VpcV1) NewVolumeAttachmentPrototypeInstanceByImageContext(volume *VolumePrototypeInstanceByImageContext) (_model *VolumeAttachmentPrototypeInstanceByImageContext, err error) { + _model = &VolumeAttachmentPrototypeInstanceByImageContext{ + Volume: volume, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalVolumeAttachmentPrototypeInstanceByImageContext unmarshals an instance of VolumeAttachmentPrototypeInstanceByImageContext from the specified map of raw messages. +func UnmarshalVolumeAttachmentPrototypeInstanceByImageContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeAttachmentPrototypeInstanceByImageContext) + err = core.UnmarshalPrimitive(m, "delete_volume_on_instance_delete", &obj.DeleteVolumeOnInstanceDelete) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "volume", &obj.Volume, UnmarshalVolumePrototypeInstanceByImageContext) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeAttachmentPrototypeInstanceBySourceSnapshotContext : VolumeAttachmentPrototypeInstanceBySourceSnapshotContext struct +type VolumeAttachmentPrototypeInstanceBySourceSnapshotContext struct { + // Indicates whether deleting the instance will also delete the attached volume. + DeleteVolumeOnInstanceDelete *bool `json:"delete_volume_on_instance_delete,omitempty"` + + // The name for this volume attachment. The name must not be used by another volume attachment on the instance. If + // unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // A prototype object for a new volume from a snapshot. + Volume *VolumePrototypeInstanceBySourceSnapshotContext `json:"volume" validate:"required"` +} + +// NewVolumeAttachmentPrototypeInstanceBySourceSnapshotContext : Instantiate VolumeAttachmentPrototypeInstanceBySourceSnapshotContext (Generic Model Constructor) +func (*VpcV1) NewVolumeAttachmentPrototypeInstanceBySourceSnapshotContext(volume *VolumePrototypeInstanceBySourceSnapshotContext) (_model *VolumeAttachmentPrototypeInstanceBySourceSnapshotContext, err error) { + _model = &VolumeAttachmentPrototypeInstanceBySourceSnapshotContext{ + Volume: volume, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalVolumeAttachmentPrototypeInstanceBySourceSnapshotContext unmarshals an instance of VolumeAttachmentPrototypeInstanceBySourceSnapshotContext from the specified map of raw messages. +func UnmarshalVolumeAttachmentPrototypeInstanceBySourceSnapshotContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeAttachmentPrototypeInstanceBySourceSnapshotContext) + err = core.UnmarshalPrimitive(m, "delete_volume_on_instance_delete", &obj.DeleteVolumeOnInstanceDelete) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "volume", &obj.Volume, UnmarshalVolumePrototypeInstanceBySourceSnapshotContext) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeAttachmentPrototypeInstanceByVolumeContext : VolumeAttachmentPrototypeInstanceByVolumeContext struct +type VolumeAttachmentPrototypeInstanceByVolumeContext struct { + // Indicates whether deleting the instance will also delete the attached volume. + DeleteVolumeOnInstanceDelete *bool `json:"delete_volume_on_instance_delete,omitempty"` + + // The name for this volume attachment. The name must not be used by another volume attachment on the instance. If + // unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // An existing volume to attach. + Volume VolumeIdentityIntf `json:"volume" validate:"required"` +} + +// NewVolumeAttachmentPrototypeInstanceByVolumeContext : Instantiate VolumeAttachmentPrototypeInstanceByVolumeContext (Generic Model Constructor) +func (*VpcV1) NewVolumeAttachmentPrototypeInstanceByVolumeContext(volume VolumeIdentityIntf) (_model *VolumeAttachmentPrototypeInstanceByVolumeContext, err error) { + _model = &VolumeAttachmentPrototypeInstanceByVolumeContext{ + Volume: volume, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalVolumeAttachmentPrototypeInstanceByVolumeContext unmarshals an instance of VolumeAttachmentPrototypeInstanceByVolumeContext from the specified map of raw messages. +func UnmarshalVolumeAttachmentPrototypeInstanceByVolumeContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeAttachmentPrototypeInstanceByVolumeContext) + err = core.UnmarshalPrimitive(m, "delete_volume_on_instance_delete", &obj.DeleteVolumeOnInstanceDelete) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "volume", &obj.Volume, UnmarshalVolumeIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeAttachmentPrototypeVolume : An existing volume to attach to the instance, or a prototype object for a new volume. +// Models which "extend" this model: +// - VolumeAttachmentPrototypeVolumeVolumeIdentity +// - VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContext +type VolumeAttachmentPrototypeVolume struct { + // The unique identifier for this volume. + ID *string `json:"id,omitempty"` + + // The CRN for this volume. + CRN *string `json:"crn,omitempty"` + + // The URL for this volume. + Href *string `json:"href,omitempty"` + + // The maximum I/O operations per second (IOPS) to use for this volume. Applicable only to volumes using a profile + // `family` of `custom`. + Iops *int64 `json:"iops,omitempty"` + + // The name for this volume. The name must not be used by another volume in the region. If unspecified, the name will + // be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-block-storage-profiles) to + // use for this volume. + Profile VolumeProfileIdentityIntf `json:"profile,omitempty"` + + // The resource group to use for this volume. If unspecified, the instance's resource + // group will be used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The [user tags](https://cloud.ibm.com/apidocs/tagging#types-of-tags) associated with this volume. + UserTags []string `json:"user_tags,omitempty"` + + // The capacity to use for the volume (in gigabytes). The specified minimum and maximum capacity values for creating or + // updating volumes may expand in the future. + Capacity *int64 `json:"capacity,omitempty"` + + // The root key to use to wrap the data encryption key for the volume. + // + // If unspecified, the `encryption` type for the volume will be `provider_managed`. + EncryptionKey EncryptionKeyIdentityIntf `json:"encryption_key,omitempty"` + + // The snapshot from which to clone the volume. + SourceSnapshot SnapshotIdentityIntf `json:"source_snapshot,omitempty"` +} + +func (*VolumeAttachmentPrototypeVolume) isaVolumeAttachmentPrototypeVolume() bool { + return true +} + +type VolumeAttachmentPrototypeVolumeIntf interface { + isaVolumeAttachmentPrototypeVolume() bool +} + +// UnmarshalVolumeAttachmentPrototypeVolume unmarshals an instance of VolumeAttachmentPrototypeVolume from the specified map of raw messages. +func UnmarshalVolumeAttachmentPrototypeVolume(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeAttachmentPrototypeVolume) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "iops", &obj.Iops) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalVolumeProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_tags", &obj.UserTags) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "capacity", &obj.Capacity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "encryption_key", &obj.EncryptionKey, UnmarshalEncryptionKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "source_snapshot", &obj.SourceSnapshot, UnmarshalSnapshotIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeAttachmentReferenceInstanceContext : VolumeAttachmentReferenceInstanceContext struct +type VolumeAttachmentReferenceInstanceContext struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *VolumeAttachmentReferenceInstanceContextDeleted `json:"deleted,omitempty"` + + // Information about how the volume is exposed to the instance operating system. + // + // This property may be absent if the volume attachment's `status` is not `attached`. + Device *VolumeAttachmentDevice `json:"device,omitempty"` + + // The URL for this volume attachment. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this volume attachment. + ID *string `json:"id" validate:"required"` + + // The name for this volume attachment. The name is unique across all volume attachments on the instance. + Name *string `json:"name" validate:"required"` + + // The attached volume. + // + // This property will be absent if the volume has not yet been provisioned. + Volume *VolumeReferenceVolumeAttachmentContext `json:"volume,omitempty"` +} + +// UnmarshalVolumeAttachmentReferenceInstanceContext unmarshals an instance of VolumeAttachmentReferenceInstanceContext from the specified map of raw messages. +func UnmarshalVolumeAttachmentReferenceInstanceContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeAttachmentReferenceInstanceContext) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalVolumeAttachmentReferenceInstanceContextDeleted) + if err != nil { + return + } + err = core.UnmarshalModel(m, "device", &obj.Device, UnmarshalVolumeAttachmentDevice) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "volume", &obj.Volume, UnmarshalVolumeReferenceVolumeAttachmentContext) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeAttachmentReferenceInstanceContextDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type VolumeAttachmentReferenceInstanceContextDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalVolumeAttachmentReferenceInstanceContextDeleted unmarshals an instance of VolumeAttachmentReferenceInstanceContextDeleted from the specified map of raw messages. +func UnmarshalVolumeAttachmentReferenceInstanceContextDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeAttachmentReferenceInstanceContextDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeAttachmentReferenceVolumeContext : VolumeAttachmentReferenceVolumeContext struct +type VolumeAttachmentReferenceVolumeContext struct { + // Indicates whether deleting the instance will also delete the attached volume. + DeleteVolumeOnInstanceDelete *bool `json:"delete_volume_on_instance_delete" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *VolumeAttachmentReferenceVolumeContextDeleted `json:"deleted,omitempty"` + + // Information about how the volume is exposed to the instance operating system. + // + // This property may be absent if the volume attachment's `status` is not `attached`. + Device *VolumeAttachmentDevice `json:"device,omitempty"` + + // The URL for this volume attachment. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this volume attachment. + ID *string `json:"id" validate:"required"` + + // The attached instance. + Instance *InstanceReference `json:"instance" validate:"required"` + + // The name for this volume attachment. The name is unique across all volume attachments on the instance. + Name *string `json:"name" validate:"required"` + + // The type of volume attachment. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the VolumeAttachmentReferenceVolumeContext.Type property. +// The type of volume attachment. +const ( + VolumeAttachmentReferenceVolumeContextTypeBootConst = "boot" + VolumeAttachmentReferenceVolumeContextTypeDataConst = "data" +) + +// UnmarshalVolumeAttachmentReferenceVolumeContext unmarshals an instance of VolumeAttachmentReferenceVolumeContext from the specified map of raw messages. +func UnmarshalVolumeAttachmentReferenceVolumeContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeAttachmentReferenceVolumeContext) + err = core.UnmarshalPrimitive(m, "delete_volume_on_instance_delete", &obj.DeleteVolumeOnInstanceDelete) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalVolumeAttachmentReferenceVolumeContextDeleted) + if err != nil { + return + } + err = core.UnmarshalModel(m, "device", &obj.Device, UnmarshalVolumeAttachmentDevice) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalModel(m, "instance", &obj.Instance, UnmarshalInstanceReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeAttachmentReferenceVolumeContextDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type VolumeAttachmentReferenceVolumeContextDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalVolumeAttachmentReferenceVolumeContextDeleted unmarshals an instance of VolumeAttachmentReferenceVolumeContextDeleted from the specified map of raw messages. +func UnmarshalVolumeAttachmentReferenceVolumeContextDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeAttachmentReferenceVolumeContextDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeCollection : VolumeCollection struct +type VolumeCollection struct { + // A link to the first page of resources. + First *VolumeCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *VolumeCollectionNext `json:"next,omitempty"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` + + // Collection of volumes. + Volumes []Volume `json:"volumes" validate:"required"` +} + +// UnmarshalVolumeCollection unmarshals an instance of VolumeCollection from the specified map of raw messages. +func UnmarshalVolumeCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalVolumeCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalVolumeCollectionNext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + err = core.UnmarshalModel(m, "volumes", &obj.Volumes, UnmarshalVolume) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *VolumeCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// VolumeCollectionFirst : A link to the first page of resources. +type VolumeCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalVolumeCollectionFirst unmarshals an instance of VolumeCollectionFirst from the specified map of raw messages. +func UnmarshalVolumeCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type VolumeCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalVolumeCollectionNext unmarshals an instance of VolumeCollectionNext from the specified map of raw messages. +func UnmarshalVolumeCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeHealthReason : VolumeHealthReason struct +type VolumeHealthReason struct { + // A snake case string succinctly identifying the reason for this health state. + Code *string `json:"code" validate:"required"` + + // An explanation of the reason for this health state. + Message *string `json:"message" validate:"required"` + + // Link to documentation about the reason for this health state. + MoreInfo *string `json:"more_info,omitempty"` +} + +// Constants associated with the VolumeHealthReason.Code property. +// A snake case string succinctly identifying the reason for this health state. +const ( + VolumeHealthReasonCodeInitializingFromSnapshotConst = "initializing_from_snapshot" +) + +// UnmarshalVolumeHealthReason unmarshals an instance of VolumeHealthReason from the specified map of raw messages. +func UnmarshalVolumeHealthReason(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeHealthReason) + err = core.UnmarshalPrimitive(m, "code", &obj.Code) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "message", &obj.Message) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeIdentity : Identifies a volume by a unique property. +// Models which "extend" this model: +// - VolumeIdentityByID +// - VolumeIdentityByCRN +// - VolumeIdentityByHref +type VolumeIdentity struct { + // The unique identifier for this volume. + ID *string `json:"id,omitempty"` + + // The CRN for this volume. + CRN *string `json:"crn,omitempty"` + + // The URL for this volume. + Href *string `json:"href,omitempty"` +} + +func (*VolumeIdentity) isaVolumeIdentity() bool { + return true +} + +type VolumeIdentityIntf interface { + isaVolumeIdentity() bool +} + +// UnmarshalVolumeIdentity unmarshals an instance of VolumeIdentity from the specified map of raw messages. +func UnmarshalVolumeIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumePatch : VolumePatch struct +type VolumePatch struct { + // The capacity to use for the volume (in gigabytes). The volume must be attached to a running virtual server instance, + // and the specified value must not be less than the current capacity. Additionally, if the volume is attached as a + // boot volume, the maximum value is 250 gigabytes. + // + // The minimum and maximum capacity limits for creating or updating volumes may expand in the future. + Capacity *int64 `json:"capacity,omitempty"` + + // The maximum I/O operations per second (IOPS) to use for this volume. Applicable only to volumes using a profile + // `family` of `custom`. The volume must be attached as a data volume to a running virtual server instance. + Iops *int64 `json:"iops,omitempty"` + + // The name for this volume. The name must not be used by another volume in the region. + Name *string `json:"name,omitempty"` + + // The profile to use for this volume. The requested profile must be in the same + // `family` as the current profile. The volume must be attached as a data volume to + // a running virtual server instance, and must have a `capacity` within the range + // supported by the specified profile. + Profile VolumeProfileIdentityIntf `json:"profile,omitempty"` + + // The [user tags](https://cloud.ibm.com/apidocs/tagging#types-of-tags) associated with this volume. + UserTags []string `json:"user_tags,omitempty"` +} + +// UnmarshalVolumePatch unmarshals an instance of VolumePatch from the specified map of raw messages. +func UnmarshalVolumePatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumePatch) + err = core.UnmarshalPrimitive(m, "capacity", &obj.Capacity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "iops", &obj.Iops) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalVolumeProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_tags", &obj.UserTags) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the VolumePatch +func (volumePatch *VolumePatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(volumePatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// VolumeProfile : VolumeProfile struct +type VolumeProfile struct { + // The product family this volume profile belongs to. + // + // The enumerated values for this property will expand in the future. When processing this property, check for and log + // unknown values. Optionally halt processing and surface the error, or bypass the volume profile on which the + // unexpected property value was encountered. + Family *string `json:"family" validate:"required"` + + // The URL for this volume profile. + Href *string `json:"href" validate:"required"` + + // The globally unique name for this volume profile. + Name *string `json:"name" validate:"required"` +} + +// Constants associated with the VolumeProfile.Family property. +// The product family this volume profile belongs to. +// +// The enumerated values for this property will expand in the future. When processing this property, check for and log +// unknown values. Optionally halt processing and surface the error, or bypass the volume profile on which the +// unexpected property value was encountered. +const ( + VolumeProfileFamilyCustomConst = "custom" + VolumeProfileFamilyTieredConst = "tiered" +) + +// UnmarshalVolumeProfile unmarshals an instance of VolumeProfile from the specified map of raw messages. +func UnmarshalVolumeProfile(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeProfile) + err = core.UnmarshalPrimitive(m, "family", &obj.Family) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeProfileCollection : VolumeProfileCollection struct +type VolumeProfileCollection struct { + // A link to the first page of resources. + First *VolumeProfileCollectionFirst `json:"first" validate:"required"` + + // The maximum number of resources that can be returned by the request. + Limit *int64 `json:"limit" validate:"required"` + + // A link to the next page of resources. This property is present for all pages + // except the last page. + Next *VolumeProfileCollectionNext `json:"next,omitempty"` + + // Collection of volume profiles. + Profiles []VolumeProfile `json:"profiles" validate:"required"` + + // The total number of resources across all pages. + TotalCount *int64 `json:"total_count" validate:"required"` +} + +// UnmarshalVolumeProfileCollection unmarshals an instance of VolumeProfileCollection from the specified map of raw messages. +func UnmarshalVolumeProfileCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeProfileCollection) + err = core.UnmarshalModel(m, "first", &obj.First, UnmarshalVolumeProfileCollectionFirst) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "limit", &obj.Limit) + if err != nil { + return + } + err = core.UnmarshalModel(m, "next", &obj.Next, UnmarshalVolumeProfileCollectionNext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profiles", &obj.Profiles, UnmarshalVolumeProfile) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_count", &obj.TotalCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Retrieve the value to be passed to a request to access the next page of results +func (resp *VolumeProfileCollection) GetNextStart() (*string, error) { + if core.IsNil(resp.Next) { + return nil, nil + } + start, err := core.GetQueryParam(resp.Next.Href, "start") + if err != nil || start == nil { + return nil, err + } + return start, nil +} + +// VolumeProfileCollectionFirst : A link to the first page of resources. +type VolumeProfileCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalVolumeProfileCollectionFirst unmarshals an instance of VolumeProfileCollectionFirst from the specified map of raw messages. +func UnmarshalVolumeProfileCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeProfileCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeProfileCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type VolumeProfileCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalVolumeProfileCollectionNext unmarshals an instance of VolumeProfileCollectionNext from the specified map of raw messages. +func UnmarshalVolumeProfileCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeProfileCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeProfileIdentity : Identifies a volume profile by a unique property. +// Models which "extend" this model: +// - VolumeProfileIdentityByName +// - VolumeProfileIdentityByHref +type VolumeProfileIdentity struct { + // The globally unique name for this volume profile. + Name *string `json:"name,omitempty"` + + // The URL for this volume profile. + Href *string `json:"href,omitempty"` +} + +func (*VolumeProfileIdentity) isaVolumeProfileIdentity() bool { + return true +} + +type VolumeProfileIdentityIntf interface { + isaVolumeProfileIdentity() bool +} + +// UnmarshalVolumeProfileIdentity unmarshals an instance of VolumeProfileIdentity from the specified map of raw messages. +func UnmarshalVolumeProfileIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeProfileIdentity) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeProfileReference : VolumeProfileReference struct +type VolumeProfileReference struct { + // The URL for this volume profile. + Href *string `json:"href" validate:"required"` + + // The globally unique name for this volume profile. + Name *string `json:"name" validate:"required"` +} + +// UnmarshalVolumeProfileReference unmarshals an instance of VolumeProfileReference from the specified map of raw messages. +func UnmarshalVolumeProfileReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeProfileReference) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumePrototype : VolumePrototype struct +// Models which "extend" this model: +// - VolumePrototypeVolumeByCapacity +// - VolumePrototypeVolumeBySourceSnapshot +type VolumePrototype struct { + // The maximum I/O operations per second (IOPS) to use for this volume. Applicable only to volumes using a profile + // `family` of `custom`. + Iops *int64 `json:"iops,omitempty"` + + // The name for this volume. The name must not be used by another volume in the region. If unspecified, the name will + // be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-block-storage-profiles) to + // use for this volume. + Profile VolumeProfileIdentityIntf `json:"profile" validate:"required"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The [user tags](https://cloud.ibm.com/apidocs/tagging#types-of-tags) associated with this volume. + UserTags []string `json:"user_tags,omitempty"` + + // The zone this volume will reside in. + Zone ZoneIdentityIntf `json:"zone" validate:"required"` + + // The capacity to use for the volume (in gigabytes). The specified minimum and maximum capacity values for creating or + // updating volumes may expand in the future. + Capacity *int64 `json:"capacity,omitempty"` + + // The root key to use to wrap the data encryption key for the volume. + // + // If unspecified, the `encryption` type for the volume will be `provider_managed`. + EncryptionKey EncryptionKeyIdentityIntf `json:"encryption_key,omitempty"` + + // The snapshot from which to clone the volume. + SourceSnapshot SnapshotIdentityIntf `json:"source_snapshot,omitempty"` +} + +func (*VolumePrototype) isaVolumePrototype() bool { + return true +} + +type VolumePrototypeIntf interface { + isaVolumePrototype() bool +} + +// UnmarshalVolumePrototype unmarshals an instance of VolumePrototype from the specified map of raw messages. +func UnmarshalVolumePrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumePrototype) + err = core.UnmarshalPrimitive(m, "iops", &obj.Iops) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalVolumeProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_tags", &obj.UserTags) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "capacity", &obj.Capacity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "encryption_key", &obj.EncryptionKey, UnmarshalEncryptionKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "source_snapshot", &obj.SourceSnapshot, UnmarshalSnapshotIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumePrototypeInstanceByImageContext : VolumePrototypeInstanceByImageContext struct +type VolumePrototypeInstanceByImageContext struct { + // The capacity to use for the volume (in gigabytes). Must be at least the image's + // `minimum_provisioned_size`. The maximum value may increase in the future. + // + // If unspecified, the capacity will be the image's `minimum_provisioned_size`. + Capacity *int64 `json:"capacity,omitempty"` + + // The root key to use to wrap the data encryption key for the volume. + // + // If unspecified, the `encryption` type for the volume will be `provider_managed`. + EncryptionKey EncryptionKeyIdentityIntf `json:"encryption_key,omitempty"` + + // The maximum I/O operations per second (IOPS) to use for this volume. Applicable only to volumes using a profile + // `family` of `custom`. + Iops *int64 `json:"iops,omitempty"` + + // The name for this volume. The name must not be used by another volume in the region. If unspecified, the name will + // be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-block-storage-profiles) to + // use for this volume. + Profile VolumeProfileIdentityIntf `json:"profile" validate:"required"` + + // The resource group to use for this volume. If unspecified, the instance's resource + // group will be used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The [user tags](https://cloud.ibm.com/apidocs/tagging#types-of-tags) associated with this volume. + UserTags []string `json:"user_tags,omitempty"` +} + +// NewVolumePrototypeInstanceByImageContext : Instantiate VolumePrototypeInstanceByImageContext (Generic Model Constructor) +func (*VpcV1) NewVolumePrototypeInstanceByImageContext(profile VolumeProfileIdentityIntf) (_model *VolumePrototypeInstanceByImageContext, err error) { + _model = &VolumePrototypeInstanceByImageContext{ + Profile: profile, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalVolumePrototypeInstanceByImageContext unmarshals an instance of VolumePrototypeInstanceByImageContext from the specified map of raw messages. +func UnmarshalVolumePrototypeInstanceByImageContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumePrototypeInstanceByImageContext) + err = core.UnmarshalPrimitive(m, "capacity", &obj.Capacity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "encryption_key", &obj.EncryptionKey, UnmarshalEncryptionKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "iops", &obj.Iops) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalVolumeProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_tags", &obj.UserTags) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumePrototypeInstanceBySourceSnapshotContext : VolumePrototypeInstanceBySourceSnapshotContext struct +type VolumePrototypeInstanceBySourceSnapshotContext struct { + // The capacity to use for the volume (in gigabytes). Must be at least the snapshot's + // `minimum_capacity`. The maximum value may increase in the future. + // + // If unspecified, the capacity will be the source snapshot's `minimum_capacity`. + Capacity *int64 `json:"capacity,omitempty"` + + // The root key to use to wrap the data encryption key for the volume. + // + // If unspecified, the `encryption` type for the volume will be `provider_managed`. + EncryptionKey EncryptionKeyIdentityIntf `json:"encryption_key,omitempty"` + + // The maximum I/O operations per second (IOPS) to use for this volume. Applicable only to volumes using a profile + // `family` of `custom`. + Iops *int64 `json:"iops,omitempty"` + + // The name for this volume. The name must not be used by another volume in the region. If unspecified, the name will + // be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-block-storage-profiles) to + // use for this volume. + Profile VolumeProfileIdentityIntf `json:"profile" validate:"required"` + + // The resource group to use for this volume. If unspecified, the instance's resource + // group will be used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The snapshot from which to clone the volume. + SourceSnapshot SnapshotIdentityIntf `json:"source_snapshot" validate:"required"` + + // The [user tags](https://cloud.ibm.com/apidocs/tagging#types-of-tags) associated with this volume. + UserTags []string `json:"user_tags,omitempty"` +} + +// NewVolumePrototypeInstanceBySourceSnapshotContext : Instantiate VolumePrototypeInstanceBySourceSnapshotContext (Generic Model Constructor) +func (*VpcV1) NewVolumePrototypeInstanceBySourceSnapshotContext(profile VolumeProfileIdentityIntf, sourceSnapshot SnapshotIdentityIntf) (_model *VolumePrototypeInstanceBySourceSnapshotContext, err error) { + _model = &VolumePrototypeInstanceBySourceSnapshotContext{ + Profile: profile, + SourceSnapshot: sourceSnapshot, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +// UnmarshalVolumePrototypeInstanceBySourceSnapshotContext unmarshals an instance of VolumePrototypeInstanceBySourceSnapshotContext from the specified map of raw messages. +func UnmarshalVolumePrototypeInstanceBySourceSnapshotContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumePrototypeInstanceBySourceSnapshotContext) + err = core.UnmarshalPrimitive(m, "capacity", &obj.Capacity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "encryption_key", &obj.EncryptionKey, UnmarshalEncryptionKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "iops", &obj.Iops) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalVolumeProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "source_snapshot", &obj.SourceSnapshot, UnmarshalSnapshotIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_tags", &obj.UserTags) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeReference : VolumeReference struct +type VolumeReference struct { + // The CRN for this volume. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *VolumeReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this volume. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this volume. + ID *string `json:"id" validate:"required"` + + // The name for this volume. The name is unique across all volumes in the region. + Name *string `json:"name" validate:"required"` + + // If present, this property indicates that the resource associated with this reference + // is remote and therefore may not be directly retrievable. + Remote *VolumeRemote `json:"remote,omitempty"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the VolumeReference.ResourceType property. +// The resource type. +const ( + VolumeReferenceResourceTypeVolumeConst = "volume" +) + +// UnmarshalVolumeReference unmarshals an instance of VolumeReference from the specified map of raw messages. +func UnmarshalVolumeReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalVolumeReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "remote", &obj.Remote, UnmarshalVolumeRemote) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeReferenceDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type VolumeReferenceDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalVolumeReferenceDeleted unmarshals an instance of VolumeReferenceDeleted from the specified map of raw messages. +func UnmarshalVolumeReferenceDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeReferenceDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeReferenceVolumeAttachmentContext : VolumeReferenceVolumeAttachmentContext struct +type VolumeReferenceVolumeAttachmentContext struct { + // The CRN for this volume. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *VolumeReferenceVolumeAttachmentContextDeleted `json:"deleted,omitempty"` + + // The URL for this volume. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this volume. + ID *string `json:"id" validate:"required"` + + // The name for this volume. The name is unique across all volumes in the region. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the VolumeReferenceVolumeAttachmentContext.ResourceType property. +// The resource type. +const ( + VolumeReferenceVolumeAttachmentContextResourceTypeVolumeConst = "volume" +) + +// UnmarshalVolumeReferenceVolumeAttachmentContext unmarshals an instance of VolumeReferenceVolumeAttachmentContext from the specified map of raw messages. +func UnmarshalVolumeReferenceVolumeAttachmentContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeReferenceVolumeAttachmentContext) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalVolumeReferenceVolumeAttachmentContextDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeReferenceVolumeAttachmentContextDeleted : If present, this property indicates the referenced resource has been deleted, and provides some supplementary +// information. +type VolumeReferenceVolumeAttachmentContextDeleted struct { + // Link to documentation about deleted resources. + MoreInfo *string `json:"more_info" validate:"required"` +} + +// UnmarshalVolumeReferenceVolumeAttachmentContextDeleted unmarshals an instance of VolumeReferenceVolumeAttachmentContextDeleted from the specified map of raw messages. +func UnmarshalVolumeReferenceVolumeAttachmentContextDeleted(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeReferenceVolumeAttachmentContextDeleted) + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeRemote : If present, this property indicates that the resource associated with this reference is remote and therefore may not +// be directly retrievable. +type VolumeRemote struct { + // If present, this property indicates that the referenced resource is remote to this + // region, and identifies the native region. + Region *RegionReference `json:"region,omitempty"` +} + +// UnmarshalVolumeRemote unmarshals an instance of VolumeRemote from the specified map of raw messages. +func UnmarshalVolumeRemote(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeRemote) + err = core.UnmarshalModel(m, "region", &obj.Region, UnmarshalRegionReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeStatusReason : VolumeStatusReason struct +type VolumeStatusReason struct { + // A snake case string succinctly identifying the status reason. + Code *string `json:"code" validate:"required"` + + // An explanation of the status reason. + Message *string `json:"message" validate:"required"` + + // Link to documentation about this status reason. + MoreInfo *string `json:"more_info,omitempty"` +} + +// Constants associated with the VolumeStatusReason.Code property. +// A snake case string succinctly identifying the status reason. +const ( + VolumeStatusReasonCodeEncryptionKeyDeletedConst = "encryption_key_deleted" +) + +// UnmarshalVolumeStatusReason unmarshals an instance of VolumeStatusReason from the specified map of raw messages. +func UnmarshalVolumeStatusReason(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeStatusReason) + err = core.UnmarshalPrimitive(m, "code", &obj.Code) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "message", &obj.Message) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "more_info", &obj.MoreInfo) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VpcdnsResolutionBindingCollectionFirst : A link to the first page of resources. +type VpcdnsResolutionBindingCollectionFirst struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalVpcdnsResolutionBindingCollectionFirst unmarshals an instance of VpcdnsResolutionBindingCollectionFirst from the specified map of raw messages. +func UnmarshalVpcdnsResolutionBindingCollectionFirst(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VpcdnsResolutionBindingCollectionFirst) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VpcdnsResolutionBindingCollectionNext : A link to the next page of resources. This property is present for all pages except the last page. +type VpcdnsResolutionBindingCollectionNext struct { + // The URL for a page of resources. + Href *string `json:"href" validate:"required"` +} + +// UnmarshalVpcdnsResolutionBindingCollectionNext unmarshals an instance of VpcdnsResolutionBindingCollectionNext from the specified map of raw messages. +func UnmarshalVpcdnsResolutionBindingCollectionNext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VpcdnsResolutionBindingCollectionNext) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// Zone : Zone struct +type Zone struct { + // The URL for this zone. + Href *string `json:"href" validate:"required"` + + // The globally unique name for this zone. + Name *string `json:"name" validate:"required"` + + // The region this zone resides in. + Region *RegionReference `json:"region" validate:"required"` + + // The availability status of this zone. + Status *string `json:"status" validate:"required"` +} + +// Constants associated with the Zone.Status property. +// The availability status of this zone. +const ( + ZoneStatusAvailableConst = "available" + ZoneStatusImpairedConst = "impaired" + ZoneStatusUnavailableConst = "unavailable" +) + +// UnmarshalZone unmarshals an instance of Zone from the specified map of raw messages. +func UnmarshalZone(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(Zone) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "region", &obj.Region, UnmarshalRegionReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ZoneCollection : ZoneCollection struct +type ZoneCollection struct { + // Collection of zones. + Zones []Zone `json:"zones" validate:"required"` +} + +// UnmarshalZoneCollection unmarshals an instance of ZoneCollection from the specified map of raw messages. +func UnmarshalZoneCollection(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ZoneCollection) + err = core.UnmarshalModel(m, "zones", &obj.Zones, UnmarshalZone) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ZoneIdentity : Identifies a zone by a unique property. +// Models which "extend" this model: +// - ZoneIdentityByName +// - ZoneIdentityByHref +type ZoneIdentity struct { + // The globally unique name for this zone. + Name *string `json:"name,omitempty"` + + // The URL for this zone. + Href *string `json:"href,omitempty"` +} + +func (*ZoneIdentity) isaZoneIdentity() bool { + return true +} + +type ZoneIdentityIntf interface { + isaZoneIdentity() bool +} + +// UnmarshalZoneIdentity unmarshals an instance of ZoneIdentity from the specified map of raw messages. +func UnmarshalZoneIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ZoneIdentity) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ZoneReference : ZoneReference struct +type ZoneReference struct { + // The URL for this zone. + Href *string `json:"href" validate:"required"` + + // The globally unique name for this zone. + Name *string `json:"name" validate:"required"` +} + +// UnmarshalZoneReference unmarshals an instance of ZoneReference from the specified map of raw messages. +func UnmarshalZoneReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ZoneReference) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BackupPolicyJobSourceVolumeReference : BackupPolicyJobSourceVolumeReference struct +// This model "extends" BackupPolicyJobSource +type BackupPolicyJobSourceVolumeReference struct { + // The CRN for this volume. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *VolumeReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this volume. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this volume. + ID *string `json:"id" validate:"required"` + + // The name for this volume. The name is unique across all volumes in the region. + Name *string `json:"name" validate:"required"` + + // If present, this property indicates that the resource associated with this reference + // is remote and therefore may not be directly retrievable. + Remote *VolumeRemote `json:"remote,omitempty"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the BackupPolicyJobSourceVolumeReference.ResourceType property. +// The resource type. +const ( + BackupPolicyJobSourceVolumeReferenceResourceTypeVolumeConst = "volume" +) + +func (*BackupPolicyJobSourceVolumeReference) isaBackupPolicyJobSource() bool { + return true +} + +// UnmarshalBackupPolicyJobSourceVolumeReference unmarshals an instance of BackupPolicyJobSourceVolumeReference from the specified map of raw messages. +func UnmarshalBackupPolicyJobSourceVolumeReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BackupPolicyJobSourceVolumeReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalVolumeReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "remote", &obj.Remote, UnmarshalVolumeRemote) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerBootTargetBareMetalServerDiskReference : BareMetalServerBootTargetBareMetalServerDiskReference struct +// This model "extends" BareMetalServerBootTarget +type BareMetalServerBootTargetBareMetalServerDiskReference struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *BareMetalServerDiskReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this bare metal server disk. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this bare metal server disk. + ID *string `json:"id" validate:"required"` + + // The name for this bare metal server disk. The name is unique across all disks on the bare metal server. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the BareMetalServerBootTargetBareMetalServerDiskReference.ResourceType property. +// The resource type. +const ( + BareMetalServerBootTargetBareMetalServerDiskReferenceResourceTypeBareMetalServerDiskConst = "bare_metal_server_disk" +) + +func (*BareMetalServerBootTargetBareMetalServerDiskReference) isaBareMetalServerBootTarget() bool { + return true +} + +// UnmarshalBareMetalServerBootTargetBareMetalServerDiskReference unmarshals an instance of BareMetalServerBootTargetBareMetalServerDiskReference from the specified map of raw messages. +func UnmarshalBareMetalServerBootTargetBareMetalServerDiskReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerBootTargetBareMetalServerDiskReference) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalBareMetalServerDiskReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerInitializationUserAccountBareMetalServerInitializationHostUserAccount : BareMetalServerInitializationUserAccountBareMetalServerInitializationHostUserAccount struct +// This model "extends" BareMetalServerInitializationUserAccount +type BareMetalServerInitializationUserAccountBareMetalServerInitializationHostUserAccount struct { + // The password at initialization, encrypted using `encryption_key`, and returned base64-encoded. + EncryptedPassword *[]byte `json:"encrypted_password" validate:"required"` + + // The public SSH key used to encrypt the password. + EncryptionKey *KeyReference `json:"encryption_key" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The username for the account created at initialization. + Username *string `json:"username" validate:"required"` +} + +// Constants associated with the BareMetalServerInitializationUserAccountBareMetalServerInitializationHostUserAccount.ResourceType property. +// The resource type. +const ( + BareMetalServerInitializationUserAccountBareMetalServerInitializationHostUserAccountResourceTypeHostUserAccountConst = "host_user_account" +) + +func (*BareMetalServerInitializationUserAccountBareMetalServerInitializationHostUserAccount) isaBareMetalServerInitializationUserAccount() bool { + return true +} + +// UnmarshalBareMetalServerInitializationUserAccountBareMetalServerInitializationHostUserAccount unmarshals an instance of BareMetalServerInitializationUserAccountBareMetalServerInitializationHostUserAccount from the specified map of raw messages. +func UnmarshalBareMetalServerInitializationUserAccountBareMetalServerInitializationHostUserAccount(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerInitializationUserAccountBareMetalServerInitializationHostUserAccount) + err = core.UnmarshalPrimitive(m, "encrypted_password", &obj.EncryptedPassword) + if err != nil { + return + } + err = core.UnmarshalModel(m, "encryption_key", &obj.EncryptionKey, UnmarshalKeyReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "username", &obj.Username) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerNetworkInterfaceByHiperSocket : BareMetalServerNetworkInterfaceByHiperSocket struct +// This model "extends" BareMetalServerNetworkInterface +type BareMetalServerNetworkInterfaceByHiperSocket struct { + // Indicates whether source IP spoofing is allowed on this bare metal server network interface. + AllowIPSpoofing *bool `json:"allow_ip_spoofing" validate:"required"` + + // The date and time that the bare metal server network interface was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // If `true`: + // - The VPC infrastructure performs any needed NAT operations. + // - `floating_ips` must not have more than one floating IP. + // + // If `false`: + // - Packets are passed unchanged to/from the bare metal server network interface, + // allowing the workload to perform any needed NAT operations. + // - `allow_ip_spoofing` must be `false`. + // - `interface_type` must not be `hipersocket`. + EnableInfrastructureNat *bool `json:"enable_infrastructure_nat" validate:"required"` + + // The floating IPs associated with this bare metal server network interface. + FloatingIps []FloatingIPReference `json:"floating_ips" validate:"required"` + + // The URL for this bare metal server network interface. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this bare metal server network interface. + ID *string `json:"id" validate:"required"` + + // The MAC address of this bare metal server network interface. If the MAC address has not yet been selected, the value + // will be an empty string. + MacAddress *string `json:"mac_address" validate:"required"` + + // The name for this bare metal server network interface. + Name *string `json:"name" validate:"required"` + + // The bare metal server network interface port speed in Mbps. + PortSpeed *int64 `json:"port_speed" validate:"required"` + + PrimaryIP *ReservedIPReference `json:"primary_ip" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The security groups targeting this bare metal server network interface. + SecurityGroups []SecurityGroupReference `json:"security_groups" validate:"required"` + + // The status of the bare metal server network interface. + Status *string `json:"status" validate:"required"` + + // The associated subnet. + Subnet *SubnetReference `json:"subnet" validate:"required"` + + // The bare metal server network interface type. + Type *string `json:"type" validate:"required"` + + // - `hipersocket`: a virtual network device that provides high-speed TCP/IP connectivity + // within a `s390x` based system. + InterfaceType *string `json:"interface_type" validate:"required"` +} + +// Constants associated with the BareMetalServerNetworkInterfaceByHiperSocket.ResourceType property. +// The resource type. +const ( + BareMetalServerNetworkInterfaceByHiperSocketResourceTypeNetworkInterfaceConst = "network_interface" +) + +// Constants associated with the BareMetalServerNetworkInterfaceByHiperSocket.Status property. +// The status of the bare metal server network interface. +const ( + BareMetalServerNetworkInterfaceByHiperSocketStatusAvailableConst = "available" + BareMetalServerNetworkInterfaceByHiperSocketStatusDeletingConst = "deleting" + BareMetalServerNetworkInterfaceByHiperSocketStatusFailedConst = "failed" + BareMetalServerNetworkInterfaceByHiperSocketStatusPendingConst = "pending" +) + +// Constants associated with the BareMetalServerNetworkInterfaceByHiperSocket.Type property. +// The bare metal server network interface type. +const ( + BareMetalServerNetworkInterfaceByHiperSocketTypePrimaryConst = "primary" + BareMetalServerNetworkInterfaceByHiperSocketTypeSecondaryConst = "secondary" +) + +// Constants associated with the BareMetalServerNetworkInterfaceByHiperSocket.InterfaceType property. +// - `hipersocket`: a virtual network device that provides high-speed TCP/IP connectivity +// within a `s390x` based system. +const ( + BareMetalServerNetworkInterfaceByHiperSocketInterfaceTypeHipersocketConst = "hipersocket" +) + +func (*BareMetalServerNetworkInterfaceByHiperSocket) isaBareMetalServerNetworkInterface() bool { + return true +} + +// UnmarshalBareMetalServerNetworkInterfaceByHiperSocket unmarshals an instance of BareMetalServerNetworkInterfaceByHiperSocket from the specified map of raw messages. +func UnmarshalBareMetalServerNetworkInterfaceByHiperSocket(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerNetworkInterfaceByHiperSocket) + err = core.UnmarshalPrimitive(m, "allow_ip_spoofing", &obj.AllowIPSpoofing) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "enable_infrastructure_nat", &obj.EnableInfrastructureNat) + if err != nil { + return + } + err = core.UnmarshalModel(m, "floating_ips", &obj.FloatingIps, UnmarshalFloatingIPReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "mac_address", &obj.MacAddress) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "port_speed", &obj.PortSpeed) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_ip", &obj.PrimaryIP, UnmarshalReservedIPReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalModel(m, "security_groups", &obj.SecurityGroups, UnmarshalSecurityGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnet", &obj.Subnet, UnmarshalSubnetReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "interface_type", &obj.InterfaceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerNetworkInterfaceByPci : BareMetalServerNetworkInterfaceByPci struct +// This model "extends" BareMetalServerNetworkInterface +type BareMetalServerNetworkInterfaceByPci struct { + // Indicates whether source IP spoofing is allowed on this bare metal server network interface. + AllowIPSpoofing *bool `json:"allow_ip_spoofing" validate:"required"` + + // The date and time that the bare metal server network interface was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // If `true`: + // - The VPC infrastructure performs any needed NAT operations. + // - `floating_ips` must not have more than one floating IP. + // + // If `false`: + // - Packets are passed unchanged to/from the bare metal server network interface, + // allowing the workload to perform any needed NAT operations. + // - `allow_ip_spoofing` must be `false`. + // - `interface_type` must not be `hipersocket`. + EnableInfrastructureNat *bool `json:"enable_infrastructure_nat" validate:"required"` + + // The floating IPs associated with this bare metal server network interface. + FloatingIps []FloatingIPReference `json:"floating_ips" validate:"required"` + + // The URL for this bare metal server network interface. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this bare metal server network interface. + ID *string `json:"id" validate:"required"` + + // The MAC address of this bare metal server network interface. If the MAC address has not yet been selected, the value + // will be an empty string. + MacAddress *string `json:"mac_address" validate:"required"` + + // The name for this bare metal server network interface. + Name *string `json:"name" validate:"required"` + + // The bare metal server network interface port speed in Mbps. + PortSpeed *int64 `json:"port_speed" validate:"required"` + + PrimaryIP *ReservedIPReference `json:"primary_ip" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The security groups targeting this bare metal server network interface. + SecurityGroups []SecurityGroupReference `json:"security_groups" validate:"required"` + + // The status of the bare metal server network interface. + Status *string `json:"status" validate:"required"` + + // The associated subnet. + Subnet *SubnetReference `json:"subnet" validate:"required"` + + // The bare metal server network interface type. + Type *string `json:"type" validate:"required"` + + // Indicates what VLAN IDs (for VLAN type only) can use this physical (PCI type) interface. + AllowedVlans []int64 `json:"allowed_vlans" validate:"required"` + + // - `pci`: a physical PCI device which can only be created or deleted when the bare metal + // server is stopped + // - Has an `allowed_vlans` property which controls the VLANs that will be permitted + // to use the PCI interface + // - Cannot directly use an IEEE 802.1q VLAN tag. + InterfaceType *string `json:"interface_type" validate:"required"` +} + +// Constants associated with the BareMetalServerNetworkInterfaceByPci.ResourceType property. +// The resource type. +const ( + BareMetalServerNetworkInterfaceByPciResourceTypeNetworkInterfaceConst = "network_interface" +) + +// Constants associated with the BareMetalServerNetworkInterfaceByPci.Status property. +// The status of the bare metal server network interface. +const ( + BareMetalServerNetworkInterfaceByPciStatusAvailableConst = "available" + BareMetalServerNetworkInterfaceByPciStatusDeletingConst = "deleting" + BareMetalServerNetworkInterfaceByPciStatusFailedConst = "failed" + BareMetalServerNetworkInterfaceByPciStatusPendingConst = "pending" +) + +// Constants associated with the BareMetalServerNetworkInterfaceByPci.Type property. +// The bare metal server network interface type. +const ( + BareMetalServerNetworkInterfaceByPciTypePrimaryConst = "primary" + BareMetalServerNetworkInterfaceByPciTypeSecondaryConst = "secondary" +) + +// Constants associated with the BareMetalServerNetworkInterfaceByPci.InterfaceType property. +// - `pci`: a physical PCI device which can only be created or deleted when the bare metal +// server is stopped +// - Has an `allowed_vlans` property which controls the VLANs that will be permitted +// to use the PCI interface +// - Cannot directly use an IEEE 802.1q VLAN tag. +const ( + BareMetalServerNetworkInterfaceByPciInterfaceTypePciConst = "pci" +) + +func (*BareMetalServerNetworkInterfaceByPci) isaBareMetalServerNetworkInterface() bool { + return true +} + +// UnmarshalBareMetalServerNetworkInterfaceByPci unmarshals an instance of BareMetalServerNetworkInterfaceByPci from the specified map of raw messages. +func UnmarshalBareMetalServerNetworkInterfaceByPci(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerNetworkInterfaceByPci) + err = core.UnmarshalPrimitive(m, "allow_ip_spoofing", &obj.AllowIPSpoofing) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "enable_infrastructure_nat", &obj.EnableInfrastructureNat) + if err != nil { + return + } + err = core.UnmarshalModel(m, "floating_ips", &obj.FloatingIps, UnmarshalFloatingIPReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "mac_address", &obj.MacAddress) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "port_speed", &obj.PortSpeed) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_ip", &obj.PrimaryIP, UnmarshalReservedIPReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalModel(m, "security_groups", &obj.SecurityGroups, UnmarshalSecurityGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnet", &obj.Subnet, UnmarshalSubnetReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "allowed_vlans", &obj.AllowedVlans) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "interface_type", &obj.InterfaceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerNetworkInterfaceByVlan : BareMetalServerNetworkInterfaceByVlan struct +// This model "extends" BareMetalServerNetworkInterface +type BareMetalServerNetworkInterfaceByVlan struct { + // Indicates whether source IP spoofing is allowed on this bare metal server network interface. + AllowIPSpoofing *bool `json:"allow_ip_spoofing" validate:"required"` + + // The date and time that the bare metal server network interface was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // If `true`: + // - The VPC infrastructure performs any needed NAT operations. + // - `floating_ips` must not have more than one floating IP. + // + // If `false`: + // - Packets are passed unchanged to/from the bare metal server network interface, + // allowing the workload to perform any needed NAT operations. + // - `allow_ip_spoofing` must be `false`. + // - `interface_type` must not be `hipersocket`. + EnableInfrastructureNat *bool `json:"enable_infrastructure_nat" validate:"required"` + + // The floating IPs associated with this bare metal server network interface. + FloatingIps []FloatingIPReference `json:"floating_ips" validate:"required"` + + // The URL for this bare metal server network interface. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this bare metal server network interface. + ID *string `json:"id" validate:"required"` + + // The MAC address of this bare metal server network interface. If the MAC address has not yet been selected, the value + // will be an empty string. + MacAddress *string `json:"mac_address" validate:"required"` + + // The name for this bare metal server network interface. + Name *string `json:"name" validate:"required"` + + // The bare metal server network interface port speed in Mbps. + PortSpeed *int64 `json:"port_speed" validate:"required"` + + PrimaryIP *ReservedIPReference `json:"primary_ip" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The security groups targeting this bare metal server network interface. + SecurityGroups []SecurityGroupReference `json:"security_groups" validate:"required"` + + // The status of the bare metal server network interface. + Status *string `json:"status" validate:"required"` + + // The associated subnet. + Subnet *SubnetReference `json:"subnet" validate:"required"` + + // The bare metal server network interface type. + Type *string `json:"type" validate:"required"` + + // Indicates if the interface can float to any other server within the same + // `resource_group`. The interface will float automatically if the network detects a GARP or RARP on another bare metal + // server in the resource group. Applies only to `vlan` type interfaces. + AllowInterfaceToFloat *bool `json:"allow_interface_to_float" validate:"required"` + + // - `vlan`: a virtual device, used through a `pci` device that has the `vlan` in its array + // of `allowed_vlans`. + // - Must use an IEEE 802.1q tag. + // - Has its own security groups and does not inherit those of the PCI device through + // which traffic flows. + InterfaceType *string `json:"interface_type" validate:"required"` + + // Indicates the 802.1Q VLAN ID tag that must be used for all traffic on this interface. + Vlan *int64 `json:"vlan" validate:"required"` +} + +// Constants associated with the BareMetalServerNetworkInterfaceByVlan.ResourceType property. +// The resource type. +const ( + BareMetalServerNetworkInterfaceByVlanResourceTypeNetworkInterfaceConst = "network_interface" +) + +// Constants associated with the BareMetalServerNetworkInterfaceByVlan.Status property. +// The status of the bare metal server network interface. +const ( + BareMetalServerNetworkInterfaceByVlanStatusAvailableConst = "available" + BareMetalServerNetworkInterfaceByVlanStatusDeletingConst = "deleting" + BareMetalServerNetworkInterfaceByVlanStatusFailedConst = "failed" + BareMetalServerNetworkInterfaceByVlanStatusPendingConst = "pending" +) + +// Constants associated with the BareMetalServerNetworkInterfaceByVlan.Type property. +// The bare metal server network interface type. +const ( + BareMetalServerNetworkInterfaceByVlanTypePrimaryConst = "primary" + BareMetalServerNetworkInterfaceByVlanTypeSecondaryConst = "secondary" +) + +// Constants associated with the BareMetalServerNetworkInterfaceByVlan.InterfaceType property. +// - `vlan`: a virtual device, used through a `pci` device that has the `vlan` in its array +// of `allowed_vlans`. +// - Must use an IEEE 802.1q tag. +// - Has its own security groups and does not inherit those of the PCI device through +// which traffic flows. +const ( + BareMetalServerNetworkInterfaceByVlanInterfaceTypeVlanConst = "vlan" +) + +func (*BareMetalServerNetworkInterfaceByVlan) isaBareMetalServerNetworkInterface() bool { + return true +} + +// UnmarshalBareMetalServerNetworkInterfaceByVlan unmarshals an instance of BareMetalServerNetworkInterfaceByVlan from the specified map of raw messages. +func UnmarshalBareMetalServerNetworkInterfaceByVlan(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerNetworkInterfaceByVlan) + err = core.UnmarshalPrimitive(m, "allow_ip_spoofing", &obj.AllowIPSpoofing) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "enable_infrastructure_nat", &obj.EnableInfrastructureNat) + if err != nil { + return + } + err = core.UnmarshalModel(m, "floating_ips", &obj.FloatingIps, UnmarshalFloatingIPReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "mac_address", &obj.MacAddress) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "port_speed", &obj.PortSpeed) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_ip", &obj.PrimaryIP, UnmarshalReservedIPReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalModel(m, "security_groups", &obj.SecurityGroups, UnmarshalSecurityGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnet", &obj.Subnet, UnmarshalSubnetReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "allow_interface_to_float", &obj.AllowInterfaceToFloat) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "interface_type", &obj.InterfaceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "vlan", &obj.Vlan) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByHiperSocketPrototype : BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByHiperSocketPrototype struct +// This model "extends" BareMetalServerNetworkInterfacePrototype +type BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByHiperSocketPrototype struct { + // Indicates whether source IP spoofing is allowed on this bare metal server network interface. + AllowIPSpoofing *bool `json:"allow_ip_spoofing,omitempty"` + + // If `true`: + // - The VPC infrastructure performs any needed NAT operations. + // - `floating_ips` must not have more than one floating IP. + // + // If `false`: + // - Packets are passed unchanged to/from the bare metal server network interface, + // allowing the workload to perform any needed NAT operations. + // - `allow_ip_spoofing` must be `false`. + // - `interface_type` must not be `hipersocket`. + EnableInfrastructureNat *bool `json:"enable_infrastructure_nat,omitempty"` + + // The name for this bare metal server network interface. The name must not be used by another network interface on the + // bare metal server. If unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The primary IP address to bind to the bare metal server network interface. This can be specified using an existing + // reserved IP, or a prototype object for a new reserved IP. + // + // If an existing reserved IP or a prototype object with an address is specified, it must be available on the bare + // metal server network interface's subnet. Otherwise, an available address on the subnet will be automatically + // selected and reserved. + PrimaryIP NetworkInterfaceIPPrototypeIntf `json:"primary_ip,omitempty"` + + // The security groups to use for this bare metal server network interface. If unspecified, the VPC's default security + // group is used. + SecurityGroups []SecurityGroupIdentityIntf `json:"security_groups,omitempty"` + + // The associated subnet. + Subnet SubnetIdentityIntf `json:"subnet" validate:"required"` + + // - `hipersocket`: a virtual network device that provides high-speed TCP/IP connectivity + // within a `s390x` based system. + // - Not supported on bare metal servers with a `cpu.architecture` of `amd64`. + InterfaceType *string `json:"interface_type" validate:"required"` +} + +// Constants associated with the BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByHiperSocketPrototype.InterfaceType property. +// - `hipersocket`: a virtual network device that provides high-speed TCP/IP connectivity +// within a `s390x` based system. +// - Not supported on bare metal servers with a `cpu.architecture` of `amd64`. +const ( + BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByHiperSocketPrototypeInterfaceTypeHipersocketConst = "hipersocket" +) + +// NewBareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByHiperSocketPrototype : Instantiate BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByHiperSocketPrototype (Generic Model Constructor) +func (*VpcV1) NewBareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByHiperSocketPrototype(subnet SubnetIdentityIntf, interfaceType string) (_model *BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByHiperSocketPrototype, err error) { + _model = &BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByHiperSocketPrototype{ + Subnet: subnet, + InterfaceType: core.StringPtr(interfaceType), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByHiperSocketPrototype) isaBareMetalServerNetworkInterfacePrototype() bool { + return true +} + +// UnmarshalBareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByHiperSocketPrototype unmarshals an instance of BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByHiperSocketPrototype from the specified map of raw messages. +func UnmarshalBareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByHiperSocketPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByHiperSocketPrototype) + err = core.UnmarshalPrimitive(m, "allow_ip_spoofing", &obj.AllowIPSpoofing) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "enable_infrastructure_nat", &obj.EnableInfrastructureNat) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_ip", &obj.PrimaryIP, UnmarshalNetworkInterfaceIPPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "security_groups", &obj.SecurityGroups, UnmarshalSecurityGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnet", &obj.Subnet, UnmarshalSubnetIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "interface_type", &obj.InterfaceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByPciPrototype : BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByPciPrototype struct +// This model "extends" BareMetalServerNetworkInterfacePrototype +type BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByPciPrototype struct { + // Indicates whether source IP spoofing is allowed on this bare metal server network interface. + AllowIPSpoofing *bool `json:"allow_ip_spoofing,omitempty"` + + // If `true`: + // - The VPC infrastructure performs any needed NAT operations. + // - `floating_ips` must not have more than one floating IP. + // + // If `false`: + // - Packets are passed unchanged to/from the bare metal server network interface, + // allowing the workload to perform any needed NAT operations. + // - `allow_ip_spoofing` must be `false`. + // - `interface_type` must not be `hipersocket`. + EnableInfrastructureNat *bool `json:"enable_infrastructure_nat,omitempty"` + + // The name for this bare metal server network interface. The name must not be used by another network interface on the + // bare metal server. If unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The primary IP address to bind to the bare metal server network interface. This can be specified using an existing + // reserved IP, or a prototype object for a new reserved IP. + // + // If an existing reserved IP or a prototype object with an address is specified, it must be available on the bare + // metal server network interface's subnet. Otherwise, an available address on the subnet will be automatically + // selected and reserved. + PrimaryIP NetworkInterfaceIPPrototypeIntf `json:"primary_ip,omitempty"` + + // The security groups to use for this bare metal server network interface. If unspecified, the VPC's default security + // group is used. + SecurityGroups []SecurityGroupIdentityIntf `json:"security_groups,omitempty"` + + // The associated subnet. + Subnet SubnetIdentityIntf `json:"subnet" validate:"required"` + + // Indicates what VLAN IDs (for VLAN type only) can use this physical (PCI type) interface. + AllowedVlans []int64 `json:"allowed_vlans,omitempty"` + + // - `pci`: a physical PCI device which can only be created or deleted when the bare metal + // server is stopped + // - Has an `allowed_vlans` property which controls the VLANs that will be permitted + // to use the PCI interface + // - Cannot directly use an IEEE 802.1q VLAN tag. + // - Not supported on bare metal servers with a `cpu.architecture` of `s390x`. + InterfaceType *string `json:"interface_type" validate:"required"` +} + +// Constants associated with the BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByPciPrototype.InterfaceType property. +// - `pci`: a physical PCI device which can only be created or deleted when the bare metal +// server is stopped +// - Has an `allowed_vlans` property which controls the VLANs that will be permitted +// to use the PCI interface +// - Cannot directly use an IEEE 802.1q VLAN tag. +// - Not supported on bare metal servers with a `cpu.architecture` of `s390x`. +const ( + BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByPciPrototypeInterfaceTypePciConst = "pci" +) + +// NewBareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByPciPrototype : Instantiate BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByPciPrototype (Generic Model Constructor) +func (*VpcV1) NewBareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByPciPrototype(subnet SubnetIdentityIntf, interfaceType string) (_model *BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByPciPrototype, err error) { + _model = &BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByPciPrototype{ + Subnet: subnet, + InterfaceType: core.StringPtr(interfaceType), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByPciPrototype) isaBareMetalServerNetworkInterfacePrototype() bool { + return true +} + +// UnmarshalBareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByPciPrototype unmarshals an instance of BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByPciPrototype from the specified map of raw messages. +func UnmarshalBareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByPciPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByPciPrototype) + err = core.UnmarshalPrimitive(m, "allow_ip_spoofing", &obj.AllowIPSpoofing) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "enable_infrastructure_nat", &obj.EnableInfrastructureNat) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_ip", &obj.PrimaryIP, UnmarshalNetworkInterfaceIPPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "security_groups", &obj.SecurityGroups, UnmarshalSecurityGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnet", &obj.Subnet, UnmarshalSubnetIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "allowed_vlans", &obj.AllowedVlans) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "interface_type", &obj.InterfaceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByVlanPrototype : BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByVlanPrototype struct +// This model "extends" BareMetalServerNetworkInterfacePrototype +type BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByVlanPrototype struct { + // Indicates whether source IP spoofing is allowed on this bare metal server network interface. + AllowIPSpoofing *bool `json:"allow_ip_spoofing,omitempty"` + + // If `true`: + // - The VPC infrastructure performs any needed NAT operations. + // - `floating_ips` must not have more than one floating IP. + // + // If `false`: + // - Packets are passed unchanged to/from the bare metal server network interface, + // allowing the workload to perform any needed NAT operations. + // - `allow_ip_spoofing` must be `false`. + // - `interface_type` must not be `hipersocket`. + EnableInfrastructureNat *bool `json:"enable_infrastructure_nat,omitempty"` + + // The name for this bare metal server network interface. The name must not be used by another network interface on the + // bare metal server. If unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The primary IP address to bind to the bare metal server network interface. This can be specified using an existing + // reserved IP, or a prototype object for a new reserved IP. + // + // If an existing reserved IP or a prototype object with an address is specified, it must be available on the bare + // metal server network interface's subnet. Otherwise, an available address on the subnet will be automatically + // selected and reserved. + PrimaryIP NetworkInterfaceIPPrototypeIntf `json:"primary_ip,omitempty"` + + // The security groups to use for this bare metal server network interface. If unspecified, the VPC's default security + // group is used. + SecurityGroups []SecurityGroupIdentityIntf `json:"security_groups,omitempty"` + + // The associated subnet. + Subnet SubnetIdentityIntf `json:"subnet" validate:"required"` + + // Indicates if the interface can float to any other server within the same + // `resource_group`. The interface will float automatically if the network detects a GARP or RARP on another bare metal + // server in the resource group. Applies only to `vlan` type interfaces. + AllowInterfaceToFloat *bool `json:"allow_interface_to_float,omitempty"` + + // - `vlan`: a virtual device, used through a `pci` device that has the `vlan` in its array + // of `allowed_vlans`. + // - Must use an IEEE 802.1q tag. + // - Has its own security groups and does not inherit those of the PCI device through + // which traffic flows. + // - Not supported on bare metal servers with a `cpu.architecture` of `s390x`. + InterfaceType *string `json:"interface_type" validate:"required"` + + // Indicates the 802.1Q VLAN ID tag that must be used for all traffic on this interface. + Vlan *int64 `json:"vlan" validate:"required"` +} + +// Constants associated with the BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByVlanPrototype.InterfaceType property. +// - `vlan`: a virtual device, used through a `pci` device that has the `vlan` in its array +// of `allowed_vlans`. +// - Must use an IEEE 802.1q tag. +// - Has its own security groups and does not inherit those of the PCI device through +// which traffic flows. +// - Not supported on bare metal servers with a `cpu.architecture` of `s390x`. +const ( + BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByVlanPrototypeInterfaceTypeVlanConst = "vlan" +) + +// NewBareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByVlanPrototype : Instantiate BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByVlanPrototype (Generic Model Constructor) +func (*VpcV1) NewBareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByVlanPrototype(subnet SubnetIdentityIntf, interfaceType string, vlan int64) (_model *BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByVlanPrototype, err error) { + _model = &BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByVlanPrototype{ + Subnet: subnet, + InterfaceType: core.StringPtr(interfaceType), + Vlan: core.Int64Ptr(vlan), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByVlanPrototype) isaBareMetalServerNetworkInterfacePrototype() bool { + return true +} + +// UnmarshalBareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByVlanPrototype unmarshals an instance of BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByVlanPrototype from the specified map of raw messages. +func UnmarshalBareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByVlanPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerNetworkInterfacePrototypeBareMetalServerNetworkInterfaceByVlanPrototype) + err = core.UnmarshalPrimitive(m, "allow_ip_spoofing", &obj.AllowIPSpoofing) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "enable_infrastructure_nat", &obj.EnableInfrastructureNat) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_ip", &obj.PrimaryIP, UnmarshalNetworkInterfaceIPPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "security_groups", &obj.SecurityGroups, UnmarshalSecurityGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnet", &obj.Subnet, UnmarshalSubnetIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "allow_interface_to_float", &obj.AllowInterfaceToFloat) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "interface_type", &obj.InterfaceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "vlan", &obj.Vlan) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileBandwidthDependent : The total bandwidth shared across the bare metal server network interfaces of a bare metal server with this profile +// depends on its configuration. +// This model "extends" BareMetalServerProfileBandwidth +type BareMetalServerProfileBandwidthDependent struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileBandwidthDependent.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileBandwidthDependentTypeDependentConst = "dependent" +) + +func (*BareMetalServerProfileBandwidthDependent) isaBareMetalServerProfileBandwidth() bool { + return true +} + +// UnmarshalBareMetalServerProfileBandwidthDependent unmarshals an instance of BareMetalServerProfileBandwidthDependent from the specified map of raw messages. +func UnmarshalBareMetalServerProfileBandwidthDependent(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileBandwidthDependent) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileBandwidthEnum : The permitted total bandwidth values (in megabits per second) shared across the bare metal server network interfaces +// of a bare metal server with this profile. +// This model "extends" BareMetalServerProfileBandwidth +type BareMetalServerProfileBandwidthEnum struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The permitted values for this profile field. + Values []int64 `json:"values" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileBandwidthEnum.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileBandwidthEnumTypeEnumConst = "enum" +) + +func (*BareMetalServerProfileBandwidthEnum) isaBareMetalServerProfileBandwidth() bool { + return true +} + +// UnmarshalBareMetalServerProfileBandwidthEnum unmarshals an instance of BareMetalServerProfileBandwidthEnum from the specified map of raw messages. +func UnmarshalBareMetalServerProfileBandwidthEnum(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileBandwidthEnum) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileBandwidthFixed : The total bandwidth (in megabits per second) shared across the bare metal server network interfaces of a bare metal +// server with this profile. +// This model "extends" BareMetalServerProfileBandwidth +type BareMetalServerProfileBandwidthFixed struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The value for this profile field. + Value *int64 `json:"value" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileBandwidthFixed.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileBandwidthFixedTypeFixedConst = "fixed" +) + +func (*BareMetalServerProfileBandwidthFixed) isaBareMetalServerProfileBandwidth() bool { + return true +} + +// UnmarshalBareMetalServerProfileBandwidthFixed unmarshals an instance of BareMetalServerProfileBandwidthFixed from the specified map of raw messages. +func UnmarshalBareMetalServerProfileBandwidthFixed(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileBandwidthFixed) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileBandwidthRange : The permitted total bandwidth range (in megabits per second) shared across the bare metal server network interfaces +// of a bare metal server with this profile. +// This model "extends" BareMetalServerProfileBandwidth +type BareMetalServerProfileBandwidthRange struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The maximum value for this profile field. + Max *int64 `json:"max" validate:"required"` + + // The minimum value for this profile field. + Min *int64 `json:"min" validate:"required"` + + // The increment step value for this profile field. + Step *int64 `json:"step" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileBandwidthRange.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileBandwidthRangeTypeRangeConst = "range" +) + +func (*BareMetalServerProfileBandwidthRange) isaBareMetalServerProfileBandwidth() bool { + return true +} + +// UnmarshalBareMetalServerProfileBandwidthRange unmarshals an instance of BareMetalServerProfileBandwidthRange from the specified map of raw messages. +func UnmarshalBareMetalServerProfileBandwidthRange(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileBandwidthRange) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileCpuCoreCountDependent : The CPU core count for a bare metal server with this profile depends on its configuration. +// This model "extends" BareMetalServerProfileCpuCoreCount +type BareMetalServerProfileCpuCoreCountDependent struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileCpuCoreCountDependent.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileCpuCoreCountDependentTypeDependentConst = "dependent" +) + +func (*BareMetalServerProfileCpuCoreCountDependent) isaBareMetalServerProfileCpuCoreCount() bool { + return true +} + +// UnmarshalBareMetalServerProfileCpuCoreCountDependent unmarshals an instance of BareMetalServerProfileCpuCoreCountDependent from the specified map of raw messages. +func UnmarshalBareMetalServerProfileCpuCoreCountDependent(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileCpuCoreCountDependent) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileCpuCoreCountEnum : The permitted values for CPU cores for a bare metal server with this profile. +// This model "extends" BareMetalServerProfileCpuCoreCount +type BareMetalServerProfileCpuCoreCountEnum struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The permitted values for this profile field. + Values []int64 `json:"values" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileCpuCoreCountEnum.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileCpuCoreCountEnumTypeEnumConst = "enum" +) + +func (*BareMetalServerProfileCpuCoreCountEnum) isaBareMetalServerProfileCpuCoreCount() bool { + return true +} + +// UnmarshalBareMetalServerProfileCpuCoreCountEnum unmarshals an instance of BareMetalServerProfileCpuCoreCountEnum from the specified map of raw messages. +func UnmarshalBareMetalServerProfileCpuCoreCountEnum(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileCpuCoreCountEnum) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileCpuCoreCountFixed : The CPU core count for a bare metal server with this profile. +// This model "extends" BareMetalServerProfileCpuCoreCount +type BareMetalServerProfileCpuCoreCountFixed struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The value for this profile field. + Value *int64 `json:"value" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileCpuCoreCountFixed.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileCpuCoreCountFixedTypeFixedConst = "fixed" +) + +func (*BareMetalServerProfileCpuCoreCountFixed) isaBareMetalServerProfileCpuCoreCount() bool { + return true +} + +// UnmarshalBareMetalServerProfileCpuCoreCountFixed unmarshals an instance of BareMetalServerProfileCpuCoreCountFixed from the specified map of raw messages. +func UnmarshalBareMetalServerProfileCpuCoreCountFixed(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileCpuCoreCountFixed) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileCpuCoreCountRange : The permitted range for the number of CPU cores for a bare metal server with this profile. +// This model "extends" BareMetalServerProfileCpuCoreCount +type BareMetalServerProfileCpuCoreCountRange struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The maximum value for this profile field. + Max *int64 `json:"max" validate:"required"` + + // The minimum value for this profile field. + Min *int64 `json:"min" validate:"required"` + + // The increment step value for this profile field. + Step *int64 `json:"step" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileCpuCoreCountRange.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileCpuCoreCountRangeTypeRangeConst = "range" +) + +func (*BareMetalServerProfileCpuCoreCountRange) isaBareMetalServerProfileCpuCoreCount() bool { + return true +} + +// UnmarshalBareMetalServerProfileCpuCoreCountRange unmarshals an instance of BareMetalServerProfileCpuCoreCountRange from the specified map of raw messages. +func UnmarshalBareMetalServerProfileCpuCoreCountRange(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileCpuCoreCountRange) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileCpuSocketCountDependent : The CPU socket count for a bare metal server with this profile depends on its configuration. +// This model "extends" BareMetalServerProfileCpuSocketCount +type BareMetalServerProfileCpuSocketCountDependent struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileCpuSocketCountDependent.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileCpuSocketCountDependentTypeDependentConst = "dependent" +) + +func (*BareMetalServerProfileCpuSocketCountDependent) isaBareMetalServerProfileCpuSocketCount() bool { + return true +} + +// UnmarshalBareMetalServerProfileCpuSocketCountDependent unmarshals an instance of BareMetalServerProfileCpuSocketCountDependent from the specified map of raw messages. +func UnmarshalBareMetalServerProfileCpuSocketCountDependent(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileCpuSocketCountDependent) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileCpuSocketCountEnum : The permitted values for CPU sockets for a bare metal server with this profile. +// This model "extends" BareMetalServerProfileCpuSocketCount +type BareMetalServerProfileCpuSocketCountEnum struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The permitted values for this profile field. + Values []int64 `json:"values" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileCpuSocketCountEnum.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileCpuSocketCountEnumTypeEnumConst = "enum" +) + +func (*BareMetalServerProfileCpuSocketCountEnum) isaBareMetalServerProfileCpuSocketCount() bool { + return true +} + +// UnmarshalBareMetalServerProfileCpuSocketCountEnum unmarshals an instance of BareMetalServerProfileCpuSocketCountEnum from the specified map of raw messages. +func UnmarshalBareMetalServerProfileCpuSocketCountEnum(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileCpuSocketCountEnum) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileCpuSocketCountFixed : The number of CPU sockets for a bare metal server with this profile. +// This model "extends" BareMetalServerProfileCpuSocketCount +type BareMetalServerProfileCpuSocketCountFixed struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The value for this profile field. + Value *int64 `json:"value" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileCpuSocketCountFixed.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileCpuSocketCountFixedTypeFixedConst = "fixed" +) + +func (*BareMetalServerProfileCpuSocketCountFixed) isaBareMetalServerProfileCpuSocketCount() bool { + return true +} + +// UnmarshalBareMetalServerProfileCpuSocketCountFixed unmarshals an instance of BareMetalServerProfileCpuSocketCountFixed from the specified map of raw messages. +func UnmarshalBareMetalServerProfileCpuSocketCountFixed(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileCpuSocketCountFixed) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileCpuSocketCountRange : The permitted range for the number of CPU sockets for a bare metal server with this profile. +// This model "extends" BareMetalServerProfileCpuSocketCount +type BareMetalServerProfileCpuSocketCountRange struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The maximum value for this profile field. + Max *int64 `json:"max" validate:"required"` + + // The minimum value for this profile field. + Min *int64 `json:"min" validate:"required"` + + // The increment step value for this profile field. + Step *int64 `json:"step" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileCpuSocketCountRange.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileCpuSocketCountRangeTypeRangeConst = "range" +) + +func (*BareMetalServerProfileCpuSocketCountRange) isaBareMetalServerProfileCpuSocketCount() bool { + return true +} + +// UnmarshalBareMetalServerProfileCpuSocketCountRange unmarshals an instance of BareMetalServerProfileCpuSocketCountRange from the specified map of raw messages. +func UnmarshalBareMetalServerProfileCpuSocketCountRange(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileCpuSocketCountRange) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileDiskQuantityDependent : The number of disks of this configuration for a bare metal server with this profile depends on its bare metal server +// configuration. +// This model "extends" BareMetalServerProfileDiskQuantity +type BareMetalServerProfileDiskQuantityDependent struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileDiskQuantityDependent.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileDiskQuantityDependentTypeDependentConst = "dependent" +) + +func (*BareMetalServerProfileDiskQuantityDependent) isaBareMetalServerProfileDiskQuantity() bool { + return true +} + +// UnmarshalBareMetalServerProfileDiskQuantityDependent unmarshals an instance of BareMetalServerProfileDiskQuantityDependent from the specified map of raw messages. +func UnmarshalBareMetalServerProfileDiskQuantityDependent(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileDiskQuantityDependent) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileDiskQuantityEnum : The permitted the number of disks of this configuration for a bare metal server with this profile. +// This model "extends" BareMetalServerProfileDiskQuantity +type BareMetalServerProfileDiskQuantityEnum struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The permitted values for this profile field. + Values []int64 `json:"values" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileDiskQuantityEnum.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileDiskQuantityEnumTypeEnumConst = "enum" +) + +func (*BareMetalServerProfileDiskQuantityEnum) isaBareMetalServerProfileDiskQuantity() bool { + return true +} + +// UnmarshalBareMetalServerProfileDiskQuantityEnum unmarshals an instance of BareMetalServerProfileDiskQuantityEnum from the specified map of raw messages. +func UnmarshalBareMetalServerProfileDiskQuantityEnum(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileDiskQuantityEnum) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileDiskQuantityFixed : The number of disks of this configuration for a bare metal server with this profile. +// This model "extends" BareMetalServerProfileDiskQuantity +type BareMetalServerProfileDiskQuantityFixed struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The value for this profile field. + Value *int64 `json:"value" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileDiskQuantityFixed.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileDiskQuantityFixedTypeFixedConst = "fixed" +) + +func (*BareMetalServerProfileDiskQuantityFixed) isaBareMetalServerProfileDiskQuantity() bool { + return true +} + +// UnmarshalBareMetalServerProfileDiskQuantityFixed unmarshals an instance of BareMetalServerProfileDiskQuantityFixed from the specified map of raw messages. +func UnmarshalBareMetalServerProfileDiskQuantityFixed(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileDiskQuantityFixed) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileDiskQuantityRange : The permitted range for the number of disks of this configuration for a bare metal server with this profile. +// This model "extends" BareMetalServerProfileDiskQuantity +type BareMetalServerProfileDiskQuantityRange struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The maximum value for this profile field. + Max *int64 `json:"max" validate:"required"` + + // The minimum value for this profile field. + Min *int64 `json:"min" validate:"required"` + + // The increment step value for this profile field. + Step *int64 `json:"step" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileDiskQuantityRange.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileDiskQuantityRangeTypeRangeConst = "range" +) + +func (*BareMetalServerProfileDiskQuantityRange) isaBareMetalServerProfileDiskQuantity() bool { + return true +} + +// UnmarshalBareMetalServerProfileDiskQuantityRange unmarshals an instance of BareMetalServerProfileDiskQuantityRange from the specified map of raw messages. +func UnmarshalBareMetalServerProfileDiskQuantityRange(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileDiskQuantityRange) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileDiskSizeDependent : The disk size in GB (gigabytes) of this configuration for a bare metal server with this profile depends on its bare +// metal server configuration. +// This model "extends" BareMetalServerProfileDiskSize +type BareMetalServerProfileDiskSizeDependent struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileDiskSizeDependent.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileDiskSizeDependentTypeDependentConst = "dependent" +) + +func (*BareMetalServerProfileDiskSizeDependent) isaBareMetalServerProfileDiskSize() bool { + return true +} + +// UnmarshalBareMetalServerProfileDiskSizeDependent unmarshals an instance of BareMetalServerProfileDiskSizeDependent from the specified map of raw messages. +func UnmarshalBareMetalServerProfileDiskSizeDependent(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileDiskSizeDependent) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileDiskSizeEnum : The permitted disk size in GB (gigabytes) of this configuration for a bare metal server with this profile. +// This model "extends" BareMetalServerProfileDiskSize +type BareMetalServerProfileDiskSizeEnum struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The permitted values for this profile field. + Values []int64 `json:"values" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileDiskSizeEnum.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileDiskSizeEnumTypeEnumConst = "enum" +) + +func (*BareMetalServerProfileDiskSizeEnum) isaBareMetalServerProfileDiskSize() bool { + return true +} + +// UnmarshalBareMetalServerProfileDiskSizeEnum unmarshals an instance of BareMetalServerProfileDiskSizeEnum from the specified map of raw messages. +func UnmarshalBareMetalServerProfileDiskSizeEnum(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileDiskSizeEnum) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileDiskSizeFixed : The size of the disk in GB (gigabytes). +// This model "extends" BareMetalServerProfileDiskSize +type BareMetalServerProfileDiskSizeFixed struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The value for this profile field. + Value *int64 `json:"value" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileDiskSizeFixed.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileDiskSizeFixedTypeFixedConst = "fixed" +) + +func (*BareMetalServerProfileDiskSizeFixed) isaBareMetalServerProfileDiskSize() bool { + return true +} + +// UnmarshalBareMetalServerProfileDiskSizeFixed unmarshals an instance of BareMetalServerProfileDiskSizeFixed from the specified map of raw messages. +func UnmarshalBareMetalServerProfileDiskSizeFixed(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileDiskSizeFixed) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileDiskSizeRange : The permitted range for the disk size of this configuration in GB (gigabytes) for a bare metal server with this +// profile. +// This model "extends" BareMetalServerProfileDiskSize +type BareMetalServerProfileDiskSizeRange struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The maximum value for this profile field. + Max *int64 `json:"max" validate:"required"` + + // The minimum value for this profile field. + Min *int64 `json:"min" validate:"required"` + + // The increment step value for this profile field. + Step *int64 `json:"step" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileDiskSizeRange.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileDiskSizeRangeTypeRangeConst = "range" +) + +func (*BareMetalServerProfileDiskSizeRange) isaBareMetalServerProfileDiskSize() bool { + return true +} + +// UnmarshalBareMetalServerProfileDiskSizeRange unmarshals an instance of BareMetalServerProfileDiskSizeRange from the specified map of raw messages. +func UnmarshalBareMetalServerProfileDiskSizeRange(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileDiskSizeRange) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileIdentityByHref : BareMetalServerProfileIdentityByHref struct +// This model "extends" BareMetalServerProfileIdentity +type BareMetalServerProfileIdentityByHref struct { + // The URL for this bare metal server profile. + Href *string `json:"href" validate:"required"` +} + +// NewBareMetalServerProfileIdentityByHref : Instantiate BareMetalServerProfileIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewBareMetalServerProfileIdentityByHref(href string) (_model *BareMetalServerProfileIdentityByHref, err error) { + _model = &BareMetalServerProfileIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*BareMetalServerProfileIdentityByHref) isaBareMetalServerProfileIdentity() bool { + return true +} + +// UnmarshalBareMetalServerProfileIdentityByHref unmarshals an instance of BareMetalServerProfileIdentityByHref from the specified map of raw messages. +func UnmarshalBareMetalServerProfileIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileIdentityByName : BareMetalServerProfileIdentityByName struct +// This model "extends" BareMetalServerProfileIdentity +type BareMetalServerProfileIdentityByName struct { + // The name for this bare metal server profile. + Name *string `json:"name" validate:"required"` +} + +// NewBareMetalServerProfileIdentityByName : Instantiate BareMetalServerProfileIdentityByName (Generic Model Constructor) +func (*VpcV1) NewBareMetalServerProfileIdentityByName(name string) (_model *BareMetalServerProfileIdentityByName, err error) { + _model = &BareMetalServerProfileIdentityByName{ + Name: core.StringPtr(name), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*BareMetalServerProfileIdentityByName) isaBareMetalServerProfileIdentity() bool { + return true +} + +// UnmarshalBareMetalServerProfileIdentityByName unmarshals an instance of BareMetalServerProfileIdentityByName from the specified map of raw messages. +func UnmarshalBareMetalServerProfileIdentityByName(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileIdentityByName) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileMemoryDependent : The memory value for a bare metal server with this profile depends on its configuration. +// This model "extends" BareMetalServerProfileMemory +type BareMetalServerProfileMemoryDependent struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileMemoryDependent.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileMemoryDependentTypeDependentConst = "dependent" +) + +func (*BareMetalServerProfileMemoryDependent) isaBareMetalServerProfileMemory() bool { + return true +} + +// UnmarshalBareMetalServerProfileMemoryDependent unmarshals an instance of BareMetalServerProfileMemoryDependent from the specified map of raw messages. +func UnmarshalBareMetalServerProfileMemoryDependent(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileMemoryDependent) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileMemoryEnum : The permitted memory values (in gibibytes) for a bare metal server with this profile. +// This model "extends" BareMetalServerProfileMemory +type BareMetalServerProfileMemoryEnum struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The permitted values for this profile field. + Values []int64 `json:"values" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileMemoryEnum.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileMemoryEnumTypeEnumConst = "enum" +) + +func (*BareMetalServerProfileMemoryEnum) isaBareMetalServerProfileMemory() bool { + return true +} + +// UnmarshalBareMetalServerProfileMemoryEnum unmarshals an instance of BareMetalServerProfileMemoryEnum from the specified map of raw messages. +func UnmarshalBareMetalServerProfileMemoryEnum(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileMemoryEnum) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileMemoryFixed : The memory (in gibibytes) for a bare metal server with this profile. +// This model "extends" BareMetalServerProfileMemory +type BareMetalServerProfileMemoryFixed struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The value for this profile field. + Value *int64 `json:"value" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileMemoryFixed.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileMemoryFixedTypeFixedConst = "fixed" +) + +func (*BareMetalServerProfileMemoryFixed) isaBareMetalServerProfileMemory() bool { + return true +} + +// UnmarshalBareMetalServerProfileMemoryFixed unmarshals an instance of BareMetalServerProfileMemoryFixed from the specified map of raw messages. +func UnmarshalBareMetalServerProfileMemoryFixed(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileMemoryFixed) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileMemoryRange : The permitted memory range (in gibibytes) for a bare metal server with this profile. +// This model "extends" BareMetalServerProfileMemory +type BareMetalServerProfileMemoryRange struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The maximum value for this profile field. + Max *int64 `json:"max" validate:"required"` + + // The minimum value for this profile field. + Min *int64 `json:"min" validate:"required"` + + // The increment step value for this profile field. + Step *int64 `json:"step" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileMemoryRange.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileMemoryRangeTypeRangeConst = "range" +) + +func (*BareMetalServerProfileMemoryRange) isaBareMetalServerProfileMemory() bool { + return true +} + +// UnmarshalBareMetalServerProfileMemoryRange unmarshals an instance of BareMetalServerProfileMemoryRange from the specified map of raw messages. +func UnmarshalBareMetalServerProfileMemoryRange(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileMemoryRange) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileNetworkInterfaceCountDependent : The number of bare metal server network interfaces supported on a bare metal server with this profile is dependent on +// its configuration. +// This model "extends" BareMetalServerProfileNetworkInterfaceCount +type BareMetalServerProfileNetworkInterfaceCountDependent struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileNetworkInterfaceCountDependent.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileNetworkInterfaceCountDependentTypeDependentConst = "dependent" +) + +func (*BareMetalServerProfileNetworkInterfaceCountDependent) isaBareMetalServerProfileNetworkInterfaceCount() bool { + return true +} + +// UnmarshalBareMetalServerProfileNetworkInterfaceCountDependent unmarshals an instance of BareMetalServerProfileNetworkInterfaceCountDependent from the specified map of raw messages. +func UnmarshalBareMetalServerProfileNetworkInterfaceCountDependent(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileNetworkInterfaceCountDependent) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// BareMetalServerProfileNetworkInterfaceCountRange : The number of bare metal server network interfaces supported on a bare metal server with this profile. +// This model "extends" BareMetalServerProfileNetworkInterfaceCount +type BareMetalServerProfileNetworkInterfaceCountRange struct { + // The maximum value for this profile field. + Max *int64 `json:"max,omitempty"` + + // The minimum value for this profile field. + Min *int64 `json:"min,omitempty"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the BareMetalServerProfileNetworkInterfaceCountRange.Type property. +// The type for this profile field. +const ( + BareMetalServerProfileNetworkInterfaceCountRangeTypeRangeConst = "range" +) + +func (*BareMetalServerProfileNetworkInterfaceCountRange) isaBareMetalServerProfileNetworkInterfaceCount() bool { + return true +} + +// UnmarshalBareMetalServerProfileNetworkInterfaceCountRange unmarshals an instance of BareMetalServerProfileNetworkInterfaceCountRange from the specified map of raw messages. +func UnmarshalBareMetalServerProfileNetworkInterfaceCountRange(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(BareMetalServerProfileNetworkInterfaceCountRange) + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// CatalogOfferingIdentityCatalogOfferingByCRN : CatalogOfferingIdentityCatalogOfferingByCRN struct +// This model "extends" CatalogOfferingIdentity +type CatalogOfferingIdentityCatalogOfferingByCRN struct { + // The CRN for this + // [catalog](https://cloud.ibm.com/docs/account?topic=account-restrict-by-user) offering. + CRN *string `json:"crn" validate:"required"` +} + +// NewCatalogOfferingIdentityCatalogOfferingByCRN : Instantiate CatalogOfferingIdentityCatalogOfferingByCRN (Generic Model Constructor) +func (*VpcV1) NewCatalogOfferingIdentityCatalogOfferingByCRN(crn string) (_model *CatalogOfferingIdentityCatalogOfferingByCRN, err error) { + _model = &CatalogOfferingIdentityCatalogOfferingByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*CatalogOfferingIdentityCatalogOfferingByCRN) isaCatalogOfferingIdentity() bool { + return true +} + +// UnmarshalCatalogOfferingIdentityCatalogOfferingByCRN unmarshals an instance of CatalogOfferingIdentityCatalogOfferingByCRN from the specified map of raw messages. +func UnmarshalCatalogOfferingIdentityCatalogOfferingByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(CatalogOfferingIdentityCatalogOfferingByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// CatalogOfferingVersionIdentityCatalogOfferingVersionByCRN : CatalogOfferingVersionIdentityCatalogOfferingVersionByCRN struct +// This model "extends" CatalogOfferingVersionIdentity +type CatalogOfferingVersionIdentityCatalogOfferingVersionByCRN struct { + // The CRN for this version of a + // [catalog](https://cloud.ibm.com/docs/account?topic=account-restrict-by-user) offering. + CRN *string `json:"crn" validate:"required"` +} + +// NewCatalogOfferingVersionIdentityCatalogOfferingVersionByCRN : Instantiate CatalogOfferingVersionIdentityCatalogOfferingVersionByCRN (Generic Model Constructor) +func (*VpcV1) NewCatalogOfferingVersionIdentityCatalogOfferingVersionByCRN(crn string) (_model *CatalogOfferingVersionIdentityCatalogOfferingVersionByCRN, err error) { + _model = &CatalogOfferingVersionIdentityCatalogOfferingVersionByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*CatalogOfferingVersionIdentityCatalogOfferingVersionByCRN) isaCatalogOfferingVersionIdentity() bool { + return true +} + +// UnmarshalCatalogOfferingVersionIdentityCatalogOfferingVersionByCRN unmarshals an instance of CatalogOfferingVersionIdentityCatalogOfferingVersionByCRN from the specified map of raw messages. +func UnmarshalCatalogOfferingVersionIdentityCatalogOfferingVersionByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(CatalogOfferingVersionIdentityCatalogOfferingVersionByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// CertificateInstanceIdentityByCRN : CertificateInstanceIdentityByCRN struct +// This model "extends" CertificateInstanceIdentity +type CertificateInstanceIdentityByCRN struct { + // The CRN for this certificate instance. + CRN *string `json:"crn" validate:"required"` +} + +// NewCertificateInstanceIdentityByCRN : Instantiate CertificateInstanceIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewCertificateInstanceIdentityByCRN(crn string) (_model *CertificateInstanceIdentityByCRN, err error) { + _model = &CertificateInstanceIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*CertificateInstanceIdentityByCRN) isaCertificateInstanceIdentity() bool { + return true +} + +// UnmarshalCertificateInstanceIdentityByCRN unmarshals an instance of CertificateInstanceIdentityByCRN from the specified map of raw messages. +func UnmarshalCertificateInstanceIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(CertificateInstanceIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// CloudObjectStorageBucketIdentityByCRN : CloudObjectStorageBucketIdentityByCRN struct +// This model "extends" CloudObjectStorageBucketIdentity +type CloudObjectStorageBucketIdentityByCRN struct { + // The CRN of this Cloud Object Storage bucket. + CRN *string `json:"crn" validate:"required"` +} + +// NewCloudObjectStorageBucketIdentityByCRN : Instantiate CloudObjectStorageBucketIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewCloudObjectStorageBucketIdentityByCRN(crn string) (_model *CloudObjectStorageBucketIdentityByCRN, err error) { + _model = &CloudObjectStorageBucketIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*CloudObjectStorageBucketIdentityByCRN) isaCloudObjectStorageBucketIdentity() bool { + return true +} + +// UnmarshalCloudObjectStorageBucketIdentityByCRN unmarshals an instance of CloudObjectStorageBucketIdentityByCRN from the specified map of raw messages. +func UnmarshalCloudObjectStorageBucketIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(CloudObjectStorageBucketIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// CloudObjectStorageBucketIdentityCloudObjectStorageBucketIdentityByName : CloudObjectStorageBucketIdentityCloudObjectStorageBucketIdentityByName struct +// This model "extends" CloudObjectStorageBucketIdentity +type CloudObjectStorageBucketIdentityCloudObjectStorageBucketIdentityByName struct { + // The globally unique name of this Cloud Object Storage bucket. + Name *string `json:"name" validate:"required"` +} + +// NewCloudObjectStorageBucketIdentityCloudObjectStorageBucketIdentityByName : Instantiate CloudObjectStorageBucketIdentityCloudObjectStorageBucketIdentityByName (Generic Model Constructor) +func (*VpcV1) NewCloudObjectStorageBucketIdentityCloudObjectStorageBucketIdentityByName(name string) (_model *CloudObjectStorageBucketIdentityCloudObjectStorageBucketIdentityByName, err error) { + _model = &CloudObjectStorageBucketIdentityCloudObjectStorageBucketIdentityByName{ + Name: core.StringPtr(name), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*CloudObjectStorageBucketIdentityCloudObjectStorageBucketIdentityByName) isaCloudObjectStorageBucketIdentity() bool { + return true +} + +// UnmarshalCloudObjectStorageBucketIdentityCloudObjectStorageBucketIdentityByName unmarshals an instance of CloudObjectStorageBucketIdentityCloudObjectStorageBucketIdentityByName from the specified map of raw messages. +func UnmarshalCloudObjectStorageBucketIdentityCloudObjectStorageBucketIdentityByName(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(CloudObjectStorageBucketIdentityCloudObjectStorageBucketIdentityByName) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DnsInstanceIdentityByCRN : DnsInstanceIdentityByCRN struct +// This model "extends" DnsInstanceIdentity +type DnsInstanceIdentityByCRN struct { + // The CRN for this DNS instance. + CRN *string `json:"crn" validate:"required"` +} + +// NewDnsInstanceIdentityByCRN : Instantiate DnsInstanceIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewDnsInstanceIdentityByCRN(crn string) (_model *DnsInstanceIdentityByCRN, err error) { + _model = &DnsInstanceIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*DnsInstanceIdentityByCRN) isaDnsInstanceIdentity() bool { + return true +} + +// UnmarshalDnsInstanceIdentityByCRN unmarshals an instance of DnsInstanceIdentityByCRN from the specified map of raw messages. +func UnmarshalDnsInstanceIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DnsInstanceIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DnsZoneIdentityByID : DnsZoneIdentityByID struct +// This model "extends" DnsZoneIdentity +type DnsZoneIdentityByID struct { + ID *string `json:"id" validate:"required"` +} + +// NewDnsZoneIdentityByID : Instantiate DnsZoneIdentityByID (Generic Model Constructor) +func (*VpcV1) NewDnsZoneIdentityByID(id string) (_model *DnsZoneIdentityByID, err error) { + _model = &DnsZoneIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*DnsZoneIdentityByID) isaDnsZoneIdentity() bool { + return true +} + +// UnmarshalDnsZoneIdentityByID unmarshals an instance of DnsZoneIdentityByID from the specified map of raw messages. +func UnmarshalDnsZoneIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DnsZoneIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostGroupIdentityByCRN : DedicatedHostGroupIdentityByCRN struct +// This model "extends" DedicatedHostGroupIdentity +type DedicatedHostGroupIdentityByCRN struct { + // The CRN for this dedicated host group. + CRN *string `json:"crn" validate:"required"` +} + +// NewDedicatedHostGroupIdentityByCRN : Instantiate DedicatedHostGroupIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewDedicatedHostGroupIdentityByCRN(crn string) (_model *DedicatedHostGroupIdentityByCRN, err error) { + _model = &DedicatedHostGroupIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*DedicatedHostGroupIdentityByCRN) isaDedicatedHostGroupIdentity() bool { + return true +} + +// UnmarshalDedicatedHostGroupIdentityByCRN unmarshals an instance of DedicatedHostGroupIdentityByCRN from the specified map of raw messages. +func UnmarshalDedicatedHostGroupIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostGroupIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostGroupIdentityByHref : DedicatedHostGroupIdentityByHref struct +// This model "extends" DedicatedHostGroupIdentity +type DedicatedHostGroupIdentityByHref struct { + // The URL for this dedicated host group. + Href *string `json:"href" validate:"required"` +} + +// NewDedicatedHostGroupIdentityByHref : Instantiate DedicatedHostGroupIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewDedicatedHostGroupIdentityByHref(href string) (_model *DedicatedHostGroupIdentityByHref, err error) { + _model = &DedicatedHostGroupIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*DedicatedHostGroupIdentityByHref) isaDedicatedHostGroupIdentity() bool { + return true +} + +// UnmarshalDedicatedHostGroupIdentityByHref unmarshals an instance of DedicatedHostGroupIdentityByHref from the specified map of raw messages. +func UnmarshalDedicatedHostGroupIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostGroupIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostGroupIdentityByID : DedicatedHostGroupIdentityByID struct +// This model "extends" DedicatedHostGroupIdentity +type DedicatedHostGroupIdentityByID struct { + // The unique identifier for this dedicated host group. + ID *string `json:"id" validate:"required"` +} + +// NewDedicatedHostGroupIdentityByID : Instantiate DedicatedHostGroupIdentityByID (Generic Model Constructor) +func (*VpcV1) NewDedicatedHostGroupIdentityByID(id string) (_model *DedicatedHostGroupIdentityByID, err error) { + _model = &DedicatedHostGroupIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*DedicatedHostGroupIdentityByID) isaDedicatedHostGroupIdentity() bool { + return true +} + +// UnmarshalDedicatedHostGroupIdentityByID unmarshals an instance of DedicatedHostGroupIdentityByID from the specified map of raw messages. +func UnmarshalDedicatedHostGroupIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostGroupIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostProfileIdentityByHref : DedicatedHostProfileIdentityByHref struct +// This model "extends" DedicatedHostProfileIdentity +type DedicatedHostProfileIdentityByHref struct { + // The URL for this dedicated host profile. + Href *string `json:"href" validate:"required"` +} + +// NewDedicatedHostProfileIdentityByHref : Instantiate DedicatedHostProfileIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewDedicatedHostProfileIdentityByHref(href string) (_model *DedicatedHostProfileIdentityByHref, err error) { + _model = &DedicatedHostProfileIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*DedicatedHostProfileIdentityByHref) isaDedicatedHostProfileIdentity() bool { + return true +} + +// UnmarshalDedicatedHostProfileIdentityByHref unmarshals an instance of DedicatedHostProfileIdentityByHref from the specified map of raw messages. +func UnmarshalDedicatedHostProfileIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostProfileIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostProfileIdentityByName : DedicatedHostProfileIdentityByName struct +// This model "extends" DedicatedHostProfileIdentity +type DedicatedHostProfileIdentityByName struct { + // The globally unique name for this dedicated host profile. + Name *string `json:"name" validate:"required"` +} + +// NewDedicatedHostProfileIdentityByName : Instantiate DedicatedHostProfileIdentityByName (Generic Model Constructor) +func (*VpcV1) NewDedicatedHostProfileIdentityByName(name string) (_model *DedicatedHostProfileIdentityByName, err error) { + _model = &DedicatedHostProfileIdentityByName{ + Name: core.StringPtr(name), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*DedicatedHostProfileIdentityByName) isaDedicatedHostProfileIdentity() bool { + return true +} + +// UnmarshalDedicatedHostProfileIdentityByName unmarshals an instance of DedicatedHostProfileIdentityByName from the specified map of raw messages. +func UnmarshalDedicatedHostProfileIdentityByName(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostProfileIdentityByName) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostProfileMemoryDependent : The memory value for a dedicated host with this profile depends on its configuration. +// This model "extends" DedicatedHostProfileMemory +type DedicatedHostProfileMemoryDependent struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the DedicatedHostProfileMemoryDependent.Type property. +// The type for this profile field. +const ( + DedicatedHostProfileMemoryDependentTypeDependentConst = "dependent" +) + +func (*DedicatedHostProfileMemoryDependent) isaDedicatedHostProfileMemory() bool { + return true +} + +// UnmarshalDedicatedHostProfileMemoryDependent unmarshals an instance of DedicatedHostProfileMemoryDependent from the specified map of raw messages. +func UnmarshalDedicatedHostProfileMemoryDependent(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostProfileMemoryDependent) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostProfileMemoryEnum : The permitted memory values (in gibibytes) for a dedicated host with this profile. +// This model "extends" DedicatedHostProfileMemory +type DedicatedHostProfileMemoryEnum struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The permitted values for this profile field. + Values []int64 `json:"values" validate:"required"` +} + +// Constants associated with the DedicatedHostProfileMemoryEnum.Type property. +// The type for this profile field. +const ( + DedicatedHostProfileMemoryEnumTypeEnumConst = "enum" +) + +func (*DedicatedHostProfileMemoryEnum) isaDedicatedHostProfileMemory() bool { + return true +} + +// UnmarshalDedicatedHostProfileMemoryEnum unmarshals an instance of DedicatedHostProfileMemoryEnum from the specified map of raw messages. +func UnmarshalDedicatedHostProfileMemoryEnum(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostProfileMemoryEnum) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostProfileMemoryFixed : The memory (in gibibytes) for a dedicated host with this profile. +// This model "extends" DedicatedHostProfileMemory +type DedicatedHostProfileMemoryFixed struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The value for this profile field. + Value *int64 `json:"value" validate:"required"` +} + +// Constants associated with the DedicatedHostProfileMemoryFixed.Type property. +// The type for this profile field. +const ( + DedicatedHostProfileMemoryFixedTypeFixedConst = "fixed" +) + +func (*DedicatedHostProfileMemoryFixed) isaDedicatedHostProfileMemory() bool { + return true +} + +// UnmarshalDedicatedHostProfileMemoryFixed unmarshals an instance of DedicatedHostProfileMemoryFixed from the specified map of raw messages. +func UnmarshalDedicatedHostProfileMemoryFixed(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostProfileMemoryFixed) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostProfileMemoryRange : The permitted memory range (in gibibytes) for a dedicated host with this profile. +// This model "extends" DedicatedHostProfileMemory +type DedicatedHostProfileMemoryRange struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The maximum value for this profile field. + Max *int64 `json:"max" validate:"required"` + + // The minimum value for this profile field. + Min *int64 `json:"min" validate:"required"` + + // The increment step value for this profile field. + Step *int64 `json:"step" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the DedicatedHostProfileMemoryRange.Type property. +// The type for this profile field. +const ( + DedicatedHostProfileMemoryRangeTypeRangeConst = "range" +) + +func (*DedicatedHostProfileMemoryRange) isaDedicatedHostProfileMemory() bool { + return true +} + +// UnmarshalDedicatedHostProfileMemoryRange unmarshals an instance of DedicatedHostProfileMemoryRange from the specified map of raw messages. +func UnmarshalDedicatedHostProfileMemoryRange(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostProfileMemoryRange) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostProfileSocketDependent : The CPU socket count for a dedicated host with this profile depends on its configuration. +// This model "extends" DedicatedHostProfileSocket +type DedicatedHostProfileSocketDependent struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the DedicatedHostProfileSocketDependent.Type property. +// The type for this profile field. +const ( + DedicatedHostProfileSocketDependentTypeDependentConst = "dependent" +) + +func (*DedicatedHostProfileSocketDependent) isaDedicatedHostProfileSocket() bool { + return true +} + +// UnmarshalDedicatedHostProfileSocketDependent unmarshals an instance of DedicatedHostProfileSocketDependent from the specified map of raw messages. +func UnmarshalDedicatedHostProfileSocketDependent(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostProfileSocketDependent) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostProfileSocketEnum : The permitted values for CPU socket count for a dedicated host with this profile. +// This model "extends" DedicatedHostProfileSocket +type DedicatedHostProfileSocketEnum struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The permitted values for this profile field. + Values []int64 `json:"values" validate:"required"` +} + +// Constants associated with the DedicatedHostProfileSocketEnum.Type property. +// The type for this profile field. +const ( + DedicatedHostProfileSocketEnumTypeEnumConst = "enum" +) + +func (*DedicatedHostProfileSocketEnum) isaDedicatedHostProfileSocket() bool { + return true +} + +// UnmarshalDedicatedHostProfileSocketEnum unmarshals an instance of DedicatedHostProfileSocketEnum from the specified map of raw messages. +func UnmarshalDedicatedHostProfileSocketEnum(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostProfileSocketEnum) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostProfileSocketFixed : The CPU socket count for a dedicated host with this profile. +// This model "extends" DedicatedHostProfileSocket +type DedicatedHostProfileSocketFixed struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The value for this profile field. + Value *int64 `json:"value" validate:"required"` +} + +// Constants associated with the DedicatedHostProfileSocketFixed.Type property. +// The type for this profile field. +const ( + DedicatedHostProfileSocketFixedTypeFixedConst = "fixed" +) + +func (*DedicatedHostProfileSocketFixed) isaDedicatedHostProfileSocket() bool { + return true +} + +// UnmarshalDedicatedHostProfileSocketFixed unmarshals an instance of DedicatedHostProfileSocketFixed from the specified map of raw messages. +func UnmarshalDedicatedHostProfileSocketFixed(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostProfileSocketFixed) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostProfileSocketRange : The permitted range for CPU socket count for a dedicated host with this profile. +// This model "extends" DedicatedHostProfileSocket +type DedicatedHostProfileSocketRange struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The maximum value for this profile field. + Max *int64 `json:"max" validate:"required"` + + // The minimum value for this profile field. + Min *int64 `json:"min" validate:"required"` + + // The increment step value for this profile field. + Step *int64 `json:"step" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the DedicatedHostProfileSocketRange.Type property. +// The type for this profile field. +const ( + DedicatedHostProfileSocketRangeTypeRangeConst = "range" +) + +func (*DedicatedHostProfileSocketRange) isaDedicatedHostProfileSocket() bool { + return true +} + +// UnmarshalDedicatedHostProfileSocketRange unmarshals an instance of DedicatedHostProfileSocketRange from the specified map of raw messages. +func UnmarshalDedicatedHostProfileSocketRange(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostProfileSocketRange) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostProfileVcpuDependent : The VCPU count for a dedicated host with this profile depends on its configuration. +// This model "extends" DedicatedHostProfileVcpu +type DedicatedHostProfileVcpuDependent struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the DedicatedHostProfileVcpuDependent.Type property. +// The type for this profile field. +const ( + DedicatedHostProfileVcpuDependentTypeDependentConst = "dependent" +) + +func (*DedicatedHostProfileVcpuDependent) isaDedicatedHostProfileVcpu() bool { + return true +} + +// UnmarshalDedicatedHostProfileVcpuDependent unmarshals an instance of DedicatedHostProfileVcpuDependent from the specified map of raw messages. +func UnmarshalDedicatedHostProfileVcpuDependent(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostProfileVcpuDependent) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostProfileVcpuEnum : The permitted values for VCPU count for a dedicated host with this profile. +// This model "extends" DedicatedHostProfileVcpu +type DedicatedHostProfileVcpuEnum struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The permitted values for this profile field. + Values []int64 `json:"values" validate:"required"` +} + +// Constants associated with the DedicatedHostProfileVcpuEnum.Type property. +// The type for this profile field. +const ( + DedicatedHostProfileVcpuEnumTypeEnumConst = "enum" +) + +func (*DedicatedHostProfileVcpuEnum) isaDedicatedHostProfileVcpu() bool { + return true +} + +// UnmarshalDedicatedHostProfileVcpuEnum unmarshals an instance of DedicatedHostProfileVcpuEnum from the specified map of raw messages. +func UnmarshalDedicatedHostProfileVcpuEnum(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostProfileVcpuEnum) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostProfileVcpuFixed : The VCPU count for a dedicated host with this profile. +// This model "extends" DedicatedHostProfileVcpu +type DedicatedHostProfileVcpuFixed struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The value for this profile field. + Value *int64 `json:"value" validate:"required"` +} + +// Constants associated with the DedicatedHostProfileVcpuFixed.Type property. +// The type for this profile field. +const ( + DedicatedHostProfileVcpuFixedTypeFixedConst = "fixed" +) + +func (*DedicatedHostProfileVcpuFixed) isaDedicatedHostProfileVcpu() bool { + return true +} + +// UnmarshalDedicatedHostProfileVcpuFixed unmarshals an instance of DedicatedHostProfileVcpuFixed from the specified map of raw messages. +func UnmarshalDedicatedHostProfileVcpuFixed(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostProfileVcpuFixed) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostProfileVcpuRange : The permitted range for VCPU count for a dedicated host with this profile. +// This model "extends" DedicatedHostProfileVcpu +type DedicatedHostProfileVcpuRange struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The maximum value for this profile field. + Max *int64 `json:"max" validate:"required"` + + // The minimum value for this profile field. + Min *int64 `json:"min" validate:"required"` + + // The increment step value for this profile field. + Step *int64 `json:"step" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the DedicatedHostProfileVcpuRange.Type property. +// The type for this profile field. +const ( + DedicatedHostProfileVcpuRangeTypeRangeConst = "range" +) + +func (*DedicatedHostProfileVcpuRange) isaDedicatedHostProfileVcpu() bool { + return true +} + +// UnmarshalDedicatedHostProfileVcpuRange unmarshals an instance of DedicatedHostProfileVcpuRange from the specified map of raw messages. +func UnmarshalDedicatedHostProfileVcpuRange(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostProfileVcpuRange) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostPrototypeDedicatedHostByGroup : DedicatedHostPrototypeDedicatedHostByGroup struct +// This model "extends" DedicatedHostPrototype +type DedicatedHostPrototypeDedicatedHostByGroup struct { + // If set to true, instances can be placed on this dedicated host. + InstancePlacementEnabled *bool `json:"instance_placement_enabled,omitempty"` + + // The name for this dedicated host. The name must not be used by another dedicated host in the region. If unspecified, + // the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-dh-profiles) to use for this dedicated host. + Profile DedicatedHostProfileIdentityIntf `json:"profile" validate:"required"` + + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The dedicated host group for this dedicated host. + Group DedicatedHostGroupIdentityIntf `json:"group" validate:"required"` +} + +// NewDedicatedHostPrototypeDedicatedHostByGroup : Instantiate DedicatedHostPrototypeDedicatedHostByGroup (Generic Model Constructor) +func (*VpcV1) NewDedicatedHostPrototypeDedicatedHostByGroup(profile DedicatedHostProfileIdentityIntf, group DedicatedHostGroupIdentityIntf) (_model *DedicatedHostPrototypeDedicatedHostByGroup, err error) { + _model = &DedicatedHostPrototypeDedicatedHostByGroup{ + Profile: profile, + Group: group, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*DedicatedHostPrototypeDedicatedHostByGroup) isaDedicatedHostPrototype() bool { + return true +} + +// UnmarshalDedicatedHostPrototypeDedicatedHostByGroup unmarshals an instance of DedicatedHostPrototypeDedicatedHostByGroup from the specified map of raw messages. +func UnmarshalDedicatedHostPrototypeDedicatedHostByGroup(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostPrototypeDedicatedHostByGroup) + err = core.UnmarshalPrimitive(m, "instance_placement_enabled", &obj.InstancePlacementEnabled) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalDedicatedHostProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "group", &obj.Group, UnmarshalDedicatedHostGroupIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// DedicatedHostPrototypeDedicatedHostByZone : DedicatedHostPrototypeDedicatedHostByZone struct +// This model "extends" DedicatedHostPrototype +type DedicatedHostPrototypeDedicatedHostByZone struct { + // If set to true, instances can be placed on this dedicated host. + InstancePlacementEnabled *bool `json:"instance_placement_enabled,omitempty"` + + // The name for this dedicated host. The name must not be used by another dedicated host in the region. If unspecified, + // the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-dh-profiles) to use for this dedicated host. + Profile DedicatedHostProfileIdentityIntf `json:"profile" validate:"required"` + + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + Group *DedicatedHostGroupPrototypeDedicatedHostByZoneContext `json:"group,omitempty"` + + // The zone this dedicated host will reside in. + Zone ZoneIdentityIntf `json:"zone" validate:"required"` +} + +// NewDedicatedHostPrototypeDedicatedHostByZone : Instantiate DedicatedHostPrototypeDedicatedHostByZone (Generic Model Constructor) +func (*VpcV1) NewDedicatedHostPrototypeDedicatedHostByZone(profile DedicatedHostProfileIdentityIntf, zone ZoneIdentityIntf) (_model *DedicatedHostPrototypeDedicatedHostByZone, err error) { + _model = &DedicatedHostPrototypeDedicatedHostByZone{ + Profile: profile, + Zone: zone, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*DedicatedHostPrototypeDedicatedHostByZone) isaDedicatedHostPrototype() bool { + return true +} + +// UnmarshalDedicatedHostPrototypeDedicatedHostByZone unmarshals an instance of DedicatedHostPrototypeDedicatedHostByZone from the specified map of raw messages. +func UnmarshalDedicatedHostPrototypeDedicatedHostByZone(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(DedicatedHostPrototypeDedicatedHostByZone) + err = core.UnmarshalPrimitive(m, "instance_placement_enabled", &obj.InstancePlacementEnabled) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalDedicatedHostProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "group", &obj.Group, UnmarshalDedicatedHostGroupPrototypeDedicatedHostByZoneContext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// EncryptionKeyIdentityByCRN : EncryptionKeyIdentityByCRN struct +// This model "extends" EncryptionKeyIdentity +type EncryptionKeyIdentityByCRN struct { + // The CRN of the [Key Protect Root + // Key](https://cloud.ibm.com/docs/key-protect?topic=key-protect-getting-started-tutorial) or [Hyper Protect Crypto + // Services Root Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started) for this resource. + CRN *string `json:"crn" validate:"required"` +} + +// NewEncryptionKeyIdentityByCRN : Instantiate EncryptionKeyIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewEncryptionKeyIdentityByCRN(crn string) (_model *EncryptionKeyIdentityByCRN, err error) { + _model = &EncryptionKeyIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*EncryptionKeyIdentityByCRN) isaEncryptionKeyIdentity() bool { + return true +} + +// UnmarshalEncryptionKeyIdentityByCRN unmarshals an instance of EncryptionKeyIdentityByCRN from the specified map of raw messages. +func UnmarshalEncryptionKeyIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(EncryptionKeyIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// EndpointGatewayReservedIPReservedIPIdentity : Identifies a reserved IP by a unique property. +// Models which "extend" this model: +// - EndpointGatewayReservedIPReservedIPIdentityByID +// - EndpointGatewayReservedIPReservedIPIdentityByHref +// This model "extends" EndpointGatewayReservedIP +type EndpointGatewayReservedIPReservedIPIdentity struct { + // The unique identifier for this reserved IP. + ID *string `json:"id,omitempty"` + + // The URL for this reserved IP. + Href *string `json:"href,omitempty"` +} + +func (*EndpointGatewayReservedIPReservedIPIdentity) isaEndpointGatewayReservedIPReservedIPIdentity() bool { + return true +} + +type EndpointGatewayReservedIPReservedIPIdentityIntf interface { + EndpointGatewayReservedIPIntf + isaEndpointGatewayReservedIPReservedIPIdentity() bool +} + +func (*EndpointGatewayReservedIPReservedIPIdentity) isaEndpointGatewayReservedIP() bool { + return true +} + +// UnmarshalEndpointGatewayReservedIPReservedIPIdentity unmarshals an instance of EndpointGatewayReservedIPReservedIPIdentity from the specified map of raw messages. +func UnmarshalEndpointGatewayReservedIPReservedIPIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(EndpointGatewayReservedIPReservedIPIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// EndpointGatewayReservedIPReservedIPPrototypeTargetContext : EndpointGatewayReservedIPReservedIPPrototypeTargetContext struct +// This model "extends" EndpointGatewayReservedIP +type EndpointGatewayReservedIPReservedIPPrototypeTargetContext struct { + // The IP address to reserve, which must not already be reserved on the subnet. + // + // If unspecified, an available address on the subnet will automatically be selected. + Address *string `json:"address,omitempty"` + + // Indicates whether this reserved IP member will be automatically deleted when either + // `target` is deleted, or the reserved IP is unbound. + AutoDelete *bool `json:"auto_delete,omitempty"` + + // The name for this reserved IP. The name must not be used by another reserved IP in the subnet. Names starting with + // `ibm-` are reserved for provider-owned resources, and are not allowed. If unspecified, the name will be a hyphenated + // list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The subnet in which to create this reserved IP. + Subnet SubnetIdentityIntf `json:"subnet" validate:"required"` +} + +// NewEndpointGatewayReservedIPReservedIPPrototypeTargetContext : Instantiate EndpointGatewayReservedIPReservedIPPrototypeTargetContext (Generic Model Constructor) +func (*VpcV1) NewEndpointGatewayReservedIPReservedIPPrototypeTargetContext(subnet SubnetIdentityIntf) (_model *EndpointGatewayReservedIPReservedIPPrototypeTargetContext, err error) { + _model = &EndpointGatewayReservedIPReservedIPPrototypeTargetContext{ + Subnet: subnet, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*EndpointGatewayReservedIPReservedIPPrototypeTargetContext) isaEndpointGatewayReservedIP() bool { + return true +} + +// UnmarshalEndpointGatewayReservedIPReservedIPPrototypeTargetContext unmarshals an instance of EndpointGatewayReservedIPReservedIPPrototypeTargetContext from the specified map of raw messages. +func UnmarshalEndpointGatewayReservedIPReservedIPPrototypeTargetContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(EndpointGatewayReservedIPReservedIPPrototypeTargetContext) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "auto_delete", &obj.AutoDelete) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnet", &obj.Subnet, UnmarshalSubnetIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// EndpointGatewayTargetPrototypeProviderCloudServiceIdentity : EndpointGatewayTargetPrototypeProviderCloudServiceIdentity struct +// Models which "extend" this model: +// - EndpointGatewayTargetPrototypeProviderCloudServiceIdentityProviderCloudServiceIdentityByCRN +// This model "extends" EndpointGatewayTargetPrototype +type EndpointGatewayTargetPrototypeProviderCloudServiceIdentity struct { + // The type of target for this endpoint gateway. + ResourceType *string `json:"resource_type" validate:"required"` + + // The CRN for this provider cloud service, or the CRN for the user's instance of a provider cloud service. + CRN *string `json:"crn,omitempty"` +} + +// Constants associated with the EndpointGatewayTargetPrototypeProviderCloudServiceIdentity.ResourceType property. +// The type of target for this endpoint gateway. +const ( + EndpointGatewayTargetPrototypeProviderCloudServiceIdentityResourceTypeProviderCloudServiceConst = "provider_cloud_service" + EndpointGatewayTargetPrototypeProviderCloudServiceIdentityResourceTypeProviderInfrastructureServiceConst = "provider_infrastructure_service" +) + +func (*EndpointGatewayTargetPrototypeProviderCloudServiceIdentity) isaEndpointGatewayTargetPrototypeProviderCloudServiceIdentity() bool { + return true +} + +type EndpointGatewayTargetPrototypeProviderCloudServiceIdentityIntf interface { + EndpointGatewayTargetPrototypeIntf + isaEndpointGatewayTargetPrototypeProviderCloudServiceIdentity() bool +} + +func (*EndpointGatewayTargetPrototypeProviderCloudServiceIdentity) isaEndpointGatewayTargetPrototype() bool { + return true +} + +// UnmarshalEndpointGatewayTargetPrototypeProviderCloudServiceIdentity unmarshals an instance of EndpointGatewayTargetPrototypeProviderCloudServiceIdentity from the specified map of raw messages. +func UnmarshalEndpointGatewayTargetPrototypeProviderCloudServiceIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(EndpointGatewayTargetPrototypeProviderCloudServiceIdentity) + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// EndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentity : EndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentity struct +// Models which "extend" this model: +// - EndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentityProviderInfrastructureServiceIdentityByName +// This model "extends" EndpointGatewayTargetPrototype +type EndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentity struct { + // The type of target for this endpoint gateway. + ResourceType *string `json:"resource_type" validate:"required"` + + // The name of a provider infrastructure service. Must be: + // - `ibm-ntp-server`: An NTP (Network Time Protocol) server provided by IBM. + Name *string `json:"name,omitempty"` +} + +// Constants associated with the EndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentity.ResourceType property. +// The type of target for this endpoint gateway. +const ( + EndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentityResourceTypeProviderCloudServiceConst = "provider_cloud_service" + EndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentityResourceTypeProviderInfrastructureServiceConst = "provider_infrastructure_service" +) + +func (*EndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentity) isaEndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentity() bool { + return true +} + +type EndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentityIntf interface { + EndpointGatewayTargetPrototypeIntf + isaEndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentity() bool +} + +func (*EndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentity) isaEndpointGatewayTargetPrototype() bool { + return true +} + +// UnmarshalEndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentity unmarshals an instance of EndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentity from the specified map of raw messages. +func UnmarshalEndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(EndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentity) + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// EndpointGatewayTargetProviderCloudServiceReference : EndpointGatewayTargetProviderCloudServiceReference struct +// This model "extends" EndpointGatewayTarget +type EndpointGatewayTargetProviderCloudServiceReference struct { + // The CRN for this provider cloud service, or the CRN for the user's instance of a provider cloud service. + CRN *string `json:"crn" validate:"required"` + + // The type of target. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the EndpointGatewayTargetProviderCloudServiceReference.ResourceType property. +// The type of target. +const ( + EndpointGatewayTargetProviderCloudServiceReferenceResourceTypeProviderCloudServiceConst = "provider_cloud_service" +) + +func (*EndpointGatewayTargetProviderCloudServiceReference) isaEndpointGatewayTarget() bool { + return true +} + +// UnmarshalEndpointGatewayTargetProviderCloudServiceReference unmarshals an instance of EndpointGatewayTargetProviderCloudServiceReference from the specified map of raw messages. +func UnmarshalEndpointGatewayTargetProviderCloudServiceReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(EndpointGatewayTargetProviderCloudServiceReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// EndpointGatewayTargetProviderInfrastructureServiceReference : The name of this provider infrastructure service. +// This model "extends" EndpointGatewayTarget +type EndpointGatewayTargetProviderInfrastructureServiceReference struct { + // The name of a provider infrastructure service. Must be: + // - `ibm-ntp-server`: An NTP (Network Time Protocol) server provided by IBM. + Name *string `json:"name" validate:"required"` + + // The type of target. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the EndpointGatewayTargetProviderInfrastructureServiceReference.ResourceType property. +// The type of target. +const ( + EndpointGatewayTargetProviderInfrastructureServiceReferenceResourceTypeProviderInfrastructureServiceConst = "provider_infrastructure_service" +) + +func (*EndpointGatewayTargetProviderInfrastructureServiceReference) isaEndpointGatewayTarget() bool { + return true +} + +// UnmarshalEndpointGatewayTargetProviderInfrastructureServiceReference unmarshals an instance of EndpointGatewayTargetProviderInfrastructureServiceReference from the specified map of raw messages. +func UnmarshalEndpointGatewayTargetProviderInfrastructureServiceReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(EndpointGatewayTargetProviderInfrastructureServiceReference) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FloatingIPPrototypeFloatingIPByTarget : FloatingIPPrototypeFloatingIPByTarget struct +// This model "extends" FloatingIPPrototype +type FloatingIPPrototypeFloatingIPByTarget struct { + // The name for this floating IP. The name must not be used by another floating IP in the region. If unspecified, the + // name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The target resource to bind this floating IP to. + // + // The target resource must not already have a floating IP bound to it if the target + // resource is: + // + // - an instance network interface + // - a bare metal server network interface with `enable_infrastructure_nat` set to `true`. + Target FloatingIPTargetPrototypeIntf `json:"target" validate:"required"` +} + +// NewFloatingIPPrototypeFloatingIPByTarget : Instantiate FloatingIPPrototypeFloatingIPByTarget (Generic Model Constructor) +func (*VpcV1) NewFloatingIPPrototypeFloatingIPByTarget(target FloatingIPTargetPrototypeIntf) (_model *FloatingIPPrototypeFloatingIPByTarget, err error) { + _model = &FloatingIPPrototypeFloatingIPByTarget{ + Target: target, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*FloatingIPPrototypeFloatingIPByTarget) isaFloatingIPPrototype() bool { + return true +} + +// UnmarshalFloatingIPPrototypeFloatingIPByTarget unmarshals an instance of FloatingIPPrototypeFloatingIPByTarget from the specified map of raw messages. +func UnmarshalFloatingIPPrototypeFloatingIPByTarget(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FloatingIPPrototypeFloatingIPByTarget) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "target", &obj.Target, UnmarshalFloatingIPTargetPrototype) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FloatingIPPrototypeFloatingIPByZone : FloatingIPPrototypeFloatingIPByZone struct +// This model "extends" FloatingIPPrototype +type FloatingIPPrototypeFloatingIPByZone struct { + // The name for this floating IP. The name must not be used by another floating IP in the region. If unspecified, the + // name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The zone this floating IP will reside in. + Zone ZoneIdentityIntf `json:"zone" validate:"required"` +} + +// NewFloatingIPPrototypeFloatingIPByZone : Instantiate FloatingIPPrototypeFloatingIPByZone (Generic Model Constructor) +func (*VpcV1) NewFloatingIPPrototypeFloatingIPByZone(zone ZoneIdentityIntf) (_model *FloatingIPPrototypeFloatingIPByZone, err error) { + _model = &FloatingIPPrototypeFloatingIPByZone{ + Zone: zone, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*FloatingIPPrototypeFloatingIPByZone) isaFloatingIPPrototype() bool { + return true +} + +// UnmarshalFloatingIPPrototypeFloatingIPByZone unmarshals an instance of FloatingIPPrototypeFloatingIPByZone from the specified map of raw messages. +func UnmarshalFloatingIPPrototypeFloatingIPByZone(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FloatingIPPrototypeFloatingIPByZone) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentity : Identifies a bare metal server network interface by a unique property. +// Models which "extend" this model: +// - FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByID +// - FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByHref +// This model "extends" FloatingIPTargetPatch +type FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentity struct { + // The unique identifier for this bare metal server network interface. + ID *string `json:"id,omitempty"` + + // The URL for this bare metal server network interface. + Href *string `json:"href,omitempty"` +} + +func (*FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentity) isaFloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentity() bool { + return true +} + +type FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityIntf interface { + FloatingIPTargetPatchIntf + isaFloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentity() bool +} + +func (*FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentity) isaFloatingIPTargetPatch() bool { + return true +} + +// UnmarshalFloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentity unmarshals an instance of FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentity from the specified map of raw messages. +func UnmarshalFloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FloatingIPTargetPatchNetworkInterfaceIdentity : Identifies an instance network interface by a unique property. +// Models which "extend" this model: +// - FloatingIPTargetPatchNetworkInterfaceIdentityNetworkInterfaceIdentityByID +// - FloatingIPTargetPatchNetworkInterfaceIdentityNetworkInterfaceIdentityByHref +// This model "extends" FloatingIPTargetPatch +type FloatingIPTargetPatchNetworkInterfaceIdentity struct { + // The unique identifier for this instance network interface. + ID *string `json:"id,omitempty"` + + // The URL for this instance network interface. + Href *string `json:"href,omitempty"` +} + +func (*FloatingIPTargetPatchNetworkInterfaceIdentity) isaFloatingIPTargetPatchNetworkInterfaceIdentity() bool { + return true +} + +type FloatingIPTargetPatchNetworkInterfaceIdentityIntf interface { + FloatingIPTargetPatchIntf + isaFloatingIPTargetPatchNetworkInterfaceIdentity() bool +} + +func (*FloatingIPTargetPatchNetworkInterfaceIdentity) isaFloatingIPTargetPatch() bool { + return true +} + +// UnmarshalFloatingIPTargetPatchNetworkInterfaceIdentity unmarshals an instance of FloatingIPTargetPatchNetworkInterfaceIdentity from the specified map of raw messages. +func UnmarshalFloatingIPTargetPatchNetworkInterfaceIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FloatingIPTargetPatchNetworkInterfaceIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentity : Identifies a bare metal server network interface by a unique property. +// Models which "extend" this model: +// - FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByID +// - FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByHref +// This model "extends" FloatingIPTargetPrototype +type FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentity struct { + // The unique identifier for this bare metal server network interface. + ID *string `json:"id,omitempty"` + + // The URL for this bare metal server network interface. + Href *string `json:"href,omitempty"` +} + +func (*FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentity) isaFloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentity() bool { + return true +} + +type FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityIntf interface { + FloatingIPTargetPrototypeIntf + isaFloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentity() bool +} + +func (*FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentity) isaFloatingIPTargetPrototype() bool { + return true +} + +// UnmarshalFloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentity unmarshals an instance of FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentity from the specified map of raw messages. +func UnmarshalFloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FloatingIPTargetPrototypeNetworkInterfaceIdentity : Identifies an instance network interface by a unique property. +// Models which "extend" this model: +// - FloatingIPTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByID +// - FloatingIPTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByHref +// This model "extends" FloatingIPTargetPrototype +type FloatingIPTargetPrototypeNetworkInterfaceIdentity struct { + // The unique identifier for this instance network interface. + ID *string `json:"id,omitempty"` + + // The URL for this instance network interface. + Href *string `json:"href,omitempty"` +} + +func (*FloatingIPTargetPrototypeNetworkInterfaceIdentity) isaFloatingIPTargetPrototypeNetworkInterfaceIdentity() bool { + return true +} + +type FloatingIPTargetPrototypeNetworkInterfaceIdentityIntf interface { + FloatingIPTargetPrototypeIntf + isaFloatingIPTargetPrototypeNetworkInterfaceIdentity() bool +} + +func (*FloatingIPTargetPrototypeNetworkInterfaceIdentity) isaFloatingIPTargetPrototype() bool { + return true +} + +// UnmarshalFloatingIPTargetPrototypeNetworkInterfaceIdentity unmarshals an instance of FloatingIPTargetPrototypeNetworkInterfaceIdentity from the specified map of raw messages. +func UnmarshalFloatingIPTargetPrototypeNetworkInterfaceIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FloatingIPTargetPrototypeNetworkInterfaceIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FloatingIPTargetBareMetalServerNetworkInterfaceReference : FloatingIPTargetBareMetalServerNetworkInterfaceReference struct +// This model "extends" FloatingIPTarget +type FloatingIPTargetBareMetalServerNetworkInterfaceReference struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *BareMetalServerNetworkInterfaceReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this bare metal server network interface. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this bare metal server network interface. + ID *string `json:"id" validate:"required"` + + // The name for this bare metal server network interface. + Name *string `json:"name" validate:"required"` + + PrimaryIP *ReservedIPReference `json:"primary_ip" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the FloatingIPTargetBareMetalServerNetworkInterfaceReference.ResourceType property. +// The resource type. +const ( + FloatingIPTargetBareMetalServerNetworkInterfaceReferenceResourceTypeNetworkInterfaceConst = "network_interface" +) + +func (*FloatingIPTargetBareMetalServerNetworkInterfaceReference) isaFloatingIPTarget() bool { + return true +} + +// UnmarshalFloatingIPTargetBareMetalServerNetworkInterfaceReference unmarshals an instance of FloatingIPTargetBareMetalServerNetworkInterfaceReference from the specified map of raw messages. +func UnmarshalFloatingIPTargetBareMetalServerNetworkInterfaceReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FloatingIPTargetBareMetalServerNetworkInterfaceReference) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalBareMetalServerNetworkInterfaceReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_ip", &obj.PrimaryIP, UnmarshalReservedIPReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FloatingIPTargetNetworkInterfaceReference : FloatingIPTargetNetworkInterfaceReference struct +// This model "extends" FloatingIPTarget +type FloatingIPTargetNetworkInterfaceReference struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *NetworkInterfaceReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this instance network interface. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this instance network interface. + ID *string `json:"id" validate:"required"` + + // The name for this instance network interface. + Name *string `json:"name" validate:"required"` + + PrimaryIP *ReservedIPReference `json:"primary_ip" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the FloatingIPTargetNetworkInterfaceReference.ResourceType property. +// The resource type. +const ( + FloatingIPTargetNetworkInterfaceReferenceResourceTypeNetworkInterfaceConst = "network_interface" +) + +func (*FloatingIPTargetNetworkInterfaceReference) isaFloatingIPTarget() bool { + return true +} + +// UnmarshalFloatingIPTargetNetworkInterfaceReference unmarshals an instance of FloatingIPTargetNetworkInterfaceReference from the specified map of raw messages. +func UnmarshalFloatingIPTargetNetworkInterfaceReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FloatingIPTargetNetworkInterfaceReference) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalNetworkInterfaceReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_ip", &obj.PrimaryIP, UnmarshalReservedIPReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FloatingIPTargetPublicGatewayReference : FloatingIPTargetPublicGatewayReference struct +// This model "extends" FloatingIPTarget +type FloatingIPTargetPublicGatewayReference struct { + // The CRN for this public gateway. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *PublicGatewayReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this public gateway. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this public gateway. + ID *string `json:"id" validate:"required"` + + // The name for this public gateway. The name is unique across all public gateways in the VPC. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the FloatingIPTargetPublicGatewayReference.ResourceType property. +// The resource type. +const ( + FloatingIPTargetPublicGatewayReferenceResourceTypePublicGatewayConst = "public_gateway" +) + +func (*FloatingIPTargetPublicGatewayReference) isaFloatingIPTarget() bool { + return true +} + +// UnmarshalFloatingIPTargetPublicGatewayReference unmarshals an instance of FloatingIPTargetPublicGatewayReference from the specified map of raw messages. +func UnmarshalFloatingIPTargetPublicGatewayReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FloatingIPTargetPublicGatewayReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalPublicGatewayReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FlowLogCollectorTargetPrototypeInstanceIdentity : Identifies a virtual server instance by a unique property. +// Models which "extend" this model: +// - FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByID +// - FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByCRN +// - FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByHref +// This model "extends" FlowLogCollectorTargetPrototype +type FlowLogCollectorTargetPrototypeInstanceIdentity struct { + // The unique identifier for this virtual server instance. + ID *string `json:"id,omitempty"` + + // The CRN for this virtual server instance. + CRN *string `json:"crn,omitempty"` + + // The URL for this virtual server instance. + Href *string `json:"href,omitempty"` +} + +func (*FlowLogCollectorTargetPrototypeInstanceIdentity) isaFlowLogCollectorTargetPrototypeInstanceIdentity() bool { + return true +} + +type FlowLogCollectorTargetPrototypeInstanceIdentityIntf interface { + FlowLogCollectorTargetPrototypeIntf + isaFlowLogCollectorTargetPrototypeInstanceIdentity() bool +} + +func (*FlowLogCollectorTargetPrototypeInstanceIdentity) isaFlowLogCollectorTargetPrototype() bool { + return true +} + +// UnmarshalFlowLogCollectorTargetPrototypeInstanceIdentity unmarshals an instance of FlowLogCollectorTargetPrototypeInstanceIdentity from the specified map of raw messages. +func UnmarshalFlowLogCollectorTargetPrototypeInstanceIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FlowLogCollectorTargetPrototypeInstanceIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FlowLogCollectorTargetPrototypeNetworkInterfaceIdentity : Identifies an instance network interface by a unique property. +// Models which "extend" this model: +// - FlowLogCollectorTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByID +// - FlowLogCollectorTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByHref +// This model "extends" FlowLogCollectorTargetPrototype +type FlowLogCollectorTargetPrototypeNetworkInterfaceIdentity struct { + // The unique identifier for this instance network interface. + ID *string `json:"id,omitempty"` + + // The URL for this instance network interface. + Href *string `json:"href,omitempty"` +} + +func (*FlowLogCollectorTargetPrototypeNetworkInterfaceIdentity) isaFlowLogCollectorTargetPrototypeNetworkInterfaceIdentity() bool { + return true +} + +type FlowLogCollectorTargetPrototypeNetworkInterfaceIdentityIntf interface { + FlowLogCollectorTargetPrototypeIntf + isaFlowLogCollectorTargetPrototypeNetworkInterfaceIdentity() bool +} + +func (*FlowLogCollectorTargetPrototypeNetworkInterfaceIdentity) isaFlowLogCollectorTargetPrototype() bool { + return true +} + +// UnmarshalFlowLogCollectorTargetPrototypeNetworkInterfaceIdentity unmarshals an instance of FlowLogCollectorTargetPrototypeNetworkInterfaceIdentity from the specified map of raw messages. +func UnmarshalFlowLogCollectorTargetPrototypeNetworkInterfaceIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FlowLogCollectorTargetPrototypeNetworkInterfaceIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FlowLogCollectorTargetPrototypeSubnetIdentity : Identifies a subnet by a unique property. +// Models which "extend" this model: +// - FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByID +// - FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByCRN +// - FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByHref +// This model "extends" FlowLogCollectorTargetPrototype +type FlowLogCollectorTargetPrototypeSubnetIdentity struct { + // The unique identifier for this subnet. + ID *string `json:"id,omitempty"` + + // The CRN for this subnet. + CRN *string `json:"crn,omitempty"` + + // The URL for this subnet. + Href *string `json:"href,omitempty"` +} + +func (*FlowLogCollectorTargetPrototypeSubnetIdentity) isaFlowLogCollectorTargetPrototypeSubnetIdentity() bool { + return true +} + +type FlowLogCollectorTargetPrototypeSubnetIdentityIntf interface { + FlowLogCollectorTargetPrototypeIntf + isaFlowLogCollectorTargetPrototypeSubnetIdentity() bool +} + +func (*FlowLogCollectorTargetPrototypeSubnetIdentity) isaFlowLogCollectorTargetPrototype() bool { + return true +} + +// UnmarshalFlowLogCollectorTargetPrototypeSubnetIdentity unmarshals an instance of FlowLogCollectorTargetPrototypeSubnetIdentity from the specified map of raw messages. +func UnmarshalFlowLogCollectorTargetPrototypeSubnetIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FlowLogCollectorTargetPrototypeSubnetIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FlowLogCollectorTargetPrototypeVPCIdentity : Identifies a VPC by a unique property. +// Models which "extend" this model: +// - FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByID +// - FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByCRN +// - FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByHref +// This model "extends" FlowLogCollectorTargetPrototype +type FlowLogCollectorTargetPrototypeVPCIdentity struct { + // The unique identifier for this VPC. + ID *string `json:"id,omitempty"` + + // The CRN for this VPC. + CRN *string `json:"crn,omitempty"` + + // The URL for this VPC. + Href *string `json:"href,omitempty"` +} + +func (*FlowLogCollectorTargetPrototypeVPCIdentity) isaFlowLogCollectorTargetPrototypeVPCIdentity() bool { + return true +} + +type FlowLogCollectorTargetPrototypeVPCIdentityIntf interface { + FlowLogCollectorTargetPrototypeIntf + isaFlowLogCollectorTargetPrototypeVPCIdentity() bool +} + +func (*FlowLogCollectorTargetPrototypeVPCIdentity) isaFlowLogCollectorTargetPrototype() bool { + return true +} + +// UnmarshalFlowLogCollectorTargetPrototypeVPCIdentity unmarshals an instance of FlowLogCollectorTargetPrototypeVPCIdentity from the specified map of raw messages. +func UnmarshalFlowLogCollectorTargetPrototypeVPCIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FlowLogCollectorTargetPrototypeVPCIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FlowLogCollectorTargetInstanceReference : FlowLogCollectorTargetInstanceReference struct +// This model "extends" FlowLogCollectorTarget +type FlowLogCollectorTargetInstanceReference struct { + // The CRN for this virtual server instance. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *InstanceReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this virtual server instance. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this virtual server instance. + ID *string `json:"id" validate:"required"` + + // The name for this virtual server instance. The name is unique across all virtual server instances in the region. + Name *string `json:"name" validate:"required"` +} + +func (*FlowLogCollectorTargetInstanceReference) isaFlowLogCollectorTarget() bool { + return true +} + +// UnmarshalFlowLogCollectorTargetInstanceReference unmarshals an instance of FlowLogCollectorTargetInstanceReference from the specified map of raw messages. +func UnmarshalFlowLogCollectorTargetInstanceReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FlowLogCollectorTargetInstanceReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalInstanceReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FlowLogCollectorTargetNetworkInterfaceReferenceTargetContext : FlowLogCollectorTargetNetworkInterfaceReferenceTargetContext struct +// This model "extends" FlowLogCollectorTarget +type FlowLogCollectorTargetNetworkInterfaceReferenceTargetContext struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *NetworkInterfaceReferenceTargetContextDeleted `json:"deleted,omitempty"` + + // The URL for this instance network interface. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this instance network interface. + ID *string `json:"id" validate:"required"` + + // The name for this instance network interface. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the FlowLogCollectorTargetNetworkInterfaceReferenceTargetContext.ResourceType property. +// The resource type. +const ( + FlowLogCollectorTargetNetworkInterfaceReferenceTargetContextResourceTypeNetworkInterfaceConst = "network_interface" +) + +func (*FlowLogCollectorTargetNetworkInterfaceReferenceTargetContext) isaFlowLogCollectorTarget() bool { + return true +} + +// UnmarshalFlowLogCollectorTargetNetworkInterfaceReferenceTargetContext unmarshals an instance of FlowLogCollectorTargetNetworkInterfaceReferenceTargetContext from the specified map of raw messages. +func UnmarshalFlowLogCollectorTargetNetworkInterfaceReferenceTargetContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FlowLogCollectorTargetNetworkInterfaceReferenceTargetContext) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalNetworkInterfaceReferenceTargetContextDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FlowLogCollectorTargetSubnetReference : FlowLogCollectorTargetSubnetReference struct +// This model "extends" FlowLogCollectorTarget +type FlowLogCollectorTargetSubnetReference struct { + // The CRN for this subnet. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *SubnetReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this subnet. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this subnet. + ID *string `json:"id" validate:"required"` + + // The name for this subnet. The name is unique across all subnets in the VPC. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the FlowLogCollectorTargetSubnetReference.ResourceType property. +// The resource type. +const ( + FlowLogCollectorTargetSubnetReferenceResourceTypeSubnetConst = "subnet" +) + +func (*FlowLogCollectorTargetSubnetReference) isaFlowLogCollectorTarget() bool { + return true +} + +// UnmarshalFlowLogCollectorTargetSubnetReference unmarshals an instance of FlowLogCollectorTargetSubnetReference from the specified map of raw messages. +func UnmarshalFlowLogCollectorTargetSubnetReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FlowLogCollectorTargetSubnetReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalSubnetReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FlowLogCollectorTargetVPCReference : FlowLogCollectorTargetVPCReference struct +// This model "extends" FlowLogCollectorTarget +type FlowLogCollectorTargetVPCReference struct { + // The CRN for this VPC. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *VPCReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this VPC. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this VPC. + ID *string `json:"id" validate:"required"` + + // The name for this VPC. The name is unique across all VPCs in the region. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the FlowLogCollectorTargetVPCReference.ResourceType property. +// The resource type. +const ( + FlowLogCollectorTargetVPCReferenceResourceTypeVPCConst = "vpc" +) + +func (*FlowLogCollectorTargetVPCReference) isaFlowLogCollectorTarget() bool { + return true +} + +// UnmarshalFlowLogCollectorTargetVPCReference unmarshals an instance of FlowLogCollectorTargetVPCReference from the specified map of raw messages. +func UnmarshalFlowLogCollectorTargetVPCReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FlowLogCollectorTargetVPCReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalVPCReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ImageIdentityByCRN : ImageIdentityByCRN struct +// This model "extends" ImageIdentity +type ImageIdentityByCRN struct { + // The CRN for this image. + CRN *string `json:"crn" validate:"required"` +} + +// NewImageIdentityByCRN : Instantiate ImageIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewImageIdentityByCRN(crn string) (_model *ImageIdentityByCRN, err error) { + _model = &ImageIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*ImageIdentityByCRN) isaImageIdentity() bool { + return true +} + +// UnmarshalImageIdentityByCRN unmarshals an instance of ImageIdentityByCRN from the specified map of raw messages. +func UnmarshalImageIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ImageIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ImageIdentityByHref : ImageIdentityByHref struct +// This model "extends" ImageIdentity +type ImageIdentityByHref struct { + // The URL for this image. + Href *string `json:"href" validate:"required"` +} + +// NewImageIdentityByHref : Instantiate ImageIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewImageIdentityByHref(href string) (_model *ImageIdentityByHref, err error) { + _model = &ImageIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*ImageIdentityByHref) isaImageIdentity() bool { + return true +} + +// UnmarshalImageIdentityByHref unmarshals an instance of ImageIdentityByHref from the specified map of raw messages. +func UnmarshalImageIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ImageIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ImageIdentityByID : ImageIdentityByID struct +// This model "extends" ImageIdentity +type ImageIdentityByID struct { + // The unique identifier for this image. + ID *string `json:"id" validate:"required"` +} + +// NewImageIdentityByID : Instantiate ImageIdentityByID (Generic Model Constructor) +func (*VpcV1) NewImageIdentityByID(id string) (_model *ImageIdentityByID, err error) { + _model = &ImageIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*ImageIdentityByID) isaImageIdentity() bool { + return true +} + +// UnmarshalImageIdentityByID unmarshals an instance of ImageIdentityByID from the specified map of raw messages. +func UnmarshalImageIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ImageIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ImagePrototypeImageByFile : ImagePrototypeImageByFile struct +// This model "extends" ImagePrototype +type ImagePrototypeImageByFile struct { + // The deprecation date and time to set for this image. + // + // The date and time must not be in the past, and must be earlier than `obsolescence_at` + // (if `obsolescence_at` is set). + // + // If unspecified, no deprecation date and time will be set. + // + // If the deprecation date and time is reached while the image has a status of `pending`, the image's status will + // transition to `deprecated` upon its successful creation (or + // `obsolete` if the obsolescence date and time was also reached). + DeprecationAt *strfmt.DateTime `json:"deprecation_at,omitempty"` + + // The name for this image. The name must not be used by another image in the region. Names starting with `ibm-` are + // reserved for system-provided images, and are not allowed. If unspecified, the name will be a hyphenated list of + // randomly-selected words. + Name *string `json:"name,omitempty"` + + // The obsolescence date and time to set for this image. + // + // The date and time must not be in the past, and must be later than `deprecation_at` (if + // `deprecation_at` is set). + // + // If unspecified, no obsolescence date and time will be set. + // + // If the obsolescence date and time is reached while the image has a status of + // `pending`, the image's status will transition to `obsolete` upon its successful creation. + ObsolescenceAt *strfmt.DateTime `json:"obsolescence_at,omitempty"` + + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // A base64-encoded, encrypted representation of the key that was used to encrypt the data for this image. + // + // That representation is created by wrapping the key's value with the `encryption_key` root key (which must also be + // specified), using either [Key Protect](https://cloud.ibm.com/docs/key-protect?topic=key-protect-wrap-keys) or the + // [Hyper Protect Crypto Services](https://cloud.ibm.com/docs/services/hs-crypto?topic=hs-crypto-wrap-keys). + // + // If unspecified, the imported image is treated as unencrypted. + EncryptedDataKey *string `json:"encrypted_data_key,omitempty"` + + // The root key that was used to wrap the data key (which is ultimately represented as + // `encrypted_data_key`). Additionally, the root key will be used to encrypt volumes + // created from this image (unless an alternate `encryption_key` is specified at volume + // creation). + // + // If unspecified, the imported image is treated as unencrypted. + EncryptionKey EncryptionKeyIdentityIntf `json:"encryption_key,omitempty"` + + // The file from which to create the image. + File *ImageFilePrototype `json:"file" validate:"required"` + + // The [supported operating + // system](https://cloud.ibm.com/apidocs/vpc#list-operating-systems) included in this + // image. + OperatingSystem OperatingSystemIdentityIntf `json:"operating_system" validate:"required"` +} + +// NewImagePrototypeImageByFile : Instantiate ImagePrototypeImageByFile (Generic Model Constructor) +func (*VpcV1) NewImagePrototypeImageByFile(file *ImageFilePrototype, operatingSystem OperatingSystemIdentityIntf) (_model *ImagePrototypeImageByFile, err error) { + _model = &ImagePrototypeImageByFile{ + File: file, + OperatingSystem: operatingSystem, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*ImagePrototypeImageByFile) isaImagePrototype() bool { + return true +} + +// UnmarshalImagePrototypeImageByFile unmarshals an instance of ImagePrototypeImageByFile from the specified map of raw messages. +func UnmarshalImagePrototypeImageByFile(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ImagePrototypeImageByFile) + err = core.UnmarshalPrimitive(m, "deprecation_at", &obj.DeprecationAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "obsolescence_at", &obj.ObsolescenceAt) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "encrypted_data_key", &obj.EncryptedDataKey) + if err != nil { + return + } + err = core.UnmarshalModel(m, "encryption_key", &obj.EncryptionKey, UnmarshalEncryptionKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "file", &obj.File, UnmarshalImageFilePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "operating_system", &obj.OperatingSystem, UnmarshalOperatingSystemIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ImagePrototypeImageBySourceVolume : ImagePrototypeImageBySourceVolume struct +// This model "extends" ImagePrototype +type ImagePrototypeImageBySourceVolume struct { + // The deprecation date and time to set for this image. + // + // The date and time must not be in the past, and must be earlier than `obsolescence_at` + // (if `obsolescence_at` is set). + // + // If unspecified, no deprecation date and time will be set. + // + // If the deprecation date and time is reached while the image has a status of `pending`, the image's status will + // transition to `deprecated` upon its successful creation (or + // `obsolete` if the obsolescence date and time was also reached). + DeprecationAt *strfmt.DateTime `json:"deprecation_at,omitempty"` + + // The name for this image. The name must not be used by another image in the region. Names starting with `ibm-` are + // reserved for system-provided images, and are not allowed. If unspecified, the name will be a hyphenated list of + // randomly-selected words. + Name *string `json:"name,omitempty"` + + // The obsolescence date and time to set for this image. + // + // The date and time must not be in the past, and must be later than `deprecation_at` (if + // `deprecation_at` is set). + // + // If unspecified, no obsolescence date and time will be set. + // + // If the obsolescence date and time is reached while the image has a status of + // `pending`, the image's status will transition to `obsolete` upon its successful creation. + ObsolescenceAt *strfmt.DateTime `json:"obsolescence_at,omitempty"` + + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The root key used to wrap the system-generated data encryption key for the image. + // + // If unspecified, the root key from `source_volume` will be used. + EncryptionKey EncryptionKeyIdentityIntf `json:"encryption_key,omitempty"` + + // The volume from which to create the image. The specified volume must: + // - Have an `operating_system`, which will be used to populate this image's + // operating system information. + // - Not be `active` or `busy`. + // + // During image creation, the specified volume may briefly become `busy`. + SourceVolume VolumeIdentityIntf `json:"source_volume" validate:"required"` +} + +// NewImagePrototypeImageBySourceVolume : Instantiate ImagePrototypeImageBySourceVolume (Generic Model Constructor) +func (*VpcV1) NewImagePrototypeImageBySourceVolume(sourceVolume VolumeIdentityIntf) (_model *ImagePrototypeImageBySourceVolume, err error) { + _model = &ImagePrototypeImageBySourceVolume{ + SourceVolume: sourceVolume, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*ImagePrototypeImageBySourceVolume) isaImagePrototype() bool { + return true +} + +// UnmarshalImagePrototypeImageBySourceVolume unmarshals an instance of ImagePrototypeImageBySourceVolume from the specified map of raw messages. +func UnmarshalImagePrototypeImageBySourceVolume(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ImagePrototypeImageBySourceVolume) + err = core.UnmarshalPrimitive(m, "deprecation_at", &obj.DeprecationAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "obsolescence_at", &obj.ObsolescenceAt) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "encryption_key", &obj.EncryptionKey, UnmarshalEncryptionKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "source_volume", &obj.SourceVolume, UnmarshalVolumeIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceCatalogOfferingPrototypeCatalogOfferingByOffering : InstanceCatalogOfferingPrototypeCatalogOfferingByOffering struct +// This model "extends" InstanceCatalogOfferingPrototype +type InstanceCatalogOfferingPrototypeCatalogOfferingByOffering struct { + // Identifies a [catalog](https://cloud.ibm.com/docs/account?topic=account-restrict-by-user) + // offering by a unique property. + Offering CatalogOfferingIdentityIntf `json:"offering" validate:"required"` +} + +// NewInstanceCatalogOfferingPrototypeCatalogOfferingByOffering : Instantiate InstanceCatalogOfferingPrototypeCatalogOfferingByOffering (Generic Model Constructor) +func (*VpcV1) NewInstanceCatalogOfferingPrototypeCatalogOfferingByOffering(offering CatalogOfferingIdentityIntf) (_model *InstanceCatalogOfferingPrototypeCatalogOfferingByOffering, err error) { + _model = &InstanceCatalogOfferingPrototypeCatalogOfferingByOffering{ + Offering: offering, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstanceCatalogOfferingPrototypeCatalogOfferingByOffering) isaInstanceCatalogOfferingPrototype() bool { + return true +} + +// UnmarshalInstanceCatalogOfferingPrototypeCatalogOfferingByOffering unmarshals an instance of InstanceCatalogOfferingPrototypeCatalogOfferingByOffering from the specified map of raw messages. +func UnmarshalInstanceCatalogOfferingPrototypeCatalogOfferingByOffering(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceCatalogOfferingPrototypeCatalogOfferingByOffering) + err = core.UnmarshalModel(m, "offering", &obj.Offering, UnmarshalCatalogOfferingIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceCatalogOfferingPrototypeCatalogOfferingByVersion : InstanceCatalogOfferingPrototypeCatalogOfferingByVersion struct +// This model "extends" InstanceCatalogOfferingPrototype +type InstanceCatalogOfferingPrototypeCatalogOfferingByVersion struct { + // Identifies a version of a + // [catalog](https://cloud.ibm.com/docs/account?topic=account-restrict-by-user) offering by a + // unique property. + Version CatalogOfferingVersionIdentityIntf `json:"version" validate:"required"` +} + +// NewInstanceCatalogOfferingPrototypeCatalogOfferingByVersion : Instantiate InstanceCatalogOfferingPrototypeCatalogOfferingByVersion (Generic Model Constructor) +func (*VpcV1) NewInstanceCatalogOfferingPrototypeCatalogOfferingByVersion(version CatalogOfferingVersionIdentityIntf) (_model *InstanceCatalogOfferingPrototypeCatalogOfferingByVersion, err error) { + _model = &InstanceCatalogOfferingPrototypeCatalogOfferingByVersion{ + Version: version, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstanceCatalogOfferingPrototypeCatalogOfferingByVersion) isaInstanceCatalogOfferingPrototype() bool { + return true +} + +// UnmarshalInstanceCatalogOfferingPrototypeCatalogOfferingByVersion unmarshals an instance of InstanceCatalogOfferingPrototypeCatalogOfferingByVersion from the specified map of raw messages. +func UnmarshalInstanceCatalogOfferingPrototypeCatalogOfferingByVersion(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceCatalogOfferingPrototypeCatalogOfferingByVersion) + err = core.UnmarshalModel(m, "version", &obj.Version, UnmarshalCatalogOfferingVersionIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerActionPrototypeScheduledActionPrototype : InstanceGroupManagerActionPrototypeScheduledActionPrototype struct +// Models which "extend" this model: +// - InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAt +// - InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpec +// This model "extends" InstanceGroupManagerActionPrototype +type InstanceGroupManagerActionPrototypeScheduledActionPrototype struct { + // The name for this instance group manager action. The name must not be used by another action for the instance group + // manager. If unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The date and time the scheduled action will run. + RunAt *strfmt.DateTime `json:"run_at,omitempty"` + + Group *InstanceGroupManagerScheduledActionGroupPrototype `json:"group,omitempty"` + + Manager InstanceGroupManagerScheduledActionManagerPrototypeIntf `json:"manager,omitempty"` + + // The cron specification for a recurring scheduled action. Actions can be applied a maximum of one time within a 5 min + // period. + CronSpec *string `json:"cron_spec,omitempty"` +} + +func (*InstanceGroupManagerActionPrototypeScheduledActionPrototype) isaInstanceGroupManagerActionPrototypeScheduledActionPrototype() bool { + return true +} + +type InstanceGroupManagerActionPrototypeScheduledActionPrototypeIntf interface { + InstanceGroupManagerActionPrototypeIntf + isaInstanceGroupManagerActionPrototypeScheduledActionPrototype() bool +} + +func (*InstanceGroupManagerActionPrototypeScheduledActionPrototype) isaInstanceGroupManagerActionPrototype() bool { + return true +} + +// UnmarshalInstanceGroupManagerActionPrototypeScheduledActionPrototype unmarshals an instance of InstanceGroupManagerActionPrototypeScheduledActionPrototype from the specified map of raw messages. +func UnmarshalInstanceGroupManagerActionPrototypeScheduledActionPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerActionPrototypeScheduledActionPrototype) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "run_at", &obj.RunAt) + if err != nil { + return + } + err = core.UnmarshalModel(m, "group", &obj.Group, UnmarshalInstanceGroupManagerScheduledActionGroupPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "manager", &obj.Manager, UnmarshalInstanceGroupManagerScheduledActionManagerPrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "cron_spec", &obj.CronSpec) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerActionScheduledAction : InstanceGroupManagerActionScheduledAction struct +// Models which "extend" this model: +// - InstanceGroupManagerActionScheduledActionGroupTarget +// - InstanceGroupManagerActionScheduledActionManagerTarget +// This model "extends" InstanceGroupManagerAction +type InstanceGroupManagerActionScheduledAction struct { + // Indicates whether this scheduled action will be automatically deleted after it has completed and + // `auto_delete_timeout` hours have passed. At present, this is always + // `true`, but may be modifiable in the future. + AutoDelete *bool `json:"auto_delete" validate:"required"` + + // If `auto_delete` is `true`, and this scheduled action has finished, the hours after which it will be automatically + // deleted. If the value is `0`, the action will be deleted once it has finished. This value may be modifiable in the + // future. + AutoDeleteTimeout *int64 `json:"auto_delete_timeout" validate:"required"` + + // The date and time that the instance group manager action was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The URL for this instance group manager action. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this instance group manager action. + ID *string `json:"id" validate:"required"` + + // The name for this instance group manager action. The name is unique across all actions for the instance group + // manager. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The status of the instance group action + // - `active`: Action is ready to be run + // - `completed`: Action was completed successfully + // - `failed`: Action could not be completed successfully + // - `incompatible`: Action parameters are not compatible with the group or manager + // - `omitted`: Action was not applied because this action's manager was disabled. + Status *string `json:"status" validate:"required"` + + // The date and time that the instance group manager action was updated. + UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"` + + // The type of action for the instance group. + ActionType *string `json:"action_type" validate:"required"` + + // The cron specification for a recurring scheduled action. Actions can be applied a maximum of one time within a 5 min + // period. + CronSpec *string `json:"cron_spec,omitempty"` + + // The date and time the scheduled action was last applied. If absent, the action has never been applied. + LastAppliedAt *strfmt.DateTime `json:"last_applied_at,omitempty"` + + // The date and time the scheduled action will next run. If absent, the system is currently calculating the next run + // time. + NextRunAt *strfmt.DateTime `json:"next_run_at,omitempty"` + + Group *InstanceGroupManagerScheduledActionGroup `json:"group,omitempty"` + + Manager InstanceGroupManagerScheduledActionManagerIntf `json:"manager,omitempty"` +} + +// Constants associated with the InstanceGroupManagerActionScheduledAction.ResourceType property. +// The resource type. +const ( + InstanceGroupManagerActionScheduledActionResourceTypeInstanceGroupManagerActionConst = "instance_group_manager_action" +) + +// Constants associated with the InstanceGroupManagerActionScheduledAction.Status property. +// The status of the instance group action +// - `active`: Action is ready to be run +// - `completed`: Action was completed successfully +// - `failed`: Action could not be completed successfully +// - `incompatible`: Action parameters are not compatible with the group or manager +// - `omitted`: Action was not applied because this action's manager was disabled. +const ( + InstanceGroupManagerActionScheduledActionStatusActiveConst = "active" + InstanceGroupManagerActionScheduledActionStatusCompletedConst = "completed" + InstanceGroupManagerActionScheduledActionStatusFailedConst = "failed" + InstanceGroupManagerActionScheduledActionStatusIncompatibleConst = "incompatible" + InstanceGroupManagerActionScheduledActionStatusOmittedConst = "omitted" +) + +// Constants associated with the InstanceGroupManagerActionScheduledAction.ActionType property. +// The type of action for the instance group. +const ( + InstanceGroupManagerActionScheduledActionActionTypeScheduledConst = "scheduled" +) + +func (*InstanceGroupManagerActionScheduledAction) isaInstanceGroupManagerActionScheduledAction() bool { + return true +} + +type InstanceGroupManagerActionScheduledActionIntf interface { + InstanceGroupManagerActionIntf + isaInstanceGroupManagerActionScheduledAction() bool +} + +func (*InstanceGroupManagerActionScheduledAction) isaInstanceGroupManagerAction() bool { + return true +} + +// UnmarshalInstanceGroupManagerActionScheduledAction unmarshals an instance of InstanceGroupManagerActionScheduledAction from the specified map of raw messages. +func UnmarshalInstanceGroupManagerActionScheduledAction(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerActionScheduledAction) + err = core.UnmarshalPrimitive(m, "auto_delete", &obj.AutoDelete) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "auto_delete_timeout", &obj.AutoDeleteTimeout) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "updated_at", &obj.UpdatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "action_type", &obj.ActionType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "cron_spec", &obj.CronSpec) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "last_applied_at", &obj.LastAppliedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "next_run_at", &obj.NextRunAt) + if err != nil { + return + } + err = core.UnmarshalModel(m, "group", &obj.Group, UnmarshalInstanceGroupManagerScheduledActionGroup) + if err != nil { + return + } + err = core.UnmarshalModel(m, "manager", &obj.Manager, UnmarshalInstanceGroupManagerScheduledActionManager) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerAutoScale : InstanceGroupManagerAutoScale struct +// This model "extends" InstanceGroupManager +type InstanceGroupManagerAutoScale struct { + // The date and time that the instance group manager was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The URL for this instance group manager. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this instance group manager. + ID *string `json:"id" validate:"required"` + + // Indicates whether this manager will control the instance group. + ManagementEnabled *bool `json:"management_enabled" validate:"required"` + + // The name for this instance group manager. The name is unique across all managers for the instance group. + Name *string `json:"name" validate:"required"` + + // The date and time that the instance group manager was updated. + UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"` + + // The time window in seconds to aggregate metrics prior to evaluation. + AggregationWindow *int64 `json:"aggregation_window" validate:"required"` + + // The duration of time in seconds to pause further scale actions after scaling has taken place. + Cooldown *int64 `json:"cooldown" validate:"required"` + + // The type of instance group manager. + ManagerType *string `json:"manager_type" validate:"required"` + + // The maximum number of members in a managed instance group. + MaxMembershipCount *int64 `json:"max_membership_count" validate:"required"` + + // The minimum number of members in a managed instance group. + MinMembershipCount *int64 `json:"min_membership_count" validate:"required"` + + // The policies of the instance group manager. + Policies []InstanceGroupManagerPolicyReference `json:"policies" validate:"required"` +} + +// Constants associated with the InstanceGroupManagerAutoScale.ManagerType property. +// The type of instance group manager. +const ( + InstanceGroupManagerAutoScaleManagerTypeAutoscaleConst = "autoscale" +) + +func (*InstanceGroupManagerAutoScale) isaInstanceGroupManager() bool { + return true +} + +// UnmarshalInstanceGroupManagerAutoScale unmarshals an instance of InstanceGroupManagerAutoScale from the specified map of raw messages. +func UnmarshalInstanceGroupManagerAutoScale(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerAutoScale) + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "management_enabled", &obj.ManagementEnabled) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "updated_at", &obj.UpdatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "aggregation_window", &obj.AggregationWindow) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "cooldown", &obj.Cooldown) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "manager_type", &obj.ManagerType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max_membership_count", &obj.MaxMembershipCount) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min_membership_count", &obj.MinMembershipCount) + if err != nil { + return + } + err = core.UnmarshalModel(m, "policies", &obj.Policies, UnmarshalInstanceGroupManagerPolicyReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerPolicyPrototypeInstanceGroupManagerTargetPolicyPrototype : InstanceGroupManagerPolicyPrototypeInstanceGroupManagerTargetPolicyPrototype struct +// This model "extends" InstanceGroupManagerPolicyPrototype +type InstanceGroupManagerPolicyPrototypeInstanceGroupManagerTargetPolicyPrototype struct { + // The name for this instance group manager policy. The name must not be used by another policy for the instance group + // manager. If unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The type of metric to be evaluated. + MetricType *string `json:"metric_type" validate:"required"` + + // The metric value to be evaluated. + MetricValue *int64 `json:"metric_value" validate:"required"` + + // The type of policy for the instance group. + PolicyType *string `json:"policy_type" validate:"required"` +} + +// Constants associated with the InstanceGroupManagerPolicyPrototypeInstanceGroupManagerTargetPolicyPrototype.MetricType property. +// The type of metric to be evaluated. +const ( + InstanceGroupManagerPolicyPrototypeInstanceGroupManagerTargetPolicyPrototypeMetricTypeCpuConst = "cpu" + InstanceGroupManagerPolicyPrototypeInstanceGroupManagerTargetPolicyPrototypeMetricTypeMemoryConst = "memory" + InstanceGroupManagerPolicyPrototypeInstanceGroupManagerTargetPolicyPrototypeMetricTypeNetworkInConst = "network_in" + InstanceGroupManagerPolicyPrototypeInstanceGroupManagerTargetPolicyPrototypeMetricTypeNetworkOutConst = "network_out" +) + +// Constants associated with the InstanceGroupManagerPolicyPrototypeInstanceGroupManagerTargetPolicyPrototype.PolicyType property. +// The type of policy for the instance group. +const ( + InstanceGroupManagerPolicyPrototypeInstanceGroupManagerTargetPolicyPrototypePolicyTypeTargetConst = "target" +) + +// NewInstanceGroupManagerPolicyPrototypeInstanceGroupManagerTargetPolicyPrototype : Instantiate InstanceGroupManagerPolicyPrototypeInstanceGroupManagerTargetPolicyPrototype (Generic Model Constructor) +func (*VpcV1) NewInstanceGroupManagerPolicyPrototypeInstanceGroupManagerTargetPolicyPrototype(metricType string, metricValue int64, policyType string) (_model *InstanceGroupManagerPolicyPrototypeInstanceGroupManagerTargetPolicyPrototype, err error) { + _model = &InstanceGroupManagerPolicyPrototypeInstanceGroupManagerTargetPolicyPrototype{ + MetricType: core.StringPtr(metricType), + MetricValue: core.Int64Ptr(metricValue), + PolicyType: core.StringPtr(policyType), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstanceGroupManagerPolicyPrototypeInstanceGroupManagerTargetPolicyPrototype) isaInstanceGroupManagerPolicyPrototype() bool { + return true +} + +// UnmarshalInstanceGroupManagerPolicyPrototypeInstanceGroupManagerTargetPolicyPrototype unmarshals an instance of InstanceGroupManagerPolicyPrototypeInstanceGroupManagerTargetPolicyPrototype from the specified map of raw messages. +func UnmarshalInstanceGroupManagerPolicyPrototypeInstanceGroupManagerTargetPolicyPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerPolicyPrototypeInstanceGroupManagerTargetPolicyPrototype) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "metric_type", &obj.MetricType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "metric_value", &obj.MetricValue) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "policy_type", &obj.PolicyType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerPolicyInstanceGroupManagerTargetPolicy : InstanceGroupManagerPolicyInstanceGroupManagerTargetPolicy struct +// This model "extends" InstanceGroupManagerPolicy +type InstanceGroupManagerPolicyInstanceGroupManagerTargetPolicy struct { + // The date and time that the instance group manager policy was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The URL for this instance group manager policy. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this instance group manager policy. + ID *string `json:"id" validate:"required"` + + // The name for this instance group manager policy. The name is unique across all policies for the instance group + // manager. + Name *string `json:"name" validate:"required"` + + // The date and time that the instance group manager policy was updated. + UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"` + + // The type of metric to be evaluated. + MetricType *string `json:"metric_type" validate:"required"` + + // The metric value to be evaluated. + MetricValue *int64 `json:"metric_value" validate:"required"` + + // The type of policy for the instance group. + PolicyType *string `json:"policy_type" validate:"required"` +} + +// Constants associated with the InstanceGroupManagerPolicyInstanceGroupManagerTargetPolicy.MetricType property. +// The type of metric to be evaluated. +const ( + InstanceGroupManagerPolicyInstanceGroupManagerTargetPolicyMetricTypeCpuConst = "cpu" + InstanceGroupManagerPolicyInstanceGroupManagerTargetPolicyMetricTypeMemoryConst = "memory" + InstanceGroupManagerPolicyInstanceGroupManagerTargetPolicyMetricTypeNetworkInConst = "network_in" + InstanceGroupManagerPolicyInstanceGroupManagerTargetPolicyMetricTypeNetworkOutConst = "network_out" +) + +// Constants associated with the InstanceGroupManagerPolicyInstanceGroupManagerTargetPolicy.PolicyType property. +// The type of policy for the instance group. +const ( + InstanceGroupManagerPolicyInstanceGroupManagerTargetPolicyPolicyTypeTargetConst = "target" +) + +func (*InstanceGroupManagerPolicyInstanceGroupManagerTargetPolicy) isaInstanceGroupManagerPolicy() bool { + return true +} + +// UnmarshalInstanceGroupManagerPolicyInstanceGroupManagerTargetPolicy unmarshals an instance of InstanceGroupManagerPolicyInstanceGroupManagerTargetPolicy from the specified map of raw messages. +func UnmarshalInstanceGroupManagerPolicyInstanceGroupManagerTargetPolicy(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerPolicyInstanceGroupManagerTargetPolicy) + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "updated_at", &obj.UpdatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "metric_type", &obj.MetricType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "metric_value", &obj.MetricValue) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "policy_type", &obj.PolicyType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerPrototypeInstanceGroupManagerAutoScalePrototype : InstanceGroupManagerPrototypeInstanceGroupManagerAutoScalePrototype struct +// This model "extends" InstanceGroupManagerPrototype +type InstanceGroupManagerPrototypeInstanceGroupManagerAutoScalePrototype struct { + // Indicates whether this manager will control the instance group. + ManagementEnabled *bool `json:"management_enabled,omitempty"` + + // The name for this instance group manager. The name must not be used by another manager for the instance group. If + // unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The time window in seconds to aggregate metrics prior to evaluation. + AggregationWindow *int64 `json:"aggregation_window,omitempty"` + + // The duration of time in seconds to pause further scale actions after scaling has taken place. + Cooldown *int64 `json:"cooldown,omitempty"` + + // The type of instance group manager. + ManagerType *string `json:"manager_type" validate:"required"` + + // The maximum number of members in a managed instance group. + MaxMembershipCount *int64 `json:"max_membership_count" validate:"required"` + + // The minimum number of members in a managed instance group. + MinMembershipCount *int64 `json:"min_membership_count,omitempty"` +} + +// Constants associated with the InstanceGroupManagerPrototypeInstanceGroupManagerAutoScalePrototype.ManagerType property. +// The type of instance group manager. +const ( + InstanceGroupManagerPrototypeInstanceGroupManagerAutoScalePrototypeManagerTypeAutoscaleConst = "autoscale" +) + +// NewInstanceGroupManagerPrototypeInstanceGroupManagerAutoScalePrototype : Instantiate InstanceGroupManagerPrototypeInstanceGroupManagerAutoScalePrototype (Generic Model Constructor) +func (*VpcV1) NewInstanceGroupManagerPrototypeInstanceGroupManagerAutoScalePrototype(managerType string, maxMembershipCount int64) (_model *InstanceGroupManagerPrototypeInstanceGroupManagerAutoScalePrototype, err error) { + _model = &InstanceGroupManagerPrototypeInstanceGroupManagerAutoScalePrototype{ + ManagerType: core.StringPtr(managerType), + MaxMembershipCount: core.Int64Ptr(maxMembershipCount), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstanceGroupManagerPrototypeInstanceGroupManagerAutoScalePrototype) isaInstanceGroupManagerPrototype() bool { + return true +} + +// UnmarshalInstanceGroupManagerPrototypeInstanceGroupManagerAutoScalePrototype unmarshals an instance of InstanceGroupManagerPrototypeInstanceGroupManagerAutoScalePrototype from the specified map of raw messages. +func UnmarshalInstanceGroupManagerPrototypeInstanceGroupManagerAutoScalePrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerPrototypeInstanceGroupManagerAutoScalePrototype) + err = core.UnmarshalPrimitive(m, "management_enabled", &obj.ManagementEnabled) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "aggregation_window", &obj.AggregationWindow) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "cooldown", &obj.Cooldown) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "manager_type", &obj.ManagerType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max_membership_count", &obj.MaxMembershipCount) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min_membership_count", &obj.MinMembershipCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerPrototypeInstanceGroupManagerScheduledPrototype : InstanceGroupManagerPrototypeInstanceGroupManagerScheduledPrototype struct +// This model "extends" InstanceGroupManagerPrototype +type InstanceGroupManagerPrototypeInstanceGroupManagerScheduledPrototype struct { + // Indicates whether this manager will control the instance group. + ManagementEnabled *bool `json:"management_enabled,omitempty"` + + // The name for this instance group manager. The name must not be used by another manager for the instance group. If + // unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The type of instance group manager. + ManagerType *string `json:"manager_type" validate:"required"` +} + +// Constants associated with the InstanceGroupManagerPrototypeInstanceGroupManagerScheduledPrototype.ManagerType property. +// The type of instance group manager. +const ( + InstanceGroupManagerPrototypeInstanceGroupManagerScheduledPrototypeManagerTypeScheduledConst = "scheduled" +) + +// NewInstanceGroupManagerPrototypeInstanceGroupManagerScheduledPrototype : Instantiate InstanceGroupManagerPrototypeInstanceGroupManagerScheduledPrototype (Generic Model Constructor) +func (*VpcV1) NewInstanceGroupManagerPrototypeInstanceGroupManagerScheduledPrototype(managerType string) (_model *InstanceGroupManagerPrototypeInstanceGroupManagerScheduledPrototype, err error) { + _model = &InstanceGroupManagerPrototypeInstanceGroupManagerScheduledPrototype{ + ManagerType: core.StringPtr(managerType), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstanceGroupManagerPrototypeInstanceGroupManagerScheduledPrototype) isaInstanceGroupManagerPrototype() bool { + return true +} + +// UnmarshalInstanceGroupManagerPrototypeInstanceGroupManagerScheduledPrototype unmarshals an instance of InstanceGroupManagerPrototypeInstanceGroupManagerScheduledPrototype from the specified map of raw messages. +func UnmarshalInstanceGroupManagerPrototypeInstanceGroupManagerScheduledPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerPrototypeInstanceGroupManagerScheduledPrototype) + err = core.UnmarshalPrimitive(m, "management_enabled", &obj.ManagementEnabled) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "manager_type", &obj.ManagerType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerScheduled : InstanceGroupManagerScheduled struct +// This model "extends" InstanceGroupManager +type InstanceGroupManagerScheduled struct { + // The date and time that the instance group manager was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The URL for this instance group manager. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this instance group manager. + ID *string `json:"id" validate:"required"` + + // Indicates whether this manager will control the instance group. + ManagementEnabled *bool `json:"management_enabled" validate:"required"` + + // The name for this instance group manager. The name is unique across all managers for the instance group. + Name *string `json:"name" validate:"required"` + + // The date and time that the instance group manager was updated. + UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"` + + // The actions of the instance group manager. + Actions []InstanceGroupManagerActionReference `json:"actions" validate:"required"` + + // The type of instance group manager. + ManagerType *string `json:"manager_type" validate:"required"` +} + +// Constants associated with the InstanceGroupManagerScheduled.ManagerType property. +// The type of instance group manager. +const ( + InstanceGroupManagerScheduledManagerTypeScheduledConst = "scheduled" +) + +func (*InstanceGroupManagerScheduled) isaInstanceGroupManager() bool { + return true +} + +// UnmarshalInstanceGroupManagerScheduled unmarshals an instance of InstanceGroupManagerScheduled from the specified map of raw messages. +func UnmarshalInstanceGroupManagerScheduled(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerScheduled) + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "management_enabled", &obj.ManagementEnabled) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "updated_at", &obj.UpdatedAt) + if err != nil { + return + } + err = core.UnmarshalModel(m, "actions", &obj.Actions, UnmarshalInstanceGroupManagerActionReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "manager_type", &obj.ManagerType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerScheduledActionManagerAutoScale : InstanceGroupManagerScheduledActionManagerAutoScale struct +// This model "extends" InstanceGroupManagerScheduledActionManager +type InstanceGroupManagerScheduledActionManagerAutoScale struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *InstanceGroupManagerReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this instance group manager. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this instance group manager. + ID *string `json:"id" validate:"required"` + + // The name for this instance group manager. The name is unique across all managers for the instance group. + Name *string `json:"name" validate:"required"` + + // The desired maximum number of instance group members at the scheduled time. + MaxMembershipCount *int64 `json:"max_membership_count,omitempty"` + + // The desired minimum number of instance group members at the scheduled time. + MinMembershipCount *int64 `json:"min_membership_count,omitempty"` +} + +func (*InstanceGroupManagerScheduledActionManagerAutoScale) isaInstanceGroupManagerScheduledActionManager() bool { + return true +} + +// UnmarshalInstanceGroupManagerScheduledActionManagerAutoScale unmarshals an instance of InstanceGroupManagerScheduledActionManagerAutoScale from the specified map of raw messages. +func UnmarshalInstanceGroupManagerScheduledActionManagerAutoScale(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerScheduledActionManagerAutoScale) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalInstanceGroupManagerReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max_membership_count", &obj.MaxMembershipCount) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min_membership_count", &obj.MinMembershipCount) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototype : The auto scale manager to update, and one or more properties to be updated. Either `id` or `href` must be specified, +// in addition to at least one of `min_membership_count` and +// `max_membership_count`. +// Models which "extend" this model: +// - InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeByID +// - InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeByHref +// This model "extends" InstanceGroupManagerScheduledActionManagerPrototype +type InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototype struct { + // The desired maximum number of instance group members at the scheduled time. + MaxMembershipCount *int64 `json:"max_membership_count,omitempty"` + + // The desired minimum number of instance group members at the scheduled time. + MinMembershipCount *int64 `json:"min_membership_count,omitempty"` + + // The unique identifier for this instance group manager. + ID *string `json:"id,omitempty"` + + // The URL for this instance group manager. + Href *string `json:"href,omitempty"` +} + +func (*InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototype) isaInstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototype() bool { + return true +} + +type InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeIntf interface { + InstanceGroupManagerScheduledActionManagerPrototypeIntf + isaInstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototype() bool +} + +func (*InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototype) isaInstanceGroupManagerScheduledActionManagerPrototype() bool { + return true +} + +// UnmarshalInstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototype unmarshals an instance of InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototype from the specified map of raw messages. +func UnmarshalInstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototype) + err = core.UnmarshalPrimitive(m, "max_membership_count", &obj.MaxMembershipCount) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min_membership_count", &obj.MinMembershipCount) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePatchProfileInstanceProfileIdentityByHref : InstancePatchProfileInstanceProfileIdentityByHref struct +// This model "extends" InstancePatchProfile +type InstancePatchProfileInstanceProfileIdentityByHref struct { + // The URL for this virtual server instance profile. + Href *string `json:"href" validate:"required"` +} + +// NewInstancePatchProfileInstanceProfileIdentityByHref : Instantiate InstancePatchProfileInstanceProfileIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewInstancePatchProfileInstanceProfileIdentityByHref(href string) (_model *InstancePatchProfileInstanceProfileIdentityByHref, err error) { + _model = &InstancePatchProfileInstanceProfileIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstancePatchProfileInstanceProfileIdentityByHref) isaInstancePatchProfile() bool { + return true +} + +// UnmarshalInstancePatchProfileInstanceProfileIdentityByHref unmarshals an instance of InstancePatchProfileInstanceProfileIdentityByHref from the specified map of raw messages. +func UnmarshalInstancePatchProfileInstanceProfileIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePatchProfileInstanceProfileIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePatchProfileInstanceProfileIdentityByName : InstancePatchProfileInstanceProfileIdentityByName struct +// This model "extends" InstancePatchProfile +type InstancePatchProfileInstanceProfileIdentityByName struct { + // The globally unique name for this virtual server instance profile. + Name *string `json:"name" validate:"required"` +} + +// NewInstancePatchProfileInstanceProfileIdentityByName : Instantiate InstancePatchProfileInstanceProfileIdentityByName (Generic Model Constructor) +func (*VpcV1) NewInstancePatchProfileInstanceProfileIdentityByName(name string) (_model *InstancePatchProfileInstanceProfileIdentityByName, err error) { + _model = &InstancePatchProfileInstanceProfileIdentityByName{ + Name: core.StringPtr(name), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstancePatchProfileInstanceProfileIdentityByName) isaInstancePatchProfile() bool { + return true +} + +// UnmarshalInstancePatchProfileInstanceProfileIdentityByName unmarshals an instance of InstancePatchProfileInstanceProfileIdentityByName from the specified map of raw messages. +func UnmarshalInstancePatchProfileInstanceProfileIdentityByName(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePatchProfileInstanceProfileIdentityByName) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePlacementTargetPatchDedicatedHostGroupIdentity : Identifies a dedicated host group by a unique property. +// Models which "extend" this model: +// - InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByID +// - InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByCRN +// - InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByHref +// This model "extends" InstancePlacementTargetPatch +type InstancePlacementTargetPatchDedicatedHostGroupIdentity struct { + // The unique identifier for this dedicated host group. + ID *string `json:"id,omitempty"` + + // The CRN for this dedicated host group. + CRN *string `json:"crn,omitempty"` + + // The URL for this dedicated host group. + Href *string `json:"href,omitempty"` +} + +func (*InstancePlacementTargetPatchDedicatedHostGroupIdentity) isaInstancePlacementTargetPatchDedicatedHostGroupIdentity() bool { + return true +} + +type InstancePlacementTargetPatchDedicatedHostGroupIdentityIntf interface { + InstancePlacementTargetPatchIntf + isaInstancePlacementTargetPatchDedicatedHostGroupIdentity() bool +} + +func (*InstancePlacementTargetPatchDedicatedHostGroupIdentity) isaInstancePlacementTargetPatch() bool { + return true +} + +// UnmarshalInstancePlacementTargetPatchDedicatedHostGroupIdentity unmarshals an instance of InstancePlacementTargetPatchDedicatedHostGroupIdentity from the specified map of raw messages. +func UnmarshalInstancePlacementTargetPatchDedicatedHostGroupIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePlacementTargetPatchDedicatedHostGroupIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePlacementTargetPatchDedicatedHostIdentity : Identifies a dedicated host by a unique property. +// Models which "extend" this model: +// - InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByID +// - InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByCRN +// - InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByHref +// This model "extends" InstancePlacementTargetPatch +type InstancePlacementTargetPatchDedicatedHostIdentity struct { + // The unique identifier for this dedicated host. + ID *string `json:"id,omitempty"` + + // The CRN for this dedicated host. + CRN *string `json:"crn,omitempty"` + + // The URL for this dedicated host. + Href *string `json:"href,omitempty"` +} + +func (*InstancePlacementTargetPatchDedicatedHostIdentity) isaInstancePlacementTargetPatchDedicatedHostIdentity() bool { + return true +} + +type InstancePlacementTargetPatchDedicatedHostIdentityIntf interface { + InstancePlacementTargetPatchIntf + isaInstancePlacementTargetPatchDedicatedHostIdentity() bool +} + +func (*InstancePlacementTargetPatchDedicatedHostIdentity) isaInstancePlacementTargetPatch() bool { + return true +} + +// UnmarshalInstancePlacementTargetPatchDedicatedHostIdentity unmarshals an instance of InstancePlacementTargetPatchDedicatedHostIdentity from the specified map of raw messages. +func UnmarshalInstancePlacementTargetPatchDedicatedHostIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePlacementTargetPatchDedicatedHostIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePlacementTargetPrototypeDedicatedHostGroupIdentity : Identifies a dedicated host group by a unique property. +// Models which "extend" this model: +// - InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByID +// - InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByCRN +// - InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByHref +// This model "extends" InstancePlacementTargetPrototype +type InstancePlacementTargetPrototypeDedicatedHostGroupIdentity struct { + // The unique identifier for this dedicated host group. + ID *string `json:"id,omitempty"` + + // The CRN for this dedicated host group. + CRN *string `json:"crn,omitempty"` + + // The URL for this dedicated host group. + Href *string `json:"href,omitempty"` +} + +func (*InstancePlacementTargetPrototypeDedicatedHostGroupIdentity) isaInstancePlacementTargetPrototypeDedicatedHostGroupIdentity() bool { + return true +} + +type InstancePlacementTargetPrototypeDedicatedHostGroupIdentityIntf interface { + InstancePlacementTargetPrototypeIntf + isaInstancePlacementTargetPrototypeDedicatedHostGroupIdentity() bool +} + +func (*InstancePlacementTargetPrototypeDedicatedHostGroupIdentity) isaInstancePlacementTargetPrototype() bool { + return true +} + +// UnmarshalInstancePlacementTargetPrototypeDedicatedHostGroupIdentity unmarshals an instance of InstancePlacementTargetPrototypeDedicatedHostGroupIdentity from the specified map of raw messages. +func UnmarshalInstancePlacementTargetPrototypeDedicatedHostGroupIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePlacementTargetPrototypeDedicatedHostGroupIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePlacementTargetPrototypeDedicatedHostIdentity : Identifies a dedicated host by a unique property. +// Models which "extend" this model: +// - InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByID +// - InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByCRN +// - InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByHref +// This model "extends" InstancePlacementTargetPrototype +type InstancePlacementTargetPrototypeDedicatedHostIdentity struct { + // The unique identifier for this dedicated host. + ID *string `json:"id,omitempty"` + + // The CRN for this dedicated host. + CRN *string `json:"crn,omitempty"` + + // The URL for this dedicated host. + Href *string `json:"href,omitempty"` +} + +func (*InstancePlacementTargetPrototypeDedicatedHostIdentity) isaInstancePlacementTargetPrototypeDedicatedHostIdentity() bool { + return true +} + +type InstancePlacementTargetPrototypeDedicatedHostIdentityIntf interface { + InstancePlacementTargetPrototypeIntf + isaInstancePlacementTargetPrototypeDedicatedHostIdentity() bool +} + +func (*InstancePlacementTargetPrototypeDedicatedHostIdentity) isaInstancePlacementTargetPrototype() bool { + return true +} + +// UnmarshalInstancePlacementTargetPrototypeDedicatedHostIdentity unmarshals an instance of InstancePlacementTargetPrototypeDedicatedHostIdentity from the specified map of raw messages. +func UnmarshalInstancePlacementTargetPrototypeDedicatedHostIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePlacementTargetPrototypeDedicatedHostIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePlacementTargetPrototypePlacementGroupIdentity : Identifies a placement group by a unique property. +// Models which "extend" this model: +// - InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByID +// - InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByCRN +// - InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByHref +// This model "extends" InstancePlacementTargetPrototype +type InstancePlacementTargetPrototypePlacementGroupIdentity struct { + // The unique identifier for this placement group. + ID *string `json:"id,omitempty"` + + // The CRN for this placement group. + CRN *string `json:"crn,omitempty"` + + // The URL for this placement group. + Href *string `json:"href,omitempty"` +} + +func (*InstancePlacementTargetPrototypePlacementGroupIdentity) isaInstancePlacementTargetPrototypePlacementGroupIdentity() bool { + return true +} + +type InstancePlacementTargetPrototypePlacementGroupIdentityIntf interface { + InstancePlacementTargetPrototypeIntf + isaInstancePlacementTargetPrototypePlacementGroupIdentity() bool +} + +func (*InstancePlacementTargetPrototypePlacementGroupIdentity) isaInstancePlacementTargetPrototype() bool { + return true +} + +// UnmarshalInstancePlacementTargetPrototypePlacementGroupIdentity unmarshals an instance of InstancePlacementTargetPrototypePlacementGroupIdentity from the specified map of raw messages. +func UnmarshalInstancePlacementTargetPrototypePlacementGroupIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePlacementTargetPrototypePlacementGroupIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePlacementTargetDedicatedHostGroupReference : InstancePlacementTargetDedicatedHostGroupReference struct +// This model "extends" InstancePlacementTarget +type InstancePlacementTargetDedicatedHostGroupReference struct { + // The CRN for this dedicated host group. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *DedicatedHostGroupReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this dedicated host group. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this dedicated host group. + ID *string `json:"id" validate:"required"` + + // The name for this dedicated host group. The name is unique across all dedicated host groups in the region. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the InstancePlacementTargetDedicatedHostGroupReference.ResourceType property. +// The resource type. +const ( + InstancePlacementTargetDedicatedHostGroupReferenceResourceTypeDedicatedHostGroupConst = "dedicated_host_group" +) + +func (*InstancePlacementTargetDedicatedHostGroupReference) isaInstancePlacementTarget() bool { + return true +} + +// UnmarshalInstancePlacementTargetDedicatedHostGroupReference unmarshals an instance of InstancePlacementTargetDedicatedHostGroupReference from the specified map of raw messages. +func UnmarshalInstancePlacementTargetDedicatedHostGroupReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePlacementTargetDedicatedHostGroupReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalDedicatedHostGroupReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePlacementTargetDedicatedHostReference : InstancePlacementTargetDedicatedHostReference struct +// This model "extends" InstancePlacementTarget +type InstancePlacementTargetDedicatedHostReference struct { + // The CRN for this dedicated host. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *DedicatedHostReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this dedicated host. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this dedicated host. + ID *string `json:"id" validate:"required"` + + // The name for this dedicated host. The name is unique across all dedicated hosts in the region. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the InstancePlacementTargetDedicatedHostReference.ResourceType property. +// The resource type. +const ( + InstancePlacementTargetDedicatedHostReferenceResourceTypeDedicatedHostConst = "dedicated_host" +) + +func (*InstancePlacementTargetDedicatedHostReference) isaInstancePlacementTarget() bool { + return true +} + +// UnmarshalInstancePlacementTargetDedicatedHostReference unmarshals an instance of InstancePlacementTargetDedicatedHostReference from the specified map of raw messages. +func UnmarshalInstancePlacementTargetDedicatedHostReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePlacementTargetDedicatedHostReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalDedicatedHostReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePlacementTargetPlacementGroupReference : InstancePlacementTargetPlacementGroupReference struct +// This model "extends" InstancePlacementTarget +type InstancePlacementTargetPlacementGroupReference struct { + // The CRN for this placement group. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *PlacementGroupReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this placement group. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this placement group. + ID *string `json:"id" validate:"required"` + + // The name for this placement group. The name is unique across all placement groups in the region. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the InstancePlacementTargetPlacementGroupReference.ResourceType property. +// The resource type. +const ( + InstancePlacementTargetPlacementGroupReferenceResourceTypePlacementGroupConst = "placement_group" +) + +func (*InstancePlacementTargetPlacementGroupReference) isaInstancePlacementTarget() bool { + return true +} + +// UnmarshalInstancePlacementTargetPlacementGroupReference unmarshals an instance of InstancePlacementTargetPlacementGroupReference from the specified map of raw messages. +func UnmarshalInstancePlacementTargetPlacementGroupReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePlacementTargetPlacementGroupReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalPlacementGroupReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileBandwidthDependent : The total bandwidth shared across the network interfaces and storage volumes of an instance with this profile depends +// on its configuration. +// This model "extends" InstanceProfileBandwidth +type InstanceProfileBandwidthDependent struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the InstanceProfileBandwidthDependent.Type property. +// The type for this profile field. +const ( + InstanceProfileBandwidthDependentTypeDependentConst = "dependent" +) + +func (*InstanceProfileBandwidthDependent) isaInstanceProfileBandwidth() bool { + return true +} + +// UnmarshalInstanceProfileBandwidthDependent unmarshals an instance of InstanceProfileBandwidthDependent from the specified map of raw messages. +func UnmarshalInstanceProfileBandwidthDependent(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileBandwidthDependent) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileBandwidthEnum : The permitted total bandwidth values (in megabits per second) shared across the network interfaces and storage +// volumes of an instance with this profile. +// This model "extends" InstanceProfileBandwidth +type InstanceProfileBandwidthEnum struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The permitted values for this profile field. + Values []int64 `json:"values" validate:"required"` +} + +// Constants associated with the InstanceProfileBandwidthEnum.Type property. +// The type for this profile field. +const ( + InstanceProfileBandwidthEnumTypeEnumConst = "enum" +) + +func (*InstanceProfileBandwidthEnum) isaInstanceProfileBandwidth() bool { + return true +} + +// UnmarshalInstanceProfileBandwidthEnum unmarshals an instance of InstanceProfileBandwidthEnum from the specified map of raw messages. +func UnmarshalInstanceProfileBandwidthEnum(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileBandwidthEnum) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileBandwidthFixed : The total bandwidth (in megabits per second) shared across the network interfaces and storage volumes of an instance +// with this profile. +// This model "extends" InstanceProfileBandwidth +type InstanceProfileBandwidthFixed struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The value for this profile field. + Value *int64 `json:"value" validate:"required"` +} + +// Constants associated with the InstanceProfileBandwidthFixed.Type property. +// The type for this profile field. +const ( + InstanceProfileBandwidthFixedTypeFixedConst = "fixed" +) + +func (*InstanceProfileBandwidthFixed) isaInstanceProfileBandwidth() bool { + return true +} + +// UnmarshalInstanceProfileBandwidthFixed unmarshals an instance of InstanceProfileBandwidthFixed from the specified map of raw messages. +func UnmarshalInstanceProfileBandwidthFixed(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileBandwidthFixed) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileBandwidthRange : The permitted total bandwidth range (in megabits per second) shared across the network interfaces and storage volumes +// of an instance with this profile. +// This model "extends" InstanceProfileBandwidth +type InstanceProfileBandwidthRange struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The maximum value for this profile field. + Max *int64 `json:"max" validate:"required"` + + // The minimum value for this profile field. + Min *int64 `json:"min" validate:"required"` + + // The increment step value for this profile field. + Step *int64 `json:"step" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the InstanceProfileBandwidthRange.Type property. +// The type for this profile field. +const ( + InstanceProfileBandwidthRangeTypeRangeConst = "range" +) + +func (*InstanceProfileBandwidthRange) isaInstanceProfileBandwidth() bool { + return true +} + +// UnmarshalInstanceProfileBandwidthRange unmarshals an instance of InstanceProfileBandwidthRange from the specified map of raw messages. +func UnmarshalInstanceProfileBandwidthRange(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileBandwidthRange) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileDiskQuantityDependent : The number of disks of this configuration for an instance with this profile depends on its instance configuration. +// This model "extends" InstanceProfileDiskQuantity +type InstanceProfileDiskQuantityDependent struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the InstanceProfileDiskQuantityDependent.Type property. +// The type for this profile field. +const ( + InstanceProfileDiskQuantityDependentTypeDependentConst = "dependent" +) + +func (*InstanceProfileDiskQuantityDependent) isaInstanceProfileDiskQuantity() bool { + return true +} + +// UnmarshalInstanceProfileDiskQuantityDependent unmarshals an instance of InstanceProfileDiskQuantityDependent from the specified map of raw messages. +func UnmarshalInstanceProfileDiskQuantityDependent(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileDiskQuantityDependent) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileDiskQuantityEnum : The permitted the number of disks of this configuration for an instance with this profile. +// This model "extends" InstanceProfileDiskQuantity +type InstanceProfileDiskQuantityEnum struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The permitted values for this profile field. + Values []int64 `json:"values" validate:"required"` +} + +// Constants associated with the InstanceProfileDiskQuantityEnum.Type property. +// The type for this profile field. +const ( + InstanceProfileDiskQuantityEnumTypeEnumConst = "enum" +) + +func (*InstanceProfileDiskQuantityEnum) isaInstanceProfileDiskQuantity() bool { + return true +} + +// UnmarshalInstanceProfileDiskQuantityEnum unmarshals an instance of InstanceProfileDiskQuantityEnum from the specified map of raw messages. +func UnmarshalInstanceProfileDiskQuantityEnum(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileDiskQuantityEnum) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileDiskQuantityFixed : The number of disks of this configuration for an instance with this profile. +// This model "extends" InstanceProfileDiskQuantity +type InstanceProfileDiskQuantityFixed struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The value for this profile field. + Value *int64 `json:"value" validate:"required"` +} + +// Constants associated with the InstanceProfileDiskQuantityFixed.Type property. +// The type for this profile field. +const ( + InstanceProfileDiskQuantityFixedTypeFixedConst = "fixed" +) + +func (*InstanceProfileDiskQuantityFixed) isaInstanceProfileDiskQuantity() bool { + return true +} + +// UnmarshalInstanceProfileDiskQuantityFixed unmarshals an instance of InstanceProfileDiskQuantityFixed from the specified map of raw messages. +func UnmarshalInstanceProfileDiskQuantityFixed(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileDiskQuantityFixed) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileDiskQuantityRange : The permitted range for the number of disks of this configuration for an instance with this profile. +// This model "extends" InstanceProfileDiskQuantity +type InstanceProfileDiskQuantityRange struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The maximum value for this profile field. + Max *int64 `json:"max" validate:"required"` + + // The minimum value for this profile field. + Min *int64 `json:"min" validate:"required"` + + // The increment step value for this profile field. + Step *int64 `json:"step" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the InstanceProfileDiskQuantityRange.Type property. +// The type for this profile field. +const ( + InstanceProfileDiskQuantityRangeTypeRangeConst = "range" +) + +func (*InstanceProfileDiskQuantityRange) isaInstanceProfileDiskQuantity() bool { + return true +} + +// UnmarshalInstanceProfileDiskQuantityRange unmarshals an instance of InstanceProfileDiskQuantityRange from the specified map of raw messages. +func UnmarshalInstanceProfileDiskQuantityRange(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileDiskQuantityRange) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileDiskSizeDependent : The disk size in GB (gigabytes) of this configuration for an instance with this profile depends on its instance +// configuration. +// This model "extends" InstanceProfileDiskSize +type InstanceProfileDiskSizeDependent struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the InstanceProfileDiskSizeDependent.Type property. +// The type for this profile field. +const ( + InstanceProfileDiskSizeDependentTypeDependentConst = "dependent" +) + +func (*InstanceProfileDiskSizeDependent) isaInstanceProfileDiskSize() bool { + return true +} + +// UnmarshalInstanceProfileDiskSizeDependent unmarshals an instance of InstanceProfileDiskSizeDependent from the specified map of raw messages. +func UnmarshalInstanceProfileDiskSizeDependent(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileDiskSizeDependent) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileDiskSizeEnum : The permitted disk size in GB (gigabytes) of this configuration for an instance with this profile. +// This model "extends" InstanceProfileDiskSize +type InstanceProfileDiskSizeEnum struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The permitted values for this profile field. + Values []int64 `json:"values" validate:"required"` +} + +// Constants associated with the InstanceProfileDiskSizeEnum.Type property. +// The type for this profile field. +const ( + InstanceProfileDiskSizeEnumTypeEnumConst = "enum" +) + +func (*InstanceProfileDiskSizeEnum) isaInstanceProfileDiskSize() bool { + return true +} + +// UnmarshalInstanceProfileDiskSizeEnum unmarshals an instance of InstanceProfileDiskSizeEnum from the specified map of raw messages. +func UnmarshalInstanceProfileDiskSizeEnum(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileDiskSizeEnum) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileDiskSizeFixed : The size of the disk in GB (gigabytes). +// This model "extends" InstanceProfileDiskSize +type InstanceProfileDiskSizeFixed struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The value for this profile field. + Value *int64 `json:"value" validate:"required"` +} + +// Constants associated with the InstanceProfileDiskSizeFixed.Type property. +// The type for this profile field. +const ( + InstanceProfileDiskSizeFixedTypeFixedConst = "fixed" +) + +func (*InstanceProfileDiskSizeFixed) isaInstanceProfileDiskSize() bool { + return true +} + +// UnmarshalInstanceProfileDiskSizeFixed unmarshals an instance of InstanceProfileDiskSizeFixed from the specified map of raw messages. +func UnmarshalInstanceProfileDiskSizeFixed(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileDiskSizeFixed) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileDiskSizeRange : The permitted range for the disk size of this configuration in GB (gigabytes) for an instance with this profile. +// This model "extends" InstanceProfileDiskSize +type InstanceProfileDiskSizeRange struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The maximum value for this profile field. + Max *int64 `json:"max" validate:"required"` + + // The minimum value for this profile field. + Min *int64 `json:"min" validate:"required"` + + // The increment step value for this profile field. + Step *int64 `json:"step" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the InstanceProfileDiskSizeRange.Type property. +// The type for this profile field. +const ( + InstanceProfileDiskSizeRangeTypeRangeConst = "range" +) + +func (*InstanceProfileDiskSizeRange) isaInstanceProfileDiskSize() bool { + return true +} + +// UnmarshalInstanceProfileDiskSizeRange unmarshals an instance of InstanceProfileDiskSizeRange from the specified map of raw messages. +func UnmarshalInstanceProfileDiskSizeRange(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileDiskSizeRange) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileGpuDependent : The GPU count for an instance with this profile depends on its configuration. +// This model "extends" InstanceProfileGpu +type InstanceProfileGpuDependent struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the InstanceProfileGpuDependent.Type property. +// The type for this profile field. +const ( + InstanceProfileGpuDependentTypeDependentConst = "dependent" +) + +func (*InstanceProfileGpuDependent) isaInstanceProfileGpu() bool { + return true +} + +// UnmarshalInstanceProfileGpuDependent unmarshals an instance of InstanceProfileGpuDependent from the specified map of raw messages. +func UnmarshalInstanceProfileGpuDependent(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileGpuDependent) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileGpuEnum : The permitted GPU count values for an instance with this profile. +// This model "extends" InstanceProfileGpu +type InstanceProfileGpuEnum struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The permitted values for this profile field. + Values []int64 `json:"values" validate:"required"` +} + +// Constants associated with the InstanceProfileGpuEnum.Type property. +// The type for this profile field. +const ( + InstanceProfileGpuEnumTypeEnumConst = "enum" +) + +func (*InstanceProfileGpuEnum) isaInstanceProfileGpu() bool { + return true +} + +// UnmarshalInstanceProfileGpuEnum unmarshals an instance of InstanceProfileGpuEnum from the specified map of raw messages. +func UnmarshalInstanceProfileGpuEnum(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileGpuEnum) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileGpuFixed : The GPU count for an instance with this profile. +// This model "extends" InstanceProfileGpu +type InstanceProfileGpuFixed struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The value for this profile field. + Value *int64 `json:"value" validate:"required"` +} + +// Constants associated with the InstanceProfileGpuFixed.Type property. +// The type for this profile field. +const ( + InstanceProfileGpuFixedTypeFixedConst = "fixed" +) + +func (*InstanceProfileGpuFixed) isaInstanceProfileGpu() bool { + return true +} + +// UnmarshalInstanceProfileGpuFixed unmarshals an instance of InstanceProfileGpuFixed from the specified map of raw messages. +func UnmarshalInstanceProfileGpuFixed(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileGpuFixed) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileGpuMemoryDependent : The overall GPU memory value for an instance with this profile depends on its configuration. +// This model "extends" InstanceProfileGpuMemory +type InstanceProfileGpuMemoryDependent struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the InstanceProfileGpuMemoryDependent.Type property. +// The type for this profile field. +const ( + InstanceProfileGpuMemoryDependentTypeDependentConst = "dependent" +) + +func (*InstanceProfileGpuMemoryDependent) isaInstanceProfileGpuMemory() bool { + return true +} + +// UnmarshalInstanceProfileGpuMemoryDependent unmarshals an instance of InstanceProfileGpuMemoryDependent from the specified map of raw messages. +func UnmarshalInstanceProfileGpuMemoryDependent(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileGpuMemoryDependent) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileGpuMemoryEnum : The permitted overall GPU memory values in GiB (gibibytes) for an instance with this profile. +// This model "extends" InstanceProfileGpuMemory +type InstanceProfileGpuMemoryEnum struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The permitted values for this profile field. + Values []int64 `json:"values" validate:"required"` +} + +// Constants associated with the InstanceProfileGpuMemoryEnum.Type property. +// The type for this profile field. +const ( + InstanceProfileGpuMemoryEnumTypeEnumConst = "enum" +) + +func (*InstanceProfileGpuMemoryEnum) isaInstanceProfileGpuMemory() bool { + return true +} + +// UnmarshalInstanceProfileGpuMemoryEnum unmarshals an instance of InstanceProfileGpuMemoryEnum from the specified map of raw messages. +func UnmarshalInstanceProfileGpuMemoryEnum(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileGpuMemoryEnum) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileGpuMemoryFixed : The overall GPU memory in GiB (gibibytes) for an instance with this profile. +// This model "extends" InstanceProfileGpuMemory +type InstanceProfileGpuMemoryFixed struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The value for this profile field. + Value *int64 `json:"value" validate:"required"` +} + +// Constants associated with the InstanceProfileGpuMemoryFixed.Type property. +// The type for this profile field. +const ( + InstanceProfileGpuMemoryFixedTypeFixedConst = "fixed" +) + +func (*InstanceProfileGpuMemoryFixed) isaInstanceProfileGpuMemory() bool { + return true +} + +// UnmarshalInstanceProfileGpuMemoryFixed unmarshals an instance of InstanceProfileGpuMemoryFixed from the specified map of raw messages. +func UnmarshalInstanceProfileGpuMemoryFixed(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileGpuMemoryFixed) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileGpuMemoryRange : The permitted overall GPU memory range in GiB (gibibytes) for an instance with this profile. +// This model "extends" InstanceProfileGpuMemory +type InstanceProfileGpuMemoryRange struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The maximum value for this profile field. + Max *int64 `json:"max" validate:"required"` + + // The minimum value for this profile field. + Min *int64 `json:"min" validate:"required"` + + // The increment step value for this profile field. + Step *int64 `json:"step" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the InstanceProfileGpuMemoryRange.Type property. +// The type for this profile field. +const ( + InstanceProfileGpuMemoryRangeTypeRangeConst = "range" +) + +func (*InstanceProfileGpuMemoryRange) isaInstanceProfileGpuMemory() bool { + return true +} + +// UnmarshalInstanceProfileGpuMemoryRange unmarshals an instance of InstanceProfileGpuMemoryRange from the specified map of raw messages. +func UnmarshalInstanceProfileGpuMemoryRange(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileGpuMemoryRange) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileGpuRange : The permitted GPU count range for an instance with this profile. +// This model "extends" InstanceProfileGpu +type InstanceProfileGpuRange struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The maximum value for this profile field. + Max *int64 `json:"max" validate:"required"` + + // The minimum value for this profile field. + Min *int64 `json:"min" validate:"required"` + + // The increment step value for this profile field. + Step *int64 `json:"step" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the InstanceProfileGpuRange.Type property. +// The type for this profile field. +const ( + InstanceProfileGpuRangeTypeRangeConst = "range" +) + +func (*InstanceProfileGpuRange) isaInstanceProfileGpu() bool { + return true +} + +// UnmarshalInstanceProfileGpuRange unmarshals an instance of InstanceProfileGpuRange from the specified map of raw messages. +func UnmarshalInstanceProfileGpuRange(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileGpuRange) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileIdentityByHref : InstanceProfileIdentityByHref struct +// This model "extends" InstanceProfileIdentity +type InstanceProfileIdentityByHref struct { + // The URL for this virtual server instance profile. + Href *string `json:"href" validate:"required"` +} + +// NewInstanceProfileIdentityByHref : Instantiate InstanceProfileIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewInstanceProfileIdentityByHref(href string) (_model *InstanceProfileIdentityByHref, err error) { + _model = &InstanceProfileIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstanceProfileIdentityByHref) isaInstanceProfileIdentity() bool { + return true +} + +// UnmarshalInstanceProfileIdentityByHref unmarshals an instance of InstanceProfileIdentityByHref from the specified map of raw messages. +func UnmarshalInstanceProfileIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileIdentityByName : InstanceProfileIdentityByName struct +// This model "extends" InstanceProfileIdentity +type InstanceProfileIdentityByName struct { + // The globally unique name for this virtual server instance profile. + Name *string `json:"name" validate:"required"` +} + +// NewInstanceProfileIdentityByName : Instantiate InstanceProfileIdentityByName (Generic Model Constructor) +func (*VpcV1) NewInstanceProfileIdentityByName(name string) (_model *InstanceProfileIdentityByName, err error) { + _model = &InstanceProfileIdentityByName{ + Name: core.StringPtr(name), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstanceProfileIdentityByName) isaInstanceProfileIdentity() bool { + return true +} + +// UnmarshalInstanceProfileIdentityByName unmarshals an instance of InstanceProfileIdentityByName from the specified map of raw messages. +func UnmarshalInstanceProfileIdentityByName(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileIdentityByName) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileMemoryDependent : The memory value for an instance with this profile depends on its configuration. +// This model "extends" InstanceProfileMemory +type InstanceProfileMemoryDependent struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the InstanceProfileMemoryDependent.Type property. +// The type for this profile field. +const ( + InstanceProfileMemoryDependentTypeDependentConst = "dependent" +) + +func (*InstanceProfileMemoryDependent) isaInstanceProfileMemory() bool { + return true +} + +// UnmarshalInstanceProfileMemoryDependent unmarshals an instance of InstanceProfileMemoryDependent from the specified map of raw messages. +func UnmarshalInstanceProfileMemoryDependent(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileMemoryDependent) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileMemoryEnum : The permitted memory values (in gibibytes) for an instance with this profile. +// This model "extends" InstanceProfileMemory +type InstanceProfileMemoryEnum struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The permitted values for this profile field. + Values []int64 `json:"values" validate:"required"` +} + +// Constants associated with the InstanceProfileMemoryEnum.Type property. +// The type for this profile field. +const ( + InstanceProfileMemoryEnumTypeEnumConst = "enum" +) + +func (*InstanceProfileMemoryEnum) isaInstanceProfileMemory() bool { + return true +} + +// UnmarshalInstanceProfileMemoryEnum unmarshals an instance of InstanceProfileMemoryEnum from the specified map of raw messages. +func UnmarshalInstanceProfileMemoryEnum(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileMemoryEnum) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileMemoryFixed : The memory (in gibibytes) for an instance with this profile. +// This model "extends" InstanceProfileMemory +type InstanceProfileMemoryFixed struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The value for this profile field. + Value *int64 `json:"value" validate:"required"` +} + +// Constants associated with the InstanceProfileMemoryFixed.Type property. +// The type for this profile field. +const ( + InstanceProfileMemoryFixedTypeFixedConst = "fixed" +) + +func (*InstanceProfileMemoryFixed) isaInstanceProfileMemory() bool { + return true +} + +// UnmarshalInstanceProfileMemoryFixed unmarshals an instance of InstanceProfileMemoryFixed from the specified map of raw messages. +func UnmarshalInstanceProfileMemoryFixed(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileMemoryFixed) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileMemoryRange : The permitted memory range (in gibibytes) for an instance with this profile. +// This model "extends" InstanceProfileMemory +type InstanceProfileMemoryRange struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The maximum value for this profile field. + Max *int64 `json:"max" validate:"required"` + + // The minimum value for this profile field. + Min *int64 `json:"min" validate:"required"` + + // The increment step value for this profile field. + Step *int64 `json:"step" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the InstanceProfileMemoryRange.Type property. +// The type for this profile field. +const ( + InstanceProfileMemoryRangeTypeRangeConst = "range" +) + +func (*InstanceProfileMemoryRange) isaInstanceProfileMemory() bool { + return true +} + +// UnmarshalInstanceProfileMemoryRange unmarshals an instance of InstanceProfileMemoryRange from the specified map of raw messages. +func UnmarshalInstanceProfileMemoryRange(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileMemoryRange) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileNetworkInterfaceCountDependent : The number of network interfaces supported on an instance with this profile is dependent on its configuration. +// This model "extends" InstanceProfileNetworkInterfaceCount +type InstanceProfileNetworkInterfaceCountDependent struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the InstanceProfileNetworkInterfaceCountDependent.Type property. +// The type for this profile field. +const ( + InstanceProfileNetworkInterfaceCountDependentTypeDependentConst = "dependent" +) + +func (*InstanceProfileNetworkInterfaceCountDependent) isaInstanceProfileNetworkInterfaceCount() bool { + return true +} + +// UnmarshalInstanceProfileNetworkInterfaceCountDependent unmarshals an instance of InstanceProfileNetworkInterfaceCountDependent from the specified map of raw messages. +func UnmarshalInstanceProfileNetworkInterfaceCountDependent(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileNetworkInterfaceCountDependent) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileNetworkInterfaceCountRange : The number of network interfaces supported on an instance with this profile. +// This model "extends" InstanceProfileNetworkInterfaceCount +type InstanceProfileNetworkInterfaceCountRange struct { + // The maximum value for this profile field. + Max *int64 `json:"max,omitempty"` + + // The minimum value for this profile field. + Min *int64 `json:"min,omitempty"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the InstanceProfileNetworkInterfaceCountRange.Type property. +// The type for this profile field. +const ( + InstanceProfileNetworkInterfaceCountRangeTypeRangeConst = "range" +) + +func (*InstanceProfileNetworkInterfaceCountRange) isaInstanceProfileNetworkInterfaceCount() bool { + return true +} + +// UnmarshalInstanceProfileNetworkInterfaceCountRange unmarshals an instance of InstanceProfileNetworkInterfaceCountRange from the specified map of raw messages. +func UnmarshalInstanceProfileNetworkInterfaceCountRange(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileNetworkInterfaceCountRange) + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfilePortSpeedDependent : The port speed of each network interface of an instance with this profile depends on its configuration. +// This model "extends" InstanceProfilePortSpeed +type InstanceProfilePortSpeedDependent struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the InstanceProfilePortSpeedDependent.Type property. +// The type for this profile field. +const ( + InstanceProfilePortSpeedDependentTypeDependentConst = "dependent" +) + +func (*InstanceProfilePortSpeedDependent) isaInstanceProfilePortSpeed() bool { + return true +} + +// UnmarshalInstanceProfilePortSpeedDependent unmarshals an instance of InstanceProfilePortSpeedDependent from the specified map of raw messages. +func UnmarshalInstanceProfilePortSpeedDependent(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfilePortSpeedDependent) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfilePortSpeedFixed : The maximum speed (in megabits per second) of each network interface of an instance with this profile. +// This model "extends" InstanceProfilePortSpeed +type InstanceProfilePortSpeedFixed struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The value for this profile field. + Value *int64 `json:"value" validate:"required"` +} + +// Constants associated with the InstanceProfilePortSpeedFixed.Type property. +// The type for this profile field. +const ( + InstanceProfilePortSpeedFixedTypeFixedConst = "fixed" +) + +func (*InstanceProfilePortSpeedFixed) isaInstanceProfilePortSpeed() bool { + return true +} + +// UnmarshalInstanceProfilePortSpeedFixed unmarshals an instance of InstanceProfilePortSpeedFixed from the specified map of raw messages. +func UnmarshalInstanceProfilePortSpeedFixed(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfilePortSpeedFixed) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileVcpuDependent : The VCPU count for an instance with this profile depends on its configuration. +// This model "extends" InstanceProfileVcpu +type InstanceProfileVcpuDependent struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the InstanceProfileVcpuDependent.Type property. +// The type for this profile field. +const ( + InstanceProfileVcpuDependentTypeDependentConst = "dependent" +) + +func (*InstanceProfileVcpuDependent) isaInstanceProfileVcpu() bool { + return true +} + +// UnmarshalInstanceProfileVcpuDependent unmarshals an instance of InstanceProfileVcpuDependent from the specified map of raw messages. +func UnmarshalInstanceProfileVcpuDependent(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileVcpuDependent) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileVcpuEnum : The permitted values for VCPU count for an instance with this profile. +// This model "extends" InstanceProfileVcpu +type InstanceProfileVcpuEnum struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The permitted values for this profile field. + Values []int64 `json:"values" validate:"required"` +} + +// Constants associated with the InstanceProfileVcpuEnum.Type property. +// The type for this profile field. +const ( + InstanceProfileVcpuEnumTypeEnumConst = "enum" +) + +func (*InstanceProfileVcpuEnum) isaInstanceProfileVcpu() bool { + return true +} + +// UnmarshalInstanceProfileVcpuEnum unmarshals an instance of InstanceProfileVcpuEnum from the specified map of raw messages. +func UnmarshalInstanceProfileVcpuEnum(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileVcpuEnum) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileVcpuFixed : The VCPU count for an instance with this profile. +// This model "extends" InstanceProfileVcpu +type InstanceProfileVcpuFixed struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The value for this profile field. + Value *int64 `json:"value" validate:"required"` +} + +// Constants associated with the InstanceProfileVcpuFixed.Type property. +// The type for this profile field. +const ( + InstanceProfileVcpuFixedTypeFixedConst = "fixed" +) + +func (*InstanceProfileVcpuFixed) isaInstanceProfileVcpu() bool { + return true +} + +// UnmarshalInstanceProfileVcpuFixed unmarshals an instance of InstanceProfileVcpuFixed from the specified map of raw messages. +func UnmarshalInstanceProfileVcpuFixed(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileVcpuFixed) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileVcpuRange : The permitted range for VCPU count for an instance with this profile. +// This model "extends" InstanceProfileVcpu +type InstanceProfileVcpuRange struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The maximum value for this profile field. + Max *int64 `json:"max" validate:"required"` + + // The minimum value for this profile field. + Min *int64 `json:"min" validate:"required"` + + // The increment step value for this profile field. + Step *int64 `json:"step" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the InstanceProfileVcpuRange.Type property. +// The type for this profile field. +const ( + InstanceProfileVcpuRangeTypeRangeConst = "range" +) + +func (*InstanceProfileVcpuRange) isaInstanceProfileVcpu() bool { + return true +} + +// UnmarshalInstanceProfileVcpuRange unmarshals an instance of InstanceProfileVcpuRange from the specified map of raw messages. +func UnmarshalInstanceProfileVcpuRange(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileVcpuRange) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileVolumeBandwidthDependent : The storage bandwidth shared across the storage volumes of an instance with this profile depends on its +// configuration. +// This model "extends" InstanceProfileVolumeBandwidth +type InstanceProfileVolumeBandwidthDependent struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the InstanceProfileVolumeBandwidthDependent.Type property. +// The type for this profile field. +const ( + InstanceProfileVolumeBandwidthDependentTypeDependentConst = "dependent" +) + +func (*InstanceProfileVolumeBandwidthDependent) isaInstanceProfileVolumeBandwidth() bool { + return true +} + +// UnmarshalInstanceProfileVolumeBandwidthDependent unmarshals an instance of InstanceProfileVolumeBandwidthDependent from the specified map of raw messages. +func UnmarshalInstanceProfileVolumeBandwidthDependent(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileVolumeBandwidthDependent) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileVolumeBandwidthEnum : The permitted storage bandwidth values (in megabits per second) shared across the storage volumes of an instance with +// this profile. +// This model "extends" InstanceProfileVolumeBandwidth +type InstanceProfileVolumeBandwidthEnum struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The permitted values for this profile field. + Values []int64 `json:"values" validate:"required"` +} + +// Constants associated with the InstanceProfileVolumeBandwidthEnum.Type property. +// The type for this profile field. +const ( + InstanceProfileVolumeBandwidthEnumTypeEnumConst = "enum" +) + +func (*InstanceProfileVolumeBandwidthEnum) isaInstanceProfileVolumeBandwidth() bool { + return true +} + +// UnmarshalInstanceProfileVolumeBandwidthEnum unmarshals an instance of InstanceProfileVolumeBandwidthEnum from the specified map of raw messages. +func UnmarshalInstanceProfileVolumeBandwidthEnum(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileVolumeBandwidthEnum) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileVolumeBandwidthFixed : The storage bandwidth (in megabits per second) shared across the storage volumes of an instance with this profile. +// This model "extends" InstanceProfileVolumeBandwidth +type InstanceProfileVolumeBandwidthFixed struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The value for this profile field. + Value *int64 `json:"value" validate:"required"` +} + +// Constants associated with the InstanceProfileVolumeBandwidthFixed.Type property. +// The type for this profile field. +const ( + InstanceProfileVolumeBandwidthFixedTypeFixedConst = "fixed" +) + +func (*InstanceProfileVolumeBandwidthFixed) isaInstanceProfileVolumeBandwidth() bool { + return true +} + +// UnmarshalInstanceProfileVolumeBandwidthFixed unmarshals an instance of InstanceProfileVolumeBandwidthFixed from the specified map of raw messages. +func UnmarshalInstanceProfileVolumeBandwidthFixed(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileVolumeBandwidthFixed) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceProfileVolumeBandwidthRange : The permitted storage bandwidth range (in megabits per second) shared across the storage volumes of an instance with +// this profile. +// This model "extends" InstanceProfileVolumeBandwidth +type InstanceProfileVolumeBandwidthRange struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The maximum value for this profile field. + Max *int64 `json:"max" validate:"required"` + + // The minimum value for this profile field. + Min *int64 `json:"min" validate:"required"` + + // The increment step value for this profile field. + Step *int64 `json:"step" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the InstanceProfileVolumeBandwidthRange.Type property. +// The type for this profile field. +const ( + InstanceProfileVolumeBandwidthRangeTypeRangeConst = "range" +) + +func (*InstanceProfileVolumeBandwidthRange) isaInstanceProfileVolumeBandwidth() bool { + return true +} + +// UnmarshalInstanceProfileVolumeBandwidthRange unmarshals an instance of InstanceProfileVolumeBandwidthRange from the specified map of raw messages. +func UnmarshalInstanceProfileVolumeBandwidthRange(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceProfileVolumeBandwidthRange) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePrototypeInstanceByCatalogOffering : Create an instance by using a catalog offering. +// This model "extends" InstancePrototype +type InstancePrototypeInstanceByCatalogOffering struct { + // The availability policy to use for this virtual server instance. + AvailabilityPolicy *InstanceAvailabilityPolicyPrototype `json:"availability_policy,omitempty"` + + // The default trusted profile configuration to use for this virtual server instance + // + // This property's value is used when provisioning the virtual server instance, but not subsequently managed. + // Accordingly, it is reflected as an [instance + // initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) property. + DefaultTrustedProfile *InstanceDefaultTrustedProfilePrototype `json:"default_trusted_profile,omitempty"` + + // The public SSH keys for the administrative user of the virtual server instance. Keys will be made available to the + // virtual server instance as cloud-init vendor data. For cloud-init enabled images, these keys will also be added as + // SSH authorized keys for the administrative user. + // + // For Windows images, the keys of type `rsa` must be specified, and one will be selected to encrypt [the administrator + // password](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization). Keys are optional for other images, but if + // no keys are specified, the instance will be inaccessible unless the specified image provides another means of + // access. + // + // This property's value is used when provisioning the virtual server instance, but not subsequently managed. + // Accordingly, it is reflected as an [instance + // initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) property. + Keys []KeyIdentityIntf `json:"keys,omitempty"` + + MetadataService *InstanceMetadataServicePrototype `json:"metadata_service,omitempty"` + + // The name for this virtual server instance. The name must not be used by another virtual server instance in the + // region. If unspecified, the name will be a hyphenated list of randomly-selected words. + // + // The system hostname will be based on this name. + Name *string `json:"name,omitempty"` + + // The placement restrictions to use for the virtual server instance. + PlacementTarget InstancePlacementTargetPrototypeIntf `json:"placement_target,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-profiles) to use for this virtual server instance. + // + // If unspecified, `bx2-2x8` will be used, but this default value is expected to change in the future. + Profile InstanceProfileIdentityIntf `json:"profile,omitempty"` + + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes. An increase in + // this value will result in a corresponding decrease to + // `total_network_bandwidth`. + TotalVolumeBandwidth *int64 `json:"total_volume_bandwidth,omitempty"` + + // [User data](https://cloud.ibm.com/docs/vpc?topic=vpc-user-data) to make available when setting up the virtual server + // instance. + UserData *string `json:"user_data,omitempty"` + + // The additional volume attachments to create for the virtual server instance. + VolumeAttachments []VolumeAttachmentPrototype `json:"volume_attachments,omitempty"` + + // The VPC this virtual server instance will reside in. + // + // If specified, it must match the VPC for the subnets of the instance network interfaces. + VPC VPCIdentityIntf `json:"vpc,omitempty"` + + // The boot volume attachment to create for the virtual server instance. + BootVolumeAttachment *VolumeAttachmentPrototypeInstanceByImageContext `json:"boot_volume_attachment,omitempty"` + + // The [catalog](https://cloud.ibm.com/docs/account?topic=account-restrict-by-user) offering + // or offering version to use when provisioning this virtual server instance. + // + // If an offering is specified, the latest version of that offering will be used. + // + // The specified offering or offering version may be in a different account in the same + // [enterprise](https://cloud.ibm.com/docs/account?topic=account-what-is-enterprise), subject + // to IAM policies. + CatalogOffering InstanceCatalogOfferingPrototypeIntf `json:"catalog_offering" validate:"required"` + + // The additional instance network interfaces to create. + NetworkInterfaces []NetworkInterfacePrototype `json:"network_interfaces,omitempty"` + + // The primary instance network interface to create. + PrimaryNetworkInterface *NetworkInterfacePrototype `json:"primary_network_interface" validate:"required"` + + // The zone this virtual server instance will reside in. + Zone ZoneIdentityIntf `json:"zone" validate:"required"` +} + +// NewInstancePrototypeInstanceByCatalogOffering : Instantiate InstancePrototypeInstanceByCatalogOffering (Generic Model Constructor) +func (*VpcV1) NewInstancePrototypeInstanceByCatalogOffering(catalogOffering InstanceCatalogOfferingPrototypeIntf, primaryNetworkInterface *NetworkInterfacePrototype, zone ZoneIdentityIntf) (_model *InstancePrototypeInstanceByCatalogOffering, err error) { + _model = &InstancePrototypeInstanceByCatalogOffering{ + CatalogOffering: catalogOffering, + PrimaryNetworkInterface: primaryNetworkInterface, + Zone: zone, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstancePrototypeInstanceByCatalogOffering) isaInstancePrototype() bool { + return true +} + +// UnmarshalInstancePrototypeInstanceByCatalogOffering unmarshals an instance of InstancePrototypeInstanceByCatalogOffering from the specified map of raw messages. +func UnmarshalInstancePrototypeInstanceByCatalogOffering(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePrototypeInstanceByCatalogOffering) + err = core.UnmarshalModel(m, "availability_policy", &obj.AvailabilityPolicy, UnmarshalInstanceAvailabilityPolicyPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "default_trusted_profile", &obj.DefaultTrustedProfile, UnmarshalInstanceDefaultTrustedProfilePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "keys", &obj.Keys, UnmarshalKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "metadata_service", &obj.MetadataService, UnmarshalInstanceMetadataServicePrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "placement_target", &obj.PlacementTarget, UnmarshalInstancePlacementTargetPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalInstanceProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_volume_bandwidth", &obj.TotalVolumeBandwidth) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_data", &obj.UserData) + if err != nil { + return + } + err = core.UnmarshalModel(m, "volume_attachments", &obj.VolumeAttachments, UnmarshalVolumeAttachmentPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "boot_volume_attachment", &obj.BootVolumeAttachment, UnmarshalVolumeAttachmentPrototypeInstanceByImageContext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "catalog_offering", &obj.CatalogOffering, UnmarshalInstanceCatalogOfferingPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "network_interfaces", &obj.NetworkInterfaces, UnmarshalNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_network_interface", &obj.PrimaryNetworkInterface, UnmarshalNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePrototypeInstanceByImage : Create an instance by using an image. +// This model "extends" InstancePrototype +type InstancePrototypeInstanceByImage struct { + // The availability policy to use for this virtual server instance. + AvailabilityPolicy *InstanceAvailabilityPolicyPrototype `json:"availability_policy,omitempty"` + + // The default trusted profile configuration to use for this virtual server instance + // + // This property's value is used when provisioning the virtual server instance, but not subsequently managed. + // Accordingly, it is reflected as an [instance + // initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) property. + DefaultTrustedProfile *InstanceDefaultTrustedProfilePrototype `json:"default_trusted_profile,omitempty"` + + // The public SSH keys for the administrative user of the virtual server instance. Keys will be made available to the + // virtual server instance as cloud-init vendor data. For cloud-init enabled images, these keys will also be added as + // SSH authorized keys for the administrative user. + // + // For Windows images, the keys of type `rsa` must be specified, and one will be selected to encrypt [the administrator + // password](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization). Keys are optional for other images, but if + // no keys are specified, the instance will be inaccessible unless the specified image provides another means of + // access. + // + // This property's value is used when provisioning the virtual server instance, but not subsequently managed. + // Accordingly, it is reflected as an [instance + // initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) property. + Keys []KeyIdentityIntf `json:"keys,omitempty"` + + MetadataService *InstanceMetadataServicePrototype `json:"metadata_service,omitempty"` + + // The name for this virtual server instance. The name must not be used by another virtual server instance in the + // region. If unspecified, the name will be a hyphenated list of randomly-selected words. + // + // The system hostname will be based on this name. + Name *string `json:"name,omitempty"` + + // The placement restrictions to use for the virtual server instance. + PlacementTarget InstancePlacementTargetPrototypeIntf `json:"placement_target,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-profiles) to use for this virtual server instance. + // + // If unspecified, `bx2-2x8` will be used, but this default value is expected to change in the future. + Profile InstanceProfileIdentityIntf `json:"profile,omitempty"` + + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes. An increase in + // this value will result in a corresponding decrease to + // `total_network_bandwidth`. + TotalVolumeBandwidth *int64 `json:"total_volume_bandwidth,omitempty"` + + // [User data](https://cloud.ibm.com/docs/vpc?topic=vpc-user-data) to make available when setting up the virtual server + // instance. + UserData *string `json:"user_data,omitempty"` + + // The additional volume attachments to create for the virtual server instance. + VolumeAttachments []VolumeAttachmentPrototype `json:"volume_attachments,omitempty"` + + // The VPC this virtual server instance will reside in. + // + // If specified, it must match the VPC for the subnets of the instance network interfaces. + VPC VPCIdentityIntf `json:"vpc,omitempty"` + + // The boot volume attachment to create for the virtual server instance. + BootVolumeAttachment *VolumeAttachmentPrototypeInstanceByImageContext `json:"boot_volume_attachment,omitempty"` + + // The image to use when provisioning the virtual server instance. + Image ImageIdentityIntf `json:"image" validate:"required"` + + // The additional instance network interfaces to create. + NetworkInterfaces []NetworkInterfacePrototype `json:"network_interfaces,omitempty"` + + // The primary instance network interface to create. + PrimaryNetworkInterface *NetworkInterfacePrototype `json:"primary_network_interface" validate:"required"` + + // The zone this virtual server instance will reside in. + Zone ZoneIdentityIntf `json:"zone" validate:"required"` +} + +// NewInstancePrototypeInstanceByImage : Instantiate InstancePrototypeInstanceByImage (Generic Model Constructor) +func (*VpcV1) NewInstancePrototypeInstanceByImage(image ImageIdentityIntf, primaryNetworkInterface *NetworkInterfacePrototype, zone ZoneIdentityIntf) (_model *InstancePrototypeInstanceByImage, err error) { + _model = &InstancePrototypeInstanceByImage{ + Image: image, + PrimaryNetworkInterface: primaryNetworkInterface, + Zone: zone, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstancePrototypeInstanceByImage) isaInstancePrototype() bool { + return true +} + +// UnmarshalInstancePrototypeInstanceByImage unmarshals an instance of InstancePrototypeInstanceByImage from the specified map of raw messages. +func UnmarshalInstancePrototypeInstanceByImage(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePrototypeInstanceByImage) + err = core.UnmarshalModel(m, "availability_policy", &obj.AvailabilityPolicy, UnmarshalInstanceAvailabilityPolicyPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "default_trusted_profile", &obj.DefaultTrustedProfile, UnmarshalInstanceDefaultTrustedProfilePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "keys", &obj.Keys, UnmarshalKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "metadata_service", &obj.MetadataService, UnmarshalInstanceMetadataServicePrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "placement_target", &obj.PlacementTarget, UnmarshalInstancePlacementTargetPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalInstanceProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_volume_bandwidth", &obj.TotalVolumeBandwidth) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_data", &obj.UserData) + if err != nil { + return + } + err = core.UnmarshalModel(m, "volume_attachments", &obj.VolumeAttachments, UnmarshalVolumeAttachmentPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "boot_volume_attachment", &obj.BootVolumeAttachment, UnmarshalVolumeAttachmentPrototypeInstanceByImageContext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "image", &obj.Image, UnmarshalImageIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "network_interfaces", &obj.NetworkInterfaces, UnmarshalNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_network_interface", &obj.PrimaryNetworkInterface, UnmarshalNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePrototypeInstanceBySourceSnapshot : Create an instance by using a snapshot. +// This model "extends" InstancePrototype +type InstancePrototypeInstanceBySourceSnapshot struct { + // The availability policy to use for this virtual server instance. + AvailabilityPolicy *InstanceAvailabilityPolicyPrototype `json:"availability_policy,omitempty"` + + // The default trusted profile configuration to use for this virtual server instance + // + // This property's value is used when provisioning the virtual server instance, but not subsequently managed. + // Accordingly, it is reflected as an [instance + // initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) property. + DefaultTrustedProfile *InstanceDefaultTrustedProfilePrototype `json:"default_trusted_profile,omitempty"` + + // The public SSH keys for the administrative user of the virtual server instance. Keys will be made available to the + // virtual server instance as cloud-init vendor data. For cloud-init enabled images, these keys will also be added as + // SSH authorized keys for the administrative user. + // + // For Windows images, the keys of type `rsa` must be specified, and one will be selected to encrypt [the administrator + // password](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization). Keys are optional for other images, but if + // no keys are specified, the instance will be inaccessible unless the specified image provides another means of + // access. + // + // This property's value is used when provisioning the virtual server instance, but not subsequently managed. + // Accordingly, it is reflected as an [instance + // initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) property. + Keys []KeyIdentityIntf `json:"keys,omitempty"` + + MetadataService *InstanceMetadataServicePrototype `json:"metadata_service,omitempty"` + + // The name for this virtual server instance. The name must not be used by another virtual server instance in the + // region. If unspecified, the name will be a hyphenated list of randomly-selected words. + // + // The system hostname will be based on this name. + Name *string `json:"name,omitempty"` + + // The placement restrictions to use for the virtual server instance. + PlacementTarget InstancePlacementTargetPrototypeIntf `json:"placement_target,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-profiles) to use for this virtual server instance. + // + // If unspecified, `bx2-2x8` will be used, but this default value is expected to change in the future. + Profile InstanceProfileIdentityIntf `json:"profile,omitempty"` + + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes. An increase in + // this value will result in a corresponding decrease to + // `total_network_bandwidth`. + TotalVolumeBandwidth *int64 `json:"total_volume_bandwidth,omitempty"` + + // [User data](https://cloud.ibm.com/docs/vpc?topic=vpc-user-data) to make available when setting up the virtual server + // instance. + UserData *string `json:"user_data,omitempty"` + + // The additional volume attachments to create for the virtual server instance. + VolumeAttachments []VolumeAttachmentPrototype `json:"volume_attachments,omitempty"` + + // The VPC this virtual server instance will reside in. + // + // If specified, it must match the VPC for the subnets of the instance network interfaces. + VPC VPCIdentityIntf `json:"vpc,omitempty"` + + // The boot volume attachment to create for the virtual server instance. + BootVolumeAttachment *VolumeAttachmentPrototypeInstanceBySourceSnapshotContext `json:"boot_volume_attachment" validate:"required"` + + // The additional instance network interfaces to create. + NetworkInterfaces []NetworkInterfacePrototype `json:"network_interfaces,omitempty"` + + // The primary instance network interface to create. + PrimaryNetworkInterface *NetworkInterfacePrototype `json:"primary_network_interface" validate:"required"` + + // The zone this virtual server instance will reside in. + Zone ZoneIdentityIntf `json:"zone" validate:"required"` +} + +// NewInstancePrototypeInstanceBySourceSnapshot : Instantiate InstancePrototypeInstanceBySourceSnapshot (Generic Model Constructor) +func (*VpcV1) NewInstancePrototypeInstanceBySourceSnapshot(bootVolumeAttachment *VolumeAttachmentPrototypeInstanceBySourceSnapshotContext, primaryNetworkInterface *NetworkInterfacePrototype, zone ZoneIdentityIntf) (_model *InstancePrototypeInstanceBySourceSnapshot, err error) { + _model = &InstancePrototypeInstanceBySourceSnapshot{ + BootVolumeAttachment: bootVolumeAttachment, + PrimaryNetworkInterface: primaryNetworkInterface, + Zone: zone, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstancePrototypeInstanceBySourceSnapshot) isaInstancePrototype() bool { + return true +} + +// UnmarshalInstancePrototypeInstanceBySourceSnapshot unmarshals an instance of InstancePrototypeInstanceBySourceSnapshot from the specified map of raw messages. +func UnmarshalInstancePrototypeInstanceBySourceSnapshot(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePrototypeInstanceBySourceSnapshot) + err = core.UnmarshalModel(m, "availability_policy", &obj.AvailabilityPolicy, UnmarshalInstanceAvailabilityPolicyPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "default_trusted_profile", &obj.DefaultTrustedProfile, UnmarshalInstanceDefaultTrustedProfilePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "keys", &obj.Keys, UnmarshalKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "metadata_service", &obj.MetadataService, UnmarshalInstanceMetadataServicePrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "placement_target", &obj.PlacementTarget, UnmarshalInstancePlacementTargetPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalInstanceProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_volume_bandwidth", &obj.TotalVolumeBandwidth) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_data", &obj.UserData) + if err != nil { + return + } + err = core.UnmarshalModel(m, "volume_attachments", &obj.VolumeAttachments, UnmarshalVolumeAttachmentPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "boot_volume_attachment", &obj.BootVolumeAttachment, UnmarshalVolumeAttachmentPrototypeInstanceBySourceSnapshotContext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "network_interfaces", &obj.NetworkInterfaces, UnmarshalNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_network_interface", &obj.PrimaryNetworkInterface, UnmarshalNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePrototypeInstanceBySourceTemplate : Create an instance by using an instance template. +// +// The `primary_network_interface` and `network_interfaces` properties may only be specified if +// `primary_network_interface` is specified in the source template. +// This model "extends" InstancePrototype +type InstancePrototypeInstanceBySourceTemplate struct { + // The availability policy to use for this virtual server instance. + AvailabilityPolicy *InstanceAvailabilityPolicyPrototype `json:"availability_policy,omitempty"` + + // The default trusted profile configuration to use for this virtual server instance + // + // This property's value is used when provisioning the virtual server instance, but not subsequently managed. + // Accordingly, it is reflected as an [instance + // initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) property. + DefaultTrustedProfile *InstanceDefaultTrustedProfilePrototype `json:"default_trusted_profile,omitempty"` + + // The public SSH keys for the administrative user of the virtual server instance. Keys will be made available to the + // virtual server instance as cloud-init vendor data. For cloud-init enabled images, these keys will also be added as + // SSH authorized keys for the administrative user. + // + // For Windows images, the keys of type `rsa` must be specified, and one will be selected to encrypt [the administrator + // password](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization). Keys are optional for other images, but if + // no keys are specified, the instance will be inaccessible unless the specified image provides another means of + // access. + // + // This property's value is used when provisioning the virtual server instance, but not subsequently managed. + // Accordingly, it is reflected as an [instance + // initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) property. + Keys []KeyIdentityIntf `json:"keys,omitempty"` + + MetadataService *InstanceMetadataServicePrototype `json:"metadata_service,omitempty"` + + // The name for this virtual server instance. The name must not be used by another virtual server instance in the + // region. If unspecified, the name will be a hyphenated list of randomly-selected words. + // + // The system hostname will be based on this name. + Name *string `json:"name,omitempty"` + + // The placement restrictions to use for the virtual server instance. + PlacementTarget InstancePlacementTargetPrototypeIntf `json:"placement_target,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-profiles) to use for this virtual server instance. + // + // If unspecified, `bx2-2x8` will be used, but this default value is expected to change in the future. + Profile InstanceProfileIdentityIntf `json:"profile,omitempty"` + + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes. An increase in + // this value will result in a corresponding decrease to + // `total_network_bandwidth`. + TotalVolumeBandwidth *int64 `json:"total_volume_bandwidth,omitempty"` + + // [User data](https://cloud.ibm.com/docs/vpc?topic=vpc-user-data) to make available when setting up the virtual server + // instance. + UserData *string `json:"user_data,omitempty"` + + // The additional volume attachments to create for the virtual server instance. + VolumeAttachments []VolumeAttachmentPrototype `json:"volume_attachments,omitempty"` + + // The VPC this virtual server instance will reside in. + // + // If specified, it must match the VPC for the subnets of the instance network interfaces. + VPC VPCIdentityIntf `json:"vpc,omitempty"` + + // The boot volume attachment to create for the virtual server instance. + BootVolumeAttachment *VolumeAttachmentPrototypeInstanceByImageContext `json:"boot_volume_attachment,omitempty"` + + // The [catalog](https://cloud.ibm.com/docs/account?topic=account-restrict-by-user) + // offering version to use when provisioning this virtual server instance. + // If an offering is specified, the latest version of that offering will be used. + // + // The specified offering or offering version may be in a different account, subject to + // IAM policies. + // + // If specified, `image` must not be specified, and `source_template` must not have + // `image` specified. + CatalogOffering InstanceCatalogOfferingPrototypeIntf `json:"catalog_offering,omitempty"` + + // The image to use when provisioning the virtual server instance. + Image ImageIdentityIntf `json:"image,omitempty"` + + // The additional instance network interfaces to create. + NetworkInterfaces []NetworkInterfacePrototype `json:"network_interfaces,omitempty"` + + // The primary instance network interface to create. + PrimaryNetworkInterface *NetworkInterfacePrototype `json:"primary_network_interface,omitempty"` + + // The template to create this virtual server instance from. + SourceTemplate InstanceTemplateIdentityIntf `json:"source_template" validate:"required"` + + // The zone this virtual server instance will reside in. + Zone ZoneIdentityIntf `json:"zone,omitempty"` +} + +// NewInstancePrototypeInstanceBySourceTemplate : Instantiate InstancePrototypeInstanceBySourceTemplate (Generic Model Constructor) +func (*VpcV1) NewInstancePrototypeInstanceBySourceTemplate(sourceTemplate InstanceTemplateIdentityIntf) (_model *InstancePrototypeInstanceBySourceTemplate, err error) { + _model = &InstancePrototypeInstanceBySourceTemplate{ + SourceTemplate: sourceTemplate, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstancePrototypeInstanceBySourceTemplate) isaInstancePrototype() bool { + return true +} + +// UnmarshalInstancePrototypeInstanceBySourceTemplate unmarshals an instance of InstancePrototypeInstanceBySourceTemplate from the specified map of raw messages. +func UnmarshalInstancePrototypeInstanceBySourceTemplate(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePrototypeInstanceBySourceTemplate) + err = core.UnmarshalModel(m, "availability_policy", &obj.AvailabilityPolicy, UnmarshalInstanceAvailabilityPolicyPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "default_trusted_profile", &obj.DefaultTrustedProfile, UnmarshalInstanceDefaultTrustedProfilePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "keys", &obj.Keys, UnmarshalKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "metadata_service", &obj.MetadataService, UnmarshalInstanceMetadataServicePrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "placement_target", &obj.PlacementTarget, UnmarshalInstancePlacementTargetPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalInstanceProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_volume_bandwidth", &obj.TotalVolumeBandwidth) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_data", &obj.UserData) + if err != nil { + return + } + err = core.UnmarshalModel(m, "volume_attachments", &obj.VolumeAttachments, UnmarshalVolumeAttachmentPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "boot_volume_attachment", &obj.BootVolumeAttachment, UnmarshalVolumeAttachmentPrototypeInstanceByImageContext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "catalog_offering", &obj.CatalogOffering, UnmarshalInstanceCatalogOfferingPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "image", &obj.Image, UnmarshalImageIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "network_interfaces", &obj.NetworkInterfaces, UnmarshalNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_network_interface", &obj.PrimaryNetworkInterface, UnmarshalNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "source_template", &obj.SourceTemplate, UnmarshalInstanceTemplateIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePrototypeInstanceByVolume : Create an instance by using a boot volume. +// This model "extends" InstancePrototype +type InstancePrototypeInstanceByVolume struct { + // The availability policy to use for this virtual server instance. + AvailabilityPolicy *InstanceAvailabilityPolicyPrototype `json:"availability_policy,omitempty"` + + // The default trusted profile configuration to use for this virtual server instance + // + // This property's value is used when provisioning the virtual server instance, but not subsequently managed. + // Accordingly, it is reflected as an [instance + // initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) property. + DefaultTrustedProfile *InstanceDefaultTrustedProfilePrototype `json:"default_trusted_profile,omitempty"` + + // The public SSH keys for the administrative user of the virtual server instance. Keys will be made available to the + // virtual server instance as cloud-init vendor data. For cloud-init enabled images, these keys will also be added as + // SSH authorized keys for the administrative user. + // + // For Windows images, the keys of type `rsa` must be specified, and one will be selected to encrypt [the administrator + // password](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization). Keys are optional for other images, but if + // no keys are specified, the instance will be inaccessible unless the specified image provides another means of + // access. + // + // This property's value is used when provisioning the virtual server instance, but not subsequently managed. + // Accordingly, it is reflected as an [instance + // initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) property. + Keys []KeyIdentityIntf `json:"keys,omitempty"` + + MetadataService *InstanceMetadataServicePrototype `json:"metadata_service,omitempty"` + + // The name for this virtual server instance. The name must not be used by another virtual server instance in the + // region. If unspecified, the name will be a hyphenated list of randomly-selected words. + // + // The system hostname will be based on this name. + Name *string `json:"name,omitempty"` + + // The placement restrictions to use for the virtual server instance. + PlacementTarget InstancePlacementTargetPrototypeIntf `json:"placement_target,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-profiles) to use for this virtual server instance. + // + // If unspecified, `bx2-2x8` will be used, but this default value is expected to change in the future. + Profile InstanceProfileIdentityIntf `json:"profile,omitempty"` + + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes. An increase in + // this value will result in a corresponding decrease to + // `total_network_bandwidth`. + TotalVolumeBandwidth *int64 `json:"total_volume_bandwidth,omitempty"` + + // [User data](https://cloud.ibm.com/docs/vpc?topic=vpc-user-data) to make available when setting up the virtual server + // instance. + UserData *string `json:"user_data,omitempty"` + + // The additional volume attachments to create for the virtual server instance. + VolumeAttachments []VolumeAttachmentPrototype `json:"volume_attachments,omitempty"` + + // The VPC this virtual server instance will reside in. + // + // If specified, it must match the VPC for the subnets of the instance network interfaces. + VPC VPCIdentityIntf `json:"vpc,omitempty"` + + // The boot volume attachment for the virtual server instance. + BootVolumeAttachment *VolumeAttachmentPrototypeInstanceByVolumeContext `json:"boot_volume_attachment" validate:"required"` + + // The additional instance network interfaces to create. + NetworkInterfaces []NetworkInterfacePrototype `json:"network_interfaces,omitempty"` + + // The primary instance network interface to create. + PrimaryNetworkInterface *NetworkInterfacePrototype `json:"primary_network_interface" validate:"required"` + + // The zone this virtual server instance will reside in. + Zone ZoneIdentityIntf `json:"zone" validate:"required"` +} + +// NewInstancePrototypeInstanceByVolume : Instantiate InstancePrototypeInstanceByVolume (Generic Model Constructor) +func (*VpcV1) NewInstancePrototypeInstanceByVolume(bootVolumeAttachment *VolumeAttachmentPrototypeInstanceByVolumeContext, primaryNetworkInterface *NetworkInterfacePrototype, zone ZoneIdentityIntf) (_model *InstancePrototypeInstanceByVolume, err error) { + _model = &InstancePrototypeInstanceByVolume{ + BootVolumeAttachment: bootVolumeAttachment, + PrimaryNetworkInterface: primaryNetworkInterface, + Zone: zone, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstancePrototypeInstanceByVolume) isaInstancePrototype() bool { + return true +} + +// UnmarshalInstancePrototypeInstanceByVolume unmarshals an instance of InstancePrototypeInstanceByVolume from the specified map of raw messages. +func UnmarshalInstancePrototypeInstanceByVolume(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePrototypeInstanceByVolume) + err = core.UnmarshalModel(m, "availability_policy", &obj.AvailabilityPolicy, UnmarshalInstanceAvailabilityPolicyPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "default_trusted_profile", &obj.DefaultTrustedProfile, UnmarshalInstanceDefaultTrustedProfilePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "keys", &obj.Keys, UnmarshalKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "metadata_service", &obj.MetadataService, UnmarshalInstanceMetadataServicePrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "placement_target", &obj.PlacementTarget, UnmarshalInstancePlacementTargetPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalInstanceProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_volume_bandwidth", &obj.TotalVolumeBandwidth) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_data", &obj.UserData) + if err != nil { + return + } + err = core.UnmarshalModel(m, "volume_attachments", &obj.VolumeAttachments, UnmarshalVolumeAttachmentPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "boot_volume_attachment", &obj.BootVolumeAttachment, UnmarshalVolumeAttachmentPrototypeInstanceByVolumeContext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "network_interfaces", &obj.NetworkInterfaces, UnmarshalNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_network_interface", &obj.PrimaryNetworkInterface, UnmarshalNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceTemplateIdentityByCRN : InstanceTemplateIdentityByCRN struct +// This model "extends" InstanceTemplateIdentity +type InstanceTemplateIdentityByCRN struct { + // The CRN for this instance template. + CRN *string `json:"crn" validate:"required"` +} + +// NewInstanceTemplateIdentityByCRN : Instantiate InstanceTemplateIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewInstanceTemplateIdentityByCRN(crn string) (_model *InstanceTemplateIdentityByCRN, err error) { + _model = &InstanceTemplateIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstanceTemplateIdentityByCRN) isaInstanceTemplateIdentity() bool { + return true +} + +// UnmarshalInstanceTemplateIdentityByCRN unmarshals an instance of InstanceTemplateIdentityByCRN from the specified map of raw messages. +func UnmarshalInstanceTemplateIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceTemplateIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceTemplateIdentityByHref : InstanceTemplateIdentityByHref struct +// This model "extends" InstanceTemplateIdentity +type InstanceTemplateIdentityByHref struct { + // The URL for this instance template. + Href *string `json:"href" validate:"required"` +} + +// NewInstanceTemplateIdentityByHref : Instantiate InstanceTemplateIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewInstanceTemplateIdentityByHref(href string) (_model *InstanceTemplateIdentityByHref, err error) { + _model = &InstanceTemplateIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstanceTemplateIdentityByHref) isaInstanceTemplateIdentity() bool { + return true +} + +// UnmarshalInstanceTemplateIdentityByHref unmarshals an instance of InstanceTemplateIdentityByHref from the specified map of raw messages. +func UnmarshalInstanceTemplateIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceTemplateIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceTemplateIdentityByID : InstanceTemplateIdentityByID struct +// This model "extends" InstanceTemplateIdentity +type InstanceTemplateIdentityByID struct { + // The unique identifier for this instance template. + ID *string `json:"id" validate:"required"` +} + +// NewInstanceTemplateIdentityByID : Instantiate InstanceTemplateIdentityByID (Generic Model Constructor) +func (*VpcV1) NewInstanceTemplateIdentityByID(id string) (_model *InstanceTemplateIdentityByID, err error) { + _model = &InstanceTemplateIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstanceTemplateIdentityByID) isaInstanceTemplateIdentity() bool { + return true +} + +// UnmarshalInstanceTemplateIdentityByID unmarshals an instance of InstanceTemplateIdentityByID from the specified map of raw messages. +func UnmarshalInstanceTemplateIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceTemplateIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceTemplatePrototypeInstanceTemplateByCatalogOffering : Create an instance template that creates instances by using a catalog offering. +// This model "extends" InstanceTemplatePrototype +type InstanceTemplatePrototypeInstanceTemplateByCatalogOffering struct { + // The availability policy to use for this virtual server instance. + AvailabilityPolicy *InstanceAvailabilityPolicyPrototype `json:"availability_policy,omitempty"` + + // The default trusted profile configuration to use for this virtual server instance + // + // This property's value is used when provisioning the virtual server instance, but not subsequently managed. + // Accordingly, it is reflected as an [instance + // initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) property. + DefaultTrustedProfile *InstanceDefaultTrustedProfilePrototype `json:"default_trusted_profile,omitempty"` + + // The public SSH keys for the administrative user of the virtual server instance. Keys will be made available to the + // virtual server instance as cloud-init vendor data. For cloud-init enabled images, these keys will also be added as + // SSH authorized keys for the administrative user. + // + // For Windows images, the keys of type `rsa` must be specified, and one will be selected to encrypt [the administrator + // password](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization). Keys are optional for other images, but if + // no keys are specified, the instance will be inaccessible unless the specified image provides another means of + // access. + // + // This property's value is used when provisioning the virtual server instance, but not subsequently managed. + // Accordingly, it is reflected as an [instance + // initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) property. + Keys []KeyIdentityIntf `json:"keys,omitempty"` + + MetadataService *InstanceMetadataServicePrototype `json:"metadata_service,omitempty"` + + // The name for this instance template. The name must not be used by another instance template in the region. If + // unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The placement restrictions to use for the virtual server instance. + PlacementTarget InstancePlacementTargetPrototypeIntf `json:"placement_target,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-profiles) to use for this virtual server instance. + // + // If unspecified, `bx2-2x8` will be used, but this default value is expected to change in the future. + Profile InstanceProfileIdentityIntf `json:"profile,omitempty"` + + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes. An increase in + // this value will result in a corresponding decrease to + // `total_network_bandwidth`. + TotalVolumeBandwidth *int64 `json:"total_volume_bandwidth,omitempty"` + + // [User data](https://cloud.ibm.com/docs/vpc?topic=vpc-user-data) to make available when setting up the virtual server + // instance. + UserData *string `json:"user_data,omitempty"` + + // The additional volume attachments to create for the virtual server instance. + VolumeAttachments []VolumeAttachmentPrototype `json:"volume_attachments,omitempty"` + + // The VPC this virtual server instance will reside in. + // + // If specified, it must match the VPC for the subnets of the instance network interfaces. + VPC VPCIdentityIntf `json:"vpc,omitempty"` + + // The boot volume attachment to create for the virtual server instance. + BootVolumeAttachment *VolumeAttachmentPrototypeInstanceByImageContext `json:"boot_volume_attachment,omitempty"` + + // The [catalog](https://cloud.ibm.com/docs/account?topic=account-restrict-by-user) offering + // or offering version to use when provisioning this virtual server instance. + // + // If an offering is specified, the latest version of that offering will be used. + // + // The specified offering or offering version may be in a different account in the same + // [enterprise](https://cloud.ibm.com/docs/account?topic=account-what-is-enterprise), subject + // to IAM policies. + CatalogOffering InstanceCatalogOfferingPrototypeIntf `json:"catalog_offering" validate:"required"` + + // The additional instance network interfaces to create. + NetworkInterfaces []NetworkInterfacePrototype `json:"network_interfaces,omitempty"` + + // The primary instance network interface to create. + PrimaryNetworkInterface *NetworkInterfacePrototype `json:"primary_network_interface" validate:"required"` + + // The zone this virtual server instance will reside in. + Zone ZoneIdentityIntf `json:"zone" validate:"required"` +} + +// NewInstanceTemplatePrototypeInstanceTemplateByCatalogOffering : Instantiate InstanceTemplatePrototypeInstanceTemplateByCatalogOffering (Generic Model Constructor) +func (*VpcV1) NewInstanceTemplatePrototypeInstanceTemplateByCatalogOffering(catalogOffering InstanceCatalogOfferingPrototypeIntf, primaryNetworkInterface *NetworkInterfacePrototype, zone ZoneIdentityIntf) (_model *InstanceTemplatePrototypeInstanceTemplateByCatalogOffering, err error) { + _model = &InstanceTemplatePrototypeInstanceTemplateByCatalogOffering{ + CatalogOffering: catalogOffering, + PrimaryNetworkInterface: primaryNetworkInterface, + Zone: zone, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstanceTemplatePrototypeInstanceTemplateByCatalogOffering) isaInstanceTemplatePrototype() bool { + return true +} + +// UnmarshalInstanceTemplatePrototypeInstanceTemplateByCatalogOffering unmarshals an instance of InstanceTemplatePrototypeInstanceTemplateByCatalogOffering from the specified map of raw messages. +func UnmarshalInstanceTemplatePrototypeInstanceTemplateByCatalogOffering(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceTemplatePrototypeInstanceTemplateByCatalogOffering) + err = core.UnmarshalModel(m, "availability_policy", &obj.AvailabilityPolicy, UnmarshalInstanceAvailabilityPolicyPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "default_trusted_profile", &obj.DefaultTrustedProfile, UnmarshalInstanceDefaultTrustedProfilePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "keys", &obj.Keys, UnmarshalKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "metadata_service", &obj.MetadataService, UnmarshalInstanceMetadataServicePrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "placement_target", &obj.PlacementTarget, UnmarshalInstancePlacementTargetPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalInstanceProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_volume_bandwidth", &obj.TotalVolumeBandwidth) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_data", &obj.UserData) + if err != nil { + return + } + err = core.UnmarshalModel(m, "volume_attachments", &obj.VolumeAttachments, UnmarshalVolumeAttachmentPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "boot_volume_attachment", &obj.BootVolumeAttachment, UnmarshalVolumeAttachmentPrototypeInstanceByImageContext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "catalog_offering", &obj.CatalogOffering, UnmarshalInstanceCatalogOfferingPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "network_interfaces", &obj.NetworkInterfaces, UnmarshalNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_network_interface", &obj.PrimaryNetworkInterface, UnmarshalNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceTemplatePrototypeInstanceTemplateByImage : Create an instance template that creates instances by using an image. +// This model "extends" InstanceTemplatePrototype +type InstanceTemplatePrototypeInstanceTemplateByImage struct { + // The availability policy to use for this virtual server instance. + AvailabilityPolicy *InstanceAvailabilityPolicyPrototype `json:"availability_policy,omitempty"` + + // The default trusted profile configuration to use for this virtual server instance + // + // This property's value is used when provisioning the virtual server instance, but not subsequently managed. + // Accordingly, it is reflected as an [instance + // initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) property. + DefaultTrustedProfile *InstanceDefaultTrustedProfilePrototype `json:"default_trusted_profile,omitempty"` + + // The public SSH keys for the administrative user of the virtual server instance. Keys will be made available to the + // virtual server instance as cloud-init vendor data. For cloud-init enabled images, these keys will also be added as + // SSH authorized keys for the administrative user. + // + // For Windows images, the keys of type `rsa` must be specified, and one will be selected to encrypt [the administrator + // password](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization). Keys are optional for other images, but if + // no keys are specified, the instance will be inaccessible unless the specified image provides another means of + // access. + // + // This property's value is used when provisioning the virtual server instance, but not subsequently managed. + // Accordingly, it is reflected as an [instance + // initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) property. + Keys []KeyIdentityIntf `json:"keys,omitempty"` + + MetadataService *InstanceMetadataServicePrototype `json:"metadata_service,omitempty"` + + // The name for this instance template. The name must not be used by another instance template in the region. If + // unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The placement restrictions to use for the virtual server instance. + PlacementTarget InstancePlacementTargetPrototypeIntf `json:"placement_target,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-profiles) to use for this virtual server instance. + // + // If unspecified, `bx2-2x8` will be used, but this default value is expected to change in the future. + Profile InstanceProfileIdentityIntf `json:"profile,omitempty"` + + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes. An increase in + // this value will result in a corresponding decrease to + // `total_network_bandwidth`. + TotalVolumeBandwidth *int64 `json:"total_volume_bandwidth,omitempty"` + + // [User data](https://cloud.ibm.com/docs/vpc?topic=vpc-user-data) to make available when setting up the virtual server + // instance. + UserData *string `json:"user_data,omitempty"` + + // The additional volume attachments to create for the virtual server instance. + VolumeAttachments []VolumeAttachmentPrototype `json:"volume_attachments,omitempty"` + + // The VPC this virtual server instance will reside in. + // + // If specified, it must match the VPC for the subnets of the instance network interfaces. + VPC VPCIdentityIntf `json:"vpc,omitempty"` + + // The boot volume attachment to create for the virtual server instance. + BootVolumeAttachment *VolumeAttachmentPrototypeInstanceByImageContext `json:"boot_volume_attachment,omitempty"` + + // The image to use when provisioning the virtual server instance. + Image ImageIdentityIntf `json:"image" validate:"required"` + + // The additional instance network interfaces to create. + NetworkInterfaces []NetworkInterfacePrototype `json:"network_interfaces,omitempty"` + + // The primary instance network interface to create. + PrimaryNetworkInterface *NetworkInterfacePrototype `json:"primary_network_interface" validate:"required"` + + // The zone this virtual server instance will reside in. + Zone ZoneIdentityIntf `json:"zone" validate:"required"` +} + +// NewInstanceTemplatePrototypeInstanceTemplateByImage : Instantiate InstanceTemplatePrototypeInstanceTemplateByImage (Generic Model Constructor) +func (*VpcV1) NewInstanceTemplatePrototypeInstanceTemplateByImage(image ImageIdentityIntf, primaryNetworkInterface *NetworkInterfacePrototype, zone ZoneIdentityIntf) (_model *InstanceTemplatePrototypeInstanceTemplateByImage, err error) { + _model = &InstanceTemplatePrototypeInstanceTemplateByImage{ + Image: image, + PrimaryNetworkInterface: primaryNetworkInterface, + Zone: zone, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstanceTemplatePrototypeInstanceTemplateByImage) isaInstanceTemplatePrototype() bool { + return true +} + +// UnmarshalInstanceTemplatePrototypeInstanceTemplateByImage unmarshals an instance of InstanceTemplatePrototypeInstanceTemplateByImage from the specified map of raw messages. +func UnmarshalInstanceTemplatePrototypeInstanceTemplateByImage(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceTemplatePrototypeInstanceTemplateByImage) + err = core.UnmarshalModel(m, "availability_policy", &obj.AvailabilityPolicy, UnmarshalInstanceAvailabilityPolicyPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "default_trusted_profile", &obj.DefaultTrustedProfile, UnmarshalInstanceDefaultTrustedProfilePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "keys", &obj.Keys, UnmarshalKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "metadata_service", &obj.MetadataService, UnmarshalInstanceMetadataServicePrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "placement_target", &obj.PlacementTarget, UnmarshalInstancePlacementTargetPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalInstanceProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_volume_bandwidth", &obj.TotalVolumeBandwidth) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_data", &obj.UserData) + if err != nil { + return + } + err = core.UnmarshalModel(m, "volume_attachments", &obj.VolumeAttachments, UnmarshalVolumeAttachmentPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "boot_volume_attachment", &obj.BootVolumeAttachment, UnmarshalVolumeAttachmentPrototypeInstanceByImageContext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "image", &obj.Image, UnmarshalImageIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "network_interfaces", &obj.NetworkInterfaces, UnmarshalNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_network_interface", &obj.PrimaryNetworkInterface, UnmarshalNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceTemplatePrototypeInstanceTemplateBySourceSnapshot : Create an instance template that creates instances by using a snapshot. +// This model "extends" InstanceTemplatePrototype +type InstanceTemplatePrototypeInstanceTemplateBySourceSnapshot struct { + // The availability policy to use for this virtual server instance. + AvailabilityPolicy *InstanceAvailabilityPolicyPrototype `json:"availability_policy,omitempty"` + + // The default trusted profile configuration to use for this virtual server instance + // + // This property's value is used when provisioning the virtual server instance, but not subsequently managed. + // Accordingly, it is reflected as an [instance + // initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) property. + DefaultTrustedProfile *InstanceDefaultTrustedProfilePrototype `json:"default_trusted_profile,omitempty"` + + // The public SSH keys for the administrative user of the virtual server instance. Keys will be made available to the + // virtual server instance as cloud-init vendor data. For cloud-init enabled images, these keys will also be added as + // SSH authorized keys for the administrative user. + // + // For Windows images, the keys of type `rsa` must be specified, and one will be selected to encrypt [the administrator + // password](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization). Keys are optional for other images, but if + // no keys are specified, the instance will be inaccessible unless the specified image provides another means of + // access. + // + // This property's value is used when provisioning the virtual server instance, but not subsequently managed. + // Accordingly, it is reflected as an [instance + // initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) property. + Keys []KeyIdentityIntf `json:"keys,omitempty"` + + MetadataService *InstanceMetadataServicePrototype `json:"metadata_service,omitempty"` + + // The name for this instance template. The name must not be used by another instance template in the region. If + // unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The placement restrictions to use for the virtual server instance. + PlacementTarget InstancePlacementTargetPrototypeIntf `json:"placement_target,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-profiles) to use for this virtual server instance. + // + // If unspecified, `bx2-2x8` will be used, but this default value is expected to change in the future. + Profile InstanceProfileIdentityIntf `json:"profile,omitempty"` + + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes. An increase in + // this value will result in a corresponding decrease to + // `total_network_bandwidth`. + TotalVolumeBandwidth *int64 `json:"total_volume_bandwidth,omitempty"` + + // [User data](https://cloud.ibm.com/docs/vpc?topic=vpc-user-data) to make available when setting up the virtual server + // instance. + UserData *string `json:"user_data,omitempty"` + + // The additional volume attachments to create for the virtual server instance. + VolumeAttachments []VolumeAttachmentPrototype `json:"volume_attachments,omitempty"` + + // The VPC this virtual server instance will reside in. + // + // If specified, it must match the VPC for the subnets of the instance network interfaces. + VPC VPCIdentityIntf `json:"vpc,omitempty"` + + // The boot volume attachment to create for the virtual server instance. + BootVolumeAttachment *VolumeAttachmentPrototypeInstanceBySourceSnapshotContext `json:"boot_volume_attachment" validate:"required"` + + // The additional instance network interfaces to create. + NetworkInterfaces []NetworkInterfacePrototype `json:"network_interfaces,omitempty"` + + // The primary instance network interface to create. + PrimaryNetworkInterface *NetworkInterfacePrototype `json:"primary_network_interface" validate:"required"` + + // The zone this virtual server instance will reside in. + Zone ZoneIdentityIntf `json:"zone" validate:"required"` +} + +// NewInstanceTemplatePrototypeInstanceTemplateBySourceSnapshot : Instantiate InstanceTemplatePrototypeInstanceTemplateBySourceSnapshot (Generic Model Constructor) +func (*VpcV1) NewInstanceTemplatePrototypeInstanceTemplateBySourceSnapshot(bootVolumeAttachment *VolumeAttachmentPrototypeInstanceBySourceSnapshotContext, primaryNetworkInterface *NetworkInterfacePrototype, zone ZoneIdentityIntf) (_model *InstanceTemplatePrototypeInstanceTemplateBySourceSnapshot, err error) { + _model = &InstanceTemplatePrototypeInstanceTemplateBySourceSnapshot{ + BootVolumeAttachment: bootVolumeAttachment, + PrimaryNetworkInterface: primaryNetworkInterface, + Zone: zone, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstanceTemplatePrototypeInstanceTemplateBySourceSnapshot) isaInstanceTemplatePrototype() bool { + return true +} + +// UnmarshalInstanceTemplatePrototypeInstanceTemplateBySourceSnapshot unmarshals an instance of InstanceTemplatePrototypeInstanceTemplateBySourceSnapshot from the specified map of raw messages. +func UnmarshalInstanceTemplatePrototypeInstanceTemplateBySourceSnapshot(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceTemplatePrototypeInstanceTemplateBySourceSnapshot) + err = core.UnmarshalModel(m, "availability_policy", &obj.AvailabilityPolicy, UnmarshalInstanceAvailabilityPolicyPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "default_trusted_profile", &obj.DefaultTrustedProfile, UnmarshalInstanceDefaultTrustedProfilePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "keys", &obj.Keys, UnmarshalKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "metadata_service", &obj.MetadataService, UnmarshalInstanceMetadataServicePrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "placement_target", &obj.PlacementTarget, UnmarshalInstancePlacementTargetPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalInstanceProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_volume_bandwidth", &obj.TotalVolumeBandwidth) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_data", &obj.UserData) + if err != nil { + return + } + err = core.UnmarshalModel(m, "volume_attachments", &obj.VolumeAttachments, UnmarshalVolumeAttachmentPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "boot_volume_attachment", &obj.BootVolumeAttachment, UnmarshalVolumeAttachmentPrototypeInstanceBySourceSnapshotContext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "network_interfaces", &obj.NetworkInterfaces, UnmarshalNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_network_interface", &obj.PrimaryNetworkInterface, UnmarshalNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceTemplatePrototypeInstanceTemplateBySourceTemplate : Create an instance template from an existing instance template. +// This model "extends" InstanceTemplatePrototype +type InstanceTemplatePrototypeInstanceTemplateBySourceTemplate struct { + // The availability policy to use for this virtual server instance. + AvailabilityPolicy *InstanceAvailabilityPolicyPrototype `json:"availability_policy,omitempty"` + + // The default trusted profile configuration to use for this virtual server instance + // + // This property's value is used when provisioning the virtual server instance, but not subsequently managed. + // Accordingly, it is reflected as an [instance + // initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) property. + DefaultTrustedProfile *InstanceDefaultTrustedProfilePrototype `json:"default_trusted_profile,omitempty"` + + // The public SSH keys for the administrative user of the virtual server instance. Keys will be made available to the + // virtual server instance as cloud-init vendor data. For cloud-init enabled images, these keys will also be added as + // SSH authorized keys for the administrative user. + // + // For Windows images, the keys of type `rsa` must be specified, and one will be selected to encrypt [the administrator + // password](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization). Keys are optional for other images, but if + // no keys are specified, the instance will be inaccessible unless the specified image provides another means of + // access. + // + // This property's value is used when provisioning the virtual server instance, but not subsequently managed. + // Accordingly, it is reflected as an [instance + // initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) property. + Keys []KeyIdentityIntf `json:"keys,omitempty"` + + MetadataService *InstanceMetadataServicePrototype `json:"metadata_service,omitempty"` + + // The name for this instance template. The name must not be used by another instance template in the region. If + // unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The placement restrictions to use for the virtual server instance. + PlacementTarget InstancePlacementTargetPrototypeIntf `json:"placement_target,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-profiles) to use for this virtual server instance. + // + // If unspecified, `bx2-2x8` will be used, but this default value is expected to change in the future. + Profile InstanceProfileIdentityIntf `json:"profile,omitempty"` + + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes. An increase in + // this value will result in a corresponding decrease to + // `total_network_bandwidth`. + TotalVolumeBandwidth *int64 `json:"total_volume_bandwidth,omitempty"` + + // [User data](https://cloud.ibm.com/docs/vpc?topic=vpc-user-data) to make available when setting up the virtual server + // instance. + UserData *string `json:"user_data,omitempty"` + + // The additional volume attachments to create for the virtual server instance. + VolumeAttachments []VolumeAttachmentPrototype `json:"volume_attachments,omitempty"` + + // The VPC this virtual server instance will reside in. + // + // If specified, it must match the VPC for the subnets of the instance network interfaces. + VPC VPCIdentityIntf `json:"vpc,omitempty"` + + // The boot volume attachment to create for the virtual server instance. + BootVolumeAttachment *VolumeAttachmentPrototypeInstanceByImageContext `json:"boot_volume_attachment,omitempty"` + + // The [catalog](https://cloud.ibm.com/docs/account?topic=account-restrict-by-user) + // offering version to use when provisioning this virtual server instance. + // If an offering is specified, the latest version of that offering will be used. + // + // The specified offering or offering version may be in a different account, subject to + // IAM policies. + // + // If specified, `image` must not be specified, and `source_template` must not have + // `image` specified. + CatalogOffering InstanceCatalogOfferingPrototypeIntf `json:"catalog_offering,omitempty"` + + // The image to use when provisioning the virtual server instance. + Image ImageIdentityIntf `json:"image,omitempty"` + + // The additional instance network interfaces to create. + NetworkInterfaces []NetworkInterfacePrototype `json:"network_interfaces,omitempty"` + + // The primary instance network interface to create. + PrimaryNetworkInterface *NetworkInterfacePrototype `json:"primary_network_interface,omitempty"` + + // The template to create this virtual server instance from. + SourceTemplate InstanceTemplateIdentityIntf `json:"source_template" validate:"required"` + + // The zone this virtual server instance will reside in. + Zone ZoneIdentityIntf `json:"zone,omitempty"` +} + +// NewInstanceTemplatePrototypeInstanceTemplateBySourceTemplate : Instantiate InstanceTemplatePrototypeInstanceTemplateBySourceTemplate (Generic Model Constructor) +func (*VpcV1) NewInstanceTemplatePrototypeInstanceTemplateBySourceTemplate(sourceTemplate InstanceTemplateIdentityIntf) (_model *InstanceTemplatePrototypeInstanceTemplateBySourceTemplate, err error) { + _model = &InstanceTemplatePrototypeInstanceTemplateBySourceTemplate{ + SourceTemplate: sourceTemplate, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstanceTemplatePrototypeInstanceTemplateBySourceTemplate) isaInstanceTemplatePrototype() bool { + return true +} + +// UnmarshalInstanceTemplatePrototypeInstanceTemplateBySourceTemplate unmarshals an instance of InstanceTemplatePrototypeInstanceTemplateBySourceTemplate from the specified map of raw messages. +func UnmarshalInstanceTemplatePrototypeInstanceTemplateBySourceTemplate(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceTemplatePrototypeInstanceTemplateBySourceTemplate) + err = core.UnmarshalModel(m, "availability_policy", &obj.AvailabilityPolicy, UnmarshalInstanceAvailabilityPolicyPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "default_trusted_profile", &obj.DefaultTrustedProfile, UnmarshalInstanceDefaultTrustedProfilePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "keys", &obj.Keys, UnmarshalKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "metadata_service", &obj.MetadataService, UnmarshalInstanceMetadataServicePrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "placement_target", &obj.PlacementTarget, UnmarshalInstancePlacementTargetPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalInstanceProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_volume_bandwidth", &obj.TotalVolumeBandwidth) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_data", &obj.UserData) + if err != nil { + return + } + err = core.UnmarshalModel(m, "volume_attachments", &obj.VolumeAttachments, UnmarshalVolumeAttachmentPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "boot_volume_attachment", &obj.BootVolumeAttachment, UnmarshalVolumeAttachmentPrototypeInstanceByImageContext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "catalog_offering", &obj.CatalogOffering, UnmarshalInstanceCatalogOfferingPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "image", &obj.Image, UnmarshalImageIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "network_interfaces", &obj.NetworkInterfaces, UnmarshalNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_network_interface", &obj.PrimaryNetworkInterface, UnmarshalNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "source_template", &obj.SourceTemplate, UnmarshalInstanceTemplateIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceTemplateInstanceByCatalogOfferingInstanceTemplateContext : Create an instance by using a catalog offering. +// This model "extends" InstanceTemplate +type InstanceTemplateInstanceByCatalogOfferingInstanceTemplateContext struct { + // The availability policy to use for this virtual server instance. + AvailabilityPolicy *InstanceAvailabilityPolicyPrototype `json:"availability_policy,omitempty"` + + // The date and time that the instance template was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The CRN for this instance template. + CRN *string `json:"crn" validate:"required"` + + // The default trusted profile configuration to use for this virtual server instance + // + // This property's value is used when provisioning the virtual server instance, but not subsequently managed. + // Accordingly, it is reflected as an [instance + // initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) property. + DefaultTrustedProfile *InstanceDefaultTrustedProfilePrototype `json:"default_trusted_profile,omitempty"` + + // The URL for this instance template. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this instance template. + ID *string `json:"id" validate:"required"` + + // The public SSH keys for the administrative user of the virtual server instance. Keys will be made available to the + // virtual server instance as cloud-init vendor data. For cloud-init enabled images, these keys will also be added as + // SSH authorized keys for the administrative user. + // + // For Windows images, the keys of type `rsa` must be specified, and one will be selected to encrypt [the administrator + // password](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization). Keys are optional for other images, but if + // no keys are specified, the instance will be inaccessible unless the specified image provides another means of + // access. + // + // This property's value is used when provisioning the virtual server instance, but not subsequently managed. + // Accordingly, it is reflected as an [instance + // initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) property. + Keys []KeyIdentityIntf `json:"keys,omitempty"` + + MetadataService *InstanceMetadataServicePrototype `json:"metadata_service,omitempty"` + + // The name for this instance template. The name is unique across all instance templates in the region. + Name *string `json:"name" validate:"required"` + + // The placement restrictions to use for the virtual server instance. + PlacementTarget InstancePlacementTargetPrototypeIntf `json:"placement_target,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-profiles) to use for this virtual server instance. + // + // If unspecified, `bx2-2x8` will be used, but this default value is expected to change in the future. + Profile InstanceProfileIdentityIntf `json:"profile,omitempty"` + + // The resource group for this instance template. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes. An increase in + // this value will result in a corresponding decrease to + // `total_network_bandwidth`. + TotalVolumeBandwidth *int64 `json:"total_volume_bandwidth,omitempty"` + + // [User data](https://cloud.ibm.com/docs/vpc?topic=vpc-user-data) to make available when setting up the virtual server + // instance. + UserData *string `json:"user_data,omitempty"` + + // The additional volume attachments to create for the virtual server instance. + VolumeAttachments []VolumeAttachmentPrototype `json:"volume_attachments,omitempty"` + + // The VPC this virtual server instance will reside in. + // + // If specified, it must match the VPC for the subnets of the instance network interfaces. + VPC VPCIdentityIntf `json:"vpc,omitempty"` + + // The boot volume attachment to create for the virtual server instance. + BootVolumeAttachment *VolumeAttachmentPrototypeInstanceByImageContext `json:"boot_volume_attachment,omitempty"` + + // The [catalog](https://cloud.ibm.com/docs/account?topic=account-restrict-by-user) offering + // or offering version to use when provisioning this virtual server instance. + // + // If an offering is specified, the latest version of that offering will be used. + // + // The specified offering or offering version may be in a different account in the same + // [enterprise](https://cloud.ibm.com/docs/account?topic=account-what-is-enterprise), subject + // to IAM policies. + CatalogOffering InstanceCatalogOfferingPrototypeIntf `json:"catalog_offering" validate:"required"` + + // The additional instance network interfaces to create. + NetworkInterfaces []NetworkInterfacePrototype `json:"network_interfaces,omitempty"` + + // The primary instance network interface to create. + PrimaryNetworkInterface *NetworkInterfacePrototype `json:"primary_network_interface,omitempty"` + + // The zone this virtual server instance will reside in. + Zone ZoneIdentityIntf `json:"zone" validate:"required"` +} + +func (*InstanceTemplateInstanceByCatalogOfferingInstanceTemplateContext) isaInstanceTemplate() bool { + return true +} + +// UnmarshalInstanceTemplateInstanceByCatalogOfferingInstanceTemplateContext unmarshals an instance of InstanceTemplateInstanceByCatalogOfferingInstanceTemplateContext from the specified map of raw messages. +func UnmarshalInstanceTemplateInstanceByCatalogOfferingInstanceTemplateContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceTemplateInstanceByCatalogOfferingInstanceTemplateContext) + err = core.UnmarshalModel(m, "availability_policy", &obj.AvailabilityPolicy, UnmarshalInstanceAvailabilityPolicyPrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "default_trusted_profile", &obj.DefaultTrustedProfile, UnmarshalInstanceDefaultTrustedProfilePrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalModel(m, "keys", &obj.Keys, UnmarshalKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "metadata_service", &obj.MetadataService, UnmarshalInstanceMetadataServicePrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "placement_target", &obj.PlacementTarget, UnmarshalInstancePlacementTargetPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalInstanceProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_volume_bandwidth", &obj.TotalVolumeBandwidth) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_data", &obj.UserData) + if err != nil { + return + } + err = core.UnmarshalModel(m, "volume_attachments", &obj.VolumeAttachments, UnmarshalVolumeAttachmentPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "boot_volume_attachment", &obj.BootVolumeAttachment, UnmarshalVolumeAttachmentPrototypeInstanceByImageContext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "catalog_offering", &obj.CatalogOffering, UnmarshalInstanceCatalogOfferingPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "network_interfaces", &obj.NetworkInterfaces, UnmarshalNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_network_interface", &obj.PrimaryNetworkInterface, UnmarshalNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceTemplateInstanceByImageInstanceTemplateContext : Create an instance by using an image. +// This model "extends" InstanceTemplate +type InstanceTemplateInstanceByImageInstanceTemplateContext struct { + // The availability policy to use for this virtual server instance. + AvailabilityPolicy *InstanceAvailabilityPolicyPrototype `json:"availability_policy,omitempty"` + + // The date and time that the instance template was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The CRN for this instance template. + CRN *string `json:"crn" validate:"required"` + + // The default trusted profile configuration to use for this virtual server instance + // + // This property's value is used when provisioning the virtual server instance, but not subsequently managed. + // Accordingly, it is reflected as an [instance + // initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) property. + DefaultTrustedProfile *InstanceDefaultTrustedProfilePrototype `json:"default_trusted_profile,omitempty"` + + // The URL for this instance template. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this instance template. + ID *string `json:"id" validate:"required"` + + // The public SSH keys for the administrative user of the virtual server instance. Keys will be made available to the + // virtual server instance as cloud-init vendor data. For cloud-init enabled images, these keys will also be added as + // SSH authorized keys for the administrative user. + // + // For Windows images, the keys of type `rsa` must be specified, and one will be selected to encrypt [the administrator + // password](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization). Keys are optional for other images, but if + // no keys are specified, the instance will be inaccessible unless the specified image provides another means of + // access. + // + // This property's value is used when provisioning the virtual server instance, but not subsequently managed. + // Accordingly, it is reflected as an [instance + // initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) property. + Keys []KeyIdentityIntf `json:"keys,omitempty"` + + MetadataService *InstanceMetadataServicePrototype `json:"metadata_service,omitempty"` + + // The name for this instance template. The name is unique across all instance templates in the region. + Name *string `json:"name" validate:"required"` + + // The placement restrictions to use for the virtual server instance. + PlacementTarget InstancePlacementTargetPrototypeIntf `json:"placement_target,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-profiles) to use for this virtual server instance. + // + // If unspecified, `bx2-2x8` will be used, but this default value is expected to change in the future. + Profile InstanceProfileIdentityIntf `json:"profile,omitempty"` + + // The resource group for this instance template. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes. An increase in + // this value will result in a corresponding decrease to + // `total_network_bandwidth`. + TotalVolumeBandwidth *int64 `json:"total_volume_bandwidth,omitempty"` + + // [User data](https://cloud.ibm.com/docs/vpc?topic=vpc-user-data) to make available when setting up the virtual server + // instance. + UserData *string `json:"user_data,omitempty"` + + // The additional volume attachments to create for the virtual server instance. + VolumeAttachments []VolumeAttachmentPrototype `json:"volume_attachments,omitempty"` + + // The VPC this virtual server instance will reside in. + // + // If specified, it must match the VPC for the subnets of the instance network interfaces. + VPC VPCIdentityIntf `json:"vpc,omitempty"` + + // The boot volume attachment to create for the virtual server instance. + BootVolumeAttachment *VolumeAttachmentPrototypeInstanceByImageContext `json:"boot_volume_attachment,omitempty"` + + // The image to use when provisioning the virtual server instance. + Image ImageIdentityIntf `json:"image" validate:"required"` + + // The additional instance network interfaces to create. + NetworkInterfaces []NetworkInterfacePrototype `json:"network_interfaces,omitempty"` + + // The primary instance network interface to create. + PrimaryNetworkInterface *NetworkInterfacePrototype `json:"primary_network_interface,omitempty"` + + // The zone this virtual server instance will reside in. + Zone ZoneIdentityIntf `json:"zone" validate:"required"` +} + +func (*InstanceTemplateInstanceByImageInstanceTemplateContext) isaInstanceTemplate() bool { + return true +} + +// UnmarshalInstanceTemplateInstanceByImageInstanceTemplateContext unmarshals an instance of InstanceTemplateInstanceByImageInstanceTemplateContext from the specified map of raw messages. +func UnmarshalInstanceTemplateInstanceByImageInstanceTemplateContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceTemplateInstanceByImageInstanceTemplateContext) + err = core.UnmarshalModel(m, "availability_policy", &obj.AvailabilityPolicy, UnmarshalInstanceAvailabilityPolicyPrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "default_trusted_profile", &obj.DefaultTrustedProfile, UnmarshalInstanceDefaultTrustedProfilePrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalModel(m, "keys", &obj.Keys, UnmarshalKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "metadata_service", &obj.MetadataService, UnmarshalInstanceMetadataServicePrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "placement_target", &obj.PlacementTarget, UnmarshalInstancePlacementTargetPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalInstanceProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_volume_bandwidth", &obj.TotalVolumeBandwidth) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_data", &obj.UserData) + if err != nil { + return + } + err = core.UnmarshalModel(m, "volume_attachments", &obj.VolumeAttachments, UnmarshalVolumeAttachmentPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "boot_volume_attachment", &obj.BootVolumeAttachment, UnmarshalVolumeAttachmentPrototypeInstanceByImageContext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "image", &obj.Image, UnmarshalImageIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "network_interfaces", &obj.NetworkInterfaces, UnmarshalNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_network_interface", &obj.PrimaryNetworkInterface, UnmarshalNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceTemplateInstanceBySourceSnapshotInstanceTemplateContext : Create an instance by using a snapshot. +// This model "extends" InstanceTemplate +type InstanceTemplateInstanceBySourceSnapshotInstanceTemplateContext struct { + // The availability policy to use for this virtual server instance. + AvailabilityPolicy *InstanceAvailabilityPolicyPrototype `json:"availability_policy,omitempty"` + + // The date and time that the instance template was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The CRN for this instance template. + CRN *string `json:"crn" validate:"required"` + + // The default trusted profile configuration to use for this virtual server instance + // + // This property's value is used when provisioning the virtual server instance, but not subsequently managed. + // Accordingly, it is reflected as an [instance + // initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) property. + DefaultTrustedProfile *InstanceDefaultTrustedProfilePrototype `json:"default_trusted_profile,omitempty"` + + // The URL for this instance template. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this instance template. + ID *string `json:"id" validate:"required"` + + // The public SSH keys for the administrative user of the virtual server instance. Keys will be made available to the + // virtual server instance as cloud-init vendor data. For cloud-init enabled images, these keys will also be added as + // SSH authorized keys for the administrative user. + // + // For Windows images, the keys of type `rsa` must be specified, and one will be selected to encrypt [the administrator + // password](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization). Keys are optional for other images, but if + // no keys are specified, the instance will be inaccessible unless the specified image provides another means of + // access. + // + // This property's value is used when provisioning the virtual server instance, but not subsequently managed. + // Accordingly, it is reflected as an [instance + // initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) property. + Keys []KeyIdentityIntf `json:"keys,omitempty"` + + MetadataService *InstanceMetadataServicePrototype `json:"metadata_service,omitempty"` + + // The name for this instance template. The name is unique across all instance templates in the region. + Name *string `json:"name" validate:"required"` + + // The placement restrictions to use for the virtual server instance. + PlacementTarget InstancePlacementTargetPrototypeIntf `json:"placement_target,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-profiles) to use for this virtual server instance. + // + // If unspecified, `bx2-2x8` will be used, but this default value is expected to change in the future. + Profile InstanceProfileIdentityIntf `json:"profile,omitempty"` + + // The resource group for this instance template. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes. An increase in + // this value will result in a corresponding decrease to + // `total_network_bandwidth`. + TotalVolumeBandwidth *int64 `json:"total_volume_bandwidth,omitempty"` + + // [User data](https://cloud.ibm.com/docs/vpc?topic=vpc-user-data) to make available when setting up the virtual server + // instance. + UserData *string `json:"user_data,omitempty"` + + // The additional volume attachments to create for the virtual server instance. + VolumeAttachments []VolumeAttachmentPrototype `json:"volume_attachments,omitempty"` + + // The VPC this virtual server instance will reside in. + // + // If specified, it must match the VPC for the subnets of the instance network interfaces. + VPC VPCIdentityIntf `json:"vpc,omitempty"` + + // The boot volume attachment to create for the virtual server instance. + BootVolumeAttachment *VolumeAttachmentPrototypeInstanceBySourceSnapshotContext `json:"boot_volume_attachment" validate:"required"` + + // The additional instance network interfaces to create. + NetworkInterfaces []NetworkInterfacePrototype `json:"network_interfaces,omitempty"` + + // The primary instance network interface to create. + PrimaryNetworkInterface *NetworkInterfacePrototype `json:"primary_network_interface,omitempty"` + + // The zone this virtual server instance will reside in. + Zone ZoneIdentityIntf `json:"zone" validate:"required"` +} + +func (*InstanceTemplateInstanceBySourceSnapshotInstanceTemplateContext) isaInstanceTemplate() bool { + return true +} + +// UnmarshalInstanceTemplateInstanceBySourceSnapshotInstanceTemplateContext unmarshals an instance of InstanceTemplateInstanceBySourceSnapshotInstanceTemplateContext from the specified map of raw messages. +func UnmarshalInstanceTemplateInstanceBySourceSnapshotInstanceTemplateContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceTemplateInstanceBySourceSnapshotInstanceTemplateContext) + err = core.UnmarshalModel(m, "availability_policy", &obj.AvailabilityPolicy, UnmarshalInstanceAvailabilityPolicyPrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "default_trusted_profile", &obj.DefaultTrustedProfile, UnmarshalInstanceDefaultTrustedProfilePrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalModel(m, "keys", &obj.Keys, UnmarshalKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "metadata_service", &obj.MetadataService, UnmarshalInstanceMetadataServicePrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "placement_target", &obj.PlacementTarget, UnmarshalInstancePlacementTargetPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalInstanceProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_volume_bandwidth", &obj.TotalVolumeBandwidth) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_data", &obj.UserData) + if err != nil { + return + } + err = core.UnmarshalModel(m, "volume_attachments", &obj.VolumeAttachments, UnmarshalVolumeAttachmentPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "boot_volume_attachment", &obj.BootVolumeAttachment, UnmarshalVolumeAttachmentPrototypeInstanceBySourceSnapshotContext) + if err != nil { + return + } + err = core.UnmarshalModel(m, "network_interfaces", &obj.NetworkInterfaces, UnmarshalNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_network_interface", &obj.PrimaryNetworkInterface, UnmarshalNetworkInterfacePrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// KeyIdentityByCRN : KeyIdentityByCRN struct +// This model "extends" KeyIdentity +type KeyIdentityByCRN struct { + // The CRN for this key. + CRN *string `json:"crn" validate:"required"` +} + +// NewKeyIdentityByCRN : Instantiate KeyIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewKeyIdentityByCRN(crn string) (_model *KeyIdentityByCRN, err error) { + _model = &KeyIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*KeyIdentityByCRN) isaKeyIdentity() bool { + return true +} + +// UnmarshalKeyIdentityByCRN unmarshals an instance of KeyIdentityByCRN from the specified map of raw messages. +func UnmarshalKeyIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(KeyIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// KeyIdentityByFingerprint : KeyIdentityByFingerprint struct +// This model "extends" KeyIdentity +type KeyIdentityByFingerprint struct { + // The fingerprint for this key. The value is returned base64-encoded and prefixed with the hash algorithm (always + // `SHA256`). + Fingerprint *string `json:"fingerprint" validate:"required"` +} + +// NewKeyIdentityByFingerprint : Instantiate KeyIdentityByFingerprint (Generic Model Constructor) +func (*VpcV1) NewKeyIdentityByFingerprint(fingerprint string) (_model *KeyIdentityByFingerprint, err error) { + _model = &KeyIdentityByFingerprint{ + Fingerprint: core.StringPtr(fingerprint), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*KeyIdentityByFingerprint) isaKeyIdentity() bool { + return true +} + +// UnmarshalKeyIdentityByFingerprint unmarshals an instance of KeyIdentityByFingerprint from the specified map of raw messages. +func UnmarshalKeyIdentityByFingerprint(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(KeyIdentityByFingerprint) + err = core.UnmarshalPrimitive(m, "fingerprint", &obj.Fingerprint) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// KeyIdentityByHref : KeyIdentityByHref struct +// This model "extends" KeyIdentity +type KeyIdentityByHref struct { + // The URL for this key. + Href *string `json:"href" validate:"required"` +} + +// NewKeyIdentityByHref : Instantiate KeyIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewKeyIdentityByHref(href string) (_model *KeyIdentityByHref, err error) { + _model = &KeyIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*KeyIdentityByHref) isaKeyIdentity() bool { + return true +} + +// UnmarshalKeyIdentityByHref unmarshals an instance of KeyIdentityByHref from the specified map of raw messages. +func UnmarshalKeyIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(KeyIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// KeyIdentityByID : KeyIdentityByID struct +// This model "extends" KeyIdentity +type KeyIdentityByID struct { + // The unique identifier for this key. + ID *string `json:"id" validate:"required"` +} + +// NewKeyIdentityByID : Instantiate KeyIdentityByID (Generic Model Constructor) +func (*VpcV1) NewKeyIdentityByID(id string) (_model *KeyIdentityByID, err error) { + _model = &KeyIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*KeyIdentityByID) isaKeyIdentity() bool { + return true +} + +// UnmarshalKeyIdentityByID unmarshals an instance of KeyIdentityByID from the specified map of raw messages. +func UnmarshalKeyIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(KeyIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LegacyCloudObjectStorageBucketIdentityCloudObjectStorageBucketIdentityByName : LegacyCloudObjectStorageBucketIdentityCloudObjectStorageBucketIdentityByName struct +// This model "extends" LegacyCloudObjectStorageBucketIdentity +type LegacyCloudObjectStorageBucketIdentityCloudObjectStorageBucketIdentityByName struct { + // The globally unique name of this Cloud Object Storage bucket. + Name *string `json:"name" validate:"required"` +} + +// NewLegacyCloudObjectStorageBucketIdentityCloudObjectStorageBucketIdentityByName : Instantiate LegacyCloudObjectStorageBucketIdentityCloudObjectStorageBucketIdentityByName (Generic Model Constructor) +func (*VpcV1) NewLegacyCloudObjectStorageBucketIdentityCloudObjectStorageBucketIdentityByName(name string) (_model *LegacyCloudObjectStorageBucketIdentityCloudObjectStorageBucketIdentityByName, err error) { + _model = &LegacyCloudObjectStorageBucketIdentityCloudObjectStorageBucketIdentityByName{ + Name: core.StringPtr(name), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*LegacyCloudObjectStorageBucketIdentityCloudObjectStorageBucketIdentityByName) isaLegacyCloudObjectStorageBucketIdentity() bool { + return true +} + +// UnmarshalLegacyCloudObjectStorageBucketIdentityCloudObjectStorageBucketIdentityByName unmarshals an instance of LegacyCloudObjectStorageBucketIdentityCloudObjectStorageBucketIdentityByName from the specified map of raw messages. +func UnmarshalLegacyCloudObjectStorageBucketIdentityCloudObjectStorageBucketIdentityByName(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LegacyCloudObjectStorageBucketIdentityCloudObjectStorageBucketIdentityByName) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerIdentityByCRN : LoadBalancerIdentityByCRN struct +// This model "extends" LoadBalancerIdentity +type LoadBalancerIdentityByCRN struct { + // The load balancer's CRN. + CRN *string `json:"crn" validate:"required"` +} + +// NewLoadBalancerIdentityByCRN : Instantiate LoadBalancerIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewLoadBalancerIdentityByCRN(crn string) (_model *LoadBalancerIdentityByCRN, err error) { + _model = &LoadBalancerIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*LoadBalancerIdentityByCRN) isaLoadBalancerIdentity() bool { + return true +} + +// UnmarshalLoadBalancerIdentityByCRN unmarshals an instance of LoadBalancerIdentityByCRN from the specified map of raw messages. +func UnmarshalLoadBalancerIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerIdentityByHref : LoadBalancerIdentityByHref struct +// This model "extends" LoadBalancerIdentity +type LoadBalancerIdentityByHref struct { + // The load balancer's canonical URL. + Href *string `json:"href" validate:"required"` +} + +// NewLoadBalancerIdentityByHref : Instantiate LoadBalancerIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewLoadBalancerIdentityByHref(href string) (_model *LoadBalancerIdentityByHref, err error) { + _model = &LoadBalancerIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*LoadBalancerIdentityByHref) isaLoadBalancerIdentity() bool { + return true +} + +// UnmarshalLoadBalancerIdentityByHref unmarshals an instance of LoadBalancerIdentityByHref from the specified map of raw messages. +func UnmarshalLoadBalancerIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerIdentityByID : LoadBalancerIdentityByID struct +// This model "extends" LoadBalancerIdentity +type LoadBalancerIdentityByID struct { + // The unique identifier for this load balancer. + ID *string `json:"id" validate:"required"` +} + +// NewLoadBalancerIdentityByID : Instantiate LoadBalancerIdentityByID (Generic Model Constructor) +func (*VpcV1) NewLoadBalancerIdentityByID(id string) (_model *LoadBalancerIdentityByID, err error) { + _model = &LoadBalancerIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*LoadBalancerIdentityByID) isaLoadBalancerIdentity() bool { + return true +} + +// UnmarshalLoadBalancerIdentityByID unmarshals an instance of LoadBalancerIdentityByID from the specified map of raw messages. +func UnmarshalLoadBalancerIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerIdentityByHref : LoadBalancerListenerIdentityByHref struct +// This model "extends" LoadBalancerListenerIdentity +type LoadBalancerListenerIdentityByHref struct { + // The listener's canonical URL. + Href *string `json:"href" validate:"required"` +} + +// NewLoadBalancerListenerIdentityByHref : Instantiate LoadBalancerListenerIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewLoadBalancerListenerIdentityByHref(href string) (_model *LoadBalancerListenerIdentityByHref, err error) { + _model = &LoadBalancerListenerIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*LoadBalancerListenerIdentityByHref) isaLoadBalancerListenerIdentity() bool { + return true +} + +// UnmarshalLoadBalancerListenerIdentityByHref unmarshals an instance of LoadBalancerListenerIdentityByHref from the specified map of raw messages. +func UnmarshalLoadBalancerListenerIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerIdentityByID : LoadBalancerListenerIdentityByID struct +// This model "extends" LoadBalancerListenerIdentity +type LoadBalancerListenerIdentityByID struct { + // The unique identifier for this load balancer listener. + ID *string `json:"id" validate:"required"` +} + +// NewLoadBalancerListenerIdentityByID : Instantiate LoadBalancerListenerIdentityByID (Generic Model Constructor) +func (*VpcV1) NewLoadBalancerListenerIdentityByID(id string) (_model *LoadBalancerListenerIdentityByID, err error) { + _model = &LoadBalancerListenerIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*LoadBalancerListenerIdentityByID) isaLoadBalancerListenerIdentity() bool { + return true +} + +// UnmarshalLoadBalancerListenerIdentityByID unmarshals an instance of LoadBalancerListenerIdentityByID from the specified map of raw messages. +func UnmarshalLoadBalancerListenerIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerPolicyTargetPatchLoadBalancerListenerHTTPSRedirectPatch : LoadBalancerListenerPolicyTargetPatchLoadBalancerListenerHTTPSRedirectPatch struct +// This model "extends" LoadBalancerListenerPolicyTargetPatch +type LoadBalancerListenerPolicyTargetPatchLoadBalancerListenerHTTPSRedirectPatch struct { + // The HTTP status code for this redirect. + HTTPStatusCode *int64 `json:"http_status_code,omitempty"` + + // Identifies a load balancer listener by a unique property. + Listener LoadBalancerListenerIdentityIntf `json:"listener,omitempty"` + + // The redirect relative target URI. + URI *string `json:"uri,omitempty"` +} + +func (*LoadBalancerListenerPolicyTargetPatchLoadBalancerListenerHTTPSRedirectPatch) isaLoadBalancerListenerPolicyTargetPatch() bool { + return true +} + +// UnmarshalLoadBalancerListenerPolicyTargetPatchLoadBalancerListenerHTTPSRedirectPatch unmarshals an instance of LoadBalancerListenerPolicyTargetPatchLoadBalancerListenerHTTPSRedirectPatch from the specified map of raw messages. +func UnmarshalLoadBalancerListenerPolicyTargetPatchLoadBalancerListenerHTTPSRedirectPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerPolicyTargetPatchLoadBalancerListenerHTTPSRedirectPatch) + err = core.UnmarshalPrimitive(m, "http_status_code", &obj.HTTPStatusCode) + if err != nil { + return + } + err = core.UnmarshalModel(m, "listener", &obj.Listener, UnmarshalLoadBalancerListenerIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "uri", &obj.URI) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerPolicyTargetPatchLoadBalancerListenerPolicyRedirectURLPatch : LoadBalancerListenerPolicyTargetPatchLoadBalancerListenerPolicyRedirectURLPatch struct +// This model "extends" LoadBalancerListenerPolicyTargetPatch +type LoadBalancerListenerPolicyTargetPatchLoadBalancerListenerPolicyRedirectURLPatch struct { + // The HTTP status code for this redirect. + HTTPStatusCode *int64 `json:"http_status_code,omitempty"` + + // The redirect target URL. + URL *string `json:"url,omitempty"` +} + +func (*LoadBalancerListenerPolicyTargetPatchLoadBalancerListenerPolicyRedirectURLPatch) isaLoadBalancerListenerPolicyTargetPatch() bool { + return true +} + +// UnmarshalLoadBalancerListenerPolicyTargetPatchLoadBalancerListenerPolicyRedirectURLPatch unmarshals an instance of LoadBalancerListenerPolicyTargetPatchLoadBalancerListenerPolicyRedirectURLPatch from the specified map of raw messages. +func UnmarshalLoadBalancerListenerPolicyTargetPatchLoadBalancerListenerPolicyRedirectURLPatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerPolicyTargetPatchLoadBalancerListenerPolicyRedirectURLPatch) + err = core.UnmarshalPrimitive(m, "http_status_code", &obj.HTTPStatusCode) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "url", &obj.URL) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentity : Identifies a load balancer pool by a unique property. +// Models which "extend" this model: +// - LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityLoadBalancerPoolIdentityByID +// - LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityLoadBalancerPoolIdentityByHref +// This model "extends" LoadBalancerListenerPolicyTargetPatch +type LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentity struct { + // The unique identifier for this load balancer pool. + ID *string `json:"id,omitempty"` + + // The pool's canonical URL. + Href *string `json:"href,omitempty"` +} + +func (*LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentity) isaLoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentity() bool { + return true +} + +type LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityIntf interface { + LoadBalancerListenerPolicyTargetPatchIntf + isaLoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentity() bool +} + +func (*LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentity) isaLoadBalancerListenerPolicyTargetPatch() bool { + return true +} + +// UnmarshalLoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentity unmarshals an instance of LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentity from the specified map of raw messages. +func UnmarshalLoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerPolicyTargetPrototypeLoadBalancerListenerHTTPSRedirectPrototype : LoadBalancerListenerPolicyTargetPrototypeLoadBalancerListenerHTTPSRedirectPrototype struct +// This model "extends" LoadBalancerListenerPolicyTargetPrototype +type LoadBalancerListenerPolicyTargetPrototypeLoadBalancerListenerHTTPSRedirectPrototype struct { + // The HTTP status code for this redirect. + HTTPStatusCode *int64 `json:"http_status_code" validate:"required"` + + // Identifies a load balancer listener by a unique property. + Listener LoadBalancerListenerIdentityIntf `json:"listener" validate:"required"` + + // The redirect relative target URI. + URI *string `json:"uri,omitempty"` +} + +// NewLoadBalancerListenerPolicyTargetPrototypeLoadBalancerListenerHTTPSRedirectPrototype : Instantiate LoadBalancerListenerPolicyTargetPrototypeLoadBalancerListenerHTTPSRedirectPrototype (Generic Model Constructor) +func (*VpcV1) NewLoadBalancerListenerPolicyTargetPrototypeLoadBalancerListenerHTTPSRedirectPrototype(httpStatusCode int64, listener LoadBalancerListenerIdentityIntf) (_model *LoadBalancerListenerPolicyTargetPrototypeLoadBalancerListenerHTTPSRedirectPrototype, err error) { + _model = &LoadBalancerListenerPolicyTargetPrototypeLoadBalancerListenerHTTPSRedirectPrototype{ + HTTPStatusCode: core.Int64Ptr(httpStatusCode), + Listener: listener, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*LoadBalancerListenerPolicyTargetPrototypeLoadBalancerListenerHTTPSRedirectPrototype) isaLoadBalancerListenerPolicyTargetPrototype() bool { + return true +} + +// UnmarshalLoadBalancerListenerPolicyTargetPrototypeLoadBalancerListenerHTTPSRedirectPrototype unmarshals an instance of LoadBalancerListenerPolicyTargetPrototypeLoadBalancerListenerHTTPSRedirectPrototype from the specified map of raw messages. +func UnmarshalLoadBalancerListenerPolicyTargetPrototypeLoadBalancerListenerHTTPSRedirectPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerPolicyTargetPrototypeLoadBalancerListenerHTTPSRedirectPrototype) + err = core.UnmarshalPrimitive(m, "http_status_code", &obj.HTTPStatusCode) + if err != nil { + return + } + err = core.UnmarshalModel(m, "listener", &obj.Listener, UnmarshalLoadBalancerListenerIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "uri", &obj.URI) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerPolicyTargetPrototypeLoadBalancerListenerPolicyRedirectURLPrototype : LoadBalancerListenerPolicyTargetPrototypeLoadBalancerListenerPolicyRedirectURLPrototype struct +// This model "extends" LoadBalancerListenerPolicyTargetPrototype +type LoadBalancerListenerPolicyTargetPrototypeLoadBalancerListenerPolicyRedirectURLPrototype struct { + // The HTTP status code for this redirect. + HTTPStatusCode *int64 `json:"http_status_code" validate:"required"` + + // The redirect target URL. + URL *string `json:"url" validate:"required"` +} + +// NewLoadBalancerListenerPolicyTargetPrototypeLoadBalancerListenerPolicyRedirectURLPrototype : Instantiate LoadBalancerListenerPolicyTargetPrototypeLoadBalancerListenerPolicyRedirectURLPrototype (Generic Model Constructor) +func (*VpcV1) NewLoadBalancerListenerPolicyTargetPrototypeLoadBalancerListenerPolicyRedirectURLPrototype(httpStatusCode int64, url string) (_model *LoadBalancerListenerPolicyTargetPrototypeLoadBalancerListenerPolicyRedirectURLPrototype, err error) { + _model = &LoadBalancerListenerPolicyTargetPrototypeLoadBalancerListenerPolicyRedirectURLPrototype{ + HTTPStatusCode: core.Int64Ptr(httpStatusCode), + URL: core.StringPtr(url), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*LoadBalancerListenerPolicyTargetPrototypeLoadBalancerListenerPolicyRedirectURLPrototype) isaLoadBalancerListenerPolicyTargetPrototype() bool { + return true +} + +// UnmarshalLoadBalancerListenerPolicyTargetPrototypeLoadBalancerListenerPolicyRedirectURLPrototype unmarshals an instance of LoadBalancerListenerPolicyTargetPrototypeLoadBalancerListenerPolicyRedirectURLPrototype from the specified map of raw messages. +func UnmarshalLoadBalancerListenerPolicyTargetPrototypeLoadBalancerListenerPolicyRedirectURLPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerPolicyTargetPrototypeLoadBalancerListenerPolicyRedirectURLPrototype) + err = core.UnmarshalPrimitive(m, "http_status_code", &obj.HTTPStatusCode) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "url", &obj.URL) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentity : Identifies a load balancer pool by a unique property. +// Models which "extend" this model: +// - LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityLoadBalancerPoolIdentityByID +// - LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityLoadBalancerPoolIdentityByHref +// This model "extends" LoadBalancerListenerPolicyTargetPrototype +type LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentity struct { + // The unique identifier for this load balancer pool. + ID *string `json:"id,omitempty"` + + // The pool's canonical URL. + Href *string `json:"href,omitempty"` +} + +func (*LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentity) isaLoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentity() bool { + return true +} + +type LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityIntf interface { + LoadBalancerListenerPolicyTargetPrototypeIntf + isaLoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentity() bool +} + +func (*LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentity) isaLoadBalancerListenerPolicyTargetPrototype() bool { + return true +} + +// UnmarshalLoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentity unmarshals an instance of LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentity from the specified map of raw messages. +func UnmarshalLoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerPolicyTargetLoadBalancerListenerHTTPSRedirect : LoadBalancerListenerPolicyTargetLoadBalancerListenerHTTPSRedirect struct +// This model "extends" LoadBalancerListenerPolicyTarget +type LoadBalancerListenerPolicyTargetLoadBalancerListenerHTTPSRedirect struct { + // The HTTP status code for this redirect. + HTTPStatusCode *int64 `json:"http_status_code" validate:"required"` + + Listener *LoadBalancerListenerReference `json:"listener" validate:"required"` + + // The redirect relative target URI. + URI *string `json:"uri,omitempty"` +} + +func (*LoadBalancerListenerPolicyTargetLoadBalancerListenerHTTPSRedirect) isaLoadBalancerListenerPolicyTarget() bool { + return true +} + +// UnmarshalLoadBalancerListenerPolicyTargetLoadBalancerListenerHTTPSRedirect unmarshals an instance of LoadBalancerListenerPolicyTargetLoadBalancerListenerHTTPSRedirect from the specified map of raw messages. +func UnmarshalLoadBalancerListenerPolicyTargetLoadBalancerListenerHTTPSRedirect(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerPolicyTargetLoadBalancerListenerHTTPSRedirect) + err = core.UnmarshalPrimitive(m, "http_status_code", &obj.HTTPStatusCode) + if err != nil { + return + } + err = core.UnmarshalModel(m, "listener", &obj.Listener, UnmarshalLoadBalancerListenerReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "uri", &obj.URI) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerPolicyTargetLoadBalancerListenerPolicyRedirectURL : LoadBalancerListenerPolicyTargetLoadBalancerListenerPolicyRedirectURL struct +// This model "extends" LoadBalancerListenerPolicyTarget +type LoadBalancerListenerPolicyTargetLoadBalancerListenerPolicyRedirectURL struct { + // The HTTP status code for this redirect. + HTTPStatusCode *int64 `json:"http_status_code" validate:"required"` + + // The redirect target URL. + URL *string `json:"url" validate:"required"` +} + +func (*LoadBalancerListenerPolicyTargetLoadBalancerListenerPolicyRedirectURL) isaLoadBalancerListenerPolicyTarget() bool { + return true +} + +// UnmarshalLoadBalancerListenerPolicyTargetLoadBalancerListenerPolicyRedirectURL unmarshals an instance of LoadBalancerListenerPolicyTargetLoadBalancerListenerPolicyRedirectURL from the specified map of raw messages. +func UnmarshalLoadBalancerListenerPolicyTargetLoadBalancerListenerPolicyRedirectURL(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerPolicyTargetLoadBalancerListenerPolicyRedirectURL) + err = core.UnmarshalPrimitive(m, "http_status_code", &obj.HTTPStatusCode) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "url", &obj.URL) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerPolicyTargetLoadBalancerPoolReference : LoadBalancerListenerPolicyTargetLoadBalancerPoolReference struct +// This model "extends" LoadBalancerListenerPolicyTarget +type LoadBalancerListenerPolicyTargetLoadBalancerPoolReference struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *LoadBalancerPoolReferenceDeleted `json:"deleted,omitempty"` + + // The pool's canonical URL. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this load balancer pool. + ID *string `json:"id" validate:"required"` + + // The name for this load balancer pool. The name is unique across all pools for the load balancer. + Name *string `json:"name" validate:"required"` +} + +func (*LoadBalancerListenerPolicyTargetLoadBalancerPoolReference) isaLoadBalancerListenerPolicyTarget() bool { + return true +} + +// UnmarshalLoadBalancerListenerPolicyTargetLoadBalancerPoolReference unmarshals an instance of LoadBalancerListenerPolicyTargetLoadBalancerPoolReference from the specified map of raw messages. +func UnmarshalLoadBalancerListenerPolicyTargetLoadBalancerPoolReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerPolicyTargetLoadBalancerPoolReference) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalLoadBalancerPoolReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerPoolIdentityByHref : LoadBalancerPoolIdentityByHref struct +// This model "extends" LoadBalancerPoolIdentity +type LoadBalancerPoolIdentityByHref struct { + // The pool's canonical URL. + Href *string `json:"href" validate:"required"` +} + +// NewLoadBalancerPoolIdentityByHref : Instantiate LoadBalancerPoolIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewLoadBalancerPoolIdentityByHref(href string) (_model *LoadBalancerPoolIdentityByHref, err error) { + _model = &LoadBalancerPoolIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*LoadBalancerPoolIdentityByHref) isaLoadBalancerPoolIdentity() bool { + return true +} + +// UnmarshalLoadBalancerPoolIdentityByHref unmarshals an instance of LoadBalancerPoolIdentityByHref from the specified map of raw messages. +func UnmarshalLoadBalancerPoolIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPoolIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerPoolIdentityByID : LoadBalancerPoolIdentityByID struct +// This model "extends" LoadBalancerPoolIdentity +type LoadBalancerPoolIdentityByID struct { + // The unique identifier for this load balancer pool. + ID *string `json:"id" validate:"required"` +} + +// NewLoadBalancerPoolIdentityByID : Instantiate LoadBalancerPoolIdentityByID (Generic Model Constructor) +func (*VpcV1) NewLoadBalancerPoolIdentityByID(id string) (_model *LoadBalancerPoolIdentityByID, err error) { + _model = &LoadBalancerPoolIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*LoadBalancerPoolIdentityByID) isaLoadBalancerPoolIdentity() bool { + return true +} + +// UnmarshalLoadBalancerPoolIdentityByID unmarshals an instance of LoadBalancerPoolIdentityByID from the specified map of raw messages. +func UnmarshalLoadBalancerPoolIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPoolIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerPoolMemberTargetPrototypeIP : LoadBalancerPoolMemberTargetPrototypeIP struct +// This model "extends" LoadBalancerPoolMemberTargetPrototype +type LoadBalancerPoolMemberTargetPrototypeIP struct { + // The IP address. + // + // This property may add support for IPv6 addresses in the future. When processing a value in this property, verify + // that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the + // error, or bypass the resource on which the unexpected IP address format was encountered. + Address *string `json:"address" validate:"required"` +} + +// NewLoadBalancerPoolMemberTargetPrototypeIP : Instantiate LoadBalancerPoolMemberTargetPrototypeIP (Generic Model Constructor) +func (*VpcV1) NewLoadBalancerPoolMemberTargetPrototypeIP(address string) (_model *LoadBalancerPoolMemberTargetPrototypeIP, err error) { + _model = &LoadBalancerPoolMemberTargetPrototypeIP{ + Address: core.StringPtr(address), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*LoadBalancerPoolMemberTargetPrototypeIP) isaLoadBalancerPoolMemberTargetPrototype() bool { + return true +} + +// UnmarshalLoadBalancerPoolMemberTargetPrototypeIP unmarshals an instance of LoadBalancerPoolMemberTargetPrototypeIP from the specified map of raw messages. +func UnmarshalLoadBalancerPoolMemberTargetPrototypeIP(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPoolMemberTargetPrototypeIP) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerPoolMemberTargetPrototypeInstanceIdentity : Identifies a virtual server instance by a unique property. +// Models which "extend" this model: +// - LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByID +// - LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByCRN +// - LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByHref +// This model "extends" LoadBalancerPoolMemberTargetPrototype +type LoadBalancerPoolMemberTargetPrototypeInstanceIdentity struct { + // The unique identifier for this virtual server instance. + ID *string `json:"id,omitempty"` + + // The CRN for this virtual server instance. + CRN *string `json:"crn,omitempty"` + + // The URL for this virtual server instance. + Href *string `json:"href,omitempty"` +} + +func (*LoadBalancerPoolMemberTargetPrototypeInstanceIdentity) isaLoadBalancerPoolMemberTargetPrototypeInstanceIdentity() bool { + return true +} + +type LoadBalancerPoolMemberTargetPrototypeInstanceIdentityIntf interface { + LoadBalancerPoolMemberTargetPrototypeIntf + isaLoadBalancerPoolMemberTargetPrototypeInstanceIdentity() bool +} + +func (*LoadBalancerPoolMemberTargetPrototypeInstanceIdentity) isaLoadBalancerPoolMemberTargetPrototype() bool { + return true +} + +// UnmarshalLoadBalancerPoolMemberTargetPrototypeInstanceIdentity unmarshals an instance of LoadBalancerPoolMemberTargetPrototypeInstanceIdentity from the specified map of raw messages. +func UnmarshalLoadBalancerPoolMemberTargetPrototypeInstanceIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPoolMemberTargetPrototypeInstanceIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerPoolMemberTargetIP : LoadBalancerPoolMemberTargetIP struct +// This model "extends" LoadBalancerPoolMemberTarget +type LoadBalancerPoolMemberTargetIP struct { + // The IP address. + // + // This property may add support for IPv6 addresses in the future. When processing a value in this property, verify + // that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the + // error, or bypass the resource on which the unexpected IP address format was encountered. + Address *string `json:"address" validate:"required"` +} + +func (*LoadBalancerPoolMemberTargetIP) isaLoadBalancerPoolMemberTarget() bool { + return true +} + +// UnmarshalLoadBalancerPoolMemberTargetIP unmarshals an instance of LoadBalancerPoolMemberTargetIP from the specified map of raw messages. +func UnmarshalLoadBalancerPoolMemberTargetIP(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPoolMemberTargetIP) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerPoolMemberTargetInstanceReference : LoadBalancerPoolMemberTargetInstanceReference struct +// This model "extends" LoadBalancerPoolMemberTarget +type LoadBalancerPoolMemberTargetInstanceReference struct { + // The CRN for this virtual server instance. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *InstanceReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this virtual server instance. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this virtual server instance. + ID *string `json:"id" validate:"required"` + + // The name for this virtual server instance. The name is unique across all virtual server instances in the region. + Name *string `json:"name" validate:"required"` +} + +func (*LoadBalancerPoolMemberTargetInstanceReference) isaLoadBalancerPoolMemberTarget() bool { + return true +} + +// UnmarshalLoadBalancerPoolMemberTargetInstanceReference unmarshals an instance of LoadBalancerPoolMemberTargetInstanceReference from the specified map of raw messages. +func UnmarshalLoadBalancerPoolMemberTargetInstanceReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPoolMemberTargetInstanceReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalInstanceReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerProfileIdentityByHref : LoadBalancerProfileIdentityByHref struct +// This model "extends" LoadBalancerProfileIdentity +type LoadBalancerProfileIdentityByHref struct { + // The URL for this load balancer profile. + Href *string `json:"href" validate:"required"` +} + +// NewLoadBalancerProfileIdentityByHref : Instantiate LoadBalancerProfileIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewLoadBalancerProfileIdentityByHref(href string) (_model *LoadBalancerProfileIdentityByHref, err error) { + _model = &LoadBalancerProfileIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*LoadBalancerProfileIdentityByHref) isaLoadBalancerProfileIdentity() bool { + return true +} + +// UnmarshalLoadBalancerProfileIdentityByHref unmarshals an instance of LoadBalancerProfileIdentityByHref from the specified map of raw messages. +func UnmarshalLoadBalancerProfileIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerProfileIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerProfileIdentityByName : LoadBalancerProfileIdentityByName struct +// This model "extends" LoadBalancerProfileIdentity +type LoadBalancerProfileIdentityByName struct { + // The globally unique name for this load balancer profile. + Name *string `json:"name" validate:"required"` +} + +// NewLoadBalancerProfileIdentityByName : Instantiate LoadBalancerProfileIdentityByName (Generic Model Constructor) +func (*VpcV1) NewLoadBalancerProfileIdentityByName(name string) (_model *LoadBalancerProfileIdentityByName, err error) { + _model = &LoadBalancerProfileIdentityByName{ + Name: core.StringPtr(name), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*LoadBalancerProfileIdentityByName) isaLoadBalancerProfileIdentity() bool { + return true +} + +// UnmarshalLoadBalancerProfileIdentityByName unmarshals an instance of LoadBalancerProfileIdentityByName from the specified map of raw messages. +func UnmarshalLoadBalancerProfileIdentityByName(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerProfileIdentityByName) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerProfileInstanceGroupsSupportedDependent : The instance groups support for a load balancer with this profile depends on its configuration. +// This model "extends" LoadBalancerProfileInstanceGroupsSupported +type LoadBalancerProfileInstanceGroupsSupportedDependent struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the LoadBalancerProfileInstanceGroupsSupportedDependent.Type property. +// The type for this profile field. +const ( + LoadBalancerProfileInstanceGroupsSupportedDependentTypeDependentConst = "dependent" +) + +func (*LoadBalancerProfileInstanceGroupsSupportedDependent) isaLoadBalancerProfileInstanceGroupsSupported() bool { + return true +} + +// UnmarshalLoadBalancerProfileInstanceGroupsSupportedDependent unmarshals an instance of LoadBalancerProfileInstanceGroupsSupportedDependent from the specified map of raw messages. +func UnmarshalLoadBalancerProfileInstanceGroupsSupportedDependent(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerProfileInstanceGroupsSupportedDependent) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerProfileInstanceGroupsSupportedFixed : The instance groups support for a load balancer with this profile. +// This model "extends" LoadBalancerProfileInstanceGroupsSupported +type LoadBalancerProfileInstanceGroupsSupportedFixed struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The value for this profile field. + Value *bool `json:"value" validate:"required"` +} + +// Constants associated with the LoadBalancerProfileInstanceGroupsSupportedFixed.Type property. +// The type for this profile field. +const ( + LoadBalancerProfileInstanceGroupsSupportedFixedTypeFixedConst = "fixed" +) + +func (*LoadBalancerProfileInstanceGroupsSupportedFixed) isaLoadBalancerProfileInstanceGroupsSupported() bool { + return true +} + +// UnmarshalLoadBalancerProfileInstanceGroupsSupportedFixed unmarshals an instance of LoadBalancerProfileInstanceGroupsSupportedFixed from the specified map of raw messages. +func UnmarshalLoadBalancerProfileInstanceGroupsSupportedFixed(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerProfileInstanceGroupsSupportedFixed) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerProfileRouteModeSupportedDependent : The route mode support for a load balancer with this profile depends on its configuration. +// This model "extends" LoadBalancerProfileRouteModeSupported +type LoadBalancerProfileRouteModeSupportedDependent struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the LoadBalancerProfileRouteModeSupportedDependent.Type property. +// The type for this profile field. +const ( + LoadBalancerProfileRouteModeSupportedDependentTypeDependentConst = "dependent" +) + +func (*LoadBalancerProfileRouteModeSupportedDependent) isaLoadBalancerProfileRouteModeSupported() bool { + return true +} + +// UnmarshalLoadBalancerProfileRouteModeSupportedDependent unmarshals an instance of LoadBalancerProfileRouteModeSupportedDependent from the specified map of raw messages. +func UnmarshalLoadBalancerProfileRouteModeSupportedDependent(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerProfileRouteModeSupportedDependent) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerProfileRouteModeSupportedFixed : The route mode support for a load balancer with this profile. +// This model "extends" LoadBalancerProfileRouteModeSupported +type LoadBalancerProfileRouteModeSupportedFixed struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The value for this profile field. + Value *bool `json:"value" validate:"required"` +} + +// Constants associated with the LoadBalancerProfileRouteModeSupportedFixed.Type property. +// The type for this profile field. +const ( + LoadBalancerProfileRouteModeSupportedFixedTypeFixedConst = "fixed" +) + +func (*LoadBalancerProfileRouteModeSupportedFixed) isaLoadBalancerProfileRouteModeSupported() bool { + return true +} + +// UnmarshalLoadBalancerProfileRouteModeSupportedFixed unmarshals an instance of LoadBalancerProfileRouteModeSupportedFixed from the specified map of raw messages. +func UnmarshalLoadBalancerProfileRouteModeSupportedFixed(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerProfileRouteModeSupportedFixed) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerProfileSecurityGroupsSupportedDependent : The security group support for a load balancer with this profile depends on its configuration. +// This model "extends" LoadBalancerProfileSecurityGroupsSupported +type LoadBalancerProfileSecurityGroupsSupportedDependent struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the LoadBalancerProfileSecurityGroupsSupportedDependent.Type property. +// The type for this profile field. +const ( + LoadBalancerProfileSecurityGroupsSupportedDependentTypeDependentConst = "dependent" +) + +func (*LoadBalancerProfileSecurityGroupsSupportedDependent) isaLoadBalancerProfileSecurityGroupsSupported() bool { + return true +} + +// UnmarshalLoadBalancerProfileSecurityGroupsSupportedDependent unmarshals an instance of LoadBalancerProfileSecurityGroupsSupportedDependent from the specified map of raw messages. +func UnmarshalLoadBalancerProfileSecurityGroupsSupportedDependent(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerProfileSecurityGroupsSupportedDependent) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerProfileSecurityGroupsSupportedFixed : The security group support for a load balancer with this profile. +// This model "extends" LoadBalancerProfileSecurityGroupsSupported +type LoadBalancerProfileSecurityGroupsSupportedFixed struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The value for this profile field. + Value *bool `json:"value" validate:"required"` +} + +// Constants associated with the LoadBalancerProfileSecurityGroupsSupportedFixed.Type property. +// The type for this profile field. +const ( + LoadBalancerProfileSecurityGroupsSupportedFixedTypeFixedConst = "fixed" +) + +func (*LoadBalancerProfileSecurityGroupsSupportedFixed) isaLoadBalancerProfileSecurityGroupsSupported() bool { + return true +} + +// UnmarshalLoadBalancerProfileSecurityGroupsSupportedFixed unmarshals an instance of LoadBalancerProfileSecurityGroupsSupportedFixed from the specified map of raw messages. +func UnmarshalLoadBalancerProfileSecurityGroupsSupportedFixed(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerProfileSecurityGroupsSupportedFixed) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerProfileUDPSupportedDependent : The UDP support for a load balancer with this profile depends on its configuration. +// This model "extends" LoadBalancerProfileUDPSupported +type LoadBalancerProfileUDPSupportedDependent struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the LoadBalancerProfileUDPSupportedDependent.Type property. +// The type for this profile field. +const ( + LoadBalancerProfileUDPSupportedDependentTypeDependentConst = "dependent" +) + +func (*LoadBalancerProfileUDPSupportedDependent) isaLoadBalancerProfileUDPSupported() bool { + return true +} + +// UnmarshalLoadBalancerProfileUDPSupportedDependent unmarshals an instance of LoadBalancerProfileUDPSupportedDependent from the specified map of raw messages. +func UnmarshalLoadBalancerProfileUDPSupportedDependent(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerProfileUDPSupportedDependent) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerProfileUDPSupportedFixed : The UDP support for a load balancer with this profile. +// This model "extends" LoadBalancerProfileUDPSupported +type LoadBalancerProfileUDPSupportedFixed struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The value for this profile field. + Value *bool `json:"value" validate:"required"` +} + +// Constants associated with the LoadBalancerProfileUDPSupportedFixed.Type property. +// The type for this profile field. +const ( + LoadBalancerProfileUDPSupportedFixedTypeFixedConst = "fixed" +) + +func (*LoadBalancerProfileUDPSupportedFixed) isaLoadBalancerProfileUDPSupported() bool { + return true +} + +// UnmarshalLoadBalancerProfileUDPSupportedFixed unmarshals an instance of LoadBalancerProfileUDPSupportedFixed from the specified map of raw messages. +func UnmarshalLoadBalancerProfileUDPSupportedFixed(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerProfileUDPSupportedFixed) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLIdentityByCRN : NetworkACLIdentityByCRN struct +// This model "extends" NetworkACLIdentity +type NetworkACLIdentityByCRN struct { + // The CRN for this network ACL. + CRN *string `json:"crn" validate:"required"` +} + +// NewNetworkACLIdentityByCRN : Instantiate NetworkACLIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewNetworkACLIdentityByCRN(crn string) (_model *NetworkACLIdentityByCRN, err error) { + _model = &NetworkACLIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*NetworkACLIdentityByCRN) isaNetworkACLIdentity() bool { + return true +} + +// UnmarshalNetworkACLIdentityByCRN unmarshals an instance of NetworkACLIdentityByCRN from the specified map of raw messages. +func UnmarshalNetworkACLIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLIdentityByHref : NetworkACLIdentityByHref struct +// This model "extends" NetworkACLIdentity +type NetworkACLIdentityByHref struct { + // The URL for this network ACL. + Href *string `json:"href" validate:"required"` +} + +// NewNetworkACLIdentityByHref : Instantiate NetworkACLIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewNetworkACLIdentityByHref(href string) (_model *NetworkACLIdentityByHref, err error) { + _model = &NetworkACLIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*NetworkACLIdentityByHref) isaNetworkACLIdentity() bool { + return true +} + +// UnmarshalNetworkACLIdentityByHref unmarshals an instance of NetworkACLIdentityByHref from the specified map of raw messages. +func UnmarshalNetworkACLIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLIdentityByID : NetworkACLIdentityByID struct +// This model "extends" NetworkACLIdentity +type NetworkACLIdentityByID struct { + // The unique identifier for this network ACL. + ID *string `json:"id" validate:"required"` +} + +// NewNetworkACLIdentityByID : Instantiate NetworkACLIdentityByID (Generic Model Constructor) +func (*VpcV1) NewNetworkACLIdentityByID(id string) (_model *NetworkACLIdentityByID, err error) { + _model = &NetworkACLIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*NetworkACLIdentityByID) isaNetworkACLIdentity() bool { + return true +} + +// UnmarshalNetworkACLIdentityByID unmarshals an instance of NetworkACLIdentityByID from the specified map of raw messages. +func UnmarshalNetworkACLIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLPrototypeNetworkACLByRules : NetworkACLPrototypeNetworkACLByRules struct +// This model "extends" NetworkACLPrototype +type NetworkACLPrototypeNetworkACLByRules struct { + // The name for this network ACL. The name must not be used by another network ACL for the VPC. If unspecified, the + // name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The VPC this network ACL will reside in. + VPC VPCIdentityIntf `json:"vpc" validate:"required"` + + // The prototype objects for rules to create along with this network ACL. If unspecified, no rules will be created, + // resulting in all traffic being denied. + Rules []NetworkACLRulePrototypeNetworkACLContextIntf `json:"rules,omitempty"` +} + +// NewNetworkACLPrototypeNetworkACLByRules : Instantiate NetworkACLPrototypeNetworkACLByRules (Generic Model Constructor) +func (*VpcV1) NewNetworkACLPrototypeNetworkACLByRules(vpc VPCIdentityIntf) (_model *NetworkACLPrototypeNetworkACLByRules, err error) { + _model = &NetworkACLPrototypeNetworkACLByRules{ + VPC: vpc, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*NetworkACLPrototypeNetworkACLByRules) isaNetworkACLPrototype() bool { + return true +} + +// UnmarshalNetworkACLPrototypeNetworkACLByRules unmarshals an instance of NetworkACLPrototypeNetworkACLByRules from the specified map of raw messages. +func UnmarshalNetworkACLPrototypeNetworkACLByRules(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLPrototypeNetworkACLByRules) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "rules", &obj.Rules, UnmarshalNetworkACLRulePrototypeNetworkACLContext) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLPrototypeNetworkACLBySourceNetworkACL : NetworkACLPrototypeNetworkACLBySourceNetworkACL struct +// This model "extends" NetworkACLPrototype +type NetworkACLPrototypeNetworkACLBySourceNetworkACL struct { + // The name for this network ACL. The name must not be used by another network ACL for the VPC. If unspecified, the + // name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The VPC this network ACL will reside in. + VPC VPCIdentityIntf `json:"vpc" validate:"required"` + + // Network ACL to copy rules from. + SourceNetworkACL NetworkACLIdentityIntf `json:"source_network_acl" validate:"required"` +} + +// NewNetworkACLPrototypeNetworkACLBySourceNetworkACL : Instantiate NetworkACLPrototypeNetworkACLBySourceNetworkACL (Generic Model Constructor) +func (*VpcV1) NewNetworkACLPrototypeNetworkACLBySourceNetworkACL(vpc VPCIdentityIntf, sourceNetworkACL NetworkACLIdentityIntf) (_model *NetworkACLPrototypeNetworkACLBySourceNetworkACL, err error) { + _model = &NetworkACLPrototypeNetworkACLBySourceNetworkACL{ + VPC: vpc, + SourceNetworkACL: sourceNetworkACL, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*NetworkACLPrototypeNetworkACLBySourceNetworkACL) isaNetworkACLPrototype() bool { + return true +} + +// UnmarshalNetworkACLPrototypeNetworkACLBySourceNetworkACL unmarshals an instance of NetworkACLPrototypeNetworkACLBySourceNetworkACL from the specified map of raw messages. +func UnmarshalNetworkACLPrototypeNetworkACLBySourceNetworkACL(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLPrototypeNetworkACLBySourceNetworkACL) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "source_network_acl", &obj.SourceNetworkACL, UnmarshalNetworkACLIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLRuleBeforePatchNetworkACLRuleIdentityByHref : NetworkACLRuleBeforePatchNetworkACLRuleIdentityByHref struct +// This model "extends" NetworkACLRuleBeforePatch +type NetworkACLRuleBeforePatchNetworkACLRuleIdentityByHref struct { + // The URL for this network ACL rule. + Href *string `json:"href" validate:"required"` +} + +// NewNetworkACLRuleBeforePatchNetworkACLRuleIdentityByHref : Instantiate NetworkACLRuleBeforePatchNetworkACLRuleIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewNetworkACLRuleBeforePatchNetworkACLRuleIdentityByHref(href string) (_model *NetworkACLRuleBeforePatchNetworkACLRuleIdentityByHref, err error) { + _model = &NetworkACLRuleBeforePatchNetworkACLRuleIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*NetworkACLRuleBeforePatchNetworkACLRuleIdentityByHref) isaNetworkACLRuleBeforePatch() bool { + return true +} + +// UnmarshalNetworkACLRuleBeforePatchNetworkACLRuleIdentityByHref unmarshals an instance of NetworkACLRuleBeforePatchNetworkACLRuleIdentityByHref from the specified map of raw messages. +func UnmarshalNetworkACLRuleBeforePatchNetworkACLRuleIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLRuleBeforePatchNetworkACLRuleIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLRuleBeforePatchNetworkACLRuleIdentityByID : NetworkACLRuleBeforePatchNetworkACLRuleIdentityByID struct +// This model "extends" NetworkACLRuleBeforePatch +type NetworkACLRuleBeforePatchNetworkACLRuleIdentityByID struct { + // The unique identifier for this network ACL rule. + ID *string `json:"id" validate:"required"` +} + +// NewNetworkACLRuleBeforePatchNetworkACLRuleIdentityByID : Instantiate NetworkACLRuleBeforePatchNetworkACLRuleIdentityByID (Generic Model Constructor) +func (*VpcV1) NewNetworkACLRuleBeforePatchNetworkACLRuleIdentityByID(id string) (_model *NetworkACLRuleBeforePatchNetworkACLRuleIdentityByID, err error) { + _model = &NetworkACLRuleBeforePatchNetworkACLRuleIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*NetworkACLRuleBeforePatchNetworkACLRuleIdentityByID) isaNetworkACLRuleBeforePatch() bool { + return true +} + +// UnmarshalNetworkACLRuleBeforePatchNetworkACLRuleIdentityByID unmarshals an instance of NetworkACLRuleBeforePatchNetworkACLRuleIdentityByID from the specified map of raw messages. +func UnmarshalNetworkACLRuleBeforePatchNetworkACLRuleIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLRuleBeforePatchNetworkACLRuleIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLRuleBeforePrototypeNetworkACLRuleIdentityByHref : NetworkACLRuleBeforePrototypeNetworkACLRuleIdentityByHref struct +// This model "extends" NetworkACLRuleBeforePrototype +type NetworkACLRuleBeforePrototypeNetworkACLRuleIdentityByHref struct { + // The URL for this network ACL rule. + Href *string `json:"href" validate:"required"` +} + +// NewNetworkACLRuleBeforePrototypeNetworkACLRuleIdentityByHref : Instantiate NetworkACLRuleBeforePrototypeNetworkACLRuleIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewNetworkACLRuleBeforePrototypeNetworkACLRuleIdentityByHref(href string) (_model *NetworkACLRuleBeforePrototypeNetworkACLRuleIdentityByHref, err error) { + _model = &NetworkACLRuleBeforePrototypeNetworkACLRuleIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*NetworkACLRuleBeforePrototypeNetworkACLRuleIdentityByHref) isaNetworkACLRuleBeforePrototype() bool { + return true +} + +// UnmarshalNetworkACLRuleBeforePrototypeNetworkACLRuleIdentityByHref unmarshals an instance of NetworkACLRuleBeforePrototypeNetworkACLRuleIdentityByHref from the specified map of raw messages. +func UnmarshalNetworkACLRuleBeforePrototypeNetworkACLRuleIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLRuleBeforePrototypeNetworkACLRuleIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLRuleBeforePrototypeNetworkACLRuleIdentityByID : NetworkACLRuleBeforePrototypeNetworkACLRuleIdentityByID struct +// This model "extends" NetworkACLRuleBeforePrototype +type NetworkACLRuleBeforePrototypeNetworkACLRuleIdentityByID struct { + // The unique identifier for this network ACL rule. + ID *string `json:"id" validate:"required"` +} + +// NewNetworkACLRuleBeforePrototypeNetworkACLRuleIdentityByID : Instantiate NetworkACLRuleBeforePrototypeNetworkACLRuleIdentityByID (Generic Model Constructor) +func (*VpcV1) NewNetworkACLRuleBeforePrototypeNetworkACLRuleIdentityByID(id string) (_model *NetworkACLRuleBeforePrototypeNetworkACLRuleIdentityByID, err error) { + _model = &NetworkACLRuleBeforePrototypeNetworkACLRuleIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*NetworkACLRuleBeforePrototypeNetworkACLRuleIdentityByID) isaNetworkACLRuleBeforePrototype() bool { + return true +} + +// UnmarshalNetworkACLRuleBeforePrototypeNetworkACLRuleIdentityByID unmarshals an instance of NetworkACLRuleBeforePrototypeNetworkACLRuleIdentityByID from the specified map of raw messages. +func UnmarshalNetworkACLRuleBeforePrototypeNetworkACLRuleIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLRuleBeforePrototypeNetworkACLRuleIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLRuleItemNetworkACLRuleProtocolAll : NetworkACLRuleItemNetworkACLRuleProtocolAll struct +// This model "extends" NetworkACLRuleItem +type NetworkACLRuleItemNetworkACLRuleProtocolAll struct { + // The action to perform for a packet matching the rule. + Action *string `json:"action" validate:"required"` + + // The rule that this rule is immediately before. In a rule collection, this always refers to the next item in the + // collection. If absent, this is the last rule. + Before *NetworkACLRuleReference `json:"before,omitempty"` + + // The date and time that the rule was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The destination IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all destination addresses. + Destination *string `json:"destination" validate:"required"` + + // The direction of traffic to match. + Direction *string `json:"direction" validate:"required"` + + // The URL for this network ACL rule. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this network ACL rule. + ID *string `json:"id" validate:"required"` + + // The IP version for this rule. + IPVersion *string `json:"ip_version" validate:"required"` + + // The name for this network ACL rule. The name is unique across all rules for the network ACL. + Name *string `json:"name" validate:"required"` + + // The source IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all source addresses. + Source *string `json:"source" validate:"required"` + + // The protocol to enforce. + Protocol *string `json:"protocol" validate:"required"` +} + +// Constants associated with the NetworkACLRuleItemNetworkACLRuleProtocolAll.Action property. +// The action to perform for a packet matching the rule. +const ( + NetworkACLRuleItemNetworkACLRuleProtocolAllActionAllowConst = "allow" + NetworkACLRuleItemNetworkACLRuleProtocolAllActionDenyConst = "deny" +) + +// Constants associated with the NetworkACLRuleItemNetworkACLRuleProtocolAll.Direction property. +// The direction of traffic to match. +const ( + NetworkACLRuleItemNetworkACLRuleProtocolAllDirectionInboundConst = "inbound" + NetworkACLRuleItemNetworkACLRuleProtocolAllDirectionOutboundConst = "outbound" +) + +// Constants associated with the NetworkACLRuleItemNetworkACLRuleProtocolAll.IPVersion property. +// The IP version for this rule. +const ( + NetworkACLRuleItemNetworkACLRuleProtocolAllIPVersionIpv4Const = "ipv4" +) + +// Constants associated with the NetworkACLRuleItemNetworkACLRuleProtocolAll.Protocol property. +// The protocol to enforce. +const ( + NetworkACLRuleItemNetworkACLRuleProtocolAllProtocolAllConst = "all" +) + +func (*NetworkACLRuleItemNetworkACLRuleProtocolAll) isaNetworkACLRuleItem() bool { + return true +} + +// UnmarshalNetworkACLRuleItemNetworkACLRuleProtocolAll unmarshals an instance of NetworkACLRuleItemNetworkACLRuleProtocolAll from the specified map of raw messages. +func UnmarshalNetworkACLRuleItemNetworkACLRuleProtocolAll(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLRuleItemNetworkACLRuleProtocolAll) + err = core.UnmarshalPrimitive(m, "action", &obj.Action) + if err != nil { + return + } + err = core.UnmarshalModel(m, "before", &obj.Before, UnmarshalNetworkACLRuleReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "destination", &obj.Destination) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "direction", &obj.Direction) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "ip_version", &obj.IPVersion) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "source", &obj.Source) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "protocol", &obj.Protocol) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLRuleItemNetworkACLRuleProtocolIcmp : NetworkACLRuleItemNetworkACLRuleProtocolIcmp struct +// This model "extends" NetworkACLRuleItem +type NetworkACLRuleItemNetworkACLRuleProtocolIcmp struct { + // The action to perform for a packet matching the rule. + Action *string `json:"action" validate:"required"` + + // The rule that this rule is immediately before. In a rule collection, this always refers to the next item in the + // collection. If absent, this is the last rule. + Before *NetworkACLRuleReference `json:"before,omitempty"` + + // The date and time that the rule was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The destination IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all destination addresses. + Destination *string `json:"destination" validate:"required"` + + // The direction of traffic to match. + Direction *string `json:"direction" validate:"required"` + + // The URL for this network ACL rule. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this network ACL rule. + ID *string `json:"id" validate:"required"` + + // The IP version for this rule. + IPVersion *string `json:"ip_version" validate:"required"` + + // The name for this network ACL rule. The name is unique across all rules for the network ACL. + Name *string `json:"name" validate:"required"` + + // The source IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all source addresses. + Source *string `json:"source" validate:"required"` + + // The ICMP traffic code to match. + // + // If absent, all codes are matched. + Code *int64 `json:"code,omitempty"` + + // The protocol to enforce. + Protocol *string `json:"protocol" validate:"required"` + + // The ICMP traffic type to match. + // + // If absent, all types are matched. + Type *int64 `json:"type,omitempty"` +} + +// Constants associated with the NetworkACLRuleItemNetworkACLRuleProtocolIcmp.Action property. +// The action to perform for a packet matching the rule. +const ( + NetworkACLRuleItemNetworkACLRuleProtocolIcmpActionAllowConst = "allow" + NetworkACLRuleItemNetworkACLRuleProtocolIcmpActionDenyConst = "deny" +) + +// Constants associated with the NetworkACLRuleItemNetworkACLRuleProtocolIcmp.Direction property. +// The direction of traffic to match. +const ( + NetworkACLRuleItemNetworkACLRuleProtocolIcmpDirectionInboundConst = "inbound" + NetworkACLRuleItemNetworkACLRuleProtocolIcmpDirectionOutboundConst = "outbound" +) + +// Constants associated with the NetworkACLRuleItemNetworkACLRuleProtocolIcmp.IPVersion property. +// The IP version for this rule. +const ( + NetworkACLRuleItemNetworkACLRuleProtocolIcmpIPVersionIpv4Const = "ipv4" +) + +// Constants associated with the NetworkACLRuleItemNetworkACLRuleProtocolIcmp.Protocol property. +// The protocol to enforce. +const ( + NetworkACLRuleItemNetworkACLRuleProtocolIcmpProtocolIcmpConst = "icmp" +) + +func (*NetworkACLRuleItemNetworkACLRuleProtocolIcmp) isaNetworkACLRuleItem() bool { + return true +} + +// UnmarshalNetworkACLRuleItemNetworkACLRuleProtocolIcmp unmarshals an instance of NetworkACLRuleItemNetworkACLRuleProtocolIcmp from the specified map of raw messages. +func UnmarshalNetworkACLRuleItemNetworkACLRuleProtocolIcmp(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLRuleItemNetworkACLRuleProtocolIcmp) + err = core.UnmarshalPrimitive(m, "action", &obj.Action) + if err != nil { + return + } + err = core.UnmarshalModel(m, "before", &obj.Before, UnmarshalNetworkACLRuleReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "destination", &obj.Destination) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "direction", &obj.Direction) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "ip_version", &obj.IPVersion) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "source", &obj.Source) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "code", &obj.Code) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "protocol", &obj.Protocol) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLRuleItemNetworkACLRuleProtocolTcpudp : NetworkACLRuleItemNetworkACLRuleProtocolTcpudp struct +// This model "extends" NetworkACLRuleItem +type NetworkACLRuleItemNetworkACLRuleProtocolTcpudp struct { + // The action to perform for a packet matching the rule. + Action *string `json:"action" validate:"required"` + + // The rule that this rule is immediately before. In a rule collection, this always refers to the next item in the + // collection. If absent, this is the last rule. + Before *NetworkACLRuleReference `json:"before,omitempty"` + + // The date and time that the rule was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The destination IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all destination addresses. + Destination *string `json:"destination" validate:"required"` + + // The direction of traffic to match. + Direction *string `json:"direction" validate:"required"` + + // The URL for this network ACL rule. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this network ACL rule. + ID *string `json:"id" validate:"required"` + + // The IP version for this rule. + IPVersion *string `json:"ip_version" validate:"required"` + + // The name for this network ACL rule. The name is unique across all rules for the network ACL. + Name *string `json:"name" validate:"required"` + + // The source IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all source addresses. + Source *string `json:"source" validate:"required"` + + // The inclusive upper bound of TCP/UDP destination port range. + DestinationPortMax *int64 `json:"destination_port_max" validate:"required"` + + // The inclusive lower bound of TCP/UDP destination port range. + DestinationPortMin *int64 `json:"destination_port_min" validate:"required"` + + // The protocol to enforce. + Protocol *string `json:"protocol" validate:"required"` + + // The inclusive upper bound of TCP/UDP source port range. + SourcePortMax *int64 `json:"source_port_max" validate:"required"` + + // The inclusive lower bound of TCP/UDP source port range. + SourcePortMin *int64 `json:"source_port_min" validate:"required"` +} + +// Constants associated with the NetworkACLRuleItemNetworkACLRuleProtocolTcpudp.Action property. +// The action to perform for a packet matching the rule. +const ( + NetworkACLRuleItemNetworkACLRuleProtocolTcpudpActionAllowConst = "allow" + NetworkACLRuleItemNetworkACLRuleProtocolTcpudpActionDenyConst = "deny" +) + +// Constants associated with the NetworkACLRuleItemNetworkACLRuleProtocolTcpudp.Direction property. +// The direction of traffic to match. +const ( + NetworkACLRuleItemNetworkACLRuleProtocolTcpudpDirectionInboundConst = "inbound" + NetworkACLRuleItemNetworkACLRuleProtocolTcpudpDirectionOutboundConst = "outbound" +) + +// Constants associated with the NetworkACLRuleItemNetworkACLRuleProtocolTcpudp.IPVersion property. +// The IP version for this rule. +const ( + NetworkACLRuleItemNetworkACLRuleProtocolTcpudpIPVersionIpv4Const = "ipv4" +) + +// Constants associated with the NetworkACLRuleItemNetworkACLRuleProtocolTcpudp.Protocol property. +// The protocol to enforce. +const ( + NetworkACLRuleItemNetworkACLRuleProtocolTcpudpProtocolTCPConst = "tcp" + NetworkACLRuleItemNetworkACLRuleProtocolTcpudpProtocolUDPConst = "udp" +) + +func (*NetworkACLRuleItemNetworkACLRuleProtocolTcpudp) isaNetworkACLRuleItem() bool { + return true +} + +// UnmarshalNetworkACLRuleItemNetworkACLRuleProtocolTcpudp unmarshals an instance of NetworkACLRuleItemNetworkACLRuleProtocolTcpudp from the specified map of raw messages. +func UnmarshalNetworkACLRuleItemNetworkACLRuleProtocolTcpudp(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLRuleItemNetworkACLRuleProtocolTcpudp) + err = core.UnmarshalPrimitive(m, "action", &obj.Action) + if err != nil { + return + } + err = core.UnmarshalModel(m, "before", &obj.Before, UnmarshalNetworkACLRuleReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "destination", &obj.Destination) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "direction", &obj.Direction) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "ip_version", &obj.IPVersion) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "source", &obj.Source) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "destination_port_max", &obj.DestinationPortMax) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "destination_port_min", &obj.DestinationPortMin) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "protocol", &obj.Protocol) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "source_port_max", &obj.SourcePortMax) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "source_port_min", &obj.SourcePortMin) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolAllPrototype : NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolAllPrototype struct +// This model "extends" NetworkACLRulePrototypeNetworkACLContext +type NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolAllPrototype struct { + // The action to perform for a packet matching the rule. + Action *string `json:"action" validate:"required"` + + // The destination IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all destination addresses. + Destination *string `json:"destination" validate:"required"` + + // The direction of traffic to match. + Direction *string `json:"direction" validate:"required"` + + // The IP version for this rule. + IPVersion *string `json:"ip_version,omitempty"` + + // The name for this network ACL rule. The name must not be used by another rule for the network ACL. If unspecified, + // the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The source IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all source addresses. + Source *string `json:"source" validate:"required"` + + // The protocol to enforce. + Protocol *string `json:"protocol" validate:"required"` +} + +// Constants associated with the NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolAllPrototype.Action property. +// The action to perform for a packet matching the rule. +const ( + NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolAllPrototypeActionAllowConst = "allow" + NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolAllPrototypeActionDenyConst = "deny" +) + +// Constants associated with the NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolAllPrototype.Direction property. +// The direction of traffic to match. +const ( + NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolAllPrototypeDirectionInboundConst = "inbound" + NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolAllPrototypeDirectionOutboundConst = "outbound" +) + +// Constants associated with the NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolAllPrototype.IPVersion property. +// The IP version for this rule. +const ( + NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolAllPrototypeIPVersionIpv4Const = "ipv4" +) + +// Constants associated with the NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolAllPrototype.Protocol property. +// The protocol to enforce. +const ( + NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolAllPrototypeProtocolAllConst = "all" +) + +// NewNetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolAllPrototype : Instantiate NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolAllPrototype (Generic Model Constructor) +func (*VpcV1) NewNetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolAllPrototype(action string, destination string, direction string, source string, protocol string) (_model *NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolAllPrototype, err error) { + _model = &NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolAllPrototype{ + Action: core.StringPtr(action), + Destination: core.StringPtr(destination), + Direction: core.StringPtr(direction), + Source: core.StringPtr(source), + Protocol: core.StringPtr(protocol), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolAllPrototype) isaNetworkACLRulePrototypeNetworkACLContext() bool { + return true +} + +// UnmarshalNetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolAllPrototype unmarshals an instance of NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolAllPrototype from the specified map of raw messages. +func UnmarshalNetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolAllPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolAllPrototype) + err = core.UnmarshalPrimitive(m, "action", &obj.Action) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "destination", &obj.Destination) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "direction", &obj.Direction) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "ip_version", &obj.IPVersion) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "source", &obj.Source) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "protocol", &obj.Protocol) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolIcmpPrototype : NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolIcmpPrototype struct +// This model "extends" NetworkACLRulePrototypeNetworkACLContext +type NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolIcmpPrototype struct { + // The action to perform for a packet matching the rule. + Action *string `json:"action" validate:"required"` + + // The destination IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all destination addresses. + Destination *string `json:"destination" validate:"required"` + + // The direction of traffic to match. + Direction *string `json:"direction" validate:"required"` + + // The IP version for this rule. + IPVersion *string `json:"ip_version,omitempty"` + + // The name for this network ACL rule. The name must not be used by another rule for the network ACL. If unspecified, + // the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The source IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all source addresses. + Source *string `json:"source" validate:"required"` + + // The ICMP traffic code to match. + // + // If specified, `type` must also be specified. If unspecified, all codes are matched. + Code *int64 `json:"code,omitempty"` + + // The protocol to enforce. + Protocol *string `json:"protocol" validate:"required"` + + // The ICMP traffic type to match. + // + // If unspecified, all types are matched. + Type *int64 `json:"type,omitempty"` +} + +// Constants associated with the NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolIcmpPrototype.Action property. +// The action to perform for a packet matching the rule. +const ( + NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolIcmpPrototypeActionAllowConst = "allow" + NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolIcmpPrototypeActionDenyConst = "deny" +) + +// Constants associated with the NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolIcmpPrototype.Direction property. +// The direction of traffic to match. +const ( + NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolIcmpPrototypeDirectionInboundConst = "inbound" + NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolIcmpPrototypeDirectionOutboundConst = "outbound" +) + +// Constants associated with the NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolIcmpPrototype.IPVersion property. +// The IP version for this rule. +const ( + NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolIcmpPrototypeIPVersionIpv4Const = "ipv4" +) + +// Constants associated with the NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolIcmpPrototype.Protocol property. +// The protocol to enforce. +const ( + NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolIcmpPrototypeProtocolIcmpConst = "icmp" +) + +// NewNetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolIcmpPrototype : Instantiate NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolIcmpPrototype (Generic Model Constructor) +func (*VpcV1) NewNetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolIcmpPrototype(action string, destination string, direction string, source string, protocol string) (_model *NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolIcmpPrototype, err error) { + _model = &NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolIcmpPrototype{ + Action: core.StringPtr(action), + Destination: core.StringPtr(destination), + Direction: core.StringPtr(direction), + Source: core.StringPtr(source), + Protocol: core.StringPtr(protocol), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolIcmpPrototype) isaNetworkACLRulePrototypeNetworkACLContext() bool { + return true +} + +// UnmarshalNetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolIcmpPrototype unmarshals an instance of NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolIcmpPrototype from the specified map of raw messages. +func UnmarshalNetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolIcmpPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolIcmpPrototype) + err = core.UnmarshalPrimitive(m, "action", &obj.Action) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "destination", &obj.Destination) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "direction", &obj.Direction) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "ip_version", &obj.IPVersion) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "source", &obj.Source) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "code", &obj.Code) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "protocol", &obj.Protocol) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolTcpudpPrototype : NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolTcpudpPrototype struct +// This model "extends" NetworkACLRulePrototypeNetworkACLContext +type NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolTcpudpPrototype struct { + // The action to perform for a packet matching the rule. + Action *string `json:"action" validate:"required"` + + // The destination IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all destination addresses. + Destination *string `json:"destination" validate:"required"` + + // The direction of traffic to match. + Direction *string `json:"direction" validate:"required"` + + // The IP version for this rule. + IPVersion *string `json:"ip_version,omitempty"` + + // The name for this network ACL rule. The name must not be used by another rule for the network ACL. If unspecified, + // the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The source IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all source addresses. + Source *string `json:"source" validate:"required"` + + // The inclusive upper bound of TCP/UDP destination port range. + DestinationPortMax *int64 `json:"destination_port_max,omitempty"` + + // The inclusive lower bound of TCP/UDP destination port range. + DestinationPortMin *int64 `json:"destination_port_min,omitempty"` + + // The protocol to enforce. + Protocol *string `json:"protocol" validate:"required"` + + // The inclusive upper bound of TCP/UDP source port range. + SourcePortMax *int64 `json:"source_port_max,omitempty"` + + // The inclusive lower bound of TCP/UDP source port range. + SourcePortMin *int64 `json:"source_port_min,omitempty"` +} + +// Constants associated with the NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolTcpudpPrototype.Action property. +// The action to perform for a packet matching the rule. +const ( + NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolTcpudpPrototypeActionAllowConst = "allow" + NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolTcpudpPrototypeActionDenyConst = "deny" +) + +// Constants associated with the NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolTcpudpPrototype.Direction property. +// The direction of traffic to match. +const ( + NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolTcpudpPrototypeDirectionInboundConst = "inbound" + NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolTcpudpPrototypeDirectionOutboundConst = "outbound" +) + +// Constants associated with the NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolTcpudpPrototype.IPVersion property. +// The IP version for this rule. +const ( + NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolTcpudpPrototypeIPVersionIpv4Const = "ipv4" +) + +// Constants associated with the NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolTcpudpPrototype.Protocol property. +// The protocol to enforce. +const ( + NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolTcpudpPrototypeProtocolTCPConst = "tcp" + NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolTcpudpPrototypeProtocolUDPConst = "udp" +) + +// NewNetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolTcpudpPrototype : Instantiate NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolTcpudpPrototype (Generic Model Constructor) +func (*VpcV1) NewNetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolTcpudpPrototype(action string, destination string, direction string, source string, protocol string) (_model *NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolTcpudpPrototype, err error) { + _model = &NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolTcpudpPrototype{ + Action: core.StringPtr(action), + Destination: core.StringPtr(destination), + Direction: core.StringPtr(direction), + Source: core.StringPtr(source), + Protocol: core.StringPtr(protocol), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolTcpudpPrototype) isaNetworkACLRulePrototypeNetworkACLContext() bool { + return true +} + +// UnmarshalNetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolTcpudpPrototype unmarshals an instance of NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolTcpudpPrototype from the specified map of raw messages. +func UnmarshalNetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolTcpudpPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLRulePrototypeNetworkACLContextNetworkACLRuleProtocolTcpudpPrototype) + err = core.UnmarshalPrimitive(m, "action", &obj.Action) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "destination", &obj.Destination) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "direction", &obj.Direction) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "ip_version", &obj.IPVersion) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "source", &obj.Source) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "destination_port_max", &obj.DestinationPortMax) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "destination_port_min", &obj.DestinationPortMin) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "protocol", &obj.Protocol) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "source_port_max", &obj.SourcePortMax) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "source_port_min", &obj.SourcePortMin) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLRulePrototypeNetworkACLRuleProtocolAllPrototype : NetworkACLRulePrototypeNetworkACLRuleProtocolAllPrototype struct +// This model "extends" NetworkACLRulePrototype +type NetworkACLRulePrototypeNetworkACLRuleProtocolAllPrototype struct { + // The action to perform for a packet matching the rule. + Action *string `json:"action" validate:"required"` + + Before NetworkACLRuleBeforePrototypeIntf `json:"before,omitempty"` + + // The destination IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all destination addresses. + Destination *string `json:"destination" validate:"required"` + + // The direction of traffic to match. + Direction *string `json:"direction" validate:"required"` + + // The IP version for this rule. + IPVersion *string `json:"ip_version,omitempty"` + + // The name for this network ACL rule. The name must not be used by another rule for the network ACL. If unspecified, + // the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The source IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all source addresses. + Source *string `json:"source" validate:"required"` + + // The protocol to enforce. + Protocol *string `json:"protocol" validate:"required"` +} + +// Constants associated with the NetworkACLRulePrototypeNetworkACLRuleProtocolAllPrototype.Action property. +// The action to perform for a packet matching the rule. +const ( + NetworkACLRulePrototypeNetworkACLRuleProtocolAllPrototypeActionAllowConst = "allow" + NetworkACLRulePrototypeNetworkACLRuleProtocolAllPrototypeActionDenyConst = "deny" +) + +// Constants associated with the NetworkACLRulePrototypeNetworkACLRuleProtocolAllPrototype.Direction property. +// The direction of traffic to match. +const ( + NetworkACLRulePrototypeNetworkACLRuleProtocolAllPrototypeDirectionInboundConst = "inbound" + NetworkACLRulePrototypeNetworkACLRuleProtocolAllPrototypeDirectionOutboundConst = "outbound" +) + +// Constants associated with the NetworkACLRulePrototypeNetworkACLRuleProtocolAllPrototype.IPVersion property. +// The IP version for this rule. +const ( + NetworkACLRulePrototypeNetworkACLRuleProtocolAllPrototypeIPVersionIpv4Const = "ipv4" +) + +// Constants associated with the NetworkACLRulePrototypeNetworkACLRuleProtocolAllPrototype.Protocol property. +// The protocol to enforce. +const ( + NetworkACLRulePrototypeNetworkACLRuleProtocolAllPrototypeProtocolAllConst = "all" +) + +// NewNetworkACLRulePrototypeNetworkACLRuleProtocolAllPrototype : Instantiate NetworkACLRulePrototypeNetworkACLRuleProtocolAllPrototype (Generic Model Constructor) +func (*VpcV1) NewNetworkACLRulePrototypeNetworkACLRuleProtocolAllPrototype(action string, destination string, direction string, source string, protocol string) (_model *NetworkACLRulePrototypeNetworkACLRuleProtocolAllPrototype, err error) { + _model = &NetworkACLRulePrototypeNetworkACLRuleProtocolAllPrototype{ + Action: core.StringPtr(action), + Destination: core.StringPtr(destination), + Direction: core.StringPtr(direction), + Source: core.StringPtr(source), + Protocol: core.StringPtr(protocol), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*NetworkACLRulePrototypeNetworkACLRuleProtocolAllPrototype) isaNetworkACLRulePrototype() bool { + return true +} + +// UnmarshalNetworkACLRulePrototypeNetworkACLRuleProtocolAllPrototype unmarshals an instance of NetworkACLRulePrototypeNetworkACLRuleProtocolAllPrototype from the specified map of raw messages. +func UnmarshalNetworkACLRulePrototypeNetworkACLRuleProtocolAllPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLRulePrototypeNetworkACLRuleProtocolAllPrototype) + err = core.UnmarshalPrimitive(m, "action", &obj.Action) + if err != nil { + return + } + err = core.UnmarshalModel(m, "before", &obj.Before, UnmarshalNetworkACLRuleBeforePrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "destination", &obj.Destination) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "direction", &obj.Direction) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "ip_version", &obj.IPVersion) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "source", &obj.Source) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "protocol", &obj.Protocol) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLRulePrototypeNetworkACLRuleProtocolIcmpPrototype : NetworkACLRulePrototypeNetworkACLRuleProtocolIcmpPrototype struct +// This model "extends" NetworkACLRulePrototype +type NetworkACLRulePrototypeNetworkACLRuleProtocolIcmpPrototype struct { + // The action to perform for a packet matching the rule. + Action *string `json:"action" validate:"required"` + + Before NetworkACLRuleBeforePrototypeIntf `json:"before,omitempty"` + + // The destination IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all destination addresses. + Destination *string `json:"destination" validate:"required"` + + // The direction of traffic to match. + Direction *string `json:"direction" validate:"required"` + + // The IP version for this rule. + IPVersion *string `json:"ip_version,omitempty"` + + // The name for this network ACL rule. The name must not be used by another rule for the network ACL. If unspecified, + // the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The source IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all source addresses. + Source *string `json:"source" validate:"required"` + + // The ICMP traffic code to match. + // + // If specified, `type` must also be specified. If unspecified, all codes are matched. + Code *int64 `json:"code,omitempty"` + + // The protocol to enforce. + Protocol *string `json:"protocol" validate:"required"` + + // The ICMP traffic type to match. + // + // If unspecified, all types are matched. + Type *int64 `json:"type,omitempty"` +} + +// Constants associated with the NetworkACLRulePrototypeNetworkACLRuleProtocolIcmpPrototype.Action property. +// The action to perform for a packet matching the rule. +const ( + NetworkACLRulePrototypeNetworkACLRuleProtocolIcmpPrototypeActionAllowConst = "allow" + NetworkACLRulePrototypeNetworkACLRuleProtocolIcmpPrototypeActionDenyConst = "deny" +) + +// Constants associated with the NetworkACLRulePrototypeNetworkACLRuleProtocolIcmpPrototype.Direction property. +// The direction of traffic to match. +const ( + NetworkACLRulePrototypeNetworkACLRuleProtocolIcmpPrototypeDirectionInboundConst = "inbound" + NetworkACLRulePrototypeNetworkACLRuleProtocolIcmpPrototypeDirectionOutboundConst = "outbound" +) + +// Constants associated with the NetworkACLRulePrototypeNetworkACLRuleProtocolIcmpPrototype.IPVersion property. +// The IP version for this rule. +const ( + NetworkACLRulePrototypeNetworkACLRuleProtocolIcmpPrototypeIPVersionIpv4Const = "ipv4" +) + +// Constants associated with the NetworkACLRulePrototypeNetworkACLRuleProtocolIcmpPrototype.Protocol property. +// The protocol to enforce. +const ( + NetworkACLRulePrototypeNetworkACLRuleProtocolIcmpPrototypeProtocolIcmpConst = "icmp" +) + +// NewNetworkACLRulePrototypeNetworkACLRuleProtocolIcmpPrototype : Instantiate NetworkACLRulePrototypeNetworkACLRuleProtocolIcmpPrototype (Generic Model Constructor) +func (*VpcV1) NewNetworkACLRulePrototypeNetworkACLRuleProtocolIcmpPrototype(action string, destination string, direction string, source string, protocol string) (_model *NetworkACLRulePrototypeNetworkACLRuleProtocolIcmpPrototype, err error) { + _model = &NetworkACLRulePrototypeNetworkACLRuleProtocolIcmpPrototype{ + Action: core.StringPtr(action), + Destination: core.StringPtr(destination), + Direction: core.StringPtr(direction), + Source: core.StringPtr(source), + Protocol: core.StringPtr(protocol), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*NetworkACLRulePrototypeNetworkACLRuleProtocolIcmpPrototype) isaNetworkACLRulePrototype() bool { + return true +} + +// UnmarshalNetworkACLRulePrototypeNetworkACLRuleProtocolIcmpPrototype unmarshals an instance of NetworkACLRulePrototypeNetworkACLRuleProtocolIcmpPrototype from the specified map of raw messages. +func UnmarshalNetworkACLRulePrototypeNetworkACLRuleProtocolIcmpPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLRulePrototypeNetworkACLRuleProtocolIcmpPrototype) + err = core.UnmarshalPrimitive(m, "action", &obj.Action) + if err != nil { + return + } + err = core.UnmarshalModel(m, "before", &obj.Before, UnmarshalNetworkACLRuleBeforePrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "destination", &obj.Destination) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "direction", &obj.Direction) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "ip_version", &obj.IPVersion) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "source", &obj.Source) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "code", &obj.Code) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "protocol", &obj.Protocol) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLRulePrototypeNetworkACLRuleProtocolTcpudpPrototype : NetworkACLRulePrototypeNetworkACLRuleProtocolTcpudpPrototype struct +// This model "extends" NetworkACLRulePrototype +type NetworkACLRulePrototypeNetworkACLRuleProtocolTcpudpPrototype struct { + // The action to perform for a packet matching the rule. + Action *string `json:"action" validate:"required"` + + Before NetworkACLRuleBeforePrototypeIntf `json:"before,omitempty"` + + // The destination IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all destination addresses. + Destination *string `json:"destination" validate:"required"` + + // The direction of traffic to match. + Direction *string `json:"direction" validate:"required"` + + // The IP version for this rule. + IPVersion *string `json:"ip_version,omitempty"` + + // The name for this network ACL rule. The name must not be used by another rule for the network ACL. If unspecified, + // the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The source IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all source addresses. + Source *string `json:"source" validate:"required"` + + // The inclusive upper bound of TCP/UDP destination port range. + DestinationPortMax *int64 `json:"destination_port_max,omitempty"` + + // The inclusive lower bound of TCP/UDP destination port range. + DestinationPortMin *int64 `json:"destination_port_min,omitempty"` + + // The protocol to enforce. + Protocol *string `json:"protocol" validate:"required"` + + // The inclusive upper bound of TCP/UDP source port range. + SourcePortMax *int64 `json:"source_port_max,omitempty"` + + // The inclusive lower bound of TCP/UDP source port range. + SourcePortMin *int64 `json:"source_port_min,omitempty"` +} + +// Constants associated with the NetworkACLRulePrototypeNetworkACLRuleProtocolTcpudpPrototype.Action property. +// The action to perform for a packet matching the rule. +const ( + NetworkACLRulePrototypeNetworkACLRuleProtocolTcpudpPrototypeActionAllowConst = "allow" + NetworkACLRulePrototypeNetworkACLRuleProtocolTcpudpPrototypeActionDenyConst = "deny" +) + +// Constants associated with the NetworkACLRulePrototypeNetworkACLRuleProtocolTcpudpPrototype.Direction property. +// The direction of traffic to match. +const ( + NetworkACLRulePrototypeNetworkACLRuleProtocolTcpudpPrototypeDirectionInboundConst = "inbound" + NetworkACLRulePrototypeNetworkACLRuleProtocolTcpudpPrototypeDirectionOutboundConst = "outbound" +) + +// Constants associated with the NetworkACLRulePrototypeNetworkACLRuleProtocolTcpudpPrototype.IPVersion property. +// The IP version for this rule. +const ( + NetworkACLRulePrototypeNetworkACLRuleProtocolTcpudpPrototypeIPVersionIpv4Const = "ipv4" +) + +// Constants associated with the NetworkACLRulePrototypeNetworkACLRuleProtocolTcpudpPrototype.Protocol property. +// The protocol to enforce. +const ( + NetworkACLRulePrototypeNetworkACLRuleProtocolTcpudpPrototypeProtocolTCPConst = "tcp" + NetworkACLRulePrototypeNetworkACLRuleProtocolTcpudpPrototypeProtocolUDPConst = "udp" +) + +// NewNetworkACLRulePrototypeNetworkACLRuleProtocolTcpudpPrototype : Instantiate NetworkACLRulePrototypeNetworkACLRuleProtocolTcpudpPrototype (Generic Model Constructor) +func (*VpcV1) NewNetworkACLRulePrototypeNetworkACLRuleProtocolTcpudpPrototype(action string, destination string, direction string, source string, protocol string) (_model *NetworkACLRulePrototypeNetworkACLRuleProtocolTcpudpPrototype, err error) { + _model = &NetworkACLRulePrototypeNetworkACLRuleProtocolTcpudpPrototype{ + Action: core.StringPtr(action), + Destination: core.StringPtr(destination), + Direction: core.StringPtr(direction), + Source: core.StringPtr(source), + Protocol: core.StringPtr(protocol), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*NetworkACLRulePrototypeNetworkACLRuleProtocolTcpudpPrototype) isaNetworkACLRulePrototype() bool { + return true +} + +// UnmarshalNetworkACLRulePrototypeNetworkACLRuleProtocolTcpudpPrototype unmarshals an instance of NetworkACLRulePrototypeNetworkACLRuleProtocolTcpudpPrototype from the specified map of raw messages. +func UnmarshalNetworkACLRulePrototypeNetworkACLRuleProtocolTcpudpPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLRulePrototypeNetworkACLRuleProtocolTcpudpPrototype) + err = core.UnmarshalPrimitive(m, "action", &obj.Action) + if err != nil { + return + } + err = core.UnmarshalModel(m, "before", &obj.Before, UnmarshalNetworkACLRuleBeforePrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "destination", &obj.Destination) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "direction", &obj.Direction) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "ip_version", &obj.IPVersion) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "source", &obj.Source) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "destination_port_max", &obj.DestinationPortMax) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "destination_port_min", &obj.DestinationPortMin) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "protocol", &obj.Protocol) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "source_port_max", &obj.SourcePortMax) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "source_port_min", &obj.SourcePortMin) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLRuleNetworkACLRuleProtocolAll : NetworkACLRuleNetworkACLRuleProtocolAll struct +// This model "extends" NetworkACLRule +type NetworkACLRuleNetworkACLRuleProtocolAll struct { + // The action to perform for a packet matching the rule. + Action *string `json:"action" validate:"required"` + + // The rule that this rule is immediately before. If absent, this is the last rule. + Before *NetworkACLRuleReference `json:"before,omitempty"` + + // The date and time that the rule was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The destination IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all destination addresses. + Destination *string `json:"destination" validate:"required"` + + // The direction of traffic to match. + Direction *string `json:"direction" validate:"required"` + + // The URL for this network ACL rule. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this network ACL rule. + ID *string `json:"id" validate:"required"` + + // The IP version for this rule. + IPVersion *string `json:"ip_version" validate:"required"` + + // The name for this network ACL rule. The name is unique across all rules for the network ACL. + Name *string `json:"name" validate:"required"` + + // The source IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all source addresses. + Source *string `json:"source" validate:"required"` + + // The protocol to enforce. + Protocol *string `json:"protocol" validate:"required"` +} + +// Constants associated with the NetworkACLRuleNetworkACLRuleProtocolAll.Action property. +// The action to perform for a packet matching the rule. +const ( + NetworkACLRuleNetworkACLRuleProtocolAllActionAllowConst = "allow" + NetworkACLRuleNetworkACLRuleProtocolAllActionDenyConst = "deny" +) + +// Constants associated with the NetworkACLRuleNetworkACLRuleProtocolAll.Direction property. +// The direction of traffic to match. +const ( + NetworkACLRuleNetworkACLRuleProtocolAllDirectionInboundConst = "inbound" + NetworkACLRuleNetworkACLRuleProtocolAllDirectionOutboundConst = "outbound" +) + +// Constants associated with the NetworkACLRuleNetworkACLRuleProtocolAll.IPVersion property. +// The IP version for this rule. +const ( + NetworkACLRuleNetworkACLRuleProtocolAllIPVersionIpv4Const = "ipv4" +) + +// Constants associated with the NetworkACLRuleNetworkACLRuleProtocolAll.Protocol property. +// The protocol to enforce. +const ( + NetworkACLRuleNetworkACLRuleProtocolAllProtocolAllConst = "all" +) + +func (*NetworkACLRuleNetworkACLRuleProtocolAll) isaNetworkACLRule() bool { + return true +} + +// UnmarshalNetworkACLRuleNetworkACLRuleProtocolAll unmarshals an instance of NetworkACLRuleNetworkACLRuleProtocolAll from the specified map of raw messages. +func UnmarshalNetworkACLRuleNetworkACLRuleProtocolAll(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLRuleNetworkACLRuleProtocolAll) + err = core.UnmarshalPrimitive(m, "action", &obj.Action) + if err != nil { + return + } + err = core.UnmarshalModel(m, "before", &obj.Before, UnmarshalNetworkACLRuleReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "destination", &obj.Destination) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "direction", &obj.Direction) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "ip_version", &obj.IPVersion) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "source", &obj.Source) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "protocol", &obj.Protocol) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLRuleNetworkACLRuleProtocolIcmp : NetworkACLRuleNetworkACLRuleProtocolIcmp struct +// This model "extends" NetworkACLRule +type NetworkACLRuleNetworkACLRuleProtocolIcmp struct { + // The action to perform for a packet matching the rule. + Action *string `json:"action" validate:"required"` + + // The rule that this rule is immediately before. If absent, this is the last rule. + Before *NetworkACLRuleReference `json:"before,omitempty"` + + // The date and time that the rule was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The destination IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all destination addresses. + Destination *string `json:"destination" validate:"required"` + + // The direction of traffic to match. + Direction *string `json:"direction" validate:"required"` + + // The URL for this network ACL rule. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this network ACL rule. + ID *string `json:"id" validate:"required"` + + // The IP version for this rule. + IPVersion *string `json:"ip_version" validate:"required"` + + // The name for this network ACL rule. The name is unique across all rules for the network ACL. + Name *string `json:"name" validate:"required"` + + // The source IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all source addresses. + Source *string `json:"source" validate:"required"` + + // The ICMP traffic code to match. + // + // If absent, all codes are matched. + Code *int64 `json:"code,omitempty"` + + // The protocol to enforce. + Protocol *string `json:"protocol" validate:"required"` + + // The ICMP traffic type to match. + // + // If absent, all types are matched. + Type *int64 `json:"type,omitempty"` +} + +// Constants associated with the NetworkACLRuleNetworkACLRuleProtocolIcmp.Action property. +// The action to perform for a packet matching the rule. +const ( + NetworkACLRuleNetworkACLRuleProtocolIcmpActionAllowConst = "allow" + NetworkACLRuleNetworkACLRuleProtocolIcmpActionDenyConst = "deny" +) + +// Constants associated with the NetworkACLRuleNetworkACLRuleProtocolIcmp.Direction property. +// The direction of traffic to match. +const ( + NetworkACLRuleNetworkACLRuleProtocolIcmpDirectionInboundConst = "inbound" + NetworkACLRuleNetworkACLRuleProtocolIcmpDirectionOutboundConst = "outbound" +) + +// Constants associated with the NetworkACLRuleNetworkACLRuleProtocolIcmp.IPVersion property. +// The IP version for this rule. +const ( + NetworkACLRuleNetworkACLRuleProtocolIcmpIPVersionIpv4Const = "ipv4" +) + +// Constants associated with the NetworkACLRuleNetworkACLRuleProtocolIcmp.Protocol property. +// The protocol to enforce. +const ( + NetworkACLRuleNetworkACLRuleProtocolIcmpProtocolIcmpConst = "icmp" +) + +func (*NetworkACLRuleNetworkACLRuleProtocolIcmp) isaNetworkACLRule() bool { + return true +} + +// UnmarshalNetworkACLRuleNetworkACLRuleProtocolIcmp unmarshals an instance of NetworkACLRuleNetworkACLRuleProtocolIcmp from the specified map of raw messages. +func UnmarshalNetworkACLRuleNetworkACLRuleProtocolIcmp(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLRuleNetworkACLRuleProtocolIcmp) + err = core.UnmarshalPrimitive(m, "action", &obj.Action) + if err != nil { + return + } + err = core.UnmarshalModel(m, "before", &obj.Before, UnmarshalNetworkACLRuleReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "destination", &obj.Destination) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "direction", &obj.Direction) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "ip_version", &obj.IPVersion) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "source", &obj.Source) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "code", &obj.Code) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "protocol", &obj.Protocol) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkACLRuleNetworkACLRuleProtocolTcpudp : NetworkACLRuleNetworkACLRuleProtocolTcpudp struct +// This model "extends" NetworkACLRule +type NetworkACLRuleNetworkACLRuleProtocolTcpudp struct { + // The action to perform for a packet matching the rule. + Action *string `json:"action" validate:"required"` + + // The rule that this rule is immediately before. If absent, this is the last rule. + Before *NetworkACLRuleReference `json:"before,omitempty"` + + // The date and time that the rule was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The destination IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all destination addresses. + Destination *string `json:"destination" validate:"required"` + + // The direction of traffic to match. + Direction *string `json:"direction" validate:"required"` + + // The URL for this network ACL rule. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this network ACL rule. + ID *string `json:"id" validate:"required"` + + // The IP version for this rule. + IPVersion *string `json:"ip_version" validate:"required"` + + // The name for this network ACL rule. The name is unique across all rules for the network ACL. + Name *string `json:"name" validate:"required"` + + // The source IP address or CIDR block to match. The CIDR block `0.0.0.0/0` matches all source addresses. + Source *string `json:"source" validate:"required"` + + // The inclusive upper bound of TCP/UDP destination port range. + DestinationPortMax *int64 `json:"destination_port_max" validate:"required"` + + // The inclusive lower bound of TCP/UDP destination port range. + DestinationPortMin *int64 `json:"destination_port_min" validate:"required"` + + // The protocol to enforce. + Protocol *string `json:"protocol" validate:"required"` + + // The inclusive upper bound of TCP/UDP source port range. + SourcePortMax *int64 `json:"source_port_max" validate:"required"` + + // The inclusive lower bound of TCP/UDP source port range. + SourcePortMin *int64 `json:"source_port_min" validate:"required"` +} + +// Constants associated with the NetworkACLRuleNetworkACLRuleProtocolTcpudp.Action property. +// The action to perform for a packet matching the rule. +const ( + NetworkACLRuleNetworkACLRuleProtocolTcpudpActionAllowConst = "allow" + NetworkACLRuleNetworkACLRuleProtocolTcpudpActionDenyConst = "deny" +) + +// Constants associated with the NetworkACLRuleNetworkACLRuleProtocolTcpudp.Direction property. +// The direction of traffic to match. +const ( + NetworkACLRuleNetworkACLRuleProtocolTcpudpDirectionInboundConst = "inbound" + NetworkACLRuleNetworkACLRuleProtocolTcpudpDirectionOutboundConst = "outbound" +) + +// Constants associated with the NetworkACLRuleNetworkACLRuleProtocolTcpudp.IPVersion property. +// The IP version for this rule. +const ( + NetworkACLRuleNetworkACLRuleProtocolTcpudpIPVersionIpv4Const = "ipv4" +) + +// Constants associated with the NetworkACLRuleNetworkACLRuleProtocolTcpudp.Protocol property. +// The protocol to enforce. +const ( + NetworkACLRuleNetworkACLRuleProtocolTcpudpProtocolTCPConst = "tcp" + NetworkACLRuleNetworkACLRuleProtocolTcpudpProtocolUDPConst = "udp" +) + +func (*NetworkACLRuleNetworkACLRuleProtocolTcpudp) isaNetworkACLRule() bool { + return true +} + +// UnmarshalNetworkACLRuleNetworkACLRuleProtocolTcpudp unmarshals an instance of NetworkACLRuleNetworkACLRuleProtocolTcpudp from the specified map of raw messages. +func UnmarshalNetworkACLRuleNetworkACLRuleProtocolTcpudp(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkACLRuleNetworkACLRuleProtocolTcpudp) + err = core.UnmarshalPrimitive(m, "action", &obj.Action) + if err != nil { + return + } + err = core.UnmarshalModel(m, "before", &obj.Before, UnmarshalNetworkACLRuleReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "destination", &obj.Destination) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "direction", &obj.Direction) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "ip_version", &obj.IPVersion) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "source", &obj.Source) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "destination_port_max", &obj.DestinationPortMax) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "destination_port_min", &obj.DestinationPortMin) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "protocol", &obj.Protocol) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "source_port_max", &obj.SourcePortMax) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "source_port_min", &obj.SourcePortMin) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkInterfaceIPPrototypeReservedIPIdentity : Identifies a reserved IP by a unique property. +// Models which "extend" this model: +// - NetworkInterfaceIPPrototypeReservedIPIdentityByID +// - NetworkInterfaceIPPrototypeReservedIPIdentityByHref +// This model "extends" NetworkInterfaceIPPrototype +type NetworkInterfaceIPPrototypeReservedIPIdentity struct { + // The unique identifier for this reserved IP. + ID *string `json:"id,omitempty"` + + // The URL for this reserved IP. + Href *string `json:"href,omitempty"` +} + +func (*NetworkInterfaceIPPrototypeReservedIPIdentity) isaNetworkInterfaceIPPrototypeReservedIPIdentity() bool { + return true +} + +type NetworkInterfaceIPPrototypeReservedIPIdentityIntf interface { + NetworkInterfaceIPPrototypeIntf + isaNetworkInterfaceIPPrototypeReservedIPIdentity() bool +} + +func (*NetworkInterfaceIPPrototypeReservedIPIdentity) isaNetworkInterfaceIPPrototype() bool { + return true +} + +// UnmarshalNetworkInterfaceIPPrototypeReservedIPIdentity unmarshals an instance of NetworkInterfaceIPPrototypeReservedIPIdentity from the specified map of raw messages. +func UnmarshalNetworkInterfaceIPPrototypeReservedIPIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkInterfaceIPPrototypeReservedIPIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkInterfaceIPPrototypeReservedIPPrototypeNetworkInterfaceContext : NetworkInterfaceIPPrototypeReservedIPPrototypeNetworkInterfaceContext struct +// This model "extends" NetworkInterfaceIPPrototype +type NetworkInterfaceIPPrototypeReservedIPPrototypeNetworkInterfaceContext struct { + // The IP address to reserve, which must not already be reserved on the subnet. + // + // If unspecified, an available address on the subnet will automatically be selected. + Address *string `json:"address,omitempty"` + + // Indicates whether this reserved IP member will be automatically deleted when either + // `target` is deleted, or the reserved IP is unbound. + AutoDelete *bool `json:"auto_delete,omitempty"` + + // The name for this reserved IP. The name must not be used by another reserved IP in the subnet. Names starting with + // `ibm-` are reserved for provider-owned resources, and are not allowed. If unspecified, the name will be a hyphenated + // list of randomly-selected words. + Name *string `json:"name,omitempty"` +} + +func (*NetworkInterfaceIPPrototypeReservedIPPrototypeNetworkInterfaceContext) isaNetworkInterfaceIPPrototype() bool { + return true +} + +// UnmarshalNetworkInterfaceIPPrototypeReservedIPPrototypeNetworkInterfaceContext unmarshals an instance of NetworkInterfaceIPPrototypeReservedIPPrototypeNetworkInterfaceContext from the specified map of raw messages. +func UnmarshalNetworkInterfaceIPPrototypeReservedIPPrototypeNetworkInterfaceContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkInterfaceIPPrototypeReservedIPPrototypeNetworkInterfaceContext) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "auto_delete", &obj.AutoDelete) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// OperatingSystemIdentityByHref : OperatingSystemIdentityByHref struct +// This model "extends" OperatingSystemIdentity +type OperatingSystemIdentityByHref struct { + // The URL for this operating system. + Href *string `json:"href" validate:"required"` +} + +// NewOperatingSystemIdentityByHref : Instantiate OperatingSystemIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewOperatingSystemIdentityByHref(href string) (_model *OperatingSystemIdentityByHref, err error) { + _model = &OperatingSystemIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*OperatingSystemIdentityByHref) isaOperatingSystemIdentity() bool { + return true +} + +// UnmarshalOperatingSystemIdentityByHref unmarshals an instance of OperatingSystemIdentityByHref from the specified map of raw messages. +func UnmarshalOperatingSystemIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(OperatingSystemIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// OperatingSystemIdentityByName : OperatingSystemIdentityByName struct +// This model "extends" OperatingSystemIdentity +type OperatingSystemIdentityByName struct { + // The globally unique name for this operating system. + Name *string `json:"name" validate:"required"` +} + +// NewOperatingSystemIdentityByName : Instantiate OperatingSystemIdentityByName (Generic Model Constructor) +func (*VpcV1) NewOperatingSystemIdentityByName(name string) (_model *OperatingSystemIdentityByName, err error) { + _model = &OperatingSystemIdentityByName{ + Name: core.StringPtr(name), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*OperatingSystemIdentityByName) isaOperatingSystemIdentity() bool { + return true +} + +// UnmarshalOperatingSystemIdentityByName unmarshals an instance of OperatingSystemIdentityByName from the specified map of raw messages. +func UnmarshalOperatingSystemIdentityByName(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(OperatingSystemIdentityByName) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// PublicGatewayFloatingIPPrototypeFloatingIPIdentity : Identifies a floating IP by a unique property. +// Models which "extend" this model: +// - PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByID +// - PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByCRN +// - PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByHref +// - PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByAddress +// This model "extends" PublicGatewayFloatingIPPrototype +type PublicGatewayFloatingIPPrototypeFloatingIPIdentity struct { + // The unique identifier for this floating IP. + ID *string `json:"id,omitempty"` + + // The CRN for this floating IP. + CRN *string `json:"crn,omitempty"` + + // The URL for this floating IP. + Href *string `json:"href,omitempty"` + + // The globally unique IP address. + Address *string `json:"address,omitempty"` +} + +func (*PublicGatewayFloatingIPPrototypeFloatingIPIdentity) isaPublicGatewayFloatingIPPrototypeFloatingIPIdentity() bool { + return true +} + +type PublicGatewayFloatingIPPrototypeFloatingIPIdentityIntf interface { + PublicGatewayFloatingIPPrototypeIntf + isaPublicGatewayFloatingIPPrototypeFloatingIPIdentity() bool +} + +func (*PublicGatewayFloatingIPPrototypeFloatingIPIdentity) isaPublicGatewayFloatingIPPrototype() bool { + return true +} + +// UnmarshalPublicGatewayFloatingIPPrototypeFloatingIPIdentity unmarshals an instance of PublicGatewayFloatingIPPrototypeFloatingIPIdentity from the specified map of raw messages. +func UnmarshalPublicGatewayFloatingIPPrototypeFloatingIPIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(PublicGatewayFloatingIPPrototypeFloatingIPIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// PublicGatewayFloatingIPPrototypeFloatingIPPrototypeTargetContext : PublicGatewayFloatingIPPrototypeFloatingIPPrototypeTargetContext struct +// This model "extends" PublicGatewayFloatingIPPrototype +type PublicGatewayFloatingIPPrototypeFloatingIPPrototypeTargetContext struct { + // The name for this floating IP. The name must not be used by another floating IP in the region. If unspecified, the + // name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` +} + +func (*PublicGatewayFloatingIPPrototypeFloatingIPPrototypeTargetContext) isaPublicGatewayFloatingIPPrototype() bool { + return true +} + +// UnmarshalPublicGatewayFloatingIPPrototypeFloatingIPPrototypeTargetContext unmarshals an instance of PublicGatewayFloatingIPPrototypeFloatingIPPrototypeTargetContext from the specified map of raw messages. +func UnmarshalPublicGatewayFloatingIPPrototypeFloatingIPPrototypeTargetContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(PublicGatewayFloatingIPPrototypeFloatingIPPrototypeTargetContext) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// PublicGatewayIdentityPublicGatewayIdentityByCRN : PublicGatewayIdentityPublicGatewayIdentityByCRN struct +// This model "extends" PublicGatewayIdentity +type PublicGatewayIdentityPublicGatewayIdentityByCRN struct { + // The CRN for this public gateway. + CRN *string `json:"crn" validate:"required"` +} + +// NewPublicGatewayIdentityPublicGatewayIdentityByCRN : Instantiate PublicGatewayIdentityPublicGatewayIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewPublicGatewayIdentityPublicGatewayIdentityByCRN(crn string) (_model *PublicGatewayIdentityPublicGatewayIdentityByCRN, err error) { + _model = &PublicGatewayIdentityPublicGatewayIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*PublicGatewayIdentityPublicGatewayIdentityByCRN) isaPublicGatewayIdentity() bool { + return true +} + +// UnmarshalPublicGatewayIdentityPublicGatewayIdentityByCRN unmarshals an instance of PublicGatewayIdentityPublicGatewayIdentityByCRN from the specified map of raw messages. +func UnmarshalPublicGatewayIdentityPublicGatewayIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(PublicGatewayIdentityPublicGatewayIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// PublicGatewayIdentityPublicGatewayIdentityByHref : PublicGatewayIdentityPublicGatewayIdentityByHref struct +// This model "extends" PublicGatewayIdentity +type PublicGatewayIdentityPublicGatewayIdentityByHref struct { + // The URL for this public gateway. + Href *string `json:"href" validate:"required"` +} + +// NewPublicGatewayIdentityPublicGatewayIdentityByHref : Instantiate PublicGatewayIdentityPublicGatewayIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewPublicGatewayIdentityPublicGatewayIdentityByHref(href string) (_model *PublicGatewayIdentityPublicGatewayIdentityByHref, err error) { + _model = &PublicGatewayIdentityPublicGatewayIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*PublicGatewayIdentityPublicGatewayIdentityByHref) isaPublicGatewayIdentity() bool { + return true +} + +// UnmarshalPublicGatewayIdentityPublicGatewayIdentityByHref unmarshals an instance of PublicGatewayIdentityPublicGatewayIdentityByHref from the specified map of raw messages. +func UnmarshalPublicGatewayIdentityPublicGatewayIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(PublicGatewayIdentityPublicGatewayIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// PublicGatewayIdentityPublicGatewayIdentityByID : PublicGatewayIdentityPublicGatewayIdentityByID struct +// This model "extends" PublicGatewayIdentity +type PublicGatewayIdentityPublicGatewayIdentityByID struct { + // The unique identifier for this public gateway. + ID *string `json:"id" validate:"required"` +} + +// NewPublicGatewayIdentityPublicGatewayIdentityByID : Instantiate PublicGatewayIdentityPublicGatewayIdentityByID (Generic Model Constructor) +func (*VpcV1) NewPublicGatewayIdentityPublicGatewayIdentityByID(id string) (_model *PublicGatewayIdentityPublicGatewayIdentityByID, err error) { + _model = &PublicGatewayIdentityPublicGatewayIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*PublicGatewayIdentityPublicGatewayIdentityByID) isaPublicGatewayIdentity() bool { + return true +} + +// UnmarshalPublicGatewayIdentityPublicGatewayIdentityByID unmarshals an instance of PublicGatewayIdentityPublicGatewayIdentityByID from the specified map of raw messages. +func UnmarshalPublicGatewayIdentityPublicGatewayIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(PublicGatewayIdentityPublicGatewayIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RegionIdentityByHref : RegionIdentityByHref struct +// This model "extends" RegionIdentity +type RegionIdentityByHref struct { + // The URL for this region. + Href *string `json:"href" validate:"required"` +} + +// NewRegionIdentityByHref : Instantiate RegionIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewRegionIdentityByHref(href string) (_model *RegionIdentityByHref, err error) { + _model = &RegionIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*RegionIdentityByHref) isaRegionIdentity() bool { + return true +} + +// UnmarshalRegionIdentityByHref unmarshals an instance of RegionIdentityByHref from the specified map of raw messages. +func UnmarshalRegionIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RegionIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RegionIdentityByName : RegionIdentityByName struct +// This model "extends" RegionIdentity +type RegionIdentityByName struct { + // The globally unique name for this region. + Name *string `json:"name" validate:"required"` +} + +// NewRegionIdentityByName : Instantiate RegionIdentityByName (Generic Model Constructor) +func (*VpcV1) NewRegionIdentityByName(name string) (_model *RegionIdentityByName, err error) { + _model = &RegionIdentityByName{ + Name: core.StringPtr(name), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*RegionIdentityByName) isaRegionIdentity() bool { + return true +} + +// UnmarshalRegionIdentityByName unmarshals an instance of RegionIdentityByName from the specified map of raw messages. +func UnmarshalRegionIdentityByName(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RegionIdentityByName) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ReservedIPTargetPrototypeEndpointGatewayIdentity : ReservedIPTargetPrototypeEndpointGatewayIdentity struct +// Models which "extend" this model: +// - ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByID +// - ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByCRN +// - ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByHref +// This model "extends" ReservedIPTargetPrototype +type ReservedIPTargetPrototypeEndpointGatewayIdentity struct { + // The unique identifier for this endpoint gateway. + ID *string `json:"id,omitempty"` + + // The CRN for this endpoint gateway. + CRN *string `json:"crn,omitempty"` + + // The URL for this endpoint gateway. + Href *string `json:"href,omitempty"` +} + +func (*ReservedIPTargetPrototypeEndpointGatewayIdentity) isaReservedIPTargetPrototypeEndpointGatewayIdentity() bool { + return true +} + +type ReservedIPTargetPrototypeEndpointGatewayIdentityIntf interface { + ReservedIPTargetPrototypeIntf + isaReservedIPTargetPrototypeEndpointGatewayIdentity() bool +} + +func (*ReservedIPTargetPrototypeEndpointGatewayIdentity) isaReservedIPTargetPrototype() bool { + return true +} + +// UnmarshalReservedIPTargetPrototypeEndpointGatewayIdentity unmarshals an instance of ReservedIPTargetPrototypeEndpointGatewayIdentity from the specified map of raw messages. +func UnmarshalReservedIPTargetPrototypeEndpointGatewayIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ReservedIPTargetPrototypeEndpointGatewayIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ReservedIPTargetBareMetalServerNetworkInterfaceReferenceTargetContext : ReservedIPTargetBareMetalServerNetworkInterfaceReferenceTargetContext struct +// This model "extends" ReservedIPTarget +type ReservedIPTargetBareMetalServerNetworkInterfaceReferenceTargetContext struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *BareMetalServerNetworkInterfaceReferenceTargetContextDeleted `json:"deleted,omitempty"` + + // The URL for this bare metal server network interface. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this bare metal server network interface. + ID *string `json:"id" validate:"required"` + + // The name for this bare metal server network interface. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the ReservedIPTargetBareMetalServerNetworkInterfaceReferenceTargetContext.ResourceType property. +// The resource type. +const ( + ReservedIPTargetBareMetalServerNetworkInterfaceReferenceTargetContextResourceTypeNetworkInterfaceConst = "network_interface" +) + +func (*ReservedIPTargetBareMetalServerNetworkInterfaceReferenceTargetContext) isaReservedIPTarget() bool { + return true +} + +// UnmarshalReservedIPTargetBareMetalServerNetworkInterfaceReferenceTargetContext unmarshals an instance of ReservedIPTargetBareMetalServerNetworkInterfaceReferenceTargetContext from the specified map of raw messages. +func UnmarshalReservedIPTargetBareMetalServerNetworkInterfaceReferenceTargetContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ReservedIPTargetBareMetalServerNetworkInterfaceReferenceTargetContext) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalBareMetalServerNetworkInterfaceReferenceTargetContextDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ReservedIPTargetEndpointGatewayReference : ReservedIPTargetEndpointGatewayReference struct +// This model "extends" ReservedIPTarget +type ReservedIPTargetEndpointGatewayReference struct { + // The CRN for this endpoint gateway. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *EndpointGatewayReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this endpoint gateway. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this endpoint gateway. + ID *string `json:"id" validate:"required"` + + // The name for this endpoint gateway. The name is unique across all endpoint gateways in the VPC. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the ReservedIPTargetEndpointGatewayReference.ResourceType property. +// The resource type. +const ( + ReservedIPTargetEndpointGatewayReferenceResourceTypeEndpointGatewayConst = "endpoint_gateway" +) + +func (*ReservedIPTargetEndpointGatewayReference) isaReservedIPTarget() bool { + return true +} + +// UnmarshalReservedIPTargetEndpointGatewayReference unmarshals an instance of ReservedIPTargetEndpointGatewayReference from the specified map of raw messages. +func UnmarshalReservedIPTargetEndpointGatewayReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ReservedIPTargetEndpointGatewayReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalEndpointGatewayReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ReservedIPTargetGenericResourceReference : Identifying information for a resource that is not native to the VPC API. +// This model "extends" ReservedIPTarget +type ReservedIPTargetGenericResourceReference struct { + // The CRN for the resource. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *GenericResourceReferenceDeleted `json:"deleted,omitempty"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the ReservedIPTargetGenericResourceReference.ResourceType property. +// The resource type. +const ( + ReservedIPTargetGenericResourceReferenceResourceTypeCloudResourceConst = "cloud_resource" +) + +func (*ReservedIPTargetGenericResourceReference) isaReservedIPTarget() bool { + return true +} + +// UnmarshalReservedIPTargetGenericResourceReference unmarshals an instance of ReservedIPTargetGenericResourceReference from the specified map of raw messages. +func UnmarshalReservedIPTargetGenericResourceReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ReservedIPTargetGenericResourceReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalGenericResourceReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ReservedIPTargetLoadBalancerReference : ReservedIPTargetLoadBalancerReference struct +// This model "extends" ReservedIPTarget +type ReservedIPTargetLoadBalancerReference struct { + // The load balancer's CRN. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *LoadBalancerReferenceDeleted `json:"deleted,omitempty"` + + // The load balancer's canonical URL. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this load balancer. + ID *string `json:"id" validate:"required"` + + // The name for this load balancer. The name is unique across all load balancers in the VPC. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the ReservedIPTargetLoadBalancerReference.ResourceType property. +// The resource type. +const ( + ReservedIPTargetLoadBalancerReferenceResourceTypeLoadBalancerConst = "load_balancer" +) + +func (*ReservedIPTargetLoadBalancerReference) isaReservedIPTarget() bool { + return true +} + +// UnmarshalReservedIPTargetLoadBalancerReference unmarshals an instance of ReservedIPTargetLoadBalancerReference from the specified map of raw messages. +func UnmarshalReservedIPTargetLoadBalancerReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ReservedIPTargetLoadBalancerReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalLoadBalancerReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ReservedIPTargetNetworkInterfaceReferenceTargetContext : ReservedIPTargetNetworkInterfaceReferenceTargetContext struct +// This model "extends" ReservedIPTarget +type ReservedIPTargetNetworkInterfaceReferenceTargetContext struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *NetworkInterfaceReferenceTargetContextDeleted `json:"deleted,omitempty"` + + // The URL for this instance network interface. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this instance network interface. + ID *string `json:"id" validate:"required"` + + // The name for this instance network interface. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the ReservedIPTargetNetworkInterfaceReferenceTargetContext.ResourceType property. +// The resource type. +const ( + ReservedIPTargetNetworkInterfaceReferenceTargetContextResourceTypeNetworkInterfaceConst = "network_interface" +) + +func (*ReservedIPTargetNetworkInterfaceReferenceTargetContext) isaReservedIPTarget() bool { + return true +} + +// UnmarshalReservedIPTargetNetworkInterfaceReferenceTargetContext unmarshals an instance of ReservedIPTargetNetworkInterfaceReferenceTargetContext from the specified map of raw messages. +func UnmarshalReservedIPTargetNetworkInterfaceReferenceTargetContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ReservedIPTargetNetworkInterfaceReferenceTargetContext) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalNetworkInterfaceReferenceTargetContextDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ReservedIPTargetVPNGatewayReference : ReservedIPTargetVPNGatewayReference struct +// This model "extends" ReservedIPTarget +type ReservedIPTargetVPNGatewayReference struct { + // The VPN gateway's CRN. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *VPNGatewayReferenceDeleted `json:"deleted,omitempty"` + + // The VPN gateway's canonical URL. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this VPN gateway. + ID *string `json:"id" validate:"required"` + + // The name for this VPN gateway. The name is unique across all VPN gateways in the VPC. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the ReservedIPTargetVPNGatewayReference.ResourceType property. +// The resource type. +const ( + ReservedIPTargetVPNGatewayReferenceResourceTypeVPNGatewayConst = "vpn_gateway" +) + +func (*ReservedIPTargetVPNGatewayReference) isaReservedIPTarget() bool { + return true +} + +// UnmarshalReservedIPTargetVPNGatewayReference unmarshals an instance of ReservedIPTargetVPNGatewayReference from the specified map of raw messages. +func UnmarshalReservedIPTargetVPNGatewayReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ReservedIPTargetVPNGatewayReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalVPNGatewayReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ReservedIPTargetVPNServerReference : ReservedIPTargetVPNServerReference struct +// This model "extends" ReservedIPTarget +type ReservedIPTargetVPNServerReference struct { + // The CRN for this VPN server. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *VPNServerReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this VPN server. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this VPN server. + ID *string `json:"id" validate:"required"` + + // The name for this VPN server. The name is unique across all VPN servers in the VPC. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the ReservedIPTargetVPNServerReference.ResourceType property. +// The resource type. +const ( + ReservedIPTargetVPNServerReferenceResourceTypeVPNServerConst = "vpn_server" +) + +func (*ReservedIPTargetVPNServerReference) isaReservedIPTarget() bool { + return true +} + +// UnmarshalReservedIPTargetVPNServerReference unmarshals an instance of ReservedIPTargetVPNServerReference from the specified map of raw messages. +func UnmarshalReservedIPTargetVPNServerReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ReservedIPTargetVPNServerReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalVPNServerReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ReservedIPTargetVirtualNetworkInterfaceReferenceReservedIPTargetContext : ReservedIPTargetVirtualNetworkInterfaceReferenceReservedIPTargetContext struct +// This model "extends" ReservedIPTarget +type ReservedIPTargetVirtualNetworkInterfaceReferenceReservedIPTargetContext struct { + // The CRN for this virtual network interface. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *VirtualNetworkInterfaceReferenceReservedIPTargetContextDeleted `json:"deleted,omitempty"` + + // The URL for this virtual network interface. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this virtual network interface. + ID *string `json:"id" validate:"required"` + + // The name for this virtual network interface. The name is unique across all virtual network interfaces in the VPC. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the ReservedIPTargetVirtualNetworkInterfaceReferenceReservedIPTargetContext.ResourceType property. +// The resource type. +const ( + ReservedIPTargetVirtualNetworkInterfaceReferenceReservedIPTargetContextResourceTypeVirtualNetworkInterfaceConst = "virtual_network_interface" +) + +func (*ReservedIPTargetVirtualNetworkInterfaceReferenceReservedIPTargetContext) isaReservedIPTarget() bool { + return true +} + +// UnmarshalReservedIPTargetVirtualNetworkInterfaceReferenceReservedIPTargetContext unmarshals an instance of ReservedIPTargetVirtualNetworkInterfaceReferenceReservedIPTargetContext from the specified map of raw messages. +func UnmarshalReservedIPTargetVirtualNetworkInterfaceReferenceReservedIPTargetContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ReservedIPTargetVirtualNetworkInterfaceReferenceReservedIPTargetContext) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalVirtualNetworkInterfaceReferenceReservedIPTargetContextDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ResourceGroupIdentityByID : ResourceGroupIdentityByID struct +// This model "extends" ResourceGroupIdentity +type ResourceGroupIdentityByID struct { + // The unique identifier for this resource group. + ID *string `json:"id" validate:"required"` +} + +// NewResourceGroupIdentityByID : Instantiate ResourceGroupIdentityByID (Generic Model Constructor) +func (*VpcV1) NewResourceGroupIdentityByID(id string) (_model *ResourceGroupIdentityByID, err error) { + _model = &ResourceGroupIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*ResourceGroupIdentityByID) isaResourceGroupIdentity() bool { + return true +} + +// UnmarshalResourceGroupIdentityByID unmarshals an instance of ResourceGroupIdentityByID from the specified map of raw messages. +func UnmarshalResourceGroupIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ResourceGroupIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RouteCreatorVPNGatewayReference : RouteCreatorVPNGatewayReference struct +// This model "extends" RouteCreator +type RouteCreatorVPNGatewayReference struct { + // The VPN gateway's CRN. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *VPNGatewayReferenceDeleted `json:"deleted,omitempty"` + + // The VPN gateway's canonical URL. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this VPN gateway. + ID *string `json:"id" validate:"required"` + + // The name for this VPN gateway. The name is unique across all VPN gateways in the VPC. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the RouteCreatorVPNGatewayReference.ResourceType property. +// The resource type. +const ( + RouteCreatorVPNGatewayReferenceResourceTypeVPNGatewayConst = "vpn_gateway" +) + +func (*RouteCreatorVPNGatewayReference) isaRouteCreator() bool { + return true +} + +// UnmarshalRouteCreatorVPNGatewayReference unmarshals an instance of RouteCreatorVPNGatewayReference from the specified map of raw messages. +func UnmarshalRouteCreatorVPNGatewayReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RouteCreatorVPNGatewayReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalVPNGatewayReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RouteCreatorVPNServerReference : RouteCreatorVPNServerReference struct +// This model "extends" RouteCreator +type RouteCreatorVPNServerReference struct { + // The CRN for this VPN server. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *VPNServerReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this VPN server. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this VPN server. + ID *string `json:"id" validate:"required"` + + // The name for this VPN server. The name is unique across all VPN servers in the VPC. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the RouteCreatorVPNServerReference.ResourceType property. +// The resource type. +const ( + RouteCreatorVPNServerReferenceResourceTypeVPNServerConst = "vpn_server" +) + +func (*RouteCreatorVPNServerReference) isaRouteCreator() bool { + return true +} + +// UnmarshalRouteCreatorVPNServerReference unmarshals an instance of RouteCreatorVPNServerReference from the specified map of raw messages. +func UnmarshalRouteCreatorVPNServerReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RouteCreatorVPNServerReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalVPNServerReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RouteNextHopIP : RouteNextHopIP struct +// This model "extends" RouteNextHop +type RouteNextHopIP struct { + // The IP address. + // + // This property may add support for IPv6 addresses in the future. When processing a value in this property, verify + // that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the + // error, or bypass the resource on which the unexpected IP address format was encountered. + Address *string `json:"address" validate:"required"` +} + +func (*RouteNextHopIP) isaRouteNextHop() bool { + return true +} + +// UnmarshalRouteNextHopIP unmarshals an instance of RouteNextHopIP from the specified map of raw messages. +func UnmarshalRouteNextHopIP(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RouteNextHopIP) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RouteNextHopPatchRouteNextHopIP : RouteNextHopPatchRouteNextHopIP struct +// Models which "extend" this model: +// - RouteNextHopPatchRouteNextHopIPRouteNextHopIPSentinelIP +// - RouteNextHopPatchRouteNextHopIPRouteNextHopIPUnicastIP +// This model "extends" RouteNextHopPatch +type RouteNextHopPatchRouteNextHopIP struct { + // The sentinel IP address (`0.0.0.0`). + // + // This property may add support for IPv6 addresses in the future. When processing a value in this property, verify + // that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the + // error, or bypass the resource on which the unexpected IP address format was encountered. + Address *string `json:"address,omitempty"` +} + +func (*RouteNextHopPatchRouteNextHopIP) isaRouteNextHopPatchRouteNextHopIP() bool { + return true +} + +type RouteNextHopPatchRouteNextHopIPIntf interface { + RouteNextHopPatchIntf + isaRouteNextHopPatchRouteNextHopIP() bool +} + +func (*RouteNextHopPatchRouteNextHopIP) isaRouteNextHopPatch() bool { + return true +} + +// UnmarshalRouteNextHopPatchRouteNextHopIP unmarshals an instance of RouteNextHopPatchRouteNextHopIP from the specified map of raw messages. +func UnmarshalRouteNextHopPatchRouteNextHopIP(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RouteNextHopPatchRouteNextHopIP) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RouteNextHopPatchVPNGatewayConnectionIdentity : Identifies a VPN gateway connection by a unique property. +// Models which "extend" this model: +// - RouteNextHopPatchVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByID +// - RouteNextHopPatchVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByHref +// This model "extends" RouteNextHopPatch +type RouteNextHopPatchVPNGatewayConnectionIdentity struct { + // The unique identifier for this VPN gateway connection. + ID *string `json:"id,omitempty"` + + // The VPN connection's canonical URL. + Href *string `json:"href,omitempty"` +} + +func (*RouteNextHopPatchVPNGatewayConnectionIdentity) isaRouteNextHopPatchVPNGatewayConnectionIdentity() bool { + return true +} + +type RouteNextHopPatchVPNGatewayConnectionIdentityIntf interface { + RouteNextHopPatchIntf + isaRouteNextHopPatchVPNGatewayConnectionIdentity() bool +} + +func (*RouteNextHopPatchVPNGatewayConnectionIdentity) isaRouteNextHopPatch() bool { + return true +} + +// UnmarshalRouteNextHopPatchVPNGatewayConnectionIdentity unmarshals an instance of RouteNextHopPatchVPNGatewayConnectionIdentity from the specified map of raw messages. +func UnmarshalRouteNextHopPatchVPNGatewayConnectionIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RouteNextHopPatchVPNGatewayConnectionIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RouteNextHopVPNGatewayConnectionReference : RouteNextHopVPNGatewayConnectionReference struct +// This model "extends" RouteNextHop +type RouteNextHopVPNGatewayConnectionReference struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *VPNGatewayConnectionReferenceDeleted `json:"deleted,omitempty"` + + // The VPN connection's canonical URL. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this VPN gateway connection. + ID *string `json:"id" validate:"required"` + + // The name for this VPN gateway connection. The name is unique across all connections for the VPN gateway. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the RouteNextHopVPNGatewayConnectionReference.ResourceType property. +// The resource type. +const ( + RouteNextHopVPNGatewayConnectionReferenceResourceTypeVPNGatewayConnectionConst = "vpn_gateway_connection" +) + +func (*RouteNextHopVPNGatewayConnectionReference) isaRouteNextHop() bool { + return true +} + +// UnmarshalRouteNextHopVPNGatewayConnectionReference unmarshals an instance of RouteNextHopVPNGatewayConnectionReference from the specified map of raw messages. +func UnmarshalRouteNextHopVPNGatewayConnectionReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RouteNextHopVPNGatewayConnectionReference) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalVPNGatewayConnectionReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIP : RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIP struct +// Models which "extend" this model: +// - RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPRouteNextHopPrototypeRouteNextHopIPRouteNextHopIPSentinelIP +// - RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPRouteNextHopPrototypeRouteNextHopIPRouteNextHopIPUnicastIP +// This model "extends" RoutePrototypeNextHop +type RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIP struct { + // The sentinel IP address (`0.0.0.0`). + // + // This property may add support for IPv6 addresses in the future. When processing a value in this property, verify + // that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the + // error, or bypass the resource on which the unexpected IP address format was encountered. + Address *string `json:"address,omitempty"` +} + +func (*RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIP) isaRoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIP() bool { + return true +} + +type RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPIntf interface { + RoutePrototypeNextHopIntf + isaRoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIP() bool +} + +func (*RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIP) isaRoutePrototypeNextHop() bool { + return true +} + +// UnmarshalRoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIP unmarshals an instance of RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIP from the specified map of raw messages. +func UnmarshalRoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIP(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIP) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentity : Identifies a VPN gateway connection by a unique property. +// Models which "extend" this model: +// - RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityRouteNextHopPrototypeVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByID +// - RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityRouteNextHopPrototypeVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByHref +// This model "extends" RoutePrototypeNextHop +type RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentity struct { + // The unique identifier for this VPN gateway connection. + ID *string `json:"id,omitempty"` + + // The VPN connection's canonical URL. + Href *string `json:"href,omitempty"` +} + +func (*RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentity) isaRoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentity() bool { + return true +} + +type RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityIntf interface { + RoutePrototypeNextHopIntf + isaRoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentity() bool +} + +func (*RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentity) isaRoutePrototypeNextHop() bool { + return true +} + +// UnmarshalRoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentity unmarshals an instance of RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentity from the specified map of raw messages. +func UnmarshalRoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RoutingTableIdentityByHref : RoutingTableIdentityByHref struct +// This model "extends" RoutingTableIdentity +type RoutingTableIdentityByHref struct { + // The URL for this routing table. + Href *string `json:"href" validate:"required"` +} + +// NewRoutingTableIdentityByHref : Instantiate RoutingTableIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewRoutingTableIdentityByHref(href string) (_model *RoutingTableIdentityByHref, err error) { + _model = &RoutingTableIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*RoutingTableIdentityByHref) isaRoutingTableIdentity() bool { + return true +} + +// UnmarshalRoutingTableIdentityByHref unmarshals an instance of RoutingTableIdentityByHref from the specified map of raw messages. +func UnmarshalRoutingTableIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RoutingTableIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RoutingTableIdentityByID : RoutingTableIdentityByID struct +// This model "extends" RoutingTableIdentity +type RoutingTableIdentityByID struct { + // The unique identifier for this routing table. + ID *string `json:"id" validate:"required"` +} + +// NewRoutingTableIdentityByID : Instantiate RoutingTableIdentityByID (Generic Model Constructor) +func (*VpcV1) NewRoutingTableIdentityByID(id string) (_model *RoutingTableIdentityByID, err error) { + _model = &RoutingTableIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*RoutingTableIdentityByID) isaRoutingTableIdentity() bool { + return true +} + +// UnmarshalRoutingTableIdentityByID unmarshals an instance of RoutingTableIdentityByID from the specified map of raw messages. +func UnmarshalRoutingTableIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RoutingTableIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupIdentityByCRN : SecurityGroupIdentityByCRN struct +// This model "extends" SecurityGroupIdentity +type SecurityGroupIdentityByCRN struct { + // The security group's CRN. + CRN *string `json:"crn" validate:"required"` +} + +// NewSecurityGroupIdentityByCRN : Instantiate SecurityGroupIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewSecurityGroupIdentityByCRN(crn string) (_model *SecurityGroupIdentityByCRN, err error) { + _model = &SecurityGroupIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SecurityGroupIdentityByCRN) isaSecurityGroupIdentity() bool { + return true +} + +// UnmarshalSecurityGroupIdentityByCRN unmarshals an instance of SecurityGroupIdentityByCRN from the specified map of raw messages. +func UnmarshalSecurityGroupIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupIdentityByHref : SecurityGroupIdentityByHref struct +// This model "extends" SecurityGroupIdentity +type SecurityGroupIdentityByHref struct { + // The security group's canonical URL. + Href *string `json:"href" validate:"required"` +} + +// NewSecurityGroupIdentityByHref : Instantiate SecurityGroupIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewSecurityGroupIdentityByHref(href string) (_model *SecurityGroupIdentityByHref, err error) { + _model = &SecurityGroupIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SecurityGroupIdentityByHref) isaSecurityGroupIdentity() bool { + return true +} + +// UnmarshalSecurityGroupIdentityByHref unmarshals an instance of SecurityGroupIdentityByHref from the specified map of raw messages. +func UnmarshalSecurityGroupIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupIdentityByID : SecurityGroupIdentityByID struct +// This model "extends" SecurityGroupIdentity +type SecurityGroupIdentityByID struct { + // The unique identifier for this security group. + ID *string `json:"id" validate:"required"` +} + +// NewSecurityGroupIdentityByID : Instantiate SecurityGroupIdentityByID (Generic Model Constructor) +func (*VpcV1) NewSecurityGroupIdentityByID(id string) (_model *SecurityGroupIdentityByID, err error) { + _model = &SecurityGroupIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SecurityGroupIdentityByID) isaSecurityGroupIdentity() bool { + return true +} + +// UnmarshalSecurityGroupIdentityByID unmarshals an instance of SecurityGroupIdentityByID from the specified map of raw messages. +func UnmarshalSecurityGroupIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupRulePrototypeSecurityGroupRuleProtocolAll : A rule allowing traffic for all supported protocols. +// This model "extends" SecurityGroupRulePrototype +type SecurityGroupRulePrototypeSecurityGroupRuleProtocolAll struct { + // The direction of traffic to enforce. + Direction *string `json:"direction" validate:"required"` + + // The IP version to enforce. The format of `remote.address` or `remote.cidr_block` must match this property, if they + // are used. Alternatively, if `remote` references a security group, then this rule only applies to IP addresses + // (network interfaces) in that group matching this IP version. + IPVersion *string `json:"ip_version,omitempty"` + + // The protocol to enforce. + Protocol *string `json:"protocol" validate:"required"` + + // The remote IP addresses or security groups from which this rule will allow traffic (or to + // which, for outbound rules). Can be specified as an IP address, a CIDR block, or a + // security group within the VPC. + // + // If unspecified, a CIDR block of `0.0.0.0/0` will be used to allow traffic from any source + // (or to any destination, for outbound rules). + Remote SecurityGroupRuleRemotePrototypeIntf `json:"remote,omitempty"` +} + +// Constants associated with the SecurityGroupRulePrototypeSecurityGroupRuleProtocolAll.Direction property. +// The direction of traffic to enforce. +const ( + SecurityGroupRulePrototypeSecurityGroupRuleProtocolAllDirectionInboundConst = "inbound" + SecurityGroupRulePrototypeSecurityGroupRuleProtocolAllDirectionOutboundConst = "outbound" +) + +// Constants associated with the SecurityGroupRulePrototypeSecurityGroupRuleProtocolAll.IPVersion property. +// The IP version to enforce. The format of `remote.address` or `remote.cidr_block` must match this property, if they +// are used. Alternatively, if `remote` references a security group, then this rule only applies to IP addresses +// (network interfaces) in that group matching this IP version. +const ( + SecurityGroupRulePrototypeSecurityGroupRuleProtocolAllIPVersionIpv4Const = "ipv4" +) + +// Constants associated with the SecurityGroupRulePrototypeSecurityGroupRuleProtocolAll.Protocol property. +// The protocol to enforce. +const ( + SecurityGroupRulePrototypeSecurityGroupRuleProtocolAllProtocolAllConst = "all" +) + +// NewSecurityGroupRulePrototypeSecurityGroupRuleProtocolAll : Instantiate SecurityGroupRulePrototypeSecurityGroupRuleProtocolAll (Generic Model Constructor) +func (*VpcV1) NewSecurityGroupRulePrototypeSecurityGroupRuleProtocolAll(direction string, protocol string) (_model *SecurityGroupRulePrototypeSecurityGroupRuleProtocolAll, err error) { + _model = &SecurityGroupRulePrototypeSecurityGroupRuleProtocolAll{ + Direction: core.StringPtr(direction), + Protocol: core.StringPtr(protocol), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SecurityGroupRulePrototypeSecurityGroupRuleProtocolAll) isaSecurityGroupRulePrototype() bool { + return true +} + +// UnmarshalSecurityGroupRulePrototypeSecurityGroupRuleProtocolAll unmarshals an instance of SecurityGroupRulePrototypeSecurityGroupRuleProtocolAll from the specified map of raw messages. +func UnmarshalSecurityGroupRulePrototypeSecurityGroupRuleProtocolAll(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupRulePrototypeSecurityGroupRuleProtocolAll) + err = core.UnmarshalPrimitive(m, "direction", &obj.Direction) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "ip_version", &obj.IPVersion) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "protocol", &obj.Protocol) + if err != nil { + return + } + err = core.UnmarshalModel(m, "remote", &obj.Remote, UnmarshalSecurityGroupRuleRemotePrototype) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupRulePrototypeSecurityGroupRuleProtocolIcmp : A rule specifying the ICMP traffic to allow. +// This model "extends" SecurityGroupRulePrototype +type SecurityGroupRulePrototypeSecurityGroupRuleProtocolIcmp struct { + // The ICMP traffic code to allow. + // + // If specified, `type` must also be specified. If unspecified, all codes are allowed. + Code *int64 `json:"code,omitempty"` + + // The direction of traffic to enforce. + Direction *string `json:"direction" validate:"required"` + + // The IP version to enforce. The format of `remote.address` or `remote.cidr_block` must match this property, if they + // are used. Alternatively, if `remote` references a security group, then this rule only applies to IP addresses + // (network interfaces) in that group matching this IP version. + IPVersion *string `json:"ip_version,omitempty"` + + // The protocol to enforce. + Protocol *string `json:"protocol" validate:"required"` + + // The remote IP addresses or security groups from which this rule will allow traffic (or to + // which, for outbound rules). Can be specified as an IP address, a CIDR block, or a + // security group within the VPC. + // + // If unspecified, a CIDR block of `0.0.0.0/0` will be used to allow traffic from any source + // (or to any destination, for outbound rules). + Remote SecurityGroupRuleRemotePrototypeIntf `json:"remote,omitempty"` + + // The ICMP traffic type to allow. + // + // If unspecified, all types are allowed. + Type *int64 `json:"type,omitempty"` +} + +// Constants associated with the SecurityGroupRulePrototypeSecurityGroupRuleProtocolIcmp.Direction property. +// The direction of traffic to enforce. +const ( + SecurityGroupRulePrototypeSecurityGroupRuleProtocolIcmpDirectionInboundConst = "inbound" + SecurityGroupRulePrototypeSecurityGroupRuleProtocolIcmpDirectionOutboundConst = "outbound" +) + +// Constants associated with the SecurityGroupRulePrototypeSecurityGroupRuleProtocolIcmp.IPVersion property. +// The IP version to enforce. The format of `remote.address` or `remote.cidr_block` must match this property, if they +// are used. Alternatively, if `remote` references a security group, then this rule only applies to IP addresses +// (network interfaces) in that group matching this IP version. +const ( + SecurityGroupRulePrototypeSecurityGroupRuleProtocolIcmpIPVersionIpv4Const = "ipv4" +) + +// Constants associated with the SecurityGroupRulePrototypeSecurityGroupRuleProtocolIcmp.Protocol property. +// The protocol to enforce. +const ( + SecurityGroupRulePrototypeSecurityGroupRuleProtocolIcmpProtocolIcmpConst = "icmp" +) + +// NewSecurityGroupRulePrototypeSecurityGroupRuleProtocolIcmp : Instantiate SecurityGroupRulePrototypeSecurityGroupRuleProtocolIcmp (Generic Model Constructor) +func (*VpcV1) NewSecurityGroupRulePrototypeSecurityGroupRuleProtocolIcmp(direction string, protocol string) (_model *SecurityGroupRulePrototypeSecurityGroupRuleProtocolIcmp, err error) { + _model = &SecurityGroupRulePrototypeSecurityGroupRuleProtocolIcmp{ + Direction: core.StringPtr(direction), + Protocol: core.StringPtr(protocol), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SecurityGroupRulePrototypeSecurityGroupRuleProtocolIcmp) isaSecurityGroupRulePrototype() bool { + return true +} + +// UnmarshalSecurityGroupRulePrototypeSecurityGroupRuleProtocolIcmp unmarshals an instance of SecurityGroupRulePrototypeSecurityGroupRuleProtocolIcmp from the specified map of raw messages. +func UnmarshalSecurityGroupRulePrototypeSecurityGroupRuleProtocolIcmp(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupRulePrototypeSecurityGroupRuleProtocolIcmp) + err = core.UnmarshalPrimitive(m, "code", &obj.Code) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "direction", &obj.Direction) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "ip_version", &obj.IPVersion) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "protocol", &obj.Protocol) + if err != nil { + return + } + err = core.UnmarshalModel(m, "remote", &obj.Remote, UnmarshalSecurityGroupRuleRemotePrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupRulePrototypeSecurityGroupRuleProtocolTcpudp : A rule specifying the TCP or UDP traffic to allow. +// +// Either both `port_min` and `port_max` will be present, or neither. When neither is present, all destination ports are +// allowed for the protocol. When both have the same value, that single destination port is allowed. +// This model "extends" SecurityGroupRulePrototype +type SecurityGroupRulePrototypeSecurityGroupRuleProtocolTcpudp struct { + // The direction of traffic to enforce. + Direction *string `json:"direction" validate:"required"` + + // The IP version to enforce. The format of `remote.address` or `remote.cidr_block` must match this property, if they + // are used. Alternatively, if `remote` references a security group, then this rule only applies to IP addresses + // (network interfaces) in that group matching this IP version. + IPVersion *string `json:"ip_version,omitempty"` + + // The inclusive upper bound of TCP/UDP destination port range. + // + // If specified, `port_min` must also be specified, and must not be larger. If unspecified, + // `port_min` must also be unspecified, allowing traffic on all destination ports. + PortMax *int64 `json:"port_max,omitempty"` + + // The inclusive lower bound of TCP/UDP destination port range + // + // If specified, `port_max` must also be specified, and must not be smaller. If unspecified, `port_max` must also be + // unspecified, allowing traffic on all destination ports. + PortMin *int64 `json:"port_min,omitempty"` + + // The protocol to enforce. + Protocol *string `json:"protocol" validate:"required"` + + // The remote IP addresses or security groups from which this rule will allow traffic (or to + // which, for outbound rules). Can be specified as an IP address, a CIDR block, or a + // security group within the VPC. + // + // If unspecified, a CIDR block of `0.0.0.0/0` will be used to allow traffic from any source + // (or to any destination, for outbound rules). + Remote SecurityGroupRuleRemotePrototypeIntf `json:"remote,omitempty"` +} + +// Constants associated with the SecurityGroupRulePrototypeSecurityGroupRuleProtocolTcpudp.Direction property. +// The direction of traffic to enforce. +const ( + SecurityGroupRulePrototypeSecurityGroupRuleProtocolTcpudpDirectionInboundConst = "inbound" + SecurityGroupRulePrototypeSecurityGroupRuleProtocolTcpudpDirectionOutboundConst = "outbound" +) + +// Constants associated with the SecurityGroupRulePrototypeSecurityGroupRuleProtocolTcpudp.IPVersion property. +// The IP version to enforce. The format of `remote.address` or `remote.cidr_block` must match this property, if they +// are used. Alternatively, if `remote` references a security group, then this rule only applies to IP addresses +// (network interfaces) in that group matching this IP version. +const ( + SecurityGroupRulePrototypeSecurityGroupRuleProtocolTcpudpIPVersionIpv4Const = "ipv4" +) + +// Constants associated with the SecurityGroupRulePrototypeSecurityGroupRuleProtocolTcpudp.Protocol property. +// The protocol to enforce. +const ( + SecurityGroupRulePrototypeSecurityGroupRuleProtocolTcpudpProtocolTCPConst = "tcp" + SecurityGroupRulePrototypeSecurityGroupRuleProtocolTcpudpProtocolUDPConst = "udp" +) + +// NewSecurityGroupRulePrototypeSecurityGroupRuleProtocolTcpudp : Instantiate SecurityGroupRulePrototypeSecurityGroupRuleProtocolTcpudp (Generic Model Constructor) +func (*VpcV1) NewSecurityGroupRulePrototypeSecurityGroupRuleProtocolTcpudp(direction string, protocol string) (_model *SecurityGroupRulePrototypeSecurityGroupRuleProtocolTcpudp, err error) { + _model = &SecurityGroupRulePrototypeSecurityGroupRuleProtocolTcpudp{ + Direction: core.StringPtr(direction), + Protocol: core.StringPtr(protocol), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SecurityGroupRulePrototypeSecurityGroupRuleProtocolTcpudp) isaSecurityGroupRulePrototype() bool { + return true +} + +// UnmarshalSecurityGroupRulePrototypeSecurityGroupRuleProtocolTcpudp unmarshals an instance of SecurityGroupRulePrototypeSecurityGroupRuleProtocolTcpudp from the specified map of raw messages. +func UnmarshalSecurityGroupRulePrototypeSecurityGroupRuleProtocolTcpudp(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupRulePrototypeSecurityGroupRuleProtocolTcpudp) + err = core.UnmarshalPrimitive(m, "direction", &obj.Direction) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "ip_version", &obj.IPVersion) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "port_max", &obj.PortMax) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "port_min", &obj.PortMin) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "protocol", &obj.Protocol) + if err != nil { + return + } + err = core.UnmarshalModel(m, "remote", &obj.Remote, UnmarshalSecurityGroupRuleRemotePrototype) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupRuleRemotePatchCIDR : SecurityGroupRuleRemotePatchCIDR struct +// This model "extends" SecurityGroupRuleRemotePatch +type SecurityGroupRuleRemotePatchCIDR struct { + // The CIDR block. This property may add support for IPv6 CIDR blocks in the future. When processing a value in this + // property, verify that the CIDR block is in an expected format. If it is not, log an error. Optionally halt + // processing and surface the error, or bypass the resource on which the unexpected CIDR block format was encountered. + CIDRBlock *string `json:"cidr_block" validate:"required"` +} + +// NewSecurityGroupRuleRemotePatchCIDR : Instantiate SecurityGroupRuleRemotePatchCIDR (Generic Model Constructor) +func (*VpcV1) NewSecurityGroupRuleRemotePatchCIDR(cidrBlock string) (_model *SecurityGroupRuleRemotePatchCIDR, err error) { + _model = &SecurityGroupRuleRemotePatchCIDR{ + CIDRBlock: core.StringPtr(cidrBlock), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SecurityGroupRuleRemotePatchCIDR) isaSecurityGroupRuleRemotePatch() bool { + return true +} + +// UnmarshalSecurityGroupRuleRemotePatchCIDR unmarshals an instance of SecurityGroupRuleRemotePatchCIDR from the specified map of raw messages. +func UnmarshalSecurityGroupRuleRemotePatchCIDR(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupRuleRemotePatchCIDR) + err = core.UnmarshalPrimitive(m, "cidr_block", &obj.CIDRBlock) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupRuleRemotePatchIP : SecurityGroupRuleRemotePatchIP struct +// This model "extends" SecurityGroupRuleRemotePatch +type SecurityGroupRuleRemotePatchIP struct { + // The IP address. + // + // This property may add support for IPv6 addresses in the future. When processing a value in this property, verify + // that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the + // error, or bypass the resource on which the unexpected IP address format was encountered. + Address *string `json:"address" validate:"required"` +} + +// NewSecurityGroupRuleRemotePatchIP : Instantiate SecurityGroupRuleRemotePatchIP (Generic Model Constructor) +func (*VpcV1) NewSecurityGroupRuleRemotePatchIP(address string) (_model *SecurityGroupRuleRemotePatchIP, err error) { + _model = &SecurityGroupRuleRemotePatchIP{ + Address: core.StringPtr(address), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SecurityGroupRuleRemotePatchIP) isaSecurityGroupRuleRemotePatch() bool { + return true +} + +// UnmarshalSecurityGroupRuleRemotePatchIP unmarshals an instance of SecurityGroupRuleRemotePatchIP from the specified map of raw messages. +func UnmarshalSecurityGroupRuleRemotePatchIP(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupRuleRemotePatchIP) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupRuleRemotePatchSecurityGroupIdentity : Identifies a security group by a unique property. +// Models which "extend" this model: +// - SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByID +// - SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByCRN +// - SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByHref +// This model "extends" SecurityGroupRuleRemotePatch +type SecurityGroupRuleRemotePatchSecurityGroupIdentity struct { + // The unique identifier for this security group. + ID *string `json:"id,omitempty"` + + // The security group's CRN. + CRN *string `json:"crn,omitempty"` + + // The security group's canonical URL. + Href *string `json:"href,omitempty"` +} + +func (*SecurityGroupRuleRemotePatchSecurityGroupIdentity) isaSecurityGroupRuleRemotePatchSecurityGroupIdentity() bool { + return true +} + +type SecurityGroupRuleRemotePatchSecurityGroupIdentityIntf interface { + SecurityGroupRuleRemotePatchIntf + isaSecurityGroupRuleRemotePatchSecurityGroupIdentity() bool +} + +func (*SecurityGroupRuleRemotePatchSecurityGroupIdentity) isaSecurityGroupRuleRemotePatch() bool { + return true +} + +// UnmarshalSecurityGroupRuleRemotePatchSecurityGroupIdentity unmarshals an instance of SecurityGroupRuleRemotePatchSecurityGroupIdentity from the specified map of raw messages. +func UnmarshalSecurityGroupRuleRemotePatchSecurityGroupIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupRuleRemotePatchSecurityGroupIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupRuleRemotePrototypeCIDR : SecurityGroupRuleRemotePrototypeCIDR struct +// This model "extends" SecurityGroupRuleRemotePrototype +type SecurityGroupRuleRemotePrototypeCIDR struct { + // The CIDR block. This property may add support for IPv6 CIDR blocks in the future. When processing a value in this + // property, verify that the CIDR block is in an expected format. If it is not, log an error. Optionally halt + // processing and surface the error, or bypass the resource on which the unexpected CIDR block format was encountered. + CIDRBlock *string `json:"cidr_block" validate:"required"` +} + +// NewSecurityGroupRuleRemotePrototypeCIDR : Instantiate SecurityGroupRuleRemotePrototypeCIDR (Generic Model Constructor) +func (*VpcV1) NewSecurityGroupRuleRemotePrototypeCIDR(cidrBlock string) (_model *SecurityGroupRuleRemotePrototypeCIDR, err error) { + _model = &SecurityGroupRuleRemotePrototypeCIDR{ + CIDRBlock: core.StringPtr(cidrBlock), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SecurityGroupRuleRemotePrototypeCIDR) isaSecurityGroupRuleRemotePrototype() bool { + return true +} + +// UnmarshalSecurityGroupRuleRemotePrototypeCIDR unmarshals an instance of SecurityGroupRuleRemotePrototypeCIDR from the specified map of raw messages. +func UnmarshalSecurityGroupRuleRemotePrototypeCIDR(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupRuleRemotePrototypeCIDR) + err = core.UnmarshalPrimitive(m, "cidr_block", &obj.CIDRBlock) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupRuleRemotePrototypeIP : SecurityGroupRuleRemotePrototypeIP struct +// This model "extends" SecurityGroupRuleRemotePrototype +type SecurityGroupRuleRemotePrototypeIP struct { + // The IP address. + // + // This property may add support for IPv6 addresses in the future. When processing a value in this property, verify + // that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the + // error, or bypass the resource on which the unexpected IP address format was encountered. + Address *string `json:"address" validate:"required"` +} + +// NewSecurityGroupRuleRemotePrototypeIP : Instantiate SecurityGroupRuleRemotePrototypeIP (Generic Model Constructor) +func (*VpcV1) NewSecurityGroupRuleRemotePrototypeIP(address string) (_model *SecurityGroupRuleRemotePrototypeIP, err error) { + _model = &SecurityGroupRuleRemotePrototypeIP{ + Address: core.StringPtr(address), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SecurityGroupRuleRemotePrototypeIP) isaSecurityGroupRuleRemotePrototype() bool { + return true +} + +// UnmarshalSecurityGroupRuleRemotePrototypeIP unmarshals an instance of SecurityGroupRuleRemotePrototypeIP from the specified map of raw messages. +func UnmarshalSecurityGroupRuleRemotePrototypeIP(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupRuleRemotePrototypeIP) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupRuleRemotePrototypeSecurityGroupIdentity : Identifies a security group by a unique property. +// Models which "extend" this model: +// - SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByID +// - SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByCRN +// - SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByHref +// This model "extends" SecurityGroupRuleRemotePrototype +type SecurityGroupRuleRemotePrototypeSecurityGroupIdentity struct { + // The unique identifier for this security group. + ID *string `json:"id,omitempty"` + + // The security group's CRN. + CRN *string `json:"crn,omitempty"` + + // The security group's canonical URL. + Href *string `json:"href,omitempty"` +} + +func (*SecurityGroupRuleRemotePrototypeSecurityGroupIdentity) isaSecurityGroupRuleRemotePrototypeSecurityGroupIdentity() bool { + return true +} + +type SecurityGroupRuleRemotePrototypeSecurityGroupIdentityIntf interface { + SecurityGroupRuleRemotePrototypeIntf + isaSecurityGroupRuleRemotePrototypeSecurityGroupIdentity() bool +} + +func (*SecurityGroupRuleRemotePrototypeSecurityGroupIdentity) isaSecurityGroupRuleRemotePrototype() bool { + return true +} + +// UnmarshalSecurityGroupRuleRemotePrototypeSecurityGroupIdentity unmarshals an instance of SecurityGroupRuleRemotePrototypeSecurityGroupIdentity from the specified map of raw messages. +func UnmarshalSecurityGroupRuleRemotePrototypeSecurityGroupIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupRuleRemotePrototypeSecurityGroupIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupRuleRemoteCIDR : SecurityGroupRuleRemoteCIDR struct +// This model "extends" SecurityGroupRuleRemote +type SecurityGroupRuleRemoteCIDR struct { + // The CIDR block. This property may add support for IPv6 CIDR blocks in the future. When processing a value in this + // property, verify that the CIDR block is in an expected format. If it is not, log an error. Optionally halt + // processing and surface the error, or bypass the resource on which the unexpected CIDR block format was encountered. + CIDRBlock *string `json:"cidr_block" validate:"required"` +} + +func (*SecurityGroupRuleRemoteCIDR) isaSecurityGroupRuleRemote() bool { + return true +} + +// UnmarshalSecurityGroupRuleRemoteCIDR unmarshals an instance of SecurityGroupRuleRemoteCIDR from the specified map of raw messages. +func UnmarshalSecurityGroupRuleRemoteCIDR(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupRuleRemoteCIDR) + err = core.UnmarshalPrimitive(m, "cidr_block", &obj.CIDRBlock) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupRuleRemoteIP : SecurityGroupRuleRemoteIP struct +// This model "extends" SecurityGroupRuleRemote +type SecurityGroupRuleRemoteIP struct { + // The IP address. + // + // This property may add support for IPv6 addresses in the future. When processing a value in this property, verify + // that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the + // error, or bypass the resource on which the unexpected IP address format was encountered. + Address *string `json:"address" validate:"required"` +} + +func (*SecurityGroupRuleRemoteIP) isaSecurityGroupRuleRemote() bool { + return true +} + +// UnmarshalSecurityGroupRuleRemoteIP unmarshals an instance of SecurityGroupRuleRemoteIP from the specified map of raw messages. +func UnmarshalSecurityGroupRuleRemoteIP(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupRuleRemoteIP) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupRuleRemoteSecurityGroupReference : SecurityGroupRuleRemoteSecurityGroupReference struct +// This model "extends" SecurityGroupRuleRemote +type SecurityGroupRuleRemoteSecurityGroupReference struct { + // The security group's CRN. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *SecurityGroupReferenceDeleted `json:"deleted,omitempty"` + + // The security group's canonical URL. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this security group. + ID *string `json:"id" validate:"required"` + + // The name for this security group. The name is unique across all security groups for the VPC. + Name *string `json:"name" validate:"required"` +} + +func (*SecurityGroupRuleRemoteSecurityGroupReference) isaSecurityGroupRuleRemote() bool { + return true +} + +// UnmarshalSecurityGroupRuleRemoteSecurityGroupReference unmarshals an instance of SecurityGroupRuleRemoteSecurityGroupReference from the specified map of raw messages. +func UnmarshalSecurityGroupRuleRemoteSecurityGroupReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupRuleRemoteSecurityGroupReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalSecurityGroupReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupRuleSecurityGroupRuleProtocolAll : A rule allowing traffic for all supported protocols. +// This model "extends" SecurityGroupRule +type SecurityGroupRuleSecurityGroupRuleProtocolAll struct { + // The direction of traffic to enforce. + Direction *string `json:"direction" validate:"required"` + + // The URL for this security group rule. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this security group rule. + ID *string `json:"id" validate:"required"` + + // The IP version to enforce. The format of `remote.address` or `remote.cidr_block` must match this property, if they + // are used. Alternatively, if `remote` references a security group, then this rule only applies to IP addresses + // (network interfaces) in that group matching this IP version. + IPVersion *string `json:"ip_version" validate:"required"` + + Remote SecurityGroupRuleRemoteIntf `json:"remote" validate:"required"` + + // The protocol to enforce. + Protocol *string `json:"protocol" validate:"required"` +} + +// Constants associated with the SecurityGroupRuleSecurityGroupRuleProtocolAll.Direction property. +// The direction of traffic to enforce. +const ( + SecurityGroupRuleSecurityGroupRuleProtocolAllDirectionInboundConst = "inbound" + SecurityGroupRuleSecurityGroupRuleProtocolAllDirectionOutboundConst = "outbound" +) + +// Constants associated with the SecurityGroupRuleSecurityGroupRuleProtocolAll.IPVersion property. +// The IP version to enforce. The format of `remote.address` or `remote.cidr_block` must match this property, if they +// are used. Alternatively, if `remote` references a security group, then this rule only applies to IP addresses +// (network interfaces) in that group matching this IP version. +const ( + SecurityGroupRuleSecurityGroupRuleProtocolAllIPVersionIpv4Const = "ipv4" +) + +// Constants associated with the SecurityGroupRuleSecurityGroupRuleProtocolAll.Protocol property. +// The protocol to enforce. +const ( + SecurityGroupRuleSecurityGroupRuleProtocolAllProtocolAllConst = "all" +) + +func (*SecurityGroupRuleSecurityGroupRuleProtocolAll) isaSecurityGroupRule() bool { + return true +} + +// UnmarshalSecurityGroupRuleSecurityGroupRuleProtocolAll unmarshals an instance of SecurityGroupRuleSecurityGroupRuleProtocolAll from the specified map of raw messages. +func UnmarshalSecurityGroupRuleSecurityGroupRuleProtocolAll(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupRuleSecurityGroupRuleProtocolAll) + err = core.UnmarshalPrimitive(m, "direction", &obj.Direction) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "ip_version", &obj.IPVersion) + if err != nil { + return + } + err = core.UnmarshalModel(m, "remote", &obj.Remote, UnmarshalSecurityGroupRuleRemote) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "protocol", &obj.Protocol) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupRuleSecurityGroupRuleProtocolIcmp : A rule specifying the ICMP traffic to allow. +// This model "extends" SecurityGroupRule +type SecurityGroupRuleSecurityGroupRuleProtocolIcmp struct { + // The direction of traffic to enforce. + Direction *string `json:"direction" validate:"required"` + + // The URL for this security group rule. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this security group rule. + ID *string `json:"id" validate:"required"` + + // The IP version to enforce. The format of `remote.address` or `remote.cidr_block` must match this property, if they + // are used. Alternatively, if `remote` references a security group, then this rule only applies to IP addresses + // (network interfaces) in that group matching this IP version. + IPVersion *string `json:"ip_version" validate:"required"` + + Remote SecurityGroupRuleRemoteIntf `json:"remote" validate:"required"` + + // The ICMP traffic code to allow. If absent, all codes are allowed. + Code *int64 `json:"code,omitempty"` + + // The protocol to enforce. + Protocol *string `json:"protocol" validate:"required"` + + // The ICMP traffic type to allow. If absent, all types are allowed. + Type *int64 `json:"type,omitempty"` +} + +// Constants associated with the SecurityGroupRuleSecurityGroupRuleProtocolIcmp.Direction property. +// The direction of traffic to enforce. +const ( + SecurityGroupRuleSecurityGroupRuleProtocolIcmpDirectionInboundConst = "inbound" + SecurityGroupRuleSecurityGroupRuleProtocolIcmpDirectionOutboundConst = "outbound" +) + +// Constants associated with the SecurityGroupRuleSecurityGroupRuleProtocolIcmp.IPVersion property. +// The IP version to enforce. The format of `remote.address` or `remote.cidr_block` must match this property, if they +// are used. Alternatively, if `remote` references a security group, then this rule only applies to IP addresses +// (network interfaces) in that group matching this IP version. +const ( + SecurityGroupRuleSecurityGroupRuleProtocolIcmpIPVersionIpv4Const = "ipv4" +) + +// Constants associated with the SecurityGroupRuleSecurityGroupRuleProtocolIcmp.Protocol property. +// The protocol to enforce. +const ( + SecurityGroupRuleSecurityGroupRuleProtocolIcmpProtocolIcmpConst = "icmp" +) + +func (*SecurityGroupRuleSecurityGroupRuleProtocolIcmp) isaSecurityGroupRule() bool { + return true +} + +// UnmarshalSecurityGroupRuleSecurityGroupRuleProtocolIcmp unmarshals an instance of SecurityGroupRuleSecurityGroupRuleProtocolIcmp from the specified map of raw messages. +func UnmarshalSecurityGroupRuleSecurityGroupRuleProtocolIcmp(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupRuleSecurityGroupRuleProtocolIcmp) + err = core.UnmarshalPrimitive(m, "direction", &obj.Direction) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "ip_version", &obj.IPVersion) + if err != nil { + return + } + err = core.UnmarshalModel(m, "remote", &obj.Remote, UnmarshalSecurityGroupRuleRemote) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "code", &obj.Code) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "protocol", &obj.Protocol) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupRuleSecurityGroupRuleProtocolTcpudp : A rule specifying the TCP or UDP traffic to allow. +// +// Either both `port_min` and `port_max` will be present, or neither. When neither is present, all destination ports are +// allowed for the protocol. When both have the same value, that single destination port is allowed. +// This model "extends" SecurityGroupRule +type SecurityGroupRuleSecurityGroupRuleProtocolTcpudp struct { + // The direction of traffic to enforce. + Direction *string `json:"direction" validate:"required"` + + // The URL for this security group rule. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this security group rule. + ID *string `json:"id" validate:"required"` + + // The IP version to enforce. The format of `remote.address` or `remote.cidr_block` must match this property, if they + // are used. Alternatively, if `remote` references a security group, then this rule only applies to IP addresses + // (network interfaces) in that group matching this IP version. + IPVersion *string `json:"ip_version" validate:"required"` + + Remote SecurityGroupRuleRemoteIntf `json:"remote" validate:"required"` + + // The inclusive upper bound of TCP/UDP destination port range. + PortMax *int64 `json:"port_max,omitempty"` + + // The inclusive lower bound of TCP/UDP destination port range. + PortMin *int64 `json:"port_min,omitempty"` + + // The protocol to enforce. + Protocol *string `json:"protocol" validate:"required"` +} + +// Constants associated with the SecurityGroupRuleSecurityGroupRuleProtocolTcpudp.Direction property. +// The direction of traffic to enforce. +const ( + SecurityGroupRuleSecurityGroupRuleProtocolTcpudpDirectionInboundConst = "inbound" + SecurityGroupRuleSecurityGroupRuleProtocolTcpudpDirectionOutboundConst = "outbound" +) + +// Constants associated with the SecurityGroupRuleSecurityGroupRuleProtocolTcpudp.IPVersion property. +// The IP version to enforce. The format of `remote.address` or `remote.cidr_block` must match this property, if they +// are used. Alternatively, if `remote` references a security group, then this rule only applies to IP addresses +// (network interfaces) in that group matching this IP version. +const ( + SecurityGroupRuleSecurityGroupRuleProtocolTcpudpIPVersionIpv4Const = "ipv4" +) + +// Constants associated with the SecurityGroupRuleSecurityGroupRuleProtocolTcpudp.Protocol property. +// The protocol to enforce. +const ( + SecurityGroupRuleSecurityGroupRuleProtocolTcpudpProtocolTCPConst = "tcp" + SecurityGroupRuleSecurityGroupRuleProtocolTcpudpProtocolUDPConst = "udp" +) + +func (*SecurityGroupRuleSecurityGroupRuleProtocolTcpudp) isaSecurityGroupRule() bool { + return true +} + +// UnmarshalSecurityGroupRuleSecurityGroupRuleProtocolTcpudp unmarshals an instance of SecurityGroupRuleSecurityGroupRuleProtocolTcpudp from the specified map of raw messages. +func UnmarshalSecurityGroupRuleSecurityGroupRuleProtocolTcpudp(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupRuleSecurityGroupRuleProtocolTcpudp) + err = core.UnmarshalPrimitive(m, "direction", &obj.Direction) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "ip_version", &obj.IPVersion) + if err != nil { + return + } + err = core.UnmarshalModel(m, "remote", &obj.Remote, UnmarshalSecurityGroupRuleRemote) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "port_max", &obj.PortMax) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "port_min", &obj.PortMin) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "protocol", &obj.Protocol) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupTargetReferenceBareMetalServerNetworkInterfaceReferenceTargetContext : SecurityGroupTargetReferenceBareMetalServerNetworkInterfaceReferenceTargetContext struct +// This model "extends" SecurityGroupTargetReference +type SecurityGroupTargetReferenceBareMetalServerNetworkInterfaceReferenceTargetContext struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *BareMetalServerNetworkInterfaceReferenceTargetContextDeleted `json:"deleted,omitempty"` + + // The URL for this bare metal server network interface. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this bare metal server network interface. + ID *string `json:"id" validate:"required"` + + // The name for this bare metal server network interface. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the SecurityGroupTargetReferenceBareMetalServerNetworkInterfaceReferenceTargetContext.ResourceType property. +// The resource type. +const ( + SecurityGroupTargetReferenceBareMetalServerNetworkInterfaceReferenceTargetContextResourceTypeNetworkInterfaceConst = "network_interface" +) + +func (*SecurityGroupTargetReferenceBareMetalServerNetworkInterfaceReferenceTargetContext) isaSecurityGroupTargetReference() bool { + return true +} + +// UnmarshalSecurityGroupTargetReferenceBareMetalServerNetworkInterfaceReferenceTargetContext unmarshals an instance of SecurityGroupTargetReferenceBareMetalServerNetworkInterfaceReferenceTargetContext from the specified map of raw messages. +func UnmarshalSecurityGroupTargetReferenceBareMetalServerNetworkInterfaceReferenceTargetContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupTargetReferenceBareMetalServerNetworkInterfaceReferenceTargetContext) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalBareMetalServerNetworkInterfaceReferenceTargetContextDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupTargetReferenceEndpointGatewayReference : SecurityGroupTargetReferenceEndpointGatewayReference struct +// This model "extends" SecurityGroupTargetReference +type SecurityGroupTargetReferenceEndpointGatewayReference struct { + // The CRN for this endpoint gateway. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *EndpointGatewayReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this endpoint gateway. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this endpoint gateway. + ID *string `json:"id" validate:"required"` + + // The name for this endpoint gateway. The name is unique across all endpoint gateways in the VPC. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the SecurityGroupTargetReferenceEndpointGatewayReference.ResourceType property. +// The resource type. +const ( + SecurityGroupTargetReferenceEndpointGatewayReferenceResourceTypeEndpointGatewayConst = "endpoint_gateway" +) + +func (*SecurityGroupTargetReferenceEndpointGatewayReference) isaSecurityGroupTargetReference() bool { + return true +} + +// UnmarshalSecurityGroupTargetReferenceEndpointGatewayReference unmarshals an instance of SecurityGroupTargetReferenceEndpointGatewayReference from the specified map of raw messages. +func UnmarshalSecurityGroupTargetReferenceEndpointGatewayReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupTargetReferenceEndpointGatewayReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalEndpointGatewayReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupTargetReferenceLoadBalancerReference : SecurityGroupTargetReferenceLoadBalancerReference struct +// This model "extends" SecurityGroupTargetReference +type SecurityGroupTargetReferenceLoadBalancerReference struct { + // The load balancer's CRN. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *LoadBalancerReferenceDeleted `json:"deleted,omitempty"` + + // The load balancer's canonical URL. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this load balancer. + ID *string `json:"id" validate:"required"` + + // The name for this load balancer. The name is unique across all load balancers in the VPC. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the SecurityGroupTargetReferenceLoadBalancerReference.ResourceType property. +// The resource type. +const ( + SecurityGroupTargetReferenceLoadBalancerReferenceResourceTypeLoadBalancerConst = "load_balancer" +) + +func (*SecurityGroupTargetReferenceLoadBalancerReference) isaSecurityGroupTargetReference() bool { + return true +} + +// UnmarshalSecurityGroupTargetReferenceLoadBalancerReference unmarshals an instance of SecurityGroupTargetReferenceLoadBalancerReference from the specified map of raw messages. +func UnmarshalSecurityGroupTargetReferenceLoadBalancerReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupTargetReferenceLoadBalancerReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalLoadBalancerReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupTargetReferenceNetworkInterfaceReferenceTargetContext : SecurityGroupTargetReferenceNetworkInterfaceReferenceTargetContext struct +// This model "extends" SecurityGroupTargetReference +type SecurityGroupTargetReferenceNetworkInterfaceReferenceTargetContext struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *NetworkInterfaceReferenceTargetContextDeleted `json:"deleted,omitempty"` + + // The URL for this instance network interface. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this instance network interface. + ID *string `json:"id" validate:"required"` + + // The name for this instance network interface. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the SecurityGroupTargetReferenceNetworkInterfaceReferenceTargetContext.ResourceType property. +// The resource type. +const ( + SecurityGroupTargetReferenceNetworkInterfaceReferenceTargetContextResourceTypeNetworkInterfaceConst = "network_interface" +) + +func (*SecurityGroupTargetReferenceNetworkInterfaceReferenceTargetContext) isaSecurityGroupTargetReference() bool { + return true +} + +// UnmarshalSecurityGroupTargetReferenceNetworkInterfaceReferenceTargetContext unmarshals an instance of SecurityGroupTargetReferenceNetworkInterfaceReferenceTargetContext from the specified map of raw messages. +func UnmarshalSecurityGroupTargetReferenceNetworkInterfaceReferenceTargetContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupTargetReferenceNetworkInterfaceReferenceTargetContext) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalNetworkInterfaceReferenceTargetContextDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupTargetReferenceVPNServerReference : SecurityGroupTargetReferenceVPNServerReference struct +// This model "extends" SecurityGroupTargetReference +type SecurityGroupTargetReferenceVPNServerReference struct { + // The CRN for this VPN server. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *VPNServerReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this VPN server. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this VPN server. + ID *string `json:"id" validate:"required"` + + // The name for this VPN server. The name is unique across all VPN servers in the VPC. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the SecurityGroupTargetReferenceVPNServerReference.ResourceType property. +// The resource type. +const ( + SecurityGroupTargetReferenceVPNServerReferenceResourceTypeVPNServerConst = "vpn_server" +) + +func (*SecurityGroupTargetReferenceVPNServerReference) isaSecurityGroupTargetReference() bool { + return true +} + +// UnmarshalSecurityGroupTargetReferenceVPNServerReference unmarshals an instance of SecurityGroupTargetReferenceVPNServerReference from the specified map of raw messages. +func UnmarshalSecurityGroupTargetReferenceVPNServerReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupTargetReferenceVPNServerReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalVPNServerReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupTargetReferenceVirtualNetworkInterfaceReference : SecurityGroupTargetReferenceVirtualNetworkInterfaceReference struct +// This model "extends" SecurityGroupTargetReference +type SecurityGroupTargetReferenceVirtualNetworkInterfaceReference struct { + // The CRN for this virtual network interface. + CRN *string `json:"crn" validate:"required"` + + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *VirtualNetworkInterfaceReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this virtual network interface. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this virtual network interface. + ID *string `json:"id" validate:"required"` + + // The name for this virtual network interface. The name is unique across all virtual network interfaces in the VPC. + Name *string `json:"name" validate:"required"` + + // The primary IP for this virtual network interface. + PrimaryIP *ReservedIPReference `json:"primary_ip" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The associated subnet. + Subnet *SubnetReference `json:"subnet" validate:"required"` +} + +// Constants associated with the SecurityGroupTargetReferenceVirtualNetworkInterfaceReference.ResourceType property. +// The resource type. +const ( + SecurityGroupTargetReferenceVirtualNetworkInterfaceReferenceResourceTypeVirtualNetworkInterfaceConst = "virtual_network_interface" +) + +func (*SecurityGroupTargetReferenceVirtualNetworkInterfaceReference) isaSecurityGroupTargetReference() bool { + return true +} + +// UnmarshalSecurityGroupTargetReferenceVirtualNetworkInterfaceReference unmarshals an instance of SecurityGroupTargetReferenceVirtualNetworkInterfaceReference from the specified map of raw messages. +func UnmarshalSecurityGroupTargetReferenceVirtualNetworkInterfaceReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupTargetReferenceVirtualNetworkInterfaceReference) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalVirtualNetworkInterfaceReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_ip", &obj.PrimaryIP, UnmarshalReservedIPReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnet", &obj.Subnet, UnmarshalSubnetReference) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareIdentityByCRN : ShareIdentityByCRN struct +// This model "extends" ShareIdentity +type ShareIdentityByCRN struct { + // The CRN for this file share. + CRN *string `json:"crn" validate:"required"` +} + +// NewShareIdentityByCRN : Instantiate ShareIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewShareIdentityByCRN(crn string) (_model *ShareIdentityByCRN, err error) { + _model = &ShareIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*ShareIdentityByCRN) isaShareIdentity() bool { + return true +} + +// UnmarshalShareIdentityByCRN unmarshals an instance of ShareIdentityByCRN from the specified map of raw messages. +func UnmarshalShareIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareIdentityByHref : ShareIdentityByHref struct +// This model "extends" ShareIdentity +type ShareIdentityByHref struct { + // The URL for this file share. + Href *string `json:"href" validate:"required"` +} + +// NewShareIdentityByHref : Instantiate ShareIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewShareIdentityByHref(href string) (_model *ShareIdentityByHref, err error) { + _model = &ShareIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*ShareIdentityByHref) isaShareIdentity() bool { + return true +} + +// UnmarshalShareIdentityByHref unmarshals an instance of ShareIdentityByHref from the specified map of raw messages. +func UnmarshalShareIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareIdentityByID : ShareIdentityByID struct +// This model "extends" ShareIdentity +type ShareIdentityByID struct { + // The unique identifier for this file share. + ID *string `json:"id" validate:"required"` +} + +// NewShareIdentityByID : Instantiate ShareIdentityByID (Generic Model Constructor) +func (*VpcV1) NewShareIdentityByID(id string) (_model *ShareIdentityByID, err error) { + _model = &ShareIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*ShareIdentityByID) isaShareIdentity() bool { + return true +} + +// UnmarshalShareIdentityByID unmarshals an instance of ShareIdentityByID from the specified map of raw messages. +func UnmarshalShareIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareMountTargetPrototypeShareMountTargetByAccessControlModeSecurityGroup : The virtual network interface for this share mount target. The virtual network interface's VPC must not be used by a +// virtual network interface for another mount target for this share. +// +// Required if the share's `access_control_mode` is `security_group`. +// This model "extends" ShareMountTargetPrototype +type ShareMountTargetPrototypeShareMountTargetByAccessControlModeSecurityGroup struct { + // The name for this share mount target. The name must not be used by another mount target for the file share. + Name *string `json:"name,omitempty"` + + // The transit encryption mode to use for this share mount target: + // - `none`: Not encrypted in transit. + // - `user_managed`: Encrypted in transit using an instance identity certificate. The + // `access_control_mode` for the share must be `security_group`. + TransitEncryption *string `json:"transit_encryption,omitempty"` + + VirtualNetworkInterface ShareMountTargetVirtualNetworkInterfacePrototypeIntf `json:"virtual_network_interface" validate:"required"` +} + +// Constants associated with the ShareMountTargetPrototypeShareMountTargetByAccessControlModeSecurityGroup.TransitEncryption property. +// The transit encryption mode to use for this share mount target: +// - `none`: Not encrypted in transit. +// - `user_managed`: Encrypted in transit using an instance identity certificate. The +// `access_control_mode` for the share must be `security_group`. +const ( + ShareMountTargetPrototypeShareMountTargetByAccessControlModeSecurityGroupTransitEncryptionNoneConst = "none" + ShareMountTargetPrototypeShareMountTargetByAccessControlModeSecurityGroupTransitEncryptionUserManagedConst = "user_managed" +) + +// NewShareMountTargetPrototypeShareMountTargetByAccessControlModeSecurityGroup : Instantiate ShareMountTargetPrototypeShareMountTargetByAccessControlModeSecurityGroup (Generic Model Constructor) +func (*VpcV1) NewShareMountTargetPrototypeShareMountTargetByAccessControlModeSecurityGroup(virtualNetworkInterface ShareMountTargetVirtualNetworkInterfacePrototypeIntf) (_model *ShareMountTargetPrototypeShareMountTargetByAccessControlModeSecurityGroup, err error) { + _model = &ShareMountTargetPrototypeShareMountTargetByAccessControlModeSecurityGroup{ + VirtualNetworkInterface: virtualNetworkInterface, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*ShareMountTargetPrototypeShareMountTargetByAccessControlModeSecurityGroup) isaShareMountTargetPrototype() bool { + return true +} + +// UnmarshalShareMountTargetPrototypeShareMountTargetByAccessControlModeSecurityGroup unmarshals an instance of ShareMountTargetPrototypeShareMountTargetByAccessControlModeSecurityGroup from the specified map of raw messages. +func UnmarshalShareMountTargetPrototypeShareMountTargetByAccessControlModeSecurityGroup(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareMountTargetPrototypeShareMountTargetByAccessControlModeSecurityGroup) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "transit_encryption", &obj.TransitEncryption) + if err != nil { + return + } + err = core.UnmarshalModel(m, "virtual_network_interface", &obj.VirtualNetworkInterface, UnmarshalShareMountTargetVirtualNetworkInterfacePrototype) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareMountTargetPrototypeShareMountTargetByAccessControlModeVPC : The VPC in which clients can mount the file share using this mount target. The VPC must not be used by another mount +// target for this share. +// +// Required if the share's `access_control_mode` is `vpc`. +// This model "extends" ShareMountTargetPrototype +type ShareMountTargetPrototypeShareMountTargetByAccessControlModeVPC struct { + // The name for this share mount target. The name must not be used by another mount target for the file share. + Name *string `json:"name,omitempty"` + + // The transit encryption mode to use for this share mount target: + // - `none`: Not encrypted in transit. + // - `user_managed`: Encrypted in transit using an instance identity certificate. The + // `access_control_mode` for the share must be `security_group`. + TransitEncryption *string `json:"transit_encryption,omitempty"` + + // Identifies a VPC by a unique property. + VPC VPCIdentityIntf `json:"vpc" validate:"required"` +} + +// Constants associated with the ShareMountTargetPrototypeShareMountTargetByAccessControlModeVPC.TransitEncryption property. +// The transit encryption mode to use for this share mount target: +// - `none`: Not encrypted in transit. +// - `user_managed`: Encrypted in transit using an instance identity certificate. The +// `access_control_mode` for the share must be `security_group`. +const ( + ShareMountTargetPrototypeShareMountTargetByAccessControlModeVPCTransitEncryptionNoneConst = "none" + ShareMountTargetPrototypeShareMountTargetByAccessControlModeVPCTransitEncryptionUserManagedConst = "user_managed" +) + +// NewShareMountTargetPrototypeShareMountTargetByAccessControlModeVPC : Instantiate ShareMountTargetPrototypeShareMountTargetByAccessControlModeVPC (Generic Model Constructor) +func (*VpcV1) NewShareMountTargetPrototypeShareMountTargetByAccessControlModeVPC(vpc VPCIdentityIntf) (_model *ShareMountTargetPrototypeShareMountTargetByAccessControlModeVPC, err error) { + _model = &ShareMountTargetPrototypeShareMountTargetByAccessControlModeVPC{ + VPC: vpc, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*ShareMountTargetPrototypeShareMountTargetByAccessControlModeVPC) isaShareMountTargetPrototype() bool { + return true +} + +// UnmarshalShareMountTargetPrototypeShareMountTargetByAccessControlModeVPC unmarshals an instance of ShareMountTargetPrototypeShareMountTargetByAccessControlModeVPC from the specified map of raw messages. +func UnmarshalShareMountTargetPrototypeShareMountTargetByAccessControlModeVPC(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareMountTargetPrototypeShareMountTargetByAccessControlModeVPC) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "transit_encryption", &obj.TransitEncryption) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareMountTargetVirtualNetworkInterfacePrototypeVirtualNetworkInterfacePrototypeShareMountTargetContext : The virtual network interface for this target. +// This model "extends" ShareMountTargetVirtualNetworkInterfacePrototype +type ShareMountTargetVirtualNetworkInterfacePrototypeVirtualNetworkInterfacePrototypeShareMountTargetContext struct { + // The name for this virtual network interface. The name must not be used by another virtual network interface in the + // VPC. If unspecified, the name will be a hyphenated list of randomly-selected words. Names beginning with `ibm-` are + // reserved for provider-owned resources, and are not allowed. + Name *string `json:"name,omitempty"` + + // The primary IP address to bind to the virtual network interface. May be either a + // reserved IP identity, or a reserved IP prototype object which will be used to create a + // new reserved IP. + // + // If a reserved IP identity is provided, the specified reserved IP must be unbound. + // + // If a reserved IP prototype object with an address is provided, the address must be + // available on the virtual network interface's subnet. If no address is specified, + // an available address on the subnet will be automatically selected and reserved. + PrimaryIP VirtualNetworkInterfacePrimaryIPPrototypeIntf `json:"primary_ip,omitempty"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The security groups to use for this virtual network interface. If unspecified, the default security group of the VPC + // for the subnet is used. + SecurityGroups []SecurityGroupIdentityIntf `json:"security_groups,omitempty"` + + // The associated subnet. Required if `primary_ip` does not specify a reserved IP and + // `primary_ip.address` is not specified. + Subnet SubnetIdentityIntf `json:"subnet,omitempty"` +} + +func (*ShareMountTargetVirtualNetworkInterfacePrototypeVirtualNetworkInterfacePrototypeShareMountTargetContext) isaShareMountTargetVirtualNetworkInterfacePrototype() bool { + return true +} + +// UnmarshalShareMountTargetVirtualNetworkInterfacePrototypeVirtualNetworkInterfacePrototypeShareMountTargetContext unmarshals an instance of ShareMountTargetVirtualNetworkInterfacePrototypeVirtualNetworkInterfacePrototypeShareMountTargetContext from the specified map of raw messages. +func UnmarshalShareMountTargetVirtualNetworkInterfacePrototypeVirtualNetworkInterfacePrototypeShareMountTargetContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareMountTargetVirtualNetworkInterfacePrototypeVirtualNetworkInterfacePrototypeShareMountTargetContext) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "primary_ip", &obj.PrimaryIP, UnmarshalVirtualNetworkInterfacePrimaryIPPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "security_groups", &obj.SecurityGroups, UnmarshalSecurityGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnet", &obj.Subnet, UnmarshalSubnetIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareProfileCapacityDependentRange : The permitted total capacity (in gigabytes) of a share with this profile depends on its configuration. +// This model "extends" ShareProfileCapacity +type ShareProfileCapacityDependentRange struct { + // The maximum value for this profile field. + Max *int64 `json:"max" validate:"required"` + + // The minimum value for this profile field. + Min *int64 `json:"min" validate:"required"` + + // The increment step value for this profile field. + Step *int64 `json:"step" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the ShareProfileCapacityDependentRange.Type property. +// The type for this profile field. +const ( + ShareProfileCapacityDependentRangeTypeDependentConst = "dependent" + ShareProfileCapacityDependentRangeTypeDependentRangeConst = "dependent_range" +) + +func (*ShareProfileCapacityDependentRange) isaShareProfileCapacity() bool { + return true +} + +// UnmarshalShareProfileCapacityDependentRange unmarshals an instance of ShareProfileCapacityDependentRange from the specified map of raw messages. +func UnmarshalShareProfileCapacityDependentRange(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareProfileCapacityDependentRange) + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareProfileCapacityEnum : The permitted total capacities (in gigabytes) of a share with this profile. +// This model "extends" ShareProfileCapacity +type ShareProfileCapacityEnum struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The permitted values for this profile field. + Values []int64 `json:"values" validate:"required"` +} + +// Constants associated with the ShareProfileCapacityEnum.Type property. +// The type for this profile field. +const ( + ShareProfileCapacityEnumTypeEnumConst = "enum" +) + +func (*ShareProfileCapacityEnum) isaShareProfileCapacity() bool { + return true +} + +// UnmarshalShareProfileCapacityEnum unmarshals an instance of ShareProfileCapacityEnum from the specified map of raw messages. +func UnmarshalShareProfileCapacityEnum(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareProfileCapacityEnum) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareProfileCapacityFixed : The permitted total capacity (in gigabytes) of a share with this profile is fixed. +// This model "extends" ShareProfileCapacity +type ShareProfileCapacityFixed struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The value for this profile field. + Value *int64 `json:"value" validate:"required"` +} + +// Constants associated with the ShareProfileCapacityFixed.Type property. +// The type for this profile field. +const ( + ShareProfileCapacityFixedTypeFixedConst = "fixed" +) + +func (*ShareProfileCapacityFixed) isaShareProfileCapacity() bool { + return true +} + +// UnmarshalShareProfileCapacityFixed unmarshals an instance of ShareProfileCapacityFixed from the specified map of raw messages. +func UnmarshalShareProfileCapacityFixed(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareProfileCapacityFixed) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareProfileCapacityRange : The permitted total capacity range (in gigabytes) of a share with this profile. +// This model "extends" ShareProfileCapacity +type ShareProfileCapacityRange struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The maximum value for this profile field. + Max *int64 `json:"max" validate:"required"` + + // The minimum value for this profile field. + Min *int64 `json:"min" validate:"required"` + + // The increment step value for this profile field. + Step *int64 `json:"step" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the ShareProfileCapacityRange.Type property. +// The type for this profile field. +const ( + ShareProfileCapacityRangeTypeRangeConst = "range" +) + +func (*ShareProfileCapacityRange) isaShareProfileCapacity() bool { + return true +} + +// UnmarshalShareProfileCapacityRange unmarshals an instance of ShareProfileCapacityRange from the specified map of raw messages. +func UnmarshalShareProfileCapacityRange(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareProfileCapacityRange) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareProfileIopsDependentRange : The permitted IOPS range of a share with this profile depends on its configuration. +// This model "extends" ShareProfileIops +type ShareProfileIopsDependentRange struct { + // The maximum value for this profile field. + Max *int64 `json:"max" validate:"required"` + + // The minimum value for this profile field. + Min *int64 `json:"min" validate:"required"` + + // The increment step value for this profile field. + Step *int64 `json:"step" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the ShareProfileIopsDependentRange.Type property. +// The type for this profile field. +const ( + ShareProfileIopsDependentRangeTypeDependentConst = "dependent" + ShareProfileIopsDependentRangeTypeDependentRangeConst = "dependent_range" +) + +func (*ShareProfileIopsDependentRange) isaShareProfileIops() bool { + return true +} + +// UnmarshalShareProfileIopsDependentRange unmarshals an instance of ShareProfileIopsDependentRange from the specified map of raw messages. +func UnmarshalShareProfileIopsDependentRange(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareProfileIopsDependentRange) + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareProfileIopsEnum : The permitted IOPS values of a share with this profile. +// This model "extends" ShareProfileIops +type ShareProfileIopsEnum struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The permitted values for this profile field. + Values []int64 `json:"values" validate:"required"` +} + +// Constants associated with the ShareProfileIopsEnum.Type property. +// The type for this profile field. +const ( + ShareProfileIopsEnumTypeEnumConst = "enum" +) + +func (*ShareProfileIopsEnum) isaShareProfileIops() bool { + return true +} + +// UnmarshalShareProfileIopsEnum unmarshals an instance of ShareProfileIopsEnum from the specified map of raw messages. +func UnmarshalShareProfileIopsEnum(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareProfileIopsEnum) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "values", &obj.Values) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareProfileIopsFixed : The permitted IOPS of a share with this profile is fixed. +// This model "extends" ShareProfileIops +type ShareProfileIopsFixed struct { + // The type for this profile field. + Type *string `json:"type" validate:"required"` + + // The value for this profile field. + Value *int64 `json:"value" validate:"required"` +} + +// Constants associated with the ShareProfileIopsFixed.Type property. +// The type for this profile field. +const ( + ShareProfileIopsFixedTypeFixedConst = "fixed" +) + +func (*ShareProfileIopsFixed) isaShareProfileIops() bool { + return true +} + +// UnmarshalShareProfileIopsFixed unmarshals an instance of ShareProfileIopsFixed from the specified map of raw messages. +func UnmarshalShareProfileIopsFixed(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareProfileIopsFixed) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "value", &obj.Value) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareProfileIopsRange : The permitted IOPS range of a share with this profile. +// This model "extends" ShareProfileIops +type ShareProfileIopsRange struct { + // The default value for this profile field. + Default *int64 `json:"default" validate:"required"` + + // The maximum value for this profile field. + Max *int64 `json:"max" validate:"required"` + + // The minimum value for this profile field. + Min *int64 `json:"min" validate:"required"` + + // The increment step value for this profile field. + Step *int64 `json:"step" validate:"required"` + + // The type for this profile field. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the ShareProfileIopsRange.Type property. +// The type for this profile field. +const ( + ShareProfileIopsRangeTypeRangeConst = "range" +) + +func (*ShareProfileIopsRange) isaShareProfileIops() bool { + return true +} + +// UnmarshalShareProfileIopsRange unmarshals an instance of ShareProfileIopsRange from the specified map of raw messages. +func UnmarshalShareProfileIopsRange(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareProfileIopsRange) + err = core.UnmarshalPrimitive(m, "default", &obj.Default) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "max", &obj.Max) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min", &obj.Min) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "step", &obj.Step) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareProfileIdentityByHref : ShareProfileIdentityByHref struct +// This model "extends" ShareProfileIdentity +type ShareProfileIdentityByHref struct { + // The URL for this share profile. + Href *string `json:"href" validate:"required"` +} + +// NewShareProfileIdentityByHref : Instantiate ShareProfileIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewShareProfileIdentityByHref(href string) (_model *ShareProfileIdentityByHref, err error) { + _model = &ShareProfileIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*ShareProfileIdentityByHref) isaShareProfileIdentity() bool { + return true +} + +// UnmarshalShareProfileIdentityByHref unmarshals an instance of ShareProfileIdentityByHref from the specified map of raw messages. +func UnmarshalShareProfileIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareProfileIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ShareProfileIdentityByName : ShareProfileIdentityByName struct +// This model "extends" ShareProfileIdentity +type ShareProfileIdentityByName struct { + // The globally unique name for this share profile. + Name *string `json:"name" validate:"required"` +} + +// NewShareProfileIdentityByName : Instantiate ShareProfileIdentityByName (Generic Model Constructor) +func (*VpcV1) NewShareProfileIdentityByName(name string) (_model *ShareProfileIdentityByName, err error) { + _model = &ShareProfileIdentityByName{ + Name: core.StringPtr(name), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*ShareProfileIdentityByName) isaShareProfileIdentity() bool { + return true +} + +// UnmarshalShareProfileIdentityByName unmarshals an instance of ShareProfileIdentityByName from the specified map of raw messages. +func UnmarshalShareProfileIdentityByName(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ShareProfileIdentityByName) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SharePrototypeShareBySize : Create a file share by size. +// This model "extends" SharePrototype +type SharePrototypeShareBySize struct { + // The maximum input/output operations per second (IOPS) for the file share. The share must be in the + // `defined_performance` profile family, and the value must be in the range supported by the share's specified size. + // + // In addition, each client accessing the share will be restricted to 48,000 IOPS. + Iops *int64 `json:"iops,omitempty"` + + // The mount targets for the file share. Each mount target must be in a unique VPC. + MountTargets []ShareMountTargetPrototypeIntf `json:"mount_targets,omitempty"` + + // The name for this share. The name must not be used by another share in the region. If unspecified, the name will be + // a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-file-storage-profiles) to use for this file share. The + // profile must support the share's specified IOPS and size. + Profile ShareProfileIdentityIntf `json:"profile" validate:"required"` + + ReplicaShare *SharePrototypeShareContext `json:"replica_share,omitempty"` + + // Tags for this resource. + UserTags []string `json:"user_tags,omitempty"` + + // The zone this file share will reside in. For a replica share, this must be a different zone in the same region as + // the source share. + Zone ZoneIdentityIntf `json:"zone" validate:"required"` + + // The access control mode for the share: + // + // - `security_group`: The security groups on the virtual network interface for a + // mount target control access to the mount target. Mount targets for this share + // require a virtual network interface. + // - `vpc`: All clients in the VPC for a mount target have access to the mount target. + // Mount targets for this share require a VPC. + AccessControlMode *string `json:"access_control_mode,omitempty"` + + // The root key to use to wrap the data encryption key for the share. + // + // If unspecified, the `encryption` type for the share will be `provider_managed`. + // + // The specified key may be in a different account, subject to IAM policies. + EncryptionKey EncryptionKeyIdentityIntf `json:"encryption_key,omitempty"` + + // The owner assigned to the file share at creation. Subsequent changes to the owner + // must be performed by a client that has mounted the file share. + InitialOwner *ShareInitialOwner `json:"initial_owner,omitempty"` + + // The resource group to use. If unspecified, the account's [default resource + // group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The size of the file share rounded up to the next gigabyte. + // + // The maximum size for a share may increase in the future. + Size *int64 `json:"size" validate:"required"` +} + +// Constants associated with the SharePrototypeShareBySize.AccessControlMode property. +// The access control mode for the share: +// +// - `security_group`: The security groups on the virtual network interface for a +// mount target control access to the mount target. Mount targets for this share +// require a virtual network interface. +// - `vpc`: All clients in the VPC for a mount target have access to the mount target. +// Mount targets for this share require a VPC. +const ( + SharePrototypeShareBySizeAccessControlModeSecurityGroupConst = "security_group" + SharePrototypeShareBySizeAccessControlModeVPCConst = "vpc" +) + +// NewSharePrototypeShareBySize : Instantiate SharePrototypeShareBySize (Generic Model Constructor) +func (*VpcV1) NewSharePrototypeShareBySize(profile ShareProfileIdentityIntf, zone ZoneIdentityIntf, size int64) (_model *SharePrototypeShareBySize, err error) { + _model = &SharePrototypeShareBySize{ + Profile: profile, + Zone: zone, + Size: core.Int64Ptr(size), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SharePrototypeShareBySize) isaSharePrototype() bool { + return true +} + +// UnmarshalSharePrototypeShareBySize unmarshals an instance of SharePrototypeShareBySize from the specified map of raw messages. +func UnmarshalSharePrototypeShareBySize(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SharePrototypeShareBySize) + err = core.UnmarshalPrimitive(m, "iops", &obj.Iops) + if err != nil { + return + } + err = core.UnmarshalModel(m, "mount_targets", &obj.MountTargets, UnmarshalShareMountTargetPrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalShareProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "replica_share", &obj.ReplicaShare, UnmarshalSharePrototypeShareContext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_tags", &obj.UserTags) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "access_control_mode", &obj.AccessControlMode) + if err != nil { + return + } + err = core.UnmarshalModel(m, "encryption_key", &obj.EncryptionKey, UnmarshalEncryptionKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "initial_owner", &obj.InitialOwner, UnmarshalShareInitialOwner) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "size", &obj.Size) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SharePrototypeShareBySourceShare : Create a replica file share for an existing file share. The values for `access_control_mode`, +// `encryption_key`, `initial_owner`, and `size` will be inherited from `source_share`. +// This model "extends" SharePrototype +type SharePrototypeShareBySourceShare struct { + // The maximum input/output operations per second (IOPS) for the file share. The share must be in the + // `defined_performance` profile family, and the value must be in the range supported by the share's specified size. + // + // In addition, each client accessing the share will be restricted to 48,000 IOPS. + Iops *int64 `json:"iops,omitempty"` + + // The mount targets for the file share. Each mount target must be in a unique VPC. + MountTargets []ShareMountTargetPrototypeIntf `json:"mount_targets,omitempty"` + + // The name for this share. The name must not be used by another share in the region. If unspecified, the name will be + // a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-file-storage-profiles) to use for this file share. The + // profile must support the share's specified IOPS and size. + Profile ShareProfileIdentityIntf `json:"profile" validate:"required"` + + ReplicaShare *SharePrototypeShareContext `json:"replica_share,omitempty"` + + // Tags for this resource. + UserTags []string `json:"user_tags,omitempty"` + + // The zone this file share will reside in. For a replica share, this must be a different zone in the same region as + // the source share. + Zone ZoneIdentityIntf `json:"zone" validate:"required"` + + // The cron specification for the file share replication schedule. + // + // Replication of a share can be scheduled to occur at most once per hour. + ReplicationCronSpec *string `json:"replication_cron_spec" validate:"required"` + + // The resource group to use. If unspecified, the resource group from + // the source share will be used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The source file share for this replica file share. The specified file share must not + // already have a replica, and must not be a replica. + SourceShare ShareIdentityIntf `json:"source_share" validate:"required"` +} + +// NewSharePrototypeShareBySourceShare : Instantiate SharePrototypeShareBySourceShare (Generic Model Constructor) +func (*VpcV1) NewSharePrototypeShareBySourceShare(profile ShareProfileIdentityIntf, zone ZoneIdentityIntf, replicationCronSpec string, sourceShare ShareIdentityIntf) (_model *SharePrototypeShareBySourceShare, err error) { + _model = &SharePrototypeShareBySourceShare{ + Profile: profile, + Zone: zone, + ReplicationCronSpec: core.StringPtr(replicationCronSpec), + SourceShare: sourceShare, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SharePrototypeShareBySourceShare) isaSharePrototype() bool { + return true +} + +// UnmarshalSharePrototypeShareBySourceShare unmarshals an instance of SharePrototypeShareBySourceShare from the specified map of raw messages. +func UnmarshalSharePrototypeShareBySourceShare(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SharePrototypeShareBySourceShare) + err = core.UnmarshalPrimitive(m, "iops", &obj.Iops) + if err != nil { + return + } + err = core.UnmarshalModel(m, "mount_targets", &obj.MountTargets, UnmarshalShareMountTargetPrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalShareProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "replica_share", &obj.ReplicaShare, UnmarshalSharePrototypeShareContext) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_tags", &obj.UserTags) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "replication_cron_spec", &obj.ReplicationCronSpec) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "source_share", &obj.SourceShare, UnmarshalShareIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SnapshotIdentityByCRN : SnapshotIdentityByCRN struct +// This model "extends" SnapshotIdentity +type SnapshotIdentityByCRN struct { + // The CRN of this snapshot. + CRN *string `json:"crn" validate:"required"` +} + +// NewSnapshotIdentityByCRN : Instantiate SnapshotIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewSnapshotIdentityByCRN(crn string) (_model *SnapshotIdentityByCRN, err error) { + _model = &SnapshotIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SnapshotIdentityByCRN) isaSnapshotIdentity() bool { + return true +} + +// UnmarshalSnapshotIdentityByCRN unmarshals an instance of SnapshotIdentityByCRN from the specified map of raw messages. +func UnmarshalSnapshotIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SnapshotIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SnapshotIdentityByHref : SnapshotIdentityByHref struct +// This model "extends" SnapshotIdentity +type SnapshotIdentityByHref struct { + // The URL for this snapshot. + Href *string `json:"href" validate:"required"` +} + +// NewSnapshotIdentityByHref : Instantiate SnapshotIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewSnapshotIdentityByHref(href string) (_model *SnapshotIdentityByHref, err error) { + _model = &SnapshotIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SnapshotIdentityByHref) isaSnapshotIdentity() bool { + return true +} + +// UnmarshalSnapshotIdentityByHref unmarshals an instance of SnapshotIdentityByHref from the specified map of raw messages. +func UnmarshalSnapshotIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SnapshotIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SnapshotIdentityByID : SnapshotIdentityByID struct +// This model "extends" SnapshotIdentity +type SnapshotIdentityByID struct { + // The unique identifier for this snapshot. + ID *string `json:"id" validate:"required"` +} + +// NewSnapshotIdentityByID : Instantiate SnapshotIdentityByID (Generic Model Constructor) +func (*VpcV1) NewSnapshotIdentityByID(id string) (_model *SnapshotIdentityByID, err error) { + _model = &SnapshotIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SnapshotIdentityByID) isaSnapshotIdentity() bool { + return true +} + +// UnmarshalSnapshotIdentityByID unmarshals an instance of SnapshotIdentityByID from the specified map of raw messages. +func UnmarshalSnapshotIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SnapshotIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SnapshotPrototypeSnapshotBySourceSnapshot : SnapshotPrototypeSnapshotBySourceSnapshot struct +// This model "extends" SnapshotPrototype +type SnapshotPrototypeSnapshotBySourceSnapshot struct { + // Clones to create for this snapshot. + Clones []SnapshotClonePrototype `json:"clones,omitempty"` + + // The name for this snapshot. The name must not be used by another snapshot in the region. If unspecified, the name + // will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The [user tags](https://cloud.ibm.com/apidocs/tagging#types-of-tags) associated with this snapshot. + UserTags []string `json:"user_tags,omitempty"` + + // The root key to use to wrap the data encryption key for this snapshot. + // + // A key must be specified if and only if the source snapshot has an `encryption` type of + // `user_managed`. To maximize snapshot availability and sharing of snapshot data, specify + // a key in the same region as the new snapshot, and use the same encryption key for all + // snapshots using the same source volume. + // + // The specified key may be in a different account, subject to IAM policies. + EncryptionKey EncryptionKeyIdentityIntf `json:"encryption_key,omitempty"` + + // The source snapshot (in another region) to create this snapshot from. + // The specified snapshot must not already be the source of another snapshot in this + // region. + SourceSnapshot *SnapshotIdentityByCRN `json:"source_snapshot" validate:"required"` +} + +// NewSnapshotPrototypeSnapshotBySourceSnapshot : Instantiate SnapshotPrototypeSnapshotBySourceSnapshot (Generic Model Constructor) +func (*VpcV1) NewSnapshotPrototypeSnapshotBySourceSnapshot(sourceSnapshot *SnapshotIdentityByCRN) (_model *SnapshotPrototypeSnapshotBySourceSnapshot, err error) { + _model = &SnapshotPrototypeSnapshotBySourceSnapshot{ + SourceSnapshot: sourceSnapshot, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SnapshotPrototypeSnapshotBySourceSnapshot) isaSnapshotPrototype() bool { + return true +} + +// UnmarshalSnapshotPrototypeSnapshotBySourceSnapshot unmarshals an instance of SnapshotPrototypeSnapshotBySourceSnapshot from the specified map of raw messages. +func UnmarshalSnapshotPrototypeSnapshotBySourceSnapshot(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SnapshotPrototypeSnapshotBySourceSnapshot) + err = core.UnmarshalModel(m, "clones", &obj.Clones, UnmarshalSnapshotClonePrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_tags", &obj.UserTags) + if err != nil { + return + } + err = core.UnmarshalModel(m, "encryption_key", &obj.EncryptionKey, UnmarshalEncryptionKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "source_snapshot", &obj.SourceSnapshot, UnmarshalSnapshotIdentityByCRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SnapshotPrototypeSnapshotBySourceVolume : SnapshotPrototypeSnapshotBySourceVolume struct +// This model "extends" SnapshotPrototype +type SnapshotPrototypeSnapshotBySourceVolume struct { + // Clones to create for this snapshot. + Clones []SnapshotClonePrototype `json:"clones,omitempty"` + + // The name for this snapshot. The name must not be used by another snapshot in the region. If unspecified, the name + // will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The [user tags](https://cloud.ibm.com/apidocs/tagging#types-of-tags) associated with this snapshot. + UserTags []string `json:"user_tags,omitempty"` + + // The volume to create this snapshot from. + SourceVolume VolumeIdentityIntf `json:"source_volume" validate:"required"` +} + +// NewSnapshotPrototypeSnapshotBySourceVolume : Instantiate SnapshotPrototypeSnapshotBySourceVolume (Generic Model Constructor) +func (*VpcV1) NewSnapshotPrototypeSnapshotBySourceVolume(sourceVolume VolumeIdentityIntf) (_model *SnapshotPrototypeSnapshotBySourceVolume, err error) { + _model = &SnapshotPrototypeSnapshotBySourceVolume{ + SourceVolume: sourceVolume, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SnapshotPrototypeSnapshotBySourceVolume) isaSnapshotPrototype() bool { + return true +} + +// UnmarshalSnapshotPrototypeSnapshotBySourceVolume unmarshals an instance of SnapshotPrototypeSnapshotBySourceVolume from the specified map of raw messages. +func UnmarshalSnapshotPrototypeSnapshotBySourceVolume(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SnapshotPrototypeSnapshotBySourceVolume) + err = core.UnmarshalModel(m, "clones", &obj.Clones, UnmarshalSnapshotClonePrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_tags", &obj.UserTags) + if err != nil { + return + } + err = core.UnmarshalModel(m, "source_volume", &obj.SourceVolume, UnmarshalVolumeIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SubnetIdentityByCRN : SubnetIdentityByCRN struct +// This model "extends" SubnetIdentity +type SubnetIdentityByCRN struct { + // The CRN for this subnet. + CRN *string `json:"crn" validate:"required"` +} + +// NewSubnetIdentityByCRN : Instantiate SubnetIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewSubnetIdentityByCRN(crn string) (_model *SubnetIdentityByCRN, err error) { + _model = &SubnetIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SubnetIdentityByCRN) isaSubnetIdentity() bool { + return true +} + +// UnmarshalSubnetIdentityByCRN unmarshals an instance of SubnetIdentityByCRN from the specified map of raw messages. +func UnmarshalSubnetIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SubnetIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SubnetIdentityByHref : SubnetIdentityByHref struct +// This model "extends" SubnetIdentity +type SubnetIdentityByHref struct { + // The URL for this subnet. + Href *string `json:"href" validate:"required"` +} + +// NewSubnetIdentityByHref : Instantiate SubnetIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewSubnetIdentityByHref(href string) (_model *SubnetIdentityByHref, err error) { + _model = &SubnetIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SubnetIdentityByHref) isaSubnetIdentity() bool { + return true +} + +// UnmarshalSubnetIdentityByHref unmarshals an instance of SubnetIdentityByHref from the specified map of raw messages. +func UnmarshalSubnetIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SubnetIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SubnetIdentityByID : SubnetIdentityByID struct +// This model "extends" SubnetIdentity +type SubnetIdentityByID struct { + // The unique identifier for this subnet. + ID *string `json:"id" validate:"required"` +} + +// NewSubnetIdentityByID : Instantiate SubnetIdentityByID (Generic Model Constructor) +func (*VpcV1) NewSubnetIdentityByID(id string) (_model *SubnetIdentityByID, err error) { + _model = &SubnetIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SubnetIdentityByID) isaSubnetIdentity() bool { + return true +} + +// UnmarshalSubnetIdentityByID unmarshals an instance of SubnetIdentityByID from the specified map of raw messages. +func UnmarshalSubnetIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SubnetIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SubnetPrototypeSubnetByCIDR : SubnetPrototypeSubnetByCIDR struct +// This model "extends" SubnetPrototype +type SubnetPrototypeSubnetByCIDR struct { + // The IP version(s) to support for this subnet. + IPVersion *string `json:"ip_version,omitempty"` + + // The name for this subnet. The name must not be used by another subnet in the VPC. If unspecified, the name will be a + // hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The network ACL to use for this subnet. + NetworkACL NetworkACLIdentityIntf `json:"network_acl,omitempty"` + + // The public gateway to use for internet-bound traffic for this subnet. If unspecified, the subnet will not be + // attached to a public gateway. + PublicGateway PublicGatewayIdentityIntf `json:"public_gateway,omitempty"` + + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The routing table to use for this subnet. If unspecified, the default routing table for the VPC is used. The routing + // table properties `route_direct_link_ingress`, + // `route_internet_ingress`, `route_transit_gateway_ingress`, and + // `route_vpc_zone_ingress` must be `false`. + RoutingTable RoutingTableIdentityIntf `json:"routing_table,omitempty"` + + // The VPC the subnet will reside in. + VPC VPCIdentityIntf `json:"vpc" validate:"required"` + + // The IPv4 range of the subnet, expressed in CIDR format. The prefix length of the subnet's CIDR must be between `/9` + // (8,388,608 addresses) and `/29` (8 addresses). The IPv4 range of the subnet's CIDR must fall within an existing + // address prefix in the VPC and must not overlap with any existing subnet. The subnet will be created in the zone of + // the address prefix that contains the IPv4 CIDR. If zone is specified, it must match the zone of the address prefix + // that contains the subnet's IPv4 CIDR. + Ipv4CIDRBlock *string `json:"ipv4_cidr_block" validate:"required"` + + // The zone this subnet will reside in. + Zone ZoneIdentityIntf `json:"zone,omitempty"` +} + +// Constants associated with the SubnetPrototypeSubnetByCIDR.IPVersion property. +// The IP version(s) to support for this subnet. +const ( + SubnetPrototypeSubnetByCIDRIPVersionIpv4Const = "ipv4" +) + +// NewSubnetPrototypeSubnetByCIDR : Instantiate SubnetPrototypeSubnetByCIDR (Generic Model Constructor) +func (*VpcV1) NewSubnetPrototypeSubnetByCIDR(vpc VPCIdentityIntf, ipv4CIDRBlock string) (_model *SubnetPrototypeSubnetByCIDR, err error) { + _model = &SubnetPrototypeSubnetByCIDR{ + VPC: vpc, + Ipv4CIDRBlock: core.StringPtr(ipv4CIDRBlock), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SubnetPrototypeSubnetByCIDR) isaSubnetPrototype() bool { + return true +} + +// UnmarshalSubnetPrototypeSubnetByCIDR unmarshals an instance of SubnetPrototypeSubnetByCIDR from the specified map of raw messages. +func UnmarshalSubnetPrototypeSubnetByCIDR(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SubnetPrototypeSubnetByCIDR) + err = core.UnmarshalPrimitive(m, "ip_version", &obj.IPVersion) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "network_acl", &obj.NetworkACL, UnmarshalNetworkACLIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "public_gateway", &obj.PublicGateway, UnmarshalPublicGatewayIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "routing_table", &obj.RoutingTable, UnmarshalRoutingTableIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "ipv4_cidr_block", &obj.Ipv4CIDRBlock) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SubnetPrototypeSubnetByTotalCount : SubnetPrototypeSubnetByTotalCount struct +// This model "extends" SubnetPrototype +type SubnetPrototypeSubnetByTotalCount struct { + // The IP version(s) to support for this subnet. + IPVersion *string `json:"ip_version,omitempty"` + + // The name for this subnet. The name must not be used by another subnet in the VPC. If unspecified, the name will be a + // hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The network ACL to use for this subnet. + NetworkACL NetworkACLIdentityIntf `json:"network_acl,omitempty"` + + // The public gateway to use for internet-bound traffic for this subnet. If unspecified, the subnet will not be + // attached to a public gateway. + PublicGateway PublicGatewayIdentityIntf `json:"public_gateway,omitempty"` + + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The routing table to use for this subnet. If unspecified, the default routing table for the VPC is used. The routing + // table properties `route_direct_link_ingress`, + // `route_internet_ingress`, `route_transit_gateway_ingress`, and + // `route_vpc_zone_ingress` must be `false`. + RoutingTable RoutingTableIdentityIntf `json:"routing_table,omitempty"` + + // The VPC the subnet will reside in. + VPC VPCIdentityIntf `json:"vpc" validate:"required"` + + // The total number of IPv4 addresses required. Must be a power of 2. The VPC must have a default address prefix in the + // specified zone, and that prefix must have a free CIDR range with at least this number of addresses. + TotalIpv4AddressCount *int64 `json:"total_ipv4_address_count" validate:"required"` + + // The zone this subnet will reside in. + Zone ZoneIdentityIntf `json:"zone" validate:"required"` +} + +// Constants associated with the SubnetPrototypeSubnetByTotalCount.IPVersion property. +// The IP version(s) to support for this subnet. +const ( + SubnetPrototypeSubnetByTotalCountIPVersionIpv4Const = "ipv4" +) + +// NewSubnetPrototypeSubnetByTotalCount : Instantiate SubnetPrototypeSubnetByTotalCount (Generic Model Constructor) +func (*VpcV1) NewSubnetPrototypeSubnetByTotalCount(vpc VPCIdentityIntf, totalIpv4AddressCount int64, zone ZoneIdentityIntf) (_model *SubnetPrototypeSubnetByTotalCount, err error) { + _model = &SubnetPrototypeSubnetByTotalCount{ + VPC: vpc, + TotalIpv4AddressCount: core.Int64Ptr(totalIpv4AddressCount), + Zone: zone, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SubnetPrototypeSubnetByTotalCount) isaSubnetPrototype() bool { + return true +} + +// UnmarshalSubnetPrototypeSubnetByTotalCount unmarshals an instance of SubnetPrototypeSubnetByTotalCount from the specified map of raw messages. +func UnmarshalSubnetPrototypeSubnetByTotalCount(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SubnetPrototypeSubnetByTotalCount) + err = core.UnmarshalPrimitive(m, "ip_version", &obj.IPVersion) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "network_acl", &obj.NetworkACL, UnmarshalNetworkACLIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "public_gateway", &obj.PublicGateway, UnmarshalPublicGatewayIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "routing_table", &obj.RoutingTable, UnmarshalRoutingTableIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "total_ipv4_address_count", &obj.TotalIpv4AddressCount) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SubnetPublicGatewayPatchPublicGatewayIdentityByCRN : SubnetPublicGatewayPatchPublicGatewayIdentityByCRN struct +// This model "extends" SubnetPublicGatewayPatch +type SubnetPublicGatewayPatchPublicGatewayIdentityByCRN struct { + // The CRN for this public gateway. + CRN *string `json:"crn" validate:"required"` +} + +// NewSubnetPublicGatewayPatchPublicGatewayIdentityByCRN : Instantiate SubnetPublicGatewayPatchPublicGatewayIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewSubnetPublicGatewayPatchPublicGatewayIdentityByCRN(crn string) (_model *SubnetPublicGatewayPatchPublicGatewayIdentityByCRN, err error) { + _model = &SubnetPublicGatewayPatchPublicGatewayIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SubnetPublicGatewayPatchPublicGatewayIdentityByCRN) isaSubnetPublicGatewayPatch() bool { + return true +} + +// UnmarshalSubnetPublicGatewayPatchPublicGatewayIdentityByCRN unmarshals an instance of SubnetPublicGatewayPatchPublicGatewayIdentityByCRN from the specified map of raw messages. +func UnmarshalSubnetPublicGatewayPatchPublicGatewayIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SubnetPublicGatewayPatchPublicGatewayIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SubnetPublicGatewayPatchPublicGatewayIdentityByHref : SubnetPublicGatewayPatchPublicGatewayIdentityByHref struct +// This model "extends" SubnetPublicGatewayPatch +type SubnetPublicGatewayPatchPublicGatewayIdentityByHref struct { + // The URL for this public gateway. + Href *string `json:"href" validate:"required"` +} + +// NewSubnetPublicGatewayPatchPublicGatewayIdentityByHref : Instantiate SubnetPublicGatewayPatchPublicGatewayIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewSubnetPublicGatewayPatchPublicGatewayIdentityByHref(href string) (_model *SubnetPublicGatewayPatchPublicGatewayIdentityByHref, err error) { + _model = &SubnetPublicGatewayPatchPublicGatewayIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SubnetPublicGatewayPatchPublicGatewayIdentityByHref) isaSubnetPublicGatewayPatch() bool { + return true +} + +// UnmarshalSubnetPublicGatewayPatchPublicGatewayIdentityByHref unmarshals an instance of SubnetPublicGatewayPatchPublicGatewayIdentityByHref from the specified map of raw messages. +func UnmarshalSubnetPublicGatewayPatchPublicGatewayIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SubnetPublicGatewayPatchPublicGatewayIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SubnetPublicGatewayPatchPublicGatewayIdentityByID : SubnetPublicGatewayPatchPublicGatewayIdentityByID struct +// This model "extends" SubnetPublicGatewayPatch +type SubnetPublicGatewayPatchPublicGatewayIdentityByID struct { + // The unique identifier for this public gateway. + ID *string `json:"id" validate:"required"` +} + +// NewSubnetPublicGatewayPatchPublicGatewayIdentityByID : Instantiate SubnetPublicGatewayPatchPublicGatewayIdentityByID (Generic Model Constructor) +func (*VpcV1) NewSubnetPublicGatewayPatchPublicGatewayIdentityByID(id string) (_model *SubnetPublicGatewayPatchPublicGatewayIdentityByID, err error) { + _model = &SubnetPublicGatewayPatchPublicGatewayIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SubnetPublicGatewayPatchPublicGatewayIdentityByID) isaSubnetPublicGatewayPatch() bool { + return true +} + +// UnmarshalSubnetPublicGatewayPatchPublicGatewayIdentityByID unmarshals an instance of SubnetPublicGatewayPatchPublicGatewayIdentityByID from the specified map of raw messages. +func UnmarshalSubnetPublicGatewayPatchPublicGatewayIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SubnetPublicGatewayPatchPublicGatewayIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// TrustedProfileIdentityTrustedProfileByCRN : TrustedProfileIdentityTrustedProfileByCRN struct +// This model "extends" TrustedProfileIdentity +type TrustedProfileIdentityTrustedProfileByCRN struct { + // The CRN for this trusted profile. + CRN *string `json:"crn" validate:"required"` +} + +// NewTrustedProfileIdentityTrustedProfileByCRN : Instantiate TrustedProfileIdentityTrustedProfileByCRN (Generic Model Constructor) +func (*VpcV1) NewTrustedProfileIdentityTrustedProfileByCRN(crn string) (_model *TrustedProfileIdentityTrustedProfileByCRN, err error) { + _model = &TrustedProfileIdentityTrustedProfileByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*TrustedProfileIdentityTrustedProfileByCRN) isaTrustedProfileIdentity() bool { + return true +} + +// UnmarshalTrustedProfileIdentityTrustedProfileByCRN unmarshals an instance of TrustedProfileIdentityTrustedProfileByCRN from the specified map of raw messages. +func UnmarshalTrustedProfileIdentityTrustedProfileByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(TrustedProfileIdentityTrustedProfileByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// TrustedProfileIdentityTrustedProfileByID : TrustedProfileIdentityTrustedProfileByID struct +// This model "extends" TrustedProfileIdentity +type TrustedProfileIdentityTrustedProfileByID struct { + // The unique identifier for this trusted profile. + ID *string `json:"id" validate:"required"` +} + +// NewTrustedProfileIdentityTrustedProfileByID : Instantiate TrustedProfileIdentityTrustedProfileByID (Generic Model Constructor) +func (*VpcV1) NewTrustedProfileIdentityTrustedProfileByID(id string) (_model *TrustedProfileIdentityTrustedProfileByID, err error) { + _model = &TrustedProfileIdentityTrustedProfileByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*TrustedProfileIdentityTrustedProfileByID) isaTrustedProfileIdentity() bool { + return true +} + +// UnmarshalTrustedProfileIdentityTrustedProfileByID unmarshals an instance of TrustedProfileIdentityTrustedProfileByID from the specified map of raw messages. +func UnmarshalTrustedProfileIdentityTrustedProfileByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(TrustedProfileIdentityTrustedProfileByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VpcdnsResolverPrototypeVpcdnsResolverTypeManualPrototype : Manually specify the DNS server addresses for this VPC. +// This model "extends" VpcdnsResolverPrototype +type VpcdnsResolverPrototypeVpcdnsResolverTypeManualPrototype struct { + // The DNS servers to use for this VPC. All the DNS servers must either: + // + // - have a unique `zone_affinity`, or + // - not have a `zone_affinity`. + ManualServers []DnsServerPrototype `json:"manual_servers" validate:"required"` + + // The type of the DNS resolver to use. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the VpcdnsResolverPrototypeVpcdnsResolverTypeManualPrototype.Type property. +// The type of the DNS resolver to use. +const ( + VpcdnsResolverPrototypeVpcdnsResolverTypeManualPrototypeTypeManualConst = "manual" +) + +// NewVpcdnsResolverPrototypeVpcdnsResolverTypeManualPrototype : Instantiate VpcdnsResolverPrototypeVpcdnsResolverTypeManualPrototype (Generic Model Constructor) +func (*VpcV1) NewVpcdnsResolverPrototypeVpcdnsResolverTypeManualPrototype(manualServers []DnsServerPrototype, typeVar string) (_model *VpcdnsResolverPrototypeVpcdnsResolverTypeManualPrototype, err error) { + _model = &VpcdnsResolverPrototypeVpcdnsResolverTypeManualPrototype{ + ManualServers: manualServers, + Type: core.StringPtr(typeVar), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VpcdnsResolverPrototypeVpcdnsResolverTypeManualPrototype) isaVpcdnsResolverPrototype() bool { + return true +} + +// UnmarshalVpcdnsResolverPrototypeVpcdnsResolverTypeManualPrototype unmarshals an instance of VpcdnsResolverPrototypeVpcdnsResolverTypeManualPrototype from the specified map of raw messages. +func UnmarshalVpcdnsResolverPrototypeVpcdnsResolverTypeManualPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VpcdnsResolverPrototypeVpcdnsResolverTypeManualPrototype) + err = core.UnmarshalModel(m, "manual_servers", &obj.ManualServers, UnmarshalDnsServerPrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VpcdnsResolverPrototypeVpcdnsResolverTypeSystemPrototype : The system will provide DNS server addresses for this VPC. The system-provided DNS server addresses depend on whether +// any endpoint gateways reside in the VPC, and whether a +// [DNS Services](https://cloud.ibm.com/docs/dns-svcs) instance is configured for the VPC. +// This model "extends" VpcdnsResolverPrototype +type VpcdnsResolverPrototypeVpcdnsResolverTypeSystemPrototype struct { + // The type of the DNS resolver to use. + Type *string `json:"type,omitempty"` +} + +// Constants associated with the VpcdnsResolverPrototypeVpcdnsResolverTypeSystemPrototype.Type property. +// The type of the DNS resolver to use. +const ( + VpcdnsResolverPrototypeVpcdnsResolverTypeSystemPrototypeTypeSystemConst = "system" +) + +func (*VpcdnsResolverPrototypeVpcdnsResolverTypeSystemPrototype) isaVpcdnsResolverPrototype() bool { + return true +} + +// UnmarshalVpcdnsResolverPrototypeVpcdnsResolverTypeSystemPrototype unmarshals an instance of VpcdnsResolverPrototypeVpcdnsResolverTypeSystemPrototype from the specified map of raw messages. +func UnmarshalVpcdnsResolverPrototypeVpcdnsResolverTypeSystemPrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VpcdnsResolverPrototypeVpcdnsResolverTypeSystemPrototype) + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VpcdnsResolverTypeDelegated : The DNS server addresses are delegated to the DNS resolver of another VPC. +// This model "extends" VpcdnsResolver +type VpcdnsResolverTypeDelegated struct { + // The DNS servers for this VPC. The servers are populated: + // + // - by the system when `dns.resolver.type` is `system` + // - using the DNS servers in `dns.resolver.vpc` when `dns.resolver.type` is `delegated` + // - using `dns.resolver.manual_servers` when the `dns.resolver.type` is `manual`. + Servers []DnsServer `json:"servers" validate:"required"` + + // The type of the DNS resolver used for the VPC. + Type *string `json:"type" validate:"required"` + + // The VPC whose DNS resolver provides the DNS server addresses for this VPC. + // + // The VPC may be remote and therefore may not be directly retrievable. + VPC *VPCReferenceDnsResolverContext `json:"vpc" validate:"required"` +} + +// Constants associated with the VpcdnsResolverTypeDelegated.Type property. +// The type of the DNS resolver used for the VPC. +const ( + VpcdnsResolverTypeDelegatedTypeDelegatedConst = "delegated" +) + +func (*VpcdnsResolverTypeDelegated) isaVpcdnsResolver() bool { + return true +} + +// UnmarshalVpcdnsResolverTypeDelegated unmarshals an instance of VpcdnsResolverTypeDelegated from the specified map of raw messages. +func UnmarshalVpcdnsResolverTypeDelegated(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VpcdnsResolverTypeDelegated) + err = core.UnmarshalModel(m, "servers", &obj.Servers, UnmarshalDnsServer) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCReferenceDnsResolverContext) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VpcdnsResolverTypeManual : The DNS server addresses are manually specified. +// This model "extends" VpcdnsResolver +type VpcdnsResolverTypeManual struct { + // The DNS servers for this VPC. The servers are populated: + // + // - by the system when `dns.resolver.type` is `system` + // - using the DNS servers in `dns.resolver.vpc` when `dns.resolver.type` is `delegated` + // - using `dns.resolver.manual_servers` when the `dns.resolver.type` is `manual`. + Servers []DnsServer `json:"servers" validate:"required"` + + // The manually specified DNS servers for this VPC. + ManualServers []DnsServer `json:"manual_servers" validate:"required"` + + // The type of the DNS resolver used for the VPC. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the VpcdnsResolverTypeManual.Type property. +// The type of the DNS resolver used for the VPC. +const ( + VpcdnsResolverTypeManualTypeManualConst = "manual" +) + +func (*VpcdnsResolverTypeManual) isaVpcdnsResolver() bool { + return true +} + +// UnmarshalVpcdnsResolverTypeManual unmarshals an instance of VpcdnsResolverTypeManual from the specified map of raw messages. +func UnmarshalVpcdnsResolverTypeManual(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VpcdnsResolverTypeManual) + err = core.UnmarshalModel(m, "servers", &obj.Servers, UnmarshalDnsServer) + if err != nil { + return + } + err = core.UnmarshalModel(m, "manual_servers", &obj.ManualServers, UnmarshalDnsServer) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VpcdnsResolverTypeSystem : The DNS server addresses are provided by the system and depend on the configuration. +// This model "extends" VpcdnsResolver +type VpcdnsResolverTypeSystem struct { + // The DNS servers for this VPC. The servers are populated: + // + // - by the system when `dns.resolver.type` is `system` + // - using the DNS servers in `dns.resolver.vpc` when `dns.resolver.type` is `delegated` + // - using `dns.resolver.manual_servers` when the `dns.resolver.type` is `manual`. + Servers []DnsServer `json:"servers" validate:"required"` + + // The configuration of the system DNS resolver for this VPC. + // + // - `custom_resolver`: A custom DNS resolver is configured for this VPC. + // + // - `private_resolver`: A private DNS resolver is configured for this VPC. Applicable when + // the VPC has either or both of the following: + // + // - at least one endpoint gateway residing in it + // - a [DNS Services](https://cloud.ibm.com/docs/dns-svcs) private zone configured for it + // + // - `default`: The provider default DNS resolvers are configured for this VPC. + // + // This system DNS resolver configuration is used when the VPC has: + // + // - no custom DNS resolver configured for it, and + // - no endpoint gateways residing in it, and + // - no [DNS Services](https://cloud.ibm.com/docs/dns-svcs) private zone configured for it. + Configuration *string `json:"configuration" validate:"required"` + + // The type of the DNS resolver used for the VPC. + Type *string `json:"type" validate:"required"` +} + +// Constants associated with the VpcdnsResolverTypeSystem.Configuration property. +// The configuration of the system DNS resolver for this VPC. +// +// - `custom_resolver`: A custom DNS resolver is configured for this VPC. +// +// - `private_resolver`: A private DNS resolver is configured for this VPC. Applicable when +// the VPC has either or both of the following: +// +// - at least one endpoint gateway residing in it +// +// - a [DNS Services](https://cloud.ibm.com/docs/dns-svcs) private zone configured for it +// +// - `default`: The provider default DNS resolvers are configured for this VPC. +// +// This system DNS resolver configuration is used when the VPC has: +// +// - no custom DNS resolver configured for it, and +// - no endpoint gateways residing in it, and +// - no [DNS Services](https://cloud.ibm.com/docs/dns-svcs) private zone configured for it. +const ( + VpcdnsResolverTypeSystemConfigurationCustomResolverConst = "custom_resolver" + VpcdnsResolverTypeSystemConfigurationDefaultConst = "default" + VpcdnsResolverTypeSystemConfigurationPrivateResolverConst = "private_resolver" +) + +// Constants associated with the VpcdnsResolverTypeSystem.Type property. +// The type of the DNS resolver used for the VPC. +const ( + VpcdnsResolverTypeSystemTypeSystemConst = "system" +) + +func (*VpcdnsResolverTypeSystem) isaVpcdnsResolver() bool { + return true +} + +// UnmarshalVpcdnsResolverTypeSystem unmarshals an instance of VpcdnsResolverTypeSystem from the specified map of raw messages. +func UnmarshalVpcdnsResolverTypeSystem(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VpcdnsResolverTypeSystem) + err = core.UnmarshalModel(m, "servers", &obj.Servers, UnmarshalDnsServer) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "configuration", &obj.Configuration) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "type", &obj.Type) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VpcdnsResolverVPCPatchVPCIdentityByCRN : VpcdnsResolverVPCPatchVPCIdentityByCRN struct +// This model "extends" VpcdnsResolverVPCPatch +type VpcdnsResolverVPCPatchVPCIdentityByCRN struct { + // The CRN for this VPC. + CRN *string `json:"crn" validate:"required"` +} + +// NewVpcdnsResolverVPCPatchVPCIdentityByCRN : Instantiate VpcdnsResolverVPCPatchVPCIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewVpcdnsResolverVPCPatchVPCIdentityByCRN(crn string) (_model *VpcdnsResolverVPCPatchVPCIdentityByCRN, err error) { + _model = &VpcdnsResolverVPCPatchVPCIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VpcdnsResolverVPCPatchVPCIdentityByCRN) isaVpcdnsResolverVPCPatch() bool { + return true +} + +// UnmarshalVpcdnsResolverVPCPatchVPCIdentityByCRN unmarshals an instance of VpcdnsResolverVPCPatchVPCIdentityByCRN from the specified map of raw messages. +func UnmarshalVpcdnsResolverVPCPatchVPCIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VpcdnsResolverVPCPatchVPCIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VpcdnsResolverVPCPatchVPCIdentityByHref : VpcdnsResolverVPCPatchVPCIdentityByHref struct +// This model "extends" VpcdnsResolverVPCPatch +type VpcdnsResolverVPCPatchVPCIdentityByHref struct { + // The URL for this VPC. + Href *string `json:"href" validate:"required"` +} + +// NewVpcdnsResolverVPCPatchVPCIdentityByHref : Instantiate VpcdnsResolverVPCPatchVPCIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewVpcdnsResolverVPCPatchVPCIdentityByHref(href string) (_model *VpcdnsResolverVPCPatchVPCIdentityByHref, err error) { + _model = &VpcdnsResolverVPCPatchVPCIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VpcdnsResolverVPCPatchVPCIdentityByHref) isaVpcdnsResolverVPCPatch() bool { + return true +} + +// UnmarshalVpcdnsResolverVPCPatchVPCIdentityByHref unmarshals an instance of VpcdnsResolverVPCPatchVPCIdentityByHref from the specified map of raw messages. +func UnmarshalVpcdnsResolverVPCPatchVPCIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VpcdnsResolverVPCPatchVPCIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VpcdnsResolverVPCPatchVPCIdentityByID : VpcdnsResolverVPCPatchVPCIdentityByID struct +// This model "extends" VpcdnsResolverVPCPatch +type VpcdnsResolverVPCPatchVPCIdentityByID struct { + // The unique identifier for this VPC. + ID *string `json:"id" validate:"required"` +} + +// NewVpcdnsResolverVPCPatchVPCIdentityByID : Instantiate VpcdnsResolverVPCPatchVPCIdentityByID (Generic Model Constructor) +func (*VpcV1) NewVpcdnsResolverVPCPatchVPCIdentityByID(id string) (_model *VpcdnsResolverVPCPatchVPCIdentityByID, err error) { + _model = &VpcdnsResolverVPCPatchVPCIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VpcdnsResolverVPCPatchVPCIdentityByID) isaVpcdnsResolverVPCPatch() bool { + return true +} + +// UnmarshalVpcdnsResolverVPCPatchVPCIdentityByID unmarshals an instance of VpcdnsResolverVPCPatchVPCIdentityByID from the specified map of raw messages. +func UnmarshalVpcdnsResolverVPCPatchVPCIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VpcdnsResolverVPCPatchVPCIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPCIdentityByCRN : VPCIdentityByCRN struct +// This model "extends" VPCIdentity +type VPCIdentityByCRN struct { + // The CRN for this VPC. + CRN *string `json:"crn" validate:"required"` +} + +// NewVPCIdentityByCRN : Instantiate VPCIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewVPCIdentityByCRN(crn string) (_model *VPCIdentityByCRN, err error) { + _model = &VPCIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VPCIdentityByCRN) isaVPCIdentity() bool { + return true +} + +// UnmarshalVPCIdentityByCRN unmarshals an instance of VPCIdentityByCRN from the specified map of raw messages. +func UnmarshalVPCIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPCIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPCIdentityByHref : VPCIdentityByHref struct +// This model "extends" VPCIdentity +type VPCIdentityByHref struct { + // The URL for this VPC. + Href *string `json:"href" validate:"required"` +} + +// NewVPCIdentityByHref : Instantiate VPCIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewVPCIdentityByHref(href string) (_model *VPCIdentityByHref, err error) { + _model = &VPCIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VPCIdentityByHref) isaVPCIdentity() bool { + return true +} + +// UnmarshalVPCIdentityByHref unmarshals an instance of VPCIdentityByHref from the specified map of raw messages. +func UnmarshalVPCIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPCIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPCIdentityByID : VPCIdentityByID struct +// This model "extends" VPCIdentity +type VPCIdentityByID struct { + // The unique identifier for this VPC. + ID *string `json:"id" validate:"required"` +} + +// NewVPCIdentityByID : Instantiate VPCIdentityByID (Generic Model Constructor) +func (*VpcV1) NewVPCIdentityByID(id string) (_model *VPCIdentityByID, err error) { + _model = &VPCIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VPCIdentityByID) isaVPCIdentity() bool { + return true +} + +// UnmarshalVPCIdentityByID unmarshals an instance of VPCIdentityByID from the specified map of raw messages. +func UnmarshalVPCIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPCIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayConnectionIkePolicyPatchIkePolicyIdentityByHref : VPNGatewayConnectionIkePolicyPatchIkePolicyIdentityByHref struct +// This model "extends" VPNGatewayConnectionIkePolicyPatch +type VPNGatewayConnectionIkePolicyPatchIkePolicyIdentityByHref struct { + // The IKE policy's canonical URL. + Href *string `json:"href" validate:"required"` +} + +// NewVPNGatewayConnectionIkePolicyPatchIkePolicyIdentityByHref : Instantiate VPNGatewayConnectionIkePolicyPatchIkePolicyIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewVPNGatewayConnectionIkePolicyPatchIkePolicyIdentityByHref(href string) (_model *VPNGatewayConnectionIkePolicyPatchIkePolicyIdentityByHref, err error) { + _model = &VPNGatewayConnectionIkePolicyPatchIkePolicyIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VPNGatewayConnectionIkePolicyPatchIkePolicyIdentityByHref) isaVPNGatewayConnectionIkePolicyPatch() bool { + return true +} + +// UnmarshalVPNGatewayConnectionIkePolicyPatchIkePolicyIdentityByHref unmarshals an instance of VPNGatewayConnectionIkePolicyPatchIkePolicyIdentityByHref from the specified map of raw messages. +func UnmarshalVPNGatewayConnectionIkePolicyPatchIkePolicyIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayConnectionIkePolicyPatchIkePolicyIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayConnectionIkePolicyPatchIkePolicyIdentityByID : VPNGatewayConnectionIkePolicyPatchIkePolicyIdentityByID struct +// This model "extends" VPNGatewayConnectionIkePolicyPatch +type VPNGatewayConnectionIkePolicyPatchIkePolicyIdentityByID struct { + // The unique identifier for this IKE policy. + ID *string `json:"id" validate:"required"` +} + +// NewVPNGatewayConnectionIkePolicyPatchIkePolicyIdentityByID : Instantiate VPNGatewayConnectionIkePolicyPatchIkePolicyIdentityByID (Generic Model Constructor) +func (*VpcV1) NewVPNGatewayConnectionIkePolicyPatchIkePolicyIdentityByID(id string) (_model *VPNGatewayConnectionIkePolicyPatchIkePolicyIdentityByID, err error) { + _model = &VPNGatewayConnectionIkePolicyPatchIkePolicyIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VPNGatewayConnectionIkePolicyPatchIkePolicyIdentityByID) isaVPNGatewayConnectionIkePolicyPatch() bool { + return true +} + +// UnmarshalVPNGatewayConnectionIkePolicyPatchIkePolicyIdentityByID unmarshals an instance of VPNGatewayConnectionIkePolicyPatchIkePolicyIdentityByID from the specified map of raw messages. +func UnmarshalVPNGatewayConnectionIkePolicyPatchIkePolicyIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayConnectionIkePolicyPatchIkePolicyIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayConnectionIkePolicyPrototypeIkePolicyIdentityByHref : VPNGatewayConnectionIkePolicyPrototypeIkePolicyIdentityByHref struct +// This model "extends" VPNGatewayConnectionIkePolicyPrototype +type VPNGatewayConnectionIkePolicyPrototypeIkePolicyIdentityByHref struct { + // The IKE policy's canonical URL. + Href *string `json:"href" validate:"required"` +} + +// NewVPNGatewayConnectionIkePolicyPrototypeIkePolicyIdentityByHref : Instantiate VPNGatewayConnectionIkePolicyPrototypeIkePolicyIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewVPNGatewayConnectionIkePolicyPrototypeIkePolicyIdentityByHref(href string) (_model *VPNGatewayConnectionIkePolicyPrototypeIkePolicyIdentityByHref, err error) { + _model = &VPNGatewayConnectionIkePolicyPrototypeIkePolicyIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VPNGatewayConnectionIkePolicyPrototypeIkePolicyIdentityByHref) isaVPNGatewayConnectionIkePolicyPrototype() bool { + return true +} + +// UnmarshalVPNGatewayConnectionIkePolicyPrototypeIkePolicyIdentityByHref unmarshals an instance of VPNGatewayConnectionIkePolicyPrototypeIkePolicyIdentityByHref from the specified map of raw messages. +func UnmarshalVPNGatewayConnectionIkePolicyPrototypeIkePolicyIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayConnectionIkePolicyPrototypeIkePolicyIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayConnectionIkePolicyPrototypeIkePolicyIdentityByID : VPNGatewayConnectionIkePolicyPrototypeIkePolicyIdentityByID struct +// This model "extends" VPNGatewayConnectionIkePolicyPrototype +type VPNGatewayConnectionIkePolicyPrototypeIkePolicyIdentityByID struct { + // The unique identifier for this IKE policy. + ID *string `json:"id" validate:"required"` +} + +// NewVPNGatewayConnectionIkePolicyPrototypeIkePolicyIdentityByID : Instantiate VPNGatewayConnectionIkePolicyPrototypeIkePolicyIdentityByID (Generic Model Constructor) +func (*VpcV1) NewVPNGatewayConnectionIkePolicyPrototypeIkePolicyIdentityByID(id string) (_model *VPNGatewayConnectionIkePolicyPrototypeIkePolicyIdentityByID, err error) { + _model = &VPNGatewayConnectionIkePolicyPrototypeIkePolicyIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VPNGatewayConnectionIkePolicyPrototypeIkePolicyIdentityByID) isaVPNGatewayConnectionIkePolicyPrototype() bool { + return true +} + +// UnmarshalVPNGatewayConnectionIkePolicyPrototypeIkePolicyIdentityByID unmarshals an instance of VPNGatewayConnectionIkePolicyPrototypeIkePolicyIdentityByID from the specified map of raw messages. +func UnmarshalVPNGatewayConnectionIkePolicyPrototypeIkePolicyIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayConnectionIkePolicyPrototypeIkePolicyIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayConnectionIPsecPolicyPatchIPsecPolicyIdentityByHref : VPNGatewayConnectionIPsecPolicyPatchIPsecPolicyIdentityByHref struct +// This model "extends" VPNGatewayConnectionIPsecPolicyPatch +type VPNGatewayConnectionIPsecPolicyPatchIPsecPolicyIdentityByHref struct { + // The IPsec policy's canonical URL. + Href *string `json:"href" validate:"required"` +} + +// NewVPNGatewayConnectionIPsecPolicyPatchIPsecPolicyIdentityByHref : Instantiate VPNGatewayConnectionIPsecPolicyPatchIPsecPolicyIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewVPNGatewayConnectionIPsecPolicyPatchIPsecPolicyIdentityByHref(href string) (_model *VPNGatewayConnectionIPsecPolicyPatchIPsecPolicyIdentityByHref, err error) { + _model = &VPNGatewayConnectionIPsecPolicyPatchIPsecPolicyIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VPNGatewayConnectionIPsecPolicyPatchIPsecPolicyIdentityByHref) isaVPNGatewayConnectionIPsecPolicyPatch() bool { + return true +} + +// UnmarshalVPNGatewayConnectionIPsecPolicyPatchIPsecPolicyIdentityByHref unmarshals an instance of VPNGatewayConnectionIPsecPolicyPatchIPsecPolicyIdentityByHref from the specified map of raw messages. +func UnmarshalVPNGatewayConnectionIPsecPolicyPatchIPsecPolicyIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayConnectionIPsecPolicyPatchIPsecPolicyIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayConnectionIPsecPolicyPatchIPsecPolicyIdentityByID : VPNGatewayConnectionIPsecPolicyPatchIPsecPolicyIdentityByID struct +// This model "extends" VPNGatewayConnectionIPsecPolicyPatch +type VPNGatewayConnectionIPsecPolicyPatchIPsecPolicyIdentityByID struct { + // The unique identifier for this IPsec policy. + ID *string `json:"id" validate:"required"` +} + +// NewVPNGatewayConnectionIPsecPolicyPatchIPsecPolicyIdentityByID : Instantiate VPNGatewayConnectionIPsecPolicyPatchIPsecPolicyIdentityByID (Generic Model Constructor) +func (*VpcV1) NewVPNGatewayConnectionIPsecPolicyPatchIPsecPolicyIdentityByID(id string) (_model *VPNGatewayConnectionIPsecPolicyPatchIPsecPolicyIdentityByID, err error) { + _model = &VPNGatewayConnectionIPsecPolicyPatchIPsecPolicyIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VPNGatewayConnectionIPsecPolicyPatchIPsecPolicyIdentityByID) isaVPNGatewayConnectionIPsecPolicyPatch() bool { + return true +} + +// UnmarshalVPNGatewayConnectionIPsecPolicyPatchIPsecPolicyIdentityByID unmarshals an instance of VPNGatewayConnectionIPsecPolicyPatchIPsecPolicyIdentityByID from the specified map of raw messages. +func UnmarshalVPNGatewayConnectionIPsecPolicyPatchIPsecPolicyIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayConnectionIPsecPolicyPatchIPsecPolicyIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayConnectionIPsecPolicyPrototypeIPsecPolicyIdentityByHref : VPNGatewayConnectionIPsecPolicyPrototypeIPsecPolicyIdentityByHref struct +// This model "extends" VPNGatewayConnectionIPsecPolicyPrototype +type VPNGatewayConnectionIPsecPolicyPrototypeIPsecPolicyIdentityByHref struct { + // The IPsec policy's canonical URL. + Href *string `json:"href" validate:"required"` +} + +// NewVPNGatewayConnectionIPsecPolicyPrototypeIPsecPolicyIdentityByHref : Instantiate VPNGatewayConnectionIPsecPolicyPrototypeIPsecPolicyIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewVPNGatewayConnectionIPsecPolicyPrototypeIPsecPolicyIdentityByHref(href string) (_model *VPNGatewayConnectionIPsecPolicyPrototypeIPsecPolicyIdentityByHref, err error) { + _model = &VPNGatewayConnectionIPsecPolicyPrototypeIPsecPolicyIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VPNGatewayConnectionIPsecPolicyPrototypeIPsecPolicyIdentityByHref) isaVPNGatewayConnectionIPsecPolicyPrototype() bool { + return true +} + +// UnmarshalVPNGatewayConnectionIPsecPolicyPrototypeIPsecPolicyIdentityByHref unmarshals an instance of VPNGatewayConnectionIPsecPolicyPrototypeIPsecPolicyIdentityByHref from the specified map of raw messages. +func UnmarshalVPNGatewayConnectionIPsecPolicyPrototypeIPsecPolicyIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayConnectionIPsecPolicyPrototypeIPsecPolicyIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayConnectionIPsecPolicyPrototypeIPsecPolicyIdentityByID : VPNGatewayConnectionIPsecPolicyPrototypeIPsecPolicyIdentityByID struct +// This model "extends" VPNGatewayConnectionIPsecPolicyPrototype +type VPNGatewayConnectionIPsecPolicyPrototypeIPsecPolicyIdentityByID struct { + // The unique identifier for this IPsec policy. + ID *string `json:"id" validate:"required"` +} + +// NewVPNGatewayConnectionIPsecPolicyPrototypeIPsecPolicyIdentityByID : Instantiate VPNGatewayConnectionIPsecPolicyPrototypeIPsecPolicyIdentityByID (Generic Model Constructor) +func (*VpcV1) NewVPNGatewayConnectionIPsecPolicyPrototypeIPsecPolicyIdentityByID(id string) (_model *VPNGatewayConnectionIPsecPolicyPrototypeIPsecPolicyIdentityByID, err error) { + _model = &VPNGatewayConnectionIPsecPolicyPrototypeIPsecPolicyIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VPNGatewayConnectionIPsecPolicyPrototypeIPsecPolicyIdentityByID) isaVPNGatewayConnectionIPsecPolicyPrototype() bool { + return true +} + +// UnmarshalVPNGatewayConnectionIPsecPolicyPrototypeIPsecPolicyIdentityByID unmarshals an instance of VPNGatewayConnectionIPsecPolicyPrototypeIPsecPolicyIdentityByID from the specified map of raw messages. +func UnmarshalVPNGatewayConnectionIPsecPolicyPrototypeIPsecPolicyIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayConnectionIPsecPolicyPrototypeIPsecPolicyIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayConnectionPatchVPNGatewayConnectionStaticRouteModePatch : VPNGatewayConnectionPatchVPNGatewayConnectionStaticRouteModePatch struct +// This model "extends" VPNGatewayConnectionPatch +type VPNGatewayConnectionPatchVPNGatewayConnectionStaticRouteModePatch struct { + // If set to false, the VPN gateway connection is shut down. + AdminStateUp *bool `json:"admin_state_up,omitempty"` + + DeadPeerDetection *VPNGatewayConnectionDpdPatch `json:"dead_peer_detection,omitempty"` + + IkePolicy VPNGatewayConnectionIkePolicyPatchIntf `json:"ike_policy,omitempty"` + + IpsecPolicy VPNGatewayConnectionIPsecPolicyPatchIntf `json:"ipsec_policy,omitempty"` + + // The name for this VPN gateway connection. The name must not be used by another connection for the VPN gateway. + Name *string `json:"name,omitempty"` + + // The IP address of the peer VPN gateway. + PeerAddress *string `json:"peer_address,omitempty"` + + // The pre-shared key. + Psk *string `json:"psk,omitempty"` + + // Routing protocols are disabled for this VPN gateway connection. + RoutingProtocol *string `json:"routing_protocol,omitempty"` +} + +// Constants associated with the VPNGatewayConnectionPatchVPNGatewayConnectionStaticRouteModePatch.RoutingProtocol property. +// Routing protocols are disabled for this VPN gateway connection. +const ( + VPNGatewayConnectionPatchVPNGatewayConnectionStaticRouteModePatchRoutingProtocolNoneConst = "none" +) + +func (*VPNGatewayConnectionPatchVPNGatewayConnectionStaticRouteModePatch) isaVPNGatewayConnectionPatch() bool { + return true +} + +// UnmarshalVPNGatewayConnectionPatchVPNGatewayConnectionStaticRouteModePatch unmarshals an instance of VPNGatewayConnectionPatchVPNGatewayConnectionStaticRouteModePatch from the specified map of raw messages. +func UnmarshalVPNGatewayConnectionPatchVPNGatewayConnectionStaticRouteModePatch(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayConnectionPatchVPNGatewayConnectionStaticRouteModePatch) + err = core.UnmarshalPrimitive(m, "admin_state_up", &obj.AdminStateUp) + if err != nil { + return + } + err = core.UnmarshalModel(m, "dead_peer_detection", &obj.DeadPeerDetection, UnmarshalVPNGatewayConnectionDpdPatch) + if err != nil { + return + } + err = core.UnmarshalModel(m, "ike_policy", &obj.IkePolicy, UnmarshalVPNGatewayConnectionIkePolicyPatch) + if err != nil { + return + } + err = core.UnmarshalModel(m, "ipsec_policy", &obj.IpsecPolicy, UnmarshalVPNGatewayConnectionIPsecPolicyPatch) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "peer_address", &obj.PeerAddress) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "psk", &obj.Psk) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "routing_protocol", &obj.RoutingProtocol) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// AsPatch returns a generic map representation of the VPNGatewayConnectionPatchVPNGatewayConnectionStaticRouteModePatch +func (vpnGatewayConnectionPatchVPNGatewayConnectionStaticRouteModePatch *VPNGatewayConnectionPatchVPNGatewayConnectionStaticRouteModePatch) AsPatch() (_patch map[string]interface{}, err error) { + var jsonData []byte + jsonData, err = json.Marshal(vpnGatewayConnectionPatchVPNGatewayConnectionStaticRouteModePatch) + if err == nil { + err = json.Unmarshal(jsonData, &_patch) + } + return +} + +// VPNGatewayConnectionPolicyMode : VPNGatewayConnectionPolicyMode struct +// This model "extends" VPNGatewayConnection +type VPNGatewayConnectionPolicyMode struct { + // If set to false, the VPN gateway connection is shut down. + AdminStateUp *bool `json:"admin_state_up" validate:"required"` + + // The authentication mode. Only `psk` is currently supported. + AuthenticationMode *string `json:"authentication_mode" validate:"required"` + + // The date and time that this VPN gateway connection was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + DeadPeerDetection *VPNGatewayConnectionDpd `json:"dead_peer_detection" validate:"required"` + + // The VPN connection's canonical URL. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this VPN gateway connection. + ID *string `json:"id" validate:"required"` + + // The IKE policy. If absent, [auto-negotiation is + // used](https://cloud.ibm.com/docs/vpc?topic=vpc-using-vpn&interface=ui#ike-auto-negotiation-phase-1). + IkePolicy *IkePolicyReference `json:"ike_policy,omitempty"` + + // The IPsec policy. If absent, [auto-negotiation is + // used](https://cloud.ibm.com/docs/vpc?topic=vpc-using-vpn&interface=ui#ipsec-auto-negotiation-phase-2). + IpsecPolicy *IPsecPolicyReference `json:"ipsec_policy,omitempty"` + + // The mode of the VPN gateway. + Mode *string `json:"mode" validate:"required"` + + // The name for this VPN gateway connection. The name is unique across all connections for the VPN gateway. + Name *string `json:"name" validate:"required"` + + // The IP address of the peer VPN gateway. + PeerAddress *string `json:"peer_address" validate:"required"` + + // The pre-shared key. + Psk *string `json:"psk" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The status of a VPN gateway connection. + Status *string `json:"status" validate:"required"` + + // The local CIDRs for this resource. + LocalCIDRs []string `json:"local_cidrs" validate:"required"` + + // The peer CIDRs for this resource. + PeerCIDRs []string `json:"peer_cidrs" validate:"required"` +} + +// Constants associated with the VPNGatewayConnectionPolicyMode.AuthenticationMode property. +// The authentication mode. Only `psk` is currently supported. +const ( + VPNGatewayConnectionPolicyModeAuthenticationModePskConst = "psk" +) + +// Constants associated with the VPNGatewayConnectionPolicyMode.Mode property. +// The mode of the VPN gateway. +const ( + VPNGatewayConnectionPolicyModeModePolicyConst = "policy" + VPNGatewayConnectionPolicyModeModeRouteConst = "route" +) + +// Constants associated with the VPNGatewayConnectionPolicyMode.ResourceType property. +// The resource type. +const ( + VPNGatewayConnectionPolicyModeResourceTypeVPNGatewayConnectionConst = "vpn_gateway_connection" +) + +// Constants associated with the VPNGatewayConnectionPolicyMode.Status property. +// The status of a VPN gateway connection. +const ( + VPNGatewayConnectionPolicyModeStatusDownConst = "down" + VPNGatewayConnectionPolicyModeStatusUpConst = "up" +) + +func (*VPNGatewayConnectionPolicyMode) isaVPNGatewayConnection() bool { + return true +} + +// UnmarshalVPNGatewayConnectionPolicyMode unmarshals an instance of VPNGatewayConnectionPolicyMode from the specified map of raw messages. +func UnmarshalVPNGatewayConnectionPolicyMode(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayConnectionPolicyMode) + err = core.UnmarshalPrimitive(m, "admin_state_up", &obj.AdminStateUp) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "authentication_mode", &obj.AuthenticationMode) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalModel(m, "dead_peer_detection", &obj.DeadPeerDetection, UnmarshalVPNGatewayConnectionDpd) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalModel(m, "ike_policy", &obj.IkePolicy, UnmarshalIkePolicyReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "ipsec_policy", &obj.IpsecPolicy, UnmarshalIPsecPolicyReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "mode", &obj.Mode) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "peer_address", &obj.PeerAddress) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "psk", &obj.Psk) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "local_cidrs", &obj.LocalCIDRs) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "peer_cidrs", &obj.PeerCIDRs) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayConnectionPrototypeVPNGatewayConnectionPolicyModePrototype : VPNGatewayConnectionPrototypeVPNGatewayConnectionPolicyModePrototype struct +// This model "extends" VPNGatewayConnectionPrototype +type VPNGatewayConnectionPrototypeVPNGatewayConnectionPolicyModePrototype struct { + // If set to false, the VPN gateway connection is shut down. + AdminStateUp *bool `json:"admin_state_up,omitempty"` + + DeadPeerDetection *VPNGatewayConnectionDpdPrototype `json:"dead_peer_detection,omitempty"` + + IkePolicy VPNGatewayConnectionIkePolicyPrototypeIntf `json:"ike_policy,omitempty"` + + IpsecPolicy VPNGatewayConnectionIPsecPolicyPrototypeIntf `json:"ipsec_policy,omitempty"` + + // The name for this VPN gateway connection. The name must not be used by another connection for the VPN gateway. If + // unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The IP address of the peer VPN gateway. + PeerAddress *string `json:"peer_address" validate:"required"` + + // The pre-shared key. + Psk *string `json:"psk" validate:"required"` + + // The local CIDRs for this resource. + LocalCIDRs []string `json:"local_cidrs" validate:"required"` + + // The peer CIDRs for this resource. + PeerCIDRs []string `json:"peer_cidrs" validate:"required"` +} + +// NewVPNGatewayConnectionPrototypeVPNGatewayConnectionPolicyModePrototype : Instantiate VPNGatewayConnectionPrototypeVPNGatewayConnectionPolicyModePrototype (Generic Model Constructor) +func (*VpcV1) NewVPNGatewayConnectionPrototypeVPNGatewayConnectionPolicyModePrototype(peerAddress string, psk string, localCIDRs []string, peerCIDRs []string) (_model *VPNGatewayConnectionPrototypeVPNGatewayConnectionPolicyModePrototype, err error) { + _model = &VPNGatewayConnectionPrototypeVPNGatewayConnectionPolicyModePrototype{ + PeerAddress: core.StringPtr(peerAddress), + Psk: core.StringPtr(psk), + LocalCIDRs: localCIDRs, + PeerCIDRs: peerCIDRs, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VPNGatewayConnectionPrototypeVPNGatewayConnectionPolicyModePrototype) isaVPNGatewayConnectionPrototype() bool { + return true +} + +// UnmarshalVPNGatewayConnectionPrototypeVPNGatewayConnectionPolicyModePrototype unmarshals an instance of VPNGatewayConnectionPrototypeVPNGatewayConnectionPolicyModePrototype from the specified map of raw messages. +func UnmarshalVPNGatewayConnectionPrototypeVPNGatewayConnectionPolicyModePrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayConnectionPrototypeVPNGatewayConnectionPolicyModePrototype) + err = core.UnmarshalPrimitive(m, "admin_state_up", &obj.AdminStateUp) + if err != nil { + return + } + err = core.UnmarshalModel(m, "dead_peer_detection", &obj.DeadPeerDetection, UnmarshalVPNGatewayConnectionDpdPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "ike_policy", &obj.IkePolicy, UnmarshalVPNGatewayConnectionIkePolicyPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "ipsec_policy", &obj.IpsecPolicy, UnmarshalVPNGatewayConnectionIPsecPolicyPrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "peer_address", &obj.PeerAddress) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "psk", &obj.Psk) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "local_cidrs", &obj.LocalCIDRs) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "peer_cidrs", &obj.PeerCIDRs) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayConnectionPrototypeVPNGatewayConnectionStaticRouteModePrototype : VPNGatewayConnectionPrototypeVPNGatewayConnectionStaticRouteModePrototype struct +// This model "extends" VPNGatewayConnectionPrototype +type VPNGatewayConnectionPrototypeVPNGatewayConnectionStaticRouteModePrototype struct { + // If set to false, the VPN gateway connection is shut down. + AdminStateUp *bool `json:"admin_state_up,omitempty"` + + DeadPeerDetection *VPNGatewayConnectionDpdPrototype `json:"dead_peer_detection,omitempty"` + + IkePolicy VPNGatewayConnectionIkePolicyPrototypeIntf `json:"ike_policy,omitempty"` + + IpsecPolicy VPNGatewayConnectionIPsecPolicyPrototypeIntf `json:"ipsec_policy,omitempty"` + + // The name for this VPN gateway connection. The name must not be used by another connection for the VPN gateway. If + // unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The IP address of the peer VPN gateway. + PeerAddress *string `json:"peer_address" validate:"required"` + + // The pre-shared key. + Psk *string `json:"psk" validate:"required"` + + // Routing protocols are disabled for this VPN gateway connection. + RoutingProtocol *string `json:"routing_protocol,omitempty"` +} + +// Constants associated with the VPNGatewayConnectionPrototypeVPNGatewayConnectionStaticRouteModePrototype.RoutingProtocol property. +// Routing protocols are disabled for this VPN gateway connection. +const ( + VPNGatewayConnectionPrototypeVPNGatewayConnectionStaticRouteModePrototypeRoutingProtocolNoneConst = "none" +) + +// NewVPNGatewayConnectionPrototypeVPNGatewayConnectionStaticRouteModePrototype : Instantiate VPNGatewayConnectionPrototypeVPNGatewayConnectionStaticRouteModePrototype (Generic Model Constructor) +func (*VpcV1) NewVPNGatewayConnectionPrototypeVPNGatewayConnectionStaticRouteModePrototype(peerAddress string, psk string) (_model *VPNGatewayConnectionPrototypeVPNGatewayConnectionStaticRouteModePrototype, err error) { + _model = &VPNGatewayConnectionPrototypeVPNGatewayConnectionStaticRouteModePrototype{ + PeerAddress: core.StringPtr(peerAddress), + Psk: core.StringPtr(psk), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VPNGatewayConnectionPrototypeVPNGatewayConnectionStaticRouteModePrototype) isaVPNGatewayConnectionPrototype() bool { + return true +} + +// UnmarshalVPNGatewayConnectionPrototypeVPNGatewayConnectionStaticRouteModePrototype unmarshals an instance of VPNGatewayConnectionPrototypeVPNGatewayConnectionStaticRouteModePrototype from the specified map of raw messages. +func UnmarshalVPNGatewayConnectionPrototypeVPNGatewayConnectionStaticRouteModePrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayConnectionPrototypeVPNGatewayConnectionStaticRouteModePrototype) + err = core.UnmarshalPrimitive(m, "admin_state_up", &obj.AdminStateUp) + if err != nil { + return + } + err = core.UnmarshalModel(m, "dead_peer_detection", &obj.DeadPeerDetection, UnmarshalVPNGatewayConnectionDpdPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "ike_policy", &obj.IkePolicy, UnmarshalVPNGatewayConnectionIkePolicyPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "ipsec_policy", &obj.IpsecPolicy, UnmarshalVPNGatewayConnectionIPsecPolicyPrototype) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "peer_address", &obj.PeerAddress) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "psk", &obj.Psk) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "routing_protocol", &obj.RoutingProtocol) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayConnectionStaticRouteMode : VPNGatewayConnectionStaticRouteMode struct +// This model "extends" VPNGatewayConnection +type VPNGatewayConnectionStaticRouteMode struct { + // If set to false, the VPN gateway connection is shut down. + AdminStateUp *bool `json:"admin_state_up" validate:"required"` + + // The authentication mode. Only `psk` is currently supported. + AuthenticationMode *string `json:"authentication_mode" validate:"required"` + + // The date and time that this VPN gateway connection was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + DeadPeerDetection *VPNGatewayConnectionDpd `json:"dead_peer_detection" validate:"required"` + + // The VPN connection's canonical URL. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this VPN gateway connection. + ID *string `json:"id" validate:"required"` + + // The IKE policy. If absent, [auto-negotiation is + // used](https://cloud.ibm.com/docs/vpc?topic=vpc-using-vpn&interface=ui#ike-auto-negotiation-phase-1). + IkePolicy *IkePolicyReference `json:"ike_policy,omitempty"` + + // The IPsec policy. If absent, [auto-negotiation is + // used](https://cloud.ibm.com/docs/vpc?topic=vpc-using-vpn&interface=ui#ipsec-auto-negotiation-phase-2). + IpsecPolicy *IPsecPolicyReference `json:"ipsec_policy,omitempty"` + + // The mode of the VPN gateway. + Mode *string `json:"mode" validate:"required"` + + // The name for this VPN gateway connection. The name is unique across all connections for the VPN gateway. + Name *string `json:"name" validate:"required"` + + // The IP address of the peer VPN gateway. + PeerAddress *string `json:"peer_address" validate:"required"` + + // The pre-shared key. + Psk *string `json:"psk" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The status of a VPN gateway connection. + Status *string `json:"status" validate:"required"` + + // Routing protocols are disabled for this VPN gateway connection. + RoutingProtocol *string `json:"routing_protocol" validate:"required"` + + // The VPN tunnel configuration for this VPN gateway connection (in static route mode). + Tunnels []VPNGatewayConnectionStaticRouteModeTunnel `json:"tunnels" validate:"required"` +} + +// Constants associated with the VPNGatewayConnectionStaticRouteMode.AuthenticationMode property. +// The authentication mode. Only `psk` is currently supported. +const ( + VPNGatewayConnectionStaticRouteModeAuthenticationModePskConst = "psk" +) + +// Constants associated with the VPNGatewayConnectionStaticRouteMode.Mode property. +// The mode of the VPN gateway. +const ( + VPNGatewayConnectionStaticRouteModeModePolicyConst = "policy" + VPNGatewayConnectionStaticRouteModeModeRouteConst = "route" +) + +// Constants associated with the VPNGatewayConnectionStaticRouteMode.ResourceType property. +// The resource type. +const ( + VPNGatewayConnectionStaticRouteModeResourceTypeVPNGatewayConnectionConst = "vpn_gateway_connection" +) + +// Constants associated with the VPNGatewayConnectionStaticRouteMode.Status property. +// The status of a VPN gateway connection. +const ( + VPNGatewayConnectionStaticRouteModeStatusDownConst = "down" + VPNGatewayConnectionStaticRouteModeStatusUpConst = "up" +) + +// Constants associated with the VPNGatewayConnectionStaticRouteMode.RoutingProtocol property. +// Routing protocols are disabled for this VPN gateway connection. +const ( + VPNGatewayConnectionStaticRouteModeRoutingProtocolNoneConst = "none" +) + +func (*VPNGatewayConnectionStaticRouteMode) isaVPNGatewayConnection() bool { + return true +} + +// UnmarshalVPNGatewayConnectionStaticRouteMode unmarshals an instance of VPNGatewayConnectionStaticRouteMode from the specified map of raw messages. +func UnmarshalVPNGatewayConnectionStaticRouteMode(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayConnectionStaticRouteMode) + err = core.UnmarshalPrimitive(m, "admin_state_up", &obj.AdminStateUp) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "authentication_mode", &obj.AuthenticationMode) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalModel(m, "dead_peer_detection", &obj.DeadPeerDetection, UnmarshalVPNGatewayConnectionDpd) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalModel(m, "ike_policy", &obj.IkePolicy, UnmarshalIkePolicyReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "ipsec_policy", &obj.IpsecPolicy, UnmarshalIPsecPolicyReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "mode", &obj.Mode) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "peer_address", &obj.PeerAddress) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "psk", &obj.Psk) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "routing_protocol", &obj.RoutingProtocol) + if err != nil { + return + } + err = core.UnmarshalModel(m, "tunnels", &obj.Tunnels, UnmarshalVPNGatewayConnectionStaticRouteModeTunnel) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayPolicyMode : VPNGatewayPolicyMode struct +// This model "extends" VPNGateway +type VPNGatewayPolicyMode struct { + // Connections for this VPN gateway. + Connections []VPNGatewayConnectionReference `json:"connections" validate:"required"` + + // The date and time that this VPN gateway was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The VPN gateway's CRN. + CRN *string `json:"crn" validate:"required"` + + // The VPN gateway's canonical URL. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this VPN gateway. + ID *string `json:"id" validate:"required"` + + // Collection of VPN gateway members. + Members []VPNGatewayMember `json:"members" validate:"required"` + + // The name for this VPN gateway. The name is unique across all VPN gateways in the VPC. + Name *string `json:"name" validate:"required"` + + // The resource group for this VPN gateway. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The status of the VPN gateway. + Status *string `json:"status" validate:"required"` + + Subnet *SubnetReference `json:"subnet" validate:"required"` + + // The VPC this VPN gateway resides in. + VPC *VPCReference `json:"vpc" validate:"required"` + + // Policy mode VPN gateway. + Mode *string `json:"mode" validate:"required"` +} + +// Constants associated with the VPNGatewayPolicyMode.ResourceType property. +// The resource type. +const ( + VPNGatewayPolicyModeResourceTypeVPNGatewayConst = "vpn_gateway" +) + +// Constants associated with the VPNGatewayPolicyMode.Status property. +// The status of the VPN gateway. +const ( + VPNGatewayPolicyModeStatusAvailableConst = "available" + VPNGatewayPolicyModeStatusDeletingConst = "deleting" + VPNGatewayPolicyModeStatusFailedConst = "failed" + VPNGatewayPolicyModeStatusPendingConst = "pending" +) + +// Constants associated with the VPNGatewayPolicyMode.Mode property. +// Policy mode VPN gateway. +const ( + VPNGatewayPolicyModeModePolicyConst = "policy" +) + +func (*VPNGatewayPolicyMode) isaVPNGateway() bool { + return true +} + +// UnmarshalVPNGatewayPolicyMode unmarshals an instance of VPNGatewayPolicyMode from the specified map of raw messages. +func UnmarshalVPNGatewayPolicyMode(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayPolicyMode) + err = core.UnmarshalModel(m, "connections", &obj.Connections, UnmarshalVPNGatewayConnectionReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalModel(m, "members", &obj.Members, UnmarshalVPNGatewayMember) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnet", &obj.Subnet, UnmarshalSubnetReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "mode", &obj.Mode) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayPrototypeVPNGatewayPolicyModePrototype : VPNGatewayPrototypeVPNGatewayPolicyModePrototype struct +// This model "extends" VPNGatewayPrototype +type VPNGatewayPrototypeVPNGatewayPolicyModePrototype struct { + // The name for this VPN gateway. The name must not be used by another VPN gateway in the VPC. If unspecified, the name + // will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + Subnet SubnetIdentityIntf `json:"subnet" validate:"required"` + + // Policy mode VPN gateway. + Mode *string `json:"mode,omitempty"` +} + +// Constants associated with the VPNGatewayPrototypeVPNGatewayPolicyModePrototype.Mode property. +// Policy mode VPN gateway. +const ( + VPNGatewayPrototypeVPNGatewayPolicyModePrototypeModePolicyConst = "policy" +) + +// NewVPNGatewayPrototypeVPNGatewayPolicyModePrototype : Instantiate VPNGatewayPrototypeVPNGatewayPolicyModePrototype (Generic Model Constructor) +func (*VpcV1) NewVPNGatewayPrototypeVPNGatewayPolicyModePrototype(subnet SubnetIdentityIntf) (_model *VPNGatewayPrototypeVPNGatewayPolicyModePrototype, err error) { + _model = &VPNGatewayPrototypeVPNGatewayPolicyModePrototype{ + Subnet: subnet, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VPNGatewayPrototypeVPNGatewayPolicyModePrototype) isaVPNGatewayPrototype() bool { + return true +} + +// UnmarshalVPNGatewayPrototypeVPNGatewayPolicyModePrototype unmarshals an instance of VPNGatewayPrototypeVPNGatewayPolicyModePrototype from the specified map of raw messages. +func UnmarshalVPNGatewayPrototypeVPNGatewayPolicyModePrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayPrototypeVPNGatewayPolicyModePrototype) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnet", &obj.Subnet, UnmarshalSubnetIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "mode", &obj.Mode) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayPrototypeVPNGatewayRouteModePrototype : VPNGatewayPrototypeVPNGatewayRouteModePrototype struct +// This model "extends" VPNGatewayPrototype +type VPNGatewayPrototypeVPNGatewayRouteModePrototype struct { + // The name for this VPN gateway. The name must not be used by another VPN gateway in the VPC. If unspecified, the name + // will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + Subnet SubnetIdentityIntf `json:"subnet" validate:"required"` + + // Route mode VPN gateway. + Mode *string `json:"mode,omitempty"` +} + +// Constants associated with the VPNGatewayPrototypeVPNGatewayRouteModePrototype.Mode property. +// Route mode VPN gateway. +const ( + VPNGatewayPrototypeVPNGatewayRouteModePrototypeModeRouteConst = "route" +) + +// NewVPNGatewayPrototypeVPNGatewayRouteModePrototype : Instantiate VPNGatewayPrototypeVPNGatewayRouteModePrototype (Generic Model Constructor) +func (*VpcV1) NewVPNGatewayPrototypeVPNGatewayRouteModePrototype(subnet SubnetIdentityIntf) (_model *VPNGatewayPrototypeVPNGatewayRouteModePrototype, err error) { + _model = &VPNGatewayPrototypeVPNGatewayRouteModePrototype{ + Subnet: subnet, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VPNGatewayPrototypeVPNGatewayRouteModePrototype) isaVPNGatewayPrototype() bool { + return true +} + +// UnmarshalVPNGatewayPrototypeVPNGatewayRouteModePrototype unmarshals an instance of VPNGatewayPrototypeVPNGatewayRouteModePrototype from the specified map of raw messages. +func UnmarshalVPNGatewayPrototypeVPNGatewayRouteModePrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayPrototypeVPNGatewayRouteModePrototype) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnet", &obj.Subnet, UnmarshalSubnetIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "mode", &obj.Mode) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNGatewayRouteMode : VPNGatewayRouteMode struct +// This model "extends" VPNGateway +type VPNGatewayRouteMode struct { + // Connections for this VPN gateway. + Connections []VPNGatewayConnectionReference `json:"connections" validate:"required"` + + // The date and time that this VPN gateway was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The VPN gateway's CRN. + CRN *string `json:"crn" validate:"required"` + + // The VPN gateway's canonical URL. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this VPN gateway. + ID *string `json:"id" validate:"required"` + + // Collection of VPN gateway members. + Members []VPNGatewayMember `json:"members" validate:"required"` + + // The name for this VPN gateway. The name is unique across all VPN gateways in the VPC. + Name *string `json:"name" validate:"required"` + + // The resource group for this VPN gateway. + ResourceGroup *ResourceGroupReference `json:"resource_group" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The status of the VPN gateway. + Status *string `json:"status" validate:"required"` + + Subnet *SubnetReference `json:"subnet" validate:"required"` + + // The VPC this VPN gateway resides in. + VPC *VPCReference `json:"vpc" validate:"required"` + + // Route mode VPN gateway. + Mode *string `json:"mode" validate:"required"` +} + +// Constants associated with the VPNGatewayRouteMode.ResourceType property. +// The resource type. +const ( + VPNGatewayRouteModeResourceTypeVPNGatewayConst = "vpn_gateway" +) + +// Constants associated with the VPNGatewayRouteMode.Status property. +// The status of the VPN gateway. +const ( + VPNGatewayRouteModeStatusAvailableConst = "available" + VPNGatewayRouteModeStatusDeletingConst = "deleting" + VPNGatewayRouteModeStatusFailedConst = "failed" + VPNGatewayRouteModeStatusPendingConst = "pending" +) + +// Constants associated with the VPNGatewayRouteMode.Mode property. +// Route mode VPN gateway. +const ( + VPNGatewayRouteModeModeRouteConst = "route" +) + +func (*VPNGatewayRouteMode) isaVPNGateway() bool { + return true +} + +// UnmarshalVPNGatewayRouteMode unmarshals an instance of VPNGatewayRouteMode from the specified map of raw messages. +func UnmarshalVPNGatewayRouteMode(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNGatewayRouteMode) + err = core.UnmarshalModel(m, "connections", &obj.Connections, UnmarshalVPNGatewayConnectionReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalModel(m, "members", &obj.Members, UnmarshalVPNGatewayMember) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + err = core.UnmarshalModel(m, "subnet", &obj.Subnet, UnmarshalSubnetReference) + if err != nil { + return + } + err = core.UnmarshalModel(m, "vpc", &obj.VPC, UnmarshalVPCReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "mode", &obj.Mode) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNServerAuthenticationByCertificate : VPNServerAuthenticationByCertificate struct +// This model "extends" VPNServerAuthentication +type VPNServerAuthenticationByCertificate struct { + // The type of authentication. + Method *string `json:"method" validate:"required"` + + // The certificate instance used for the VPN client certificate authority (CA). + ClientCa *CertificateInstanceReference `json:"client_ca" validate:"required"` + + // The certificate revocation list contents, encoded in PEM format. + Crl *string `json:"crl,omitempty"` +} + +// Constants associated with the VPNServerAuthenticationByCertificate.Method property. +// The type of authentication. +const ( + VPNServerAuthenticationByCertificateMethodCertificateConst = "certificate" + VPNServerAuthenticationByCertificateMethodUsernameConst = "username" +) + +func (*VPNServerAuthenticationByCertificate) isaVPNServerAuthentication() bool { + return true +} + +// UnmarshalVPNServerAuthenticationByCertificate unmarshals an instance of VPNServerAuthenticationByCertificate from the specified map of raw messages. +func UnmarshalVPNServerAuthenticationByCertificate(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNServerAuthenticationByCertificate) + err = core.UnmarshalPrimitive(m, "method", &obj.Method) + if err != nil { + return + } + err = core.UnmarshalModel(m, "client_ca", &obj.ClientCa, UnmarshalCertificateInstanceReference) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crl", &obj.Crl) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNServerAuthenticationByUsername : VPNServerAuthenticationByUsername struct +// This model "extends" VPNServerAuthentication +type VPNServerAuthenticationByUsername struct { + // The type of authentication. + Method *string `json:"method" validate:"required"` + + // The type of identity provider to be used by VPN client. + IdentityProvider VPNServerAuthenticationByUsernameIDProviderIntf `json:"identity_provider" validate:"required"` +} + +// Constants associated with the VPNServerAuthenticationByUsername.Method property. +// The type of authentication. +const ( + VPNServerAuthenticationByUsernameMethodCertificateConst = "certificate" + VPNServerAuthenticationByUsernameMethodUsernameConst = "username" +) + +func (*VPNServerAuthenticationByUsername) isaVPNServerAuthentication() bool { + return true +} + +// UnmarshalVPNServerAuthenticationByUsername unmarshals an instance of VPNServerAuthenticationByUsername from the specified map of raw messages. +func UnmarshalVPNServerAuthenticationByUsername(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNServerAuthenticationByUsername) + err = core.UnmarshalPrimitive(m, "method", &obj.Method) + if err != nil { + return + } + err = core.UnmarshalModel(m, "identity_provider", &obj.IdentityProvider, UnmarshalVPNServerAuthenticationByUsernameIDProvider) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNServerAuthenticationByUsernameIDProviderByIam : VPNServerAuthenticationByUsernameIDProviderByIam struct +// This model "extends" VPNServerAuthenticationByUsernameIDProvider +type VPNServerAuthenticationByUsernameIDProviderByIam struct { + // The type of identity provider to be used by the VPN client. + // - `iam`: IBM identity and access management + // + // The enumerated values for this property are expected to expand in the future. When processing this property, check + // for and log unknown values. Optionally halt processing and surface the error, or bypass the route on which the + // unexpected property value was encountered. + ProviderType *string `json:"provider_type" validate:"required"` +} + +// Constants associated with the VPNServerAuthenticationByUsernameIDProviderByIam.ProviderType property. +// The type of identity provider to be used by the VPN client. +// - `iam`: IBM identity and access management +// +// The enumerated values for this property are expected to expand in the future. When processing this property, check +// for and log unknown values. Optionally halt processing and surface the error, or bypass the route on which the +// unexpected property value was encountered. +const ( + VPNServerAuthenticationByUsernameIDProviderByIamProviderTypeIamConst = "iam" +) + +// NewVPNServerAuthenticationByUsernameIDProviderByIam : Instantiate VPNServerAuthenticationByUsernameIDProviderByIam (Generic Model Constructor) +func (*VpcV1) NewVPNServerAuthenticationByUsernameIDProviderByIam(providerType string) (_model *VPNServerAuthenticationByUsernameIDProviderByIam, err error) { + _model = &VPNServerAuthenticationByUsernameIDProviderByIam{ + ProviderType: core.StringPtr(providerType), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VPNServerAuthenticationByUsernameIDProviderByIam) isaVPNServerAuthenticationByUsernameIDProvider() bool { + return true +} + +// UnmarshalVPNServerAuthenticationByUsernameIDProviderByIam unmarshals an instance of VPNServerAuthenticationByUsernameIDProviderByIam from the specified map of raw messages. +func UnmarshalVPNServerAuthenticationByUsernameIDProviderByIam(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNServerAuthenticationByUsernameIDProviderByIam) + err = core.UnmarshalPrimitive(m, "provider_type", &obj.ProviderType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNServerAuthenticationPrototypeVPNServerAuthenticationByCertificatePrototype : VPNServerAuthenticationPrototypeVPNServerAuthenticationByCertificatePrototype struct +// This model "extends" VPNServerAuthenticationPrototype +type VPNServerAuthenticationPrototypeVPNServerAuthenticationByCertificatePrototype struct { + // The type of authentication. + Method *string `json:"method" validate:"required"` + + // The certificate instance to use for the VPN client certificate authority (CA). + ClientCa CertificateInstanceIdentityIntf `json:"client_ca" validate:"required"` + + // The certificate revocation list contents, encoded in PEM format. + Crl *string `json:"crl,omitempty"` +} + +// Constants associated with the VPNServerAuthenticationPrototypeVPNServerAuthenticationByCertificatePrototype.Method property. +// The type of authentication. +const ( + VPNServerAuthenticationPrototypeVPNServerAuthenticationByCertificatePrototypeMethodCertificateConst = "certificate" + VPNServerAuthenticationPrototypeVPNServerAuthenticationByCertificatePrototypeMethodUsernameConst = "username" +) + +// NewVPNServerAuthenticationPrototypeVPNServerAuthenticationByCertificatePrototype : Instantiate VPNServerAuthenticationPrototypeVPNServerAuthenticationByCertificatePrototype (Generic Model Constructor) +func (*VpcV1) NewVPNServerAuthenticationPrototypeVPNServerAuthenticationByCertificatePrototype(method string, clientCa CertificateInstanceIdentityIntf) (_model *VPNServerAuthenticationPrototypeVPNServerAuthenticationByCertificatePrototype, err error) { + _model = &VPNServerAuthenticationPrototypeVPNServerAuthenticationByCertificatePrototype{ + Method: core.StringPtr(method), + ClientCa: clientCa, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VPNServerAuthenticationPrototypeVPNServerAuthenticationByCertificatePrototype) isaVPNServerAuthenticationPrototype() bool { + return true +} + +// UnmarshalVPNServerAuthenticationPrototypeVPNServerAuthenticationByCertificatePrototype unmarshals an instance of VPNServerAuthenticationPrototypeVPNServerAuthenticationByCertificatePrototype from the specified map of raw messages. +func UnmarshalVPNServerAuthenticationPrototypeVPNServerAuthenticationByCertificatePrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNServerAuthenticationPrototypeVPNServerAuthenticationByCertificatePrototype) + err = core.UnmarshalPrimitive(m, "method", &obj.Method) + if err != nil { + return + } + err = core.UnmarshalModel(m, "client_ca", &obj.ClientCa, UnmarshalCertificateInstanceIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crl", &obj.Crl) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VPNServerAuthenticationPrototypeVPNServerAuthenticationByUsernamePrototype : VPNServerAuthenticationPrototypeVPNServerAuthenticationByUsernamePrototype struct +// This model "extends" VPNServerAuthenticationPrototype +type VPNServerAuthenticationPrototypeVPNServerAuthenticationByUsernamePrototype struct { + // The type of authentication. + Method *string `json:"method" validate:"required"` + + // The type of identity provider to be used by VPN client. + IdentityProvider VPNServerAuthenticationByUsernameIDProviderIntf `json:"identity_provider" validate:"required"` +} + +// Constants associated with the VPNServerAuthenticationPrototypeVPNServerAuthenticationByUsernamePrototype.Method property. +// The type of authentication. +const ( + VPNServerAuthenticationPrototypeVPNServerAuthenticationByUsernamePrototypeMethodCertificateConst = "certificate" + VPNServerAuthenticationPrototypeVPNServerAuthenticationByUsernamePrototypeMethodUsernameConst = "username" +) + +// NewVPNServerAuthenticationPrototypeVPNServerAuthenticationByUsernamePrototype : Instantiate VPNServerAuthenticationPrototypeVPNServerAuthenticationByUsernamePrototype (Generic Model Constructor) +func (*VpcV1) NewVPNServerAuthenticationPrototypeVPNServerAuthenticationByUsernamePrototype(method string, identityProvider VPNServerAuthenticationByUsernameIDProviderIntf) (_model *VPNServerAuthenticationPrototypeVPNServerAuthenticationByUsernamePrototype, err error) { + _model = &VPNServerAuthenticationPrototypeVPNServerAuthenticationByUsernamePrototype{ + Method: core.StringPtr(method), + IdentityProvider: identityProvider, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VPNServerAuthenticationPrototypeVPNServerAuthenticationByUsernamePrototype) isaVPNServerAuthenticationPrototype() bool { + return true +} + +// UnmarshalVPNServerAuthenticationPrototypeVPNServerAuthenticationByUsernamePrototype unmarshals an instance of VPNServerAuthenticationPrototypeVPNServerAuthenticationByUsernamePrototype from the specified map of raw messages. +func UnmarshalVPNServerAuthenticationPrototypeVPNServerAuthenticationByUsernamePrototype(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VPNServerAuthenticationPrototypeVPNServerAuthenticationByUsernamePrototype) + err = core.UnmarshalPrimitive(m, "method", &obj.Method) + if err != nil { + return + } + err = core.UnmarshalModel(m, "identity_provider", &obj.IdentityProvider, UnmarshalVPNServerAuthenticationByUsernameIDProvider) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContext : Identifies a reserved IP by a unique property. Required if `subnet` is not specified. The reserved IP must be +// currently unbound. +// Models which "extend" this model: +// - VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextByID +// - VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextByHref +// This model "extends" VirtualNetworkInterfacePrimaryIPPrototype +type VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContext struct { + // The unique identifier for this reserved IP. + ID *string `json:"id,omitempty"` + + // The URL for this reserved IP. + Href *string `json:"href,omitempty"` +} + +func (*VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContext) isaVirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContext() bool { + return true +} + +type VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextIntf interface { + VirtualNetworkInterfacePrimaryIPPrototypeIntf + isaVirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContext() bool +} + +func (*VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContext) isaVirtualNetworkInterfacePrimaryIPPrototype() bool { + return true +} + +// UnmarshalVirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContext unmarshals an instance of VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContext from the specified map of raw messages. +func UnmarshalVirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContext) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VirtualNetworkInterfacePrimaryIPPrototypeReservedIPPrototypeVirtualNetworkInterfacePrimaryIPContext : The prototype for a new reserved IP. Requires `subnet` to be specified. +// This model "extends" VirtualNetworkInterfacePrimaryIPPrototype +type VirtualNetworkInterfacePrimaryIPPrototypeReservedIPPrototypeVirtualNetworkInterfacePrimaryIPContext struct { + // The IP address to reserve, which must not already be reserved on the subnet. + // + // If unspecified, an available address on the subnet will automatically be selected. + Address *string `json:"address,omitempty"` + + // Indicates whether this reserved IP member will be automatically deleted when either + // `target` is deleted, or the reserved IP is unbound. + AutoDelete *bool `json:"auto_delete,omitempty"` + + // The name for this reserved IP. The name must not be used by another reserved IP in the subnet. Names starting with + // `ibm-` are reserved for provider-owned resources, and are not allowed. If unspecified, the name will be a hyphenated + // list of randomly-selected words. + Name *string `json:"name,omitempty"` +} + +func (*VirtualNetworkInterfacePrimaryIPPrototypeReservedIPPrototypeVirtualNetworkInterfacePrimaryIPContext) isaVirtualNetworkInterfacePrimaryIPPrototype() bool { + return true +} + +// UnmarshalVirtualNetworkInterfacePrimaryIPPrototypeReservedIPPrototypeVirtualNetworkInterfacePrimaryIPContext unmarshals an instance of VirtualNetworkInterfacePrimaryIPPrototypeReservedIPPrototypeVirtualNetworkInterfacePrimaryIPContext from the specified map of raw messages. +func UnmarshalVirtualNetworkInterfacePrimaryIPPrototypeReservedIPPrototypeVirtualNetworkInterfacePrimaryIPContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VirtualNetworkInterfacePrimaryIPPrototypeReservedIPPrototypeVirtualNetworkInterfacePrimaryIPContext) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "auto_delete", &obj.AutoDelete) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VirtualNetworkInterfaceTargetShareMountTargetReference : VirtualNetworkInterfaceTargetShareMountTargetReference struct +// This model "extends" VirtualNetworkInterfaceTarget +type VirtualNetworkInterfaceTargetShareMountTargetReference struct { + // If present, this property indicates the referenced resource has been deleted, and provides + // some supplementary information. + Deleted *ShareMountTargetReferenceDeleted `json:"deleted,omitempty"` + + // The URL for this share mount target. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this share mount target. + ID *string `json:"id" validate:"required"` + + // The name for this share mount target. The name is unique across all mount targets for the file share. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` +} + +// Constants associated with the VirtualNetworkInterfaceTargetShareMountTargetReference.ResourceType property. +// The resource type. +const ( + VirtualNetworkInterfaceTargetShareMountTargetReferenceResourceTypeShareMountTargetConst = "share_mount_target" +) + +func (*VirtualNetworkInterfaceTargetShareMountTargetReference) isaVirtualNetworkInterfaceTarget() bool { + return true +} + +// UnmarshalVirtualNetworkInterfaceTargetShareMountTargetReference unmarshals an instance of VirtualNetworkInterfaceTargetShareMountTargetReference from the specified map of raw messages. +func UnmarshalVirtualNetworkInterfaceTargetShareMountTargetReference(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VirtualNetworkInterfaceTargetShareMountTargetReference) + err = core.UnmarshalModel(m, "deleted", &obj.Deleted, UnmarshalShareMountTargetReferenceDeleted) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeAttachmentPrototypeVolumeVolumeIdentity : Identifies a volume by a unique property. +// Models which "extend" this model: +// - VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByID +// - VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByCRN +// - VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByHref +// This model "extends" VolumeAttachmentPrototypeVolume +type VolumeAttachmentPrototypeVolumeVolumeIdentity struct { + // The unique identifier for this volume. + ID *string `json:"id,omitempty"` + + // The CRN for this volume. + CRN *string `json:"crn,omitempty"` + + // The URL for this volume. + Href *string `json:"href,omitempty"` +} + +func (*VolumeAttachmentPrototypeVolumeVolumeIdentity) isaVolumeAttachmentPrototypeVolumeVolumeIdentity() bool { + return true +} + +type VolumeAttachmentPrototypeVolumeVolumeIdentityIntf interface { + VolumeAttachmentPrototypeVolumeIntf + isaVolumeAttachmentPrototypeVolumeVolumeIdentity() bool +} + +func (*VolumeAttachmentPrototypeVolumeVolumeIdentity) isaVolumeAttachmentPrototypeVolume() bool { + return true +} + +// UnmarshalVolumeAttachmentPrototypeVolumeVolumeIdentity unmarshals an instance of VolumeAttachmentPrototypeVolumeVolumeIdentity from the specified map of raw messages. +func UnmarshalVolumeAttachmentPrototypeVolumeVolumeIdentity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeAttachmentPrototypeVolumeVolumeIdentity) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContext : VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContext struct +// Models which "extend" this model: +// - VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextVolumePrototypeInstanceContextVolumeByCapacity +// - VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextVolumePrototypeInstanceContextVolumeBySourceSnapshot +// This model "extends" VolumeAttachmentPrototypeVolume +type VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContext struct { + // The maximum I/O operations per second (IOPS) to use for this volume. Applicable only to volumes using a profile + // `family` of `custom`. + Iops *int64 `json:"iops,omitempty"` + + // The name for this volume. The name must not be used by another volume in the region. If unspecified, the name will + // be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-block-storage-profiles) to + // use for this volume. + Profile VolumeProfileIdentityIntf `json:"profile" validate:"required"` + + // The resource group to use for this volume. If unspecified, the instance's resource + // group will be used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The [user tags](https://cloud.ibm.com/apidocs/tagging#types-of-tags) associated with this volume. + UserTags []string `json:"user_tags,omitempty"` + + // The capacity to use for the volume (in gigabytes). The specified minimum and maximum capacity values for creating or + // updating volumes may expand in the future. + Capacity *int64 `json:"capacity,omitempty"` + + // The root key to use to wrap the data encryption key for the volume. + // + // If unspecified, the `encryption` type for the volume will be `provider_managed`. + EncryptionKey EncryptionKeyIdentityIntf `json:"encryption_key,omitempty"` + + // The snapshot from which to clone the volume. + SourceSnapshot SnapshotIdentityIntf `json:"source_snapshot,omitempty"` +} + +func (*VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContext) isaVolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContext() bool { + return true +} + +type VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextIntf interface { + VolumeAttachmentPrototypeVolumeIntf + isaVolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContext() bool +} + +func (*VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContext) isaVolumeAttachmentPrototypeVolume() bool { + return true +} + +// UnmarshalVolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContext unmarshals an instance of VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContext from the specified map of raw messages. +func UnmarshalVolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContext(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContext) + err = core.UnmarshalPrimitive(m, "iops", &obj.Iops) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalVolumeProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_tags", &obj.UserTags) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "capacity", &obj.Capacity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "encryption_key", &obj.EncryptionKey, UnmarshalEncryptionKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "source_snapshot", &obj.SourceSnapshot, UnmarshalSnapshotIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeIdentityByCRN : VolumeIdentityByCRN struct +// This model "extends" VolumeIdentity +type VolumeIdentityByCRN struct { + // The CRN for this volume. + CRN *string `json:"crn" validate:"required"` +} + +// NewVolumeIdentityByCRN : Instantiate VolumeIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewVolumeIdentityByCRN(crn string) (_model *VolumeIdentityByCRN, err error) { + _model = &VolumeIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VolumeIdentityByCRN) isaVolumeIdentity() bool { + return true +} + +// UnmarshalVolumeIdentityByCRN unmarshals an instance of VolumeIdentityByCRN from the specified map of raw messages. +func UnmarshalVolumeIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeIdentityByHref : VolumeIdentityByHref struct +// This model "extends" VolumeIdentity +type VolumeIdentityByHref struct { + // The URL for this volume. + Href *string `json:"href" validate:"required"` +} + +// NewVolumeIdentityByHref : Instantiate VolumeIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewVolumeIdentityByHref(href string) (_model *VolumeIdentityByHref, err error) { + _model = &VolumeIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VolumeIdentityByHref) isaVolumeIdentity() bool { + return true +} + +// UnmarshalVolumeIdentityByHref unmarshals an instance of VolumeIdentityByHref from the specified map of raw messages. +func UnmarshalVolumeIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeIdentityByID : VolumeIdentityByID struct +// This model "extends" VolumeIdentity +type VolumeIdentityByID struct { + // The unique identifier for this volume. + ID *string `json:"id" validate:"required"` +} + +// NewVolumeIdentityByID : Instantiate VolumeIdentityByID (Generic Model Constructor) +func (*VpcV1) NewVolumeIdentityByID(id string) (_model *VolumeIdentityByID, err error) { + _model = &VolumeIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VolumeIdentityByID) isaVolumeIdentity() bool { + return true +} + +// UnmarshalVolumeIdentityByID unmarshals an instance of VolumeIdentityByID from the specified map of raw messages. +func UnmarshalVolumeIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeProfileIdentityByHref : VolumeProfileIdentityByHref struct +// This model "extends" VolumeProfileIdentity +type VolumeProfileIdentityByHref struct { + // The URL for this volume profile. + Href *string `json:"href" validate:"required"` +} + +// NewVolumeProfileIdentityByHref : Instantiate VolumeProfileIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewVolumeProfileIdentityByHref(href string) (_model *VolumeProfileIdentityByHref, err error) { + _model = &VolumeProfileIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VolumeProfileIdentityByHref) isaVolumeProfileIdentity() bool { + return true +} + +// UnmarshalVolumeProfileIdentityByHref unmarshals an instance of VolumeProfileIdentityByHref from the specified map of raw messages. +func UnmarshalVolumeProfileIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeProfileIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeProfileIdentityByName : VolumeProfileIdentityByName struct +// This model "extends" VolumeProfileIdentity +type VolumeProfileIdentityByName struct { + // The globally unique name for this volume profile. + Name *string `json:"name" validate:"required"` +} + +// NewVolumeProfileIdentityByName : Instantiate VolumeProfileIdentityByName (Generic Model Constructor) +func (*VpcV1) NewVolumeProfileIdentityByName(name string) (_model *VolumeProfileIdentityByName, err error) { + _model = &VolumeProfileIdentityByName{ + Name: core.StringPtr(name), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VolumeProfileIdentityByName) isaVolumeProfileIdentity() bool { + return true +} + +// UnmarshalVolumeProfileIdentityByName unmarshals an instance of VolumeProfileIdentityByName from the specified map of raw messages. +func UnmarshalVolumeProfileIdentityByName(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeProfileIdentityByName) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumePrototypeVolumeByCapacity : VolumePrototypeVolumeByCapacity struct +// This model "extends" VolumePrototype +type VolumePrototypeVolumeByCapacity struct { + // The maximum I/O operations per second (IOPS) to use for this volume. Applicable only to volumes using a profile + // `family` of `custom`. + Iops *int64 `json:"iops,omitempty"` + + // The name for this volume. The name must not be used by another volume in the region. If unspecified, the name will + // be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-block-storage-profiles) to use for this volume. + Profile VolumeProfileIdentityIntf `json:"profile" validate:"required"` + + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The [user tags](https://cloud.ibm.com/apidocs/tagging#types-of-tags) associated with this volume. + UserTags []string `json:"user_tags,omitempty"` + + // The zone this volume will reside in. + Zone ZoneIdentityIntf `json:"zone" validate:"required"` + + // The capacity to use for the volume (in gigabytes). The specified minimum and maximum capacity values for creating or + // updating volumes may expand in the future. + Capacity *int64 `json:"capacity" validate:"required"` + + // The root key to use to wrap the data encryption key for the volume. + // + // If unspecified, the `encryption` type for the volume will be `provider_managed`. + EncryptionKey EncryptionKeyIdentityIntf `json:"encryption_key,omitempty"` +} + +// NewVolumePrototypeVolumeByCapacity : Instantiate VolumePrototypeVolumeByCapacity (Generic Model Constructor) +func (*VpcV1) NewVolumePrototypeVolumeByCapacity(profile VolumeProfileIdentityIntf, zone ZoneIdentityIntf, capacity int64) (_model *VolumePrototypeVolumeByCapacity, err error) { + _model = &VolumePrototypeVolumeByCapacity{ + Profile: profile, + Zone: zone, + Capacity: core.Int64Ptr(capacity), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VolumePrototypeVolumeByCapacity) isaVolumePrototype() bool { + return true +} + +// UnmarshalVolumePrototypeVolumeByCapacity unmarshals an instance of VolumePrototypeVolumeByCapacity from the specified map of raw messages. +func UnmarshalVolumePrototypeVolumeByCapacity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumePrototypeVolumeByCapacity) + err = core.UnmarshalPrimitive(m, "iops", &obj.Iops) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalVolumeProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_tags", &obj.UserTags) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "capacity", &obj.Capacity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "encryption_key", &obj.EncryptionKey, UnmarshalEncryptionKeyIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumePrototypeVolumeBySourceSnapshot : VolumePrototypeVolumeBySourceSnapshot struct +// This model "extends" VolumePrototype +type VolumePrototypeVolumeBySourceSnapshot struct { + // The maximum I/O operations per second (IOPS) to use for this volume. Applicable only to volumes using a profile + // `family` of `custom`. + Iops *int64 `json:"iops,omitempty"` + + // The name for this volume. The name must not be used by another volume in the region. If unspecified, the name will + // be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-block-storage-profiles) to use for this volume. + Profile VolumeProfileIdentityIntf `json:"profile" validate:"required"` + + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The [user tags](https://cloud.ibm.com/apidocs/tagging#types-of-tags) associated with this volume. + UserTags []string `json:"user_tags,omitempty"` + + // The zone this volume will reside in. + Zone ZoneIdentityIntf `json:"zone" validate:"required"` + + // The capacity to use for the volume (in gigabytes). Must be at least the snapshot's + // `minimum_capacity`. The maximum value may increase in the future. + // + // If unspecified, the capacity will be the source snapshot's `minimum_capacity`. + Capacity *int64 `json:"capacity,omitempty"` + + // The root key to use to wrap the data encryption key for the volume. + // + // If unspecified, the `encryption` type for the volume will be `provider_managed`. + EncryptionKey EncryptionKeyIdentityIntf `json:"encryption_key,omitempty"` + + // The snapshot from which to clone the volume. + SourceSnapshot SnapshotIdentityIntf `json:"source_snapshot" validate:"required"` +} + +// NewVolumePrototypeVolumeBySourceSnapshot : Instantiate VolumePrototypeVolumeBySourceSnapshot (Generic Model Constructor) +func (*VpcV1) NewVolumePrototypeVolumeBySourceSnapshot(profile VolumeProfileIdentityIntf, zone ZoneIdentityIntf, sourceSnapshot SnapshotIdentityIntf) (_model *VolumePrototypeVolumeBySourceSnapshot, err error) { + _model = &VolumePrototypeVolumeBySourceSnapshot{ + Profile: profile, + Zone: zone, + SourceSnapshot: sourceSnapshot, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VolumePrototypeVolumeBySourceSnapshot) isaVolumePrototype() bool { + return true +} + +// UnmarshalVolumePrototypeVolumeBySourceSnapshot unmarshals an instance of VolumePrototypeVolumeBySourceSnapshot from the specified map of raw messages. +func UnmarshalVolumePrototypeVolumeBySourceSnapshot(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumePrototypeVolumeBySourceSnapshot) + err = core.UnmarshalPrimitive(m, "iops", &obj.Iops) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalVolumeProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_tags", &obj.UserTags) + if err != nil { + return + } + err = core.UnmarshalModel(m, "zone", &obj.Zone, UnmarshalZoneIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "capacity", &obj.Capacity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "encryption_key", &obj.EncryptionKey, UnmarshalEncryptionKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "source_snapshot", &obj.SourceSnapshot, UnmarshalSnapshotIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ZoneIdentityByHref : ZoneIdentityByHref struct +// This model "extends" ZoneIdentity +type ZoneIdentityByHref struct { + // The URL for this zone. + Href *string `json:"href" validate:"required"` +} + +// NewZoneIdentityByHref : Instantiate ZoneIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewZoneIdentityByHref(href string) (_model *ZoneIdentityByHref, err error) { + _model = &ZoneIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*ZoneIdentityByHref) isaZoneIdentity() bool { + return true +} + +// UnmarshalZoneIdentityByHref unmarshals an instance of ZoneIdentityByHref from the specified map of raw messages. +func UnmarshalZoneIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ZoneIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ZoneIdentityByName : ZoneIdentityByName struct +// This model "extends" ZoneIdentity +type ZoneIdentityByName struct { + // The globally unique name for this zone. + Name *string `json:"name" validate:"required"` +} + +// NewZoneIdentityByName : Instantiate ZoneIdentityByName (Generic Model Constructor) +func (*VpcV1) NewZoneIdentityByName(name string) (_model *ZoneIdentityByName, err error) { + _model = &ZoneIdentityByName{ + Name: core.StringPtr(name), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*ZoneIdentityByName) isaZoneIdentity() bool { + return true +} + +// UnmarshalZoneIdentityByName unmarshals an instance of ZoneIdentityByName from the specified map of raw messages. +func UnmarshalZoneIdentityByName(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ZoneIdentityByName) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// EndpointGatewayReservedIPReservedIPIdentityByHref : EndpointGatewayReservedIPReservedIPIdentityByHref struct +// This model "extends" EndpointGatewayReservedIPReservedIPIdentity +type EndpointGatewayReservedIPReservedIPIdentityByHref struct { + // The URL for this reserved IP. + Href *string `json:"href" validate:"required"` +} + +// NewEndpointGatewayReservedIPReservedIPIdentityByHref : Instantiate EndpointGatewayReservedIPReservedIPIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewEndpointGatewayReservedIPReservedIPIdentityByHref(href string) (_model *EndpointGatewayReservedIPReservedIPIdentityByHref, err error) { + _model = &EndpointGatewayReservedIPReservedIPIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*EndpointGatewayReservedIPReservedIPIdentityByHref) isaEndpointGatewayReservedIPReservedIPIdentity() bool { + return true +} + +func (*EndpointGatewayReservedIPReservedIPIdentityByHref) isaEndpointGatewayReservedIP() bool { + return true +} + +// UnmarshalEndpointGatewayReservedIPReservedIPIdentityByHref unmarshals an instance of EndpointGatewayReservedIPReservedIPIdentityByHref from the specified map of raw messages. +func UnmarshalEndpointGatewayReservedIPReservedIPIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(EndpointGatewayReservedIPReservedIPIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// EndpointGatewayReservedIPReservedIPIdentityByID : EndpointGatewayReservedIPReservedIPIdentityByID struct +// This model "extends" EndpointGatewayReservedIPReservedIPIdentity +type EndpointGatewayReservedIPReservedIPIdentityByID struct { + // The unique identifier for this reserved IP. + ID *string `json:"id" validate:"required"` +} + +// NewEndpointGatewayReservedIPReservedIPIdentityByID : Instantiate EndpointGatewayReservedIPReservedIPIdentityByID (Generic Model Constructor) +func (*VpcV1) NewEndpointGatewayReservedIPReservedIPIdentityByID(id string) (_model *EndpointGatewayReservedIPReservedIPIdentityByID, err error) { + _model = &EndpointGatewayReservedIPReservedIPIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*EndpointGatewayReservedIPReservedIPIdentityByID) isaEndpointGatewayReservedIPReservedIPIdentity() bool { + return true +} + +func (*EndpointGatewayReservedIPReservedIPIdentityByID) isaEndpointGatewayReservedIP() bool { + return true +} + +// UnmarshalEndpointGatewayReservedIPReservedIPIdentityByID unmarshals an instance of EndpointGatewayReservedIPReservedIPIdentityByID from the specified map of raw messages. +func UnmarshalEndpointGatewayReservedIPReservedIPIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(EndpointGatewayReservedIPReservedIPIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// EndpointGatewayTargetPrototypeProviderCloudServiceIdentityProviderCloudServiceIdentityByCRN : EndpointGatewayTargetPrototypeProviderCloudServiceIdentityProviderCloudServiceIdentityByCRN struct +// This model "extends" EndpointGatewayTargetPrototypeProviderCloudServiceIdentity +type EndpointGatewayTargetPrototypeProviderCloudServiceIdentityProviderCloudServiceIdentityByCRN struct { + // The type of target for this endpoint gateway. + ResourceType *string `json:"resource_type" validate:"required"` + + // The CRN for this provider cloud service, or the CRN for the user's instance of a provider cloud service. + CRN *string `json:"crn" validate:"required"` +} + +// Constants associated with the EndpointGatewayTargetPrototypeProviderCloudServiceIdentityProviderCloudServiceIdentityByCRN.ResourceType property. +// The type of target for this endpoint gateway. +const ( + EndpointGatewayTargetPrototypeProviderCloudServiceIdentityProviderCloudServiceIdentityByCRNResourceTypeProviderCloudServiceConst = "provider_cloud_service" + EndpointGatewayTargetPrototypeProviderCloudServiceIdentityProviderCloudServiceIdentityByCRNResourceTypeProviderInfrastructureServiceConst = "provider_infrastructure_service" +) + +// NewEndpointGatewayTargetPrototypeProviderCloudServiceIdentityProviderCloudServiceIdentityByCRN : Instantiate EndpointGatewayTargetPrototypeProviderCloudServiceIdentityProviderCloudServiceIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewEndpointGatewayTargetPrototypeProviderCloudServiceIdentityProviderCloudServiceIdentityByCRN(resourceType string, crn string) (_model *EndpointGatewayTargetPrototypeProviderCloudServiceIdentityProviderCloudServiceIdentityByCRN, err error) { + _model = &EndpointGatewayTargetPrototypeProviderCloudServiceIdentityProviderCloudServiceIdentityByCRN{ + ResourceType: core.StringPtr(resourceType), + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*EndpointGatewayTargetPrototypeProviderCloudServiceIdentityProviderCloudServiceIdentityByCRN) isaEndpointGatewayTargetPrototypeProviderCloudServiceIdentity() bool { + return true +} + +func (*EndpointGatewayTargetPrototypeProviderCloudServiceIdentityProviderCloudServiceIdentityByCRN) isaEndpointGatewayTargetPrototype() bool { + return true +} + +// UnmarshalEndpointGatewayTargetPrototypeProviderCloudServiceIdentityProviderCloudServiceIdentityByCRN unmarshals an instance of EndpointGatewayTargetPrototypeProviderCloudServiceIdentityProviderCloudServiceIdentityByCRN from the specified map of raw messages. +func UnmarshalEndpointGatewayTargetPrototypeProviderCloudServiceIdentityProviderCloudServiceIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(EndpointGatewayTargetPrototypeProviderCloudServiceIdentityProviderCloudServiceIdentityByCRN) + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// EndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentityProviderInfrastructureServiceIdentityByName : The name of this provider infrastructure service. +// This model "extends" EndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentity +type EndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentityProviderInfrastructureServiceIdentityByName struct { + // The type of target for this endpoint gateway. + ResourceType *string `json:"resource_type" validate:"required"` + + // The name of a provider infrastructure service. Must be: + // - `ibm-ntp-server`: An NTP (Network Time Protocol) server provided by IBM. + Name *string `json:"name" validate:"required"` +} + +// Constants associated with the EndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentityProviderInfrastructureServiceIdentityByName.ResourceType property. +// The type of target for this endpoint gateway. +const ( + EndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentityProviderInfrastructureServiceIdentityByNameResourceTypeProviderCloudServiceConst = "provider_cloud_service" + EndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentityProviderInfrastructureServiceIdentityByNameResourceTypeProviderInfrastructureServiceConst = "provider_infrastructure_service" +) + +// NewEndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentityProviderInfrastructureServiceIdentityByName : Instantiate EndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentityProviderInfrastructureServiceIdentityByName (Generic Model Constructor) +func (*VpcV1) NewEndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentityProviderInfrastructureServiceIdentityByName(resourceType string, name string) (_model *EndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentityProviderInfrastructureServiceIdentityByName, err error) { + _model = &EndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentityProviderInfrastructureServiceIdentityByName{ + ResourceType: core.StringPtr(resourceType), + Name: core.StringPtr(name), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*EndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentityProviderInfrastructureServiceIdentityByName) isaEndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentity() bool { + return true +} + +func (*EndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentityProviderInfrastructureServiceIdentityByName) isaEndpointGatewayTargetPrototype() bool { + return true +} + +// UnmarshalEndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentityProviderInfrastructureServiceIdentityByName unmarshals an instance of EndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentityProviderInfrastructureServiceIdentityByName from the specified map of raw messages. +func UnmarshalEndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentityProviderInfrastructureServiceIdentityByName(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(EndpointGatewayTargetPrototypeProviderInfrastructureServiceIdentityProviderInfrastructureServiceIdentityByName) + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByHref : FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByHref struct +// This model "extends" FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentity +type FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByHref struct { + // The URL for this bare metal server network interface. + Href *string `json:"href" validate:"required"` +} + +// NewFloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByHref : Instantiate FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewFloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByHref(href string) (_model *FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByHref, err error) { + _model = &FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByHref) isaFloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentity() bool { + return true +} + +func (*FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByHref) isaFloatingIPTargetPatch() bool { + return true +} + +// UnmarshalFloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByHref unmarshals an instance of FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByHref from the specified map of raw messages. +func UnmarshalFloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByID : FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByID struct +// This model "extends" FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentity +type FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByID struct { + // The unique identifier for this bare metal server network interface. + ID *string `json:"id" validate:"required"` +} + +// NewFloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByID : Instantiate FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByID (Generic Model Constructor) +func (*VpcV1) NewFloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByID(id string) (_model *FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByID, err error) { + _model = &FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByID) isaFloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentity() bool { + return true +} + +func (*FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByID) isaFloatingIPTargetPatch() bool { + return true +} + +// UnmarshalFloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByID unmarshals an instance of FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByID from the specified map of raw messages. +func UnmarshalFloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FloatingIPTargetPatchBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FloatingIPTargetPatchNetworkInterfaceIdentityNetworkInterfaceIdentityByHref : FloatingIPTargetPatchNetworkInterfaceIdentityNetworkInterfaceIdentityByHref struct +// This model "extends" FloatingIPTargetPatchNetworkInterfaceIdentity +type FloatingIPTargetPatchNetworkInterfaceIdentityNetworkInterfaceIdentityByHref struct { + // The URL for this instance network interface. + Href *string `json:"href" validate:"required"` +} + +// NewFloatingIPTargetPatchNetworkInterfaceIdentityNetworkInterfaceIdentityByHref : Instantiate FloatingIPTargetPatchNetworkInterfaceIdentityNetworkInterfaceIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewFloatingIPTargetPatchNetworkInterfaceIdentityNetworkInterfaceIdentityByHref(href string) (_model *FloatingIPTargetPatchNetworkInterfaceIdentityNetworkInterfaceIdentityByHref, err error) { + _model = &FloatingIPTargetPatchNetworkInterfaceIdentityNetworkInterfaceIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*FloatingIPTargetPatchNetworkInterfaceIdentityNetworkInterfaceIdentityByHref) isaFloatingIPTargetPatchNetworkInterfaceIdentity() bool { + return true +} + +func (*FloatingIPTargetPatchNetworkInterfaceIdentityNetworkInterfaceIdentityByHref) isaFloatingIPTargetPatch() bool { + return true +} + +// UnmarshalFloatingIPTargetPatchNetworkInterfaceIdentityNetworkInterfaceIdentityByHref unmarshals an instance of FloatingIPTargetPatchNetworkInterfaceIdentityNetworkInterfaceIdentityByHref from the specified map of raw messages. +func UnmarshalFloatingIPTargetPatchNetworkInterfaceIdentityNetworkInterfaceIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FloatingIPTargetPatchNetworkInterfaceIdentityNetworkInterfaceIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FloatingIPTargetPatchNetworkInterfaceIdentityNetworkInterfaceIdentityByID : FloatingIPTargetPatchNetworkInterfaceIdentityNetworkInterfaceIdentityByID struct +// This model "extends" FloatingIPTargetPatchNetworkInterfaceIdentity +type FloatingIPTargetPatchNetworkInterfaceIdentityNetworkInterfaceIdentityByID struct { + // The unique identifier for this instance network interface. + ID *string `json:"id" validate:"required"` +} + +// NewFloatingIPTargetPatchNetworkInterfaceIdentityNetworkInterfaceIdentityByID : Instantiate FloatingIPTargetPatchNetworkInterfaceIdentityNetworkInterfaceIdentityByID (Generic Model Constructor) +func (*VpcV1) NewFloatingIPTargetPatchNetworkInterfaceIdentityNetworkInterfaceIdentityByID(id string) (_model *FloatingIPTargetPatchNetworkInterfaceIdentityNetworkInterfaceIdentityByID, err error) { + _model = &FloatingIPTargetPatchNetworkInterfaceIdentityNetworkInterfaceIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*FloatingIPTargetPatchNetworkInterfaceIdentityNetworkInterfaceIdentityByID) isaFloatingIPTargetPatchNetworkInterfaceIdentity() bool { + return true +} + +func (*FloatingIPTargetPatchNetworkInterfaceIdentityNetworkInterfaceIdentityByID) isaFloatingIPTargetPatch() bool { + return true +} + +// UnmarshalFloatingIPTargetPatchNetworkInterfaceIdentityNetworkInterfaceIdentityByID unmarshals an instance of FloatingIPTargetPatchNetworkInterfaceIdentityNetworkInterfaceIdentityByID from the specified map of raw messages. +func UnmarshalFloatingIPTargetPatchNetworkInterfaceIdentityNetworkInterfaceIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FloatingIPTargetPatchNetworkInterfaceIdentityNetworkInterfaceIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByHref : FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByHref struct +// This model "extends" FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentity +type FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByHref struct { + // The URL for this bare metal server network interface. + Href *string `json:"href" validate:"required"` +} + +// NewFloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByHref : Instantiate FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewFloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByHref(href string) (_model *FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByHref, err error) { + _model = &FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByHref) isaFloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentity() bool { + return true +} + +func (*FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByHref) isaFloatingIPTargetPrototype() bool { + return true +} + +// UnmarshalFloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByHref unmarshals an instance of FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByHref from the specified map of raw messages. +func UnmarshalFloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByID : FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByID struct +// This model "extends" FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentity +type FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByID struct { + // The unique identifier for this bare metal server network interface. + ID *string `json:"id" validate:"required"` +} + +// NewFloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByID : Instantiate FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByID (Generic Model Constructor) +func (*VpcV1) NewFloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByID(id string) (_model *FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByID, err error) { + _model = &FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByID) isaFloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentity() bool { + return true +} + +func (*FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByID) isaFloatingIPTargetPrototype() bool { + return true +} + +// UnmarshalFloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByID unmarshals an instance of FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByID from the specified map of raw messages. +func UnmarshalFloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FloatingIPTargetPrototypeBareMetalServerNetworkInterfaceIdentityBareMetalServerNetworkInterfaceIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FloatingIPTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByHref : FloatingIPTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByHref struct +// This model "extends" FloatingIPTargetPrototypeNetworkInterfaceIdentity +type FloatingIPTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByHref struct { + // The URL for this instance network interface. + Href *string `json:"href" validate:"required"` +} + +// NewFloatingIPTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByHref : Instantiate FloatingIPTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewFloatingIPTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByHref(href string) (_model *FloatingIPTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByHref, err error) { + _model = &FloatingIPTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*FloatingIPTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByHref) isaFloatingIPTargetPrototypeNetworkInterfaceIdentity() bool { + return true +} + +func (*FloatingIPTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByHref) isaFloatingIPTargetPrototype() bool { + return true +} + +// UnmarshalFloatingIPTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByHref unmarshals an instance of FloatingIPTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByHref from the specified map of raw messages. +func UnmarshalFloatingIPTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FloatingIPTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FloatingIPTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByID : FloatingIPTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByID struct +// This model "extends" FloatingIPTargetPrototypeNetworkInterfaceIdentity +type FloatingIPTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByID struct { + // The unique identifier for this instance network interface. + ID *string `json:"id" validate:"required"` +} + +// NewFloatingIPTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByID : Instantiate FloatingIPTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByID (Generic Model Constructor) +func (*VpcV1) NewFloatingIPTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByID(id string) (_model *FloatingIPTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByID, err error) { + _model = &FloatingIPTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*FloatingIPTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByID) isaFloatingIPTargetPrototypeNetworkInterfaceIdentity() bool { + return true +} + +func (*FloatingIPTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByID) isaFloatingIPTargetPrototype() bool { + return true +} + +// UnmarshalFloatingIPTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByID unmarshals an instance of FloatingIPTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByID from the specified map of raw messages. +func UnmarshalFloatingIPTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FloatingIPTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByCRN : FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByCRN struct +// This model "extends" FlowLogCollectorTargetPrototypeInstanceIdentity +type FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByCRN struct { + // The CRN for this virtual server instance. + CRN *string `json:"crn" validate:"required"` +} + +// NewFlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByCRN : Instantiate FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewFlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByCRN(crn string) (_model *FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByCRN, err error) { + _model = &FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByCRN) isaFlowLogCollectorTargetPrototypeInstanceIdentity() bool { + return true +} + +func (*FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByCRN) isaFlowLogCollectorTargetPrototype() bool { + return true +} + +// UnmarshalFlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByCRN unmarshals an instance of FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByCRN from the specified map of raw messages. +func UnmarshalFlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByHref : FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByHref struct +// This model "extends" FlowLogCollectorTargetPrototypeInstanceIdentity +type FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByHref struct { + // The URL for this virtual server instance. + Href *string `json:"href" validate:"required"` +} + +// NewFlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByHref : Instantiate FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewFlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByHref(href string) (_model *FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByHref, err error) { + _model = &FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByHref) isaFlowLogCollectorTargetPrototypeInstanceIdentity() bool { + return true +} + +func (*FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByHref) isaFlowLogCollectorTargetPrototype() bool { + return true +} + +// UnmarshalFlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByHref unmarshals an instance of FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByHref from the specified map of raw messages. +func UnmarshalFlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByID : FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByID struct +// This model "extends" FlowLogCollectorTargetPrototypeInstanceIdentity +type FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByID struct { + // The unique identifier for this virtual server instance. + ID *string `json:"id" validate:"required"` +} + +// NewFlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByID : Instantiate FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByID (Generic Model Constructor) +func (*VpcV1) NewFlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByID(id string) (_model *FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByID, err error) { + _model = &FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByID) isaFlowLogCollectorTargetPrototypeInstanceIdentity() bool { + return true +} + +func (*FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByID) isaFlowLogCollectorTargetPrototype() bool { + return true +} + +// UnmarshalFlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByID unmarshals an instance of FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByID from the specified map of raw messages. +func UnmarshalFlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FlowLogCollectorTargetPrototypeInstanceIdentityInstanceIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FlowLogCollectorTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByHref : FlowLogCollectorTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByHref struct +// This model "extends" FlowLogCollectorTargetPrototypeNetworkInterfaceIdentity +type FlowLogCollectorTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByHref struct { + // The URL for this instance network interface. + Href *string `json:"href" validate:"required"` +} + +// NewFlowLogCollectorTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByHref : Instantiate FlowLogCollectorTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewFlowLogCollectorTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByHref(href string) (_model *FlowLogCollectorTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByHref, err error) { + _model = &FlowLogCollectorTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*FlowLogCollectorTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByHref) isaFlowLogCollectorTargetPrototypeNetworkInterfaceIdentity() bool { + return true +} + +func (*FlowLogCollectorTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByHref) isaFlowLogCollectorTargetPrototype() bool { + return true +} + +// UnmarshalFlowLogCollectorTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByHref unmarshals an instance of FlowLogCollectorTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByHref from the specified map of raw messages. +func UnmarshalFlowLogCollectorTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FlowLogCollectorTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FlowLogCollectorTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByID : FlowLogCollectorTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByID struct +// This model "extends" FlowLogCollectorTargetPrototypeNetworkInterfaceIdentity +type FlowLogCollectorTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByID struct { + // The unique identifier for this instance network interface. + ID *string `json:"id" validate:"required"` +} + +// NewFlowLogCollectorTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByID : Instantiate FlowLogCollectorTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByID (Generic Model Constructor) +func (*VpcV1) NewFlowLogCollectorTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByID(id string) (_model *FlowLogCollectorTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByID, err error) { + _model = &FlowLogCollectorTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*FlowLogCollectorTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByID) isaFlowLogCollectorTargetPrototypeNetworkInterfaceIdentity() bool { + return true +} + +func (*FlowLogCollectorTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByID) isaFlowLogCollectorTargetPrototype() bool { + return true +} + +// UnmarshalFlowLogCollectorTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByID unmarshals an instance of FlowLogCollectorTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByID from the specified map of raw messages. +func UnmarshalFlowLogCollectorTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FlowLogCollectorTargetPrototypeNetworkInterfaceIdentityNetworkInterfaceIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByCRN : FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByCRN struct +// This model "extends" FlowLogCollectorTargetPrototypeSubnetIdentity +type FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByCRN struct { + // The CRN for this subnet. + CRN *string `json:"crn" validate:"required"` +} + +// NewFlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByCRN : Instantiate FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewFlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByCRN(crn string) (_model *FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByCRN, err error) { + _model = &FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByCRN) isaFlowLogCollectorTargetPrototypeSubnetIdentity() bool { + return true +} + +func (*FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByCRN) isaFlowLogCollectorTargetPrototype() bool { + return true +} + +// UnmarshalFlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByCRN unmarshals an instance of FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByCRN from the specified map of raw messages. +func UnmarshalFlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByHref : FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByHref struct +// This model "extends" FlowLogCollectorTargetPrototypeSubnetIdentity +type FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByHref struct { + // The URL for this subnet. + Href *string `json:"href" validate:"required"` +} + +// NewFlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByHref : Instantiate FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewFlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByHref(href string) (_model *FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByHref, err error) { + _model = &FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByHref) isaFlowLogCollectorTargetPrototypeSubnetIdentity() bool { + return true +} + +func (*FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByHref) isaFlowLogCollectorTargetPrototype() bool { + return true +} + +// UnmarshalFlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByHref unmarshals an instance of FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByHref from the specified map of raw messages. +func UnmarshalFlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByID : FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByID struct +// This model "extends" FlowLogCollectorTargetPrototypeSubnetIdentity +type FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByID struct { + // The unique identifier for this subnet. + ID *string `json:"id" validate:"required"` +} + +// NewFlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByID : Instantiate FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByID (Generic Model Constructor) +func (*VpcV1) NewFlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByID(id string) (_model *FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByID, err error) { + _model = &FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByID) isaFlowLogCollectorTargetPrototypeSubnetIdentity() bool { + return true +} + +func (*FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByID) isaFlowLogCollectorTargetPrototype() bool { + return true +} + +// UnmarshalFlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByID unmarshals an instance of FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByID from the specified map of raw messages. +func UnmarshalFlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FlowLogCollectorTargetPrototypeSubnetIdentitySubnetIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByCRN : FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByCRN struct +// This model "extends" FlowLogCollectorTargetPrototypeVPCIdentity +type FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByCRN struct { + // The CRN for this VPC. + CRN *string `json:"crn" validate:"required"` +} + +// NewFlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByCRN : Instantiate FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewFlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByCRN(crn string) (_model *FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByCRN, err error) { + _model = &FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByCRN) isaFlowLogCollectorTargetPrototypeVPCIdentity() bool { + return true +} + +func (*FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByCRN) isaFlowLogCollectorTargetPrototype() bool { + return true +} + +// UnmarshalFlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByCRN unmarshals an instance of FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByCRN from the specified map of raw messages. +func UnmarshalFlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByHref : FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByHref struct +// This model "extends" FlowLogCollectorTargetPrototypeVPCIdentity +type FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByHref struct { + // The URL for this VPC. + Href *string `json:"href" validate:"required"` +} + +// NewFlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByHref : Instantiate FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewFlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByHref(href string) (_model *FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByHref, err error) { + _model = &FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByHref) isaFlowLogCollectorTargetPrototypeVPCIdentity() bool { + return true +} + +func (*FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByHref) isaFlowLogCollectorTargetPrototype() bool { + return true +} + +// UnmarshalFlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByHref unmarshals an instance of FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByHref from the specified map of raw messages. +func UnmarshalFlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByID : FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByID struct +// This model "extends" FlowLogCollectorTargetPrototypeVPCIdentity +type FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByID struct { + // The unique identifier for this VPC. + ID *string `json:"id" validate:"required"` +} + +// NewFlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByID : Instantiate FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByID (Generic Model Constructor) +func (*VpcV1) NewFlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByID(id string) (_model *FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByID, err error) { + _model = &FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByID) isaFlowLogCollectorTargetPrototypeVPCIdentity() bool { + return true +} + +func (*FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByID) isaFlowLogCollectorTargetPrototype() bool { + return true +} + +// UnmarshalFlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByID unmarshals an instance of FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByID from the specified map of raw messages. +func UnmarshalFlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(FlowLogCollectorTargetPrototypeVPCIdentityVPCIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpec : InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpec struct +// Models which "extend" this model: +// - InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByGroup +// - InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByManager +// This model "extends" InstanceGroupManagerActionPrototypeScheduledActionPrototype +type InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpec struct { + // The name for this instance group manager action. The name must not be used by another action for the instance group + // manager. If unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The cron specification for a recurring scheduled action. Actions can be applied a maximum of one time within a 5 min + // period. + CronSpec *string `json:"cron_spec,omitempty"` + + Group *InstanceGroupManagerScheduledActionGroupPrototype `json:"group,omitempty"` + + Manager InstanceGroupManagerScheduledActionManagerPrototypeIntf `json:"manager,omitempty"` +} + +func (*InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpec) isaInstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpec() bool { + return true +} + +type InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecIntf interface { + InstanceGroupManagerActionPrototypeScheduledActionPrototypeIntf + isaInstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpec() bool +} + +func (*InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpec) isaInstanceGroupManagerActionPrototypeScheduledActionPrototype() bool { + return true +} + +func (*InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpec) isaInstanceGroupManagerActionPrototype() bool { + return true +} + +// UnmarshalInstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpec unmarshals an instance of InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpec from the specified map of raw messages. +func UnmarshalInstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpec(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpec) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "cron_spec", &obj.CronSpec) + if err != nil { + return + } + err = core.UnmarshalModel(m, "group", &obj.Group, UnmarshalInstanceGroupManagerScheduledActionGroupPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "manager", &obj.Manager, UnmarshalInstanceGroupManagerScheduledActionManagerPrototype) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAt : InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAt struct +// Models which "extend" this model: +// - InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByGroup +// - InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByManager +// This model "extends" InstanceGroupManagerActionPrototypeScheduledActionPrototype +type InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAt struct { + // The name for this instance group manager action. The name must not be used by another action for the instance group + // manager. If unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The date and time the scheduled action will run. + RunAt *strfmt.DateTime `json:"run_at,omitempty"` + + Group *InstanceGroupManagerScheduledActionGroupPrototype `json:"group,omitempty"` + + Manager InstanceGroupManagerScheduledActionManagerPrototypeIntf `json:"manager,omitempty"` +} + +func (*InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAt) isaInstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAt() bool { + return true +} + +type InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtIntf interface { + InstanceGroupManagerActionPrototypeScheduledActionPrototypeIntf + isaInstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAt() bool +} + +func (*InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAt) isaInstanceGroupManagerActionPrototypeScheduledActionPrototype() bool { + return true +} + +func (*InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAt) isaInstanceGroupManagerActionPrototype() bool { + return true +} + +// UnmarshalInstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAt unmarshals an instance of InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAt from the specified map of raw messages. +func UnmarshalInstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAt(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAt) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "run_at", &obj.RunAt) + if err != nil { + return + } + err = core.UnmarshalModel(m, "group", &obj.Group, UnmarshalInstanceGroupManagerScheduledActionGroupPrototype) + if err != nil { + return + } + err = core.UnmarshalModel(m, "manager", &obj.Manager, UnmarshalInstanceGroupManagerScheduledActionManagerPrototype) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerActionScheduledActionGroupTarget : InstanceGroupManagerActionScheduledActionGroupTarget struct +// This model "extends" InstanceGroupManagerActionScheduledAction +type InstanceGroupManagerActionScheduledActionGroupTarget struct { + // Indicates whether this scheduled action will be automatically deleted after it has completed and + // `auto_delete_timeout` hours have passed. At present, this is always + // `true`, but may be modifiable in the future. + AutoDelete *bool `json:"auto_delete" validate:"required"` + + // If `auto_delete` is `true`, and this scheduled action has finished, the hours after which it will be automatically + // deleted. If the value is `0`, the action will be deleted once it has finished. This value may be modifiable in the + // future. + AutoDeleteTimeout *int64 `json:"auto_delete_timeout" validate:"required"` + + // The date and time that the instance group manager action was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The URL for this instance group manager action. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this instance group manager action. + ID *string `json:"id" validate:"required"` + + // The name for this instance group manager action. The name is unique across all actions for the instance group + // manager. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The status of the instance group action + // - `active`: Action is ready to be run + // - `completed`: Action was completed successfully + // - `failed`: Action could not be completed successfully + // - `incompatible`: Action parameters are not compatible with the group or manager + // - `omitted`: Action was not applied because this action's manager was disabled. + Status *string `json:"status" validate:"required"` + + // The date and time that the instance group manager action was updated. + UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"` + + // The type of action for the instance group. + ActionType *string `json:"action_type" validate:"required"` + + // The cron specification for a recurring scheduled action. Actions can be applied a maximum of one time within a 5 min + // period. + CronSpec *string `json:"cron_spec,omitempty"` + + // The date and time the scheduled action was last applied. If absent, the action has never been applied. + LastAppliedAt *strfmt.DateTime `json:"last_applied_at,omitempty"` + + // The date and time the scheduled action will next run. If absent, the system is currently calculating the next run + // time. + NextRunAt *strfmt.DateTime `json:"next_run_at,omitempty"` + + Group *InstanceGroupManagerScheduledActionGroup `json:"group" validate:"required"` +} + +// Constants associated with the InstanceGroupManagerActionScheduledActionGroupTarget.ResourceType property. +// The resource type. +const ( + InstanceGroupManagerActionScheduledActionGroupTargetResourceTypeInstanceGroupManagerActionConst = "instance_group_manager_action" +) + +// Constants associated with the InstanceGroupManagerActionScheduledActionGroupTarget.Status property. +// The status of the instance group action +// - `active`: Action is ready to be run +// - `completed`: Action was completed successfully +// - `failed`: Action could not be completed successfully +// - `incompatible`: Action parameters are not compatible with the group or manager +// - `omitted`: Action was not applied because this action's manager was disabled. +const ( + InstanceGroupManagerActionScheduledActionGroupTargetStatusActiveConst = "active" + InstanceGroupManagerActionScheduledActionGroupTargetStatusCompletedConst = "completed" + InstanceGroupManagerActionScheduledActionGroupTargetStatusFailedConst = "failed" + InstanceGroupManagerActionScheduledActionGroupTargetStatusIncompatibleConst = "incompatible" + InstanceGroupManagerActionScheduledActionGroupTargetStatusOmittedConst = "omitted" +) + +// Constants associated with the InstanceGroupManagerActionScheduledActionGroupTarget.ActionType property. +// The type of action for the instance group. +const ( + InstanceGroupManagerActionScheduledActionGroupTargetActionTypeScheduledConst = "scheduled" +) + +func (*InstanceGroupManagerActionScheduledActionGroupTarget) isaInstanceGroupManagerActionScheduledAction() bool { + return true +} + +func (*InstanceGroupManagerActionScheduledActionGroupTarget) isaInstanceGroupManagerAction() bool { + return true +} + +// UnmarshalInstanceGroupManagerActionScheduledActionGroupTarget unmarshals an instance of InstanceGroupManagerActionScheduledActionGroupTarget from the specified map of raw messages. +func UnmarshalInstanceGroupManagerActionScheduledActionGroupTarget(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerActionScheduledActionGroupTarget) + err = core.UnmarshalPrimitive(m, "auto_delete", &obj.AutoDelete) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "auto_delete_timeout", &obj.AutoDeleteTimeout) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "updated_at", &obj.UpdatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "action_type", &obj.ActionType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "cron_spec", &obj.CronSpec) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "last_applied_at", &obj.LastAppliedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "next_run_at", &obj.NextRunAt) + if err != nil { + return + } + err = core.UnmarshalModel(m, "group", &obj.Group, UnmarshalInstanceGroupManagerScheduledActionGroup) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerActionScheduledActionManagerTarget : InstanceGroupManagerActionScheduledActionManagerTarget struct +// This model "extends" InstanceGroupManagerActionScheduledAction +type InstanceGroupManagerActionScheduledActionManagerTarget struct { + // Indicates whether this scheduled action will be automatically deleted after it has completed and + // `auto_delete_timeout` hours have passed. At present, this is always + // `true`, but may be modifiable in the future. + AutoDelete *bool `json:"auto_delete" validate:"required"` + + // If `auto_delete` is `true`, and this scheduled action has finished, the hours after which it will be automatically + // deleted. If the value is `0`, the action will be deleted once it has finished. This value may be modifiable in the + // future. + AutoDeleteTimeout *int64 `json:"auto_delete_timeout" validate:"required"` + + // The date and time that the instance group manager action was created. + CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` + + // The URL for this instance group manager action. + Href *string `json:"href" validate:"required"` + + // The unique identifier for this instance group manager action. + ID *string `json:"id" validate:"required"` + + // The name for this instance group manager action. The name is unique across all actions for the instance group + // manager. + Name *string `json:"name" validate:"required"` + + // The resource type. + ResourceType *string `json:"resource_type" validate:"required"` + + // The status of the instance group action + // - `active`: Action is ready to be run + // - `completed`: Action was completed successfully + // - `failed`: Action could not be completed successfully + // - `incompatible`: Action parameters are not compatible with the group or manager + // - `omitted`: Action was not applied because this action's manager was disabled. + Status *string `json:"status" validate:"required"` + + // The date and time that the instance group manager action was updated. + UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"` + + // The type of action for the instance group. + ActionType *string `json:"action_type" validate:"required"` + + // The cron specification for a recurring scheduled action. Actions can be applied a maximum of one time within a 5 min + // period. + CronSpec *string `json:"cron_spec,omitempty"` + + // The date and time the scheduled action was last applied. If absent, the action has never been applied. + LastAppliedAt *strfmt.DateTime `json:"last_applied_at,omitempty"` + + // The date and time the scheduled action will next run. If absent, the system is currently calculating the next run + // time. + NextRunAt *strfmt.DateTime `json:"next_run_at,omitempty"` + + Manager InstanceGroupManagerScheduledActionManagerIntf `json:"manager" validate:"required"` +} + +// Constants associated with the InstanceGroupManagerActionScheduledActionManagerTarget.ResourceType property. +// The resource type. +const ( + InstanceGroupManagerActionScheduledActionManagerTargetResourceTypeInstanceGroupManagerActionConst = "instance_group_manager_action" +) + +// Constants associated with the InstanceGroupManagerActionScheduledActionManagerTarget.Status property. +// The status of the instance group action +// - `active`: Action is ready to be run +// - `completed`: Action was completed successfully +// - `failed`: Action could not be completed successfully +// - `incompatible`: Action parameters are not compatible with the group or manager +// - `omitted`: Action was not applied because this action's manager was disabled. +const ( + InstanceGroupManagerActionScheduledActionManagerTargetStatusActiveConst = "active" + InstanceGroupManagerActionScheduledActionManagerTargetStatusCompletedConst = "completed" + InstanceGroupManagerActionScheduledActionManagerTargetStatusFailedConst = "failed" + InstanceGroupManagerActionScheduledActionManagerTargetStatusIncompatibleConst = "incompatible" + InstanceGroupManagerActionScheduledActionManagerTargetStatusOmittedConst = "omitted" +) + +// Constants associated with the InstanceGroupManagerActionScheduledActionManagerTarget.ActionType property. +// The type of action for the instance group. +const ( + InstanceGroupManagerActionScheduledActionManagerTargetActionTypeScheduledConst = "scheduled" +) + +func (*InstanceGroupManagerActionScheduledActionManagerTarget) isaInstanceGroupManagerActionScheduledAction() bool { + return true +} + +func (*InstanceGroupManagerActionScheduledActionManagerTarget) isaInstanceGroupManagerAction() bool { + return true +} + +// UnmarshalInstanceGroupManagerActionScheduledActionManagerTarget unmarshals an instance of InstanceGroupManagerActionScheduledActionManagerTarget from the specified map of raw messages. +func UnmarshalInstanceGroupManagerActionScheduledActionManagerTarget(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerActionScheduledActionManagerTarget) + err = core.UnmarshalPrimitive(m, "auto_delete", &obj.AutoDelete) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "auto_delete_timeout", &obj.AutoDeleteTimeout) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "created_at", &obj.CreatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "resource_type", &obj.ResourceType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "status", &obj.Status) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "updated_at", &obj.UpdatedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "action_type", &obj.ActionType) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "cron_spec", &obj.CronSpec) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "last_applied_at", &obj.LastAppliedAt) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "next_run_at", &obj.NextRunAt) + if err != nil { + return + } + err = core.UnmarshalModel(m, "manager", &obj.Manager, UnmarshalInstanceGroupManagerScheduledActionManager) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeByHref : InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeByHref struct +// This model "extends" InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototype +type InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeByHref struct { + // The desired maximum number of instance group members at the scheduled time. + MaxMembershipCount *int64 `json:"max_membership_count,omitempty"` + + // The desired minimum number of instance group members at the scheduled time. + MinMembershipCount *int64 `json:"min_membership_count,omitempty"` + + // The URL for this instance group manager. + Href *string `json:"href" validate:"required"` +} + +// NewInstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeByHref : Instantiate InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeByHref (Generic Model Constructor) +func (*VpcV1) NewInstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeByHref(href string) (_model *InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeByHref, err error) { + _model = &InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeByHref) isaInstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototype() bool { + return true +} + +func (*InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeByHref) isaInstanceGroupManagerScheduledActionManagerPrototype() bool { + return true +} + +// UnmarshalInstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeByHref unmarshals an instance of InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeByHref from the specified map of raw messages. +func UnmarshalInstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeByHref) + err = core.UnmarshalPrimitive(m, "max_membership_count", &obj.MaxMembershipCount) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min_membership_count", &obj.MinMembershipCount) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeByID : InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeByID struct +// This model "extends" InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototype +type InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeByID struct { + // The desired maximum number of instance group members at the scheduled time. + MaxMembershipCount *int64 `json:"max_membership_count,omitempty"` + + // The desired minimum number of instance group members at the scheduled time. + MinMembershipCount *int64 `json:"min_membership_count,omitempty"` + + // The unique identifier for this instance group manager. + ID *string `json:"id" validate:"required"` +} + +// NewInstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeByID : Instantiate InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeByID (Generic Model Constructor) +func (*VpcV1) NewInstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeByID(id string) (_model *InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeByID, err error) { + _model = &InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeByID) isaInstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototype() bool { + return true +} + +func (*InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeByID) isaInstanceGroupManagerScheduledActionManagerPrototype() bool { + return true +} + +// UnmarshalInstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeByID unmarshals an instance of InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeByID from the specified map of raw messages. +func UnmarshalInstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerScheduledActionManagerPrototypeAutoScalePrototypeByID) + err = core.UnmarshalPrimitive(m, "max_membership_count", &obj.MaxMembershipCount) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "min_membership_count", &obj.MinMembershipCount) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByCRN : InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByCRN struct +// This model "extends" InstancePlacementTargetPatchDedicatedHostGroupIdentity +type InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByCRN struct { + // The CRN for this dedicated host group. + CRN *string `json:"crn" validate:"required"` +} + +// NewInstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByCRN : Instantiate InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewInstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByCRN(crn string) (_model *InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByCRN, err error) { + _model = &InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByCRN) isaInstancePlacementTargetPatchDedicatedHostGroupIdentity() bool { + return true +} + +func (*InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByCRN) isaInstancePlacementTargetPatch() bool { + return true +} + +// UnmarshalInstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByCRN unmarshals an instance of InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByCRN from the specified map of raw messages. +func UnmarshalInstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByHref : InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByHref struct +// This model "extends" InstancePlacementTargetPatchDedicatedHostGroupIdentity +type InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByHref struct { + // The URL for this dedicated host group. + Href *string `json:"href" validate:"required"` +} + +// NewInstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByHref : Instantiate InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewInstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByHref(href string) (_model *InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByHref, err error) { + _model = &InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByHref) isaInstancePlacementTargetPatchDedicatedHostGroupIdentity() bool { + return true +} + +func (*InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByHref) isaInstancePlacementTargetPatch() bool { + return true +} + +// UnmarshalInstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByHref unmarshals an instance of InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByHref from the specified map of raw messages. +func UnmarshalInstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByID : InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByID struct +// This model "extends" InstancePlacementTargetPatchDedicatedHostGroupIdentity +type InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByID struct { + // The unique identifier for this dedicated host group. + ID *string `json:"id" validate:"required"` +} + +// NewInstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByID : Instantiate InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByID (Generic Model Constructor) +func (*VpcV1) NewInstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByID(id string) (_model *InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByID, err error) { + _model = &InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByID) isaInstancePlacementTargetPatchDedicatedHostGroupIdentity() bool { + return true +} + +func (*InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByID) isaInstancePlacementTargetPatch() bool { + return true +} + +// UnmarshalInstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByID unmarshals an instance of InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByID from the specified map of raw messages. +func UnmarshalInstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePlacementTargetPatchDedicatedHostGroupIdentityDedicatedHostGroupIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByCRN : InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByCRN struct +// This model "extends" InstancePlacementTargetPatchDedicatedHostIdentity +type InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByCRN struct { + // The CRN for this dedicated host. + CRN *string `json:"crn" validate:"required"` +} + +// NewInstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByCRN : Instantiate InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewInstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByCRN(crn string) (_model *InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByCRN, err error) { + _model = &InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByCRN) isaInstancePlacementTargetPatchDedicatedHostIdentity() bool { + return true +} + +func (*InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByCRN) isaInstancePlacementTargetPatch() bool { + return true +} + +// UnmarshalInstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByCRN unmarshals an instance of InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByCRN from the specified map of raw messages. +func UnmarshalInstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByHref : InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByHref struct +// This model "extends" InstancePlacementTargetPatchDedicatedHostIdentity +type InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByHref struct { + // The URL for this dedicated host. + Href *string `json:"href" validate:"required"` +} + +// NewInstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByHref : Instantiate InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewInstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByHref(href string) (_model *InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByHref, err error) { + _model = &InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByHref) isaInstancePlacementTargetPatchDedicatedHostIdentity() bool { + return true +} + +func (*InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByHref) isaInstancePlacementTargetPatch() bool { + return true +} + +// UnmarshalInstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByHref unmarshals an instance of InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByHref from the specified map of raw messages. +func UnmarshalInstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByID : InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByID struct +// This model "extends" InstancePlacementTargetPatchDedicatedHostIdentity +type InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByID struct { + // The unique identifier for this dedicated host. + ID *string `json:"id" validate:"required"` +} + +// NewInstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByID : Instantiate InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByID (Generic Model Constructor) +func (*VpcV1) NewInstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByID(id string) (_model *InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByID, err error) { + _model = &InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByID) isaInstancePlacementTargetPatchDedicatedHostIdentity() bool { + return true +} + +func (*InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByID) isaInstancePlacementTargetPatch() bool { + return true +} + +// UnmarshalInstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByID unmarshals an instance of InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByID from the specified map of raw messages. +func UnmarshalInstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePlacementTargetPatchDedicatedHostIdentityDedicatedHostIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByCRN : InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByCRN struct +// This model "extends" InstancePlacementTargetPrototypeDedicatedHostGroupIdentity +type InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByCRN struct { + // The CRN for this dedicated host group. + CRN *string `json:"crn" validate:"required"` +} + +// NewInstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByCRN : Instantiate InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewInstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByCRN(crn string) (_model *InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByCRN, err error) { + _model = &InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByCRN) isaInstancePlacementTargetPrototypeDedicatedHostGroupIdentity() bool { + return true +} + +func (*InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByCRN) isaInstancePlacementTargetPrototype() bool { + return true +} + +// UnmarshalInstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByCRN unmarshals an instance of InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByCRN from the specified map of raw messages. +func UnmarshalInstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByHref : InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByHref struct +// This model "extends" InstancePlacementTargetPrototypeDedicatedHostGroupIdentity +type InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByHref struct { + // The URL for this dedicated host group. + Href *string `json:"href" validate:"required"` +} + +// NewInstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByHref : Instantiate InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewInstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByHref(href string) (_model *InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByHref, err error) { + _model = &InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByHref) isaInstancePlacementTargetPrototypeDedicatedHostGroupIdentity() bool { + return true +} + +func (*InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByHref) isaInstancePlacementTargetPrototype() bool { + return true +} + +// UnmarshalInstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByHref unmarshals an instance of InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByHref from the specified map of raw messages. +func UnmarshalInstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByID : InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByID struct +// This model "extends" InstancePlacementTargetPrototypeDedicatedHostGroupIdentity +type InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByID struct { + // The unique identifier for this dedicated host group. + ID *string `json:"id" validate:"required"` +} + +// NewInstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByID : Instantiate InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByID (Generic Model Constructor) +func (*VpcV1) NewInstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByID(id string) (_model *InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByID, err error) { + _model = &InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByID) isaInstancePlacementTargetPrototypeDedicatedHostGroupIdentity() bool { + return true +} + +func (*InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByID) isaInstancePlacementTargetPrototype() bool { + return true +} + +// UnmarshalInstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByID unmarshals an instance of InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByID from the specified map of raw messages. +func UnmarshalInstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePlacementTargetPrototypeDedicatedHostGroupIdentityDedicatedHostGroupIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByCRN : InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByCRN struct +// This model "extends" InstancePlacementTargetPrototypeDedicatedHostIdentity +type InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByCRN struct { + // The CRN for this dedicated host. + CRN *string `json:"crn" validate:"required"` +} + +// NewInstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByCRN : Instantiate InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewInstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByCRN(crn string) (_model *InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByCRN, err error) { + _model = &InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByCRN) isaInstancePlacementTargetPrototypeDedicatedHostIdentity() bool { + return true +} + +func (*InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByCRN) isaInstancePlacementTargetPrototype() bool { + return true +} + +// UnmarshalInstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByCRN unmarshals an instance of InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByCRN from the specified map of raw messages. +func UnmarshalInstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByHref : InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByHref struct +// This model "extends" InstancePlacementTargetPrototypeDedicatedHostIdentity +type InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByHref struct { + // The URL for this dedicated host. + Href *string `json:"href" validate:"required"` +} + +// NewInstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByHref : Instantiate InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewInstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByHref(href string) (_model *InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByHref, err error) { + _model = &InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByHref) isaInstancePlacementTargetPrototypeDedicatedHostIdentity() bool { + return true +} + +func (*InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByHref) isaInstancePlacementTargetPrototype() bool { + return true +} + +// UnmarshalInstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByHref unmarshals an instance of InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByHref from the specified map of raw messages. +func UnmarshalInstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByID : InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByID struct +// This model "extends" InstancePlacementTargetPrototypeDedicatedHostIdentity +type InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByID struct { + // The unique identifier for this dedicated host. + ID *string `json:"id" validate:"required"` +} + +// NewInstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByID : Instantiate InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByID (Generic Model Constructor) +func (*VpcV1) NewInstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByID(id string) (_model *InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByID, err error) { + _model = &InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByID) isaInstancePlacementTargetPrototypeDedicatedHostIdentity() bool { + return true +} + +func (*InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByID) isaInstancePlacementTargetPrototype() bool { + return true +} + +// UnmarshalInstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByID unmarshals an instance of InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByID from the specified map of raw messages. +func UnmarshalInstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePlacementTargetPrototypeDedicatedHostIdentityDedicatedHostIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByCRN : InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByCRN struct +// This model "extends" InstancePlacementTargetPrototypePlacementGroupIdentity +type InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByCRN struct { + // The CRN for this placement group. + CRN *string `json:"crn" validate:"required"` +} + +// NewInstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByCRN : Instantiate InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewInstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByCRN(crn string) (_model *InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByCRN, err error) { + _model = &InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByCRN) isaInstancePlacementTargetPrototypePlacementGroupIdentity() bool { + return true +} + +func (*InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByCRN) isaInstancePlacementTargetPrototype() bool { + return true +} + +// UnmarshalInstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByCRN unmarshals an instance of InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByCRN from the specified map of raw messages. +func UnmarshalInstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByHref : InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByHref struct +// This model "extends" InstancePlacementTargetPrototypePlacementGroupIdentity +type InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByHref struct { + // The URL for this placement group. + Href *string `json:"href" validate:"required"` +} + +// NewInstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByHref : Instantiate InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewInstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByHref(href string) (_model *InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByHref, err error) { + _model = &InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByHref) isaInstancePlacementTargetPrototypePlacementGroupIdentity() bool { + return true +} + +func (*InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByHref) isaInstancePlacementTargetPrototype() bool { + return true +} + +// UnmarshalInstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByHref unmarshals an instance of InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByHref from the specified map of raw messages. +func UnmarshalInstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByID : InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByID struct +// This model "extends" InstancePlacementTargetPrototypePlacementGroupIdentity +type InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByID struct { + // The unique identifier for this placement group. + ID *string `json:"id" validate:"required"` +} + +// NewInstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByID : Instantiate InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByID (Generic Model Constructor) +func (*VpcV1) NewInstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByID(id string) (_model *InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByID, err error) { + _model = &InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByID) isaInstancePlacementTargetPrototypePlacementGroupIdentity() bool { + return true +} + +func (*InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByID) isaInstancePlacementTargetPrototype() bool { + return true +} + +// UnmarshalInstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByID unmarshals an instance of InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByID from the specified map of raw messages. +func UnmarshalInstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstancePlacementTargetPrototypePlacementGroupIdentityPlacementGroupIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityLoadBalancerPoolIdentityByHref : LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityLoadBalancerPoolIdentityByHref struct +// This model "extends" LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentity +type LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityLoadBalancerPoolIdentityByHref struct { + // The pool's canonical URL. + Href *string `json:"href" validate:"required"` +} + +// NewLoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityLoadBalancerPoolIdentityByHref : Instantiate LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityLoadBalancerPoolIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewLoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityLoadBalancerPoolIdentityByHref(href string) (_model *LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityLoadBalancerPoolIdentityByHref, err error) { + _model = &LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityLoadBalancerPoolIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityLoadBalancerPoolIdentityByHref) isaLoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentity() bool { + return true +} + +func (*LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityLoadBalancerPoolIdentityByHref) isaLoadBalancerListenerPolicyTargetPatch() bool { + return true +} + +// UnmarshalLoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityLoadBalancerPoolIdentityByHref unmarshals an instance of LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityLoadBalancerPoolIdentityByHref from the specified map of raw messages. +func UnmarshalLoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityLoadBalancerPoolIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityLoadBalancerPoolIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityLoadBalancerPoolIdentityByID : LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityLoadBalancerPoolIdentityByID struct +// This model "extends" LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentity +type LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityLoadBalancerPoolIdentityByID struct { + // The unique identifier for this load balancer pool. + ID *string `json:"id" validate:"required"` +} + +// NewLoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityLoadBalancerPoolIdentityByID : Instantiate LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityLoadBalancerPoolIdentityByID (Generic Model Constructor) +func (*VpcV1) NewLoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityLoadBalancerPoolIdentityByID(id string) (_model *LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityLoadBalancerPoolIdentityByID, err error) { + _model = &LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityLoadBalancerPoolIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityLoadBalancerPoolIdentityByID) isaLoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentity() bool { + return true +} + +func (*LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityLoadBalancerPoolIdentityByID) isaLoadBalancerListenerPolicyTargetPatch() bool { + return true +} + +// UnmarshalLoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityLoadBalancerPoolIdentityByID unmarshals an instance of LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityLoadBalancerPoolIdentityByID from the specified map of raw messages. +func UnmarshalLoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityLoadBalancerPoolIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerPolicyTargetPatchLoadBalancerPoolIdentityLoadBalancerPoolIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityLoadBalancerPoolIdentityByHref : LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityLoadBalancerPoolIdentityByHref struct +// This model "extends" LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentity +type LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityLoadBalancerPoolIdentityByHref struct { + // The pool's canonical URL. + Href *string `json:"href" validate:"required"` +} + +// NewLoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityLoadBalancerPoolIdentityByHref : Instantiate LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityLoadBalancerPoolIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewLoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityLoadBalancerPoolIdentityByHref(href string) (_model *LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityLoadBalancerPoolIdentityByHref, err error) { + _model = &LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityLoadBalancerPoolIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityLoadBalancerPoolIdentityByHref) isaLoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentity() bool { + return true +} + +func (*LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityLoadBalancerPoolIdentityByHref) isaLoadBalancerListenerPolicyTargetPrototype() bool { + return true +} + +// UnmarshalLoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityLoadBalancerPoolIdentityByHref unmarshals an instance of LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityLoadBalancerPoolIdentityByHref from the specified map of raw messages. +func UnmarshalLoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityLoadBalancerPoolIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityLoadBalancerPoolIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityLoadBalancerPoolIdentityByID : LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityLoadBalancerPoolIdentityByID struct +// This model "extends" LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentity +type LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityLoadBalancerPoolIdentityByID struct { + // The unique identifier for this load balancer pool. + ID *string `json:"id" validate:"required"` +} + +// NewLoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityLoadBalancerPoolIdentityByID : Instantiate LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityLoadBalancerPoolIdentityByID (Generic Model Constructor) +func (*VpcV1) NewLoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityLoadBalancerPoolIdentityByID(id string) (_model *LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityLoadBalancerPoolIdentityByID, err error) { + _model = &LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityLoadBalancerPoolIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityLoadBalancerPoolIdentityByID) isaLoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentity() bool { + return true +} + +func (*LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityLoadBalancerPoolIdentityByID) isaLoadBalancerListenerPolicyTargetPrototype() bool { + return true +} + +// UnmarshalLoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityLoadBalancerPoolIdentityByID unmarshals an instance of LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityLoadBalancerPoolIdentityByID from the specified map of raw messages. +func UnmarshalLoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityLoadBalancerPoolIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerListenerPolicyTargetPrototypeLoadBalancerPoolIdentityLoadBalancerPoolIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByCRN : LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByCRN struct +// This model "extends" LoadBalancerPoolMemberTargetPrototypeInstanceIdentity +type LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByCRN struct { + // The CRN for this virtual server instance. + CRN *string `json:"crn" validate:"required"` +} + +// NewLoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByCRN : Instantiate LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewLoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByCRN(crn string) (_model *LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByCRN, err error) { + _model = &LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByCRN) isaLoadBalancerPoolMemberTargetPrototypeInstanceIdentity() bool { + return true +} + +func (*LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByCRN) isaLoadBalancerPoolMemberTargetPrototype() bool { + return true +} + +// UnmarshalLoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByCRN unmarshals an instance of LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByCRN from the specified map of raw messages. +func UnmarshalLoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByHref : LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByHref struct +// This model "extends" LoadBalancerPoolMemberTargetPrototypeInstanceIdentity +type LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByHref struct { + // The URL for this virtual server instance. + Href *string `json:"href" validate:"required"` +} + +// NewLoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByHref : Instantiate LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewLoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByHref(href string) (_model *LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByHref, err error) { + _model = &LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByHref) isaLoadBalancerPoolMemberTargetPrototypeInstanceIdentity() bool { + return true +} + +func (*LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByHref) isaLoadBalancerPoolMemberTargetPrototype() bool { + return true +} + +// UnmarshalLoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByHref unmarshals an instance of LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByHref from the specified map of raw messages. +func UnmarshalLoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByID : LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByID struct +// This model "extends" LoadBalancerPoolMemberTargetPrototypeInstanceIdentity +type LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByID struct { + // The unique identifier for this virtual server instance. + ID *string `json:"id" validate:"required"` +} + +// NewLoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByID : Instantiate LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByID (Generic Model Constructor) +func (*VpcV1) NewLoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByID(id string) (_model *LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByID, err error) { + _model = &LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByID) isaLoadBalancerPoolMemberTargetPrototypeInstanceIdentity() bool { + return true +} + +func (*LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByID) isaLoadBalancerPoolMemberTargetPrototype() bool { + return true +} + +// UnmarshalLoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByID unmarshals an instance of LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByID from the specified map of raw messages. +func UnmarshalLoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(LoadBalancerPoolMemberTargetPrototypeInstanceIdentityInstanceIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkInterfaceIPPrototypeReservedIPIdentityByHref : NetworkInterfaceIPPrototypeReservedIPIdentityByHref struct +// This model "extends" NetworkInterfaceIPPrototypeReservedIPIdentity +type NetworkInterfaceIPPrototypeReservedIPIdentityByHref struct { + // The URL for this reserved IP. + Href *string `json:"href" validate:"required"` +} + +// NewNetworkInterfaceIPPrototypeReservedIPIdentityByHref : Instantiate NetworkInterfaceIPPrototypeReservedIPIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewNetworkInterfaceIPPrototypeReservedIPIdentityByHref(href string) (_model *NetworkInterfaceIPPrototypeReservedIPIdentityByHref, err error) { + _model = &NetworkInterfaceIPPrototypeReservedIPIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*NetworkInterfaceIPPrototypeReservedIPIdentityByHref) isaNetworkInterfaceIPPrototypeReservedIPIdentity() bool { + return true +} + +func (*NetworkInterfaceIPPrototypeReservedIPIdentityByHref) isaNetworkInterfaceIPPrototype() bool { + return true +} + +// UnmarshalNetworkInterfaceIPPrototypeReservedIPIdentityByHref unmarshals an instance of NetworkInterfaceIPPrototypeReservedIPIdentityByHref from the specified map of raw messages. +func UnmarshalNetworkInterfaceIPPrototypeReservedIPIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkInterfaceIPPrototypeReservedIPIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// NetworkInterfaceIPPrototypeReservedIPIdentityByID : NetworkInterfaceIPPrototypeReservedIPIdentityByID struct +// This model "extends" NetworkInterfaceIPPrototypeReservedIPIdentity +type NetworkInterfaceIPPrototypeReservedIPIdentityByID struct { + // The unique identifier for this reserved IP. + ID *string `json:"id" validate:"required"` +} + +// NewNetworkInterfaceIPPrototypeReservedIPIdentityByID : Instantiate NetworkInterfaceIPPrototypeReservedIPIdentityByID (Generic Model Constructor) +func (*VpcV1) NewNetworkInterfaceIPPrototypeReservedIPIdentityByID(id string) (_model *NetworkInterfaceIPPrototypeReservedIPIdentityByID, err error) { + _model = &NetworkInterfaceIPPrototypeReservedIPIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*NetworkInterfaceIPPrototypeReservedIPIdentityByID) isaNetworkInterfaceIPPrototypeReservedIPIdentity() bool { + return true +} + +func (*NetworkInterfaceIPPrototypeReservedIPIdentityByID) isaNetworkInterfaceIPPrototype() bool { + return true +} + +// UnmarshalNetworkInterfaceIPPrototypeReservedIPIdentityByID unmarshals an instance of NetworkInterfaceIPPrototypeReservedIPIdentityByID from the specified map of raw messages. +func UnmarshalNetworkInterfaceIPPrototypeReservedIPIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(NetworkInterfaceIPPrototypeReservedIPIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByAddress : PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByAddress struct +// This model "extends" PublicGatewayFloatingIPPrototypeFloatingIPIdentity +type PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByAddress struct { + // The globally unique IP address. + Address *string `json:"address" validate:"required"` +} + +// NewPublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByAddress : Instantiate PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByAddress (Generic Model Constructor) +func (*VpcV1) NewPublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByAddress(address string) (_model *PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByAddress, err error) { + _model = &PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByAddress{ + Address: core.StringPtr(address), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByAddress) isaPublicGatewayFloatingIPPrototypeFloatingIPIdentity() bool { + return true +} + +func (*PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByAddress) isaPublicGatewayFloatingIPPrototype() bool { + return true +} + +// UnmarshalPublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByAddress unmarshals an instance of PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByAddress from the specified map of raw messages. +func UnmarshalPublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByAddress(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByAddress) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByCRN : PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByCRN struct +// This model "extends" PublicGatewayFloatingIPPrototypeFloatingIPIdentity +type PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByCRN struct { + // The CRN for this floating IP. + CRN *string `json:"crn" validate:"required"` +} + +// NewPublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByCRN : Instantiate PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewPublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByCRN(crn string) (_model *PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByCRN, err error) { + _model = &PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByCRN) isaPublicGatewayFloatingIPPrototypeFloatingIPIdentity() bool { + return true +} + +func (*PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByCRN) isaPublicGatewayFloatingIPPrototype() bool { + return true +} + +// UnmarshalPublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByCRN unmarshals an instance of PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByCRN from the specified map of raw messages. +func UnmarshalPublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByHref : PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByHref struct +// This model "extends" PublicGatewayFloatingIPPrototypeFloatingIPIdentity +type PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByHref struct { + // The URL for this floating IP. + Href *string `json:"href" validate:"required"` +} + +// NewPublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByHref : Instantiate PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewPublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByHref(href string) (_model *PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByHref, err error) { + _model = &PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByHref) isaPublicGatewayFloatingIPPrototypeFloatingIPIdentity() bool { + return true +} + +func (*PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByHref) isaPublicGatewayFloatingIPPrototype() bool { + return true +} + +// UnmarshalPublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByHref unmarshals an instance of PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByHref from the specified map of raw messages. +func UnmarshalPublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByID : PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByID struct +// This model "extends" PublicGatewayFloatingIPPrototypeFloatingIPIdentity +type PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByID struct { + // The unique identifier for this floating IP. + ID *string `json:"id" validate:"required"` +} + +// NewPublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByID : Instantiate PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByID (Generic Model Constructor) +func (*VpcV1) NewPublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByID(id string) (_model *PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByID, err error) { + _model = &PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByID) isaPublicGatewayFloatingIPPrototypeFloatingIPIdentity() bool { + return true +} + +func (*PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByID) isaPublicGatewayFloatingIPPrototype() bool { + return true +} + +// UnmarshalPublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByID unmarshals an instance of PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByID from the specified map of raw messages. +func UnmarshalPublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(PublicGatewayFloatingIPPrototypeFloatingIPIdentityFloatingIPIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByCRN : ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByCRN struct +// This model "extends" ReservedIPTargetPrototypeEndpointGatewayIdentity +type ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByCRN struct { + // The CRN for this endpoint gateway. + CRN *string `json:"crn" validate:"required"` +} + +// NewReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByCRN : Instantiate ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByCRN(crn string) (_model *ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByCRN, err error) { + _model = &ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByCRN) isaReservedIPTargetPrototypeEndpointGatewayIdentity() bool { + return true +} + +func (*ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByCRN) isaReservedIPTargetPrototype() bool { + return true +} + +// UnmarshalReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByCRN unmarshals an instance of ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByCRN from the specified map of raw messages. +func UnmarshalReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByHref : ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByHref struct +// This model "extends" ReservedIPTargetPrototypeEndpointGatewayIdentity +type ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByHref struct { + // The URL for this endpoint gateway. + Href *string `json:"href" validate:"required"` +} + +// NewReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByHref : Instantiate ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByHref(href string) (_model *ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByHref, err error) { + _model = &ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByHref) isaReservedIPTargetPrototypeEndpointGatewayIdentity() bool { + return true +} + +func (*ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByHref) isaReservedIPTargetPrototype() bool { + return true +} + +// UnmarshalReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByHref unmarshals an instance of ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByHref from the specified map of raw messages. +func UnmarshalReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByID : ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByID struct +// This model "extends" ReservedIPTargetPrototypeEndpointGatewayIdentity +type ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByID struct { + // The unique identifier for this endpoint gateway. + ID *string `json:"id" validate:"required"` +} + +// NewReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByID : Instantiate ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByID (Generic Model Constructor) +func (*VpcV1) NewReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByID(id string) (_model *ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByID, err error) { + _model = &ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByID) isaReservedIPTargetPrototypeEndpointGatewayIdentity() bool { + return true +} + +func (*ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByID) isaReservedIPTargetPrototype() bool { + return true +} + +// UnmarshalReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByID unmarshals an instance of ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByID from the specified map of raw messages. +func UnmarshalReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(ReservedIPTargetPrototypeEndpointGatewayIdentityEndpointGatewayIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RouteNextHopPatchRouteNextHopIPRouteNextHopIPSentinelIP : RouteNextHopPatchRouteNextHopIPRouteNextHopIPSentinelIP struct +// This model "extends" RouteNextHopPatchRouteNextHopIP +type RouteNextHopPatchRouteNextHopIPRouteNextHopIPSentinelIP struct { + // The sentinel IP address (`0.0.0.0`). + // + // This property may add support for IPv6 addresses in the future. When processing a value in this property, verify + // that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the + // error, or bypass the resource on which the unexpected IP address format was encountered. + Address *string `json:"address" validate:"required"` +} + +// NewRouteNextHopPatchRouteNextHopIPRouteNextHopIPSentinelIP : Instantiate RouteNextHopPatchRouteNextHopIPRouteNextHopIPSentinelIP (Generic Model Constructor) +func (*VpcV1) NewRouteNextHopPatchRouteNextHopIPRouteNextHopIPSentinelIP(address string) (_model *RouteNextHopPatchRouteNextHopIPRouteNextHopIPSentinelIP, err error) { + _model = &RouteNextHopPatchRouteNextHopIPRouteNextHopIPSentinelIP{ + Address: core.StringPtr(address), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*RouteNextHopPatchRouteNextHopIPRouteNextHopIPSentinelIP) isaRouteNextHopPatchRouteNextHopIP() bool { + return true +} + +func (*RouteNextHopPatchRouteNextHopIPRouteNextHopIPSentinelIP) isaRouteNextHopPatch() bool { + return true +} + +// UnmarshalRouteNextHopPatchRouteNextHopIPRouteNextHopIPSentinelIP unmarshals an instance of RouteNextHopPatchRouteNextHopIPRouteNextHopIPSentinelIP from the specified map of raw messages. +func UnmarshalRouteNextHopPatchRouteNextHopIPRouteNextHopIPSentinelIP(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RouteNextHopPatchRouteNextHopIPRouteNextHopIPSentinelIP) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RouteNextHopPatchRouteNextHopIPRouteNextHopIPUnicastIP : RouteNextHopPatchRouteNextHopIPRouteNextHopIPUnicastIP struct +// This model "extends" RouteNextHopPatchRouteNextHopIP +type RouteNextHopPatchRouteNextHopIPRouteNextHopIPUnicastIP struct { + // A unicast IP address, which must not be any of the following values: + // + // - `0.0.0.0` (the sentinel IP address) + // - `224.0.0.0` to `239.255.255.255` (multicast IP addresses) + // - `255.255.255.255` (the broadcast IP address) + // + // This property may add support for IPv6 addresses in the future. When processing a value in this property, verify + // that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the + // error, or bypass the resource on which the unexpected IP address format was encountered. + Address *string `json:"address" validate:"required"` +} + +// NewRouteNextHopPatchRouteNextHopIPRouteNextHopIPUnicastIP : Instantiate RouteNextHopPatchRouteNextHopIPRouteNextHopIPUnicastIP (Generic Model Constructor) +func (*VpcV1) NewRouteNextHopPatchRouteNextHopIPRouteNextHopIPUnicastIP(address string) (_model *RouteNextHopPatchRouteNextHopIPRouteNextHopIPUnicastIP, err error) { + _model = &RouteNextHopPatchRouteNextHopIPRouteNextHopIPUnicastIP{ + Address: core.StringPtr(address), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*RouteNextHopPatchRouteNextHopIPRouteNextHopIPUnicastIP) isaRouteNextHopPatchRouteNextHopIP() bool { + return true +} + +func (*RouteNextHopPatchRouteNextHopIPRouteNextHopIPUnicastIP) isaRouteNextHopPatch() bool { + return true +} + +// UnmarshalRouteNextHopPatchRouteNextHopIPRouteNextHopIPUnicastIP unmarshals an instance of RouteNextHopPatchRouteNextHopIPRouteNextHopIPUnicastIP from the specified map of raw messages. +func UnmarshalRouteNextHopPatchRouteNextHopIPRouteNextHopIPUnicastIP(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RouteNextHopPatchRouteNextHopIPRouteNextHopIPUnicastIP) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RouteNextHopPatchVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByHref : RouteNextHopPatchVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByHref struct +// This model "extends" RouteNextHopPatchVPNGatewayConnectionIdentity +type RouteNextHopPatchVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByHref struct { + // The VPN connection's canonical URL. + Href *string `json:"href" validate:"required"` +} + +// NewRouteNextHopPatchVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByHref : Instantiate RouteNextHopPatchVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewRouteNextHopPatchVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByHref(href string) (_model *RouteNextHopPatchVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByHref, err error) { + _model = &RouteNextHopPatchVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*RouteNextHopPatchVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByHref) isaRouteNextHopPatchVPNGatewayConnectionIdentity() bool { + return true +} + +func (*RouteNextHopPatchVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByHref) isaRouteNextHopPatch() bool { + return true +} + +// UnmarshalRouteNextHopPatchVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByHref unmarshals an instance of RouteNextHopPatchVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByHref from the specified map of raw messages. +func UnmarshalRouteNextHopPatchVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RouteNextHopPatchVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RouteNextHopPatchVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByID : RouteNextHopPatchVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByID struct +// This model "extends" RouteNextHopPatchVPNGatewayConnectionIdentity +type RouteNextHopPatchVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByID struct { + // The unique identifier for this VPN gateway connection. + ID *string `json:"id" validate:"required"` +} + +// NewRouteNextHopPatchVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByID : Instantiate RouteNextHopPatchVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByID (Generic Model Constructor) +func (*VpcV1) NewRouteNextHopPatchVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByID(id string) (_model *RouteNextHopPatchVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByID, err error) { + _model = &RouteNextHopPatchVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*RouteNextHopPatchVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByID) isaRouteNextHopPatchVPNGatewayConnectionIdentity() bool { + return true +} + +func (*RouteNextHopPatchVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByID) isaRouteNextHopPatch() bool { + return true +} + +// UnmarshalRouteNextHopPatchVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByID unmarshals an instance of RouteNextHopPatchVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByID from the specified map of raw messages. +func UnmarshalRouteNextHopPatchVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RouteNextHopPatchVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPRouteNextHopPrototypeRouteNextHopIPRouteNextHopIPSentinelIP : RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPRouteNextHopPrototypeRouteNextHopIPRouteNextHopIPSentinelIP struct +// This model "extends" RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIP +type RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPRouteNextHopPrototypeRouteNextHopIPRouteNextHopIPSentinelIP struct { + // The sentinel IP address (`0.0.0.0`). + // + // This property may add support for IPv6 addresses in the future. When processing a value in this property, verify + // that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the + // error, or bypass the resource on which the unexpected IP address format was encountered. + Address *string `json:"address" validate:"required"` +} + +// NewRoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPRouteNextHopPrototypeRouteNextHopIPRouteNextHopIPSentinelIP : Instantiate RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPRouteNextHopPrototypeRouteNextHopIPRouteNextHopIPSentinelIP (Generic Model Constructor) +func (*VpcV1) NewRoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPRouteNextHopPrototypeRouteNextHopIPRouteNextHopIPSentinelIP(address string) (_model *RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPRouteNextHopPrototypeRouteNextHopIPRouteNextHopIPSentinelIP, err error) { + _model = &RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPRouteNextHopPrototypeRouteNextHopIPRouteNextHopIPSentinelIP{ + Address: core.StringPtr(address), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPRouteNextHopPrototypeRouteNextHopIPRouteNextHopIPSentinelIP) isaRoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIP() bool { + return true +} + +func (*RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPRouteNextHopPrototypeRouteNextHopIPRouteNextHopIPSentinelIP) isaRoutePrototypeNextHop() bool { + return true +} + +// UnmarshalRoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPRouteNextHopPrototypeRouteNextHopIPRouteNextHopIPSentinelIP unmarshals an instance of RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPRouteNextHopPrototypeRouteNextHopIPRouteNextHopIPSentinelIP from the specified map of raw messages. +func UnmarshalRoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPRouteNextHopPrototypeRouteNextHopIPRouteNextHopIPSentinelIP(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPRouteNextHopPrototypeRouteNextHopIPRouteNextHopIPSentinelIP) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPRouteNextHopPrototypeRouteNextHopIPRouteNextHopIPUnicastIP : RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPRouteNextHopPrototypeRouteNextHopIPRouteNextHopIPUnicastIP struct +// This model "extends" RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIP +type RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPRouteNextHopPrototypeRouteNextHopIPRouteNextHopIPUnicastIP struct { + // A unicast IP address, which must not be any of the following values: + // + // - `0.0.0.0` (the sentinel IP address) + // - `224.0.0.0` to `239.255.255.255` (multicast IP addresses) + // - `255.255.255.255` (the broadcast IP address) + // + // This property may add support for IPv6 addresses in the future. When processing a value in this property, verify + // that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the + // error, or bypass the resource on which the unexpected IP address format was encountered. + Address *string `json:"address" validate:"required"` +} + +// NewRoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPRouteNextHopPrototypeRouteNextHopIPRouteNextHopIPUnicastIP : Instantiate RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPRouteNextHopPrototypeRouteNextHopIPRouteNextHopIPUnicastIP (Generic Model Constructor) +func (*VpcV1) NewRoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPRouteNextHopPrototypeRouteNextHopIPRouteNextHopIPUnicastIP(address string) (_model *RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPRouteNextHopPrototypeRouteNextHopIPRouteNextHopIPUnicastIP, err error) { + _model = &RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPRouteNextHopPrototypeRouteNextHopIPRouteNextHopIPUnicastIP{ + Address: core.StringPtr(address), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPRouteNextHopPrototypeRouteNextHopIPRouteNextHopIPUnicastIP) isaRoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIP() bool { + return true +} + +func (*RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPRouteNextHopPrototypeRouteNextHopIPRouteNextHopIPUnicastIP) isaRoutePrototypeNextHop() bool { + return true +} + +// UnmarshalRoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPRouteNextHopPrototypeRouteNextHopIPRouteNextHopIPUnicastIP unmarshals an instance of RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPRouteNextHopPrototypeRouteNextHopIPRouteNextHopIPUnicastIP from the specified map of raw messages. +func UnmarshalRoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPRouteNextHopPrototypeRouteNextHopIPRouteNextHopIPUnicastIP(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RoutePrototypeNextHopRouteNextHopPrototypeRouteNextHopIPRouteNextHopPrototypeRouteNextHopIPRouteNextHopIPUnicastIP) + err = core.UnmarshalPrimitive(m, "address", &obj.Address) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityRouteNextHopPrototypeVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByHref : RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityRouteNextHopPrototypeVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByHref struct +// This model "extends" RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentity +type RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityRouteNextHopPrototypeVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByHref struct { + // The VPN connection's canonical URL. + Href *string `json:"href" validate:"required"` +} + +// NewRoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityRouteNextHopPrototypeVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByHref : Instantiate RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityRouteNextHopPrototypeVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewRoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityRouteNextHopPrototypeVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByHref(href string) (_model *RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityRouteNextHopPrototypeVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByHref, err error) { + _model = &RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityRouteNextHopPrototypeVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityRouteNextHopPrototypeVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByHref) isaRoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentity() bool { + return true +} + +func (*RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityRouteNextHopPrototypeVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByHref) isaRoutePrototypeNextHop() bool { + return true +} + +// UnmarshalRoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityRouteNextHopPrototypeVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByHref unmarshals an instance of RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityRouteNextHopPrototypeVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByHref from the specified map of raw messages. +func UnmarshalRoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityRouteNextHopPrototypeVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityRouteNextHopPrototypeVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityRouteNextHopPrototypeVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByID : RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityRouteNextHopPrototypeVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByID struct +// This model "extends" RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentity +type RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityRouteNextHopPrototypeVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByID struct { + // The unique identifier for this VPN gateway connection. + ID *string `json:"id" validate:"required"` +} + +// NewRoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityRouteNextHopPrototypeVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByID : Instantiate RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityRouteNextHopPrototypeVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByID (Generic Model Constructor) +func (*VpcV1) NewRoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityRouteNextHopPrototypeVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByID(id string) (_model *RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityRouteNextHopPrototypeVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByID, err error) { + _model = &RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityRouteNextHopPrototypeVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityRouteNextHopPrototypeVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByID) isaRoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentity() bool { + return true +} + +func (*RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityRouteNextHopPrototypeVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByID) isaRoutePrototypeNextHop() bool { + return true +} + +// UnmarshalRoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityRouteNextHopPrototypeVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByID unmarshals an instance of RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityRouteNextHopPrototypeVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByID from the specified map of raw messages. +func UnmarshalRoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityRouteNextHopPrototypeVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(RoutePrototypeNextHopRouteNextHopPrototypeVPNGatewayConnectionIdentityRouteNextHopPrototypeVPNGatewayConnectionIdentityVPNGatewayConnectionIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByCRN : SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByCRN struct +// This model "extends" SecurityGroupRuleRemotePatchSecurityGroupIdentity +type SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByCRN struct { + // The security group's CRN. + CRN *string `json:"crn" validate:"required"` +} + +// NewSecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByCRN : Instantiate SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewSecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByCRN(crn string) (_model *SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByCRN, err error) { + _model = &SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByCRN) isaSecurityGroupRuleRemotePatchSecurityGroupIdentity() bool { + return true +} + +func (*SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByCRN) isaSecurityGroupRuleRemotePatch() bool { + return true +} + +// UnmarshalSecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByCRN unmarshals an instance of SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByCRN from the specified map of raw messages. +func UnmarshalSecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByHref : SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByHref struct +// This model "extends" SecurityGroupRuleRemotePatchSecurityGroupIdentity +type SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByHref struct { + // The security group's canonical URL. + Href *string `json:"href" validate:"required"` +} + +// NewSecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByHref : Instantiate SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewSecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByHref(href string) (_model *SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByHref, err error) { + _model = &SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByHref) isaSecurityGroupRuleRemotePatchSecurityGroupIdentity() bool { + return true +} + +func (*SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByHref) isaSecurityGroupRuleRemotePatch() bool { + return true +} + +// UnmarshalSecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByHref unmarshals an instance of SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByHref from the specified map of raw messages. +func UnmarshalSecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByID : SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByID struct +// This model "extends" SecurityGroupRuleRemotePatchSecurityGroupIdentity +type SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByID struct { + // The unique identifier for this security group. + ID *string `json:"id" validate:"required"` +} + +// NewSecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByID : Instantiate SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByID (Generic Model Constructor) +func (*VpcV1) NewSecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByID(id string) (_model *SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByID, err error) { + _model = &SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByID) isaSecurityGroupRuleRemotePatchSecurityGroupIdentity() bool { + return true +} + +func (*SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByID) isaSecurityGroupRuleRemotePatch() bool { + return true +} + +// UnmarshalSecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByID unmarshals an instance of SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByID from the specified map of raw messages. +func UnmarshalSecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupRuleRemotePatchSecurityGroupIdentitySecurityGroupIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByCRN : SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByCRN struct +// This model "extends" SecurityGroupRuleRemotePrototypeSecurityGroupIdentity +type SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByCRN struct { + // The security group's CRN. + CRN *string `json:"crn" validate:"required"` +} + +// NewSecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByCRN : Instantiate SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewSecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByCRN(crn string) (_model *SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByCRN, err error) { + _model = &SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByCRN) isaSecurityGroupRuleRemotePrototypeSecurityGroupIdentity() bool { + return true +} + +func (*SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByCRN) isaSecurityGroupRuleRemotePrototype() bool { + return true +} + +// UnmarshalSecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByCRN unmarshals an instance of SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByCRN from the specified map of raw messages. +func UnmarshalSecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByHref : SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByHref struct +// This model "extends" SecurityGroupRuleRemotePrototypeSecurityGroupIdentity +type SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByHref struct { + // The security group's canonical URL. + Href *string `json:"href" validate:"required"` +} + +// NewSecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByHref : Instantiate SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewSecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByHref(href string) (_model *SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByHref, err error) { + _model = &SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByHref) isaSecurityGroupRuleRemotePrototypeSecurityGroupIdentity() bool { + return true +} + +func (*SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByHref) isaSecurityGroupRuleRemotePrototype() bool { + return true +} + +// UnmarshalSecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByHref unmarshals an instance of SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByHref from the specified map of raw messages. +func UnmarshalSecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByID : SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByID struct +// This model "extends" SecurityGroupRuleRemotePrototypeSecurityGroupIdentity +type SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByID struct { + // The unique identifier for this security group. + ID *string `json:"id" validate:"required"` +} + +// NewSecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByID : Instantiate SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByID (Generic Model Constructor) +func (*VpcV1) NewSecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByID(id string) (_model *SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByID, err error) { + _model = &SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByID) isaSecurityGroupRuleRemotePrototypeSecurityGroupIdentity() bool { + return true +} + +func (*SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByID) isaSecurityGroupRuleRemotePrototype() bool { + return true +} + +// UnmarshalSecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByID unmarshals an instance of SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByID from the specified map of raw messages. +func UnmarshalSecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(SecurityGroupRuleRemotePrototypeSecurityGroupIdentitySecurityGroupIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextByHref : VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextByHref struct +// This model "extends" VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContext +type VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextByHref struct { + // The URL for this reserved IP. + Href *string `json:"href" validate:"required"` +} + +// NewVirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextByHref : Instantiate VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextByHref (Generic Model Constructor) +func (*VpcV1) NewVirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextByHref(href string) (_model *VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextByHref, err error) { + _model = &VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextByHref) isaVirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContext() bool { + return true +} + +func (*VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextByHref) isaVirtualNetworkInterfacePrimaryIPPrototype() bool { + return true +} + +// UnmarshalVirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextByHref unmarshals an instance of VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextByHref from the specified map of raw messages. +func UnmarshalVirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextByID : VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextByID struct +// This model "extends" VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContext +type VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextByID struct { + // The unique identifier for this reserved IP. + ID *string `json:"id" validate:"required"` +} + +// NewVirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextByID : Instantiate VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextByID (Generic Model Constructor) +func (*VpcV1) NewVirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextByID(id string) (_model *VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextByID, err error) { + _model = &VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextByID) isaVirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContext() bool { + return true +} + +func (*VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextByID) isaVirtualNetworkInterfacePrimaryIPPrototype() bool { + return true +} + +// UnmarshalVirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextByID unmarshals an instance of VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextByID from the specified map of raw messages. +func UnmarshalVirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VirtualNetworkInterfacePrimaryIPPrototypeReservedIPIdentityVirtualNetworkInterfacePrimaryIPContextByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByCRN : VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByCRN struct +// This model "extends" VolumeAttachmentPrototypeVolumeVolumeIdentity +type VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByCRN struct { + // The CRN for this volume. + CRN *string `json:"crn" validate:"required"` +} + +// NewVolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByCRN : Instantiate VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByCRN (Generic Model Constructor) +func (*VpcV1) NewVolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByCRN(crn string) (_model *VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByCRN, err error) { + _model = &VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByCRN{ + CRN: core.StringPtr(crn), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByCRN) isaVolumeAttachmentPrototypeVolumeVolumeIdentity() bool { + return true +} + +func (*VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByCRN) isaVolumeAttachmentPrototypeVolume() bool { + return true +} + +// UnmarshalVolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByCRN unmarshals an instance of VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByCRN from the specified map of raw messages. +func UnmarshalVolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByCRN(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByCRN) + err = core.UnmarshalPrimitive(m, "crn", &obj.CRN) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByHref : VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByHref struct +// This model "extends" VolumeAttachmentPrototypeVolumeVolumeIdentity +type VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByHref struct { + // The URL for this volume. + Href *string `json:"href" validate:"required"` +} + +// NewVolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByHref : Instantiate VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByHref (Generic Model Constructor) +func (*VpcV1) NewVolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByHref(href string) (_model *VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByHref, err error) { + _model = &VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByHref{ + Href: core.StringPtr(href), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByHref) isaVolumeAttachmentPrototypeVolumeVolumeIdentity() bool { + return true +} + +func (*VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByHref) isaVolumeAttachmentPrototypeVolume() bool { + return true +} + +// UnmarshalVolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByHref unmarshals an instance of VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByHref from the specified map of raw messages. +func UnmarshalVolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByHref(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByHref) + err = core.UnmarshalPrimitive(m, "href", &obj.Href) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByID : VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByID struct +// This model "extends" VolumeAttachmentPrototypeVolumeVolumeIdentity +type VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByID struct { + // The unique identifier for this volume. + ID *string `json:"id" validate:"required"` +} + +// NewVolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByID : Instantiate VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByID (Generic Model Constructor) +func (*VpcV1) NewVolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByID(id string) (_model *VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByID, err error) { + _model = &VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByID{ + ID: core.StringPtr(id), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByID) isaVolumeAttachmentPrototypeVolumeVolumeIdentity() bool { + return true +} + +func (*VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByID) isaVolumeAttachmentPrototypeVolume() bool { + return true +} + +// UnmarshalVolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByID unmarshals an instance of VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByID from the specified map of raw messages. +func UnmarshalVolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByID(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeAttachmentPrototypeVolumeVolumeIdentityVolumeIdentityByID) + err = core.UnmarshalPrimitive(m, "id", &obj.ID) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextVolumePrototypeInstanceContextVolumeByCapacity : VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextVolumePrototypeInstanceContextVolumeByCapacity struct +// This model "extends" VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContext +type VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextVolumePrototypeInstanceContextVolumeByCapacity struct { + // The maximum I/O operations per second (IOPS) to use for this volume. Applicable only to volumes using a profile + // `family` of `custom`. + Iops *int64 `json:"iops,omitempty"` + + // The name for this volume. The name must not be used by another volume in the region. If unspecified, the name will + // be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-block-storage-profiles) to use for this volume. + Profile VolumeProfileIdentityIntf `json:"profile" validate:"required"` + + // The resource group to use for this volume. If unspecified, the instance's resource group will be used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The [user tags](https://cloud.ibm.com/apidocs/tagging#types-of-tags) associated with this volume. + UserTags []string `json:"user_tags,omitempty"` + + // The capacity to use for the volume (in gigabytes). The specified minimum and maximum capacity values for creating or + // updating volumes may expand in the future. + Capacity *int64 `json:"capacity" validate:"required"` + + // The root key to use to wrap the data encryption key for the volume. + // + // If unspecified, the `encryption` type for the volume will be `provider_managed`. + EncryptionKey EncryptionKeyIdentityIntf `json:"encryption_key,omitempty"` +} + +// NewVolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextVolumePrototypeInstanceContextVolumeByCapacity : Instantiate VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextVolumePrototypeInstanceContextVolumeByCapacity (Generic Model Constructor) +func (*VpcV1) NewVolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextVolumePrototypeInstanceContextVolumeByCapacity(profile VolumeProfileIdentityIntf, capacity int64) (_model *VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextVolumePrototypeInstanceContextVolumeByCapacity, err error) { + _model = &VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextVolumePrototypeInstanceContextVolumeByCapacity{ + Profile: profile, + Capacity: core.Int64Ptr(capacity), + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextVolumePrototypeInstanceContextVolumeByCapacity) isaVolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContext() bool { + return true +} + +func (*VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextVolumePrototypeInstanceContextVolumeByCapacity) isaVolumeAttachmentPrototypeVolume() bool { + return true +} + +// UnmarshalVolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextVolumePrototypeInstanceContextVolumeByCapacity unmarshals an instance of VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextVolumePrototypeInstanceContextVolumeByCapacity from the specified map of raw messages. +func UnmarshalVolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextVolumePrototypeInstanceContextVolumeByCapacity(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextVolumePrototypeInstanceContextVolumeByCapacity) + err = core.UnmarshalPrimitive(m, "iops", &obj.Iops) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalVolumeProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_tags", &obj.UserTags) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "capacity", &obj.Capacity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "encryption_key", &obj.EncryptionKey, UnmarshalEncryptionKeyIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextVolumePrototypeInstanceContextVolumeBySourceSnapshot : VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextVolumePrototypeInstanceContextVolumeBySourceSnapshot struct +// This model "extends" VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContext +type VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextVolumePrototypeInstanceContextVolumeBySourceSnapshot struct { + // The maximum I/O operations per second (IOPS) to use for this volume. Applicable only to volumes using a profile + // `family` of `custom`. + Iops *int64 `json:"iops,omitempty"` + + // The name for this volume. The name must not be used by another volume in the region. If unspecified, the name will + // be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-block-storage-profiles) to use for this volume. + Profile VolumeProfileIdentityIntf `json:"profile" validate:"required"` + + // The resource group to use for this volume. If unspecified, the instance's resource group will be used. + ResourceGroup ResourceGroupIdentityIntf `json:"resource_group,omitempty"` + + // The [user tags](https://cloud.ibm.com/apidocs/tagging#types-of-tags) associated with this volume. + UserTags []string `json:"user_tags,omitempty"` + + // The capacity to use for the volume (in gigabytes). Must be at least the snapshot's + // `minimum_capacity`. The maximum value may increase in the future. + // + // If unspecified, the capacity will be the source snapshot's `minimum_capacity`. + Capacity *int64 `json:"capacity,omitempty"` + + // The root key to use to wrap the data encryption key for the volume. + // + // If unspecified, the `encryption` type for the volume will be `provider_managed`. + EncryptionKey EncryptionKeyIdentityIntf `json:"encryption_key,omitempty"` + + // The snapshot from which to clone the volume. + SourceSnapshot SnapshotIdentityIntf `json:"source_snapshot" validate:"required"` +} + +// NewVolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextVolumePrototypeInstanceContextVolumeBySourceSnapshot : Instantiate VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextVolumePrototypeInstanceContextVolumeBySourceSnapshot (Generic Model Constructor) +func (*VpcV1) NewVolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextVolumePrototypeInstanceContextVolumeBySourceSnapshot(profile VolumeProfileIdentityIntf, sourceSnapshot SnapshotIdentityIntf) (_model *VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextVolumePrototypeInstanceContextVolumeBySourceSnapshot, err error) { + _model = &VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextVolumePrototypeInstanceContextVolumeBySourceSnapshot{ + Profile: profile, + SourceSnapshot: sourceSnapshot, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextVolumePrototypeInstanceContextVolumeBySourceSnapshot) isaVolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContext() bool { + return true +} + +func (*VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextVolumePrototypeInstanceContextVolumeBySourceSnapshot) isaVolumeAttachmentPrototypeVolume() bool { + return true +} + +// UnmarshalVolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextVolumePrototypeInstanceContextVolumeBySourceSnapshot unmarshals an instance of VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextVolumePrototypeInstanceContextVolumeBySourceSnapshot from the specified map of raw messages. +func UnmarshalVolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextVolumePrototypeInstanceContextVolumeBySourceSnapshot(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(VolumeAttachmentPrototypeVolumeVolumePrototypeInstanceContextVolumePrototypeInstanceContextVolumeBySourceSnapshot) + err = core.UnmarshalPrimitive(m, "iops", &obj.Iops) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalModel(m, "profile", &obj.Profile, UnmarshalVolumeProfileIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "resource_group", &obj.ResourceGroup, UnmarshalResourceGroupIdentity) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "user_tags", &obj.UserTags) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "capacity", &obj.Capacity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "encryption_key", &obj.EncryptionKey, UnmarshalEncryptionKeyIdentity) + if err != nil { + return + } + err = core.UnmarshalModel(m, "source_snapshot", &obj.SourceSnapshot, UnmarshalSnapshotIdentity) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByGroup : InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByGroup struct +// This model "extends" InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpec +type InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByGroup struct { + // The name for this instance group manager action. The name must not be used by another action for the instance group + // manager. If unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The cron specification for a recurring scheduled action. Actions can be applied a maximum of one time within a 5 min + // period. + CronSpec *string `json:"cron_spec,omitempty"` + + Group *InstanceGroupManagerScheduledActionGroupPrototype `json:"group" validate:"required"` +} + +// NewInstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByGroup : Instantiate InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByGroup (Generic Model Constructor) +func (*VpcV1) NewInstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByGroup(group *InstanceGroupManagerScheduledActionGroupPrototype) (_model *InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByGroup, err error) { + _model = &InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByGroup{ + Group: group, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByGroup) isaInstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpec() bool { + return true +} + +func (*InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByGroup) isaInstanceGroupManagerActionPrototypeScheduledActionPrototype() bool { + return true +} + +func (*InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByGroup) isaInstanceGroupManagerActionPrototype() bool { + return true +} + +// UnmarshalInstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByGroup unmarshals an instance of InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByGroup from the specified map of raw messages. +func UnmarshalInstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByGroup(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByGroup) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "cron_spec", &obj.CronSpec) + if err != nil { + return + } + err = core.UnmarshalModel(m, "group", &obj.Group, UnmarshalInstanceGroupManagerScheduledActionGroupPrototype) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByManager : InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByManager struct +// This model "extends" InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpec +type InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByManager struct { + // The name for this instance group manager action. The name must not be used by another action for the instance group + // manager. If unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The cron specification for a recurring scheduled action. Actions can be applied a maximum of one time within a 5 min + // period. + CronSpec *string `json:"cron_spec,omitempty"` + + Manager InstanceGroupManagerScheduledActionManagerPrototypeIntf `json:"manager" validate:"required"` +} + +// NewInstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByManager : Instantiate InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByManager (Generic Model Constructor) +func (*VpcV1) NewInstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByManager(manager InstanceGroupManagerScheduledActionManagerPrototypeIntf) (_model *InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByManager, err error) { + _model = &InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByManager{ + Manager: manager, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByManager) isaInstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpec() bool { + return true +} + +func (*InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByManager) isaInstanceGroupManagerActionPrototypeScheduledActionPrototype() bool { + return true +} + +func (*InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByManager) isaInstanceGroupManagerActionPrototype() bool { + return true +} + +// UnmarshalInstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByManager unmarshals an instance of InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByManager from the specified map of raw messages. +func UnmarshalInstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByManager(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerActionPrototypeScheduledActionPrototypeByCronSpecByManager) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "cron_spec", &obj.CronSpec) + if err != nil { + return + } + err = core.UnmarshalModel(m, "manager", &obj.Manager, UnmarshalInstanceGroupManagerScheduledActionManagerPrototype) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByGroup : InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByGroup struct +// This model "extends" InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAt +type InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByGroup struct { + // The name for this instance group manager action. The name must not be used by another action for the instance group + // manager. If unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The date and time the scheduled action will run. + RunAt *strfmt.DateTime `json:"run_at,omitempty"` + + Group *InstanceGroupManagerScheduledActionGroupPrototype `json:"group" validate:"required"` +} + +// NewInstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByGroup : Instantiate InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByGroup (Generic Model Constructor) +func (*VpcV1) NewInstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByGroup(group *InstanceGroupManagerScheduledActionGroupPrototype) (_model *InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByGroup, err error) { + _model = &InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByGroup{ + Group: group, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByGroup) isaInstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAt() bool { + return true +} + +func (*InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByGroup) isaInstanceGroupManagerActionPrototypeScheduledActionPrototype() bool { + return true +} + +func (*InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByGroup) isaInstanceGroupManagerActionPrototype() bool { + return true +} + +// UnmarshalInstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByGroup unmarshals an instance of InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByGroup from the specified map of raw messages. +func UnmarshalInstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByGroup(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByGroup) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "run_at", &obj.RunAt) + if err != nil { + return + } + err = core.UnmarshalModel(m, "group", &obj.Group, UnmarshalInstanceGroupManagerScheduledActionGroupPrototype) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByManager : InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByManager struct +// This model "extends" InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAt +type InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByManager struct { + // The name for this instance group manager action. The name must not be used by another action for the instance group + // manager. If unspecified, the name will be a hyphenated list of randomly-selected words. + Name *string `json:"name,omitempty"` + + // The date and time the scheduled action will run. + RunAt *strfmt.DateTime `json:"run_at,omitempty"` + + Manager InstanceGroupManagerScheduledActionManagerPrototypeIntf `json:"manager" validate:"required"` +} + +// NewInstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByManager : Instantiate InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByManager (Generic Model Constructor) +func (*VpcV1) NewInstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByManager(manager InstanceGroupManagerScheduledActionManagerPrototypeIntf) (_model *InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByManager, err error) { + _model = &InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByManager{ + Manager: manager, + } + err = core.ValidateStruct(_model, "required parameters") + return +} + +func (*InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByManager) isaInstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAt() bool { + return true +} + +func (*InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByManager) isaInstanceGroupManagerActionPrototypeScheduledActionPrototype() bool { + return true +} + +func (*InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByManager) isaInstanceGroupManagerActionPrototype() bool { + return true +} + +// UnmarshalInstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByManager unmarshals an instance of InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByManager from the specified map of raw messages. +func UnmarshalInstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByManager(m map[string]json.RawMessage, result interface{}) (err error) { + obj := new(InstanceGroupManagerActionPrototypeScheduledActionPrototypeByRunAtByManager) + err = core.UnmarshalPrimitive(m, "name", &obj.Name) + if err != nil { + return + } + err = core.UnmarshalPrimitive(m, "run_at", &obj.RunAt) + if err != nil { + return + } + err = core.UnmarshalModel(m, "manager", &obj.Manager, UnmarshalInstanceGroupManagerScheduledActionManagerPrototype) + if err != nil { + return + } + reflect.ValueOf(result).Elem().Set(reflect.ValueOf(obj)) + return +} + +// VpcsPager can be used to simplify the use of the "ListVpcs" method. +type VpcsPager struct { + hasNext bool + options *ListVpcsOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewVpcsPager returns a new VpcsPager instance. +func (vpc *VpcV1) NewVpcsPager(options *ListVpcsOptions) (pager *VpcsPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListVpcsOptions = *options + pager = &VpcsPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *VpcsPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *VpcsPager) GetNextWithContext(ctx context.Context) (page []VPC, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListVpcsWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.Vpcs + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *VpcsPager) GetAllWithContext(ctx context.Context) (allItems []VPC, err error) { + for pager.HasNext() { + var nextPage []VPC + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *VpcsPager) GetNext() (page []VPC, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *VpcsPager) GetAll() (allItems []VPC, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// VPCAddressPrefixesPager can be used to simplify the use of the "ListVPCAddressPrefixes" method. +type VPCAddressPrefixesPager struct { + hasNext bool + options *ListVPCAddressPrefixesOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewVPCAddressPrefixesPager returns a new VPCAddressPrefixesPager instance. +func (vpc *VpcV1) NewVPCAddressPrefixesPager(options *ListVPCAddressPrefixesOptions) (pager *VPCAddressPrefixesPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListVPCAddressPrefixesOptions = *options + pager = &VPCAddressPrefixesPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *VPCAddressPrefixesPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *VPCAddressPrefixesPager) GetNextWithContext(ctx context.Context) (page []AddressPrefix, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListVPCAddressPrefixesWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.AddressPrefixes + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *VPCAddressPrefixesPager) GetAllWithContext(ctx context.Context) (allItems []AddressPrefix, err error) { + for pager.HasNext() { + var nextPage []AddressPrefix + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *VPCAddressPrefixesPager) GetNext() (page []AddressPrefix, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *VPCAddressPrefixesPager) GetAll() (allItems []AddressPrefix, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// VPCDnsResolutionBindingsPager can be used to simplify the use of the "ListVPCDnsResolutionBindings" method. +type VPCDnsResolutionBindingsPager struct { + hasNext bool + options *ListVPCDnsResolutionBindingsOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewVPCDnsResolutionBindingsPager returns a new VPCDnsResolutionBindingsPager instance. +func (vpc *VpcV1) NewVPCDnsResolutionBindingsPager(options *ListVPCDnsResolutionBindingsOptions) (pager *VPCDnsResolutionBindingsPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListVPCDnsResolutionBindingsOptions = *options + pager = &VPCDnsResolutionBindingsPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *VPCDnsResolutionBindingsPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *VPCDnsResolutionBindingsPager) GetNextWithContext(ctx context.Context) (page []VpcdnsResolutionBinding, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListVPCDnsResolutionBindingsWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.DnsResolutionBindings + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *VPCDnsResolutionBindingsPager) GetAllWithContext(ctx context.Context) (allItems []VpcdnsResolutionBinding, err error) { + for pager.HasNext() { + var nextPage []VpcdnsResolutionBinding + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *VPCDnsResolutionBindingsPager) GetNext() (page []VpcdnsResolutionBinding, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *VPCDnsResolutionBindingsPager) GetAll() (allItems []VpcdnsResolutionBinding, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// VPCRoutesPager can be used to simplify the use of the "ListVPCRoutes" method. +type VPCRoutesPager struct { + hasNext bool + options *ListVPCRoutesOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewVPCRoutesPager returns a new VPCRoutesPager instance. +func (vpc *VpcV1) NewVPCRoutesPager(options *ListVPCRoutesOptions) (pager *VPCRoutesPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListVPCRoutesOptions = *options + pager = &VPCRoutesPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *VPCRoutesPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *VPCRoutesPager) GetNextWithContext(ctx context.Context) (page []RouteCollectionVPCContextRoutesItem, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListVPCRoutesWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.Routes + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *VPCRoutesPager) GetAllWithContext(ctx context.Context) (allItems []RouteCollectionVPCContextRoutesItem, err error) { + for pager.HasNext() { + var nextPage []RouteCollectionVPCContextRoutesItem + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *VPCRoutesPager) GetNext() (page []RouteCollectionVPCContextRoutesItem, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *VPCRoutesPager) GetAll() (allItems []RouteCollectionVPCContextRoutesItem, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// VPCRoutingTablesPager can be used to simplify the use of the "ListVPCRoutingTables" method. +type VPCRoutingTablesPager struct { + hasNext bool + options *ListVPCRoutingTablesOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewVPCRoutingTablesPager returns a new VPCRoutingTablesPager instance. +func (vpc *VpcV1) NewVPCRoutingTablesPager(options *ListVPCRoutingTablesOptions) (pager *VPCRoutingTablesPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListVPCRoutingTablesOptions = *options + pager = &VPCRoutingTablesPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *VPCRoutingTablesPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *VPCRoutingTablesPager) GetNextWithContext(ctx context.Context) (page []RoutingTable, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListVPCRoutingTablesWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.RoutingTables + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *VPCRoutingTablesPager) GetAllWithContext(ctx context.Context) (allItems []RoutingTable, err error) { + for pager.HasNext() { + var nextPage []RoutingTable + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *VPCRoutingTablesPager) GetNext() (page []RoutingTable, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *VPCRoutingTablesPager) GetAll() (allItems []RoutingTable, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// VPCRoutingTableRoutesPager can be used to simplify the use of the "ListVPCRoutingTableRoutes" method. +type VPCRoutingTableRoutesPager struct { + hasNext bool + options *ListVPCRoutingTableRoutesOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewVPCRoutingTableRoutesPager returns a new VPCRoutingTableRoutesPager instance. +func (vpc *VpcV1) NewVPCRoutingTableRoutesPager(options *ListVPCRoutingTableRoutesOptions) (pager *VPCRoutingTableRoutesPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListVPCRoutingTableRoutesOptions = *options + pager = &VPCRoutingTableRoutesPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *VPCRoutingTableRoutesPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *VPCRoutingTableRoutesPager) GetNextWithContext(ctx context.Context) (page []Route, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListVPCRoutingTableRoutesWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.Routes + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *VPCRoutingTableRoutesPager) GetAllWithContext(ctx context.Context) (allItems []Route, err error) { + for pager.HasNext() { + var nextPage []Route + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *VPCRoutingTableRoutesPager) GetNext() (page []Route, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *VPCRoutingTableRoutesPager) GetAll() (allItems []Route, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// SubnetsPager can be used to simplify the use of the "ListSubnets" method. +type SubnetsPager struct { + hasNext bool + options *ListSubnetsOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewSubnetsPager returns a new SubnetsPager instance. +func (vpc *VpcV1) NewSubnetsPager(options *ListSubnetsOptions) (pager *SubnetsPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListSubnetsOptions = *options + pager = &SubnetsPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *SubnetsPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *SubnetsPager) GetNextWithContext(ctx context.Context) (page []Subnet, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListSubnetsWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.Subnets + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *SubnetsPager) GetAllWithContext(ctx context.Context) (allItems []Subnet, err error) { + for pager.HasNext() { + var nextPage []Subnet + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *SubnetsPager) GetNext() (page []Subnet, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *SubnetsPager) GetAll() (allItems []Subnet, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// SubnetReservedIpsPager can be used to simplify the use of the "ListSubnetReservedIps" method. +type SubnetReservedIpsPager struct { + hasNext bool + options *ListSubnetReservedIpsOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewSubnetReservedIpsPager returns a new SubnetReservedIpsPager instance. +func (vpc *VpcV1) NewSubnetReservedIpsPager(options *ListSubnetReservedIpsOptions) (pager *SubnetReservedIpsPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListSubnetReservedIpsOptions = *options + pager = &SubnetReservedIpsPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *SubnetReservedIpsPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *SubnetReservedIpsPager) GetNextWithContext(ctx context.Context) (page []ReservedIP, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListSubnetReservedIpsWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.ReservedIps + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *SubnetReservedIpsPager) GetAllWithContext(ctx context.Context) (allItems []ReservedIP, err error) { + for pager.HasNext() { + var nextPage []ReservedIP + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *SubnetReservedIpsPager) GetNext() (page []ReservedIP, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *SubnetReservedIpsPager) GetAll() (allItems []ReservedIP, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// ImagesPager can be used to simplify the use of the "ListImages" method. +type ImagesPager struct { + hasNext bool + options *ListImagesOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewImagesPager returns a new ImagesPager instance. +func (vpc *VpcV1) NewImagesPager(options *ListImagesOptions) (pager *ImagesPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListImagesOptions = *options + pager = &ImagesPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *ImagesPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *ImagesPager) GetNextWithContext(ctx context.Context) (page []Image, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListImagesWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.Images + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *ImagesPager) GetAllWithContext(ctx context.Context) (allItems []Image, err error) { + for pager.HasNext() { + var nextPage []Image + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *ImagesPager) GetNext() (page []Image, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *ImagesPager) GetAll() (allItems []Image, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// OperatingSystemsPager can be used to simplify the use of the "ListOperatingSystems" method. +type OperatingSystemsPager struct { + hasNext bool + options *ListOperatingSystemsOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewOperatingSystemsPager returns a new OperatingSystemsPager instance. +func (vpc *VpcV1) NewOperatingSystemsPager(options *ListOperatingSystemsOptions) (pager *OperatingSystemsPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListOperatingSystemsOptions = *options + pager = &OperatingSystemsPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *OperatingSystemsPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *OperatingSystemsPager) GetNextWithContext(ctx context.Context) (page []OperatingSystem, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListOperatingSystemsWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.OperatingSystems + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *OperatingSystemsPager) GetAllWithContext(ctx context.Context) (allItems []OperatingSystem, err error) { + for pager.HasNext() { + var nextPage []OperatingSystem + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *OperatingSystemsPager) GetNext() (page []OperatingSystem, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *OperatingSystemsPager) GetAll() (allItems []OperatingSystem, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// KeysPager can be used to simplify the use of the "ListKeys" method. +type KeysPager struct { + hasNext bool + options *ListKeysOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewKeysPager returns a new KeysPager instance. +func (vpc *VpcV1) NewKeysPager(options *ListKeysOptions) (pager *KeysPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListKeysOptions = *options + pager = &KeysPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *KeysPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *KeysPager) GetNextWithContext(ctx context.Context) (page []Key, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListKeysWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.Keys + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *KeysPager) GetAllWithContext(ctx context.Context) (allItems []Key, err error) { + for pager.HasNext() { + var nextPage []Key + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *KeysPager) GetNext() (page []Key, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *KeysPager) GetAll() (allItems []Key, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// InstancesPager can be used to simplify the use of the "ListInstances" method. +type InstancesPager struct { + hasNext bool + options *ListInstancesOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewInstancesPager returns a new InstancesPager instance. +func (vpc *VpcV1) NewInstancesPager(options *ListInstancesOptions) (pager *InstancesPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListInstancesOptions = *options + pager = &InstancesPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *InstancesPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *InstancesPager) GetNextWithContext(ctx context.Context) (page []Instance, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListInstancesWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.Instances + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *InstancesPager) GetAllWithContext(ctx context.Context) (allItems []Instance, err error) { + for pager.HasNext() { + var nextPage []Instance + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *InstancesPager) GetNext() (page []Instance, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *InstancesPager) GetAll() (allItems []Instance, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// InstanceNetworkInterfaceIpsPager can be used to simplify the use of the "ListInstanceNetworkInterfaceIps" method. +type InstanceNetworkInterfaceIpsPager struct { + hasNext bool + options *ListInstanceNetworkInterfaceIpsOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewInstanceNetworkInterfaceIpsPager returns a new InstanceNetworkInterfaceIpsPager instance. +func (vpc *VpcV1) NewInstanceNetworkInterfaceIpsPager(options *ListInstanceNetworkInterfaceIpsOptions) (pager *InstanceNetworkInterfaceIpsPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListInstanceNetworkInterfaceIpsOptions = *options + pager = &InstanceNetworkInterfaceIpsPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *InstanceNetworkInterfaceIpsPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *InstanceNetworkInterfaceIpsPager) GetNextWithContext(ctx context.Context) (page []ReservedIP, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListInstanceNetworkInterfaceIpsWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.Ips + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *InstanceNetworkInterfaceIpsPager) GetAllWithContext(ctx context.Context) (allItems []ReservedIP, err error) { + for pager.HasNext() { + var nextPage []ReservedIP + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *InstanceNetworkInterfaceIpsPager) GetNext() (page []ReservedIP, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *InstanceNetworkInterfaceIpsPager) GetAll() (allItems []ReservedIP, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// InstanceGroupsPager can be used to simplify the use of the "ListInstanceGroups" method. +type InstanceGroupsPager struct { + hasNext bool + options *ListInstanceGroupsOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewInstanceGroupsPager returns a new InstanceGroupsPager instance. +func (vpc *VpcV1) NewInstanceGroupsPager(options *ListInstanceGroupsOptions) (pager *InstanceGroupsPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListInstanceGroupsOptions = *options + pager = &InstanceGroupsPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *InstanceGroupsPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *InstanceGroupsPager) GetNextWithContext(ctx context.Context) (page []InstanceGroup, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListInstanceGroupsWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.InstanceGroups + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *InstanceGroupsPager) GetAllWithContext(ctx context.Context) (allItems []InstanceGroup, err error) { + for pager.HasNext() { + var nextPage []InstanceGroup + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *InstanceGroupsPager) GetNext() (page []InstanceGroup, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *InstanceGroupsPager) GetAll() (allItems []InstanceGroup, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// InstanceGroupManagersPager can be used to simplify the use of the "ListInstanceGroupManagers" method. +type InstanceGroupManagersPager struct { + hasNext bool + options *ListInstanceGroupManagersOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewInstanceGroupManagersPager returns a new InstanceGroupManagersPager instance. +func (vpc *VpcV1) NewInstanceGroupManagersPager(options *ListInstanceGroupManagersOptions) (pager *InstanceGroupManagersPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListInstanceGroupManagersOptions = *options + pager = &InstanceGroupManagersPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *InstanceGroupManagersPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *InstanceGroupManagersPager) GetNextWithContext(ctx context.Context) (page []InstanceGroupManagerIntf, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListInstanceGroupManagersWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.Managers + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *InstanceGroupManagersPager) GetAllWithContext(ctx context.Context) (allItems []InstanceGroupManagerIntf, err error) { + for pager.HasNext() { + var nextPage []InstanceGroupManagerIntf + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *InstanceGroupManagersPager) GetNext() (page []InstanceGroupManagerIntf, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *InstanceGroupManagersPager) GetAll() (allItems []InstanceGroupManagerIntf, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// InstanceGroupManagerActionsPager can be used to simplify the use of the "ListInstanceGroupManagerActions" method. +type InstanceGroupManagerActionsPager struct { + hasNext bool + options *ListInstanceGroupManagerActionsOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewInstanceGroupManagerActionsPager returns a new InstanceGroupManagerActionsPager instance. +func (vpc *VpcV1) NewInstanceGroupManagerActionsPager(options *ListInstanceGroupManagerActionsOptions) (pager *InstanceGroupManagerActionsPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListInstanceGroupManagerActionsOptions = *options + pager = &InstanceGroupManagerActionsPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *InstanceGroupManagerActionsPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *InstanceGroupManagerActionsPager) GetNextWithContext(ctx context.Context) (page []InstanceGroupManagerActionIntf, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListInstanceGroupManagerActionsWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.Actions + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *InstanceGroupManagerActionsPager) GetAllWithContext(ctx context.Context) (allItems []InstanceGroupManagerActionIntf, err error) { + for pager.HasNext() { + var nextPage []InstanceGroupManagerActionIntf + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *InstanceGroupManagerActionsPager) GetNext() (page []InstanceGroupManagerActionIntf, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *InstanceGroupManagerActionsPager) GetAll() (allItems []InstanceGroupManagerActionIntf, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// InstanceGroupManagerPoliciesPager can be used to simplify the use of the "ListInstanceGroupManagerPolicies" method. +type InstanceGroupManagerPoliciesPager struct { + hasNext bool + options *ListInstanceGroupManagerPoliciesOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewInstanceGroupManagerPoliciesPager returns a new InstanceGroupManagerPoliciesPager instance. +func (vpc *VpcV1) NewInstanceGroupManagerPoliciesPager(options *ListInstanceGroupManagerPoliciesOptions) (pager *InstanceGroupManagerPoliciesPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListInstanceGroupManagerPoliciesOptions = *options + pager = &InstanceGroupManagerPoliciesPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *InstanceGroupManagerPoliciesPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *InstanceGroupManagerPoliciesPager) GetNextWithContext(ctx context.Context) (page []InstanceGroupManagerPolicyIntf, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListInstanceGroupManagerPoliciesWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.Policies + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *InstanceGroupManagerPoliciesPager) GetAllWithContext(ctx context.Context) (allItems []InstanceGroupManagerPolicyIntf, err error) { + for pager.HasNext() { + var nextPage []InstanceGroupManagerPolicyIntf + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *InstanceGroupManagerPoliciesPager) GetNext() (page []InstanceGroupManagerPolicyIntf, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *InstanceGroupManagerPoliciesPager) GetAll() (allItems []InstanceGroupManagerPolicyIntf, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// InstanceGroupMembershipsPager can be used to simplify the use of the "ListInstanceGroupMemberships" method. +type InstanceGroupMembershipsPager struct { + hasNext bool + options *ListInstanceGroupMembershipsOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewInstanceGroupMembershipsPager returns a new InstanceGroupMembershipsPager instance. +func (vpc *VpcV1) NewInstanceGroupMembershipsPager(options *ListInstanceGroupMembershipsOptions) (pager *InstanceGroupMembershipsPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListInstanceGroupMembershipsOptions = *options + pager = &InstanceGroupMembershipsPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *InstanceGroupMembershipsPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *InstanceGroupMembershipsPager) GetNextWithContext(ctx context.Context) (page []InstanceGroupMembership, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListInstanceGroupMembershipsWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.Memberships + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *InstanceGroupMembershipsPager) GetAllWithContext(ctx context.Context) (allItems []InstanceGroupMembership, err error) { + for pager.HasNext() { + var nextPage []InstanceGroupMembership + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *InstanceGroupMembershipsPager) GetNext() (page []InstanceGroupMembership, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *InstanceGroupMembershipsPager) GetAll() (allItems []InstanceGroupMembership, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// DedicatedHostGroupsPager can be used to simplify the use of the "ListDedicatedHostGroups" method. +type DedicatedHostGroupsPager struct { + hasNext bool + options *ListDedicatedHostGroupsOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewDedicatedHostGroupsPager returns a new DedicatedHostGroupsPager instance. +func (vpc *VpcV1) NewDedicatedHostGroupsPager(options *ListDedicatedHostGroupsOptions) (pager *DedicatedHostGroupsPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListDedicatedHostGroupsOptions = *options + pager = &DedicatedHostGroupsPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *DedicatedHostGroupsPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *DedicatedHostGroupsPager) GetNextWithContext(ctx context.Context) (page []DedicatedHostGroup, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListDedicatedHostGroupsWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.Groups + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *DedicatedHostGroupsPager) GetAllWithContext(ctx context.Context) (allItems []DedicatedHostGroup, err error) { + for pager.HasNext() { + var nextPage []DedicatedHostGroup + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *DedicatedHostGroupsPager) GetNext() (page []DedicatedHostGroup, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *DedicatedHostGroupsPager) GetAll() (allItems []DedicatedHostGroup, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// DedicatedHostProfilesPager can be used to simplify the use of the "ListDedicatedHostProfiles" method. +type DedicatedHostProfilesPager struct { + hasNext bool + options *ListDedicatedHostProfilesOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewDedicatedHostProfilesPager returns a new DedicatedHostProfilesPager instance. +func (vpc *VpcV1) NewDedicatedHostProfilesPager(options *ListDedicatedHostProfilesOptions) (pager *DedicatedHostProfilesPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListDedicatedHostProfilesOptions = *options + pager = &DedicatedHostProfilesPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *DedicatedHostProfilesPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *DedicatedHostProfilesPager) GetNextWithContext(ctx context.Context) (page []DedicatedHostProfile, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListDedicatedHostProfilesWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.Profiles + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *DedicatedHostProfilesPager) GetAllWithContext(ctx context.Context) (allItems []DedicatedHostProfile, err error) { + for pager.HasNext() { + var nextPage []DedicatedHostProfile + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *DedicatedHostProfilesPager) GetNext() (page []DedicatedHostProfile, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *DedicatedHostProfilesPager) GetAll() (allItems []DedicatedHostProfile, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// DedicatedHostsPager can be used to simplify the use of the "ListDedicatedHosts" method. +type DedicatedHostsPager struct { + hasNext bool + options *ListDedicatedHostsOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewDedicatedHostsPager returns a new DedicatedHostsPager instance. +func (vpc *VpcV1) NewDedicatedHostsPager(options *ListDedicatedHostsOptions) (pager *DedicatedHostsPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListDedicatedHostsOptions = *options + pager = &DedicatedHostsPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *DedicatedHostsPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *DedicatedHostsPager) GetNextWithContext(ctx context.Context) (page []DedicatedHost, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListDedicatedHostsWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.DedicatedHosts + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *DedicatedHostsPager) GetAllWithContext(ctx context.Context) (allItems []DedicatedHost, err error) { + for pager.HasNext() { + var nextPage []DedicatedHost + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *DedicatedHostsPager) GetNext() (page []DedicatedHost, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *DedicatedHostsPager) GetAll() (allItems []DedicatedHost, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// BackupPoliciesPager can be used to simplify the use of the "ListBackupPolicies" method. +type BackupPoliciesPager struct { + hasNext bool + options *ListBackupPoliciesOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewBackupPoliciesPager returns a new BackupPoliciesPager instance. +func (vpc *VpcV1) NewBackupPoliciesPager(options *ListBackupPoliciesOptions) (pager *BackupPoliciesPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListBackupPoliciesOptions = *options + pager = &BackupPoliciesPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *BackupPoliciesPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *BackupPoliciesPager) GetNextWithContext(ctx context.Context) (page []BackupPolicy, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListBackupPoliciesWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.BackupPolicies + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *BackupPoliciesPager) GetAllWithContext(ctx context.Context) (allItems []BackupPolicy, err error) { + for pager.HasNext() { + var nextPage []BackupPolicy + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *BackupPoliciesPager) GetNext() (page []BackupPolicy, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *BackupPoliciesPager) GetAll() (allItems []BackupPolicy, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// BackupPolicyJobsPager can be used to simplify the use of the "ListBackupPolicyJobs" method. +type BackupPolicyJobsPager struct { + hasNext bool + options *ListBackupPolicyJobsOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewBackupPolicyJobsPager returns a new BackupPolicyJobsPager instance. +func (vpc *VpcV1) NewBackupPolicyJobsPager(options *ListBackupPolicyJobsOptions) (pager *BackupPolicyJobsPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListBackupPolicyJobsOptions = *options + pager = &BackupPolicyJobsPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *BackupPolicyJobsPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *BackupPolicyJobsPager) GetNextWithContext(ctx context.Context) (page []BackupPolicyJob, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListBackupPolicyJobsWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.Jobs + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *BackupPolicyJobsPager) GetAllWithContext(ctx context.Context) (allItems []BackupPolicyJob, err error) { + for pager.HasNext() { + var nextPage []BackupPolicyJob + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *BackupPolicyJobsPager) GetNext() (page []BackupPolicyJob, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *BackupPolicyJobsPager) GetAll() (allItems []BackupPolicyJob, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// PlacementGroupsPager can be used to simplify the use of the "ListPlacementGroups" method. +type PlacementGroupsPager struct { + hasNext bool + options *ListPlacementGroupsOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewPlacementGroupsPager returns a new PlacementGroupsPager instance. +func (vpc *VpcV1) NewPlacementGroupsPager(options *ListPlacementGroupsOptions) (pager *PlacementGroupsPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListPlacementGroupsOptions = *options + pager = &PlacementGroupsPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *PlacementGroupsPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *PlacementGroupsPager) GetNextWithContext(ctx context.Context) (page []PlacementGroup, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListPlacementGroupsWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.PlacementGroups + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *PlacementGroupsPager) GetAllWithContext(ctx context.Context) (allItems []PlacementGroup, err error) { + for pager.HasNext() { + var nextPage []PlacementGroup + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *PlacementGroupsPager) GetNext() (page []PlacementGroup, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *PlacementGroupsPager) GetAll() (allItems []PlacementGroup, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// BareMetalServerProfilesPager can be used to simplify the use of the "ListBareMetalServerProfiles" method. +type BareMetalServerProfilesPager struct { + hasNext bool + options *ListBareMetalServerProfilesOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewBareMetalServerProfilesPager returns a new BareMetalServerProfilesPager instance. +func (vpc *VpcV1) NewBareMetalServerProfilesPager(options *ListBareMetalServerProfilesOptions) (pager *BareMetalServerProfilesPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListBareMetalServerProfilesOptions = *options + pager = &BareMetalServerProfilesPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *BareMetalServerProfilesPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *BareMetalServerProfilesPager) GetNextWithContext(ctx context.Context) (page []BareMetalServerProfile, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListBareMetalServerProfilesWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.Profiles + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *BareMetalServerProfilesPager) GetAllWithContext(ctx context.Context) (allItems []BareMetalServerProfile, err error) { + for pager.HasNext() { + var nextPage []BareMetalServerProfile + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *BareMetalServerProfilesPager) GetNext() (page []BareMetalServerProfile, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *BareMetalServerProfilesPager) GetAll() (allItems []BareMetalServerProfile, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// BareMetalServersPager can be used to simplify the use of the "ListBareMetalServers" method. +type BareMetalServersPager struct { + hasNext bool + options *ListBareMetalServersOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewBareMetalServersPager returns a new BareMetalServersPager instance. +func (vpc *VpcV1) NewBareMetalServersPager(options *ListBareMetalServersOptions) (pager *BareMetalServersPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListBareMetalServersOptions = *options + pager = &BareMetalServersPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *BareMetalServersPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *BareMetalServersPager) GetNextWithContext(ctx context.Context) (page []BareMetalServer, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListBareMetalServersWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.BareMetalServers + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *BareMetalServersPager) GetAllWithContext(ctx context.Context) (allItems []BareMetalServer, err error) { + for pager.HasNext() { + var nextPage []BareMetalServer + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *BareMetalServersPager) GetNext() (page []BareMetalServer, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *BareMetalServersPager) GetAll() (allItems []BareMetalServer, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// BareMetalServerNetworkInterfacesPager can be used to simplify the use of the "ListBareMetalServerNetworkInterfaces" method. +type BareMetalServerNetworkInterfacesPager struct { + hasNext bool + options *ListBareMetalServerNetworkInterfacesOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewBareMetalServerNetworkInterfacesPager returns a new BareMetalServerNetworkInterfacesPager instance. +func (vpc *VpcV1) NewBareMetalServerNetworkInterfacesPager(options *ListBareMetalServerNetworkInterfacesOptions) (pager *BareMetalServerNetworkInterfacesPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListBareMetalServerNetworkInterfacesOptions = *options + pager = &BareMetalServerNetworkInterfacesPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *BareMetalServerNetworkInterfacesPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *BareMetalServerNetworkInterfacesPager) GetNextWithContext(ctx context.Context) (page []BareMetalServerNetworkInterfaceIntf, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListBareMetalServerNetworkInterfacesWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.NetworkInterfaces + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *BareMetalServerNetworkInterfacesPager) GetAllWithContext(ctx context.Context) (allItems []BareMetalServerNetworkInterfaceIntf, err error) { + for pager.HasNext() { + var nextPage []BareMetalServerNetworkInterfaceIntf + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *BareMetalServerNetworkInterfacesPager) GetNext() (page []BareMetalServerNetworkInterfaceIntf, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *BareMetalServerNetworkInterfacesPager) GetAll() (allItems []BareMetalServerNetworkInterfaceIntf, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// VolumeProfilesPager can be used to simplify the use of the "ListVolumeProfiles" method. +type VolumeProfilesPager struct { + hasNext bool + options *ListVolumeProfilesOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewVolumeProfilesPager returns a new VolumeProfilesPager instance. +func (vpc *VpcV1) NewVolumeProfilesPager(options *ListVolumeProfilesOptions) (pager *VolumeProfilesPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListVolumeProfilesOptions = *options + pager = &VolumeProfilesPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *VolumeProfilesPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *VolumeProfilesPager) GetNextWithContext(ctx context.Context) (page []VolumeProfile, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListVolumeProfilesWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.Profiles + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *VolumeProfilesPager) GetAllWithContext(ctx context.Context) (allItems []VolumeProfile, err error) { + for pager.HasNext() { + var nextPage []VolumeProfile + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *VolumeProfilesPager) GetNext() (page []VolumeProfile, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *VolumeProfilesPager) GetAll() (allItems []VolumeProfile, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// VolumesPager can be used to simplify the use of the "ListVolumes" method. +type VolumesPager struct { + hasNext bool + options *ListVolumesOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewVolumesPager returns a new VolumesPager instance. +func (vpc *VpcV1) NewVolumesPager(options *ListVolumesOptions) (pager *VolumesPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListVolumesOptions = *options + pager = &VolumesPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *VolumesPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *VolumesPager) GetNextWithContext(ctx context.Context) (page []Volume, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListVolumesWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.Volumes + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *VolumesPager) GetAllWithContext(ctx context.Context) (allItems []Volume, err error) { + for pager.HasNext() { + var nextPage []Volume + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *VolumesPager) GetNext() (page []Volume, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *VolumesPager) GetAll() (allItems []Volume, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// SnapshotsPager can be used to simplify the use of the "ListSnapshots" method. +type SnapshotsPager struct { + hasNext bool + options *ListSnapshotsOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewSnapshotsPager returns a new SnapshotsPager instance. +func (vpc *VpcV1) NewSnapshotsPager(options *ListSnapshotsOptions) (pager *SnapshotsPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListSnapshotsOptions = *options + pager = &SnapshotsPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *SnapshotsPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *SnapshotsPager) GetNextWithContext(ctx context.Context) (page []Snapshot, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListSnapshotsWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.Snapshots + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *SnapshotsPager) GetAllWithContext(ctx context.Context) (allItems []Snapshot, err error) { + for pager.HasNext() { + var nextPage []Snapshot + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *SnapshotsPager) GetNext() (page []Snapshot, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *SnapshotsPager) GetAll() (allItems []Snapshot, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// ShareProfilesPager can be used to simplify the use of the "ListShareProfiles" method. +type ShareProfilesPager struct { + hasNext bool + options *ListShareProfilesOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewShareProfilesPager returns a new ShareProfilesPager instance. +func (vpc *VpcV1) NewShareProfilesPager(options *ListShareProfilesOptions) (pager *ShareProfilesPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListShareProfilesOptions = *options + pager = &ShareProfilesPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *ShareProfilesPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *ShareProfilesPager) GetNextWithContext(ctx context.Context) (page []ShareProfile, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListShareProfilesWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.Profiles + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *ShareProfilesPager) GetAllWithContext(ctx context.Context) (allItems []ShareProfile, err error) { + for pager.HasNext() { + var nextPage []ShareProfile + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *ShareProfilesPager) GetNext() (page []ShareProfile, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *ShareProfilesPager) GetAll() (allItems []ShareProfile, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// SharesPager can be used to simplify the use of the "ListShares" method. +type SharesPager struct { + hasNext bool + options *ListSharesOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewSharesPager returns a new SharesPager instance. +func (vpc *VpcV1) NewSharesPager(options *ListSharesOptions) (pager *SharesPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListSharesOptions = *options + pager = &SharesPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *SharesPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *SharesPager) GetNextWithContext(ctx context.Context) (page []Share, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListSharesWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.Shares + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *SharesPager) GetAllWithContext(ctx context.Context) (allItems []Share, err error) { + for pager.HasNext() { + var nextPage []Share + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *SharesPager) GetNext() (page []Share, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *SharesPager) GetAll() (allItems []Share, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// ShareMountTargetsPager can be used to simplify the use of the "ListShareMountTargets" method. +type ShareMountTargetsPager struct { + hasNext bool + options *ListShareMountTargetsOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewShareMountTargetsPager returns a new ShareMountTargetsPager instance. +func (vpc *VpcV1) NewShareMountTargetsPager(options *ListShareMountTargetsOptions) (pager *ShareMountTargetsPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListShareMountTargetsOptions = *options + pager = &ShareMountTargetsPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *ShareMountTargetsPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *ShareMountTargetsPager) GetNextWithContext(ctx context.Context) (page []ShareMountTarget, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListShareMountTargetsWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.MountTargets + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *ShareMountTargetsPager) GetAllWithContext(ctx context.Context) (allItems []ShareMountTarget, err error) { + for pager.HasNext() { + var nextPage []ShareMountTarget + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *ShareMountTargetsPager) GetNext() (page []ShareMountTarget, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *ShareMountTargetsPager) GetAll() (allItems []ShareMountTarget, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// VirtualNetworkInterfacesPager can be used to simplify the use of the "ListVirtualNetworkInterfaces" method. +type VirtualNetworkInterfacesPager struct { + hasNext bool + options *ListVirtualNetworkInterfacesOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewVirtualNetworkInterfacesPager returns a new VirtualNetworkInterfacesPager instance. +func (vpc *VpcV1) NewVirtualNetworkInterfacesPager(options *ListVirtualNetworkInterfacesOptions) (pager *VirtualNetworkInterfacesPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListVirtualNetworkInterfacesOptions = *options + pager = &VirtualNetworkInterfacesPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *VirtualNetworkInterfacesPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *VirtualNetworkInterfacesPager) GetNextWithContext(ctx context.Context) (page []VirtualNetworkInterface, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListVirtualNetworkInterfacesWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.VirtualNetworkInterfaces + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *VirtualNetworkInterfacesPager) GetAllWithContext(ctx context.Context) (allItems []VirtualNetworkInterface, err error) { + for pager.HasNext() { + var nextPage []VirtualNetworkInterface + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *VirtualNetworkInterfacesPager) GetNext() (page []VirtualNetworkInterface, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *VirtualNetworkInterfacesPager) GetAll() (allItems []VirtualNetworkInterface, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// PublicGatewaysPager can be used to simplify the use of the "ListPublicGateways" method. +type PublicGatewaysPager struct { + hasNext bool + options *ListPublicGatewaysOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewPublicGatewaysPager returns a new PublicGatewaysPager instance. +func (vpc *VpcV1) NewPublicGatewaysPager(options *ListPublicGatewaysOptions) (pager *PublicGatewaysPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListPublicGatewaysOptions = *options + pager = &PublicGatewaysPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *PublicGatewaysPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *PublicGatewaysPager) GetNextWithContext(ctx context.Context) (page []PublicGateway, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListPublicGatewaysWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.PublicGateways + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *PublicGatewaysPager) GetAllWithContext(ctx context.Context) (allItems []PublicGateway, err error) { + for pager.HasNext() { + var nextPage []PublicGateway + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *PublicGatewaysPager) GetNext() (page []PublicGateway, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *PublicGatewaysPager) GetAll() (allItems []PublicGateway, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// FloatingIpsPager can be used to simplify the use of the "ListFloatingIps" method. +type FloatingIpsPager struct { + hasNext bool + options *ListFloatingIpsOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewFloatingIpsPager returns a new FloatingIpsPager instance. +func (vpc *VpcV1) NewFloatingIpsPager(options *ListFloatingIpsOptions) (pager *FloatingIpsPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListFloatingIpsOptions = *options + pager = &FloatingIpsPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *FloatingIpsPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *FloatingIpsPager) GetNextWithContext(ctx context.Context) (page []FloatingIP, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListFloatingIpsWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.FloatingIps + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *FloatingIpsPager) GetAllWithContext(ctx context.Context) (allItems []FloatingIP, err error) { + for pager.HasNext() { + var nextPage []FloatingIP + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *FloatingIpsPager) GetNext() (page []FloatingIP, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *FloatingIpsPager) GetAll() (allItems []FloatingIP, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// NetworkAclsPager can be used to simplify the use of the "ListNetworkAcls" method. +type NetworkAclsPager struct { + hasNext bool + options *ListNetworkAclsOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewNetworkAclsPager returns a new NetworkAclsPager instance. +func (vpc *VpcV1) NewNetworkAclsPager(options *ListNetworkAclsOptions) (pager *NetworkAclsPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListNetworkAclsOptions = *options + pager = &NetworkAclsPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *NetworkAclsPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *NetworkAclsPager) GetNextWithContext(ctx context.Context) (page []NetworkACL, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListNetworkAclsWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.NetworkAcls + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *NetworkAclsPager) GetAllWithContext(ctx context.Context) (allItems []NetworkACL, err error) { + for pager.HasNext() { + var nextPage []NetworkACL + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *NetworkAclsPager) GetNext() (page []NetworkACL, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *NetworkAclsPager) GetAll() (allItems []NetworkACL, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// NetworkACLRulesPager can be used to simplify the use of the "ListNetworkACLRules" method. +type NetworkACLRulesPager struct { + hasNext bool + options *ListNetworkACLRulesOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewNetworkACLRulesPager returns a new NetworkACLRulesPager instance. +func (vpc *VpcV1) NewNetworkACLRulesPager(options *ListNetworkACLRulesOptions) (pager *NetworkACLRulesPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListNetworkACLRulesOptions = *options + pager = &NetworkACLRulesPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *NetworkACLRulesPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *NetworkACLRulesPager) GetNextWithContext(ctx context.Context) (page []NetworkACLRuleItemIntf, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListNetworkACLRulesWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.Rules + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *NetworkACLRulesPager) GetAllWithContext(ctx context.Context) (allItems []NetworkACLRuleItemIntf, err error) { + for pager.HasNext() { + var nextPage []NetworkACLRuleItemIntf + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *NetworkACLRulesPager) GetNext() (page []NetworkACLRuleItemIntf, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *NetworkACLRulesPager) GetAll() (allItems []NetworkACLRuleItemIntf, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// SecurityGroupsPager can be used to simplify the use of the "ListSecurityGroups" method. +type SecurityGroupsPager struct { + hasNext bool + options *ListSecurityGroupsOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewSecurityGroupsPager returns a new SecurityGroupsPager instance. +func (vpc *VpcV1) NewSecurityGroupsPager(options *ListSecurityGroupsOptions) (pager *SecurityGroupsPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListSecurityGroupsOptions = *options + pager = &SecurityGroupsPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *SecurityGroupsPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *SecurityGroupsPager) GetNextWithContext(ctx context.Context) (page []SecurityGroup, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListSecurityGroupsWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.SecurityGroups + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *SecurityGroupsPager) GetAllWithContext(ctx context.Context) (allItems []SecurityGroup, err error) { + for pager.HasNext() { + var nextPage []SecurityGroup + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *SecurityGroupsPager) GetNext() (page []SecurityGroup, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *SecurityGroupsPager) GetAll() (allItems []SecurityGroup, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// SecurityGroupTargetsPager can be used to simplify the use of the "ListSecurityGroupTargets" method. +type SecurityGroupTargetsPager struct { + hasNext bool + options *ListSecurityGroupTargetsOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewSecurityGroupTargetsPager returns a new SecurityGroupTargetsPager instance. +func (vpc *VpcV1) NewSecurityGroupTargetsPager(options *ListSecurityGroupTargetsOptions) (pager *SecurityGroupTargetsPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListSecurityGroupTargetsOptions = *options + pager = &SecurityGroupTargetsPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *SecurityGroupTargetsPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *SecurityGroupTargetsPager) GetNextWithContext(ctx context.Context) (page []SecurityGroupTargetReferenceIntf, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListSecurityGroupTargetsWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.Targets + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *SecurityGroupTargetsPager) GetAllWithContext(ctx context.Context) (allItems []SecurityGroupTargetReferenceIntf, err error) { + for pager.HasNext() { + var nextPage []SecurityGroupTargetReferenceIntf + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *SecurityGroupTargetsPager) GetNext() (page []SecurityGroupTargetReferenceIntf, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *SecurityGroupTargetsPager) GetAll() (allItems []SecurityGroupTargetReferenceIntf, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// IkePoliciesPager can be used to simplify the use of the "ListIkePolicies" method. +type IkePoliciesPager struct { + hasNext bool + options *ListIkePoliciesOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewIkePoliciesPager returns a new IkePoliciesPager instance. +func (vpc *VpcV1) NewIkePoliciesPager(options *ListIkePoliciesOptions) (pager *IkePoliciesPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListIkePoliciesOptions = *options + pager = &IkePoliciesPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *IkePoliciesPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *IkePoliciesPager) GetNextWithContext(ctx context.Context) (page []IkePolicy, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListIkePoliciesWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.IkePolicies + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *IkePoliciesPager) GetAllWithContext(ctx context.Context) (allItems []IkePolicy, err error) { + for pager.HasNext() { + var nextPage []IkePolicy + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *IkePoliciesPager) GetNext() (page []IkePolicy, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *IkePoliciesPager) GetAll() (allItems []IkePolicy, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// IpsecPoliciesPager can be used to simplify the use of the "ListIpsecPolicies" method. +type IpsecPoliciesPager struct { + hasNext bool + options *ListIpsecPoliciesOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewIpsecPoliciesPager returns a new IpsecPoliciesPager instance. +func (vpc *VpcV1) NewIpsecPoliciesPager(options *ListIpsecPoliciesOptions) (pager *IpsecPoliciesPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListIpsecPoliciesOptions = *options + pager = &IpsecPoliciesPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *IpsecPoliciesPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *IpsecPoliciesPager) GetNextWithContext(ctx context.Context) (page []IPsecPolicy, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListIpsecPoliciesWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.IpsecPolicies + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *IpsecPoliciesPager) GetAllWithContext(ctx context.Context) (allItems []IPsecPolicy, err error) { + for pager.HasNext() { + var nextPage []IPsecPolicy + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *IpsecPoliciesPager) GetNext() (page []IPsecPolicy, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *IpsecPoliciesPager) GetAll() (allItems []IPsecPolicy, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// VPNGatewaysPager can be used to simplify the use of the "ListVPNGateways" method. +type VPNGatewaysPager struct { + hasNext bool + options *ListVPNGatewaysOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewVPNGatewaysPager returns a new VPNGatewaysPager instance. +func (vpc *VpcV1) NewVPNGatewaysPager(options *ListVPNGatewaysOptions) (pager *VPNGatewaysPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListVPNGatewaysOptions = *options + pager = &VPNGatewaysPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *VPNGatewaysPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *VPNGatewaysPager) GetNextWithContext(ctx context.Context) (page []VPNGatewayIntf, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListVPNGatewaysWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.VPNGateways + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *VPNGatewaysPager) GetAllWithContext(ctx context.Context) (allItems []VPNGatewayIntf, err error) { + for pager.HasNext() { + var nextPage []VPNGatewayIntf + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *VPNGatewaysPager) GetNext() (page []VPNGatewayIntf, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *VPNGatewaysPager) GetAll() (allItems []VPNGatewayIntf, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// VPNServersPager can be used to simplify the use of the "ListVPNServers" method. +type VPNServersPager struct { + hasNext bool + options *ListVPNServersOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewVPNServersPager returns a new VPNServersPager instance. +func (vpc *VpcV1) NewVPNServersPager(options *ListVPNServersOptions) (pager *VPNServersPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListVPNServersOptions = *options + pager = &VPNServersPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *VPNServersPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *VPNServersPager) GetNextWithContext(ctx context.Context) (page []VPNServer, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListVPNServersWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.VPNServers + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *VPNServersPager) GetAllWithContext(ctx context.Context) (allItems []VPNServer, err error) { + for pager.HasNext() { + var nextPage []VPNServer + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *VPNServersPager) GetNext() (page []VPNServer, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *VPNServersPager) GetAll() (allItems []VPNServer, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// VPNServerClientsPager can be used to simplify the use of the "ListVPNServerClients" method. +type VPNServerClientsPager struct { + hasNext bool + options *ListVPNServerClientsOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewVPNServerClientsPager returns a new VPNServerClientsPager instance. +func (vpc *VpcV1) NewVPNServerClientsPager(options *ListVPNServerClientsOptions) (pager *VPNServerClientsPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListVPNServerClientsOptions = *options + pager = &VPNServerClientsPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *VPNServerClientsPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *VPNServerClientsPager) GetNextWithContext(ctx context.Context) (page []VPNServerClient, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListVPNServerClientsWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.Clients + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *VPNServerClientsPager) GetAllWithContext(ctx context.Context) (allItems []VPNServerClient, err error) { + for pager.HasNext() { + var nextPage []VPNServerClient + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *VPNServerClientsPager) GetNext() (page []VPNServerClient, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *VPNServerClientsPager) GetAll() (allItems []VPNServerClient, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// VPNServerRoutesPager can be used to simplify the use of the "ListVPNServerRoutes" method. +type VPNServerRoutesPager struct { + hasNext bool + options *ListVPNServerRoutesOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewVPNServerRoutesPager returns a new VPNServerRoutesPager instance. +func (vpc *VpcV1) NewVPNServerRoutesPager(options *ListVPNServerRoutesOptions) (pager *VPNServerRoutesPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListVPNServerRoutesOptions = *options + pager = &VPNServerRoutesPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *VPNServerRoutesPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *VPNServerRoutesPager) GetNextWithContext(ctx context.Context) (page []VPNServerRoute, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListVPNServerRoutesWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.Routes + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *VPNServerRoutesPager) GetAllWithContext(ctx context.Context) (allItems []VPNServerRoute, err error) { + for pager.HasNext() { + var nextPage []VPNServerRoute + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *VPNServerRoutesPager) GetNext() (page []VPNServerRoute, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *VPNServerRoutesPager) GetAll() (allItems []VPNServerRoute, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// LoadBalancerProfilesPager can be used to simplify the use of the "ListLoadBalancerProfiles" method. +type LoadBalancerProfilesPager struct { + hasNext bool + options *ListLoadBalancerProfilesOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewLoadBalancerProfilesPager returns a new LoadBalancerProfilesPager instance. +func (vpc *VpcV1) NewLoadBalancerProfilesPager(options *ListLoadBalancerProfilesOptions) (pager *LoadBalancerProfilesPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListLoadBalancerProfilesOptions = *options + pager = &LoadBalancerProfilesPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *LoadBalancerProfilesPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *LoadBalancerProfilesPager) GetNextWithContext(ctx context.Context) (page []LoadBalancerProfile, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListLoadBalancerProfilesWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.Profiles + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *LoadBalancerProfilesPager) GetAllWithContext(ctx context.Context) (allItems []LoadBalancerProfile, err error) { + for pager.HasNext() { + var nextPage []LoadBalancerProfile + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *LoadBalancerProfilesPager) GetNext() (page []LoadBalancerProfile, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *LoadBalancerProfilesPager) GetAll() (allItems []LoadBalancerProfile, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// LoadBalancersPager can be used to simplify the use of the "ListLoadBalancers" method. +type LoadBalancersPager struct { + hasNext bool + options *ListLoadBalancersOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewLoadBalancersPager returns a new LoadBalancersPager instance. +func (vpc *VpcV1) NewLoadBalancersPager(options *ListLoadBalancersOptions) (pager *LoadBalancersPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListLoadBalancersOptions = *options + pager = &LoadBalancersPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *LoadBalancersPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *LoadBalancersPager) GetNextWithContext(ctx context.Context) (page []LoadBalancer, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListLoadBalancersWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.LoadBalancers + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *LoadBalancersPager) GetAllWithContext(ctx context.Context) (allItems []LoadBalancer, err error) { + for pager.HasNext() { + var nextPage []LoadBalancer + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *LoadBalancersPager) GetNext() (page []LoadBalancer, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *LoadBalancersPager) GetAll() (allItems []LoadBalancer, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// EndpointGatewaysPager can be used to simplify the use of the "ListEndpointGateways" method. +type EndpointGatewaysPager struct { + hasNext bool + options *ListEndpointGatewaysOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewEndpointGatewaysPager returns a new EndpointGatewaysPager instance. +func (vpc *VpcV1) NewEndpointGatewaysPager(options *ListEndpointGatewaysOptions) (pager *EndpointGatewaysPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListEndpointGatewaysOptions = *options + pager = &EndpointGatewaysPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *EndpointGatewaysPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *EndpointGatewaysPager) GetNextWithContext(ctx context.Context) (page []EndpointGateway, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListEndpointGatewaysWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.EndpointGateways + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *EndpointGatewaysPager) GetAllWithContext(ctx context.Context) (allItems []EndpointGateway, err error) { + for pager.HasNext() { + var nextPage []EndpointGateway + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *EndpointGatewaysPager) GetNext() (page []EndpointGateway, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *EndpointGatewaysPager) GetAll() (allItems []EndpointGateway, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// EndpointGatewayIpsPager can be used to simplify the use of the "ListEndpointGatewayIps" method. +type EndpointGatewayIpsPager struct { + hasNext bool + options *ListEndpointGatewayIpsOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewEndpointGatewayIpsPager returns a new EndpointGatewayIpsPager instance. +func (vpc *VpcV1) NewEndpointGatewayIpsPager(options *ListEndpointGatewayIpsOptions) (pager *EndpointGatewayIpsPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListEndpointGatewayIpsOptions = *options + pager = &EndpointGatewayIpsPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *EndpointGatewayIpsPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *EndpointGatewayIpsPager) GetNextWithContext(ctx context.Context) (page []ReservedIP, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListEndpointGatewayIpsWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.Ips + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *EndpointGatewayIpsPager) GetAllWithContext(ctx context.Context) (allItems []ReservedIP, err error) { + for pager.HasNext() { + var nextPage []ReservedIP + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *EndpointGatewayIpsPager) GetNext() (page []ReservedIP, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *EndpointGatewayIpsPager) GetAll() (allItems []ReservedIP, err error) { + return pager.GetAllWithContext(context.Background()) +} + +// FlowLogCollectorsPager can be used to simplify the use of the "ListFlowLogCollectors" method. +type FlowLogCollectorsPager struct { + hasNext bool + options *ListFlowLogCollectorsOptions + client *VpcV1 + pageContext struct { + next *string + } +} + +// NewFlowLogCollectorsPager returns a new FlowLogCollectorsPager instance. +func (vpc *VpcV1) NewFlowLogCollectorsPager(options *ListFlowLogCollectorsOptions) (pager *FlowLogCollectorsPager, err error) { + if options.Start != nil && *options.Start != "" { + err = fmt.Errorf("the 'options.Start' field should not be set") + return + } + + var optionsCopy ListFlowLogCollectorsOptions = *options + pager = &FlowLogCollectorsPager{ + hasNext: true, + options: &optionsCopy, + client: vpc, + } + return +} + +// HasNext returns true if there are potentially more results to be retrieved. +func (pager *FlowLogCollectorsPager) HasNext() bool { + return pager.hasNext +} + +// GetNextWithContext returns the next page of results using the specified Context. +func (pager *FlowLogCollectorsPager) GetNextWithContext(ctx context.Context) (page []FlowLogCollector, err error) { + if !pager.HasNext() { + return nil, fmt.Errorf("no more results available") + } + + pager.options.Start = pager.pageContext.next + + result, _, err := pager.client.ListFlowLogCollectorsWithContext(ctx, pager.options) + if err != nil { + return + } + + var next *string + if result.Next != nil { + var start *string + start, err = core.GetQueryParam(result.Next.Href, "start") + if err != nil { + err = fmt.Errorf("error retrieving 'start' query parameter from URL '%s': %s", *result.Next.Href, err.Error()) + return + } + next = start + } + pager.pageContext.next = next + pager.hasNext = (pager.pageContext.next != nil) + page = result.FlowLogCollectors + + return +} + +// GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly +// until all pages of results have been retrieved. +func (pager *FlowLogCollectorsPager) GetAllWithContext(ctx context.Context) (allItems []FlowLogCollector, err error) { + for pager.HasNext() { + var nextPage []FlowLogCollector + nextPage, err = pager.GetNextWithContext(ctx) + if err != nil { + return + } + allItems = append(allItems, nextPage...) + } + return +} + +// GetNext invokes GetNextWithContext() using context.Background() as the Context parameter. +func (pager *FlowLogCollectorsPager) GetNext() (page []FlowLogCollector, err error) { + return pager.GetNextWithContext(context.Background()) +} + +// GetAll invokes GetAllWithContext() using context.Background() as the Context parameter. +func (pager *FlowLogCollectorsPager) GetAll() (allItems []FlowLogCollector, err error) { + return pager.GetAllWithContext(context.Background()) +} diff --git a/examples/ibm-atracker/README.md b/examples/ibm-atracker/README.md index eb76c6ceb2..c7ac19e610 100644 --- a/examples/ibm-atracker/README.md +++ b/examples/ibm-atracker/README.md @@ -2,7 +2,7 @@ This example illustrates how to use the AtrackerV2 -These types of resources are supported: +The following types of resources are supported: * Activity Tracker Target * Activity Tracker Route @@ -10,7 +10,7 @@ These types of resources are supported: ## Usage -To run this example you need to execute: +To run this example, execute the following commands: ```bash $ terraform init @@ -29,7 +29,10 @@ atracker_target resource: resource "atracker_target" "atracker_target_instance" { name = var.atracker_target_name target_type = var.atracker_target_target_type + region = var.atracker_target_region cos_endpoint = var.atracker_target_cos_endpoint + logdna_endpoint = var.atracker_target_logdna_endpoint + eventstreams_endpoint = var.atracker_target_eventstreams_endpoint } ``` atracker_route resource: @@ -37,7 +40,6 @@ atracker_route resource: ```hcl resource "atracker_route" "atracker_route_instance" { name = var.atracker_route_name - receive_global_events = var.atracker_route_receive_global_events rules = var.atracker_route_rules } ``` @@ -98,9 +100,15 @@ data "atracker_routes" "atracker_routes_instance" { | name | The name of the target. The name must be 1000 characters or less, and cannot include any special characters other than `(space) - . _ :`. | `string` | true | | target_type | The type of the target. | `string` | true | | cos_endpoint | Property values for a Cloud Object Storage Endpoint. | `` | true | +| eventstreams_endpoint | Property values for the Event Streams Endpoint in responses. | `` | false | | name | The name of the route. The name must be 1000 characters or less and cannot include any special characters other than `(space) - . _ :`. | `string` | true | -| receive_global_events | Indicates whether or not all global events should be forwarded to this region. | `bool` | true | -| rules | Routing rules that will be evaluated in their order of the array. | `list()` | true | +| rules | The routing rules that will be evaluated in their order of the array. Once a rule is matched, the remaining rules in the route definition will be skipped. | `list()` | true | +| default_targets | The target ID List. In the event that no routing rule causes the event to be sent to a target, these targets will receive the event. | `list(string)` | false | +| permitted_target_regions | If present then only these regions may be used to define a target. | `list(string)` | false | +| metadata_region_primary | To store all your meta data in a single region. | `string` | true | +| metadata_region_backup | To store all your meta data in a backup region. | `string` | false | +| private_api_endpoint_only | If you set this true then you cannot access api through public network. | `bool` | true | +| region | Limit the query to the specified region. | `string` | false | | name | The name of the target resource. | `string` | false | | name | The name of the route. | `string` | false | diff --git a/examples/ibm-atracker/main.tf b/examples/ibm-atracker/main.tf index a44f4cec1d..c6d6787889 100644 --- a/examples/ibm-atracker/main.tf +++ b/examples/ibm-atracker/main.tf @@ -41,8 +41,10 @@ resource "ibm_atracker_target" atracker_target_eventstreams_instance { // Provision atracker_route resource instance resource "ibm_atracker_route" "atracker_route_instance" { name = var.atracker_route_name - receive_global_events = var.atracker_route_receive_global_events - rules = var.atracker_route_rules + rules { + target_ids = [ ibm_atracker_target.atracker_target_instance.id ] + locations = [ "us-south" ] + } } // Provision atracker_settings resource instance diff --git a/examples/ibm-atracker/variables.tf b/examples/ibm-atracker/variables.tf index 09adc4bc0b..911bcfee60 100644 --- a/examples/ibm-atracker/variables.tf +++ b/examples/ibm-atracker/variables.tf @@ -15,6 +15,12 @@ variable "atracker_target_target_type" { default = "cloud_object_storage" } +variable "atracker_target_region" { + description = "Included this optional field if you used it to create a target in a different region other than the one you are connected." + type = string + default = "us-south" +} + // Resource arguments for atracker_route variable "atracker_route_name" { description = "The name of the route. The name must be 1000 characters or less and cannot include any special characters other than `(space) - . _ :`." @@ -66,5 +72,4 @@ variable "atracker_settings_permitted_target_regions" { type = list(string) default = [ "us-south" ] } - // Data source arguments for atracker_endpoints diff --git a/examples/ibm-atracker/versions.tf b/examples/ibm-atracker/versions.tf index ee0f9705a2..4049a00043 100644 --- a/examples/ibm-atracker/versions.tf +++ b/examples/ibm-atracker/versions.tf @@ -1,3 +1,9 @@ terraform { - required_version = ">= 0.12" + required_version = ">= 1.0" + required_providers { + ibm = { + source = "IBM-Cloud/ibm" + version = "1.52.0-beta0" + } + } } \ No newline at end of file diff --git a/examples/ibm-cos-bucket/main.tf b/examples/ibm-cos-bucket/main.tf index 5fd73492d8..7d9a1390d7 100644 --- a/examples/ibm-cos-bucket/main.tf +++ b/examples/ibm-cos-bucket/main.tf @@ -410,6 +410,11 @@ resource "ibm_cos_bucket" "cos_bucket_website_configuration" { storage_class = var.standard_storage_class } + +data "ibm_iam_access_group" "public_access_group" { + access_group_name = "Public Access" +} + # Give public access to above mentioned bucket resource "ibm_iam_access_group_policy" "policy" { depends_on = [ibm_cos_bucket.cos_bucket_website_configuration] @@ -419,8 +424,8 @@ resource "ibm_iam_access_group_policy" "policy" { resources { service = "cloud-object-storage" resource_type = "bucket" - resource_instance_id = "COS instance guid" - resource = data.ibm_cos_bucket.cos_bucket_website_configuration.bucket_name + resource_instance_id = "COS instance guid" # eg : 94xxxxxx-3xxx-4xxx-8xxx-7xxxxxxxxx7 + resource = ibm_cos_bucket.cos_bucket_website_configuration.bucket_name } } diff --git a/examples/ibm-is-ng/main.tf b/examples/ibm-is-ng/main.tf index 3a7d3eb2dc..b4ce696697 100644 --- a/examples/ibm-is-ng/main.tf +++ b/examples/ibm-is-ng/main.tf @@ -1258,6 +1258,111 @@ data "ibm_is_share" "is_share" { data "ibm_is_shares" "is_shares" { } +// vpc dns resolution bindings + + // list all dns resolution bindings on a vpc +data "ibm_is_vpc_dns_resolution_bindings" "is_vpc_dns_resolution_bindings" { + vpc_id = ibm_is_vpc.vpc1.id +} + // get a dns resolution bindings on a vpc +data "ibm_is_vpc_dns_resolution_binding" "is_vpc_dns_resolution_binding" { + vpc_id = ibm_is_vpc.vpc1.id + id = ibm_is_vpc.vpc2.id +} +data "ibm_resource_group" "rg" { + is_default = true +} + // creating a hub enabled vpc, hub disabled vpc, creating custom resolvers for both then + // delegating the vpc by uncommenting the configuration in hub_false_delegated vpc +resource ibm_is_vpc hub_true { + name = "${var.name}-vpc-hub-true" + dns { + enable_hub = true + } +} + +resource ibm_is_vpc hub_false_delegated { + name = "${var.name}-vpc-hub-false-del" + dns { + enable_hub = false + # resolver { + # type = "delegated" + # vpc_id = ibm_is_vpc.hub_true.id + # } + } +} + +resource "ibm_is_subnet" "hub_true_sub1" { + name = "hub-true-subnet1" + vpc = ibm_is_vpc.hub_true.id + zone = "${var.region}-2" + total_ipv4_address_count = 16 +} +resource "ibm_is_subnet" "hub_true_sub2" { + name = "hub-true-subnet2" + vpc = ibm_is_vpc.hub_true.id + zone = "${var.region}-2" + total_ipv4_address_count = 16 +} +resource "ibm_is_subnet" "hub_false_delegated_sub1" { + name = "hub-false-delegated-subnet1" + vpc = ibm_is_vpc.hub_false_delegated.id + zone = "${var.region}-2" + total_ipv4_address_count = 16 +} +resource "ibm_is_subnet" "hub_false_delegated_sub2" { + name = "hub-false-delegated-subnet2" + vpc = ibm_is_vpc.hub_false_delegated.id + zone = "${var.region}-2" + total_ipv4_address_count = 16 +} +resource "ibm_resource_instance" "dns-cr-instance" { + name = "dns-cr-instance" + resource_group_id = data.ibm_resource_group.rg.id + location = "global" + service = "dns-svcs" + plan = "standard-dns" +} +resource "ibm_dns_custom_resolver" "test_hub_true" { + name = "test-hub-true-customresolver" + instance_id = ibm_resource_instance.dns-cr-instance.guid + description = "new test CR - TF" + high_availability = true + enabled = true + locations { + subnet_crn = ibm_is_subnet.hub_true_sub1.crn + enabled = true + } + locations { + subnet_crn = ibm_is_subnet.hub_true_sub2.crn + enabled = true + } +} +resource "ibm_dns_custom_resolver" "test_hub_false_delegated" { + name = "test-hub-false-customresolver" + instance_id = ibm_resource_instance.dns-cr-instance.guid + description = "new test CR - TF" + high_availability = true + enabled = true + locations { + subnet_crn = ibm_is_subnet.hub_false_delegated_sub1.crn + enabled = true + } + locations { + subnet_crn = ibm_is_subnet.hub_false_delegated_sub2.crn + enabled = true + } +} + +resource ibm_is_vpc_dns_resolution_binding dnstrue { + name = "hub-spoke-binding" + vpc_id = ibm_is_vpc.hub_false_delegated.id + vpc { + id = ibm_is_vpc.hub_true.id + } +} + + // snapshot cross region provider "ibm" { diff --git a/examples/ibm-metrics-router/README.md b/examples/ibm-metrics-router/README.md index 7ce765722f..0fd3a4be07 100644 --- a/examples/ibm-metrics-router/README.md +++ b/examples/ibm-metrics-router/README.md @@ -1,4 +1,4 @@ -# Example for IBM Cloud Metrics Routing V3 Example +# Example for IBM Cloud Metrics Routing This example illustrates how to use the MetricsRouterV3 diff --git a/examples/ibm-metrics-router/variables.tf b/examples/ibm-metrics-router/variables.tf index 6e83960b08..7f172313fb 100644 --- a/examples/ibm-metrics-router/variables.tf +++ b/examples/ibm-metrics-router/variables.tf @@ -10,7 +10,7 @@ variable "metrics_router_target_name" { default = "my-mr-target" } variable "metrics_router_target_destination_crn" { - description = "The CRN of a destination service instance or resource." + description = "The CRN of a destination service instance or resource. Ensure you have a service authorization between IBM Cloud Metrics Routing and your Cloud resource. Read [S2S authorization](https://cloud.ibm.com/docs/metrics-router?topic=metrics-router-target-monitoring&interface=ui#target-monitoring-ui) for details." type = string default = "crn:v1:bluemix:public:sysdig-monitor:us-south:a/0be5ad401ae913d8ff665d92680664ed:22222222-2222-2222-2222-222222222222::" } diff --git a/examples/ibm-scc/control_library/main.tf b/examples/ibm-scc/control_library/main.tf index cfcf5419e6..89731d8ebb 100644 --- a/examples/ibm-scc/control_library/main.tf +++ b/examples/ibm-scc/control_library/main.tf @@ -1,4 +1,5 @@ resource "ibm_scc_control_library" "scc_demo_control_library" { + instance_id = "00000000-1111-2222-3333-444444444444" control_library_name = var.scc_control_library_name control_library_description = var.scc_control_library_description control_library_type = "custom" diff --git a/examples/ibm-scc/integration/main.tf b/examples/ibm-scc/integration/main.tf index 178cfd6c2b..74da718d92 100644 --- a/examples/ibm-scc/integration/main.tf +++ b/examples/ibm-scc/integration/main.tf @@ -1,4 +1,5 @@ resource "ibm_scc_provider_type_instance" "scc_provider_type_instance_instance" { + instance_id = "00000000-1111-2222-3333-444444444444" provider_type_id = var.scc_provider_type_id name = var.scc_provider_type_instance_instance attributes = var.scc_provider_type_instance_attributes diff --git a/examples/ibm-scc/profile/main.tf b/examples/ibm-scc/profile/main.tf index d9f4dcaf8d..18d8e1fc59 100644 --- a/examples/ibm-scc/profile/main.tf +++ b/examples/ibm-scc/profile/main.tf @@ -3,6 +3,7 @@ data "ibm_scc_control_library" "scc_control_library" { } resource "ibm_scc_profile" "scc_demo_profile" { + instance_id = "00000000-1111-2222-3333-444444444444" profile_type = "custom" profile_description = var.ibm_scc_profile_description profile_name = var.ibm_scc_profile_name @@ -15,6 +16,7 @@ resource "ibm_scc_profile" "scc_demo_profile" { } resource "ibm_scc_profile_attachment" "scc_demo_profile_attachment" { + instance_id = "00000000-1111-2222-3333-444444444444" profile_id = resource.ibm_scc_profile.scc_demo_profile.id name = var.ibm_scc_profile_attachment_name description = var.ibm_scc_profile_attachment_description diff --git a/examples/ibm-scc/report/main.tf b/examples/ibm-scc/report/main.tf index c46dc8bc2d..bf0dc8138d 100644 --- a/examples/ibm-scc/report/main.tf +++ b/examples/ibm-scc/report/main.tf @@ -1,32 +1,40 @@ data "ibm_scc_latest_reports" "scc_latest_reports_instance" { + instance_id = "00000000-1111-2222-3333-444444444444" sort = "profile_name" } data "ibm_scc_report_rule" "scc_report_rule_instance" { + instance_id = "00000000-1111-2222-3333-444444444444" report_id = var.scc_report_id rule_id = var.scc_rule_id } data "ibm_scc_report_tags" "scc_report_tags_instance" { + instance_id = "00000000-1111-2222-3333-444444444444" report_id = var.scc_report_id } data "ibm_scc_report_evaluations" "scc_report_evaluations_instance" { + instance_id = "00000000-1111-2222-3333-444444444444" report_id = var.scc_report_id } data "ibm_scc_report_controls" "scc_report_controls_instance" { + instance_id = "00000000-1111-2222-3333-444444444444" report_id = var.scc_report_id } data "ibm_scc_report_summary" "scc_report_summary_instance" { + instance_id = "00000000-1111-2222-3333-444444444444" report_id = var.scc_report_id } data "ibm_scc_report_violation_drift" "scc_report_violation_drift_instance" { + instance_id = "00000000-1111-2222-3333-444444444444" report_id = var.scc_report_id } data "ibm_scc_report" "scc_report_instance" { + instance_id = "00000000-1111-2222-3333-444444444444" report_id = var.scc_report_id } diff --git a/examples/ibm-scc/rule/main.tf b/examples/ibm-scc/rule/main.tf index 41f8348c68..ba6ffc5327 100644 --- a/examples/ibm-scc/rule/main.tf +++ b/examples/ibm-scc/rule/main.tf @@ -1,5 +1,6 @@ // Provision scc_rule resource instance resource "ibm_scc_rule" "scc_rule_tf_demo" { + instance_id = "00000000-1111-2222-3333-444444444444" description = var.scc_description target { service_name = "cloud-object-storage" diff --git a/examples/ibm-usage-reports/README.md b/examples/ibm-usage-reports/README.md new file mode 100644 index 0000000000..d588bda6dd --- /dev/null +++ b/examples/ibm-usage-reports/README.md @@ -0,0 +1,93 @@ +# Example for UsageReportsV4 + +This example illustrates how to use the UsageReportsV4 + +The following types of resources are supported: + +* billing_report_snapshot + +## Usage + +To run this example, execute the following commands: + +```bash +$ terraform init +$ terraform plan +$ terraform apply +``` + +Run `terraform destroy` when you don't need these resources. + + +## UsageReportsV4 resources + +billing_report_snapshot resource: + +```hcl +resource "billing_report_snapshot" "billing_report_snapshot_instance" { + account_id = var.billing_report_snapshot_account_id + interval = var.billing_report_snapshot_interval + versioning = var.billing_report_snapshot_versioning + report_types = var.billing_report_snapshot_report_types + cos_reports_folder = var.billing_report_snapshot_cos_reports_folder + cos_bucket = var.billing_report_snapshot_cos_bucket + cos_location = var.billing_report_snapshot_cos_location +} +``` + +## UsageReportsV4 data sources + +billing_snapshot_list data source: + +```hcl +data "billing_snapshot_list" "billing_snapshot_list_instance" { + account_id = var.billing_snapshot_list_account_id + month = var.billing_snapshot_list_month + date_from = var.billing_snapshot_list_date_from + date_to = var.billing_snapshot_list_date_to +} +``` + +## Assumptions + +1. TODO + +## Notes + +1. TODO + +## Requirements + +| Name | Version | +|------|---------| +| terraform | ~> 0.12 | + +## Providers + +| Name | Version | +|------|---------| +| ibm | 1.13.1 | + +## Inputs + +| Name | Description | Type | Required | +|------|-------------|------|---------| +| ibmcloud\_api\_key | IBM Cloud API key | `string` | true | +| account_id | Account ID for which billing report snapshot is configured. | `string` | true | +| interval | Frequency of taking the snapshot of the billing reports. | `string` | true | +| versioning | A new version of report is created or the existing report version is overwritten with every update. | `string` | false | +| report_types | The type of billing reports to take snapshot of. Possible values are [account_summary, enterprise_summary, account_resource_instance_usage]. | `list(string)` | false | +| cos_reports_folder | The billing reports root folder to store the billing reports snapshots. Defaults to "IBMCloud-Billing-Reports". | `string` | false | +| cos_bucket | The name of the COS bucket to store the snapshot of the billing reports. | `string` | true | +| cos_location | Region of the COS instance. | `string` | true | +| account_id | Account ID for which the billing report snapshot is requested. | `string` | true | +| month | The month for which billing report snapshot is requested. Format is yyyy-mm. | `string` | true | +| date_from | Timestamp in milliseconds for which billing report snapshot is requested. | `number` | false | +| date_to | Timestamp in milliseconds for which billing report snapshot is requested. | `number` | false | + +## Outputs + +| Name | Description | +|------|-------------| +| billing_report_snapshot | billing_report_snapshot object | +| billing_snapshot_list | billing_snapshot_list object | diff --git a/examples/ibm-usage-reports/main.tf b/examples/ibm-usage-reports/main.tf new file mode 100644 index 0000000000..3eb1c866da --- /dev/null +++ b/examples/ibm-usage-reports/main.tf @@ -0,0 +1,20 @@ +provider "ibm" { + ibmcloud_api_key = var.ibmcloud_api_key +} + +// Provision billing_report_snapshot resource instance +resource "ibm_billing_report_snapshot" "billing_report_snapshot_instance" { + interval = var.billing_report_snapshot_interval + versioning = var.billing_report_snapshot_versioning + report_types = var.billing_report_snapshot_report_types + cos_reports_folder = var.billing_report_snapshot_cos_reports_folder + cos_bucket = var.billing_report_snapshot_cos_bucket + cos_location = var.billing_report_snapshot_cos_location +} + +// Create billing_snapshot_list data source +data "ibm_billing_snapshot_list" "billing_snapshot_list_instance" { + month = var.billing_snapshot_list_month + date_from = var.billing_snapshot_list_date_from + date_to = var.billing_snapshot_list_date_to +} diff --git a/examples/ibm-usage-reports/outputs.tf b/examples/ibm-usage-reports/outputs.tf new file mode 100644 index 0000000000..5c12aed70b --- /dev/null +++ b/examples/ibm-usage-reports/outputs.tf @@ -0,0 +1,6 @@ +// This output allows billing_report_snapshot data to be referenced by other resources and the terraform CLI +// Modify this output if only certain data should be exposed +output "ibm_billing_report_snapshot" { + value = ibm_billing_report_snapshot.billing_report_snapshot_instance + description = "billing_report_snapshot resource instance" +} diff --git a/examples/ibm-usage-reports/variables.tf b/examples/ibm-usage-reports/variables.tf new file mode 100644 index 0000000000..d8c62e6b2f --- /dev/null +++ b/examples/ibm-usage-reports/variables.tf @@ -0,0 +1,58 @@ +variable "ibmcloud_api_key" { + description = "IBM Cloud API key" + type = string +} + +// Resource arguments for billing_report_snapshot +variable "billing_report_snapshot_interval" { + description = "Frequency of taking the snapshot of the billing reports." + type = string + default = "daily" +} +variable "billing_report_snapshot_versioning" { + description = "A new version of report is created or the existing report version is overwritten with every update." + type = string + default = "new" +} +variable "billing_report_snapshot_report_types" { + description = "The type of billing reports to take snapshot of. Possible values are [account_summary, enterprise_summary, account_resource_instance_usage]." + type = list(string) + default = ["account_summary","enterprise_summary","account_resource_instance_usage"] +} +variable "billing_report_snapshot_cos_reports_folder" { + description = "The billing reports root folder to store the billing reports snapshots. Defaults to \"IBMCloud-Billing-Reports\"." + type = string + default = "IBMCloud-Billing-Reports" +} +variable "billing_report_snapshot_cos_bucket" { + description = "The name of the COS bucket to store the snapshot of the billing reports." + type = string + default = "bucket_name" +} +variable "billing_report_snapshot_cos_location" { + description = "Region of the COS instance." + type = string + default = "us-south" +} + +// Data source arguments for billing_snapshot_list +variable "billing_snapshot_list_account_id" { + description = "Account ID for which the billing report snapshot is requested." + type = string + default = "abc" +} +variable "billing_snapshot_list_month" { + description = "The month for which billing report snapshot is requested. Format is yyyy-mm." + type = string + default = "2023-02" +} +variable "billing_snapshot_list_date_from" { + description = "Timestamp in milliseconds for which billing report snapshot is requested." + type = number + default = 1675209600000 +} +variable "billing_snapshot_list_date_to" { + description = "Timestamp in milliseconds for which billing report snapshot is requested." + type = number + default = 1675987200000 +} diff --git a/examples/ibm-usage-reports/versions.tf b/examples/ibm-usage-reports/versions.tf new file mode 100644 index 0000000000..54c9d03e8d --- /dev/null +++ b/examples/ibm-usage-reports/versions.tf @@ -0,0 +1,9 @@ +terraform { + required_version = ">= 1.0" + required_providers { + ibm = { + source = "IBM-Cloud/ibm" + version = "1.52.0-beta0" + } + } +} diff --git a/go.mod b/go.mod index 8c76a02e6f..5816c2db68 100644 --- a/go.mod +++ b/go.mod @@ -3,7 +3,7 @@ module github.com/IBM-Cloud/terraform-provider-ibm go 1.18 require ( - github.com/IBM-Cloud/bluemix-go v0.0.0-20230601050310-eecebfbff63e + github.com/IBM-Cloud/bluemix-go v0.0.0-20230927110736-d84df0f30e60 github.com/IBM-Cloud/container-services-go-sdk v0.0.0-20230822142550-30562e113de9 github.com/IBM-Cloud/power-go-client v1.2.4 github.com/IBM/apigateway-go-sdk v0.0.0-20210714141226-a5d5d49caaca @@ -13,7 +13,7 @@ require ( github.com/IBM/cloudant-go-sdk v0.0.43 github.com/IBM/code-engine-go-sdk v0.0.0-20230606173928-4863db061918 github.com/IBM/container-registry-go-sdk v1.1.0 - github.com/IBM/continuous-delivery-go-sdk v1.1.2 + github.com/IBM/continuous-delivery-go-sdk v1.2.0 github.com/IBM/event-notifications-go-admin-sdk v0.2.4 github.com/IBM/eventstreams-go-sdk v1.2.0 github.com/IBM/go-sdk-core/v3 v3.2.4 @@ -24,14 +24,14 @@ require ( github.com/IBM/ibm-hpcs-uko-sdk v0.0.20-beta github.com/IBM/keyprotect-go-client v0.12.2 github.com/IBM/networking-go-sdk v0.42.2 + github.com/IBM/platform-services-go-sdk v0.50.4 github.com/IBM/project-go-sdk v0.0.10 - github.com/IBM/platform-services-go-sdk v0.48.1 github.com/IBM/push-notifications-go-sdk v0.0.0-20210310100607-5790b96c47f5 - github.com/IBM/scc-go-sdk/v5 v5.0.2 + github.com/IBM/scc-go-sdk/v5 v5.1.2 github.com/IBM/schematics-go-sdk v0.2.1 - github.com/IBM/secrets-manager-go-sdk/v2 v2.0.0 + github.com/IBM/secrets-manager-go-sdk/v2 v2.0.1 github.com/IBM/vpc-beta-go-sdk v0.6.0 - github.com/IBM/vpc-go-sdk v0.41.0 + github.com/IBM/vpc-go-sdk v0.42.0 github.com/ScaleFT/sshkeys v0.0.0-20200327173127-6142f742bca5 github.com/Shopify/sarama v1.29.1 github.com/akamai/AkamaiOPEN-edgegrid-golang v1.2.2 @@ -54,7 +54,7 @@ require ( github.com/pkg/errors v0.9.1 github.com/rook/rook v1.11.4 github.com/softlayer/softlayer-go v1.0.3 - golang.org/x/crypto v0.7.0 + golang.org/x/crypto v0.14.0 gopkg.in/yaml.v3 v3.0.1 gotest.tools v2.2.0+incompatible k8s.io/api v0.26.3 @@ -63,18 +63,13 @@ require ( ) require ( - github.com/IBM/go-sdk-core/v3 v3.2.4 - github.com/IBM/project-go-sdk v0.0.10 - github.com/akamai/AkamaiOPEN-edgegrid-golang v1.2.2 - github.com/akamai/AkamaiOPEN-edgegrid-golang/v5 v5.0.0 - github.com/pkg/errors v0.9.1 - github.com/rook/rook v1.11.4 - gopkg.in/yaml.v3 v3.0.1 k8s.io/utils v0.0.0-20230313181309-38a27ef9d749 sigs.k8s.io/controller-runtime v0.14.1 ) require ( + cloud.google.com/go/kms v1.10.1 // indirect + cloud.google.com/go/monitoring v1.13.0 // indirect github.com/Logicalis/asn1 v0.0.0-20190312173541-d60463189a56 // indirect github.com/PromonLogicalis/asn1 v0.0.0-20190312173541-d60463189a56 // indirect github.com/agext/levenshtein v1.2.2 // indirect @@ -97,10 +92,11 @@ require ( github.com/eapache/queue v1.1.0 // indirect github.com/emicklei/go-restful/v3 v3.10.0 // indirect github.com/evanphx/json-patch/v5 v5.6.0 // indirect - github.com/fatih/color v1.14.1 // indirect + github.com/fatih/color v1.15.0 // indirect github.com/frankban/quicktest v1.14.3 // indirect github.com/fsnotify/fsnotify v1.6.0 // indirect - github.com/go-logr/logr v1.2.3 // indirect + github.com/go-jose/go-jose/v3 v3.0.0 // indirect + github.com/go-logr/logr v1.2.4 // indirect github.com/go-openapi/analysis v0.21.2 // indirect github.com/go-openapi/errors v0.20.3 // indirect github.com/go-openapi/jsonpointer v0.19.5 // indirect @@ -115,7 +111,7 @@ require ( github.com/go-playground/universal-translator v0.18.1 // indirect github.com/go-playground/validator/v10 v10.13.0 // indirect github.com/gogo/protobuf v1.3.2 // indirect - github.com/golang/protobuf v1.5.2 // indirect + github.com/golang/protobuf v1.5.3 // indirect github.com/golang/snappy v0.0.4 // indirect github.com/google/gnostic v0.6.9 // indirect github.com/google/go-querystring v1.1.0 // indirect @@ -127,7 +123,7 @@ require ( github.com/hashicorp/go-hclog v1.5.0 // indirect github.com/hashicorp/go-immutable-radix v1.3.1 // indirect github.com/hashicorp/go-multierror v1.1.1 // indirect - github.com/hashicorp/go-plugin v1.4.8 // indirect + github.com/hashicorp/go-plugin v1.5.0 // indirect github.com/hashicorp/go-retryablehttp v0.7.2 // indirect github.com/hashicorp/go-rootcerts v1.0.2 // indirect github.com/hashicorp/go-secure-stdlib/parseutil v0.1.7 // indirect @@ -144,10 +140,10 @@ require ( github.com/hashicorp/terraform-plugin-log v0.7.0 // indirect github.com/hashicorp/terraform-registry-address v0.0.0-20220623143253-7d51757b572c // indirect github.com/hashicorp/terraform-svchost v0.0.0-20200729002733-f050f53b9734 // indirect - github.com/hashicorp/vault v1.13.5 // indirect - github.com/hashicorp/vault/api v1.9.0 // indirect + github.com/hashicorp/vault v1.13.7 // indirect + github.com/hashicorp/vault/api v1.9.2 // indirect github.com/hashicorp/vault/api/auth/approle v0.3.0 // indirect - github.com/hashicorp/vault/sdk v0.8.1 // indirect + github.com/hashicorp/vault/sdk v0.10.0 // indirect github.com/hashicorp/yamux v0.1.1 // indirect github.com/hokaccha/go-prettyjson v0.0.0-20170213120834-e6b9231a2b1c // indirect github.com/imdario/mergo v0.3.13 // indirect @@ -160,13 +156,13 @@ require ( github.com/jmespath/go-jmespath v0.4.0 // indirect github.com/josharian/intern v1.0.0 // indirect github.com/json-iterator/go v1.1.12 // indirect - github.com/klauspost/compress v1.15.15 // indirect + github.com/klauspost/compress v1.16.5 // indirect github.com/kube-object-storage/lib-bucket-provisioner v0.0.0-20221122204822-d1a8c34382f1 // indirect github.com/leodido/go-urn v1.2.3 // indirect github.com/libopenstorage/secrets v0.0.0-20220823020833-2ecadaf59d8a // indirect github.com/mailru/easyjson v0.7.7 // indirect github.com/mattn/go-colorable v0.1.13 // indirect - github.com/mattn/go-isatty v0.0.17 // indirect + github.com/mattn/go-isatty v0.0.18 // indirect github.com/matttproud/golang_protobuf_extensions v1.0.4 // indirect github.com/mitchellh/copystructure v1.2.0 // indirect github.com/mitchellh/go-testing-interface v1.14.1 // indirect @@ -202,21 +198,20 @@ require ( github.com/zclconf/go-cty v1.11.0 // indirect go.mongodb.org/mongo-driver v1.11.6 // indirect go.uber.org/ratelimit v0.2.0 // indirect - golang.org/x/net v0.10.0 // indirect - golang.org/x/oauth2 v0.6.0 // indirect - golang.org/x/sys v0.8.0 // indirect - golang.org/x/term v0.8.0 // indirect - golang.org/x/text v0.9.0 // indirect + golang.org/x/net v0.17.0 // indirect + golang.org/x/oauth2 v0.7.0 // indirect + golang.org/x/sys v0.13.0 // indirect + golang.org/x/term v0.13.0 // indirect + golang.org/x/text v0.13.0 // indirect golang.org/x/time v0.3.0 // indirect gomodules.xyz/jsonpatch/v2 v2.2.0 // indirect google.golang.org/appengine v1.6.7 // indirect - google.golang.org/genproto v0.0.0-20230306155012-7f2fa6fef1f4 // indirect - google.golang.org/grpc v1.53.0 // indirect - google.golang.org/protobuf v1.29.1 // indirect + google.golang.org/genproto/googleapis/rpc v0.0.0-20230525234030-28d5490b6b19 // indirect + google.golang.org/grpc v1.57.0 // indirect + google.golang.org/protobuf v1.31.0 // indirect gopkg.in/go-playground/validator.v9 v9.31.0 // indirect gopkg.in/inf.v0 v0.9.1 // indirect gopkg.in/ini.v1 v1.67.0 // indirect - gopkg.in/square/go-jose.v2 v2.6.0 // indirect gopkg.in/yaml.v2 v2.4.0 // indirect k8s.io/klog/v2 v2.90.1 // indirect k8s.io/kube-openapi v0.0.0-20221110221610-a28e98eb7c70 // indirect @@ -236,3 +231,5 @@ exclude ( k8s.io/client-go v11.0.1-0.20190409021438-1a26190bd76a+incompatible k8s.io/client-go v12.0.0+incompatible ) + +replace github.com/IBM/vpc-go-sdk v0.42.0 => ./common/github.com/IBM/vpc-go-sdk diff --git a/go.sum b/go.sum index 12d71481a0..7186032ece 100644 --- a/go.sum +++ b/go.sum @@ -28,14 +28,16 @@ cloud.google.com/go/bigquery v1.4.0/go.mod h1:S8dzgnTigyfTmLBfrtrhyYhwRxG72rYxvf cloud.google.com/go/bigquery v1.5.0/go.mod h1:snEHRnqQbz117VIFhE8bmtwIDY80NLUZUMb4Nv6dBIg= cloud.google.com/go/bigquery v1.7.0/go.mod h1://okPTzCYNXSlb24MZs83e2Do+h+VXtc4gLoIoXIAPc= cloud.google.com/go/bigquery v1.8.0/go.mod h1:J5hqkt3O0uAFnINi6JXValWIb1v0goeZM77hZzJN/fQ= -cloud.google.com/go/compute v1.18.0 h1:FEigFqoDbys2cvFkZ9Fjq4gnHBP55anJ0yQyau2f9oY= +cloud.google.com/go/compute v1.19.1 h1:am86mquDUgjGNWxiGn+5PGLbmgiWXlE/yNWpIpNvuXY= cloud.google.com/go/compute/metadata v0.2.3 h1:mg4jlk7mCAj6xXp9UJ4fjI9VUI5rubuGBW5aJ7UnBMY= cloud.google.com/go/datastore v1.0.0/go.mod h1:LXYbyblFSglQ5pkeyhO+Qmw7ukd3C+pD7TKLgZqpHYE= cloud.google.com/go/datastore v1.1.0/go.mod h1:umbIZjpQpHh4hmRpGhH4tLFup+FVzqBi1b3c64qFpCk= cloud.google.com/go/firestore v1.1.0/go.mod h1:ulACoGHTpvq5r8rxGJ4ddJZBZqakUQqClKRT5SZwBmk= -cloud.google.com/go/iam v0.12.0 h1:DRtTY29b75ciH6Ov1PHb4/iat2CLCvrOm40Q0a6DFpE= -cloud.google.com/go/kms v1.9.0 h1:b0votJQa/9DSsxgHwN33/tTLA7ZHVzfWhDCrfiXijSo= -cloud.google.com/go/monitoring v1.12.0 h1:+X79DyOP/Ny23XIqSIb37AvFWSxDN15w/ktklVvPLso= +cloud.google.com/go/iam v0.13.0 h1:+CmB+K0J/33d0zSQ9SlFWUeCCEn5XJA0ZMZ3pHE9u8k= +cloud.google.com/go/kms v1.10.1 h1:7hm1bRqGCA1GBRQUrp831TwJ9TWhP+tvLuP497CQS2g= +cloud.google.com/go/kms v1.10.1/go.mod h1:rIWk/TryCkR59GMC3YtHtXeLzd634lBbKenvyySAyYI= +cloud.google.com/go/monitoring v1.13.0 h1:2qsrgXGVoRXpP7otZ14eE1I568zAa92sJSDPyOJvwjM= +cloud.google.com/go/monitoring v1.13.0/go.mod h1:k2yMBAB1H9JT/QETjNkgdCGD9bPF712XiLTVr+cBrpw= cloud.google.com/go/pubsub v1.0.1/go.mod h1:R0Gpsv3s54REJCy4fxDixWD93lHJMoZTyQ2kNxGRt3I= cloud.google.com/go/pubsub v1.1.0/go.mod h1:EwwdRX2sKPjnvnqCa270oGRyludottCI76h+R3AArQw= cloud.google.com/go/pubsub v1.2.0/go.mod h1:jhfEVHT8odbXTkndysNHCcx0awwzvfOlguIAii9o8iA= @@ -98,13 +100,11 @@ github.com/DataDog/datadog-go v2.2.0+incompatible/go.mod h1:LButxg5PwREeZtORoXG3 github.com/DataDog/datadog-go v3.2.0+incompatible h1:qSG2N4FghB1He/r2mFrWKCaL7dXCilEuNEeAn20fdD4= github.com/DataDog/datadog-go v3.2.0+incompatible/go.mod h1:LButxg5PwREeZtORoXG3tL4fMGNddJ+vMq1mwgfaqoQ= github.com/DataDog/zstd v1.4.4/go.mod h1:1jcaCB/ufaK+sKp1NBhlGmpz41jOoPQ35bpF36t7BBo= -github.com/IBM-Cloud/bluemix-go v0.0.0-20230601050310-eecebfbff63e h1:0GNM+YmWoFcq8/cih+oZAv+cdvNt8ZdFO807QbBzm1Y= -github.com/IBM-Cloud/bluemix-go v0.0.0-20230601050310-eecebfbff63e/go.mod h1:cO5KCpiop9eP/pM/5W07TprYUkv/kHtajW1FiZgE59k= +github.com/IBM-Cloud/bluemix-go v0.0.0-20230927110736-d84df0f30e60 h1:LLuBM06+x6Gy0UF0mfd04C7EdM/Ui49I2BRGFQ5/qAk= +github.com/IBM-Cloud/bluemix-go v0.0.0-20230927110736-d84df0f30e60/go.mod h1:+zqvApuiOW3LQ3rHEjCybhIdQrQCjwWkdS+3+XckpAU= github.com/IBM-Cloud/container-services-go-sdk v0.0.0-20230822142550-30562e113de9 h1:sXRzCK3Glxpyu66Tu2NjztLdT5sDwj4qly+MJKRhdWY= github.com/IBM-Cloud/container-services-go-sdk v0.0.0-20230822142550-30562e113de9/go.mod h1:xUQL9SGAjoZFd4GNjrjjtEpjpkgU7RFXRyHesbKTjiY= github.com/IBM-Cloud/ibm-cloud-cli-sdk v0.5.3/go.mod h1:RiUvKuHKTBmBApDMUQzBL14pQUGKcx/IioKQPIcRQjs= -github.com/IBM-Cloud/power-go-client v1.2.2 h1:VNlzizoG2x06c3nL1ZBILF701QcvXcu6nEH3hmEKCkw= -github.com/IBM-Cloud/power-go-client v1.2.2/go.mod h1:Qfx0fNi+9hms+xu9Z6Euhu9088ByW6C/TCMLECTRWNE= github.com/IBM-Cloud/power-go-client v1.2.4 h1:4y/ubiOXpMg3xyBryfgfsa8hae/9Dn5WLdvphoxvgsQ= github.com/IBM-Cloud/power-go-client v1.2.4/go.mod h1:0YVWoIQN5I5IvyhO/m4yxgPJqCh9QjceN2FNlVpYlOQ= github.com/IBM-Cloud/softlayer-go v1.0.5-tf h1:koUAyF9b6X78lLLruGYPSOmrfY2YcGYKOj/Ug9nbKNw= @@ -123,8 +123,8 @@ github.com/IBM/code-engine-go-sdk v0.0.0-20230606173928-4863db061918 h1:RfHezAVs github.com/IBM/code-engine-go-sdk v0.0.0-20230606173928-4863db061918/go.mod h1:IP6U/1NxgxzPeYdyiEwMaZyzelTw82JGHWl7bY78eQM= github.com/IBM/container-registry-go-sdk v1.1.0 h1:sYyknIod8R4RJZQqAheiduP6wbSTphE9Ag8ho28yXjc= github.com/IBM/container-registry-go-sdk v1.1.0/go.mod h1:4TwsCnQtVfZ4Vkapy/KPvQBKFc3VOyUZYkwRU4FTPrs= -github.com/IBM/continuous-delivery-go-sdk v1.1.2 h1:UHwwak2RVTSZGtIV+SjH0vALqSvA+Vwkd1PHAbGgGrc= -github.com/IBM/continuous-delivery-go-sdk v1.1.2/go.mod h1:A9rI1HPbccBBFgwJxXB999yXXpj1l+MnlE+rsxKtxw0= +github.com/IBM/continuous-delivery-go-sdk v1.2.0 h1:FcgB5EvVrZLUnyR4S/mBocHHo9gJ5IQkSlCa6nqmr2A= +github.com/IBM/continuous-delivery-go-sdk v1.2.0/go.mod h1:oW51tS5/MDCcEM7lUvjK1H9GFC/oKsRbyYfmvGyMGmw= github.com/IBM/event-notifications-go-admin-sdk v0.2.4 h1:WWUxwrKQxvExEK+xaAQOs6gP54LvJDPi3KatDTMfwh0= github.com/IBM/event-notifications-go-admin-sdk v0.2.4/go.mod h1:1TlGAFP47DybbovJfHtYYgSI8xpLL8Q0wao6vsAlb6c= github.com/IBM/eventstreams-go-sdk v1.2.0 h1:eP0afHArMGjwhGqvZAhhu/3EDKRch2JehpveqF1TUjs= @@ -139,6 +139,7 @@ github.com/IBM/go-sdk-core/v5 v5.7.0/go.mod h1:+YbdhrjCHC84ls4MeBp+Hj4NZCni+tDAc github.com/IBM/go-sdk-core/v5 v5.9.2/go.mod h1:YlOwV9LeuclmT/qi/LAK2AsobbAP42veV0j68/rlZsE= github.com/IBM/go-sdk-core/v5 v5.9.5/go.mod h1:YlOwV9LeuclmT/qi/LAK2AsobbAP42veV0j68/rlZsE= github.com/IBM/go-sdk-core/v5 v5.10.2/go.mod h1:WZPFasUzsKab/2mzt29xPcfruSk5js2ywAPwW4VJjdI= +github.com/IBM/go-sdk-core/v5 v5.12.1/go.mod h1:WZPFasUzsKab/2mzt29xPcfruSk5js2ywAPwW4VJjdI= github.com/IBM/go-sdk-core/v5 v5.14.1 h1:WR1r0zz+gDW++xzZjF41r9ueY4JyjS2vgZjiYs8lO3c= github.com/IBM/go-sdk-core/v5 v5.14.1/go.mod h1:MUvIr/1mgGh198ZXL+ByKz9Qs1JoEh80v/96x8jPXNY= github.com/IBM/ibm-cos-sdk-go v1.3.1/go.mod h1:YLBAYobEA8bD27P7xpMwSQeNQu6W3DNBtBComXrRzRY= @@ -155,22 +156,20 @@ github.com/IBM/keyprotect-go-client v0.12.2 h1:Cjxcqin9Pl0xz3MnxdiVd4v/eIa79xL3h github.com/IBM/keyprotect-go-client v0.12.2/go.mod h1:yr8h2noNgU8vcbs+vhqoXp3Lmv73PI0zAc6VMgFvWwM= github.com/IBM/networking-go-sdk v0.42.2 h1:caqjx4jyFHi10Vlf3skHvlL6K3YJRVstsmCBmvdyqkA= github.com/IBM/networking-go-sdk v0.42.2/go.mod h1:lTUZwtUkMANMnrLHFIgRhHrkBfwASY/Iho1fabaPHxo= -github.com/IBM/platform-services-go-sdk v0.48.1 h1:TT+v28xaaFDolswhFLc+2ut6KXukoNyJGhlhuJupV7g= -github.com/IBM/platform-services-go-sdk v0.48.1/go.mod h1:6LxcUhIaSLP4SuQJXF9oLXBamSQogs5D9BcVwr4hmfU= +github.com/IBM/platform-services-go-sdk v0.50.4 h1:YQcdFv5+WW+rH1lideBX4fJbPoS3NauUNqtJdxnnKyI= +github.com/IBM/platform-services-go-sdk v0.50.4/go.mod h1:6LxcUhIaSLP4SuQJXF9oLXBamSQogs5D9BcVwr4hmfU= github.com/IBM/project-go-sdk v0.0.10 h1:vHSuemwZ4S4c6BEb22tzsEcPTs/5LnZ0yKpP3GG/GL8= github.com/IBM/project-go-sdk v0.0.10/go.mod h1:lqe0M4cKvABI1iHR1b+KfasVcxQL6nl2VJ8eOyQs8Ig= github.com/IBM/push-notifications-go-sdk v0.0.0-20210310100607-5790b96c47f5 h1:NPUhkoOCRuv3OFWt19PmwjXGGTKlvmbuPg9fUrBUNe4= github.com/IBM/push-notifications-go-sdk v0.0.0-20210310100607-5790b96c47f5/go.mod h1:b07XHUVh0XYnQE9s2mqgjYST1h9buaQNqN4EcKhOsX0= -github.com/IBM/scc-go-sdk/v5 v5.0.2 h1:OUqkzLfJqozp2aqylNurwaJd1SmY8o7KturFse6R2xM= -github.com/IBM/scc-go-sdk/v5 v5.0.2/go.mod h1:YtAVlzq10bwR82QX4ZavhDIwa1s85RuVO9N/KmXVcuk= +github.com/IBM/scc-go-sdk/v5 v5.1.2 h1:9axGtNlP3bHhoE9yJgCuc+g5/VdyhYqfhZ5oS3ovCFI= +github.com/IBM/scc-go-sdk/v5 v5.1.2/go.mod h1:YtAVlzq10bwR82QX4ZavhDIwa1s85RuVO9N/KmXVcuk= github.com/IBM/schematics-go-sdk v0.2.1 h1:byATysGD+Z1k/wdtNqQmKALcAPjgSLuSyzcabh1jRAw= github.com/IBM/schematics-go-sdk v0.2.1/go.mod h1:Tw2OSAPdpC69AxcwoyqcYYaGTTW6YpERF9uNEU+BFRQ= -github.com/IBM/secrets-manager-go-sdk/v2 v2.0.0 h1:Lx4Bvim/MfoHEYR+n312bty5DirAJypBGGS9YZo3zCw= -github.com/IBM/secrets-manager-go-sdk/v2 v2.0.0/go.mod h1:jagqWmjZ0zUEqh5jdGB42ApSQS40fu2LWw6pdg8JJko= +github.com/IBM/secrets-manager-go-sdk/v2 v2.0.1 h1:0Ouu31RsuOLdH26oNsnPErEjctWTplLEIXxwExnTZT0= +github.com/IBM/secrets-manager-go-sdk/v2 v2.0.1/go.mod h1:jagqWmjZ0zUEqh5jdGB42ApSQS40fu2LWw6pdg8JJko= github.com/IBM/vpc-beta-go-sdk v0.6.0 h1:wfM3AcW3zOM3xsRtZ+EA6+sESlGUjQ6Yf4n5QQyz4uc= github.com/IBM/vpc-beta-go-sdk v0.6.0/go.mod h1:fzHDAQIqH/5yJmYsKodKHLcqxMDT+yfH6vZjdiw8CQA= -github.com/IBM/vpc-go-sdk v0.41.0 h1:Y/V0i5qp3hraD0nHl1EYga9MupSqMJP12vO/OlFqvDk= -github.com/IBM/vpc-go-sdk v0.41.0/go.mod h1:Ga9hUJYJ6AbQVWL123Mz+/RIi77nv1dhnO4s3c3XdQE= github.com/Jeffail/gabs v1.1.1 h1:V0uzR08Hj22EX8+8QMhyI9sX2hwRu+/RJhJUmnwda/E= github.com/Jeffail/gabs v1.1.1/go.mod h1:6xMvQMK4k33lb7GUUpaAPh6nKMmemQeg5d4gn7/bOXc= github.com/Logicalis/asn1 v0.0.0-20190312173541-d60463189a56 h1:vuquMR410psHNax14XKNWa0Ae/kYgWJcXi0IFuX60N0= @@ -178,11 +177,13 @@ github.com/Logicalis/asn1 v0.0.0-20190312173541-d60463189a56/go.mod h1:Zb3OT4l0m github.com/Masterminds/goutils v1.1.1 h1:5nUrii3FMTL5diU80unEVvNevw1nH4+ZV4DSLVJLSYI= github.com/Masterminds/semver v1.4.2/go.mod h1:MB6lktGJrhw8PrUyiEoblNEGEQ+RzHPF078ddwwvV3Y= github.com/Masterminds/semver v1.5.0 h1:H65muMkzWKEuNDnfl9d70GUjFniHKHRbFPGBuZ3QEww= +github.com/Masterminds/semver/v3 v3.1.1 h1:hLg3sBzpNErnxhQtUy/mmLR2I9foDujNK030IGemrRc= github.com/Masterminds/sprig v2.22.0+incompatible h1:z4yfnGrZ7netVz+0EDJ0Wi+5VZCSYp4Z0m2dk6cEM60= +github.com/Masterminds/sprig/v3 v3.2.1 h1:n6EPaDyLSvCEa3frruQvAiHuNp2dhBlMSmkEr+HuzGc= github.com/Microsoft/go-winio v0.4.13/go.mod h1:qXqCSQ3Xa7+6tgxaGTIe4Kpcdsi+P8jBhyzoq1bpyYA= github.com/Microsoft/go-winio v0.4.14/go.mod h1:qXqCSQ3Xa7+6tgxaGTIe4Kpcdsi+P8jBhyzoq1bpyYA= github.com/Microsoft/go-winio v0.4.16/go.mod h1:XB6nPKklQyQ7GC9LdcBEcBl8PF76WugXOPRXwdLnMv0= -github.com/Microsoft/go-winio v0.5.2 h1:a9IhgEQBCUEk6QCdml9CiJGhAws+YwffDHEMp1VMrpA= +github.com/Microsoft/go-winio v0.6.1 h1:9/kr64B9VUZrLm5YYwbGtUJnMgqWVOdUAXu6Migciow= github.com/NYTimes/gziphandler v0.0.0-20170623195520-56545f4a5d46/go.mod h1:3wb06e3pkSAbeQ52E9H9iFoQsEEwGN64994WTCIhntQ= github.com/NYTimes/gziphandler v1.1.1 h1:ZUDjpQae29j0ryrS0u/B8HZfJBtBQHjqw2rQ2cqUQ3I= github.com/NYTimes/gziphandler v1.1.1/go.mod h1:n/CVRwUEOgIxrgPvAQhUUr9oeUtvrhMomdKFjzJNB0c= @@ -290,9 +291,10 @@ github.com/blang/semver v3.5.0+incompatible/go.mod h1:kRBLl5iJ+tD4TcOOxsy/0fnweb github.com/blang/semver v3.5.1+incompatible/go.mod h1:kRBLl5iJ+tD4TcOOxsy/0fnwebNt5EWlYSAyrTnjyyk= github.com/bmizerany/assert v0.0.0-20160611221934-b7ed37b82869/go.mod h1:Ekp36dRnpXw/yCqJaO+ZrUyxD+3VXMFFr56k5XYrpB4= github.com/boltdb/bolt v1.3.1/go.mod h1:clJnj/oiGkjum5o1McbSZDSLxVThjynRyGBgiAx27Ps= -github.com/boombuler/barcode v1.0.1-0.20190219062509-6c824513bacc h1:biVzkmvwrH8WK8raXaxBx6fRVTlJILwEwQGL1I/ByEI= github.com/boombuler/barcode v1.0.1-0.20190219062509-6c824513bacc/go.mod h1:paBWMcWSl3LHKBqUq+rly7CNSldXjb2rDl3JlRe0mD8= +github.com/boombuler/barcode v1.0.1 h1:NDBbPmhS+EqABEs5Kg3n/5ZNjy73Pz7SIV+KCeqyXcs= github.com/briankassouf/jose v0.9.2-0.20180619214549-d2569464773f/go.mod h1:HQhVmdUf7dBNwIIdBTivnCDxcf6IZY3/zrb+uKSJz6Y= +github.com/bufbuild/protocompile v0.4.0 h1:LbFKd2XowZvQ/kajzguUp2DC9UEIQhIq77fZZlaQsNA= github.com/buger/jsonparser v1.1.1/go.mod h1:6RYKKt7H4d4+iWqouImQ9R2FZql3VbhNgx27UK13J/0= github.com/cenkalti/backoff v2.2.1+incompatible h1:tNowT99t7UNflLxfYYSlKYsBpXdEet03Pg2g16Swow4= github.com/cenkalti/backoff v2.2.1+incompatible/go.mod h1:90ReRw6GdpyfrHakVjL/QHaoyV4aDUVVkXQJJJ3NXXM= @@ -367,10 +369,14 @@ github.com/digitalocean/godo v1.65.0 h1:3SywGJBC18HaYtPQF+T36jYzXBi+a6eIMonSjDll github.com/dimchansky/utfbom v1.1.0/go.mod h1:rO41eb7gLfo8SF1jd9F8HplJm1Fewwi4mQvIirEdv+8= github.com/dimchansky/utfbom v1.1.1 h1:vV6w1AhK4VMnhBno/TPVCoK9U/LP0PkLCS9tbxHdi/U= github.com/dnaeon/go-vcr v1.0.1/go.mod h1:aBB1+wY4s93YsC3HHjMBMrwTj2R9FHDzUr9KyGc8n1E= +github.com/docker/distribution v2.8.2+incompatible h1:T3de5rq0dB1j30rp0sA2rER+m322EBzniBPB6ZIzuh8= github.com/docker/docker v0.7.3-0.20190327010347-be7ac8be2ae0/go.mod h1:eEKB0N0r5NX/I1kEveEz05bcu8tLC/8azJZsviup8Sk= +github.com/docker/docker v24.0.5+incompatible h1:WmgcE4fxyI6EEXxBRxsHnZXrO1pQ3smi0k/jho4HLeY= +github.com/docker/go-connections v0.4.0 h1:El9xVISelRB7BuFusrZozjnkIM5YnzCViNKohAFqRJQ= github.com/docker/go-connections v0.4.0/go.mod h1:Gbd7IOopHjR8Iph03tsViu4nIes5XhDvyHbTtUxmeec= github.com/docker/go-units v0.3.3/go.mod h1:fgPhTUdO+D/Jk86RDLlptpiXQzgHJF7gydDDbaIK4Dk= github.com/docker/go-units v0.4.0/go.mod h1:fgPhTUdO+D/Jk86RDLlptpiXQzgHJF7gydDDbaIK4Dk= +github.com/docker/go-units v0.5.0 h1:69rxXcBk27SvSaaxTtLh/8llcHD8vYHT7WSdRZ/jvr4= github.com/docker/spdystream v0.0.0-20160310174837-449fdfce4d96/go.mod h1:Qh8CwZgvJUkLughtfhJv5dyTYa91l1fOUCrgjqmcifM= github.com/docker/spdystream v0.0.0-20181023171402-6480d4af844c/go.mod h1:Qh8CwZgvJUkLughtfhJv5dyTYa91l1fOUCrgjqmcifM= github.com/docopt/docopt-go v0.0.0-20180111231733-ee0de3bc6815/go.mod h1:WwZ+bS3ebgob9U8Nd0kOddGdZWjyMGR8Wziv+TBNwSE= @@ -420,8 +426,8 @@ github.com/evanphx/json-patch/v5 v5.6.0/go.mod h1:G79N1coSVB93tBe7j6PhzjmR3/2Vvl github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4= github.com/fatih/color v1.9.0/go.mod h1:eQcE1qtQxscV5RaZvpXrrb8Drkc3/DdQ+uUYCNjL+zU= github.com/fatih/color v1.13.0/go.mod h1:kLAiJbzzSOZDVNGyDpeOxJ47H46qBXwg5ILebYFFOfk= -github.com/fatih/color v1.14.1 h1:qfhVLaG5s+nCROl1zJsZRxFeYrHLqWroPOQ8BWiNb4w= -github.com/fatih/color v1.14.1/go.mod h1:2oHN61fhTpgcxD3TSWCgKDiH1+x4OiDVVGH8WlgGZGg= +github.com/fatih/color v1.15.0 h1:kOqh6YHBtK8aywxGerMG2Eq3H6Qgoqeo13Bk2Mv/nBs= +github.com/fatih/color v1.15.0/go.mod h1:0h5ZqXfHYED7Bhv2ZJamyIOUej9KtShiJESRwBDUSsw= github.com/fatih/structs v1.1.0/go.mod h1:9NiDSp5zOcgEDl+j00MP/WkGVPOlPRLejGD8Ga6PJ7M= github.com/flowstack/go-jsonschema v0.1.1/go.mod h1:yL7fNggx1o8rm9RlgXv7hTBWxdBM0rVwpMwimd3F3N0= github.com/flynn/go-shlex v0.0.0-20150515145356-3f9db97f8568/go.mod h1:xEzjJPgXI435gkrCt3MPfRiAkVrwSbHsst4LCFVfpJc= @@ -459,12 +465,13 @@ github.com/go-git/go-billy/v5 v5.2.0/go.mod h1:pmpqyWchKfYfrkb/UVH4otLvyi/5gJlGI github.com/go-git/go-billy/v5 v5.3.1 h1:CPiOUAzKtMRvolEKw+bG1PLRpT7D3LIs3/3ey4Aiu34= github.com/go-git/go-billy/v5 v5.3.1/go.mod h1:pmpqyWchKfYfrkb/UVH4otLvyi/5gJlGI4Hb3ZqZ3W0= github.com/go-git/go-git-fixtures/v4 v4.2.1/go.mod h1:K8zd3kDUAykwTdDCr+I0per6Y6vMiRR/nnVTBtavnB0= -github.com/go-git/go-git/v5 v5.0.0/go.mod h1:oYD8y9kWsGINPFJoLdaScGCN6dlKg23blmClfZwtUVA= github.com/go-git/go-git/v5 v5.4.2 h1:BXyZu9t0VkbiHtqrsvdq39UDhGJTl1h55VW6CSC4aY4= github.com/go-git/go-git/v5 v5.4.2/go.mod h1:gQ1kArt6d+n+BGd+/B/I74HwRTLhth2+zti4ihgckDc= github.com/go-gl/glfw v0.0.0-20190409004039-e6da0acd62b1/go.mod h1:vR7hzQXu2zJy9AVAgeJqvqgH9Q5CA+iKCZ2gyEVpxRU= github.com/go-gl/glfw/v3.3/glfw v0.0.0-20191125211704-12ad95a8df72/go.mod h1:tQ2UAYgL5IevRw8kRxooKSPJfGvJ9fJQFa0TUsXzTg8= github.com/go-gl/glfw/v3.3/glfw v0.0.0-20200222043503-6f7a984d4dc4/go.mod h1:tQ2UAYgL5IevRw8kRxooKSPJfGvJ9fJQFa0TUsXzTg8= +github.com/go-jose/go-jose/v3 v3.0.0 h1:s6rrhirfEP/CGIoc6p+PZAeogN2SxKav6Wp7+dyMWVo= +github.com/go-jose/go-jose/v3 v3.0.0/go.mod h1:RNkWWRld676jZEYoV3+XK8L2ZnNSvIsxFMht0mSX+u8= github.com/go-kit/kit v0.8.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as= github.com/go-kit/kit v0.9.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as= github.com/go-kit/log v0.1.0/go.mod h1:zbhenjAZHb184qTLMA9ZjW7ThYL0H2mk7Q6pNt4vbaY= @@ -479,8 +486,9 @@ github.com/go-logfmt/logfmt v0.5.1/go.mod h1:WYhtIu8zTZfxdn5+rREduYbwxfcBr/Vr6KE github.com/go-logr/logr v0.1.0/go.mod h1:ixOQHD9gLJUVQQ2ZOR7zLEifBX6tGkNJF4QyIY7sIas= github.com/go-logr/logr v0.2.0/go.mod h1:z6/tIYblkpsD+a4lm/fGIIU9mZ+XfAiaFtq7xTgseGU= github.com/go-logr/logr v1.2.0/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A= -github.com/go-logr/logr v1.2.3 h1:2DntVwHkVopvECVRSlL5PSo9eG+cAkDCuckLubN+rq0= github.com/go-logr/logr v1.2.3/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A= +github.com/go-logr/logr v1.2.4 h1:g01GSCwiDw2xSZfjJ2/T9M+S6pFdcNtFYsp+Y43HYDQ= +github.com/go-logr/logr v1.2.4/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A= github.com/go-logr/zapr v0.1.0/go.mod h1:tabnROwaDl0UNxkVeFRbY8bwB37GwRv0P8lg6aAiEnk= github.com/go-logr/zapr v1.2.3 h1:a9vnzlIBPQBBkeaR9IuMUfmVOrQlkoC4YfPoFkX3T7A= github.com/go-martini/martini v0.0.0-20170121215854-22fa46961aab/go.mod h1:/P9AEU963A2AYjv4d1V5eVL1CQbEJq6aCNHDDjibzu8= @@ -624,6 +632,8 @@ github.com/go-sql-driver/mysql v1.5.0/go.mod h1:DCzpHaOWr8IXmIStZouvnhqoel9Qv2LB github.com/go-sql-driver/mysql v1.6.0 h1:BCTh4TKNUYmOmMUcQ3IipzF5prigylS7XXjEkfCHuOE= github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY= github.com/go-task/slim-sprig v0.0.0-20210107165309-348f09dbbbc0/go.mod h1:fyg7847qk6SyHyPtNmDHnmrv/HOrqktSC+C9fM+CJOE= +github.com/go-task/slim-sprig v0.0.0-20230315185526-52ccab3ef572 h1:tfuBGBXKqDEevZMzYi5KSi8KkcZtzBcTgAUUtapy0OI= +github.com/go-task/slim-sprig v0.0.0-20230315185526-52ccab3ef572/go.mod h1:9Pwr4B2jHnOSGXyyzV8ROjYa2ojvAY6HCGYYfMoC3Ls= github.com/go-test/deep v1.0.1/go.mod h1:wGDj63lr65AM2AQyKZd/NYHGb0R+1RLqB8NKt3aSFNA= github.com/go-test/deep v1.0.2-0.20181118220953-042da051cf31/go.mod h1:wGDj63lr65AM2AQyKZd/NYHGb0R+1RLqB8NKt3aSFNA= github.com/go-test/deep v1.0.2/go.mod h1:wGDj63lr65AM2AQyKZd/NYHGb0R+1RLqB8NKt3aSFNA= @@ -702,8 +712,9 @@ github.com/golang/protobuf v1.4.2/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw github.com/golang/protobuf v1.4.3/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw735rRwI= github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk= github.com/golang/protobuf v1.5.1/go.mod h1:DopwsBzvsk0Fs44TXzsVbJyPhcCPeIwnvohx4u74HPM= -github.com/golang/protobuf v1.5.2 h1:ROPKBNFfQgOUMifHyP+KYbvpjbdoFNs+aK7DXlji0Tw= github.com/golang/protobuf v1.5.2/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY= +github.com/golang/protobuf v1.5.3 h1:KhyjKVUg7Usr/dYsdSqoFveMYd5ko72D+zANwlG1mmg= +github.com/golang/protobuf v1.5.3/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY= github.com/golang/snappy v0.0.0-20170215233205-553a64147049/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q= github.com/golang/snappy v0.0.0-20180518054509-2e65f85255db/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q= github.com/golang/snappy v0.0.1/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q= @@ -756,6 +767,7 @@ github.com/google/pprof v0.0.0-20201203190320-1bf35d6f28c2/go.mod h1:kpwsk12EmLe github.com/google/pprof v0.0.0-20210122040257-d980be63207e/go.mod h1:kpwsk12EmLew5upagYY7GY0pfYCcupk39gWOCRROcvE= github.com/google/pprof v0.0.0-20210226084205-cbba55b83ad5/go.mod h1:kpwsk12EmLew5upagYY7GY0pfYCcupk39gWOCRROcvE= github.com/google/pprof v0.0.0-20210407192527-94a9f03dee38/go.mod h1:kpwsk12EmLew5upagYY7GY0pfYCcupk39gWOCRROcvE= +github.com/google/pprof v0.0.0-20230510103437-eeec1cb781c3 h1:2XF1Vzq06X+inNqgJ9tRnGuw+ZVCB3FazXODD6JE1R8= github.com/google/renameio v0.1.0/go.mod h1:KWCgfxg9yswjAJkECMjeO8J8rahYeXnNhOm40UhjYkI= github.com/google/uuid v1.0.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= github.com/google/uuid v1.1.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= @@ -843,16 +855,16 @@ github.com/hashicorp/go-kms-wrapping/entropy v0.1.0 h1:xuTi5ZwjimfpvpL09jDE71smC github.com/hashicorp/go-kms-wrapping/entropy v0.1.0/go.mod h1:d1g9WGtAunDNpek8jUIEJnBlbgKS1N2Q61QkHiZyR1g= github.com/hashicorp/go-kms-wrapping/entropy/v2 v2.0.0 h1:pSjQfW3vPtrOTcasTUKgCTQT7OGPPTTMVRrOfU6FJD8= github.com/hashicorp/go-kms-wrapping/entropy/v2 v2.0.0/go.mod h1:xvb32K2keAc+R8DSFG2IwDcydK9DBQE+fGA5fsw6hSk= -github.com/hashicorp/go-kms-wrapping/v2 v2.0.8 h1:9Q2lu1YbbmiAgvYZ7Pr31RdlVonUpX+mmDL7Z7qTA2U= +github.com/hashicorp/go-kms-wrapping/v2 v2.0.9-0.20230228100945-740d2999c798 h1:22yjMhn+kJ7u8RaP5qcYEn02zHWnIg1/JxE4BL8JLtQ= github.com/hashicorp/go-kms-wrapping/wrappers/aead/v2 v2.0.7-1 h1:ZV26VJYcITBom0QqYSUOIj4HOHCVPEFjLqjxyXV/AbA= github.com/hashicorp/go-kms-wrapping/wrappers/alicloudkms/v2 v2.0.1 h1:ydUCtmr8f9F+mHZ1iCsvzqFTXqNVpewX3s9zcYipMKI= github.com/hashicorp/go-kms-wrapping/wrappers/awskms/v2 v2.0.7 h1:E3eEWpkofgPNrYyYznfS1+drq4/jFcqHQVNcL7WhUCo= -github.com/hashicorp/go-kms-wrapping/wrappers/azurekeyvault/v2 v2.0.7 h1:X27JWuPW6Gmi2l7NMm0pvnp7z7hhtns2TeIOQU93mqI= +github.com/hashicorp/go-kms-wrapping/wrappers/azurekeyvault/v2 v2.0.8-0.20230905162003-bfa3347a7c85 h1:yZqD2ZQ4kWyVI2reKGC8Hl78ywWBtl1iLz/Bb5GBvMA= github.com/hashicorp/go-kms-wrapping/wrappers/gcpckms/v2 v2.0.8 h1:16I8OqBEuxZIowwn3jiLvhlx+z+ia4dJc9stvz0yUBU= github.com/hashicorp/go-kms-wrapping/wrappers/ocikms/v2 v2.0.7 h1:KeG3QGrbxbr2qAqCJdf3NR4ijAYwdcWLTmwSbR0yusM= github.com/hashicorp/go-kms-wrapping/wrappers/transit/v2 v2.0.7 h1:G25tZFw/LrAzJWxvS0/BFI7V1xAP/UsAIsgBwiE0mwo= github.com/hashicorp/go-memdb v1.0.2/go.mod h1:I6dKdmYhZqU0RJSheVEWgTNWdVQH5QvTgIUQ0t/t32M= -github.com/hashicorp/go-memdb v1.3.3 h1:oGfEWrFuxtIUF3W2q/Jzt6G85TrMk9ey6XfYLvVe1Wo= +github.com/hashicorp/go-memdb v1.3.4 h1:XSL3NR682X/cVk2IeV0d70N4DZ9ljI885xAEU8IoK3c= github.com/hashicorp/go-msgpack v0.5.3/go.mod h1:ahLV/dePpqEmjfWmKiqvPkv/twdG7iPBM1vqhUKIvfM= github.com/hashicorp/go-msgpack v0.5.5/go.mod h1:ahLV/dePpqEmjfWmKiqvPkv/twdG7iPBM1vqhUKIvfM= github.com/hashicorp/go-msgpack v1.1.5 h1:9byZdVjKTe5mce63pRVNP1L7UAmdHOTEMGehn6KvJWs= @@ -862,8 +874,8 @@ github.com/hashicorp/go-multierror v1.1.1/go.mod h1:iw975J/qwKPdAO1clOe2L8331t/9 github.com/hashicorp/go-plugin v1.0.0/go.mod h1:++UyYGoz3o5w9ZzAdZxtQKrWWP+iqPBn3cQptSMzBuY= github.com/hashicorp/go-plugin v1.0.1/go.mod h1:++UyYGoz3o5w9ZzAdZxtQKrWWP+iqPBn3cQptSMzBuY= github.com/hashicorp/go-plugin v1.4.3/go.mod h1:5fGEH17QVwTTcR0zV7yhDPLLmFX9YSZ38b18Udy6vYQ= -github.com/hashicorp/go-plugin v1.4.8 h1:CHGwpxYDOttQOY7HOWgETU9dyVjOXzniXDqJcYJE1zM= -github.com/hashicorp/go-plugin v1.4.8/go.mod h1:viDMjcLJuDui6pXb8U4HVfb8AamCWhHGUjr2IrTF67s= +github.com/hashicorp/go-plugin v1.5.0 h1:g6Lj3USwF5LaB8HlvCxPjN2X4nFE08ko2BJNVpl7TIE= +github.com/hashicorp/go-plugin v1.5.0/go.mod h1:w1sAEES3g3PuV/RzUrgow20W2uErMly84hhD3um1WL4= github.com/hashicorp/go-raftchunking v0.6.3-0.20191002164813-7e9e8525653a h1:FmnBDwGwlTgugDGbVxwV8UavqSMACbGrUpfc98yFLR4= github.com/hashicorp/go-raftchunking v0.6.3-0.20191002164813-7e9e8525653a/go.mod h1:xbXnmKqX9/+RhPkJ4zrEx4738HacP72aaUPlT2RZ4sU= github.com/hashicorp/go-retryablehttp v0.5.3/go.mod h1:9B5zBasrRhHXnJnui7y6sL7es7NDiJgTc6Er0maI1Xs= @@ -889,6 +901,7 @@ github.com/hashicorp/go-secure-stdlib/parseutil v0.1.7 h1:UpiO20jno/eV1eVZcxqWnU github.com/hashicorp/go-secure-stdlib/parseutil v0.1.7/go.mod h1:QmrqtbKuxxSWTN3ETMPuB+VtEiBJ/A9XhoYGv8E1uD8= github.com/hashicorp/go-secure-stdlib/password v0.1.1 h1:6JzmBqXprakgFEHwBgdchsjaA9x3GyjdI568bXKxa60= github.com/hashicorp/go-secure-stdlib/password v0.1.1/go.mod h1:9hH302QllNwu1o2TGYtSk8I8kTAN0ca1EHpwhm5Mmzo= +github.com/hashicorp/go-secure-stdlib/plugincontainer v0.1.1 h1:1F0n5stk5uz4yIw2elN3k6bGbIv95OQaJVR2sVQ1kk0= github.com/hashicorp/go-secure-stdlib/reloadutil v0.1.1 h1:SMGUnbpAcat8rIKHkBPjfv81yC46a8eCNZ2hsR2l1EI= github.com/hashicorp/go-secure-stdlib/strutil v0.1.1/go.mod h1:gKOamz3EwoIoJq7mlMIRBpVTAUn8qPCrEclOKKWhD3U= github.com/hashicorp/go-secure-stdlib/strutil v0.1.2 h1:kes8mmyCpxJsI7FTwtzRqEy9CdjCtrXrXGuOpxEA7Ts= @@ -958,8 +971,8 @@ github.com/hashicorp/terraform-registry-address v0.0.0-20220623143253-7d51757b57 github.com/hashicorp/terraform-svchost v0.0.0-20200729002733-f050f53b9734 h1:HKLsbzeOsfXmKNpr3GiT18XAblV0BjCbzL8KQAMZGa0= github.com/hashicorp/terraform-svchost v0.0.0-20200729002733-f050f53b9734/go.mod h1:kNDNcF7sN4DocDLBkQYz73HGKwN1ANB1blq4lIYLYvg= github.com/hashicorp/vault v1.4.2/go.mod h1:500fLOj7p92Ys4X265LizqF78MzmHJUf1jV1zNJt060= -github.com/hashicorp/vault v1.13.5 h1:OxJBYy/6b0vw3/A/W6k8eOMfe5bj+cMcn9G6IgvrOVA= -github.com/hashicorp/vault v1.13.5/go.mod h1:pwi56hyIUi3b3fVT5G23K4Hi84nEYG1l+Kz1V6aLb7s= +github.com/hashicorp/vault v1.13.7 h1:4s/RullYWwTtWW7HzOKSR3SNzv4V2cgNo4ImvArnXpU= +github.com/hashicorp/vault v1.13.7/go.mod h1:KgEsayEcTM6N6fSun+4OqofsiwmD8rN6TUPRqESLBJQ= github.com/hashicorp/vault-plugin-auth-alicloud v0.5.5/go.mod h1:sQ+VNwPQlemgXHXikYH6onfH9gPwDZ1GUVRLz0ZvHx8= github.com/hashicorp/vault-plugin-auth-azure v0.5.6-0.20200422235613-1b5c70f9ef68/go.mod h1:RCVBsf8AJndh4c6iGZtvVZFui9SG0Bj9fnF0SodNIkw= github.com/hashicorp/vault-plugin-auth-centrify v0.5.5/go.mod h1:GfRoy7NHsuR/ogmZtbExdJXUwbfwcxPrS9xzkyy2J/c= @@ -987,8 +1000,8 @@ github.com/hashicorp/vault/api v1.0.5-0.20200215224050-f6547fa8e820/go.mod h1:3f github.com/hashicorp/vault/api v1.0.5-0.20200317185738-82f498082f02/go.mod h1:3f12BMfgDGjTsTtIUj+ZKZwSobQpZtYGFIEehOv5z1o= github.com/hashicorp/vault/api v1.3.0/go.mod h1:EabNQLI0VWbWoGlA+oBLC8PXmR9D60aUVgQGvangFWQ= github.com/hashicorp/vault/api v1.8.0/go.mod h1:uJrw6D3y9Rv7hhmS17JQC50jbPDAZdjZoTtrCCxxs7E= -github.com/hashicorp/vault/api v1.9.0 h1:ab7dI6W8DuCY7yCU8blo0UCYl2oHre/dloCmzMWg9w8= -github.com/hashicorp/vault/api v1.9.0/go.mod h1:lloELQP4EyhjnCQhF8agKvWIVTmxbpEJj70b98959sM= +github.com/hashicorp/vault/api v1.9.2 h1:YjkZLJ7K3inKgMZ0wzCU9OHqc+UqMQyXsPXnf3Cl2as= +github.com/hashicorp/vault/api v1.9.2/go.mod h1:jo5Y/ET+hNyz+JnKDt8XLAdKs+AM0G5W0Vp1IrFI8N8= github.com/hashicorp/vault/api/auth/approle v0.1.1/go.mod h1:mHOLgh//xDx4dpqXoq6tS8Ob0FoCFWLU2ibJ26Lfmag= github.com/hashicorp/vault/api/auth/approle v0.3.0 h1:Ib0oCNXsCq/QZhPYtXPzJEbGS5WR/KoZf8c84QoFdkU= github.com/hashicorp/vault/api/auth/approle v0.3.0/go.mod h1:hm51TbjzUkPO0Y17wkrpwOpvyyMRpXJNueTHiG04t3k= @@ -1003,8 +1016,8 @@ github.com/hashicorp/vault/sdk v0.1.14-0.20200427170607-03332aaf8d18/go.mod h1:W github.com/hashicorp/vault/sdk v0.1.14-0.20200429182704-29fce8f27ce4/go.mod h1:WX57W2PwkrOPQ6rVQk+dy5/htHIaB4aBM70EwKThu10= github.com/hashicorp/vault/sdk v0.3.0/go.mod h1:aZ3fNuL5VNydQk8GcLJ2TV8YCRVvyaakYkhZRoVuhj0= github.com/hashicorp/vault/sdk v0.6.0/go.mod h1:+DRpzoXIdMvKc88R4qxr+edwy/RvH5QK8itmxLiDHLc= -github.com/hashicorp/vault/sdk v0.8.1 h1:bdlhIpxBmJuOZ5Anumao1xeiLocR2eQrBRuJynZfTac= -github.com/hashicorp/vault/sdk v0.8.1/go.mod h1:kEpyfUU2ECGWf6XohKVFzvJ97ybSnXvxsTsBkbeVcQg= +github.com/hashicorp/vault/sdk v0.10.0 h1:dDAe1mMG7Qqor1h3i7TU70ykwJy8ijyWeZZkN2CB0j4= +github.com/hashicorp/vault/sdk v0.10.0/go.mod h1:s9F8+FF/Q9HuChoi1OWnIPoHRU6V675qHhCYkXVPPQE= github.com/hashicorp/vic v1.5.1-0.20190403131502-bbfe86ec9443 h1:O/pT5C1Q3mVXMyuqg7yuAWUg/jMZR1/0QTzTRdNR6Uw= github.com/hashicorp/yamux v0.0.0-20180604194846-3520598351bb/go.mod h1:+NfK9FKeTrX5uv1uIXGdwYDTeHna2qgaIlx54MXqjAM= github.com/hashicorp/yamux v0.0.0-20181012175058-2f1d1f20f75d/go.mod h1:+NfK9FKeTrX5uv1uIXGdwYDTeHna2qgaIlx54MXqjAM= @@ -1056,8 +1069,8 @@ github.com/jefferai/jsonx v1.0.0 h1:Xoz0ZbmkpBvED5W9W1B5B/zc3Oiq7oXqiW7iRV3B6EI= github.com/jefferai/jsonx v1.0.0/go.mod h1:OGmqmi2tTeI/PS+qQfBDToLHHJIy/RMp24fPo8vFvoQ= github.com/jessevdk/go-flags v1.4.0/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI= github.com/jessevdk/go-flags v1.5.0/go.mod h1:Fw0T6WPc1dYxT4mKEZRfG5kJhaTDP9pj1c2EWnYs/m4= -github.com/jhump/protoreflect v1.6.0 h1:h5jfMVslIg6l29nsMs0D8Wj17RDVdNYti0vDN/PZZoE= github.com/jhump/protoreflect v1.6.0/go.mod h1:eaTn3RZAmMBcV0fifFvlm6VHNz3wSkYyXYWUh7ymB74= +github.com/jhump/protoreflect v1.15.1 h1:HUMERORf3I3ZdX05WaQ6MIpd/NJ434hTp5YiKgfCL6c= github.com/jinzhu/copier v0.3.2 h1:QdBOCbaouLDYaIPFfi1bKv5F5tPpeTwXe4sD0jqtz5w= github.com/jinzhu/copier v0.3.2/go.mod h1:24xnZezI2Yqac9J61UC6/dG/k76ttpq0DdJI3QmUvro= github.com/jmespath/go-jmespath v0.0.0-20180206201540-c2b33e8439af/go.mod h1:Nht3zPeWKUH0NzdCt2Blrr5ys8VGpn0CEB0cQHVjt7k= @@ -1065,8 +1078,6 @@ github.com/jmespath/go-jmespath v0.4.0 h1:BEgLn5cpjn8UN1mAw4NjwDrS35OdebyEtFe+9Y github.com/jmespath/go-jmespath v0.4.0/go.mod h1:T8mJZnbsbmF+m6zOOFylbeCJqk5+pHWvzYPziyZiYoo= github.com/jmespath/go-jmespath/internal/testify v1.5.1 h1:shLQSRRSCCPj3f2gpwzGwWFoC7ycTf1rcQZHOlsJ6N8= github.com/jmespath/go-jmespath/internal/testify v1.5.1/go.mod h1:L3OGu8Wl2/fWfCI6z80xFu9LTZmf1ZRjMHUOPmWr69U= -github.com/johnstarich/go/gopages v0.1.8/go.mod h1:OaSRjfHdFfN+LS7u6xqgNO7C2Uxjlvpm17DcKcvLBhY= -github.com/johnstarich/go/pipe v0.2.0/go.mod h1:3X9IdVJJnI7pkpzEH6np98wqHl55zFmbilKG+9+koMo= github.com/joho/godotenv v1.3.0 h1:Zjp+RcGpHhGlrMbJzXTrZZPrWj+1vfm90La1wgB6Bhc= github.com/joho/godotenv v1.3.0/go.mod h1:7hK45KPybAkOC6peb+G5yklZfMxEjkZhHbwpqxOKXbg= github.com/jonboulle/clockwork v0.1.0/go.mod h1:Ii8DK3G1RaLaWxj9trq07+26W01tbo22gdxWY5EU2bo= @@ -1096,7 +1107,6 @@ github.com/karrick/godirwalk v1.8.0/go.mod h1:H5KPZjojv4lE+QYImBI8xVtrBRgYrIVsaR github.com/karrick/godirwalk v1.10.3/go.mod h1:RoGL9dQei4vP9ilrpETWE8CLOZ1kiN0LhBygSwrAsHA= github.com/kelseyhightower/envconfig v1.3.0/go.mod h1:cccZRl6mQpaq41TPp5QxidR+Sa3axMbJDNb//FQX6Gg= github.com/kelseyhightower/envconfig v1.4.0 h1:Im6hONhd3pLkfDFsbRgu68RDNkGF1r3dvMUtDTo2cv8= -github.com/kevinburke/ssh_config v0.0.0-20190725054713-01f96b0aa0cd/go.mod h1:CT57kijsi8u/K/BOFA39wgDQJ9CxiF4nAY/ojJ6r6mM= github.com/kevinburke/ssh_config v0.0.0-20201106050909-4977a11b4351 h1:DowS9hvgyYSX4TO5NpyC606/Z4SxnNYbT+WX27or6Ck= github.com/kevinburke/ssh_config v0.0.0-20201106050909-4977a11b4351/go.mod h1:CT57kijsi8u/K/BOFA39wgDQJ9CxiF4nAY/ojJ6r6mM= github.com/keybase/go-crypto v0.0.0-20190403132359-d65b6b94177f/go.mod h1:ghbZscTyKdM07+Fw3KSi0hcJm+AlEUWj8QLlPtijN/M= @@ -1108,8 +1118,8 @@ github.com/klauspost/compress v1.4.1/go.mod h1:RyIbtBH6LamlWaDj8nUwkbUhJ87Yi3uG0 github.com/klauspost/compress v1.9.5/go.mod h1:RyIbtBH6LamlWaDj8nUwkbUhJ87Yi3uG0guNDohfE1A= github.com/klauspost/compress v1.12.2/go.mod h1:8dP1Hq4DHOhN9w426knH3Rhby4rFm6D8eO+e+Dq5Gzg= github.com/klauspost/compress v1.13.6/go.mod h1:/3/Vjq9QcHkK5uEr5lBEmyoZ1iFhe47etQ6QUkpK6sk= -github.com/klauspost/compress v1.15.15 h1:EF27CXIuDsYJ6mmvtBRlEuB2UVOqHG1tAXgZ7yIO+lw= -github.com/klauspost/compress v1.15.15/go.mod h1:ZcK2JAFqKOpnBlxcLsJzYfrS9X1akm9fHZNnD9+Vo/4= +github.com/klauspost/compress v1.16.5 h1:IFV2oUNUzZaz+XyusxpLzpzS8Pt5rh0Z16For/djlyI= +github.com/klauspost/compress v1.16.5/go.mod h1:ntbaceVETuRiXiv4DpjP66DpAtAGkEQskQzEyD//IeE= github.com/klauspost/cpuid v1.2.0/go.mod h1:Pj4uuM528wm8OyEC2QMXAi2YiTZ96dNQPGgoMS4s3ek= github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ= github.com/konsorten/go-windows-terminal-sequences v1.0.2/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ= @@ -1118,8 +1128,8 @@ github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515/go.mod h1:+0opPa2QZZtGFB github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= github.com/kr/pretty v0.2.0/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI= github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI= -github.com/kr/pretty v0.3.0 h1:WgNl7dwNpEZ6jJ9k1snq4pZsg7DOEN8hP9Xw0Tsjwk0= github.com/kr/pretty v0.3.0/go.mod h1:640gp4NfQd8pI5XOwp5fnNeVWj67G7CFk/SaSQn7NBk= +github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= github.com/kr/pty v1.1.5/go.mod h1:9r2w37qlBe7rQ6e1fg1S/9xpWHSnaqNdHD3WcMdbPDA= github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= @@ -1177,8 +1187,8 @@ github.com/mattn/go-isatty v0.0.11/go.mod h1:PhnuNfih5lzO57/f3n+odYbM4JtupLOxQOA github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU= github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94= github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM= -github.com/mattn/go-isatty v0.0.17 h1:BTarxUcIeDqL27Mc+vyvdWYSL28zpIhv3RoTdsLMPng= -github.com/mattn/go-isatty v0.0.17/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM= +github.com/mattn/go-isatty v0.0.18 h1:DOKFKCQ7FNG2L1rbrmstDN4QVRdS89Nkh85u68Uwp98= +github.com/mattn/go-isatty v0.0.18/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= github.com/mattn/go-runewidth v0.0.2/go.mod h1:LwmH8dsx7+W8Uxz3IHJYH5QSwggIsqBzpuz5H//U1FU= github.com/mattn/go-runewidth v0.0.8/go.mod h1:H031xJmbD/WCDINGzjvQ9THkh0rPKHF+m2gUSrubnMI= github.com/mattn/go-shellwords v1.0.5/go.mod h1:3xCvwCdWdlDJUrvuMn7Wuy9eWs4pE8vqg+NOMyg4B2o= @@ -1195,7 +1205,7 @@ github.com/miekg/dns v1.1.41 h1:WMszZWJG0XmzbK9FEmzH2TVcqYzFesusSIB41b8KHxY= github.com/minsikl/netscaler-nitro-go v0.0.0-20170827154432-5b14ce3643e3 h1:PHPBYVeLuR7/2XSOfVwDpW+70KNuxMWygsyOZSKK15Y= github.com/minsikl/netscaler-nitro-go v0.0.0-20170827154432-5b14ce3643e3/go.mod h1:jh28TRFZwBumf7OjMQbRb8TNtDuuX7QNAGRjFEt+h6I= github.com/mitchellh/cli v1.0.0/go.mod h1:hNIlj7HEI86fIcpObd7a0FcrxTWetlwJDGcceTlRvqc= -github.com/mitchellh/cli v1.1.2 h1:PvH+lL2B7IQ101xQL63Of8yFS2y+aDlsFcsqNc+u/Kw= +github.com/mitchellh/cli v1.1.5 h1:OxRIeJXpAMztws/XHlN2vu6imG5Dpq+j61AzAX5fLng= github.com/mitchellh/copystructure v1.0.0/go.mod h1:SNtv71yrdKgLRyLFxmLdkAbkKEFWgYaq1OVrnRcwhnw= github.com/mitchellh/copystructure v1.2.0 h1:vpKXTN4ewci03Vljg/q9QvCGUDttBOGBIa15WveJJGw= github.com/mitchellh/copystructure v1.2.0/go.mod h1:qLl+cE2AmVv+CoeAwDPye/v+N2HKCj9FbZEVFJRxO9s= @@ -1284,7 +1294,18 @@ github.com/onsi/ginkgo/v2 v2.0.0/go.mod h1:vw5CSIxN1JObi/U8gcbwft7ZxR2dgaR70JSE3 github.com/onsi/ginkgo/v2 v2.1.3/go.mod h1:vw5CSIxN1JObi/U8gcbwft7ZxR2dgaR70JSE3/PpL4c= github.com/onsi/ginkgo/v2 v2.1.4/go.mod h1:um6tUpWM/cxCK3/FK8BXqEiUMUwRgSM4JXG47RKZmLU= github.com/onsi/ginkgo/v2 v2.1.6/go.mod h1:MEH45j8TBi6u9BMogfbp0stKC5cdGjumZj5Y7AG4VIk= -github.com/onsi/ginkgo/v2 v2.6.0 h1:9t9b9vRUbFq3C4qKFCGkVuq/fIHji802N1nrtkh1mNc= +github.com/onsi/ginkgo/v2 v2.3.0/go.mod h1:Eew0uilEqZmIEZr8JrvYlvOM7Rr6xzTmMV8AyFNU9d0= +github.com/onsi/ginkgo/v2 v2.4.0/go.mod h1:iHkDK1fKGcBoEHT5W7YBq4RFWaQulw+caOMkAt4OrFo= +github.com/onsi/ginkgo/v2 v2.5.0/go.mod h1:Luc4sArBICYCS8THh8v3i3i5CuSZO+RaQRaJoeNwomw= +github.com/onsi/ginkgo/v2 v2.7.0/go.mod h1:yjiuMwPokqY1XauOgju45q3sJt6VzQ/Fict1LFVcsAo= +github.com/onsi/ginkgo/v2 v2.8.1/go.mod h1:N1/NbDngAFcSLdyZ+/aYTYGSlq9qMCS/cNKGJjy+csc= +github.com/onsi/ginkgo/v2 v2.9.0/go.mod h1:4xkjoL/tZv4SMWeww56BU5kAt19mVB47gTWxmrTcxyk= +github.com/onsi/ginkgo/v2 v2.9.1/go.mod h1:FEcmzVcCHl+4o9bQZVab+4dC9+j+91t2FHSzmGAPfuo= +github.com/onsi/ginkgo/v2 v2.9.2/go.mod h1:WHcJJG2dIlcCqVfBAwUCrJxSPFb6v4azBwgxeMeDuts= +github.com/onsi/ginkgo/v2 v2.9.5/go.mod h1:tvAoo1QUJwNEU2ITftXTpR7R1RbCzoZUOs3RonqW57k= +github.com/onsi/ginkgo/v2 v2.9.7/go.mod h1:cxrmXWykAwTwhQsJOPfdIDiJ+l2RYq7U8hFU+M/1uw0= +github.com/onsi/ginkgo/v2 v2.11.0 h1:WgqUCUt/lT6yXoQ8Wef0fsNn5cAuMK7+KT9UFRz2tcU= +github.com/onsi/ginkgo/v2 v2.11.0/go.mod h1:ZhrRA5XmEE3x3rhlzamx/JJvujdZoJ2uvgI7kR0iZvM= github.com/onsi/gomega v0.0.0-20170829124025-dcabb60a477c/go.mod h1:C1qb7wdrVGGVU+Z6iS04AVkA3Q65CEZX59MT0QO5uiA= github.com/onsi/gomega v0.0.0-20190113212917-5533ce8a0da3/go.mod h1:ex+gbHU/CVuBBDIJjb2X0qEXbFg53c61hWP/1CpauHY= github.com/onsi/gomega v1.4.2/go.mod h1:ex+gbHU/CVuBBDIJjb2X0qEXbFg53c61hWP/1CpauHY= @@ -1302,11 +1323,25 @@ github.com/onsi/gomega v1.17.0/go.mod h1:HnhC7FXeEQY45zxNK3PPoIUhzk/80Xly9PcubAl github.com/onsi/gomega v1.18.0/go.mod h1:0q+aL8jAiMXy9hbwj2mr5GziHiwhAIQpFmmtT5hitRs= github.com/onsi/gomega v1.18.1/go.mod h1:0q+aL8jAiMXy9hbwj2mr5GziHiwhAIQpFmmtT5hitRs= github.com/onsi/gomega v1.19.0/go.mod h1:LY+I3pBVzYsTBU1AnDwOSxaYi9WoWiqgwooUqq9yPro= +github.com/onsi/gomega v1.20.0/go.mod h1:DtrZpjmvpn2mPm4YWQa0/ALMDj9v4YxLgojwPeREyVo= github.com/onsi/gomega v1.20.1/go.mod h1:DtrZpjmvpn2mPm4YWQa0/ALMDj9v4YxLgojwPeREyVo= github.com/onsi/gomega v1.21.1/go.mod h1:iYAIXgPSaDHak0LCMA+AWBpIKBr8WZicMxnE8luStNc= -github.com/onsi/gomega v1.27.7 h1:fVih9JD6ogIiHUN6ePK7HJidyEDpWGVB5mzM7cWNXoU= +github.com/onsi/gomega v1.22.1/go.mod h1:x6n7VNe4hw0vkyYUM4mjIXx3JbLiPaBPNgB7PRQ1tuM= +github.com/onsi/gomega v1.24.0/go.mod h1:Z/NWtiqwBrwUt4/2loMmHL63EDLnYHmVbuBpDr2vQAg= +github.com/onsi/gomega v1.24.1/go.mod h1:3AOiACssS3/MajrniINInwbfOOtfZvplPzuRSmvt1jM= +github.com/onsi/gomega v1.26.0/go.mod h1:r+zV744Re+DiYCIPRlYOTxn0YkOLcAnW8k1xXdMPGhM= +github.com/onsi/gomega v1.27.1/go.mod h1:aHX5xOykVYzWOV4WqQy0sy8BQptgukenXpCXfadcIAw= +github.com/onsi/gomega v1.27.3/go.mod h1:5vG284IBtfDAmDyrK+eGyZmUgUlmi+Wngqo557cZ6Gw= +github.com/onsi/gomega v1.27.4/go.mod h1:riYq/GJKh8hhoM01HN6Vmuy93AarCXCBGpvFDK3q3fQ= +github.com/onsi/gomega v1.27.6/go.mod h1:PIQNjfQwkP3aQAH7lf7j87O/5FiNr+ZR8+ipb+qQlhg= +github.com/onsi/gomega v1.27.7/go.mod h1:1p8OOlwo2iUUDsHnOrjE5UKYJ+e3W8eQ3qSlRahPmr4= +github.com/onsi/gomega v1.27.8/go.mod h1:2J8vzI/s+2shY9XHRApDkdgPo1TKT7P2u6fXeJKFnNQ= +github.com/onsi/gomega v1.27.10 h1:naR28SdDFlqrG6kScpT8VWpu1xWY5nJRCF3XaYyBjhI= +github.com/onsi/gomega v1.27.10/go.mod h1:RsS8tutOdbdgzbPtzzATp12yT7kM5I5aElG3evPbQ0M= github.com/opencontainers/go-digest v1.0.0-rc1/go.mod h1:cMLVZDEM3+U2I4VmLI6N8jQYUd2OVphdqWwCJHrFt2s= +github.com/opencontainers/go-digest v1.0.0 h1:apOUWs51W5PlhuyGyz9FCeeBIOUDA/6nW8Oi/yOhh5U= github.com/opencontainers/image-spec v1.0.1/go.mod h1:BtxoFyWECRxE4U/7sNtV5W15zMzWCbyJoFRP3s7yZA0= +github.com/opencontainers/image-spec v1.1.0-rc2.0.20221005185240-3a7f492d3f1b h1:YWuSjZCQAPM8UUBLkYUk1e+rZcvWHJmFb6i6rM44Xs8= github.com/opencontainers/runc v0.1.1/go.mod h1:qT5XzbpPznkRYVz/mWwUaVBUv2rmF59PVA73FjuZG0U= github.com/openshift/api v0.0.0-20210105115604-44119421ec6b/go.mod h1:aqU5Cq+kqKKPbDMqxo9FojgDeSpNJI7iuskjXjtojDg= github.com/openshift/api v0.0.0-20230329202819-04d4fb776982 h1:WQ6AkeLlqh6OrGuric5yYJ7j29QpsDiDNkdMKIqq3Dc= @@ -1453,6 +1488,7 @@ github.com/shirou/gopsutil v2.19.9+incompatible/go.mod h1:5b4v6he4MtMOwMlS0TUMTu github.com/shirou/gopsutil/v3 v3.22.6 h1:FnHOFOh+cYAM0C30P+zysPISzlknLC5Z1G4EAElznfQ= github.com/shirou/w32 v0.0.0-20160930032740-bb4de0191aa4/go.mod h1:qsXQc7+bwAM3Q1u/4XEfrquwF8Lw7D7y5cD8CuHnfIc= github.com/shopspring/decimal v0.0.0-20180709203117-cd690d0c9e24/go.mod h1:M+9NzErvs504Cn4c5DxATwIqPbtswREoFCre64PpcG4= +github.com/shopspring/decimal v1.2.0 h1:abSATXmQEYyShuxI4/vyW3tV1MrKAJzCZ/0zLUXYbsQ= github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc= github.com/sirupsen/logrus v1.2.0/go.mod h1:LxeOpSwHxABJmUn/MG1IvRgCAasNZTLOkJPxbbu5VWo= github.com/sirupsen/logrus v1.4.0/go.mod h1:LxeOpSwHxABJmUn/MG1IvRgCAasNZTLOkJPxbbu5VWo= @@ -1477,6 +1513,7 @@ github.com/spaolacci/murmur3 v0.0.0-20180118202830-f09979ecbc72/go.mod h1:JwIasO github.com/spf13/afero v1.1.2/go.mod h1:j4pytiNVoe2o6bmDsKpLACNPDBIoEAkihy7loJ1B0CQ= github.com/spf13/afero v1.2.2/go.mod h1:9ZxEEn6pIJ8Rxe320qSDBk6AsU0r9pR7Q4OcevTdifk= github.com/spf13/cast v1.3.0/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE= +github.com/spf13/cast v1.3.1 h1:nFm6S0SMdyzrzcmThSipiEubIDy8WEXKNZ0UOgiRpng= github.com/spf13/cobra v0.0.3/go.mod h1:1l0Ry5zgKvJasoi3XT1TypsSe7PqH0Sj9dhYf7v3XqQ= github.com/spf13/cobra v0.0.5/go.mod h1:3K3wKZymM7VvHMDS9+Akkh4K60UwM26emMESw8tLCHU= github.com/spf13/cobra v1.1.1/go.mod h1:WnodtKOvamDL/PwE2M4iKs8aMDBZ5Q5klgD3qfVJQMI= @@ -1540,7 +1577,6 @@ github.com/vmihailenco/msgpack/v4 v4.3.12/go.mod h1:gborTTJjAo/GWTqqRjrLCn9pgNN+ github.com/vmihailenco/tagparser v0.1.1 h1:quXMXlA39OCbd2wAdTsGDlK9RkOk6Wuw+x37wVyIuWY= github.com/vmihailenco/tagparser v0.1.1/go.mod h1:OeAg3pn3UbLjkWt+rN9oFYB6u/cQgqMEUPoW2WPyhdI= github.com/vmware/govmomi v0.18.0 h1:f7QxSmP7meCtoAmiKZogvVbLInT+CZx6Px6K5rYsJZo= -github.com/xanzy/ssh-agent v0.2.1/go.mod h1:mLlQY/MoOhWBj+gOGMQkOeiEvkx+8pJSI+0Bx9h2kr4= github.com/xanzy/ssh-agent v0.3.0 h1:wUMzuKtKilRgBAD1sUb8gOwwRr2FGoBVumcjoOACClI= github.com/xanzy/ssh-agent v0.3.0/go.mod h1:3s9xbODqPuuhK9JV1R321M/FlMZSBvE5aY6eAcqrDh0= github.com/xdg-go/pbkdf2 v1.0.0/go.mod h1:jrpuAogTd400dnrH08LKmI/xc1MbPOebTwRqcT5RDeI= @@ -1596,6 +1632,7 @@ go.mongodb.org/mongo-driver v1.7.0/go.mod h1:Q4oFMbo1+MSNqICAdYMlC/zSTrwCogR4R8N go.mongodb.org/mongo-driver v1.7.3/go.mod h1:NqaYOwnXWr5Pm7AOpO5QFxKJ503nbMse/R79oO62zWg= go.mongodb.org/mongo-driver v1.7.5/go.mod h1:VXEWRZ6URJIkUq2SCAyapmhH0ZLRBP+FT4xhp5Zvxng= go.mongodb.org/mongo-driver v1.10.0/go.mod h1:wsihk0Kdgv8Kqu1Anit4sfK+22vSFbUrAVEYRhCXrA8= +go.mongodb.org/mongo-driver v1.11.3/go.mod h1:PTSz5yu21bkT/wXpkS7WR5f0ddqw5quethTUn9WM+2g= go.mongodb.org/mongo-driver v1.11.6 h1:XM7G6PjiGAO5betLF13BIa5TlLUUE3uJ/2Ox3Lz1K+o= go.mongodb.org/mongo-driver v1.11.6/go.mod h1:G9TgswdsWjX4tmDA5zfs2+6AEPpYJwqblyjsfuh8oXY= go.opencensus.io v0.19.1/go.mod h1:gug0GbSHa8Pafr0d2urOSgoXHZ6x/RUlaiT0d9pqb4A= @@ -1641,6 +1678,7 @@ golang.org/x/crypto v0.0.0-20190605123033-f99c8df09eb5/go.mod h1:yigFU9vqHzYiE8U golang.org/x/crypto v0.0.0-20190611184440-5c40567a22f8/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/crypto v0.0.0-20190617133340-57b3e21c3d56/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/crypto v0.0.0-20190701094942-4def268fd1a4/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= +golang.org/x/crypto v0.0.0-20190911031432-227b76d455e7/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/crypto v0.0.0-20191206172530-e9b2fee46413/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= golang.org/x/crypto v0.0.0-20200117160349-530e935923ad/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= @@ -1659,9 +1697,11 @@ golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97/go.mod h1:GvvjBRRGRdwPK5y golang.org/x/crypto v0.0.0-20210817164053-32db794688a5/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4= +golang.org/x/crypto v0.1.0/go.mod h1:RecgLatLF4+eUMCP1PoPZQb+cVrJcOPbHkTkbkB9sbw= golang.org/x/crypto v0.6.0/go.mod h1:OFC/31mSvZgRz0V1QTNCzfAI1aIRzbiufJtkMIlEp58= -golang.org/x/crypto v0.7.0 h1:AvwMYaRytfdeVt3u6mLaxYtErKYjxA2OXjJ1HHq6t3A= -golang.org/x/crypto v0.7.0/go.mod h1:pYwdfH91IfpZVANVyUOhSIPZaFoJGxTFbZhFTx+dXZU= +golang.org/x/crypto v0.11.0/go.mod h1:xgJhtzW8F9jGdVFWZESrid1U1bjeNy4zgy5cRr/CIio= +golang.org/x/crypto v0.14.0 h1:wBqGXzWJW6m1XrIKlAH0Hs1JJ7+9KBwnIO8v66Q9cHc= +golang.org/x/crypto v0.14.0/go.mod h1:MVFd36DqK4CsrnJYDkBA3VC4m2GkXAM0PvzMCn4JQf4= golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190510132918-efd6b22b2522/go.mod h1:ZjyILWgesfNpC6sMxTJOJm9Kp84zZh5NQWvqDGG3Qr8= @@ -1700,7 +1740,12 @@ golang.org/x/mod v0.4.1/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= golang.org/x/mod v0.4.2/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= golang.org/x/mod v0.6.0-dev.0.20220106191415-9b9b3d81d5e3/go.mod h1:3p9vT2HGsQu2K1YbXdKPJLVgG5VJdoTa1poYQBtP1AY= golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= +golang.org/x/mod v0.6.0/go.mod h1:4mET923SAdbXp2ki8ey+zGs1SLqsuM2Y0uvdZR/fUNI= +golang.org/x/mod v0.7.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= +golang.org/x/mod v0.9.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= +golang.org/x/mod v0.10.0 h1:lFO9qtOdlre5W1jxS3r/4szv2/6iXxScdzjoBMXNhYk= +golang.org/x/mod v0.10.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= golang.org/x/net v0.0.0-20170114055629-f2499483f923/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20180530234432-1e491301e022/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= @@ -1772,12 +1817,17 @@ golang.org/x/net v0.0.0-20220127200216-cd36cc0744dd/go.mod h1:CfG3xpIq0wQ8r1q4Su golang.org/x/net v0.0.0-20220225172249-27dd8689420f/go.mod h1:CfG3xpIq0wQ8r1q4Su4UZFWDARRcnwPjda9FqA0JpMk= golang.org/x/net v0.0.0-20220425223048-2871e0cb64e4/go.mod h1:CfG3xpIq0wQ8r1q4Su4UZFWDARRcnwPjda9FqA0JpMk= golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= -golang.org/x/net v0.0.0-20221004154528-8021a29435af/go.mod h1:YDH+HFinaLZZlnHAfSS6ZXJJ9M9t4Dl22yv3iI2vPwk= +golang.org/x/net v0.1.0/go.mod h1:Cx3nUiGt4eDBEyega/BKRp+/AlGL8hYe7U9odMt2Cco= +golang.org/x/net v0.2.0/go.mod h1:KqCZLdyyvdV855qA2rE3GC2aiw5xGR5TEjj8smXukLY= +golang.org/x/net v0.3.0/go.mod h1:MBQ8lrhLObU/6UmLb4fmbmk5OcyYmqtbGd/9yIeKjEE= +golang.org/x/net v0.5.0/go.mod h1:DivGGAXEgPSlEBzxGzZI+ZLohi+xUj054jfeKui00ws= golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs= golang.org/x/net v0.7.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs= golang.org/x/net v0.8.0/go.mod h1:QVkue5JL9kW//ek3r6jTKnTFis1tRmNAW2P1shuFdJc= -golang.org/x/net v0.10.0 h1:X2//UzNDwYmtCLn7To6G58Wr6f5ahEAQgKNzv9Y951M= golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg= +golang.org/x/net v0.12.0/go.mod h1:zEVYFnQC7m/vmpQFELhcD1EWkZlX69l4oqgmer6hfKA= +golang.org/x/net v0.17.0 h1:pVaXccu2ozPjCXewfr1S7xza/zcXTity9cCdXQYSjIM= +golang.org/x/net v0.17.0/go.mod h1:NxSsAGuq816PNPmqtQdLE42eU2Fs7NoRIZrHJAlaCOE= golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= golang.org/x/oauth2 v0.0.0-20181203162652-d668ce993890/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= golang.org/x/oauth2 v0.0.0-20190130055435-99b60b757ec1/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= @@ -1796,8 +1846,8 @@ golang.org/x/oauth2 v0.0.0-20210313182246-cd4f82c27b84/go.mod h1:KelEdhl1UZF7XfJ golang.org/x/oauth2 v0.0.0-20210514164344-f6687ab2804c/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A= golang.org/x/oauth2 v0.0.0-20210819190943-2bc19b11175f/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A= golang.org/x/oauth2 v0.0.0-20220223155221-ee480838109b/go.mod h1:DAh4E804XQdzx2j+YRIaUnCqCV2RuMz24cGBJ5QYIrc= -golang.org/x/oauth2 v0.6.0 h1:Lh8GPgSKBfWSwFvtuWOfeI3aAAnbXTSutYxJiOJFgIw= -golang.org/x/oauth2 v0.6.0/go.mod h1:ycmewcwgD4Rpr3eZJLSB4Kyyljb3qDh40vJ8STE5HKw= +golang.org/x/oauth2 v0.7.0 h1:qe6s0zUXlPX80/dITx3440hWZ7GwMwgDDyrSGTPJG/g= +golang.org/x/oauth2 v0.7.0/go.mod h1:hPLQkd9LyjfXTiRohC/41GhcFqxisoUQ99sCUOHO9x4= golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= @@ -1811,8 +1861,9 @@ golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJ golang.org/x/sync v0.0.0-20201207232520-09787c993a3a/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sync v0.1.0 h1:wsuoTGHzEhffawBOhz5CYhcrV4IdKZbEyZjBMuTp12o= golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.2.0 h1:PUR+T4wwASmuSTYdKjYHI5TD22Wy5ogLU5qZCOLxBrI= +golang.org/x/sync v0.2.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sys v0.0.0-20170830134202-bb24a47a89ea/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20180823144017-11551d06cbcc/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= @@ -1909,21 +1960,33 @@ golang.org/x/sys v0.0.0-20220503163025-988cb79eb6c6/go.mod h1:oPkhp1MJrh7nUepCBc golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20220728004956-3c1f35247d10/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220908164124-27713097b956/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.2.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.3.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.4.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.8.0 h1:EBmGv8NaZBZTWvrbjNoL6HVt+IVy3QDQpJs7VRIw3tU= golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.9.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.10.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.13.0 h1:Af8nKPmuFypiUBjVoU9V20FiaFXOcuZI21p0ycVYYGE= +golang.org/x/sys v0.13.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/term v0.0.0-20201117132131-f5c789dd3221/go.mod h1:Nr5EML6q2oocZ2LXRh80K7BxOlk5/8JxuGnuhpl+muw= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/term v0.0.0-20210615171337-6886f2dfbf5b/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= +golang.org/x/term v0.1.0/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= +golang.org/x/term v0.2.0/go.mod h1:TVmDHMZPmdnySmBfhjOoOdhjzdE1h4u1VwSiw2l1Nuc= +golang.org/x/term v0.3.0/go.mod h1:q750SLmJuPmVoN1blW3UFBPREJfb1KmY3vwxfr+nFDA= +golang.org/x/term v0.4.0/go.mod h1:9P2UbLfCdcvo3p/nzKvsmas4TnlujnuoV9hGgYzW1lQ= golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k= golang.org/x/term v0.6.0/go.mod h1:m6U89DPEgQRMq3DNkDClhWw02AUbt2daBVO4cn4Hv9U= -golang.org/x/term v0.8.0 h1:n5xxQn2i3PC0yLAbjTpNT85q/Kgzcr2gIoX9OrJUols= golang.org/x/term v0.8.0/go.mod h1:xPskH00ivmX89bAKVGSKKtLOWNx2+17Eiy94tnKShWo= +golang.org/x/term v0.10.0/go.mod h1:lpqdcUyK/oCiQxvxVrppt5ggO2KCZ5QblwqPnfZ6d5o= +golang.org/x/term v0.13.0 h1:bb+I9cTfFazGW51MZqBVmZy7+JEJMouUHTUSKVQLBek= +golang.org/x/term v0.13.0/go.mod h1:LTmsnFJwVN6bCy1rVCoS+qHT1HhALEFxKncY3WNNh4U= golang.org/x/text v0.0.0-20160726164857-2910a502d2bf/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= @@ -1935,10 +1998,15 @@ golang.org/x/text v0.3.4/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.5/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= +golang.org/x/text v0.4.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= +golang.org/x/text v0.5.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= +golang.org/x/text v0.6.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= golang.org/x/text v0.8.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8= -golang.org/x/text v0.9.0 h1:2sjJmO8cDvYveuX97RDLsxlyUxLl+GHoLxBiRdHllBE= golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8= +golang.org/x/text v0.11.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE= +golang.org/x/text v0.13.0 h1:ablQoSUd0tRdKxZewP80B+BaqeKJuVhuRxj/dkrun3k= +golang.org/x/text v0.13.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE= golang.org/x/time v0.0.0-20180412165947-fbb02b2291d2/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/time v0.0.0-20181108054448-85acf8d2951c/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= @@ -2021,7 +2089,13 @@ golang.org/x/tools v0.1.0/go.mod h1:xkSsbof2nBLbhDlRMhhhyNLN/zl3eTqcnHD5viDpcZ0= golang.org/x/tools v0.1.5/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= golang.org/x/tools v0.1.10/go.mod h1:Uh6Zz+xoGYZom868N8YTex3t7RhtHDBrE8Gzo9bV56E= golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= +golang.org/x/tools v0.2.0/go.mod h1:y4OqIKeOV/fWJetJ8bXPU1sEVniLMIyDAZWeHdV+NTA= +golang.org/x/tools v0.4.0/go.mod h1:UE5sM2OK9E/d67R0ANs2xJizIymRP5gJU295PvKXxjQ= golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU= +golang.org/x/tools v0.7.0/go.mod h1:4pg6aUX35JBAogB10C9AtvVL+qowtN4pT3CGSQex14s= +golang.org/x/tools v0.9.1/go.mod h1:owI94Op576fPu3cIGQeHs3joujW/2Oc6MtlxbF5dfNc= +golang.org/x/tools v0.9.3 h1:Gn1I8+64MsuTb/HpH+LmQtNas23LhUVr3rYZ0eKuaMM= +golang.org/x/tools v0.9.3/go.mod h1:owI94Op576fPu3cIGQeHs3joujW/2Oc6MtlxbF5dfNc= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= @@ -2115,8 +2189,10 @@ google.golang.org/genproto v0.0.0-20210310155132-4ce2db91004e/go.mod h1:FWY/as6D google.golang.org/genproto v0.0.0-20210319143718-93e7006c17a6/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no= google.golang.org/genproto v0.0.0-20210402141018-6c239bbf2bb1/go.mod h1:9lPAdzaEmUacj36I+k7YKbEc5CXzPIeORRgDAUOu28A= google.golang.org/genproto v0.0.0-20220107163113-42d7afdf6368/go.mod h1:5CzLGKJ67TSI2B9POpiiyGha0AjJvZIUgRMt1dSmuhc= -google.golang.org/genproto v0.0.0-20230306155012-7f2fa6fef1f4 h1:DdoeryqhaXp1LtT/emMP1BRJPHHKFi5akj/nbx/zNTA= -google.golang.org/genproto v0.0.0-20230306155012-7f2fa6fef1f4/go.mod h1:NWraEVixdDnqcqQ30jipen1STv2r/n24Wb7twVTGR4s= +google.golang.org/genproto v0.0.0-20230526161137-0005af68ea54 h1:9NWlQfY2ePejTmfwUH1OWwmznFa+0kKcHGPDvcPza9M= +google.golang.org/genproto/googleapis/api v0.0.0-20230525234035-dd9d682886f9 h1:m8v1xLLLzMe1m5P+gCTF8nJB9epwZQUBERm20Oy1poQ= +google.golang.org/genproto/googleapis/rpc v0.0.0-20230525234030-28d5490b6b19 h1:0nDDozoAU19Qb2HwhXadU8OcsiO/09cnTqhUtq2MEOM= +google.golang.org/genproto/googleapis/rpc v0.0.0-20230525234030-28d5490b6b19/go.mod h1:66JfowdXAEgad5O9NnYcsNPLCPZJD++2L9X0PCMODrA= google.golang.org/grpc v1.8.0/go.mod h1:yo6s7OP7yaDglbqo1J04qKzAhqBH6lvTonzMVmEdcZw= google.golang.org/grpc v1.14.0/go.mod h1:yo6s7OP7yaDglbqo1J04qKzAhqBH6lvTonzMVmEdcZw= google.golang.org/grpc v1.16.0/go.mod h1:0JHn/cJsOMiMfNA9+DeHDlAU7KAAB5GDlYFpa9MZMio= @@ -2145,8 +2221,8 @@ google.golang.org/grpc v1.36.0/go.mod h1:qjiiYl8FncCW8feJPdyg3v6XW24KsRHe+dy9BAG google.golang.org/grpc v1.36.1/go.mod h1:qjiiYl8FncCW8feJPdyg3v6XW24KsRHe+dy9BAGRRjU= google.golang.org/grpc v1.40.0/go.mod h1:ogyxbiOoUXAkP+4+xa6PZSE9DZgIHtSpzjDTB9KAK34= google.golang.org/grpc v1.41.0/go.mod h1:U3l9uK9J0sini8mHphKoXyaqDA/8VyGnDee1zzIUK6k= -google.golang.org/grpc v1.53.0 h1:LAv2ds7cmFV/XTS3XG1NneeENYrXGmorPxsBbptIjNc= -google.golang.org/grpc v1.53.0/go.mod h1:OnIrk0ipVdj4N5d9IUoFUx72/VlD7+jUsHwZgwSMQpw= +google.golang.org/grpc v1.57.0 h1:kfzNeI/klCGD2YPMUlaGNT3pxvYfga7smW3Vth8Zsiw= +google.golang.org/grpc v1.57.0/go.mod h1:Sd+9RMTACXwmub0zcNY2c4arhtrbBYD1AUHI/dt16Mo= google.golang.org/protobuf v0.0.0-20200109180630-ec00e32a8dfd/go.mod h1:DFci5gLYBciE7Vtevhsrf46CRTquxDuWsQurQQe4oz8= google.golang.org/protobuf v0.0.0-20200221191635-4d8936d0db64/go.mod h1:kwYJMbMJ01Woi6D6+Kah6886xMZcty6N08ah7+eCXa0= google.golang.org/protobuf v0.0.0-20200228230310-ab0ca4ff8a60/go.mod h1:cfTl7dwQJ+fmap5saPgwCLgHXTUD7jkjRqWcaiX5VyM= @@ -2161,8 +2237,8 @@ google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp0 google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc= google.golang.org/protobuf v1.27.1/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc= google.golang.org/protobuf v1.28.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I= -google.golang.org/protobuf v1.29.1 h1:7QBf+IK2gx70Ap/hDsOmam3GE0v9HicjfEdAxE62UoM= -google.golang.org/protobuf v1.29.1/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I= +google.golang.org/protobuf v1.31.0 h1:g0LDEJHgrBl9N9r17Ru3sqWhkIx2NB67okBHPwC7hs8= +google.golang.org/protobuf v1.31.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I= gopkg.in/alecthomas/kingpin.v2 v2.2.6/go.mod h1:FMv+mEhP44yOT+4EoQTLFTRgOQ1FBLkstjWtayDeSgw= gopkg.in/asn1-ber.v1 v1.0.0-20181015200546-f715ec2f112d/go.mod h1:cuepJuh7vyXfUyUwEgHQXw849cJrilpS5NeIjOWESAw= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= @@ -2203,7 +2279,6 @@ gopkg.in/square/go-jose.v2 v2.3.1/go.mod h1:M9dMgbHiYLoDGQrXy7OpJDJWiKiU//h+vD76 gopkg.in/square/go-jose.v2 v2.4.1/go.mod h1:M9dMgbHiYLoDGQrXy7OpJDJWiKiU//h+vD76mk0e1AI= gopkg.in/square/go-jose.v2 v2.5.1/go.mod h1:M9dMgbHiYLoDGQrXy7OpJDJWiKiU//h+vD76mk0e1AI= gopkg.in/square/go-jose.v2 v2.6.0 h1:NGk74WTnPKBNUhNzQX7PYcTLUjoq7mzKk2OKbvwk2iI= -gopkg.in/square/go-jose.v2 v2.6.0/go.mod h1:M9dMgbHiYLoDGQrXy7OpJDJWiKiU//h+vD76mk0e1AI= gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7 h1:uRGJdciOHaEIrze2W8Q3AKkepLTh2hOroT7a+7czfdQ= gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7/go.mod h1:dt/ZhP58zS4L8KSrWDmTeBkI65Dw0HsyUHuEVlX15mw= gopkg.in/warnings.v0 v0.1.2 h1:wFXVbFY8DY5/xOe1ECiWdKCzZlxgshcYVNkBHstARME= diff --git a/ibm/acctest/acctest.go b/ibm/acctest/acctest.go index 03f2d507f4..7032d767e4 100644 --- a/ibm/acctest/acctest.go +++ b/ibm/acctest/acctest.go @@ -14,259 +14,298 @@ import ( "github.com/IBM-Cloud/terraform-provider-ibm/ibm/provider" ) -var AppIDTenantID string -var AppIDTestUserEmail string -var BackupPolicyJobID string -var BackupPolicyID string -var CfOrganization string -var CfSpace string -var CisDomainStatic string -var CisDomainTest string -var CisInstance string -var CisResourceGroup string -var CloudShellAccountID string -var CosCRN string -var BucketCRN string -var BucketName string -var CosName string -var Ibmid1 string -var Ibmid2 string -var IAMUser string -var IAMAccountId string -var IAMServiceId string -var IAMTrustedProfileID string -var Datacenter string -var MachineType string -var trustedMachineType string -var PublicVlanID string -var PrivateVlanID string -var PrivateSubnetID string -var PublicSubnetID string -var SubnetID string -var LbaasDatacenter string -var LbaasSubnetId string -var LbListerenerCertificateInstance string -var IpsecDatacenter string -var Customersubnetid string -var Customerpeerip string -var DedicatedHostName string -var DedicatedHostID string -var KubeVersion string -var KubeUpdateVersion string -var Zone string -var ZonePrivateVlan string -var ZonePublicVlan string -var ZoneUpdatePrivateVlan string -var ZoneUpdatePublicVlan string -var WorkerPoolSecondaryStorage string -var CsRegion string -var ExtendedHardwareTesting bool -var err error -var placementGroupName string -var CertCRN string -var UpdatedCertCRN string -var SecretCRN string -var SecretCRN2 string -var InstanceCRN string -var SecretGroupID string -var RegionName string -var ISZoneName string -var ISZoneName2 string -var ISZoneName3 string -var IsResourceGroupID string -var ISCIDR string -var ISCIDR2 string -var ISPublicSSHKeyFilePath string -var ISPrivateSSHKeyFilePath string -var ISAddressPrefixCIDR string -var InstanceName string -var InstanceProfileName string -var InstanceProfileNameUpdate string -var IsBareMetalServerProfileName string -var IsBareMetalServerImage string -var DNSInstanceCRN string -var DNSZoneID string -var DNSInstanceCRN1 string -var DNSZoneID1 string -var DedicatedHostProfileName string -var DedicatedHostGroupID string -var InstanceDiskProfileName string -var DedicatedHostGroupFamily string -var DedicatedHostGroupClass string -var ShareProfileName string -var VNIId string -var VolumeProfileName string -var VSIUnattachedBootVolumeID string -var VSIDataVolumeID string -var ISRouteDestination string -var ISRouteNextHop string -var ISSnapshotCRN string -var WorkspaceID string -var TemplateID string -var ActionID string -var JobID string -var RepoURL string -var RepoBranch string -var imageName string -var functionNamespace string -var HpcsInstanceID string +var ( + AppIDTenantID string + AppIDTestUserEmail string + BackupPolicyJobID string + BackupPolicyID string + CfOrganization string + CfSpace string + CisDomainStatic string + CisDomainTest string + CisInstance string + CisResourceGroup string + CloudShellAccountID string + CosCRN string + BucketCRN string + BucketName string + CosName string + Ibmid1 string + Ibmid2 string + IAMUser string + IAMAccountId string + IAMServiceId string + IAMTrustedProfileID string + Datacenter string + MachineType string + trustedMachineType string + PublicVlanID string + PrivateVlanID string + PrivateSubnetID string + PublicSubnetID string + SubnetID string + LbaasDatacenter string + LbaasSubnetId string + LbListerenerCertificateInstance string + IpsecDatacenter string + Customersubnetid string + Customerpeerip string + DedicatedHostName string + DedicatedHostID string + KubeVersion string + KubeUpdateVersion string + Zone string + ZonePrivateVlan string + ZonePublicVlan string + ZoneUpdatePrivateVlan string + ZoneUpdatePublicVlan string + WorkerPoolSecondaryStorage string + CsRegion string + ExtendedHardwareTesting bool + err error + placementGroupName string + CertCRN string + UpdatedCertCRN string + SecretCRN string + SecretCRN2 string + InstanceCRN string + SecretGroupID string + RegionName string + ISZoneName string + ISZoneName2 string + ISZoneName3 string + IsResourceGroupID string + ISCIDR string + ISCIDR2 string + ISPublicSSHKeyFilePath string + ISPrivateSSHKeyFilePath string + ISAddressPrefixCIDR string + InstanceName string + InstanceProfileName string + InstanceProfileNameUpdate string + IsBareMetalServerProfileName string + IsBareMetalServerImage string + DNSInstanceCRN string + DNSZoneID string + DNSInstanceCRN1 string + DNSZoneID1 string + DedicatedHostProfileName string + DedicatedHostGroupID string + InstanceDiskProfileName string + DedicatedHostGroupFamily string + DedicatedHostGroupClass string + ShareProfileName string + VNIId string + VolumeProfileName string + VSIUnattachedBootVolumeID string + VSIDataVolumeID string + ISRouteDestination string + ISRouteNextHop string + ISSnapshotCRN string + WorkspaceID string + TemplateID string + ActionID string + JobID string + RepoURL string + RepoBranch string + imageName string + functionNamespace string + HpcsInstanceID string +) // Secrets Manager -var SecretsManagerInstanceID string -var SecretsManagerInstanceRegion string -var SecretsManagerENInstanceCrn string -var SecretsManagerIamCredentialsConfigurationApiKey string -var SecretsManagerIamCredentialsSecretServiceId string -var SecretsManagerIamCredentialsSecretServiceAccessGroup string -var SecretsManagerPublicCertificateLetsEncryptEnvironment string -var SecretsManagerPublicCertificateLetsEncryptPrivateKey string -var SecretsManagerPublicCertificateCisCrn string -var SecretsManagerPublicCertificateClassicInfrastructureUsername string -var SecretsManagerPublicCertificateClassicInfrastructurePassword string -var SecretsManagerPublicCertificateCommonName string -var SecretsManagerValidateManualDnsCisZoneId string -var SecretsManagerImportedCertificatePathToCertificate string -var SecretsManagerSecretType string -var SecretsManagerSecretID string - -var HpcsAdmin1 string -var HpcsToken1 string -var HpcsAdmin2 string -var HpcsToken2 string -var HpcsRootKeyCrn string -var RealmName string -var IksSa string -var IksClusterID string -var IksClusterVpcID string -var IksClusterSubnetID string -var IksClusterResourceGroupID string -var IcdDbRegion string -var IcdDbDeploymentId string -var IcdDbBackupId string -var IcdDbTaskId string -var KmsInstanceID string -var CrkID string -var KmsAccountID string -var BaasEncryptionkeyCRN string +var ( + SecretsManagerInstanceID string + SecretsManagerInstanceRegion string + SecretsManagerENInstanceCrn string + SecretsManagerIamCredentialsConfigurationApiKey string + SecretsManagerIamCredentialsSecretServiceId string + SecretsManagerIamCredentialsSecretServiceAccessGroup string + SecretsManagerPublicCertificateLetsEncryptEnvironment string + SecretsManagerPublicCertificateLetsEncryptPrivateKey string + SecretsManagerPublicCertificateCisCrn string + SecretsManagerPublicCertificateClassicInfrastructureUsername string + SecretsManagerPublicCertificateClassicInfrastructurePassword string + SecretsManagerPublicCertificateCommonName string + SecretsManagerValidateManualDnsCisZoneId string + SecretsManagerImportedCertificatePathToCertificate string + SecretsManagerSecretType string + SecretsManagerSecretID string +) + +var ( + HpcsAdmin1 string + HpcsToken1 string + HpcsAdmin2 string + HpcsToken2 string + HpcsRootKeyCrn string + RealmName string + IksSa string + IksClusterID string + IksClusterVpcID string + IksClusterSubnetID string + IksClusterResourceGroupID string + IcdDbRegion string + IcdDbDeploymentId string + IcdDbBackupId string + IcdDbTaskId string + KmsInstanceID string + CrkID string + KmsAccountID string + BaasEncryptionkeyCRN string +) // for snapshot encryption -var IsKMSInstanceId string -var IsKMSKeyName string +var ( + IsKMSInstanceId string + IsKMSKeyName string +) // For Power Colo -var Pi_image string -var Pi_sap_image string -var Pi_image_bucket_name string -var Pi_image_bucket_file_name string -var Pi_image_bucket_access_key string -var Pi_image_bucket_secret_key string -var Pi_image_bucket_region string -var Pi_key_name string -var Pi_volume_name string -var Pi_volume_id string -var Pi_replication_volume_name string -var Pi_volume_onboarding_source_crn string -var Pi_auxiliary_volume_name string -var Pi_volume_group_name string -var Pi_volume_group_id string -var Pi_volume_onboarding_id string -var Pi_network_name string -var Pi_cloud_instance_id string -var Pi_instance_name string -var Pi_dhcp_id string -var PiCloudConnectionName string -var PiSAPProfileID string -var Pi_placement_group_name string -var Pi_spp_placement_group_id string -var PiStoragePool string -var PiStorageType string -var Pi_shared_processor_pool_id string - -var Pi_capture_storage_image_path string -var Pi_capture_cloud_storage_access_key string -var Pi_capture_cloud_storage_secret_key string +var ( + Pi_image string + Pi_sap_image string + Pi_image_bucket_name string + Pi_image_bucket_file_name string + Pi_image_bucket_access_key string + Pi_image_bucket_secret_key string + Pi_image_bucket_region string + Pi_key_name string + Pi_volume_name string + Pi_volume_id string + Pi_replication_volume_name string + Pi_volume_onboarding_source_crn string + Pi_auxiliary_volume_name string + Pi_volume_group_name string + Pi_volume_group_id string + Pi_volume_onboarding_id string + Pi_network_name string + Pi_cloud_instance_id string + Pi_instance_name string + Pi_dhcp_id string + PiCloudConnectionName string + PiSAPProfileID string + Pi_placement_group_name string + Pi_spp_placement_group_id string + PiStoragePool string + PiStorageType string + Pi_shared_processor_pool_id string +) + +var ( + Pi_capture_storage_image_path string + Pi_capture_cloud_storage_access_key string + Pi_capture_cloud_storage_secret_key string +) + +var ISDelegegatedVPC string // For Image -var IsImageName string -var IsImage string -var IsImageEncryptedDataKey string -var IsImageEncryptionKey string -var IsWinImage string -var IsCosBucketName string -var IsCosBucketCRN string -var Image_cos_url string -var Image_cos_url_encrypted string -var Image_operating_system string +var ( + IsImageName string + IsImage string + IsImageEncryptedDataKey string + IsImageEncryptionKey string + IsWinImage string + IsCosBucketName string + IsCosBucketCRN string + Image_cos_url string + Image_cos_url_encrypted string + Image_operating_system string +) // Transit Gateway Power Virtual Server var Tg_power_vs_network_id string // Transit Gateway cross account -var Tg_cross_network_account_id string -var Tg_cross_network_account_api_key string -var Tg_cross_network_id string +var ( + Tg_cross_network_account_id string + Tg_cross_network_account_api_key string + Tg_cross_network_id string +) // Enterprise Management var Account_to_be_imported string +// Billing Snapshot Configuration +var Cos_bucket string +var Cos_location string +var Cos_bucket_update string +var Cos_location_update string +var Cos_reports_folder string +var Snapshot_date_from string +var Snapshot_date_to string +var Snapshot_month string + // Secuity and Complinace Center -var SccApiEndpoint string -var SccProviderTypeAttributes string -var SccReportId string +var ( + SccApiEndpoint string + SccProviderTypeAttributes string + SccReportID string + SccInstanceID string +) // ROKS Cluster var ClusterName string // Satellite instance -var Satellite_location_id string -var Satellite_Resource_instance_id string +var ( + Satellite_location_id string + Satellite_Resource_instance_id string +) // Dedicated host var HostPoolID string // Continuous Delivery -var CdResourceGroupName string -var CdAppConfigInstanceName string -var CdKeyProtectInstanceName string -var CdSecretsManagerInstanceName string -var CdSlackChannelName string -var CdSlackTeamName string -var CdSlackWebhook string -var CdJiraProjectKey string -var CdJiraApiUrl string -var CdJiraUsername string -var CdJiraApiToken string -var CdSaucelabsAccessKey string -var CdSaucelabsUsername string -var CdBitbucketRepoUrl string -var CdGithubConsolidatedRepoUrl string -var CdGitlabRepoUrl string -var CdHostedGitRepoUrl string -var CdEventNotificationsInstanceName string +var ( + CdResourceGroupName string + CdAppConfigInstanceName string + CdKeyProtectInstanceName string + CdSecretsManagerInstanceName string + CdSlackChannelName string + CdSlackTeamName string + CdSlackWebhook string + CdJiraProjectKey string + CdJiraApiUrl string + CdJiraUsername string + CdJiraApiToken string + CdSaucelabsAccessKey string + CdSaucelabsUsername string + CdBitbucketRepoUrl string + CdGithubConsolidatedRepoUrl string + CdGitlabRepoUrl string + CdHostedGitRepoUrl string + CdEventNotificationsInstanceName string +) // VPN Server -var ISCertificateCrn string -var ISClientCaCrn string +var ( + ISCertificateCrn string + ISClientCaCrn string +) // COS Replication Bucket var IBM_AccountID_REPL string // Atracker -var IesApiKey string -var IngestionKey string -var COSApiKey string +var ( + IesApiKey string + IngestionKey string + COSApiKey string +) // For Code Engine - -var CeResourceGroupID string -var CeProjectId string -var CeServiceInstanceID string -var CeResourceKeyID string +var ( + CeResourceGroupID string + CeProjectId string + CeServiceInstanceID string + CeResourceKeyID string +) // for IAM Identity - var IamIdentityAssignmentTargetAccountId string func init() { @@ -625,14 +664,14 @@ func init() { IsImage = os.Getenv("IS_IMAGE") if IsImage == "" { - //IsImage = "fc538f61-7dd6-4408-978c-c6b85b69fe76" // for classic infrastructure + // IsImage = "fc538f61-7dd6-4408-978c-c6b85b69fe76" // for classic infrastructure IsImage = "r006-907911a7-0ffe-467e-8821-3cc9a0d82a39" // for next gen infrastructure ibm-centos-7-9-minimal-amd64-10 image fmt.Println("[INFO] Set the environment variable IS_IMAGE for testing ibm_is_instance, ibm_is_floating_ip else it is set to default value 'r006-907911a7-0ffe-467e-8821-3cc9a0d82a39'") } IsWinImage = os.Getenv("IS_WIN_IMAGE") if IsWinImage == "" { - //IsWinImage = "a7a0626c-f97e-4180-afbe-0331ec62f32a" // classic windows machine: ibm-windows-server-2012-full-standard-amd64-1 + // IsWinImage = "a7a0626c-f97e-4180-afbe-0331ec62f32a" // classic windows machine: ibm-windows-server-2012-full-standard-amd64-1 IsWinImage = "r006-d2e0d0e9-0a4f-4c45-afd7-cab787030776" // next gen windows machine: ibm-windows-server-2022-full-standard-amd64-8 fmt.Println("[INFO] Set the environment variable IS_WIN_IMAGE for testing ibm_is_instance data source else it is set to default value 'r006-d2e0d0e9-0a4f-4c45-afd7-cab787030776'") } @@ -673,7 +712,7 @@ func init() { InstanceProfileName = os.Getenv("SL_INSTANCE_PROFILE") if InstanceProfileName == "" { - //InstanceProfileName = "bc1-2x8" // for classic infrastructure + // InstanceProfileName = "bc1-2x8" // for classic infrastructure InstanceProfileName = "cx2-2x4" // for next gen infrastructure fmt.Println("[INFO] Set the environment variable SL_INSTANCE_PROFILE for testing ibm_is_instance resource else it is set to default value 'cx2-2x4'") } @@ -764,7 +803,7 @@ func init() { InstanceDiskProfileName = os.Getenv("IS_INSTANCE_DISK_PROFILE") if InstanceDiskProfileName == "" { - //InstanceProfileName = "bc1-2x8" // for classic infrastructure + // InstanceProfileName = "bc1-2x8" // for classic infrastructure InstanceDiskProfileName = "bx2d-16x64" // for next gen infrastructure fmt.Println("[INFO] Set the environment variable SL_INSTANCE_PROFILE for testing ibm_is_instance resource else it is set to default value 'bx2d-16x64'") } @@ -1042,6 +1081,11 @@ func init() { fmt.Println("[WARN] Set the environment variable IMAGE_COS_URL with a VALID COS Image SQL URL for testing ibm_is_image resources on staging/test") } + ISDelegegatedVPC = os.Getenv("IS_DELEGATED_VPC") + if ISDelegegatedVPC == "" { + ISDelegegatedVPC = "tfp-test-vpc-hub-false-del" + fmt.Println("[WARN] Set the environment variable IS_DELEGATED_VPC with a VALID created vpc name for testing ibm_is_vpc data source on staging/test") + } // Added for resource image testing Image_cos_url_encrypted = os.Getenv("IMAGE_COS_URL_ENCRYPTED") if Image_cos_url_encrypted == "" { @@ -1056,7 +1100,7 @@ func init() { IsImageName = os.Getenv("IS_IMAGE_NAME") if IsImageName == "" { - //IsImageName = "ibm-ubuntu-18-04-2-minimal-amd64-1" // for classic infrastructure + // IsImageName = "ibm-ubuntu-18-04-2-minimal-amd64-1" // for classic infrastructure IsImageName = "ibm-ubuntu-22-04-1-minimal-amd64-4" // for next gen infrastructure fmt.Println("[INFO] Set the environment variable IS_IMAGE_NAME for testing data source ibm_is_image else it is set to default value `ibm-ubuntu-18-04-1-minimal-amd64-2`") } @@ -1182,6 +1226,38 @@ func init() { if Account_to_be_imported == "" { fmt.Println("[INFO] Set the environment variable ACCOUNT_TO_BE_IMPORTED for testing import enterprise account resource else tests will fail if this is not set correctly") } + Cos_bucket = os.Getenv("COS_BUCKET") + if Cos_bucket == "" { + fmt.Println("[INFO] Set the environment variable COS_BUCKET for testing CRUD operations on billing snapshot configuration APIs") + } + Cos_location = os.Getenv("COS_LOCATION") + if Cos_location == "" { + fmt.Println("[INFO] Set the environment variable COS_LOCATION for testing CRUD operations on billing snapshot configuration APIs") + } + Cos_bucket_update = os.Getenv("COS_BUCKET_UPDATE") + if Cos_bucket_update == "" { + fmt.Println("[INFO] Set the environment variable COS_BUCKET_UPDATE for testing update operation on billing snapshot configuration API") + } + Cos_location_update = os.Getenv("COS_LOCATION_UPDATE") + if Cos_location_update == "" { + fmt.Println("[INFO] Set the environment variable COS_LOCATION_UPDATE for testing update operation on billing snapshot configuration API") + } + Cos_reports_folder = os.Getenv("COS_REPORTS_FOLDER") + if Cos_reports_folder == "" { + fmt.Println("[INFO] Set the environment variable COS_REPORTS_FOLDER for testing CRUD operations on billing snapshot configuration APIs") + } + Snapshot_date_from = os.Getenv("SNAPSHOT_DATE_FROM") + if Snapshot_date_from == "" { + fmt.Println("[INFO] Set the environment variable SNAPSHOT_DATE_FROM for testing CRUD operations on billing snapshot configuration APIs") + } + Snapshot_date_to = os.Getenv("SNAPSHOT_DATE_TO") + if Snapshot_date_to == "" { + fmt.Println("[INFO] Set the environment variable SNAPSHOT_DATE_TO for testing CRUD operations on billing snapshot configuration APIs") + } + Snapshot_month = os.Getenv("SNAPSHOT_MONTH") + if Snapshot_month == "" { + fmt.Println("[INFO] Set the environment variable SNAPSHOT_MONTH for testing CRUD operations on billing snapshot configuration APIs") + } HpcsAdmin1 = os.Getenv("IBM_HPCS_ADMIN1") if HpcsAdmin1 == "" { fmt.Println("[WARN] Set the environment variable IBM_HPCS_ADMIN1 with a VALID HPCS Admin Key1 Path") @@ -1213,21 +1289,6 @@ func init() { fmt.Println("[WARN] Set the environment variable IBM_HPCS_ROOTKEY_CRN with a VALID CRN for a root key created in the HPCS instance") } - SccApiEndpoint = os.Getenv("IBMCLOUD_SCC_API_ENDPOINT") - if SccApiEndpoint == "" { - fmt.Println("[WARN] Set the environment variable IBMCLOUD_SCC_API_ENDPOINT with a VALID endpoint") - } - - SccProviderTypeAttributes = os.Getenv("IBMCLOUD_SCC_PROVIDER_TYPE_ATTRIBUTES") - if SccProviderTypeAttributes == "" { - fmt.Println("[WARN] Set the environment variable IBMCLOUD_SCC_PROVIDER_TYPE_ATTRIBUTES with a VALID ATTRIBUTE") - } - - SccReportId = os.Getenv("IBMCLOUD_SCC_REPORT_ID") - if SccApiEndpoint == "" { - fmt.Println("[WARN] Set the environment variable IBMCLOUD_SCC_REPORT_ID with a VALID REPORT_ID") - } - CloudShellAccountID = os.Getenv("IBM_CLOUD_SHELL_ACCOUNT_ID") if CloudShellAccountID == "" { fmt.Println("[INFO] Set the environment variable IBM_CLOUD_SHELL_ACCOUNT_ID for ibm-cloud-shell resource or datasource else tests will fail if this is not set correctly") @@ -1263,6 +1324,26 @@ func init() { fmt.Println("[INFO] Set the environment variable SATELLITE_RESOURCE_INSTANCE_ID for ibm_cos_bucket satellite location resource or datasource else tests will fail if this is not set correctly") } + SccInstanceID = os.Getenv("IBMCLOUD_SCC_INSTANCE_ID") + if SccInstanceID == "" { + fmt.Println("[WARN] Set the environment variable IBMCLOUD_SCC_INSTANCE_ID with a VALID SCC INSTANCE ID") + } + + SccApiEndpoint = os.Getenv("IBMCLOUD_SCC_API_ENDPOINT") + if SccApiEndpoint == "" { + fmt.Println("[WARN] Set the environment variable IBMCLOUD_SCC_API_ENDPOINT with a VALID SCC API ENDPOINT") + } + + SccReportID = os.Getenv("IBMCLOUD_SCC_REPORT_ID") + if SccReportID == "" { + fmt.Println("[WARN] Set the environment variable IBMCLOUD_SCC_REPORT_ID with a VALID SCC REPORT ID") + } + + SccProviderTypeAttributes = os.Getenv("IBMCLOUD_SCC_PROVIDER_TYPE_ATTRIBUTES") + if SccProviderTypeAttributes == "" { + fmt.Println("[WARN] Set the environment variable IBMCLOUD_SCC_PROVIDER_TYPE_ATTRIBUTES with a VALID SCC PROVIDER TYPE ATTRIBUTE") + } + HostPoolID = os.Getenv("IBM_CONTAINER_DEDICATEDHOST_POOL_ID") if HostPoolID == "" { fmt.Println("[INFO] Set the environment variable IBM_CONTAINER_DEDICATEDHOST_POOL_ID for ibm_container_vpc_cluster resource to test dedicated host functionality") @@ -1428,11 +1509,12 @@ func init() { CeResourceKeyID = "" fmt.Println("[WARN] Set the environment variable IBM_CODE_ENGINE_RESOURCE_KEY_ID with the ID of a resource key to access a service instance") } - } -var TestAccProviders map[string]*schema.Provider -var TestAccProvider *schema.Provider +var ( + TestAccProviders map[string]*schema.Provider + TestAccProvider *schema.Provider +) func init() { TestAccProvider = provider.Provider() @@ -1482,8 +1564,8 @@ func TestAccPreCheckEnterpriseAccountImport(t *testing.T) { if Account_to_be_imported == "" { t.Fatal("ACCOUNT_TO_BE_IMPORTED must be set for acceptance tests") } - } + func TestAccPreCheckCis(t *testing.T) { TestAccPreCheck(t) if CisInstance == "" { @@ -1522,6 +1604,7 @@ func TestAccPreCheckHPCS(t *testing.T) { t.Fatal("IBM_HPCS_TOKEN2 must be set for acceptance tests") } } + func TestAccPreCheckIAMTrustedProfile(t *testing.T) { TestAccPreCheck(t) if RealmName == "" { @@ -1548,6 +1631,7 @@ func TestAccPreCheckImage(t *testing.T) { t.Fatal("IMAGE_OPERATING_SYSTEM must be set for acceptance tests") } } + func TestAccPreCheckEncryptedImage(t *testing.T) { TestAccPreCheck(t) if Image_cos_url_encrypted == "" { @@ -1573,3 +1657,28 @@ func TestAccPreCheckCodeEngine(t *testing.T) { t.Fatal("IBM_CODE_ENGINE_PROJECT_INSTANCE_ID must be set for acceptance tests") } } + +func TestAccPreCheckUsage(t *testing.T) { + if v := os.Getenv("IC_API_KEY"); v == "" { + t.Fatal("IC_API_KEY must be set for acceptance tests") + } +} + +func TestAccPreCheckScc(t *testing.T) { + TestAccPreCheck(t) + if SccApiEndpoint == "" { + t.Fatal("IBMCLOUD_SCC_API_ENDPOINT missing. Set the environment variable IBMCLOUD_SCC_API_ENDPOINT with a VALID endpoint") + } + + if SccProviderTypeAttributes == "" { + t.Fatal("IBMCLOUD_SCC_PROVIDER_TYPE_ATTRIBUTES missing. Set the environment variable IBMCLOUD_SCC_PROVIDER_TYPE_ATTRIBUTES with a VALID ATTRIBUTE") + } + + if SccInstanceID == "" { + t.Fatal("IBMCLOUD_SCC_INSTANCE_ID missing. Set the environment variable IBMCLOUD_SCC_INSTANCE_ID with a VALID SCC INSTANCE ID") + } + + if SccReportID == "" { + t.Fatal("IBMCLOUD_SCC_REPORT_ID missing. Set the environment variable IBMCLOUD_SCC_REPORT_ID with a VALID REPORT_ID") + } +} diff --git a/ibm/conns/config.go b/ibm/conns/config.go index a8fefc5e46..ff89bd307f 100644 --- a/ibm/conns/config.go +++ b/ibm/conns/config.go @@ -77,6 +77,7 @@ import ( "github.com/IBM/platform-services-go-sdk/metricsrouterv3" resourcecontroller "github.com/IBM/platform-services-go-sdk/resourcecontrollerv2" resourcemanager "github.com/IBM/platform-services-go-sdk/resourcemanagerv2" + "github.com/IBM/platform-services-go-sdk/usagereportsv4" project "github.com/IBM/project-go-sdk/projectv1" "github.com/IBM/push-notifications-go-sdk/pushservicev1" schematicsv1 "github.com/IBM/schematics-go-sdk/schematicsv1" @@ -297,6 +298,7 @@ type ClientSession interface { CdTektonPipelineV2() (*cdtektonpipelinev2.CdTektonPipelineV2, error) CodeEngineV2() (*codeengine.CodeEngineV2, error) ProjectV1() (*project.ProjectV1, error) + UsageReportsV4() (*usagereportsv4.UsageReportsV4, error) } type clientSession struct { @@ -618,6 +620,15 @@ type clientSession struct { // Project options projectClient *project.ProjectV1 projectClientErr error + + // Usage Reports options + usageReportsClient *usagereportsv4.UsageReportsV4 + usageReportsClientErr error +} + +// Usage Reports +func (session clientSession) UsageReportsV4() (*usagereportsv4.UsageReportsV4, error) { + return session.usageReportsClient, session.usageReportsClientErr } // AppIDAPI provides AppID Service APIs ... @@ -1604,6 +1615,43 @@ func (c *Config) ClientSession() (interface{}, error) { session.contextBasedRestrictionsClientErr = fmt.Errorf("[ERROR] Error occurred while configuring Context Based Restrictions service: %q", err) } + // // Usage Reports Service Client + usageReportsURL := usagereportsv4.DefaultServiceURL + if c.Visibility == "private" { + if c.Region == "us-south" || c.Region == "us-east" { + usageReportsURL = ContructEndpoint(fmt.Sprintf("private.%s.usagereports", c.Region), fmt.Sprintf("%s/v1", cloudEndpoint)) + } else { + fmt.Println("Private Endpint supports only us-south and us-east region specific endpoint") + usageReportsURL = ContructEndpoint("private.us-south.usagereports", fmt.Sprintf("%s/v1", cloudEndpoint)) + } + } + if c.Visibility == "public-and-private" { + if c.Region == "us-south" || c.Region == "us-east" { + usageReportsURL = ContructEndpoint(fmt.Sprintf("private.%s.usagereports", c.Region), + fmt.Sprintf("%s/v1", cloudEndpoint)) + } else { + usageReportsURL = usagereportsv4.DefaultServiceURL + } + } + if fileMap != nil && c.Visibility != "public-and-private" { + usageReportsURL = fileFallBack(fileMap, c.Visibility, "IBMCLOUD_USAGE_REPORTS_API_ENDPOINT", c.Region, usageReportsURL) + } + usageReportsClientOptions := &usagereportsv4.UsageReportsV4Options{ + Authenticator: authenticator, + URL: EnvFallBack([]string{"IBMCLOUD_USAGE_REPORTS_API_ENDPOINT"}, usageReportsURL), + } + usageReportsClient, err := usagereportsv4.NewUsageReportsV4(usageReportsClientOptions) + if err != nil { + session.usageReportsClientErr = fmt.Errorf("[ERROR] Error occurred while configuring IBM Cloud Usage Reports API service: %q", err) + } + if usageReportsClient != nil && usageReportsClient.Service != nil { + usageReportsClient.Service.EnableRetries(c.RetryCount, c.RetryDelay) + usageReportsClient.SetDefaultHeaders(gohttp.Header{ + "X-Original-User-Agent": {fmt.Sprintf("terraform-provider-ibm/%s", version.Version)}, + }) + } + session.usageReportsClient = usageReportsClient + // CATALOG MANAGEMENT Service catalogManagementURL := "https://cm.globalcatalog.cloud.ibm.com/api/v1-beta" if c.Visibility == "private" { @@ -1705,10 +1753,12 @@ func (c *Config) ClientSession() (interface{}, error) { session.metricsRouterClientErr = fmt.Errorf("Error occurred while configuring Metrics Router API Version 3 service: %q", err) } - // SCC Service + // SCC (Security and Compliance Center) Service sccApiClientURL := scc.DefaultServiceURL // Construct the service options. - + if regionURL, sccRegionErr := scc.GetServiceURLForRegion(c.Region); sccRegionErr == nil { + sccApiClientURL = regionURL + } sccApiClientOptions := &scc.SecurityAndComplianceCenterApiV3Options{ Authenticator: authenticator, URL: EnvFallBack([]string{"IBMCLOUD_SCC_API_ENDPOINT"}, sccApiClientURL), @@ -1724,7 +1774,7 @@ func (c *Config) ClientSession() (interface{}, error) { "X-Original-User-Agent": {fmt.Sprintf("terraform-provider-ibm/%s", version.Version)}, }) } else { - session.securityAndComplianceCenterClientErr = fmt.Errorf("Error occurred while configuring Config Manager service: %q", err) + session.securityAndComplianceCenterClientErr = fmt.Errorf("Error occurred while configuring Security And Compliance Center service: %q", err) } // SCHEMATICS Service diff --git a/ibm/flex/structures.go b/ibm/flex/structures.go index 05596d16b6..5f89a520a6 100644 --- a/ibm/flex/structures.go +++ b/ibm/flex/structures.go @@ -2718,131 +2718,6 @@ func ResourceIBMISLBPoolCookieValidate(diff *schema.ResourceDiff) error { return nil } -func ResourceSharesValidate(diff *schema.ResourceDiff) error { - err := ResourceSharesValidateHelper(diff, "size", "profile", "iops") - if err != nil { - return err - } - if _, ok := diff.GetOk("replica_share"); ok { - err := ResourceSharesValidateHelper(diff, "replica_share.0.size", "replica_share.0.profile", "replica_share.0.iops") - if err != nil { - return err - } - } - return nil -} -func ResourceSharesValidateHelper(diff *schema.ResourceDiff, sizeStr, profileStr, iopsStr string) error { - - profile := "" - var size, iops int - - if iopsIntf, ok := diff.GetOk(iopsStr); ok { - iops = iopsIntf.(int) - } - if profileIntf, ok := diff.GetOk(profileStr); ok { - profile = profileIntf.(string) - } - if diff.HasChange(sizeStr) && !diff.HasChange(profileStr) { - oldSize, newSize := diff.GetChange(sizeStr) - if newSize.(int) < oldSize.(int) { - return fmt.Errorf("The new share size '%d' must be greater than the current share size '%d'", newSize.(int), oldSize.(int)) - } - } - - if sizeIntf, ok := diff.GetOk(sizeStr); ok { - size = sizeIntf.(int) - if profile == "tier-5iops" && size > 9600 { - return fmt.Errorf("'%s' shares cannot have size more than %d.", profile, 9600) - } else if profile == "tier-10iops" && size > 4800 { - return fmt.Errorf("'%s' shares cannot have size more than %d.", profile, 4800) - } else if profile == "custom-iops" && size > 16000 { - return fmt.Errorf("'%s' shares cannot have size more than %d.", profile, 16000) - } - } - - if profile != "custom-iops" && profile != "dp2" { - if iops != 0 && diff.NewValueKnown(iopsStr) && diff.HasChange(iopsStr) { - return fmt.Errorf("The Share profile specified in the request cannot accept IOPS values") - } - } else { - if iops == 0 { - return nil - } - if size >= 10 && size <= 39 { - min := 100 - max := 1000 - if !(iops >= min && iops <= max) { - return fmt.Errorf("Shares Error: Allowed iops range for size %d is [%d-%d] ", size, min, max) - } - } - if size >= 40 && size <= 79 { - min := 100 - max := 2000 - if !(iops >= min && iops <= max) { - return fmt.Errorf("Shares Error: Allowed iops range for size %d is [%d-%d] ", size, min, max) - } - } - if size >= 80 && size <= 99 { - min := 100 - max := 4000 - if !(iops >= min && iops <= max) { - return fmt.Errorf("Shares Error: Allowed iops range for size %d is [%d-%d] ", size, min, max) - } - } - if size >= 100 && size <= 499 { - min := 100 - max := 6000 - if !(iops >= min && iops <= max) { - return fmt.Errorf("Shares Error: Allowed iops range for size %d is [%d-%d] ", size, min, max) - } - } - if size >= 500 && size <= 999 { - min := 100 - max := 10000 - if !(iops >= min && iops <= max) { - return fmt.Errorf("Shares Error: Allowed iops range for size %d is [%d-%d] ", size, min, max) - } - } - if size >= 1000 && size <= 1999 { - min := 100 - max := 20000 - if !(iops >= min && iops <= max) { - return fmt.Errorf("Shares Error: Allowed iops range for size %d is [%d-%d] ", size, min, max) - } - } - if size >= 2000 && size <= 3999 { - min := 200 - max := 40000 - if !(iops >= min && iops <= max) { - return fmt.Errorf("Shares Error: Allowed iops range for size %d is [%d-%d] ", size, min, max) - } - } - if size >= 4000 && size <= 7999 { - min := 300 - max := 40000 - if !(iops >= min && iops <= max) { - return fmt.Errorf("Shares Error: Allowed iops range for size %d is [%d-%d] ", size, min, max) - } - } - if size >= 8000 && size <= 9999 { - min := 500 - max := 48000 - if !(iops >= min && iops <= max) { - return fmt.Errorf("Shares Error: Allowed iops range for size %d is [%d-%d] ", size, min, max) - } - } - if size >= 10000 && size <= 16000 { - min := 1000 - max := 48000 - if !(iops >= min && iops <= max) { - return fmt.Errorf("Shares Error: Allowed iops range for size %d is [%d-%d] ", size, min, max) - } - } - } - - return nil -} - func ResourceVolumeAttachmentValidate(diff *schema.ResourceDiff) error { if volsintf, ok := diff.GetOk("volume_attachments"); ok { @@ -2871,22 +2746,6 @@ func ResourceVolumeAttachmentValidate(diff *schema.ResourceDiff) error { return nil } -func InstanceProfileValidate(diff *schema.ResourceDiff) error { - if diff.Id() != "" && diff.HasChange("profile") { - o, n := diff.GetChange("profile") - old := o.(string) - new := n.(string) - log.Println("old profile : ", old) - log.Println("new profile : ", new) - if !strings.Contains(old, "d") && strings.Contains(new, "d") { - diff.ForceNew("profile") - } else if strings.Contains(old, "d") && !strings.Contains(new, "d") { - diff.ForceNew("profile") - } - } - return nil -} - func ResourceIPSecPolicyValidate(diff *schema.ResourceDiff) error { newEncAlgo := diff.Get("encryption_algorithm").(string) diff --git a/ibm/provider/provider.go b/ibm/provider/provider.go index e8fc58fe0b..49f8308306 100644 --- a/ibm/provider/provider.go +++ b/ibm/provider/provider.go @@ -50,6 +50,7 @@ import ( "github.com/IBM-Cloud/terraform-provider-ibm/ibm/service/schematics" "github.com/IBM-Cloud/terraform-provider-ibm/ibm/service/secretsmanager" "github.com/IBM-Cloud/terraform-provider-ibm/ibm/service/transitgateway" + "github.com/IBM-Cloud/terraform-provider-ibm/ibm/service/usagereports" "github.com/IBM-Cloud/terraform-provider-ibm/ibm/service/vpc" "github.com/IBM-Cloud/terraform-provider-ibm/ibm/validate" "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" @@ -498,6 +499,8 @@ func Provider() *schema.Provider { "ibm_is_volume_profile": vpc.DataSourceIBMISVolumeProfile(), "ibm_is_volume_profiles": vpc.DataSourceIBMISVolumeProfiles(), "ibm_is_vpc": vpc.DataSourceIBMISVPC(), + "ibm_is_vpc_dns_resolution_binding": vpc.DataSourceIBMIsVPCDnsResolutionBinding(), + "ibm_is_vpc_dns_resolution_bindings": vpc.DataSourceIBMIsVPCDnsResolutionBindings(), "ibm_is_vpcs": vpc.DataSourceIBMISVPCs(), "ibm_is_vpn_gateway": vpc.DataSourceIBMISVPNGateway(), "ibm_is_vpn_gateways": vpc.DataSourceIBMISVPNGateways(), @@ -662,6 +665,9 @@ func Provider() *schema.Provider { "ibm_enterprise_account_groups": enterprise.DataSourceIBMEnterpriseAccountGroups(), "ibm_enterprise_accounts": enterprise.DataSourceIBMEnterpriseAccounts(), + // //Added for Usage Reports + "ibm_billing_snapshot_list": usagereports.DataSourceIBMBillingSnapshotList(), + // Added for Secrets Manager // V1 data sources: "ibm_secrets_manager_secrets": secretsmanager.DataSourceIBMSecretsManagerSecrets(), @@ -704,8 +710,6 @@ func Provider() *schema.Provider { "ibm_satellite_link": satellite.DataSourceIBMSatelliteLink(), "ibm_satellite_endpoint": satellite.DataSourceIBMSatelliteEndpoint(), "ibm_satellite_cluster_worker_pool_zone_attachment": satellite.DataSourceIBMSatelliteClusterWorkerPoolAttachment(), - "ibm_satellite_storage_configuration": satellite.DataSourceIBMSatelliteStorageConfiguration(), - "ibm_satellite_storage_assignment": satellite.DataSourceIBMSatelliteStorageAssignment(), // Catalog related resources "ibm_cm_catalog": catalogmanagement.DataSourceIBMCmCatalog(), @@ -797,6 +801,7 @@ func Provider() *schema.Provider { // Added for Toolchain "ibm_cd_toolchain": cdtoolchain.DataSourceIBMCdToolchain(), + "ibm_cd_toolchains": cdtoolchain.DataSourceIBMCdToolchains(), "ibm_cd_toolchain_tool_keyprotect": cdtoolchain.DataSourceIBMCdToolchainToolKeyprotect(), "ibm_cd_toolchain_tool_secretsmanager": cdtoolchain.DataSourceIBMCdToolchainToolSecretsmanager(), "ibm_cd_toolchain_tool_bitbucketgit": cdtoolchain.DataSourceIBMCdToolchainToolBitbucketgit(), @@ -1062,6 +1067,7 @@ func Provider() *schema.Provider { "ibm_is_vpn_gateway_connection": vpc.ResourceIBMISVPNGatewayConnection(), "ibm_is_vpc": vpc.ResourceIBMISVPC(), "ibm_is_vpc_address_prefix": vpc.ResourceIBMISVpcAddressPrefix(), + "ibm_is_vpc_dns_resolution_binding": vpc.ResourceIBMIsVPCDnsResolutionBinding(), "ibm_is_vpc_routing_table": vpc.ResourceIBMISVPCRoutingTable(), "ibm_is_vpc_routing_table_route": vpc.ResourceIBMISVPCRoutingTableRoute(), "ibm_is_vpn_server": vpc.ResourceIBMIsVPNServer(), @@ -1190,6 +1196,9 @@ func Provider() *schema.Provider { "ibm_enterprise_account_group": enterprise.ResourceIBMEnterpriseAccountGroup(), "ibm_enterprise_account": enterprise.ResourceIBMEnterpriseAccount(), + // //Added for Usage Reports + "ibm_billing_report_snapshot": usagereports.ResourceIBMBillingReportSnapshot(), + // Added for Schematics "ibm_schematics_workspace": schematics.ResourceIBMSchematicsWorkspace(), "ibm_schematics_action": schematics.ResourceIBMSchematicsAction(), @@ -1224,8 +1233,6 @@ func Provider() *schema.Provider { "ibm_satellite_cluster": satellite.ResourceIBMSatelliteCluster(), "ibm_satellite_cluster_worker_pool": satellite.ResourceIBMSatelliteClusterWorkerPool(), "ibm_satellite_link": satellite.ResourceIBMSatelliteLink(), - "ibm_satellite_storage_configuration": satellite.ResourceIBMSatelliteStorageConfiguration(), - "ibm_satellite_storage_assignment": satellite.ResourceIBMSatelliteStorageAssignment(), "ibm_satellite_endpoint": satellite.ResourceIBMSatelliteEndpoint(), "ibm_satellite_location_nlb_dns": satellite.ResourceIBMSatelliteLocationNlbDns(), "ibm_satellite_cluster_worker_pool_zone_attachment": satellite.ResourceIbmSatelliteClusterWorkerPoolZoneAttachment(), @@ -1574,6 +1581,9 @@ func Validator() validate.ValidatorDict { "ibm_iam_policy_template": iampolicy.ResourceIBMIAMPolicyTemplateValidator(), "ibm_iam_policy_template_version": iampolicy.ResourceIBMIAMPolicyTemplateVersionValidator(), + // // Added for Usage Reports + "ibm_billing_report_snapshot": usagereports.ResourceIBMBillingReportSnapshotValidator(), + // // Added for Secrets Manager "ibm_sm_secret_group": secretsmanager.ResourceIbmSmSecretGroupValidator(), "ibm_sm_en_registration": secretsmanager.ResourceIbmSmEnRegistrationValidator(), diff --git a/ibm/service/cdtoolchain/data_source_ibm_cd_toolchains.go b/ibm/service/cdtoolchain/data_source_ibm_cd_toolchains.go new file mode 100644 index 0000000000..fb27446528 --- /dev/null +++ b/ibm/service/cdtoolchain/data_source_ibm_cd_toolchains.go @@ -0,0 +1,170 @@ +// Copyright IBM Corp. 2023 All Rights Reserved. +// Licensed under the Mozilla Public License v2.0 + +package cdtoolchain + +import ( + "context" + "fmt" + "log" + "time" + + "github.com/hashicorp/terraform-plugin-sdk/v2/diag" + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" + + "github.com/IBM-Cloud/terraform-provider-ibm/ibm/conns" + "github.com/IBM/continuous-delivery-go-sdk/cdtoolchainv2" +) + +func DataSourceIBMCdToolchains() *schema.Resource { + return &schema.Resource{ + ReadContext: dataSourceIBMCdToolchainsRead, + + Schema: map[string]*schema.Schema{ + "resource_group_id": &schema.Schema{ + Type: schema.TypeString, + Required: true, + Description: "The resource group ID where the toolchains exist.", + }, + "name": &schema.Schema{ + Type: schema.TypeString, + Optional: true, + Description: "Name of toolchain to look up.", + }, + "toolchains": &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "Toolchain results returned from the collection.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "id": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "Toolchain ID.", + }, + "name": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "Toolchain name.", + }, + "description": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "Describes the toolchain.", + }, + "account_id": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "Account ID where toolchain can be found.", + }, + "location": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "Toolchain region.", + }, + "resource_group_id": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "Resource group where the toolchain is located.", + }, + "crn": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "Toolchain CRN.", + }, + "href": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "URI that can be used to retrieve toolchain.", + }, + "ui_href": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "URL of a user-facing user interface for this toolchain.", + }, + "created_at": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "Toolchain creation timestamp.", + }, + "updated_at": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "Latest toolchain update timestamp.", + }, + "created_by": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "Identity that created the toolchain.", + }, + }, + }, + }, + }, + } +} + +func dataSourceIBMCdToolchainsRead(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { + cdToolchainClient, err := meta.(conns.ClientSession).CdToolchainV2() + if err != nil { + return diag.FromErr(err) + } + + listToolchainsOptions := &cdtoolchainv2.ListToolchainsOptions{} + + listToolchainsOptions.SetResourceGroupID(d.Get("resource_group_id").(string)) + if _, ok := d.GetOk("name"); ok { + listToolchainsOptions.SetName(d.Get("name").(string)) + } + + var pager *cdtoolchainv2.ToolchainsPager + pager, err = cdToolchainClient.NewToolchainsPager(listToolchainsOptions) + if err != nil { + return diag.FromErr(err) + } + + allItems, err := pager.GetAll() + if err != nil { + log.Printf("[DEBUG] ToolchainsPager.GetAll() failed %s", err) + return diag.FromErr(fmt.Errorf("ToolchainsPager.GetAll() failed %s", err)) + } + + d.SetId(dataSourceIBMCdToolchainsID(d)) + + mapSlice := []map[string]interface{}{} + for _, modelItem := range allItems { + modelMap, err := dataSourceIBMCdToolchainsToolchainModelToMap(&modelItem) + if err != nil { + return diag.FromErr(err) + } + mapSlice = append(mapSlice, modelMap) + } + + if err = d.Set("toolchains", mapSlice); err != nil { + return diag.FromErr(fmt.Errorf("Error setting toolchains %s", err)) + } + + return nil +} + +// dataSourceIBMCdToolchainsID returns a reasonable ID for the list. +func dataSourceIBMCdToolchainsID(d *schema.ResourceData) string { + return time.Now().UTC().String() +} + +func dataSourceIBMCdToolchainsToolchainModelToMap(model *cdtoolchainv2.ToolchainModel) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + modelMap["id"] = model.ID + modelMap["name"] = model.Name + modelMap["description"] = model.Description + modelMap["account_id"] = model.AccountID + modelMap["location"] = model.Location + modelMap["resource_group_id"] = model.ResourceGroupID + modelMap["crn"] = model.CRN + modelMap["href"] = model.Href + modelMap["ui_href"] = model.UIHref + modelMap["created_at"] = model.CreatedAt.String() + modelMap["updated_at"] = model.UpdatedAt.String() + modelMap["created_by"] = model.CreatedBy + return modelMap, nil +} diff --git a/ibm/service/cdtoolchain/data_source_ibm_cd_toolchains_test.go b/ibm/service/cdtoolchain/data_source_ibm_cd_toolchains_test.go new file mode 100644 index 0000000000..2aa93b56f0 --- /dev/null +++ b/ibm/service/cdtoolchain/data_source_ibm_cd_toolchains_test.go @@ -0,0 +1,55 @@ +// Copyright IBM Corp. 2023 All Rights Reserved. +// Licensed under the Mozilla Public License v2.0 + +package cdtoolchain_test + +import ( + "fmt" + "testing" + + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/acctest" + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource" + + acc "github.com/IBM-Cloud/terraform-provider-ibm/ibm/acctest" +) + +func TestAccIBMCdToolchainsDataSourceBasic(t *testing.T) { + tcName := fmt.Sprintf("tf_tc_ds_name_%d", acctest.RandIntRange(10, 100)) + rgName := acc.CdResourceGroupName + resource.Test(t, resource.TestCase{ + PreCheck: func() { acc.TestAccPreCheck(t) }, + Providers: acc.TestAccProviders, + Steps: []resource.TestStep{ + resource.TestStep{ + Config: testAccCheckIBMCdToolchainsDataSourceConfigBasic(tcName, rgName), + Check: resource.ComposeTestCheckFunc( + resource.TestCheckResourceAttrSet("data.ibm_cd_toolchains.cd_toolchains", "id"), + resource.TestCheckResourceAttrSet("data.ibm_cd_toolchains.cd_toolchains", "resource_group_id"), + resource.TestCheckResourceAttrSet("data.ibm_cd_toolchains.cd_toolchains", "toolchains.0.name"), + resource.TestCheckResourceAttr("data.ibm_cd_toolchains.cd_toolchains", "toolchains.0.name", tcName), + ), + }, + }, + }) +} + +func testAccCheckIBMCdToolchainsDataSourceConfigBasic(tcName string, rgName string) string { + return fmt.Sprintf(` + data "ibm_resource_group" "resource_group" { + name = "%s" + } + + resource "ibm_cd_toolchain" "cd_toolchain" { + name = "%s" + resource_group_id = data.ibm_resource_group.resource_group.id + } + + data "ibm_cd_toolchains" "cd_toolchains" { + resource_group_id = data.ibm_resource_group.resource_group.id + name = "%s" + depends_on = [ + ibm_cd_toolchain.cd_toolchain + ] + } + `, rgName, tcName, tcName) +} diff --git a/ibm/service/cos/data_source_ibm_cos_bucket.go b/ibm/service/cos/data_source_ibm_cos_bucket.go index 0af4dccfed..e45744b986 100644 --- a/ibm/service/cos/data_source_ibm_cos_bucket.go +++ b/ibm/service/cos/data_source_ibm_cos_bucket.go @@ -851,16 +851,14 @@ func dataSourceIBMCosBucketRead(d *schema.ResourceData, meta interface{}) error getBucketWebsiteConfigurationInput := &s3.GetBucketWebsiteInput{ Bucket: aws.String(bucketName), } - - outputBucketWebsite, err := s3Client.GetBucketWebsite(getBucketWebsiteConfigurationInput) - var outputBucketWebsiteptr *s3.WebsiteConfiguration - outputBucketWebsiteptr = (*s3.WebsiteConfiguration)(outputBucketWebsite) - if err != nil && !strings.Contains(err.Error(), "AccessDenied: Access Denied") { + outputwebsite, err := s3Client.GetBucketWebsite(getBucketWebsiteConfigurationInput) + var outputptr *s3.WebsiteConfiguration + outputptr = (*s3.WebsiteConfiguration)(outputwebsite) + if err != nil && !strings.Contains(err.Error(), "AccessDenied: Access Denied") && !strings.Contains(err.Error(), "The specified bucket does not have a website configuration") { return err } - - if outputBucketWebsite != nil { - websiteConfiguration := flex.WebsiteConfigurationGet(outputBucketWebsiteptr) + if outputwebsite.IndexDocument != nil || outputwebsite.RedirectAllRequestsTo != nil { + websiteConfiguration := flex.WebsiteConfigurationGet(outputptr) if len(websiteConfiguration) > 0 { d.Set("website_configuration", websiteConfiguration) } @@ -868,7 +866,6 @@ func dataSourceIBMCosBucketRead(d *schema.ResourceData, meta interface{}) error if websiteEndpoint != "" { d.Set("website_endpoint", websiteEndpoint) } - } return nil diff --git a/ibm/service/iampolicy/resource_ibm_iam_authorization_policy.go b/ibm/service/iampolicy/resource_ibm_iam_authorization_policy.go index 947cee9fbc..c1facb1f30 100644 --- a/ibm/service/iampolicy/resource_ibm_iam_authorization_policy.go +++ b/ibm/service/iampolicy/resource_ibm_iam_authorization_policy.go @@ -32,17 +32,17 @@ func ResourceIBMIAMAuthorizationPolicy() *schema.Resource { Type: schema.TypeString, Optional: true, Computed: true, - ExactlyOneOf: []string{"source_service_name", "subject_attributes"}, - Description: "The source service name", ForceNew: true, + AtLeastOneOf: []string{"source_service_name", "source_resource_group_id", "subject_attributes"}, + Description: "The source service name", }, "target_service_name": { Type: schema.TypeString, Optional: true, Computed: true, - ExactlyOneOf: []string{"target_service_name", "resource_attributes"}, ForceNew: true, + AtLeastOneOf: []string{"target_service_name", "target_resource_type", "resource_attributes"}, Description: "The target service name", }, @@ -126,7 +126,7 @@ func ResourceIBMIAMAuthorizationPolicy() *schema.Resource { Computed: true, ForceNew: true, Description: "Set subject attributes.", - ConflictsWith: []string{"source_resource_instance_id", "source_resource_group_id", "source_resource_type", "source_service_account"}, + ConflictsWith: []string{"source_service_name", "source_resource_instance_id", "source_resource_group_id", "source_resource_type", "source_service_account"}, Elem: &schema.Resource{ Schema: map[string]*schema.Schema{ "name": { @@ -149,7 +149,7 @@ func ResourceIBMIAMAuthorizationPolicy() *schema.Resource { Computed: true, ForceNew: true, Description: "Set resource attributes.", - ConflictsWith: []string{"target_resource_instance_id", "target_resource_group_id", "target_resource_type"}, + ConflictsWith: []string{"target_service_name", "target_resource_instance_id", "target_resource_group_id", "target_resource_type"}, Elem: &schema.Resource{ Schema: map[string]*schema.Schema{ "name": { @@ -249,13 +249,15 @@ func resourceIBMIAMAuthorizationPolicyCreate(d *schema.ResourceData, meta interf } } else { - sourceServiceName = d.Get("source_service_name").(string) + if name, ok := d.GetOk("source_service_name"); ok { + sourceServiceName = name.(string) - serviceNameSubjectAttribute := &iampolicymanagementv1.SubjectAttribute{ - Name: core.StringPtr("serviceName"), - Value: &sourceServiceName, + serviceNameSubjectAttribute := &iampolicymanagementv1.SubjectAttribute{ + Name: core.StringPtr("serviceName"), + Value: &sourceServiceName, + } + policySubject.Attributes = append(policySubject.Attributes, *serviceNameSubjectAttribute) } - policySubject.Attributes = append(policySubject.Attributes, *serviceNameSubjectAttribute) sourceServiceAccount := userDetails.UserAccount if account, ok := d.GetOk("source_service_account"); ok { @@ -304,6 +306,9 @@ func resourceIBMIAMAuthorizationPolicyCreate(d *schema.ResourceData, meta interf if name == "serviceName" { targetServiceName = value } + if name == "resourceType" && targetServiceName == "" { + targetServiceName = "resource-controller" + } at := iampolicymanagementv1.ResourceAttribute{ Name: &name, Value: &value, @@ -312,13 +317,15 @@ func resourceIBMIAMAuthorizationPolicyCreate(d *schema.ResourceData, meta interf policyResource.Attributes = append(policyResource.Attributes, at) } } else { - targetServiceName = d.Get("target_service_name").(string) - serviceNameResourceAttribute := &iampolicymanagementv1.ResourceAttribute{ - Name: core.StringPtr("serviceName"), - Value: core.StringPtr(targetServiceName), - Operator: core.StringPtr("stringEquals"), + if name, ok := d.GetOk("target_service_name"); ok { + targetServiceName = name.(string) + serviceNameResourceAttribute := &iampolicymanagementv1.ResourceAttribute{ + Name: core.StringPtr("serviceName"), + Value: core.StringPtr(targetServiceName), + Operator: core.StringPtr("stringEquals"), + } + policyResource.Attributes = append(policyResource.Attributes, *serviceNameResourceAttribute) } - policyResource.Attributes = append(policyResource.Attributes, *serviceNameResourceAttribute) accountIDResourceAttribute := &iampolicymanagementv1.ResourceAttribute{ Name: core.StringPtr("accountId"), @@ -342,6 +349,9 @@ func resourceIBMIAMAuthorizationPolicyCreate(d *schema.ResourceData, meta interf Value: core.StringPtr(tType.(string)), } policyResource.Attributes = append(policyResource.Attributes, resourceTypeResourceAttribute) + if targetServiceName == "" { + targetServiceName = "resource-controller" + } } if tResGrpID, ok := d.GetOk("target_resource_group_id"); ok { diff --git a/ibm/service/iampolicy/resource_ibm_iam_authorization_policy_test.go b/ibm/service/iampolicy/resource_ibm_iam_authorization_policy_test.go index 7ff47f344c..fe5b7436ca 100644 --- a/ibm/service/iampolicy/resource_ibm_iam_authorization_policy_test.go +++ b/ibm/service/iampolicy/resource_ibm_iam_authorization_policy_test.go @@ -107,7 +107,7 @@ func TestAccIBMIAMAuthorizationPolicy_ResourceType(t *testing.T) { testAccCheckIBMIAMAuthorizationPolicyExists("ibm_iam_authorization_policy.policy", conf), resource.TestCheckResourceAttr("ibm_iam_authorization_policy.policy", "source_service_name", "is"), resource.TestCheckResourceAttr("ibm_iam_authorization_policy.policy", "source_resource_type", "load-balancer"), - resource.TestCheckResourceAttr("ibm_iam_authorization_policy.policy", "target_service_name", "cloudcerts"), + resource.TestCheckResourceAttr("ibm_iam_authorization_policy.policy", "target_service_name", "hs-crypto"), ), }, }, @@ -154,6 +154,96 @@ func TestAccIBMIAMAuthorizationPolicy_ResourceAttributes(t *testing.T) { }) } +func TestAccIBMIAMAuthorizationPolicy_SourceResourceGroupId(t *testing.T) { + var conf iampolicymanagementv1.PolicyTemplateMetaData + resourceName := "ibm_iam_authorization_policy.policy" + resource.Test(t, resource.TestCase{ + PreCheck: func() { acc.TestAccPreCheck(t) }, + Providers: acc.TestAccProviders, + CheckDestroy: testAccCheckIBMIAMAuthorizationPolicyDestroy, + Steps: []resource.TestStep{ + { + Config: testAccCheckIBMIAMAuthorizationPolicySourceResourceGroupId(), + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckIBMIAMAuthorizationPolicyExists("ibm_iam_authorization_policy.policy", conf), + resource.TestCheckResourceAttrSet("ibm_iam_authorization_policy.policy", "id"), + resource.TestCheckResourceAttr("ibm_iam_authorization_policy.policy", "source_service_name", ""), + resource.TestCheckResourceAttr("ibm_iam_authorization_policy.policy", "target_service_name", "cloud-object-storage"), + ), + }, + { + ResourceName: resourceName, + ImportState: true, + ImportStateVerify: true, + ImportStateVerifyIgnore: []string{"transaction_id"}, + }, + }, + }) +} + +func TestAccIBMIAMAuthorizationPolicy_SourceResourceGroupId_ResourceAttributes(t *testing.T) { + var conf iampolicymanagementv1.PolicyTemplateMetaData + + resource.Test(t, resource.TestCase{ + PreCheck: func() { acc.TestAccPreCheck(t) }, + Providers: acc.TestAccProviders, + CheckDestroy: testAccCheckIBMIAMAuthorizationPolicyDestroy, + Steps: []resource.TestStep{ + { + Config: testAccCheckIBMIAMAuthorizationPolicySourceResourceGroupIdResourceAttributes(acc.Tg_cross_network_account_id, acc.Tg_cross_network_account_id), + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckIBMIAMAuthorizationPolicyExists("ibm_iam_authorization_policy.policy", conf), + resource.TestCheckResourceAttrSet("ibm_iam_authorization_policy.policy", "id"), + resource.TestCheckResourceAttr("ibm_iam_authorization_policy.policy", "source_service_name", ""), + resource.TestCheckResourceAttr("ibm_iam_authorization_policy.policy", "target_service_name", "cloud-object-storage"), + ), + }, + }, + }) +} + +func TestAccIBMIAMAuthorizationPolicy_TargetResourceType(t *testing.T) { + var conf iampolicymanagementv1.PolicyTemplateMetaData + + resource.Test(t, resource.TestCase{ + PreCheck: func() { acc.TestAccPreCheck(t) }, + Providers: acc.TestAccProviders, + CheckDestroy: testAccCheckIBMIAMAuthorizationPolicyDestroy, + Steps: []resource.TestStep{ + { + Config: testAccCheckIBMIAMAuthorizationPolicyTargetResourceType(), + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckIBMIAMAuthorizationPolicyExists("ibm_iam_authorization_policy.policy", conf), + resource.TestCheckResourceAttr("ibm_iam_authorization_policy.policy", "target_service_name", ""), + resource.TestCheckResourceAttr("ibm_iam_authorization_policy.policy", "source_service_name", "project"), + resource.TestCheckResourceAttr("ibm_iam_authorization_policy.policy", "target_resource_type", "resource-group"), + ), + }, + }, + }) +} + +func TestAccIBMIAMAuthorizationPolicy_TargetResourceTypeAndResourceAttributes(t *testing.T) { + var conf iampolicymanagementv1.PolicyTemplateMetaData + + resource.Test(t, resource.TestCase{ + PreCheck: func() { acc.TestAccPreCheck(t) }, + Providers: acc.TestAccProviders, + CheckDestroy: testAccCheckIBMIAMAuthorizationPolicyDestroy, + Steps: []resource.TestStep{ + { + Config: testAccCheckIBMIAMAuthorizationPolicyResourceTypeAndResourceAttributes(acc.Tg_cross_network_account_id, acc.Tg_cross_network_account_id), + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckIBMIAMAuthorizationPolicyExists("ibm_iam_authorization_policy.policy", conf), + resource.TestCheckResourceAttr("ibm_iam_authorization_policy.policy", "target_service_name", ""), + resource.TestCheckResourceAttr("ibm_iam_authorization_policy.policy", "source_service_name", "project"), + resource.TestCheckResourceAttr("ibm_iam_authorization_policy.policy", "target_resource_type", "resource-group"), + ), + }, + }, + }) +} + func TestAccIBMIAMAuthorizationPolicy_With_Transaction_id(t *testing.T) { var conf iampolicymanagementv1.PolicyTemplateMetaData @@ -274,7 +364,7 @@ func testAccCheckIBMIAMAuthorizationPolicyResourceType() string { resource "ibm_iam_authorization_policy" "policy" { source_service_name = "is" source_resource_type = "load-balancer" - target_service_name = "cloudcerts" + target_service_name = "hs-crypto" roles = ["Reader"] } ` @@ -368,3 +458,79 @@ func testAccCheckIBMIAMAuthorizationPolicyTransactionId() string { } ` } + +func testAccCheckIBMIAMAuthorizationPolicySourceResourceGroupId() string { + return fmt.Sprintf(` + resource "ibm_iam_authorization_policy" "policy" { + source_resource_group_id = "123-456-abc-def" + target_service_name = "cloud-object-storage" + roles = ["Reader"] + } + + `) +} + +func testAccCheckIBMIAMAuthorizationPolicySourceResourceGroupIdResourceAttributes(sAccountID, tAccountID string) string { + + return fmt.Sprintf(` + + resource "ibm_iam_authorization_policy" "policy" { + roles = ["Reader"] + subject_attributes { + name = "accountId" + value = "%s" + } + subject_attributes { + name = "resourceGroupId" + value = "def-abc-456-123" + } + + resource_attributes { + name = "serviceName" + value = "cloud-object-storage" + } + resource_attributes { + name = "accountId" + value = "%s" + } + } + `, sAccountID, tAccountID) +} + +func testAccCheckIBMIAMAuthorizationPolicyTargetResourceType() string { + return ` + resource "ibm_iam_authorization_policy" "policy" { + source_service_name = "project" + target_resource_type = "resource-group" + roles = ["Viewer"] + } + ` +} + +func testAccCheckIBMIAMAuthorizationPolicyResourceTypeAndResourceAttributes(sAccountID, tAccountID string) string { + + return fmt.Sprintf(` + + resource "ibm_iam_authorization_policy" "policy" { + roles = ["Viewer"] + subject_attributes { + name = "accountId" + value = "%s" + } + subject_attributes { + name = "serviceName" + value = "project" + } + + resource_attributes { + name = "resourceType" + value = "resource-group" + } + resource_attributes { + name = "accountId" + value = "%s" + } + + } + `, sAccountID, tAccountID) +} diff --git a/ibm/service/kms/resource_ibm_kms_key_rings.go b/ibm/service/kms/resource_ibm_kms_key_rings.go index 5f4bc85c70..f64278dda8 100644 --- a/ibm/service/kms/resource_ibm_kms_key_rings.go +++ b/ibm/service/kms/resource_ibm_kms_key_rings.go @@ -153,7 +153,9 @@ func resourceIBMKmsKeyRingDelete(d *schema.ResourceData, meta interface{}) error err = kpAPI.DeleteKeyRing(context.Background(), id[0], kp.WithForce(force_delete)) if err != nil { kpError := err.(*kp.Error) - if kpError.StatusCode == 404 { + // Key ring deletion used to occur by silencing the 409 failed deletion and allowing instance deletion to clean it up + // Will be deprecated in the future in favor of force_delete flag + if kpError.StatusCode == 404 || kpError.StatusCode == 409 { return nil } else { return fmt.Errorf(" failed to Destroy key ring with error: %s", err) diff --git a/ibm/service/kubernetes/data_source_ibm_container_cluster_config.go b/ibm/service/kubernetes/data_source_ibm_container_cluster_config.go index b3d8be3a04..b3d1ce27ab 100644 --- a/ibm/service/kubernetes/data_source_ibm_container_cluster_config.go +++ b/ibm/service/kubernetes/data_source_ibm_container_cluster_config.go @@ -88,6 +88,11 @@ func DataSourceIBMContainerClusterConfig() *schema.Resource { Optional: true, Default: false, }, + "endpoint_type": { + Description: "It can specify what kind of server URL will be used for the cluster context", + Type: schema.TypeString, + Optional: true, + }, "config_file_path": { Description: "The absolute path to the kubernetes config yml file ", Type: schema.TypeString, @@ -151,6 +156,7 @@ func dataSourceIBMContainerClusterConfigRead(d *schema.ResourceData, meta interf admin := d.Get("admin").(bool) configDir := d.Get("config_dir").(string) network := d.Get("network").(bool) + endpointType := d.Get("endpoint_type").(string) clusterId := "Cluster_Config_" + name conns.IbmMutexKV.Lock(clusterId) @@ -170,7 +176,7 @@ func dataSourceIBMContainerClusterConfigRead(d *schema.ResourceData, meta interf expectedDir := v1.ComputeClusterConfigDir(configDir, name, admin) configPath = filepath.Join(expectedDir, "config.yml") if !helpers.FileExists(configPath) { - return fmt.Errorf(`[ERROR] Couldn't find the cluster config at expected path %s. Please set "download" to true to download the new config`, configPath) + return fmt.Errorf(`[ERROR] Couldn't find the cluster config at expected path %s. Please set "download" to true to download the new config`, configPath) } d.Set("config_file_path", configPath) @@ -185,7 +191,7 @@ func dataSourceIBMContainerClusterConfigRead(d *schema.ResourceData, meta interf var clusterKeyDetails v1.ClusterKeyInfo err = resource.Retry(5*time.Minute, func() *resource.RetryError { var err error - calicoConfigFilePath, clusterKeyDetails, err = csAPI.StoreConfigDetail(name, configDir, admin || true, network, targetEnv) + calicoConfigFilePath, clusterKeyDetails, err = csAPI.StoreConfigDetail(name, configDir, admin || true, network, targetEnv, endpointType) if err != nil { log.Printf("[DEBUG] Failed to fetch cluster config err %s", err) if strings.Contains(err.Error(), "Could not login to openshift account runtime error:") { @@ -200,7 +206,7 @@ func dataSourceIBMContainerClusterConfigRead(d *schema.ResourceData, meta interf return nil }) if conns.IsResourceTimeoutError(err) { - calicoConfigFilePath, clusterKeyDetails, err = csAPI.StoreConfigDetail(name, configDir, admin || true, network, targetEnv) + calicoConfigFilePath, clusterKeyDetails, err = csAPI.StoreConfigDetail(name, configDir, admin || true, network, targetEnv, endpointType) } if err != nil { return fmt.Errorf("[ERROR] Error downloading the cluster config [%s]: %s", name, err) @@ -217,7 +223,7 @@ func dataSourceIBMContainerClusterConfigRead(d *schema.ResourceData, meta interf var clusterKeyDetails v1.ClusterKeyInfo err = resource.Retry(5*time.Minute, func() *resource.RetryError { var err error - clusterKeyDetails, err = csAPI.GetClusterConfigDetail(name, configDir, admin, targetEnv) + clusterKeyDetails, err = csAPI.GetClusterConfigDetail(name, configDir, admin, targetEnv, endpointType) if err != nil { log.Printf("[DEBUG] Failed to fetch cluster config err %s", err) if strings.Contains(err.Error(), "Could not login to openshift account runtime error:") { @@ -232,7 +238,7 @@ func dataSourceIBMContainerClusterConfigRead(d *schema.ResourceData, meta interf return nil }) if conns.IsResourceTimeoutError(err) { - clusterKeyDetails, err = csAPI.GetClusterConfigDetail(name, configDir, admin, targetEnv) + clusterKeyDetails, err = csAPI.GetClusterConfigDetail(name, configDir, admin, targetEnv, endpointType) } if err != nil { return fmt.Errorf("[ERROR] Error downloading the cluster config [%s]: %s", name, err) diff --git a/ibm/service/kubernetes/data_source_ibm_container_cluster_config_test.go b/ibm/service/kubernetes/data_source_ibm_container_cluster_config_test.go index 5acd9f60ca..e4010eca2b 100644 --- a/ibm/service/kubernetes/data_source_ibm_container_cluster_config_test.go +++ b/ibm/service/kubernetes/data_source_ibm_container_cluster_config_test.go @@ -5,6 +5,7 @@ package kubernetes_test import ( "fmt" + "regexp" "testing" acc "github.com/IBM-Cloud/terraform-provider-ibm/ibm/acctest" @@ -76,6 +77,8 @@ func TestAccIBMContainer_ClusterConfigCalicoDataSourceBasic(t *testing.T) { "data.ibm_container_cluster_config.testacc_ds_cluster", "config_file_path"), resource.TestCheckResourceAttrSet( "data.ibm_container_cluster_config.testacc_ds_cluster", "calico_config_file_path"), + resource.TestMatchResourceAttr( + "data.ibm_container_cluster_config.testacc_ds_cluster", "host", regexp.MustCompile("^https://.*private.*")), ), }, }, @@ -129,10 +132,12 @@ resource "ibm_container_cluster" "testacc_cluster" { wait_till = "Normal" public_vlan_id = "%s" private_vlan_id = "%s" + private_service_endpoint = true } data "ibm_container_cluster_config" "testacc_ds_cluster" { cluster_name_id = ibm_container_cluster.testacc_cluster.id network = true + endpoint_type = "private" }`, clustername, acc.Datacenter, acc.MachineType, acc.PublicVlanID, acc.PrivateVlanID) } diff --git a/ibm/service/metricsrouter/data_source_ibm_metrics_router_targets.go b/ibm/service/metricsrouter/data_source_ibm_metrics_router_targets.go index d7c3cf7784..af6d852f87 100644 --- a/ibm/service/metricsrouter/data_source_ibm_metrics_router_targets.go +++ b/ibm/service/metricsrouter/data_source_ibm_metrics_router_targets.go @@ -50,7 +50,7 @@ func DataSourceIBMMetricsRouterTargets() *schema.Resource { "destination_crn": &schema.Schema{ Type: schema.TypeString, Computed: true, - Description: "The CRN of the destination service instance or resource.", + Description: "The CRN of the destination service instance or resource. Ensure you have a service authorization between IBM Cloud Metrics Routing and your Cloud resource. Read [S2S authorization](https://cloud.ibm.com/docs/metrics-router?topic=metrics-router-target-monitoring&interface=ui#target-monitoring-ui) for details.", }, "target_type": &schema.Schema{ Type: schema.TypeString, diff --git a/ibm/service/metricsrouter/resource_ibm_metrics_router_target.go b/ibm/service/metricsrouter/resource_ibm_metrics_router_target.go index a23bc3408e..3ab0fe5941 100644 --- a/ibm/service/metricsrouter/resource_ibm_metrics_router_target.go +++ b/ibm/service/metricsrouter/resource_ibm_metrics_router_target.go @@ -36,7 +36,7 @@ func ResourceIBMMetricsRouterTarget() *schema.Resource { Type: schema.TypeString, Required: true, ValidateFunc: validate.InvokeValidator("ibm_metrics_router_target", "destination_crn"), - Description: "The CRN of a destination service instance or resource.", + Description: "The CRN of a destination service instance or resource. Ensure you have a service authorization between IBM Cloud Metrics Routing and your Cloud resource. Read [S2S authorization](https://cloud.ibm.com/docs/metrics-router?topic=metrics-router-target-monitoring&interface=ui#target-monitoring-ui) for details.", }, "region": &schema.Schema{ Type: schema.TypeString, diff --git a/ibm/service/scc/data_source_ibm_scc_control_library.go b/ibm/service/scc/data_source_ibm_scc_control_library.go index e5958811ec..fe7b9df7b0 100644 --- a/ibm/service/scc/data_source_ibm_scc_control_library.go +++ b/ibm/service/scc/data_source_ibm_scc_control_library.go @@ -17,117 +17,117 @@ import ( ) func DataSourceIbmSccControlLibrary() *schema.Resource { - return &schema.Resource{ + return AddSchemaData(&schema.Resource{ ReadContext: dataSourceIbmSccControlLibraryRead, Schema: map[string]*schema.Schema{ - "control_library_id": &schema.Schema{ + "control_library_id": { Type: schema.TypeString, Required: true, Description: "The control library ID.", }, - "account_id": &schema.Schema{ + "account_id": { Type: schema.TypeString, Computed: true, Description: "The account ID.", }, - "control_library_name": &schema.Schema{ + "control_library_name": { Type: schema.TypeString, Computed: true, Description: "The control library name.", }, - "control_library_description": &schema.Schema{ + "control_library_description": { Type: schema.TypeString, Computed: true, Description: "The control library description.", }, - "control_library_type": &schema.Schema{ + "control_library_type": { Type: schema.TypeString, Computed: true, Description: "The control library type.", }, - "version_group_label": &schema.Schema{ + "version_group_label": { Type: schema.TypeString, Computed: true, Description: "The version group label.", }, - "control_library_version": &schema.Schema{ + "control_library_version": { Type: schema.TypeString, Computed: true, Description: "The control library version.", }, - "created_on": &schema.Schema{ + "created_on": { Type: schema.TypeString, Computed: true, Description: "The date when the control library was created.", }, - "created_by": &schema.Schema{ + "created_by": { Type: schema.TypeString, Computed: true, Description: "The user who created the control library.", }, - "updated_on": &schema.Schema{ + "updated_on": { Type: schema.TypeString, Computed: true, Description: "The date when the control library was updated.", }, - "updated_by": &schema.Schema{ + "updated_by": { Type: schema.TypeString, Computed: true, Description: "The user who updated the control library.", }, - "latest": &schema.Schema{ + "latest": { Type: schema.TypeBool, Computed: true, Description: "The latest version of the control library.", }, - "hierarchy_enabled": &schema.Schema{ + "hierarchy_enabled": { Type: schema.TypeBool, Computed: true, Description: "The indication of whether hierarchy is enabled for the control library.", }, - "controls_count": &schema.Schema{ + "controls_count": { Type: schema.TypeInt, Computed: true, Description: "The number of controls.", }, - "control_parents_count": &schema.Schema{ + "control_parents_count": { Type: schema.TypeInt, Computed: true, Description: "The number of parent controls in the control library.", }, - "controls": &schema.Schema{ + "controls": { Type: schema.TypeList, Computed: true, Description: "The list of controls in a control library.", Elem: &schema.Resource{ Schema: map[string]*schema.Schema{ - "control_name": &schema.Schema{ + "control_name": { Type: schema.TypeString, Computed: true, Description: "The ID of the control library that contains the profile.", }, - "control_id": &schema.Schema{ + "control_id": { Type: schema.TypeString, Computed: true, Description: "The control name.", }, - "control_description": &schema.Schema{ + "control_description": { Type: schema.TypeString, Computed: true, Description: "The control description.", }, - "control_category": &schema.Schema{ + "control_category": { Type: schema.TypeString, Computed: true, Description: "The control category.", }, - "control_parent": &schema.Schema{ + "control_parent": { Type: schema.TypeString, Computed: true, Description: "The parent control.", }, - "control_tags": &schema.Schema{ + "control_tags": { Type: schema.TypeList, Computed: true, Description: "The control tags.", @@ -135,95 +135,95 @@ func DataSourceIbmSccControlLibrary() *schema.Resource { Type: schema.TypeString, }, }, - "control_specifications": &schema.Schema{ + "control_specifications": { Type: schema.TypeList, Computed: true, Description: "The control specifications.", Elem: &schema.Resource{ Schema: map[string]*schema.Schema{ - "control_specification_id": &schema.Schema{ + "control_specification_id": { Type: schema.TypeString, Computed: true, Description: "The control specification ID.", }, - "responsibility": &schema.Schema{ + "responsibility": { Type: schema.TypeString, Computed: true, Description: "The responsibility for managing the control.", }, - "component_id": &schema.Schema{ + "component_id": { Type: schema.TypeString, Computed: true, Description: "The component ID.", }, - "component_name": &schema.Schema{ + "component_name": { Type: schema.TypeString, Computed: true, Description: "The component name.", }, - "environment": &schema.Schema{ + "environment": { Type: schema.TypeString, Computed: true, Description: "The control specifications environment.", }, - "control_specification_description": &schema.Schema{ + "control_specification_description": { Type: schema.TypeString, Computed: true, Description: "The control specifications description.", }, - "assessments_count": &schema.Schema{ + "assessments_count": { Type: schema.TypeInt, Computed: true, Description: "The number of assessments.", }, - "assessments": &schema.Schema{ + "assessments": { Type: schema.TypeList, Computed: true, Description: "The assessments.", Elem: &schema.Resource{ Schema: map[string]*schema.Schema{ - "assessment_id": &schema.Schema{ + "assessment_id": { Type: schema.TypeString, Computed: true, Description: "The assessment ID.", }, - "assessment_method": &schema.Schema{ + "assessment_method": { Type: schema.TypeString, Computed: true, Description: "The assessment method.", }, - "assessment_type": &schema.Schema{ + "assessment_type": { Type: schema.TypeString, Computed: true, Description: "The assessment type.", }, - "assessment_description": &schema.Schema{ + "assessment_description": { Type: schema.TypeString, Computed: true, Description: "The assessment description.", }, - "parameter_count": &schema.Schema{ + "parameter_count": { Type: schema.TypeInt, Computed: true, Description: "The parameter count.", }, - "parameters": &schema.Schema{ + "parameters": { Type: schema.TypeList, Computed: true, Description: "The parameters.", Elem: &schema.Resource{ Schema: map[string]*schema.Schema{ - "parameter_name": &schema.Schema{ + "parameter_name": { Type: schema.TypeString, Computed: true, Description: "The parameter name.", }, - "parameter_display_name": &schema.Schema{ + "parameter_display_name": { Type: schema.TypeString, Computed: true, Description: "The parameter display name.", }, - "parameter_type": &schema.Schema{ + "parameter_type": { Type: schema.TypeString, Computed: true, Description: "The parameter type.", @@ -237,18 +237,18 @@ func DataSourceIbmSccControlLibrary() *schema.Resource { }, }, }, - "control_docs": &schema.Schema{ + "control_docs": { Type: schema.TypeList, Computed: true, Description: "The control documentation.", Elem: &schema.Resource{ Schema: map[string]*schema.Schema{ - "control_docs_id": &schema.Schema{ + "control_docs_id": { Type: schema.TypeString, Computed: true, Description: "The ID of the control documentation.", }, - "control_docs_type": &schema.Schema{ + "control_docs_type": { Type: schema.TypeString, Computed: true, Description: "The type of control documentation.", @@ -256,12 +256,12 @@ func DataSourceIbmSccControlLibrary() *schema.Resource { }, }, }, - "control_requirement": &schema.Schema{ + "control_requirement": { Type: schema.TypeBool, Computed: true, Description: "Is this a control that can be automated or manually evaluated.", }, - "status": &schema.Schema{ + "status": { Type: schema.TypeString, Computed: true, Description: "The control status.", @@ -270,7 +270,7 @@ func DataSourceIbmSccControlLibrary() *schema.Resource { }, }, }, - } + }) } func dataSourceIbmSccControlLibraryRead(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { @@ -282,6 +282,7 @@ func dataSourceIbmSccControlLibraryRead(context context.Context, d *schema.Resou getControlLibraryOptions := &securityandcompliancecenterapiv3.GetControlLibraryOptions{} getControlLibraryOptions.SetControlLibrariesID(d.Get("control_library_id").(string)) + getControlLibraryOptions.SetInstanceID(d.Get("instance_id").(string)) controlLibrary, response, err := securityandcompliancecenterapiClient.GetControlLibraryWithContext(context, getControlLibraryOptions) if err != nil { diff --git a/ibm/service/scc/data_source_ibm_scc_control_library_test.go b/ibm/service/scc/data_source_ibm_scc_control_library_test.go index 47caefc5b8..d557801ce3 100644 --- a/ibm/service/scc/data_source_ibm_scc_control_library_test.go +++ b/ibm/service/scc/data_source_ibm_scc_control_library_test.go @@ -19,11 +19,11 @@ func TestAccIbmSccControlLibraryDataSourceBasic(t *testing.T) { controlLibraryControlLibraryType := "custom" resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, Steps: []resource.TestStep{ { - Config: testAccCheckIbmSccControlLibraryDataSourceConfigBasic(controlLibraryControlLibraryName, controlLibraryControlLibraryDescription, controlLibraryControlLibraryType), + Config: testAccCheckIbmSccControlLibraryDataSourceConfigBasic(acc.SccInstanceID, controlLibraryControlLibraryName, controlLibraryControlLibraryDescription, controlLibraryControlLibraryType), Check: resource.ComposeTestCheckFunc( resource.TestCheckResourceAttrSet("data.ibm_scc_control_library.scc_control_library", "id"), resource.TestCheckResourceAttrSet("data.ibm_scc_control_library.scc_control_library", "control_library_id"), @@ -38,16 +38,15 @@ func TestAccIbmSccControlLibraryDataSourceAllArgs(t *testing.T) { controlLibraryControlLibraryDescription := fmt.Sprintf("tf_control_library_description_%d", acctest.RandIntRange(10, 100)) controlLibraryControlLibraryType := "custom" controlLibraryVersionGroupLabel := fmt.Sprintf("d755830f-1d83-4fab-b5d5-1dfb2b0dad1%d", acctest.RandIntRange(1, 9)) - controlLibraryControlLibraryVersion := fmt.Sprintf("0.0.%d", acctest.RandIntRange(1, 100)) controlLibraryLatest := "true" resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, Steps: []resource.TestStep{ { - Config: testAccCheckIbmSccControlLibraryDataSourceConfig(controlLibraryControlLibraryName, controlLibraryControlLibraryDescription, controlLibraryControlLibraryType, controlLibraryVersionGroupLabel, controlLibraryControlLibraryVersion, controlLibraryLatest), + Config: testAccCheckIbmSccControlLibraryDataSourceConfig(acc.SccInstanceID, controlLibraryControlLibraryName, controlLibraryControlLibraryDescription, controlLibraryControlLibraryType, controlLibraryVersionGroupLabel, controlLibraryControlLibraryVersion, controlLibraryLatest), Check: resource.ComposeTestCheckFunc( resource.TestCheckResourceAttrSet("data.ibm_scc_control_library.scc_control_library", "id"), resource.TestCheckResourceAttrSet("data.ibm_scc_control_library.scc_control_library", "account_id"), @@ -77,9 +76,10 @@ func TestAccIbmSccControlLibraryDataSourceAllArgs(t *testing.T) { }) } -func testAccCheckIbmSccControlLibraryDataSourceConfigBasic(controlLibraryControlLibraryName string, controlLibraryControlLibraryDescription string, controlLibraryControlLibraryType string) string { +func testAccCheckIbmSccControlLibraryDataSourceConfigBasic(instanceID string, controlLibraryControlLibraryName string, controlLibraryControlLibraryDescription string, controlLibraryControlLibraryType string) string { return fmt.Sprintf(` resource "ibm_scc_control_library" "scc_control_library_instance" { + instance_id = "%s" control_library_name = "%s" control_library_description = "%s" control_library_type = "%s" @@ -120,15 +120,17 @@ func testAccCheckIbmSccControlLibraryDataSourceConfigBasic(controlLibraryControl } data "ibm_scc_control_library" "scc_control_library" { - control_library_id = ibm_scc_control_library.scc_control_library_instance.id + instance_id = ibm_scc_control_library.scc_control_library_instance.instance_id + control_library_id = ibm_scc_control_library.scc_control_library_instance.control_library_id } - `, controlLibraryControlLibraryName, controlLibraryControlLibraryDescription, controlLibraryControlLibraryType) + `, instanceID, controlLibraryControlLibraryName, controlLibraryControlLibraryDescription, controlLibraryControlLibraryType) } -func testAccCheckIbmSccControlLibraryDataSourceConfig(controlLibraryControlLibraryName string, controlLibraryControlLibraryDescription string, controlLibraryControlLibraryType string, controlLibraryVersionGroupLabel string, controlLibraryControlLibraryVersion string, controlLibraryLatest string) string { +func testAccCheckIbmSccControlLibraryDataSourceConfig(instanceID string, controlLibraryControlLibraryName string, controlLibraryControlLibraryDescription string, controlLibraryControlLibraryType string, controlLibraryVersionGroupLabel string, controlLibraryControlLibraryVersion string, controlLibraryLatest string) string { return fmt.Sprintf(` resource "ibm_scc_control_library" "scc_control_library_instance" { + instance_id = "%s" control_library_name = "%s" control_library_description = "%s" control_library_type = "%s" @@ -170,8 +172,9 @@ func testAccCheckIbmSccControlLibraryDataSourceConfig(controlLibraryControlLibra } data "ibm_scc_control_library" "scc_control_library" { - control_library_id = ibm_scc_control_library.scc_control_library_instance.id + instance_id = ibm_scc_control_library.scc_control_library_instance.instance_id + control_library_id = ibm_scc_control_library.scc_control_library_instance.control_library_id } - `, controlLibraryControlLibraryName, controlLibraryControlLibraryDescription, controlLibraryControlLibraryType, controlLibraryVersionGroupLabel, controlLibraryControlLibraryVersion, controlLibraryLatest) + `, instanceID, controlLibraryControlLibraryName, controlLibraryControlLibraryDescription, controlLibraryControlLibraryType, controlLibraryVersionGroupLabel, controlLibraryControlLibraryVersion, controlLibraryLatest) } diff --git a/ibm/service/scc/data_source_ibm_scc_instance_settings.go b/ibm/service/scc/data_source_ibm_scc_instance_settings.go index 25b0a4cf5e..4ba27e9dbb 100644 --- a/ibm/service/scc/data_source_ibm_scc_instance_settings.go +++ b/ibm/service/scc/data_source_ibm_scc_instance_settings.go @@ -17,7 +17,7 @@ import ( ) func DataSourceIbmSccInstanceSettings() *schema.Resource { - return &schema.Resource{ + return AddSchemaData(&schema.Resource{ ReadContext: dataSourceIbmSccInstanceSettingsRead, Schema: map[string]*schema.Schema{ @@ -80,7 +80,7 @@ func DataSourceIbmSccInstanceSettings() *schema.Resource { }, }, }, - } + }) } func dataSourceIbmSccInstanceSettingsRead(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { @@ -90,6 +90,7 @@ func dataSourceIbmSccInstanceSettingsRead(context context.Context, d *schema.Res } getSettingsOptions := &securityandcompliancecenterapiv3.GetSettingsOptions{} + getSettingsOptions.SetInstanceID(d.Get("instance_id").(string)) settings, response, err := adminClient.GetSettingsWithContext(context, getSettingsOptions) diff --git a/ibm/service/scc/data_source_ibm_scc_instance_settings_test.go b/ibm/service/scc/data_source_ibm_scc_instance_settings_test.go index 94f7127479..e91ea633eb 100644 --- a/ibm/service/scc/data_source_ibm_scc_instance_settings_test.go +++ b/ibm/service/scc/data_source_ibm_scc_instance_settings_test.go @@ -14,11 +14,11 @@ import ( func TestAccIbmSccInstanceSettingsDataSourceBasic(t *testing.T) { resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, Steps: []resource.TestStep{ - resource.TestStep{ - Config: testAccCheckIbmSccInstanceSettingsDataSourceConfigBasic(), + { + Config: testAccCheckIbmSccInstanceSettingsDataSourceConfigBasic(acc.SccInstanceID), Check: resource.ComposeTestCheckFunc( resource.TestCheckResourceAttrSet("data.ibm_scc_instance_settings.scc_instance_settings_tf", "id"), resource.TestCheckResourceAttrSet("data.ibm_scc_instance_settings.scc_instance_settings_tf", "event_notifications.#"), @@ -29,9 +29,10 @@ func TestAccIbmSccInstanceSettingsDataSourceBasic(t *testing.T) { }) } -func testAccCheckIbmSccInstanceSettingsDataSourceConfigBasic() string { +func testAccCheckIbmSccInstanceSettingsDataSourceConfigBasic(instanceID string) string { return fmt.Sprintf(` data "ibm_scc_instance_settings" "scc_instance_settings_tf" { + instance_id = "%s" } - `) + `, instanceID) } diff --git a/ibm/service/scc/data_source_ibm_scc_latest_reports.go b/ibm/service/scc/data_source_ibm_scc_latest_reports.go index 48a732e6bb..d6c48d2e4b 100644 --- a/ibm/service/scc/data_source_ibm_scc_latest_reports.go +++ b/ibm/service/scc/data_source_ibm_scc_latest_reports.go @@ -18,7 +18,7 @@ import ( ) func DataSourceIbmSccLatestReports() *schema.Resource { - return &schema.Resource{ + return AddSchemaData(&schema.Resource{ ReadContext: dataSourceIbmSccLatestReportsRead, Schema: map[string]*schema.Schema{ @@ -294,7 +294,7 @@ func DataSourceIbmSccLatestReports() *schema.Resource { }, }, }, - } + }) } func dataSourceIbmSccLatestReportsRead(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { @@ -304,6 +304,7 @@ func dataSourceIbmSccLatestReportsRead(context context.Context, d *schema.Resour } getLatestReportsOptions := &securityandcompliancecenterapiv3.GetLatestReportsOptions{} + getLatestReportsOptions.SetInstanceID(d.Get("instance_id").(string)) if _, ok := d.GetOk("sort"); ok { getLatestReportsOptions.SetSort(d.Get("sort").(string)) diff --git a/ibm/service/scc/data_source_ibm_scc_latest_reports_test.go b/ibm/service/scc/data_source_ibm_scc_latest_reports_test.go index 9e5babbac8..bb710d33fb 100644 --- a/ibm/service/scc/data_source_ibm_scc_latest_reports_test.go +++ b/ibm/service/scc/data_source_ibm_scc_latest_reports_test.go @@ -14,11 +14,11 @@ import ( func TestAccIbmSccLatestReportsDataSourceBasic(t *testing.T) { resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, Steps: []resource.TestStep{ resource.TestStep{ - Config: testAccCheckIbmSccLatestReportsDataSourceConfigBasic(), + Config: testAccCheckIbmSccLatestReportsDataSourceConfigBasic(acc.SccInstanceID), Check: resource.ComposeTestCheckFunc( resource.TestCheckResourceAttrSet("data.ibm_scc_latest_reports.scc_latest_reports_instance", "id"), ), @@ -27,10 +27,11 @@ func TestAccIbmSccLatestReportsDataSourceBasic(t *testing.T) { }) } -func testAccCheckIbmSccLatestReportsDataSourceConfigBasic() string { +func testAccCheckIbmSccLatestReportsDataSourceConfigBasic(instanceID string) string { return fmt.Sprintf(` data "ibm_scc_latest_reports" "scc_latest_reports_instance" { + instance_id = "%s" sort = "profile_name" } - `) + `, instanceID) } diff --git a/ibm/service/scc/data_source_ibm_scc_profile.go b/ibm/service/scc/data_source_ibm_scc_profile.go index e15120cd4d..1974088603 100644 --- a/ibm/service/scc/data_source_ibm_scc_profile.go +++ b/ibm/service/scc/data_source_ibm_scc_profile.go @@ -17,7 +17,7 @@ import ( ) func DataSourceIbmSccProfile() *schema.Resource { - return &schema.Resource{ + return AddSchemaData(&schema.Resource{ ReadContext: dataSourceIbmSccProfileRead, Schema: map[string]*schema.Schema{ @@ -316,7 +316,7 @@ func DataSourceIbmSccProfile() *schema.Resource { }, }, }, - } + }) } func dataSourceIbmSccProfileRead(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { @@ -328,6 +328,7 @@ func dataSourceIbmSccProfileRead(context context.Context, d *schema.ResourceData getProfileOptions := &securityandcompliancecenterapiv3.GetProfileOptions{} getProfileOptions.SetProfileID(d.Get("profile_id").(string)) + getProfileOptions.SetInstanceID(d.Get("instance_id").(string)) profile, response, err := securityandcompliancecenterapiClient.GetProfileWithContext(context, getProfileOptions) if err != nil { @@ -357,10 +358,6 @@ func dataSourceIbmSccProfileRead(context context.Context, d *schema.ResourceData return diag.FromErr(fmt.Errorf("Error setting version_group_label: %s", err)) } - if err = d.Set("instance_id", profile.InstanceID); err != nil { - return diag.FromErr(fmt.Errorf("Error setting instance_id: %s", err)) - } - if err = d.Set("latest", profile.Latest); err != nil { return diag.FromErr(fmt.Errorf("Error setting latest: %s", err)) } diff --git a/ibm/service/scc/data_source_ibm_scc_profile_attachment.go b/ibm/service/scc/data_source_ibm_scc_profile_attachment.go index c8b54847c5..64ee30e057 100644 --- a/ibm/service/scc/data_source_ibm_scc_profile_attachment.go +++ b/ibm/service/scc/data_source_ibm_scc_profile_attachment.go @@ -17,7 +17,7 @@ import ( ) func DataSourceIbmSccProfileAttachment() *schema.Resource { - return &schema.Resource{ + return AddSchemaData(&schema.Resource{ ReadContext: dataSourceIbmSccProfileAttachmentRead, Schema: map[string]*schema.Schema{ @@ -224,7 +224,7 @@ func DataSourceIbmSccProfileAttachment() *schema.Resource { Description: "The description for the attachment.", }, }, - } + }) } func dataSourceIbmSccProfileAttachmentRead(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { @@ -237,6 +237,7 @@ func dataSourceIbmSccProfileAttachmentRead(context context.Context, d *schema.Re getProfileAttachmentOptions.SetAttachmentID(d.Get("attachment_id").(string)) getProfileAttachmentOptions.SetProfileID(d.Get("profile_id").(string)) + getProfileAttachmentOptions.SetInstanceID(d.Get("instance_id").(string)) attachmentItem, response, err := securityandcompliancecenterapiClient.GetProfileAttachmentWithContext(context, getProfileAttachmentOptions) if err != nil { diff --git a/ibm/service/scc/data_source_ibm_scc_profile_attachment_test.go b/ibm/service/scc/data_source_ibm_scc_profile_attachment_test.go index b6c438b563..84d113eae8 100644 --- a/ibm/service/scc/data_source_ibm_scc_profile_attachment_test.go +++ b/ibm/service/scc/data_source_ibm_scc_profile_attachment_test.go @@ -14,11 +14,11 @@ import ( func TestAccIbmSccProfileAttachmentDataSourceBasic(t *testing.T) { resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, Steps: []resource.TestStep{ { - Config: testAccCheckIbmSccProfileAttachmentDataSourceConfigBasic(), + Config: testAccCheckIbmSccProfileAttachmentDataSourceConfigBasic(acc.SccInstanceID), Check: resource.ComposeTestCheckFunc( resource.TestCheckResourceAttrSet("data.ibm_scc_profile_attachment.scc_profile_attachment_instance", "id"), resource.TestCheckResourceAttrSet("data.ibm_scc_profile_attachment.scc_profile_attachment_instance", "attachment_id"), @@ -31,11 +31,11 @@ func TestAccIbmSccProfileAttachmentDataSourceBasic(t *testing.T) { func TestAccIbmSccProfileAttachmentDataSourceAllArgs(t *testing.T) { resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, Steps: []resource.TestStep{ { - Config: testAccCheckIbmSccProfileAttachmentDataSourceConfig(), + Config: testAccCheckIbmSccProfileAttachmentDataSourceConfig(acc.SccInstanceID), Check: resource.ComposeTestCheckFunc( resource.TestCheckResourceAttrSet("data.ibm_scc_profile_attachment.scc_profile_attachment_instance", "id"), resource.TestCheckResourceAttrSet("data.ibm_scc_profile_attachment.scc_profile_attachment_instance", "attachment_id"), @@ -62,10 +62,10 @@ func TestAccIbmSccProfileAttachmentDataSourceAllArgs(t *testing.T) { }) } -func testAccCheckIbmSccProfileAttachmentDataSourceConfigBasic() string { +func testAccCheckIbmSccProfileAttachmentDataSourceConfigBasic(instanceID string) string { return fmt.Sprintf(` - resource "ibm_scc_control_library" "scc_control_library_instance" { + instance_id = "%s" control_library_name = "control_library_name" control_library_description = "control_library_description" control_library_type = "custom" @@ -106,11 +106,12 @@ func testAccCheckIbmSccProfileAttachmentDataSourceConfigBasic() string { } resource "ibm_scc_profile" "scc_profile_instance" { + instance_id = resource.ibm_scc_control_library.scc_control_library_instance.instance_id profile_name = "profile_name" profile_description = "profile_description" profile_type = "custom" controls { - control_library_id = resource.ibm_scc_control_library.scc_control_library_instance.id + control_library_id = resource.ibm_scc_control_library.scc_control_library_instance.control_library_id control_id = resource.ibm_scc_control_library.scc_control_library_instance.controls[0].control_id } default_parameters { @@ -118,7 +119,8 @@ func testAccCheckIbmSccProfileAttachmentDataSourceConfigBasic() string { } resource "ibm_scc_profile_attachment" "scc_profile_attachment_instance" { - profile_id = ibm_scc_profile.scc_profile_instance.id + instance_id = resource.ibm_scc_control_library.scc_control_library_instance.instance_id + profile_id = ibm_scc_profile.scc_profile_instance.profile_id name = "profile_attachment_name" description = "profile_attachment_description" scope { @@ -146,14 +148,15 @@ func testAccCheckIbmSccProfileAttachmentDataSourceConfigBasic() string { data "ibm_scc_profile_attachment" "scc_profile_attachment_instance" { attachment_id = ibm_scc_profile_attachment.scc_profile_attachment_instance.attachment_id profile_id = ibm_scc_profile_attachment.scc_profile_attachment_instance.profile_id + instance_id = resource.ibm_scc_control_library.scc_control_library_instance.instance_id } - `) + `, instanceID) } -func testAccCheckIbmSccProfileAttachmentDataSourceConfig() string { - return fmt.Sprint(` - +func testAccCheckIbmSccProfileAttachmentDataSourceConfig(instanceID string) string { + return fmt.Sprintf(` resource "ibm_scc_control_library" "scc_control_library_instance" { + instance_id = "%s" control_library_name = "control_library_name" control_library_description = "control_library_description" control_library_type = "custom" @@ -194,11 +197,12 @@ func testAccCheckIbmSccProfileAttachmentDataSourceConfig() string { } resource "ibm_scc_profile" "scc_profile_instance" { + instance_id = resource.ibm_scc_control_library.scc_control_library_instance.instance_id profile_name = "profile_name" profile_description = "profile_description" profile_type = "custom" controls { - control_library_id = resource.ibm_scc_control_library.scc_control_library_instance.id + control_library_id = resource.ibm_scc_control_library.scc_control_library_instance.control_library_id control_id = resource.ibm_scc_control_library.scc_control_library_instance.controls[0].control_id } default_parameters { @@ -206,7 +210,8 @@ func testAccCheckIbmSccProfileAttachmentDataSourceConfig() string { } resource "ibm_scc_profile_attachment" "scc_profile_attachment_instance" { - profile_id = ibm_scc_profile.scc_profile_instance.id + instance_id = resource.ibm_scc_control_library.scc_control_library_instance.instance_id + profile_id = ibm_scc_profile.scc_profile_instance.profile_id name = "profile_attachment_name" description = "profile_attachment_description" scope { @@ -232,8 +237,9 @@ func testAccCheckIbmSccProfileAttachmentDataSourceConfig() string { } data "ibm_scc_profile_attachment" "scc_profile_attachment_instance" { + instance_id = resource.ibm_scc_control_library.scc_control_library_instance.instance_id attachment_id = ibm_scc_profile_attachment.scc_profile_attachment_instance.attachment_id profile_id = ibm_scc_profile_attachment.scc_profile_attachment_instance.profile_id } - `) + `, instanceID) } diff --git a/ibm/service/scc/data_source_ibm_scc_profile_test.go b/ibm/service/scc/data_source_ibm_scc_profile_test.go index 1d17c0abd2..47ab120f1f 100644 --- a/ibm/service/scc/data_source_ibm_scc_profile_test.go +++ b/ibm/service/scc/data_source_ibm_scc_profile_test.go @@ -19,11 +19,11 @@ func TestAccIbmSccProfileDataSourceBasic(t *testing.T) { profileProfileType := "custom" resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, Steps: []resource.TestStep{ resource.TestStep{ - Config: testAccCheckIbmSccProfileDataSourceConfigBasic(profileProfileName, profileProfileDescription, profileProfileType), + Config: testAccCheckIbmSccProfileDataSourceConfigBasic(acc.SccInstanceID, profileProfileName, profileProfileDescription, profileProfileType), Check: resource.ComposeTestCheckFunc( resource.TestCheckResourceAttrSet("data.ibm_scc_profile.scc_profile_instance", "id"), resource.TestCheckResourceAttrSet("data.ibm_scc_profile.scc_profile_instance", "profile_id"), @@ -39,11 +39,11 @@ func TestAccIbmSccProfileDataSourceAllArgs(t *testing.T) { profileProfileType := "custom" resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, Steps: []resource.TestStep{ resource.TestStep{ - Config: testAccCheckIbmSccProfileDataSourceConfig(profileProfileName, profileProfileDescription, profileProfileType), + Config: testAccCheckIbmSccProfileDataSourceConfig(acc.SccInstanceID, profileProfileName, profileProfileDescription, profileProfileType), Check: resource.ComposeTestCheckFunc( resource.TestCheckResourceAttrSet("data.ibm_scc_profile.scc_profile_instance", "id"), resource.TestCheckResourceAttrSet("data.ibm_scc_profile.scc_profile_instance", "profile_name"), @@ -68,9 +68,10 @@ func TestAccIbmSccProfileDataSourceAllArgs(t *testing.T) { }) } -func testAccCheckIbmSccProfileDataSourceConfigBasic(profileProfileName string, profileProfileDescription string, profileProfileType string) string { +func testAccCheckIbmSccProfileDataSourceConfigBasic(instanceID string, profileProfileName string, profileProfileDescription string, profileProfileType string) string { return fmt.Sprintf(` resource "ibm_scc_control_library" "scc_control_library_instance" { + instance_id = "%s" control_library_name = "control_library_name" control_library_description = "control_library_description" control_library_type = "custom" @@ -111,26 +112,27 @@ func testAccCheckIbmSccProfileDataSourceConfigBasic(profileProfileName string, p } resource "ibm_scc_profile" "scc_profile_instance" { + instance_id = resource.ibm_scc_control_library.scc_control_library_instance.instance_id profile_name = "%s" profile_description = "%s" profile_type = "%s" controls { - control_library_id = resource.ibm_scc_control_library.scc_control_library_instance.id + control_library_id = resource.ibm_scc_control_library.scc_control_library_instance.control_library_id control_id = resource.ibm_scc_control_library.scc_control_library_instance.controls[0].control_id } - default_parameters { - } } data "ibm_scc_profile" "scc_profile_instance" { - profile_id = ibm_scc_profile.scc_profile_instance.id + profile_id = resource.ibm_scc_profile.scc_profile_instance.profile_id + instance_id = resource.ibm_scc_profile.scc_profile_instance.instance_id } - `, profileProfileName, profileProfileDescription, profileProfileType) + `, instanceID, profileProfileName, profileProfileDescription, profileProfileType) } -func testAccCheckIbmSccProfileDataSourceConfig(profileProfileName string, profileProfileDescription string, profileProfileType string) string { +func testAccCheckIbmSccProfileDataSourceConfig(instanceID string, profileProfileName string, profileProfileDescription string, profileProfileType string) string { return fmt.Sprintf(` resource "ibm_scc_control_library" "scc_control_library_instance" { + instance_id = "%s" control_library_name = "control_library_name" control_library_description = "control_library_description" control_library_type = "custom" @@ -171,11 +173,12 @@ func testAccCheckIbmSccProfileDataSourceConfig(profileProfileName string, profil } resource "ibm_scc_profile" "scc_profile_instance" { + instance_id = resource.ibm_scc_control_library.scc_control_library_instance.instance_id profile_name = "%s" profile_description = "%s" profile_type = "%s" controls { - control_library_id = resource.ibm_scc_control_library.scc_control_library_instance.id + control_library_id = resource.ibm_scc_control_library.scc_control_library_instance.control_library_id control_id = resource.ibm_scc_control_library.scc_control_library_instance.controls[0].control_id } default_parameters { @@ -183,7 +186,8 @@ func testAccCheckIbmSccProfileDataSourceConfig(profileProfileName string, profil } data "ibm_scc_profile" "scc_profile_instance" { - profile_id = ibm_scc_profile.scc_profile_instance.id + profile_id = resource.ibm_scc_profile.scc_profile_instance.profile_id + instance_id = resource.ibm_scc_profile.scc_profile_instance.instance_id } - `, profileProfileName, profileProfileDescription, profileProfileType) + `, instanceID, profileProfileName, profileProfileDescription, profileProfileType) } diff --git a/ibm/service/scc/data_source_ibm_scc_provider_type_collection_test.go b/ibm/service/scc/data_source_ibm_scc_provider_type_collection_test.go index e40969244f..b6a6969e9b 100644 --- a/ibm/service/scc/data_source_ibm_scc_provider_type_collection_test.go +++ b/ibm/service/scc/data_source_ibm_scc_provider_type_collection_test.go @@ -14,7 +14,7 @@ import ( func TestAccIbmSccProviderTypeCollectionDataSourceBasic(t *testing.T) { resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, Steps: []resource.TestStep{ resource.TestStep{ diff --git a/ibm/service/scc/data_source_ibm_scc_provider_type_instance.go b/ibm/service/scc/data_source_ibm_scc_provider_type_instance.go index ce129f670b..ce95151b29 100644 --- a/ibm/service/scc/data_source_ibm_scc_provider_type_instance.go +++ b/ibm/service/scc/data_source_ibm_scc_provider_type_instance.go @@ -17,7 +17,7 @@ import ( ) func DataSourceIbmSccProviderTypeInstance() *schema.Resource { - return &schema.Resource{ + return AddSchemaData(&schema.Resource{ ReadContext: dataSourceIbmSccProviderTypeInstanceRead, Schema: map[string]*schema.Schema{ @@ -61,7 +61,7 @@ func DataSourceIbmSccProviderTypeInstance() *schema.Resource { Description: "Time at which resource was updated.", }, }, - } + }) } func dataSourceIbmSccProviderTypeInstanceRead(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { @@ -74,6 +74,7 @@ func dataSourceIbmSccProviderTypeInstanceRead(context context.Context, d *schema getProviderTypeInstanceOptions.SetProviderTypeID(d.Get("provider_type_id").(string)) getProviderTypeInstanceOptions.SetProviderTypeInstanceID(d.Get("provider_type_instance_id").(string)) + getProviderTypeInstanceOptions.SetInstanceID(d.Get("instance_id").(string)) providerTypeInstanceItem, response, err := securityAndComplianceCenterApIsClient.GetProviderTypeInstanceWithContext(context, getProviderTypeInstanceOptions) if err != nil { diff --git a/ibm/service/scc/data_source_ibm_scc_provider_type_instance_test.go b/ibm/service/scc/data_source_ibm_scc_provider_type_instance_test.go index 11a592e4f5..f5ae316512 100644 --- a/ibm/service/scc/data_source_ibm_scc_provider_type_instance_test.go +++ b/ibm/service/scc/data_source_ibm_scc_provider_type_instance_test.go @@ -5,7 +5,6 @@ package scc_test import ( "fmt" - "os" "testing" "github.com/hashicorp/terraform-plugin-sdk/v2/helper/acctest" @@ -16,14 +15,12 @@ import ( func TestAccIbmSccProviderTypeInstanceDataSourceBasic(t *testing.T) { providerTypeInstanceName := fmt.Sprintf("tf_provider_type_instance_name_%d", acctest.RandIntRange(10, 100)) - providerTypeInstanceAttributes := os.Getenv("IBMCLOUD_SCC_PROVIDER_TYPE_ATTRIBUTES") - resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, Steps: []resource.TestStep{ { - Config: testAccCheckIbmSccProviderTypeInstanceDataSourceConfigBasic(providerTypeInstanceName, providerTypeInstanceAttributes), + Config: testAccCheckIbmSccProviderTypeInstanceDataSourceConfigBasic(acc.SccInstanceID, providerTypeInstanceName, acc.SccProviderTypeAttributes), Check: resource.ComposeTestCheckFunc( resource.TestCheckResourceAttrSet("data.ibm_scc_provider_type_instance.scc_provider_type_instance_tf", "id"), resource.TestCheckResourceAttrSet("data.ibm_scc_provider_type_instance.scc_provider_type_instance_tf", "provider_type_id"), @@ -36,14 +33,13 @@ func TestAccIbmSccProviderTypeInstanceDataSourceBasic(t *testing.T) { func TestAccIbmSccProviderTypeInstanceDataSourceAllArgs(t *testing.T) { providerTypeInstanceName := fmt.Sprintf("tf_provider_type_instance_name_%d", acctest.RandIntRange(10, 100)) - providerTypeInstanceAttributes := os.Getenv("IBMCLOUD_SCC_PROVIDER_TYPE_ATTRIBUTES") resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, Steps: []resource.TestStep{ { - Config: testAccCheckIbmSccProviderTypeInstanceDataSourceConfig(providerTypeInstanceName, providerTypeInstanceAttributes), + Config: testAccCheckIbmSccProviderTypeInstanceDataSourceConfig(acc.SccInstanceID, providerTypeInstanceName, acc.SccProviderTypeAttributes), Check: resource.ComposeTestCheckFunc( resource.TestCheckResourceAttrSet("data.ibm_scc_provider_type_instance.scc_provider_type_instance_tf", "id"), resource.TestCheckResourceAttrSet("data.ibm_scc_provider_type_instance.scc_provider_type_instance_tf", "provider_type_id"), @@ -59,32 +55,36 @@ func TestAccIbmSccProviderTypeInstanceDataSourceAllArgs(t *testing.T) { }) } -func testAccCheckIbmSccProviderTypeInstanceDataSourceConfigBasic(providerTypeInstanceName string, providerTypeInstanceAttributes string) string { +func testAccCheckIbmSccProviderTypeInstanceDataSourceConfigBasic(instanceID string, providerTypeInstanceName string, providerTypeInstanceAttributes string) string { return fmt.Sprintf(` resource "ibm_scc_provider_type_instance" "scc_provider_type_instance" { + instance_id = "%s" provider_type_id = "afa2476ecfa5f09af248492fe991b4d1" name = "%s" attributes = %s } data "ibm_scc_provider_type_instance" "scc_provider_type_instance_tf" { + instance_id = resource.ibm_scc_provider_type_instance.scc_provider_type_instance.instance_id provider_type_id = ibm_scc_provider_type_instance.scc_provider_type_instance.provider_type_id provider_type_instance_id = ibm_scc_provider_type_instance.scc_provider_type_instance.provider_type_instance_id } - `, providerTypeInstanceName, providerTypeInstanceAttributes) + `, instanceID, providerTypeInstanceName, providerTypeInstanceAttributes) } -func testAccCheckIbmSccProviderTypeInstanceDataSourceConfig(providerTypeInstanceName string, providerTypeInstanceAttributes string) string { +func testAccCheckIbmSccProviderTypeInstanceDataSourceConfig(instanceID string, providerTypeInstanceName string, providerTypeInstanceAttributes string) string { return fmt.Sprintf(` resource "ibm_scc_provider_type_instance" "scc_provider_type_instance" { + instance_id = "%s" provider_type_id = "afa2476ecfa5f09af248492fe991b4d1" name = "%s" attributes = %s } data "ibm_scc_provider_type_instance" "scc_provider_type_instance_tf" { + instance_id = resource.ibm_scc_provider_type_instance.scc_provider_type_instance.instance_id provider_type_id = ibm_scc_provider_type_instance.scc_provider_type_instance.provider_type_id provider_type_instance_id = ibm_scc_provider_type_instance.scc_provider_type_instance.provider_type_instance_id } - `, providerTypeInstanceName, providerTypeInstanceAttributes) + `, instanceID, providerTypeInstanceName, providerTypeInstanceAttributes) } diff --git a/ibm/service/scc/data_source_ibm_scc_provider_type_test.go b/ibm/service/scc/data_source_ibm_scc_provider_type_test.go index ded3202436..ea2db7e89e 100644 --- a/ibm/service/scc/data_source_ibm_scc_provider_type_test.go +++ b/ibm/service/scc/data_source_ibm_scc_provider_type_test.go @@ -14,7 +14,7 @@ import ( func TestAccIbmSccProviderTypeDataSourceBasic(t *testing.T) { resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, Steps: []resource.TestStep{ resource.TestStep{ diff --git a/ibm/service/scc/data_source_ibm_scc_report.go b/ibm/service/scc/data_source_ibm_scc_report.go index f7f03ebac4..e3e8f366cc 100644 --- a/ibm/service/scc/data_source_ibm_scc_report.go +++ b/ibm/service/scc/data_source_ibm_scc_report.go @@ -16,7 +16,7 @@ import ( ) func DataSourceIbmSccReport() *schema.Resource { - return &schema.Resource{ + return AddSchemaData(&schema.Resource{ ReadContext: dataSourceIbmSccReportRead, Schema: map[string]*schema.Schema{ @@ -176,7 +176,7 @@ func DataSourceIbmSccReport() *schema.Resource { }, }, }, - } + }) } func dataSourceIbmSccReportRead(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { @@ -188,6 +188,7 @@ func dataSourceIbmSccReportRead(context context.Context, d *schema.ResourceData, getReportOptions := &securityandcompliancecenterapiv3.GetReportOptions{} getReportOptions.SetReportID(d.Get("report_id").(string)) + getReportOptions.SetInstanceID(d.Get("instance_id").(string)) report, response, err := resultsClient.GetReportWithContext(context, getReportOptions) if err != nil { diff --git a/ibm/service/scc/data_source_ibm_scc_report_controls.go b/ibm/service/scc/data_source_ibm_scc_report_controls.go index 141213fc3f..798707827a 100644 --- a/ibm/service/scc/data_source_ibm_scc_report_controls.go +++ b/ibm/service/scc/data_source_ibm_scc_report_controls.go @@ -18,7 +18,7 @@ import ( ) func DataSourceIbmSccReportControls() *schema.Resource { - return &schema.Resource{ + return AddSchemaData(&schema.Resource{ ReadContext: dataSourceIbmSccReportControlsRead, Schema: map[string]*schema.Schema{ @@ -289,7 +289,7 @@ func DataSourceIbmSccReportControls() *schema.Resource { }, }, }, - } + }) } func dataSourceIbmSccReportControlsRead(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { @@ -301,6 +301,7 @@ func dataSourceIbmSccReportControlsRead(context context.Context, d *schema.Resou getReportControlsOptions := &securityandcompliancecenterapiv3.GetReportControlsOptions{} getReportControlsOptions.SetReportID(d.Get("report_id").(string)) + getReportControlsOptions.SetInstanceID(d.Get("instance_id").(string)) if _, ok := d.GetOk("control_id"); ok { getReportControlsOptions.SetControlID(d.Get("control_id").(string)) } diff --git a/ibm/service/scc/data_source_ibm_scc_report_controls_test.go b/ibm/service/scc/data_source_ibm_scc_report_controls_test.go index adec094fab..d3e6d13eeb 100644 --- a/ibm/service/scc/data_source_ibm_scc_report_controls_test.go +++ b/ibm/service/scc/data_source_ibm_scc_report_controls_test.go @@ -5,7 +5,6 @@ package scc_test import ( "fmt" - "os" "testing" "github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource" @@ -14,12 +13,13 @@ import ( ) func TestAccIbmSccReportControlsDataSourceBasic(t *testing.T) { + resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, Steps: []resource.TestStep{ { - Config: testAccCheckIbmSccReportControlsDataSourceConfigBasic(), + Config: testAccCheckIbmSccReportControlsDataSourceConfigBasic(acc.SccInstanceID, acc.SccReportID), Check: resource.ComposeTestCheckFunc( resource.TestCheckResourceAttrSet("data.ibm_scc_report_controls.scc_report_controls_instance", "id"), resource.TestCheckResourceAttrSet("data.ibm_scc_report_controls.scc_report_controls_instance", "report_id"), @@ -29,11 +29,11 @@ func TestAccIbmSccReportControlsDataSourceBasic(t *testing.T) { }) } -func testAccCheckIbmSccReportControlsDataSourceConfigBasic() string { - report_id := os.Getenv("IBMCLOUD_SCC_REPORT_ID") +func testAccCheckIbmSccReportControlsDataSourceConfigBasic(instanceID, reportID string) string { return fmt.Sprintf(` data "ibm_scc_report_controls" "scc_report_controls_instance" { + instance_id = "%s" report_id = "%s" } - `, report_id) + `, instanceID, reportID) } diff --git a/ibm/service/scc/data_source_ibm_scc_report_evaluations.go b/ibm/service/scc/data_source_ibm_scc_report_evaluations.go index 24fc6f6100..1b2b34c304 100644 --- a/ibm/service/scc/data_source_ibm_scc_report_evaluations.go +++ b/ibm/service/scc/data_source_ibm_scc_report_evaluations.go @@ -18,7 +18,7 @@ import ( ) func DataSourceIbmSccReportEvaluations() *schema.Resource { - return &schema.Resource{ + return AddSchemaData(&schema.Resource{ ReadContext: dataSourceIbmSccReportEvaluationsRead, Schema: map[string]*schema.Schema{ @@ -256,7 +256,7 @@ func DataSourceIbmSccReportEvaluations() *schema.Resource { }, }, }, - } + }) } func dataSourceIbmSccReportEvaluationsRead(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { @@ -268,6 +268,7 @@ func dataSourceIbmSccReportEvaluationsRead(context context.Context, d *schema.Re listReportEvaluationsOptions := &securityandcompliancecenterapiv3.ListReportEvaluationsOptions{} listReportEvaluationsOptions.SetReportID(d.Get("report_id").(string)) + listReportEvaluationsOptions.SetInstanceID(d.Get("instance_id").(string)) if _, ok := d.GetOk("assessment_id"); ok { listReportEvaluationsOptions.SetAssessmentID(d.Get("assessment_id").(string)) } diff --git a/ibm/service/scc/data_source_ibm_scc_report_evaluations_test.go b/ibm/service/scc/data_source_ibm_scc_report_evaluations_test.go index bab407752a..e7019dc543 100644 --- a/ibm/service/scc/data_source_ibm_scc_report_evaluations_test.go +++ b/ibm/service/scc/data_source_ibm_scc_report_evaluations_test.go @@ -5,7 +5,6 @@ package scc_test import ( "fmt" - "os" "testing" "github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource" @@ -15,11 +14,11 @@ import ( func TestAccIbmSccReportEvaluationsDataSourceBasic(t *testing.T) { resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, Steps: []resource.TestStep{ resource.TestStep{ - Config: testAccCheckIbmSccReportEvaluationsDataSourceConfigBasic(), + Config: testAccCheckIbmSccReportEvaluationsDataSourceConfigBasic(acc.SccInstanceID, acc.SccReportID), Check: resource.ComposeTestCheckFunc( resource.TestCheckResourceAttrSet("data.ibm_scc_report_evaluations.scc_report_evaluations_instance", "id"), resource.TestCheckResourceAttrSet("data.ibm_scc_report_evaluations.scc_report_evaluations_instance", "report_id"), @@ -30,11 +29,11 @@ func TestAccIbmSccReportEvaluationsDataSourceBasic(t *testing.T) { }) } -func testAccCheckIbmSccReportEvaluationsDataSourceConfigBasic() string { - report_id := os.Getenv("IBMCLOUD_SCC_REPORT_ID") +func testAccCheckIbmSccReportEvaluationsDataSourceConfigBasic(instanceID, reportID string) string { return fmt.Sprintf(` data "ibm_scc_report_evaluations" "scc_report_evaluations_instance" { + instance_id = "%s" report_id = "%s" } - `, report_id) + `, instanceID, reportID) } diff --git a/ibm/service/scc/data_source_ibm_scc_report_resources.go b/ibm/service/scc/data_source_ibm_scc_report_resources.go index d040497f29..5fe353e6d6 100644 --- a/ibm/service/scc/data_source_ibm_scc_report_resources.go +++ b/ibm/service/scc/data_source_ibm_scc_report_resources.go @@ -18,7 +18,7 @@ import ( ) func DataSourceIbmSccReportResources() *schema.Resource { - return &schema.Resource{ + return AddSchemaData(&schema.Resource{ ReadContext: dataSourceIbmSccReportResourcesRead, Schema: map[string]*schema.Schema{ @@ -165,7 +165,7 @@ func DataSourceIbmSccReportResources() *schema.Resource { }, }, }, - } + }) } func dataSourceIbmSccReportResourcesRead(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { @@ -177,6 +177,7 @@ func dataSourceIbmSccReportResourcesRead(context context.Context, d *schema.Reso listReportResourcesOptions := &securityandcompliancecenterapiv3.ListReportResourcesOptions{} listReportResourcesOptions.SetReportID(d.Get("report_id").(string)) + listReportResourcesOptions.SetInstanceID(d.Get("instance_id").(string)) if _, ok := d.GetOk("id"); ok { listReportResourcesOptions.SetID(d.Get("id").(string)) } diff --git a/ibm/service/scc/data_source_ibm_scc_report_resources_test.go b/ibm/service/scc/data_source_ibm_scc_report_resources_test.go index 352bc33432..4334ea3fa2 100644 --- a/ibm/service/scc/data_source_ibm_scc_report_resources_test.go +++ b/ibm/service/scc/data_source_ibm_scc_report_resources_test.go @@ -5,7 +5,6 @@ package scc_test import ( "fmt" - "os" "testing" "github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource" @@ -15,11 +14,11 @@ import ( func TestAccIbmSccReportResourcesDataSourceBasic(t *testing.T) { resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, Steps: []resource.TestStep{ resource.TestStep{ - Config: testAccCheckIbmSccReportResourcesDataSourceConfigBasic(), + Config: testAccCheckIbmSccReportResourcesDataSourceConfigBasic(acc.SccInstanceID, acc.SccReportID), Check: resource.ComposeTestCheckFunc( resource.TestCheckResourceAttrSet("data.ibm_scc_report_resources.scc_report_resources_instance", "id"), resource.TestCheckResourceAttrSet("data.ibm_scc_report_resources.scc_report_resources_instance", "report_id"), @@ -30,11 +29,11 @@ func TestAccIbmSccReportResourcesDataSourceBasic(t *testing.T) { }) } -func testAccCheckIbmSccReportResourcesDataSourceConfigBasic() string { - report_id := os.Getenv("IBMCLOUD_SCC_REPORT_ID") +func testAccCheckIbmSccReportResourcesDataSourceConfigBasic(instanceID, reportID string) string { return fmt.Sprintf(` data "ibm_scc_report_resources" "scc_report_resources_instance" { + instance_id = "%s" report_id = "%s" } - `, report_id) + `, instanceID, reportID) } diff --git a/ibm/service/scc/data_source_ibm_scc_report_rule.go b/ibm/service/scc/data_source_ibm_scc_report_rule.go index ce5e218bc9..b920a20c56 100644 --- a/ibm/service/scc/data_source_ibm_scc_report_rule.go +++ b/ibm/service/scc/data_source_ibm_scc_report_rule.go @@ -16,7 +16,7 @@ import ( ) func DataSourceIbmSccReportRule() *schema.Resource { - return &schema.Resource{ + return AddSchemaData(&schema.Resource{ ReadContext: dataSourceIbmSccReportRuleRead, Schema: map[string]*schema.Schema{ @@ -84,7 +84,7 @@ func DataSourceIbmSccReportRule() *schema.Resource { }, }, }, - } + }) } func dataSourceIbmSccReportRuleRead(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { @@ -97,6 +97,7 @@ func dataSourceIbmSccReportRuleRead(context context.Context, d *schema.ResourceD getReportRuleOptions.SetReportID(d.Get("report_id").(string)) getReportRuleOptions.SetRuleID(d.Get("rule_id").(string)) + getReportRuleOptions.SetInstanceID(d.Get("instance_id").(string)) ruleInfo, response, err := resultsClient.GetReportRuleWithContext(context, getReportRuleOptions) if err != nil { diff --git a/ibm/service/scc/data_source_ibm_scc_report_rule_test.go b/ibm/service/scc/data_source_ibm_scc_report_rule_test.go index 649c1fcd03..ace64c9529 100644 --- a/ibm/service/scc/data_source_ibm_scc_report_rule_test.go +++ b/ibm/service/scc/data_source_ibm_scc_report_rule_test.go @@ -5,7 +5,6 @@ package scc_test import ( "fmt" - "os" "testing" "github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource" @@ -14,12 +13,13 @@ import ( ) func TestAccIbmSccReportRuleDataSourceBasic(t *testing.T) { + resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, Steps: []resource.TestStep{ - resource.TestStep{ - Config: testAccCheckIbmSccReportRuleDataSourceConfigBasic(), + { + Config: testAccCheckIbmSccReportRuleDataSourceConfigBasic(acc.SccInstanceID, acc.SccReportID), Check: resource.ComposeTestCheckFunc( resource.TestCheckResourceAttrSet("data.ibm_scc_report_rule.scc_report_rule_instance", "id"), resource.TestCheckResourceAttrSet("data.ibm_scc_report_rule.scc_report_rule_instance", "report_id"), @@ -30,12 +30,12 @@ func TestAccIbmSccReportRuleDataSourceBasic(t *testing.T) { }) } -func testAccCheckIbmSccReportRuleDataSourceConfigBasic() string { - report_id := os.Getenv("IBMCLOUD_SCC_REPORT_ID") +func testAccCheckIbmSccReportRuleDataSourceConfigBasic(instanceID, reportID string) string { return fmt.Sprintf(` data "ibm_scc_report_rule" "scc_report_rule_instance" { + instance_id = "%s" report_id = "%s" rule_id = "rule-f8722625-1968-4d7a-93cb-4b0f8da726da" } - `, report_id) + `, instanceID, reportID) } diff --git a/ibm/service/scc/data_source_ibm_scc_report_summary.go b/ibm/service/scc/data_source_ibm_scc_report_summary.go index 086838f0f2..ebac6cd966 100644 --- a/ibm/service/scc/data_source_ibm_scc_report_summary.go +++ b/ibm/service/scc/data_source_ibm_scc_report_summary.go @@ -18,7 +18,7 @@ import ( ) func DataSourceIbmSccReportSummary() *schema.Resource { - return &schema.Resource{ + return AddSchemaData(&schema.Resource{ ReadContext: dataSourceIbmSccReportSummaryRead, Schema: map[string]*schema.Schema{ @@ -290,7 +290,7 @@ func DataSourceIbmSccReportSummary() *schema.Resource { }, }, }, - } + }) } func dataSourceIbmSccReportSummaryRead(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { @@ -302,6 +302,7 @@ func dataSourceIbmSccReportSummaryRead(context context.Context, d *schema.Resour getReportSummaryOptions := &securityandcompliancecenterapiv3.GetReportSummaryOptions{} getReportSummaryOptions.SetReportID(d.Get("report_id").(string)) + getReportSummaryOptions.SetInstanceID(d.Get("instance_id").(string)) reportSummary, response, err := resultsClient.GetReportSummaryWithContext(context, getReportSummaryOptions) if err != nil { diff --git a/ibm/service/scc/data_source_ibm_scc_report_summary_test.go b/ibm/service/scc/data_source_ibm_scc_report_summary_test.go index e28d55ec2b..6339470867 100644 --- a/ibm/service/scc/data_source_ibm_scc_report_summary_test.go +++ b/ibm/service/scc/data_source_ibm_scc_report_summary_test.go @@ -5,7 +5,6 @@ package scc_test import ( "fmt" - "os" "testing" "github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource" @@ -15,11 +14,11 @@ import ( func TestAccIbmSccReportSummaryDataSourceBasic(t *testing.T) { resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, Steps: []resource.TestStep{ resource.TestStep{ - Config: testAccCheckIbmSccReportSummaryDataSourceConfigBasic(), + Config: testAccCheckIbmSccReportSummaryDataSourceConfigBasic(acc.SccInstanceID, acc.SccReportID), Check: resource.ComposeTestCheckFunc( resource.TestCheckResourceAttrSet("data.ibm_scc_report_summary.scc_report_summary_instance", "id"), resource.TestCheckResourceAttrSet("data.ibm_scc_report_summary.scc_report_summary_instance", "report_id"), @@ -29,11 +28,11 @@ func TestAccIbmSccReportSummaryDataSourceBasic(t *testing.T) { }) } -func testAccCheckIbmSccReportSummaryDataSourceConfigBasic() string { - report_id := os.Getenv("IBMCLOUD_SCC_REPORT_ID") +func testAccCheckIbmSccReportSummaryDataSourceConfigBasic(instanceID, reportID string) string { return fmt.Sprintf(` data "ibm_scc_report_summary" "scc_report_summary_instance" { + instance_id = "%s" report_id = "%s" } - `, report_id) + `, instanceID, reportID) } diff --git a/ibm/service/scc/data_source_ibm_scc_report_tags.go b/ibm/service/scc/data_source_ibm_scc_report_tags.go index ad46601842..270dc45ff2 100644 --- a/ibm/service/scc/data_source_ibm_scc_report_tags.go +++ b/ibm/service/scc/data_source_ibm_scc_report_tags.go @@ -17,7 +17,7 @@ import ( ) func DataSourceIbmSccReportTags() *schema.Resource { - return &schema.Resource{ + return AddSchemaData(&schema.Resource{ ReadContext: dataSourceIbmSccReportTagsRead, Schema: map[string]*schema.Schema{ @@ -60,7 +60,7 @@ func DataSourceIbmSccReportTags() *schema.Resource { }, }, }, - } + }) } func dataSourceIbmSccReportTagsRead(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { @@ -72,6 +72,7 @@ func dataSourceIbmSccReportTagsRead(context context.Context, d *schema.ResourceD getReportTagsOptions := &securityandcompliancecenterapiv3.GetReportTagsOptions{} getReportTagsOptions.SetReportID(d.Get("report_id").(string)) + getReportTagsOptions.SetInstanceID(d.Get("instance_id").(string)) reportTags, response, err := resultsClient.GetReportTagsWithContext(context, getReportTagsOptions) if err != nil { diff --git a/ibm/service/scc/data_source_ibm_scc_report_tags_test.go b/ibm/service/scc/data_source_ibm_scc_report_tags_test.go index 8319f6a27c..c7ff551d09 100644 --- a/ibm/service/scc/data_source_ibm_scc_report_tags_test.go +++ b/ibm/service/scc/data_source_ibm_scc_report_tags_test.go @@ -5,7 +5,6 @@ package scc_test import ( "fmt" - "os" "testing" "github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource" @@ -15,11 +14,11 @@ import ( func TestAccIbmSccReportTagsDataSourceBasic(t *testing.T) { resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, Steps: []resource.TestStep{ - resource.TestStep{ - Config: testAccCheckIbmSccReportTagsDataSourceConfigBasic(), + { + Config: testAccCheckIbmSccReportTagsDataSourceConfigBasic(acc.SccInstanceID, acc.SccReportID), Check: resource.ComposeTestCheckFunc( resource.TestCheckResourceAttrSet("data.ibm_scc_report_tags.scc_report_tags_instance", "id"), resource.TestCheckResourceAttrSet("data.ibm_scc_report_tags.scc_report_tags_instance", "report_id"), @@ -29,11 +28,11 @@ func TestAccIbmSccReportTagsDataSourceBasic(t *testing.T) { }) } -func testAccCheckIbmSccReportTagsDataSourceConfigBasic() string { - report_id := os.Getenv("IBMCLOUD_SCC_REPORT_ID") +func testAccCheckIbmSccReportTagsDataSourceConfigBasic(instanceID, reportID string) string { return fmt.Sprintf(` data "ibm_scc_report_tags" "scc_report_tags_instance" { + instance_id = "%s" report_id = "%s" } - `, report_id) + `, instanceID, reportID) } diff --git a/ibm/service/scc/data_source_ibm_scc_report_test.go b/ibm/service/scc/data_source_ibm_scc_report_test.go index 19feffc1b5..9aad4050f7 100644 --- a/ibm/service/scc/data_source_ibm_scc_report_test.go +++ b/ibm/service/scc/data_source_ibm_scc_report_test.go @@ -5,7 +5,6 @@ package scc_test import ( "fmt" - "os" "testing" "github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource" @@ -15,11 +14,11 @@ import ( func TestAccIbmSccReportDataSourceBasic(t *testing.T) { resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, Steps: []resource.TestStep{ { - Config: testAccCheckIbmSccReportDataSourceConfigBasic(), + Config: testAccCheckIbmSccReportDataSourceConfigBasic(acc.SccInstanceID, acc.SccReportID), Check: resource.ComposeTestCheckFunc( resource.TestCheckResourceAttrSet("data.ibm_scc_report.scc_report_instance", "id"), resource.TestCheckResourceAttrSet("data.ibm_scc_report.scc_report_instance", "report_id"), @@ -29,11 +28,11 @@ func TestAccIbmSccReportDataSourceBasic(t *testing.T) { }) } -func testAccCheckIbmSccReportDataSourceConfigBasic() string { - report_id := os.Getenv("IBMCLOUD_SCC_REPORT_ID") +func testAccCheckIbmSccReportDataSourceConfigBasic(instanceID, reportID string) string { return fmt.Sprintf(` data "ibm_scc_report" "scc_report_instance" { + instance_id = "%s" report_id = "%s" } - `, report_id) + `, instanceID, reportID) } diff --git a/ibm/service/scc/data_source_ibm_scc_report_violation_drift.go b/ibm/service/scc/data_source_ibm_scc_report_violation_drift.go index 39ba6b307d..8a4487f084 100644 --- a/ibm/service/scc/data_source_ibm_scc_report_violation_drift.go +++ b/ibm/service/scc/data_source_ibm_scc_report_violation_drift.go @@ -18,7 +18,7 @@ import ( ) func DataSourceIbmSccReportViolationDrift() *schema.Resource { - return &schema.Resource{ + return AddSchemaData(&schema.Resource{ ReadContext: dataSourceIbmSccReportViolationDriftRead, Schema: map[string]*schema.Schema{ @@ -102,7 +102,7 @@ func DataSourceIbmSccReportViolationDrift() *schema.Resource { }, }, }, - } + }) } func dataSourceIbmSccReportViolationDriftRead(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { @@ -114,6 +114,7 @@ func dataSourceIbmSccReportViolationDriftRead(context context.Context, d *schema getReportViolationsDriftOptions := &securityandcompliancecenterapiv3.GetReportViolationsDriftOptions{} getReportViolationsDriftOptions.SetReportID(d.Get("report_id").(string)) + getReportViolationsDriftOptions.SetInstanceID(d.Get("instance_id").(string)) if _, ok := d.GetOk("scan_time_duration"); ok { getReportViolationsDriftOptions.SetScanTimeDuration(int64(d.Get("scan_time_duration").(int))) } diff --git a/ibm/service/scc/data_source_ibm_scc_report_violation_drift_test.go b/ibm/service/scc/data_source_ibm_scc_report_violation_drift_test.go index 829942fc77..496779ad72 100644 --- a/ibm/service/scc/data_source_ibm_scc_report_violation_drift_test.go +++ b/ibm/service/scc/data_source_ibm_scc_report_violation_drift_test.go @@ -5,7 +5,6 @@ package scc_test import ( "fmt" - "os" "testing" "github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource" @@ -15,11 +14,11 @@ import ( func TestAccIbmSccReportViolationDriftDataSourceBasic(t *testing.T) { resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, Steps: []resource.TestStep{ resource.TestStep{ - Config: testAccCheckIbmSccReportViolationDriftDataSourceConfigBasic(), + Config: testAccCheckIbmSccReportViolationDriftDataSourceConfigBasic(acc.SccInstanceID, acc.SccReportID), Check: resource.ComposeTestCheckFunc( resource.TestCheckResourceAttrSet("data.ibm_scc_report_violation_drift.scc_report_violation_drift_instance", "id"), resource.TestCheckResourceAttrSet("data.ibm_scc_report_violation_drift.scc_report_violation_drift_instance", "report_id"), @@ -29,11 +28,11 @@ func TestAccIbmSccReportViolationDriftDataSourceBasic(t *testing.T) { }) } -func testAccCheckIbmSccReportViolationDriftDataSourceConfigBasic() string { - report_id := os.Getenv("IBMCLOUD_SCC_REPORT_ID") +func testAccCheckIbmSccReportViolationDriftDataSourceConfigBasic(instanceID, reportID string) string { return fmt.Sprintf(` data "ibm_scc_report_violation_drift" "scc_report_violation_drift_instance" { + instance_id = "%s" report_id = "%s" } - `, report_id) + `, instanceID, reportID) } diff --git a/ibm/service/scc/data_source_ibm_scc_rule.go b/ibm/service/scc/data_source_ibm_scc_rule.go index 84eea610e9..a41bd61f5d 100644 --- a/ibm/service/scc/data_source_ibm_scc_rule.go +++ b/ibm/service/scc/data_source_ibm_scc_rule.go @@ -18,7 +18,7 @@ import ( ) func DataSourceIbmSccRule() *schema.Resource { - return &schema.Resource{ + return AddSchemaData(&schema.Resource{ ReadContext: dataSourceIbmSccRuleRead, Timeouts: &schema.ResourceTimeout{ Read: schema.DefaultTimeout(40 * time.Minute), @@ -373,7 +373,7 @@ func DataSourceIbmSccRule() *schema.Resource { }, }, }, - } + }) } func dataSourceIbmSccRuleRead(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { @@ -385,6 +385,7 @@ func dataSourceIbmSccRuleRead(context context.Context, d *schema.ResourceData, m getRuleOptions := &securityandcompliancecenterapiv3.GetRuleOptions{} getRuleOptions.SetRuleID(d.Get("rule_id").(string)) + getRuleOptions.SetInstanceID(d.Get("instance_id").(string)) rule, response, err := configManagerClient.GetRuleWithContext(context, getRuleOptions) if err != nil { diff --git a/ibm/service/scc/data_source_ibm_scc_rule_test.go b/ibm/service/scc/data_source_ibm_scc_rule_test.go index 92cbeef72a..a7218bdaf8 100644 --- a/ibm/service/scc/data_source_ibm_scc_rule_test.go +++ b/ibm/service/scc/data_source_ibm_scc_rule_test.go @@ -17,11 +17,11 @@ func TestAccIbmSccRuleDataSourceBasic(t *testing.T) { ruleDescription := fmt.Sprintf("tf_description_%d", acctest.RandIntRange(10, 100)) resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, Steps: []resource.TestStep{ { - Config: testAccCheckIbmSccRuleDataSourceConfigBasic(ruleDescription), + Config: testAccCheckIbmSccRuleDataSourceConfigBasic(acc.SccInstanceID, ruleDescription), Check: resource.ComposeTestCheckFunc( resource.TestCheckResourceAttrSet("data.ibm_scc_rule.scc_rule_instance", "id"), resource.TestCheckResourceAttrSet("data.ibm_scc_rule.scc_rule_instance", "rule_id"), @@ -48,11 +48,11 @@ func TestAccIbmSccRuleDataSourceAllArgs(t *testing.T) { ruleVersion := "0.0.1" resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, Steps: []resource.TestStep{ { - Config: testAccCheckIbmSccRuleDataSourceConfig(ruleDescription, ruleVersion), + Config: testAccCheckIbmSccRuleDataSourceConfig(acc.SccInstanceID, ruleDescription, ruleVersion), Check: resource.ComposeTestCheckFunc( resource.TestCheckResourceAttrSet("data.ibm_scc_rule.scc_rule_instance", "id"), resource.TestCheckResourceAttrSet("data.ibm_scc_rule.scc_rule_instance", "rule_id"), @@ -75,9 +75,10 @@ func TestAccIbmSccRuleDataSourceAllArgs(t *testing.T) { }) } -func testAccCheckIbmSccRuleDataSourceConfigBasic(ruleDescription string) string { +func testAccCheckIbmSccRuleDataSourceConfigBasic(instanceID string, ruleDescription string) string { return fmt.Sprintf(` resource "ibm_scc_rule" "scc_rule_instance" { + instance_id = "%s" description = "%s" target { service_name = "cloud-object-storage" @@ -97,14 +98,16 @@ func testAccCheckIbmSccRuleDataSourceConfigBasic(ruleDescription string) string } data "ibm_scc_rule" "scc_rule_instance" { - rule_id = ibm_scc_rule.scc_rule_instance.id + instance_id = resource.ibm_scc_rule.scc_rule_instance.instance_id + rule_id = resource.ibm_scc_rule.scc_rule_instance.rule_id } - `, ruleDescription) + `, instanceID, ruleDescription) } -func testAccCheckIbmSccRuleDataSourceConfig(ruleDescription string, ruleVersion string) string { +func testAccCheckIbmSccRuleDataSourceConfig(instanceID string, ruleDescription string, ruleVersion string) string { return fmt.Sprintf(` resource "ibm_scc_rule" "scc_rule_instance" { + instance_id = "%s" description = "%s" target { service_name = "cloud-object-storage" @@ -124,7 +127,8 @@ func testAccCheckIbmSccRuleDataSourceConfig(ruleDescription string, ruleVersion } data "ibm_scc_rule" "scc_rule_instance" { - rule_id = ibm_scc_rule.scc_rule_instance.id + instance_id = resource.ibm_scc_rule.scc_rule_instance.instance_id + rule_id = resource.ibm_scc_rule.scc_rule_instance.rule_id } - `, ruleDescription, ruleVersion) + `, instanceID, ruleDescription, ruleVersion) } diff --git a/ibm/service/scc/ibm_scc_utilities.go b/ibm/service/scc/ibm_scc_utilities.go new file mode 100644 index 0000000000..baacbede0e --- /dev/null +++ b/ibm/service/scc/ibm_scc_utilities.go @@ -0,0 +1,43 @@ +// Copyright IBM Corp. 2023 All Rights Reserved. +// Licensed under the Mozilla Public License v2.0 + +package scc + +import ( + "strings" + + "github.com/IBM/scc-go-sdk/v5/securityandcompliancecenterapiv3" + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" +) + +const INSTANCE_ID = "instance_id" + +// AddSchemaData will add the Schemas 'instance_id' and 'region' to the resource +func AddSchemaData(resource *schema.Resource) *schema.Resource { + resource.Schema["instance_id"] = &schema.Schema{ + Type: schema.TypeString, + Required: true, + ForceNew: true, + Description: "The ID of the Security and Compliance Center instance.", + } + return resource +} + +// getRegionData will check if the field region is defined +func getRegionData(client securityandcompliancecenterapiv3.SecurityAndComplianceCenterApiV3, d *schema.ResourceData) string { + val, ok := d.GetOk("region") + if ok { + return val.(string) + } else { + url := client.Service.GetServiceURL() + return strings.Split(url, ".")[1] + } +} + +// setRegionData will set the field "region" field if the field was previously defined +func setRegionData(d *schema.ResourceData, region string) error { + if val, ok := d.GetOk("region"); ok { + return d.Set("region", val.(string)) + } + return nil +} diff --git a/ibm/service/scc/resource_ibm_scc_control_library.go b/ibm/service/scc/resource_ibm_scc_control_library.go index f89d21acda..381efbe2c3 100644 --- a/ibm/service/scc/resource_ibm_scc_control_library.go +++ b/ibm/service/scc/resource_ibm_scc_control_library.go @@ -19,7 +19,7 @@ import ( ) func ResourceIbmSccControlLibrary() *schema.Resource { - return &schema.Resource{ + return AddSchemaData(&schema.Resource{ CreateContext: resourceIbmSccControlLibraryCreate, ReadContext: resourceIbmSccControlLibraryRead, UpdateContext: resourceIbmSccControlLibraryUpdate, @@ -27,6 +27,11 @@ func ResourceIbmSccControlLibrary() *schema.Resource { Importer: &schema.ResourceImporter{}, Schema: map[string]*schema.Schema{ + "control_library_id": { + Type: schema.TypeString, + Computed: true, + Description: "The control library ID.", + }, "control_library_name": { Type: schema.TypeString, Required: true, @@ -276,7 +281,7 @@ func ResourceIbmSccControlLibrary() *schema.Resource { Description: "The number of parent controls in the control library.", }, }, - } + }) } func ResourceIbmSccControlLibraryValidator() *validate.ResourceValidator { @@ -340,6 +345,8 @@ func resourceIbmSccControlLibraryCreate(context context.Context, d *schema.Resou bodyModelMap := map[string]interface{}{} createCustomControlLibraryOptions := &securityandcompliancecenterapiv3.CreateCustomControlLibraryOptions{} + instance_id := d.Get("instance_id").(string) + bodyModelMap["instance_id"] = instance_id bodyModelMap["control_library_name"] = d.Get("control_library_name") bodyModelMap["control_library_description"] = d.Get("control_library_description") bodyModelMap["control_library_type"] = d.Get("control_library_type") @@ -369,7 +376,7 @@ func resourceIbmSccControlLibraryCreate(context context.Context, d *schema.Resou return diag.FromErr(fmt.Errorf("CreateCustomControlLibraryWithContext failed %s\n%s", err, response)) } - d.SetId(*controlLibrary.ID) + d.SetId(instance_id + "/" + *controlLibrary.ID) return resourceIbmSccControlLibraryRead(context, d, meta) } @@ -381,8 +388,12 @@ func resourceIbmSccControlLibraryRead(context context.Context, d *schema.Resourc } getControlLibraryOptions := &securityandcompliancecenterapiv3.GetControlLibraryOptions{} - - getControlLibraryOptions.SetControlLibrariesID(d.Id()) + parts, err := flex.SepIdParts(d.Id(), "/") + if err != nil { + return diag.FromErr(err) + } + getControlLibraryOptions.SetInstanceID(parts[0]) + getControlLibraryOptions.SetControlLibrariesID(parts[1]) controlLibrary, response, err := securityandcompliancecenterapiClient.GetControlLibraryWithContext(context, getControlLibraryOptions) if err != nil { @@ -393,7 +404,12 @@ func resourceIbmSccControlLibraryRead(context context.Context, d *schema.Resourc log.Printf("[DEBUG] GetControlLibraryWithContext failed %s\n%s", err, response) return diag.FromErr(fmt.Errorf("GetControlLibraryWithContext failed %s\n%s", err, response)) } - + if err = d.Set("instance_id", parts[0]); err != nil { + return diag.FromErr(fmt.Errorf("Error setting instance_id: %s", err)) + } + if err = d.Set("control_library_id", controlLibrary.ID); err != nil { + return diag.FromErr(fmt.Errorf("Error setting control_library_id: %s", err)) + } if err = d.Set("control_library_name", controlLibrary.ControlLibraryName); err != nil { return diag.FromErr(fmt.Errorf("Error setting control_library_name: %s", err)) } @@ -480,8 +496,12 @@ func resourceIbmSccControlLibraryUpdate(context context.Context, d *schema.Resou } replaceCustomControlLibraryOptions := &securityandcompliancecenterapiv3.ReplaceCustomControlLibraryOptions{} - - replaceCustomControlLibraryOptions.SetControlLibrariesID(d.Id()) + parts, err := flex.SepIdParts(d.Id(), "/") + if err != nil { + return diag.FromErr(err) + } + replaceCustomControlLibraryOptions.SetInstanceID(parts[0]) + replaceCustomControlLibraryOptions.SetControlLibrariesID(parts[1]) hasChange := false @@ -546,7 +566,12 @@ func resourceIbmSccControlLibraryDelete(context context.Context, d *schema.Resou deleteCustomControlLibraryOptions := &securityandcompliancecenterapiv3.DeleteCustomControlLibraryOptions{} - deleteCustomControlLibraryOptions.SetControlLibrariesID(d.Id()) + parts, err := flex.SepIdParts(d.Id(), "/") + if err != nil { + return diag.FromErr(err) + } + deleteCustomControlLibraryOptions.SetInstanceID(parts[0]) + deleteCustomControlLibraryOptions.SetControlLibrariesID(parts[1]) _, response, err := securityandcompliancecenterapiClient.DeleteCustomControlLibraryWithContext(context, deleteCustomControlLibraryOptions) if err != nil { @@ -776,6 +801,7 @@ func resourceIbmSccControlLibraryMapToControlLibrary(modelMap map[string]interfa func resourceIbmSccControlLibraryMapToControlLibraryPrototype(modelMap map[string]interface{}) (*securityandcompliancecenterapiv3.CreateCustomControlLibraryOptions, error) { model := &securityandcompliancecenterapiv3.CreateCustomControlLibraryOptions{} + model.InstanceID = core.StringPtr(modelMap["instance_id"].(string)) model.ControlLibraryName = core.StringPtr(modelMap["control_library_name"].(string)) model.ControlLibraryDescription = core.StringPtr(modelMap["control_library_description"].(string)) model.ControlLibraryType = core.StringPtr(modelMap["control_library_type"].(string)) diff --git a/ibm/service/scc/resource_ibm_scc_control_library_test.go b/ibm/service/scc/resource_ibm_scc_control_library_test.go index ecc8a35da2..d6b3656437 100644 --- a/ibm/service/scc/resource_ibm_scc_control_library_test.go +++ b/ibm/service/scc/resource_ibm_scc_control_library_test.go @@ -5,6 +5,7 @@ package scc_test import ( "fmt" + "strings" "testing" "github.com/hashicorp/terraform-plugin-sdk/v2/helper/acctest" @@ -26,12 +27,12 @@ func TestAccIbmSccControlLibraryBasic(t *testing.T) { controlLibraryTypeUpdate := controlLibraryType resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, CheckDestroy: testAccCheckIbmSccControlLibraryDestroy, Steps: []resource.TestStep{ resource.TestStep{ - Config: testAccCheckIbmSccControlLibraryConfigBasic(controlLibraryName, controlLibraryDescription, controlLibraryType), + Config: testAccCheckIbmSccControlLibraryConfigBasic(acc.SccInstanceID, controlLibraryName, controlLibraryDescription, controlLibraryType), Check: resource.ComposeAggregateTestCheckFunc( testAccCheckIbmSccControlLibraryExists("ibm_scc_control_library.scc_control_library_instance", conf), resource.TestCheckResourceAttr("ibm_scc_control_library.scc_control_library_instance", "control_library_name", controlLibraryName), @@ -40,7 +41,7 @@ func TestAccIbmSccControlLibraryBasic(t *testing.T) { ), }, resource.TestStep{ - Config: testAccCheckIbmSccControlLibraryConfigBasic(controlLibraryNameUpdate, controlLibraryDescriptionUpdate, controlLibraryTypeUpdate), + Config: testAccCheckIbmSccControlLibraryConfigBasic(acc.SccInstanceID, controlLibraryNameUpdate, controlLibraryDescriptionUpdate, controlLibraryTypeUpdate), Check: resource.ComposeAggregateTestCheckFunc( resource.TestCheckResourceAttr("ibm_scc_control_library.scc_control_library_instance", "control_library_name", controlLibraryNameUpdate), resource.TestCheckResourceAttr("ibm_scc_control_library.scc_control_library_instance", "control_library_description", controlLibraryDescriptionUpdate), @@ -69,12 +70,12 @@ func TestAccIbmSccControlLibraryAllArgs(t *testing.T) { latestUpdate := "true" resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, CheckDestroy: testAccCheckIbmSccControlLibraryDestroy, Steps: []resource.TestStep{ resource.TestStep{ - Config: testAccCheckIbmSccControlLibraryConfig(controlLibraryName, controlLibraryDescription, controlLibraryType, versionGroupLabel, controlLibraryVersion, latest), + Config: testAccCheckIbmSccControlLibraryConfig(acc.SccInstanceID, controlLibraryName, controlLibraryDescription, controlLibraryType, versionGroupLabel, controlLibraryVersion, latest), Check: resource.ComposeAggregateTestCheckFunc( testAccCheckIbmSccControlLibraryExists("ibm_scc_control_library.scc_control_library_instance", conf), resource.TestCheckResourceAttr("ibm_scc_control_library.scc_control_library_instance", "control_library_name", controlLibraryName), @@ -87,7 +88,7 @@ func TestAccIbmSccControlLibraryAllArgs(t *testing.T) { ), }, resource.TestStep{ - Config: testAccCheckIbmSccControlLibraryConfig(controlLibraryNameUpdate, controlLibraryDescriptionUpdate, controlLibraryTypeUpdate, versionGroupLabelUpdate, controlLibraryVersionUpdate, latestUpdate), + Config: testAccCheckIbmSccControlLibraryConfig(acc.SccInstanceID, controlLibraryNameUpdate, controlLibraryDescriptionUpdate, controlLibraryTypeUpdate, versionGroupLabelUpdate, controlLibraryVersionUpdate, latestUpdate), Check: resource.ComposeAggregateTestCheckFunc( resource.TestCheckResourceAttr("ibm_scc_control_library.scc_control_library_instance", "control_library_name", controlLibraryNameUpdate), resource.TestCheckResourceAttr("ibm_scc_control_library.scc_control_library_instance", "control_library_description", controlLibraryDescriptionUpdate), @@ -107,9 +108,10 @@ func TestAccIbmSccControlLibraryAllArgs(t *testing.T) { }) } -func testAccCheckIbmSccControlLibraryConfigBasic(controlLibraryName string, controlLibraryDescription string, controlLibraryType string) string { +func testAccCheckIbmSccControlLibraryConfigBasic(instanceID string, controlLibraryName string, controlLibraryDescription string, controlLibraryType string) string { return fmt.Sprintf(` resource "ibm_scc_control_library" "scc_control_library_instance" { + instance_id = "%s" control_library_name = "%s" control_library_description = "%s" control_library_type = "%s" @@ -148,13 +150,14 @@ func testAccCheckIbmSccControlLibraryConfigBasic(controlLibraryName string, cont status = "enabled" } } - `, controlLibraryName, controlLibraryDescription, controlLibraryType) + `, instanceID, controlLibraryName, controlLibraryDescription, controlLibraryType) } -func testAccCheckIbmSccControlLibraryConfig(controlLibraryName string, controlLibraryDescription string, controlLibraryType string, versionGroupLabel string, controlLibraryVersion string, latest string) string { +func testAccCheckIbmSccControlLibraryConfig(instanceID string, controlLibraryName string, controlLibraryDescription string, controlLibraryType string, versionGroupLabel string, controlLibraryVersion string, latest string) string { return fmt.Sprintf(` resource "ibm_scc_control_library" "scc_control_library_instance" { + instance_id = "%s" control_library_name = "%s" control_library_description = "%s" control_library_type = "%s" @@ -194,7 +197,7 @@ func testAccCheckIbmSccControlLibraryConfig(controlLibraryName string, controlLi status = "enabled" } } - `, controlLibraryName, controlLibraryDescription, controlLibraryType, versionGroupLabel, controlLibraryVersion, latest) + `, instanceID, controlLibraryName, controlLibraryDescription, controlLibraryType, versionGroupLabel, controlLibraryVersion, latest) } func testAccCheckIbmSccControlLibraryExists(n string, obj securityandcompliancecenterapiv3.ControlLibrary) resource.TestCheckFunc { @@ -212,7 +215,9 @@ func testAccCheckIbmSccControlLibraryExists(n string, obj securityandcompliancec getControlLibraryOptions := &securityandcompliancecenterapiv3.GetControlLibraryOptions{} - getControlLibraryOptions.SetControlLibrariesID(rs.Primary.ID) + id := strings.Split(rs.Primary.ID, "/") + getControlLibraryOptions.SetInstanceID(id[0]) + getControlLibraryOptions.SetControlLibrariesID(id[1]) controlLibrary, _, err := securityandcompliancecenterapiClient.GetControlLibrary(getControlLibraryOptions) if err != nil { @@ -236,7 +241,9 @@ func testAccCheckIbmSccControlLibraryDestroy(s *terraform.State) error { getControlLibraryOptions := &securityandcompliancecenterapiv3.GetControlLibraryOptions{} - getControlLibraryOptions.SetControlLibrariesID(rs.Primary.ID) + id := strings.Split(rs.Primary.ID, "/") + getControlLibraryOptions.SetInstanceID(id[0]) + getControlLibraryOptions.SetControlLibrariesID(id[1]) // Try to find the key _, response, err := securityandcompliancecenterapiClient.GetControlLibrary(getControlLibraryOptions) diff --git a/ibm/service/scc/resource_ibm_scc_profile.go b/ibm/service/scc/resource_ibm_scc_profile.go index d70e2bf221..0ba57cdf76 100644 --- a/ibm/service/scc/resource_ibm_scc_profile.go +++ b/ibm/service/scc/resource_ibm_scc_profile.go @@ -19,7 +19,7 @@ import ( ) func ResourceIbmSccProfile() *schema.Resource { - return &schema.Resource{ + return AddSchemaData(&schema.Resource{ CreateContext: resourceIbmSccProfileCreate, ReadContext: resourceIbmSccProfileRead, UpdateContext: resourceIbmSccProfileUpdate, @@ -27,6 +27,11 @@ func ResourceIbmSccProfile() *schema.Resource { Importer: &schema.ResourceImporter{}, Schema: map[string]*schema.Schema{ + "profile_id": { + Type: schema.TypeString, + Computed: true, + Description: "The profile name.", + }, "profile_name": { Type: schema.TypeString, Required: true, @@ -320,7 +325,7 @@ func ResourceIbmSccProfile() *schema.Resource { Description: "The number of attachments related to this profile.", }, }, - } + }) } func ResourceIbmSccProfileValidator() *validate.ResourceValidator { @@ -360,6 +365,8 @@ func resourceIbmSccProfileCreate(context context.Context, d *schema.ResourceData bodyModelMap := map[string]interface{}{} createProfileOptions := &securityandcompliancecenterapiv3.CreateProfileOptions{} + instance_id := d.Get("instance_id").(string) + bodyModelMap["instance_id"] = instance_id bodyModelMap["profile_name"] = d.Get("profile_name") bodyModelMap["profile_description"] = d.Get("profile_description") bodyModelMap["profile_type"] = "custom" @@ -376,6 +383,7 @@ func resourceIbmSccProfileCreate(context context.Context, d *schema.ResourceData return diag.FromErr(err) } createProfileOptions = convertedModel + createProfileOptions.SetInstanceID(instance_id) profile, response, err := securityandcompliancecenterapiClient.CreateProfileWithContext(context, createProfileOptions) if err != nil { @@ -383,7 +391,7 @@ func resourceIbmSccProfileCreate(context context.Context, d *schema.ResourceData return diag.FromErr(fmt.Errorf("CreateProfileWithContext failed %s\n%s", err, response)) } - d.SetId(*profile.ID) + d.SetId(instance_id + "/" + *profile.ID) return resourceIbmSccProfileRead(context, d, meta) } @@ -397,7 +405,12 @@ func resourceIbmSccProfileRead(context context.Context, d *schema.ResourceData, getProfileOptions := &securityandcompliancecenterapiv3.GetProfileOptions{} - getProfileOptions.SetProfileID(d.Id()) + parts, err := flex.SepIdParts(d.Id(), "/") + if err != nil { + return diag.FromErr(err) + } + getProfileOptions.SetInstanceID(parts[0]) + getProfileOptions.SetProfileID(parts[1]) profile, response, err := securityandcompliancecenterapiClient.GetProfileWithContext(context, getProfileOptions) if err != nil { @@ -409,6 +422,12 @@ func resourceIbmSccProfileRead(context context.Context, d *schema.ResourceData, return diag.FromErr(fmt.Errorf("GetProfileWithContext failed %s\n%s", err, response)) } + if err = d.Set("instance_id", parts[0]); err != nil { + return diag.FromErr(fmt.Errorf("Error setting instance_id: %s", err)) + } + if err = d.Set("profile_id", parts[1]); err != nil { + return diag.FromErr(fmt.Errorf("Error setting profile_id: %s", err)) + } if err = d.Set("profile_name", profile.ProfileName); err != nil { return diag.FromErr(fmt.Errorf("Error setting profile_name: %s", err)) } @@ -513,6 +532,12 @@ func resourceIbmSccProfileUpdate(context context.Context, d *schema.ResourceData } replaceProfileOptions := &securityandcompliancecenterapiv3.ReplaceProfileOptions{} + parts, err := flex.SepIdParts(d.Id(), "/") + if err != nil { + return diag.FromErr(err) + } + replaceProfileOptions.SetInstanceID(parts[0]) + replaceProfileOptions.SetProfileID(parts[1]) hasChange := false bodyModelMap := map[string]interface{}{} @@ -568,7 +593,12 @@ func resourceIbmSccProfileDelete(context context.Context, d *schema.ResourceData deleteCustomProfileOptions := &securityandcompliancecenterapiv3.DeleteCustomProfileOptions{} - deleteCustomProfileOptions.SetProfileID(d.Id()) + parts, err := flex.SepIdParts(d.Id(), "/") + if err != nil { + return diag.FromErr(err) + } + deleteCustomProfileOptions.SetInstanceID(parts[0]) + deleteCustomProfileOptions.SetProfileID(parts[1]) _, response, err := securityandcompliancecenterapiClient.DeleteCustomProfileWithContext(context, deleteCustomProfileOptions) if err != nil { diff --git a/ibm/service/scc/resource_ibm_scc_profile_attachment.go b/ibm/service/scc/resource_ibm_scc_profile_attachment.go index 456bc1fd40..7c02d9613a 100644 --- a/ibm/service/scc/resource_ibm_scc_profile_attachment.go +++ b/ibm/service/scc/resource_ibm_scc_profile_attachment.go @@ -19,7 +19,7 @@ import ( ) func ResourceIbmSccProfileAttachment() *schema.Resource { - return &schema.Resource{ + return AddSchemaData(&schema.Resource{ CreateContext: resourceIbmSccProfileAttachmentCreate, ReadContext: resourceIbmSccProfileAttachmentRead, UpdateContext: resourceIbmSccProfileAttachmentUpdate, @@ -27,6 +27,11 @@ func ResourceIbmSccProfileAttachment() *schema.Resource { Importer: &schema.ResourceImporter{}, Schema: map[string]*schema.Schema{ + "profile_attachment_id": { + Type: schema.TypeString, + Computed: true, + Description: "The profile attachment ID.", + }, "profile_id": { Type: schema.TypeString, Required: true, @@ -39,11 +44,6 @@ func ResourceIbmSccProfileAttachment() *schema.Resource { Computed: true, Description: "The account ID that is associated to the attachment.", }, - "instance_id": { - Type: schema.TypeString, - Computed: true, - Description: "The instance ID of the account that is associated to the attachment.", - }, "scope": { Type: schema.TypeList, Required: true, @@ -244,7 +244,7 @@ func ResourceIbmSccProfileAttachment() *schema.Resource { Description: "The ID of the attachment.", }, }, - } + }) } func ResourceIbmSccProfileAttachmentValidator() *validate.ResourceValidator { @@ -273,7 +273,8 @@ func resourceIbmSccProfileAttachmentCreate(context context.Context, d *schema.Re bodyModelMap := map[string]interface{}{} createAttachmentOptions := &securityandcompliancecenterapiv3.CreateAttachmentOptions{} - + instance_id := d.Get("instance_id").(string) + bodyModelMap["instance_id"] = instance_id if _, ok := d.GetOk("profile_id"); ok { bodyModelMap["profile_id"] = d.Get("profile_id") } @@ -314,7 +315,7 @@ func resourceIbmSccProfileAttachmentCreate(context context.Context, d *schema.Re return diag.FromErr(fmt.Errorf("CreateAttachmentWithContext failed %s\n%s", err, response)) } - d.SetId(fmt.Sprintf("%s/%s", *createAttachmentOptions.ProfileID, *attachmentPrototype.Attachments[0].ID)) + d.SetId(fmt.Sprintf("%s/%s/%s", instance_id, *createAttachmentOptions.ProfileID, *attachmentPrototype.Attachments[0].ID)) return resourceIbmSccProfileAttachmentRead(context, d, meta) } @@ -332,8 +333,9 @@ func resourceIbmSccProfileAttachmentRead(context context.Context, d *schema.Reso return diag.FromErr(err) } - getProfileAttachmentOptions.SetProfileID(parts[0]) - getProfileAttachmentOptions.SetAttachmentID(parts[1]) + getProfileAttachmentOptions.SetInstanceID(parts[0]) + getProfileAttachmentOptions.SetProfileID(parts[1]) + getProfileAttachmentOptions.SetAttachmentID(parts[2]) attachmentItem, response, err := securityandcompliancecenterapiClient.GetProfileAttachmentWithContext(context, getProfileAttachmentOptions) if err != nil { @@ -345,6 +347,14 @@ func resourceIbmSccProfileAttachmentRead(context context.Context, d *schema.Reso return diag.FromErr(fmt.Errorf("GetProfileAttachmentWithContext failed %s\n%s", err, response)) } + if err = d.Set("instance_id", parts[0]); err != nil { + return diag.FromErr(fmt.Errorf("Error setting instance_id: %s", err)) + } + if !core.IsNil(attachmentItem.ID) { + if err = d.Set("profile_attachment_id", attachmentItem.ID); err != nil { + return diag.FromErr(fmt.Errorf("Error setting profile_id: %s", err)) + } + } if !core.IsNil(attachmentItem.ProfileID) { if err = d.Set("profile_id", attachmentItem.ProfileID); err != nil { return diag.FromErr(fmt.Errorf("Error setting profile_id: %s", err)) @@ -355,11 +365,6 @@ func resourceIbmSccProfileAttachmentRead(context context.Context, d *schema.Reso return diag.FromErr(fmt.Errorf("Error setting account_id: %s", err)) } } - if !core.IsNil(attachmentItem.InstanceID) { - if err = d.Set("instance_id", attachmentItem.InstanceID); err != nil { - return diag.FromErr(fmt.Errorf("Error setting instance_id: %s", err)) - } - } if !core.IsNil(attachmentItem.Scope) { scope := []map[string]interface{}{} for _, scopeItem := range attachmentItem.Scope { @@ -471,8 +476,9 @@ func resourceIbmSccProfileAttachmentUpdate(context context.Context, d *schema.Re return diag.FromErr(err) } - replaceProfileAttachmentOptions.SetProfileID(parts[0]) - replaceProfileAttachmentOptions.SetAttachmentID(parts[1]) + replaceProfileAttachmentOptions.SetInstanceID(parts[0]) + replaceProfileAttachmentOptions.SetProfileID(parts[1]) + replaceProfileAttachmentOptions.SetAttachmentID(parts[2]) hasChange := false @@ -564,8 +570,9 @@ func resourceIbmSccProfileAttachmentDelete(context context.Context, d *schema.Re return diag.FromErr(err) } - deleteProfileAttachmentOptions.SetProfileID(parts[0]) - deleteProfileAttachmentOptions.SetAttachmentID(parts[1]) + deleteProfileAttachmentOptions.SetInstanceID(parts[0]) + deleteProfileAttachmentOptions.SetProfileID(parts[1]) + deleteProfileAttachmentOptions.SetAttachmentID(parts[2]) _, response, err := securityandcompliancecenterapiClient.DeleteProfileAttachmentWithContext(context, deleteProfileAttachmentOptions) if err != nil { @@ -816,6 +823,7 @@ func resourceIbmSccProfileAttachmentMapToAttachmentPrototype(modelMap map[string } attachments = append(attachments, *attachmentsItemModel) model.Attachments = attachments + model.SetInstanceID(modelMap["instance_id"].(string)) return model, nil } diff --git a/ibm/service/scc/resource_ibm_scc_profile_attachment_test.go b/ibm/service/scc/resource_ibm_scc_profile_attachment_test.go index 3d751f1f12..14d8800be7 100644 --- a/ibm/service/scc/resource_ibm_scc_profile_attachment_test.go +++ b/ibm/service/scc/resource_ibm_scc_profile_attachment_test.go @@ -20,12 +20,12 @@ func TestAccIbmSccProfileAttachmentBasic(t *testing.T) { var conf securityandcompliancecenterapiv3.AttachmentItem resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, CheckDestroy: testAccCheckIbmSccProfileAttachmentDestroy, Steps: []resource.TestStep{ resource.TestStep{ - Config: testAccCheckIbmSccProfileAttachmentConfigBasic(), + Config: testAccCheckIbmSccProfileAttachmentConfigBasic(acc.SccInstanceID), Check: resource.ComposeAggregateTestCheckFunc( testAccCheckIbmSccProfileAttachmentExists("ibm_scc_profile_attachment.scc_profile_attachment_instance", conf), ), @@ -38,18 +38,18 @@ func TestAccIbmSccProfileAttachmentAllArgs(t *testing.T) { var conf securityandcompliancecenterapiv3.AttachmentItem resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, CheckDestroy: testAccCheckIbmSccProfileAttachmentDestroy, Steps: []resource.TestStep{ resource.TestStep{ - Config: testAccCheckIbmSccProfileAttachmentConfig(), + Config: testAccCheckIbmSccProfileAttachmentConfig(acc.SccInstanceID), Check: resource.ComposeAggregateTestCheckFunc( testAccCheckIbmSccProfileAttachmentExists("ibm_scc_profile_attachment.scc_profile_attachment_instance", conf), ), }, resource.TestStep{ - Config: testAccCheckIbmSccProfileAttachmentConfig(), + Config: testAccCheckIbmSccProfileAttachmentConfig(acc.SccInstanceID), Check: resource.ComposeAggregateTestCheckFunc(), }, resource.TestStep{ @@ -61,9 +61,10 @@ func TestAccIbmSccProfileAttachmentAllArgs(t *testing.T) { }) } -func testAccCheckIbmSccProfileAttachmentConfigBasic() string { +func testAccCheckIbmSccProfileAttachmentConfigBasic(instanceID string) string { return fmt.Sprintf(` resource "ibm_scc_control_library" "scc_control_library_instance" { + instance_id = "%s" control_library_name = "control_library_name" control_library_description = "control_library_description" control_library_type = "custom" @@ -104,11 +105,12 @@ func testAccCheckIbmSccProfileAttachmentConfigBasic() string { } resource "ibm_scc_profile" "scc_profile_instance" { + instance_id = resource.ibm_scc_control_library.scc_control_library_instance.instance_id profile_name = "profile_name" profile_description = "profile_description" profile_type = "custom" controls { - control_library_id = resource.ibm_scc_control_library.scc_control_library_instance.id + control_library_id = resource.ibm_scc_control_library.scc_control_library_instance.control_library_id control_id = resource.ibm_scc_control_library.scc_control_library_instance.controls[0].control_id } default_parameters { @@ -116,7 +118,8 @@ func testAccCheckIbmSccProfileAttachmentConfigBasic() string { } resource "ibm_scc_profile_attachment" "scc_profile_attachment_instance" { - profile_id = ibm_scc_profile.scc_profile_instance.id + instance_id = resource.ibm_scc_control_library.scc_control_library_instance.instance_id + profile_id = ibm_scc_profile.scc_profile_instance.profile_id name = "profile_attachment_name" description = "scc_profile_attachment_description" scope { @@ -140,13 +143,13 @@ func testAccCheckIbmSccProfileAttachmentConfigBasic() string { } } } - `) + `, instanceID) } -func testAccCheckIbmSccProfileAttachmentConfig() string { - return fmt.Sprint(` - +func testAccCheckIbmSccProfileAttachmentConfig(instanceID string) string { + return fmt.Sprintf(` resource "ibm_scc_control_library" "scc_control_library_instance" { + instance_id = "%s" control_library_name = "control_library_name" control_library_description = "control_library_description" control_library_type = "custom" @@ -187,11 +190,12 @@ func testAccCheckIbmSccProfileAttachmentConfig() string { } resource "ibm_scc_profile" "scc_profile_instance" { + instance_id = resource.ibm_scc_control_library.scc_control_library_instance.instance_id profile_name = "profile_name" profile_description = "profile_description" profile_type = "custom" controls { - control_library_id = resource.ibm_scc_control_library.scc_control_library_instance.id + control_library_id = resource.ibm_scc_control_library.scc_control_library_instance.control_library_id control_id = resource.ibm_scc_control_library.scc_control_library_instance.controls[0].control_id } default_parameters { @@ -199,7 +203,8 @@ func testAccCheckIbmSccProfileAttachmentConfig() string { } resource "ibm_scc_profile_attachment" "scc_profile_attachment_instance" { - profile_id = ibm_scc_profile.scc_profile_instance.id + instance_id = resource.ibm_scc_control_library.scc_control_library_instance.instance_id + profile_id = ibm_scc_profile.scc_profile_instance.profile_id name = "profile_attachment_name" description = "scc_profile_attachment_description" scope { @@ -223,7 +228,7 @@ func testAccCheckIbmSccProfileAttachmentConfig() string { } } } - `) + `, instanceID) } func testAccCheckIbmSccProfileAttachmentExists(n string, obj securityandcompliancecenterapiv3.AttachmentItem) resource.TestCheckFunc { @@ -246,8 +251,9 @@ func testAccCheckIbmSccProfileAttachmentExists(n string, obj securityandcomplian return err } - getProfileAttachmentOptions.SetProfileID(parts[0]) - getProfileAttachmentOptions.SetAttachmentID(parts[1]) + getProfileAttachmentOptions.SetInstanceID(parts[0]) + getProfileAttachmentOptions.SetProfileID(parts[1]) + getProfileAttachmentOptions.SetAttachmentID(parts[2]) attachmentItem, _, err := securityandcompliancecenterapiClient.GetProfileAttachment(getProfileAttachmentOptions) if err != nil { @@ -276,8 +282,9 @@ func testAccCheckIbmSccProfileAttachmentDestroy(s *terraform.State) error { return err } - getProfileAttachmentOptions.SetProfileID(parts[0]) - getProfileAttachmentOptions.SetAttachmentID(parts[1]) + getProfileAttachmentOptions.SetInstanceID(parts[0]) + getProfileAttachmentOptions.SetProfileID(parts[1]) + getProfileAttachmentOptions.SetAttachmentID(parts[2]) // Try to find the key _, response, err := securityandcompliancecenterapiClient.GetProfileAttachment(getProfileAttachmentOptions) diff --git a/ibm/service/scc/resource_ibm_scc_profile_test.go b/ibm/service/scc/resource_ibm_scc_profile_test.go index dd7a317d0a..7823df8ad0 100644 --- a/ibm/service/scc/resource_ibm_scc_profile_test.go +++ b/ibm/service/scc/resource_ibm_scc_profile_test.go @@ -5,6 +5,7 @@ package scc_test import ( "fmt" + "strings" "testing" "github.com/hashicorp/terraform-plugin-sdk/v2/helper/acctest" @@ -26,12 +27,12 @@ func TestAccIbmSccProfileBasic(t *testing.T) { profileTypeUpdate := profileType resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, CheckDestroy: testAccCheckIbmSccProfileDestroy, Steps: []resource.TestStep{ resource.TestStep{ - Config: testAccCheckIbmSccProfileConfigBasic(profileName, profileDescription, profileType), + Config: testAccCheckIbmSccProfileConfigBasic(acc.SccInstanceID, profileName, profileDescription, profileType), Check: resource.ComposeAggregateTestCheckFunc( testAccCheckIbmSccProfileExists("ibm_scc_profile.scc_profile_instance", conf), resource.TestCheckResourceAttr("ibm_scc_profile.scc_profile_instance", "profile_name", profileName), @@ -40,7 +41,7 @@ func TestAccIbmSccProfileBasic(t *testing.T) { ), }, resource.TestStep{ - Config: testAccCheckIbmSccProfileConfigBasic(profileNameUpdate, profileDescriptionUpdate, profileTypeUpdate), + Config: testAccCheckIbmSccProfileConfigBasic(acc.SccInstanceID, profileNameUpdate, profileDescriptionUpdate, profileTypeUpdate), Check: resource.ComposeAggregateTestCheckFunc( resource.TestCheckResourceAttr("ibm_scc_profile.scc_profile_instance", "profile_name", profileNameUpdate), resource.TestCheckResourceAttr("ibm_scc_profile.scc_profile_instance", "profile_description", profileDescriptionUpdate), @@ -61,12 +62,12 @@ func TestAccIbmSccProfileAllArgs(t *testing.T) { profileTypeUpdate := profileType resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, CheckDestroy: testAccCheckIbmSccProfileDestroy, Steps: []resource.TestStep{ resource.TestStep{ - Config: testAccCheckIbmSccProfileConfig(profileName, profileDescription, profileType), + Config: testAccCheckIbmSccProfileConfig(acc.SccInstanceID, profileName, profileDescription, profileType), Check: resource.ComposeAggregateTestCheckFunc( testAccCheckIbmSccProfileExists("ibm_scc_profile.scc_profile_instance", conf), resource.TestCheckResourceAttr("ibm_scc_profile.scc_profile_instance", "profile_name", profileName), @@ -75,7 +76,7 @@ func TestAccIbmSccProfileAllArgs(t *testing.T) { ), }, resource.TestStep{ - Config: testAccCheckIbmSccProfileConfig(profileNameUpdate, profileDescriptionUpdate, profileTypeUpdate), + Config: testAccCheckIbmSccProfileConfig(acc.SccInstanceID, profileNameUpdate, profileDescriptionUpdate, profileTypeUpdate), Check: resource.ComposeAggregateTestCheckFunc( resource.TestCheckResourceAttr("ibm_scc_profile.scc_profile_instance", "profile_name", profileNameUpdate), resource.TestCheckResourceAttr("ibm_scc_profile.scc_profile_instance", "profile_description", profileDescriptionUpdate), @@ -91,9 +92,10 @@ func TestAccIbmSccProfileAllArgs(t *testing.T) { }) } -func testAccCheckIbmSccProfileConfigBasic(profileName string, profileDescription string, profileType string) string { +func testAccCheckIbmSccProfileConfigBasic(instanceID string, profileName string, profileDescription string, profileType string) string { return fmt.Sprintf(` resource "ibm_scc_control_library" "scc_control_library_instance" { + instance_id = "%s" control_library_name = "control_library_name" control_library_description = "control_library_description" control_library_type = "custom" @@ -134,21 +136,23 @@ func testAccCheckIbmSccProfileConfigBasic(profileName string, profileDescription } resource "ibm_scc_profile" "scc_profile_instance" { + instance_id = resource.ibm_scc_control_library.scc_control_library_instance.instance_id profile_name = "%s" profile_description = "%s" profile_type = "%s" controls { - control_library_id = resource.ibm_scc_control_library.scc_control_library_instance.id + control_library_id = resource.ibm_scc_control_library.scc_control_library_instance.control_library_id control_id = resource.ibm_scc_control_library.scc_control_library_instance.controls[0].control_id } } - `, profileName, profileDescription, profileType) + `, instanceID, profileName, profileDescription, profileType) } -func testAccCheckIbmSccProfileConfig(profileName string, profileDescription string, profileType string) string { +func testAccCheckIbmSccProfileConfig(instanceID string, profileName string, profileDescription string, profileType string) string { return fmt.Sprintf(` resource "ibm_scc_control_library" "scc_control_library_instance" { + instance_id = "%s" control_library_name = "control_library_name" control_library_description = "control_library_description" control_library_type = "custom" @@ -189,11 +193,12 @@ func testAccCheckIbmSccProfileConfig(profileName string, profileDescription stri } resource "ibm_scc_profile" "scc_profile_instance" { + instance_id = resource.ibm_scc_control_library.scc_control_library_instance.instance_id profile_name = "%s" profile_description = "%s" profile_type = "%s" controls { - control_library_id = resource.ibm_scc_control_library.scc_control_library_instance.id + control_library_id = resource.ibm_scc_control_library.scc_control_library_instance.control_library_id control_id = resource.ibm_scc_control_library.scc_control_library_instance.controls[0].control_id } default_parameters { @@ -206,7 +211,7 @@ func testAccCheckIbmSccProfileConfig(profileName string, profileDescription stri } } - `, profileName, profileDescription, profileType) + `, instanceID, profileName, profileDescription, profileType) } func testAccCheckIbmSccProfileExists(n string, obj securityandcompliancecenterapiv3.Profile) resource.TestCheckFunc { @@ -224,7 +229,9 @@ func testAccCheckIbmSccProfileExists(n string, obj securityandcompliancecenterap getProfileOptions := &securityandcompliancecenterapiv3.GetProfileOptions{} - getProfileOptions.SetProfileID(rs.Primary.ID) + id := strings.Split(rs.Primary.ID, "/") + getProfileOptions.SetInstanceID(id[0]) + getProfileOptions.SetProfileID(id[1]) profile, _, err := securityandcompliancecenterapiClient.GetProfile(getProfileOptions) if err != nil { @@ -248,7 +255,9 @@ func testAccCheckIbmSccProfileDestroy(s *terraform.State) error { getProfileOptions := &securityandcompliancecenterapiv3.GetProfileOptions{} - getProfileOptions.SetProfileID(rs.Primary.ID) + id := strings.Split(rs.Primary.ID, "/") + getProfileOptions.SetInstanceID(id[0]) + getProfileOptions.SetProfileID(id[1]) // Try to find the key _, response, err := securityandcompliancecenterapiClient.GetProfile(getProfileOptions) diff --git a/ibm/service/scc/resource_ibm_scc_provider_type_instance.go b/ibm/service/scc/resource_ibm_scc_provider_type_instance.go index 95d61448e5..a9b4c4faca 100644 --- a/ibm/service/scc/resource_ibm_scc_provider_type_instance.go +++ b/ibm/service/scc/resource_ibm_scc_provider_type_instance.go @@ -1,4 +1,4 @@ -//ng Copyright IBM Corp. 2023 All Rights Reserved. +// ng Copyright IBM Corp. 2023 All Rights Reserved. // Licensed under the Mozilla Public License v2.0 package scc @@ -19,7 +19,7 @@ import ( ) func ResourceIbmSccProviderTypeInstance() *schema.Resource { - return &schema.Resource{ + return AddSchemaData(&schema.Resource{ CreateContext: resourceIbmSccProviderTypeInstanceCreate, ReadContext: resourceIbmSccProviderTypeInstanceRead, UpdateContext: resourceIbmSccProviderTypeInstanceUpdate, @@ -65,7 +65,7 @@ func ResourceIbmSccProviderTypeInstance() *schema.Resource { Description: "The unique identifier of the provider type instance.", }, }, - } + }) } func ResourceIbmSccProviderTypeInstanceValidator() *validate.ResourceValidator { @@ -102,9 +102,11 @@ func resourceIbmSccProviderTypeInstanceCreate(context context.Context, d *schema } createProviderTypeInstanceOptions := &securityandcompliancecenterapiv3.CreateProviderTypeInstanceOptions{} + instanceID := d.Get("instance_id").(string) createProviderTypeInstanceOptions.SetProviderTypeID(d.Get("provider_type_id").(string)) createProviderTypeInstanceOptions.SetName(d.Get("name").(string)) + createProviderTypeInstanceOptions.SetInstanceID(instanceID) attributesModel, err := resourceIbmSccProviderTypeInstanceMapToProviderTypeInstanceAttributes(d.Get("attributes").(map[string]interface{})) if err != nil { return diag.FromErr(err) @@ -117,7 +119,7 @@ func resourceIbmSccProviderTypeInstanceCreate(context context.Context, d *schema return diag.FromErr(fmt.Errorf("CreateProviderTypeInstanceWithContext failed %s\n%s", err, response)) } - d.SetId(fmt.Sprintf("%s/%s", *createProviderTypeInstanceOptions.ProviderTypeID, *providerTypeInstanceItem.ID)) + d.SetId(fmt.Sprintf("%s/%s/%s", instanceID, *createProviderTypeInstanceOptions.ProviderTypeID, *providerTypeInstanceItem.ID)) return resourceIbmSccProviderTypeInstanceRead(context, d, meta) } @@ -135,8 +137,9 @@ func resourceIbmSccProviderTypeInstanceRead(context context.Context, d *schema.R return diag.FromErr(err) } - getProviderTypeInstanceOptions.SetProviderTypeID(parts[0]) - getProviderTypeInstanceOptions.SetProviderTypeInstanceID(parts[1]) + getProviderTypeInstanceOptions.SetInstanceID(parts[0]) + getProviderTypeInstanceOptions.SetProviderTypeID(parts[1]) + getProviderTypeInstanceOptions.SetProviderTypeInstanceID(parts[2]) providerTypeInstanceItem, response, err := securityAndComplianceCenterApIsClient.GetProviderTypeInstanceWithContext(context, getProviderTypeInstanceOptions) if err != nil { @@ -148,6 +151,10 @@ func resourceIbmSccProviderTypeInstanceRead(context context.Context, d *schema.R return diag.FromErr(fmt.Errorf("GetProviderTypeInstanceWithContext failed %s\n%s", err, response)) } + if err = d.Set("instance_id", parts[0]); err != nil { + return diag.FromErr(fmt.Errorf("Error setting instance_id: %s", err)) + } + if err = d.Set("name", providerTypeInstanceItem.Name); err != nil { return diag.FromErr(fmt.Errorf("Error setting name: %s", err)) } @@ -181,7 +188,7 @@ func resourceIbmSccProviderTypeInstanceRead(context context.Context, d *schema.R return diag.FromErr(fmt.Errorf("Error setting provider_type_instance_id: %s", err)) } } - if err = d.Set("provider_type_id", parts[0]); err != nil { + if err = d.Set("provider_type_id", parts[1]); err != nil { return diag.FromErr(fmt.Errorf("Error setting provider_type_id: %s", err)) } @@ -201,8 +208,10 @@ func resourceIbmSccProviderTypeInstanceUpdate(context context.Context, d *schema return diag.FromErr(err) } - updateProviderTypeInstanceOptions.SetProviderTypeID(parts[0]) - updateProviderTypeInstanceOptions.SetProviderTypeInstanceID(parts[1]) + // TODO: add updateProviderTypeInstanceOptions.SetInstanceID to scc-go-sdk + updateProviderTypeInstanceOptions.SetInstanceID(parts[0]) + updateProviderTypeInstanceOptions.SetProviderTypeID(parts[1]) + updateProviderTypeInstanceOptions.SetProviderTypeInstanceID(parts[2]) hasChange := false @@ -243,8 +252,9 @@ func resourceIbmSccProviderTypeInstanceDelete(context context.Context, d *schema return diag.FromErr(err) } - deleteProviderTypeInstanceOptions.SetProviderTypeID(parts[0]) - deleteProviderTypeInstanceOptions.SetProviderTypeInstanceID(parts[1]) + deleteProviderTypeInstanceOptions.SetInstanceID(parts[0]) + deleteProviderTypeInstanceOptions.SetProviderTypeID(parts[1]) + deleteProviderTypeInstanceOptions.SetProviderTypeInstanceID(parts[2]) response, err := securityAndComplianceCenterApIsClient.DeleteProviderTypeInstanceWithContext(context, deleteProviderTypeInstanceOptions) if err != nil { diff --git a/ibm/service/scc/resource_ibm_scc_provider_type_instance_test.go b/ibm/service/scc/resource_ibm_scc_provider_type_instance_test.go index ad79dcf352..cbf5170421 100644 --- a/ibm/service/scc/resource_ibm_scc_provider_type_instance_test.go +++ b/ibm/service/scc/resource_ibm_scc_provider_type_instance_test.go @@ -5,7 +5,6 @@ package scc_test import ( "fmt" - "os" "testing" "github.com/hashicorp/terraform-plugin-sdk/v2/helper/acctest" @@ -20,24 +19,23 @@ import ( func TestAccIbmSccProviderTypeInstanceBasic(t *testing.T) { var conf securityandcompliancecenterapiv3.ProviderTypeInstanceItem - providerTypeAttributes := os.Getenv("IBMCLOUD_SCC_PROVIDER_TYPE_ATTRIBUTES") name := fmt.Sprintf("tf_provider_type_instance_name_%d", acctest.RandIntRange(10, 100)) nameUpdate := fmt.Sprintf("tf_provider_type_instance_name_%d", acctest.RandIntRange(10, 100)) resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, CheckDestroy: testAccCheckIbmSccProviderTypeInstanceDestroy, Steps: []resource.TestStep{ { - Config: testAccCheckIbmSccProviderTypeInstanceConfigBasic(name, providerTypeAttributes), + Config: testAccCheckIbmSccProviderTypeInstanceConfigBasic(acc.SccInstanceID, name, acc.SccProviderTypeAttributes), Check: resource.ComposeAggregateTestCheckFunc( testAccCheckIbmSccProviderTypeInstanceExists("ibm_scc_provider_type_instance.scc_provider_type_instance_wlp", conf), resource.TestCheckResourceAttr("ibm_scc_provider_type_instance.scc_provider_type_instance_wlp", "name", name), ), }, { - Config: testAccCheckIbmSccProviderTypeInstanceConfigBasic(nameUpdate, providerTypeAttributes), + Config: testAccCheckIbmSccProviderTypeInstanceConfigBasic(acc.SccInstanceID, nameUpdate, acc.SccProviderTypeAttributes), Check: resource.ComposeAggregateTestCheckFunc( resource.TestCheckResourceAttr("ibm_scc_provider_type_instance.scc_provider_type_instance_wlp", "name", nameUpdate), ), @@ -48,24 +46,23 @@ func TestAccIbmSccProviderTypeInstanceBasic(t *testing.T) { func TestAccIbmSccProviderTypeInstanceAllArgs(t *testing.T) { var conf securityandcompliancecenterapiv3.ProviderTypeInstanceItem - providerTypeAttributes := os.Getenv("IBMCLOUD_SCC_PROVIDER_TYPE_ATTRIBUTES") name := fmt.Sprintf("tf_provider_type_instance_name_%d", acctest.RandIntRange(10, 100)) nameUpdate := fmt.Sprintf("tf_provider_type_instance_name_%d", acctest.RandIntRange(10, 100)) resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, CheckDestroy: testAccCheckIbmSccProviderTypeInstanceDestroy, Steps: []resource.TestStep{ { - Config: testAccCheckIbmSccProviderTypeInstanceConfig(name, providerTypeAttributes), + Config: testAccCheckIbmSccProviderTypeInstanceConfig(acc.SccInstanceID, name, acc.SccProviderTypeAttributes), Check: resource.ComposeAggregateTestCheckFunc( testAccCheckIbmSccProviderTypeInstanceExists("ibm_scc_provider_type_instance.scc_provider_type_instance_wlp", conf), resource.TestCheckResourceAttr("ibm_scc_provider_type_instance.scc_provider_type_instance_wlp", "name", name), ), }, { - Config: testAccCheckIbmSccProviderTypeInstanceConfig(nameUpdate, providerTypeAttributes), + Config: testAccCheckIbmSccProviderTypeInstanceConfig(acc.SccInstanceID, nameUpdate, acc.SccProviderTypeAttributes), Check: resource.ComposeAggregateTestCheckFunc( resource.TestCheckResourceAttr("ibm_scc_provider_type_instance.scc_provider_type_instance_wlp", "name", nameUpdate), ), @@ -79,24 +76,26 @@ func TestAccIbmSccProviderTypeInstanceAllArgs(t *testing.T) { }) } -func testAccCheckIbmSccProviderTypeInstanceConfigBasic(name string, attributes string) string { +func testAccCheckIbmSccProviderTypeInstanceConfigBasic(instanceID string, name string, attributes string) string { return fmt.Sprintf(` resource "ibm_scc_provider_type_instance" "scc_provider_type_instance_wlp" { + instance_id = "%s" provider_type_id = "afa2476ecfa5f09af248492fe991b4d1" name = "%s" attributes = %s } - `, name, attributes) + `, instanceID, name, attributes) } -func testAccCheckIbmSccProviderTypeInstanceConfig(name string, attributes string) string { +func testAccCheckIbmSccProviderTypeInstanceConfig(instanceID string, name string, attributes string) string { return fmt.Sprintf(` resource "ibm_scc_provider_type_instance" "scc_provider_type_instance_wlp" { + instance_id = "%s" provider_type_id = "afa2476ecfa5f09af248492fe991b4d1" name = "%s" attributes = %s } - `, name, attributes) + `, instanceID, name, attributes) } func testAccCheckIbmSccProviderTypeInstanceExists(n string, obj securityandcompliancecenterapiv3.ProviderTypeInstanceItem) resource.TestCheckFunc { @@ -118,8 +117,9 @@ func testAccCheckIbmSccProviderTypeInstanceExists(n string, obj securityandcompl return err } - getProviderTypeInstanceOptions.SetProviderTypeID(parts[0]) - getProviderTypeInstanceOptions.SetProviderTypeInstanceID(parts[1]) + getProviderTypeInstanceOptions.SetInstanceID(parts[0]) + getProviderTypeInstanceOptions.SetProviderTypeID(parts[1]) + getProviderTypeInstanceOptions.SetProviderTypeInstanceID(parts[2]) providerTypeInstanceItem, _, err := securityAndComplianceCenterApIsClient.GetProviderTypeInstance(getProviderTypeInstanceOptions) if err != nil { @@ -148,8 +148,9 @@ func testAccCheckIbmSccProviderTypeInstanceDestroy(s *terraform.State) error { return err } - getProviderTypeInstanceOptions.SetProviderTypeID(parts[0]) - getProviderTypeInstanceOptions.SetProviderTypeInstanceID(parts[1]) + getProviderTypeInstanceOptions.SetInstanceID(parts[0]) + getProviderTypeInstanceOptions.SetProviderTypeID(parts[1]) + getProviderTypeInstanceOptions.SetProviderTypeInstanceID(parts[2]) // Try to find the key _, response, err := securityAndComplianceCenterApIsClient.GetProviderTypeInstance(getProviderTypeInstanceOptions) diff --git a/ibm/service/scc/resource_ibm_scc_rule.go b/ibm/service/scc/resource_ibm_scc_rule.go index 056ae35cbe..e8d2ec7092 100644 --- a/ibm/service/scc/resource_ibm_scc_rule.go +++ b/ibm/service/scc/resource_ibm_scc_rule.go @@ -22,7 +22,7 @@ import ( ) func ResourceIbmSccRule() *schema.Resource { - return &schema.Resource{ + return AddSchemaData(&schema.Resource{ CreateContext: resourceIbmSccRuleCreate, ReadContext: resourceIbmSccRuleRead, UpdateContext: resourceIbmSccRuleUpdate, @@ -83,6 +83,11 @@ func ResourceIbmSccRule() *schema.Resource { Deprecated: "enforcement_actions is now deprecated", }, // End of Deprecation list + "rule_id": { + Type: schema.TypeString, + Computed: true, + Description: "The rule ID.", + }, "account_id": { Type: schema.TypeString, Computed: true, @@ -444,7 +449,7 @@ func ResourceIbmSccRule() *schema.Resource { Description: "The version number of a rule.", }, }, - } + }) } func ResourceIbmSccRuleValidator() *validate.ResourceValidator { @@ -514,13 +519,15 @@ func resourceIbmSccRuleCreate(context context.Context, d *schema.ResourceData, m createRuleOptions.SetLabels(labels) } + instance_id := d.Get("instance_id").(string) + createRuleOptions.SetInstanceID(instance_id) rule, response, err := configManagerClient.CreateRuleWithContext(context, createRuleOptions) if err != nil { log.Printf("[DEBUG] CreateRuleWithContext failed %s\n%s", err, response) return diag.FromErr(fmt.Errorf("CreateRuleWithContext failed %s\n%s", err, response)) } - d.SetId(*rule.ID) + d.SetId(instance_id + "/" + *rule.ID) return resourceIbmSccRuleRead(context, d, meta) } @@ -533,7 +540,12 @@ func resourceIbmSccRuleRead(context context.Context, d *schema.ResourceData, met getRuleOptions := &securityandcompliancecenterapiv3.GetRuleOptions{} - getRuleOptions.SetRuleID(d.Id()) + parts, err := flex.SepIdParts(d.Id(), "/") + if err != nil { + return diag.FromErr(err) + } + getRuleOptions.SetInstanceID(parts[0]) + getRuleOptions.SetRuleID(parts[1]) rule, response, err := configManagerClient.GetRuleWithContext(context, getRuleOptions) if err != nil { @@ -545,6 +557,12 @@ func resourceIbmSccRuleRead(context context.Context, d *schema.ResourceData, met return diag.FromErr(fmt.Errorf("GetRuleWithContext failed %s\n%s", err, response)) } // Manual Intervention + if err = d.Set("instance_id", parts[0]); err != nil { + return diag.FromErr(fmt.Errorf("Error setting instance_id: %s", err)) + } + if err = d.Set("rule_id", parts[1]); err != nil { + return diag.FromErr(fmt.Errorf("Error setting instance_id: %s", err)) + } if err = d.Set("etag", response.Headers.Get("ETag")); err != nil { return diag.FromErr(fmt.Errorf("Error setting etag: %s", err)) } @@ -620,11 +638,14 @@ func resourceIbmSccRuleUpdate(context context.Context, d *schema.ResourceData, m replaceRuleOptions := &securityandcompliancecenterapiv3.ReplaceRuleOptions{} - replaceRuleOptions.SetRuleID(d.Id()) - // Manual Intervention + parts, err := flex.SepIdParts(d.Id(), "/") + if err != nil { + return diag.FromErr(err) + } + replaceRuleOptions.SetInstanceID(parts[0]) + replaceRuleOptions.SetRuleID(parts[1]) replaceRuleOptions.SetIfMatch(d.Get("etag").(string)) - // End Manual Intervention hasChange := false if d.HasChange("description") || d.HasChange("target") || d.HasChange("required_config") { @@ -691,7 +712,12 @@ func resourceIbmSccRuleDelete(context context.Context, d *schema.ResourceData, m deleteRuleOptions := &securityandcompliancecenterapiv3.DeleteRuleOptions{} - deleteRuleOptions.SetRuleID(d.Id()) + parts, err := flex.SepIdParts(d.Id(), "/") + if err != nil { + return diag.FromErr(err) + } + deleteRuleOptions.SetInstanceID(parts[0]) + deleteRuleOptions.SetRuleID(parts[1]) response, err := configManagerClient.DeleteRuleWithContext(context, deleteRuleOptions) if err != nil { diff --git a/ibm/service/scc/resource_ibm_scc_rule_test.go b/ibm/service/scc/resource_ibm_scc_rule_test.go index c3c17cdc63..d79a2b7bba 100644 --- a/ibm/service/scc/resource_ibm_scc_rule_test.go +++ b/ibm/service/scc/resource_ibm_scc_rule_test.go @@ -5,6 +5,7 @@ package scc_test import ( "fmt" + "strings" "testing" "github.com/hashicorp/terraform-plugin-sdk/v2/helper/acctest" @@ -20,21 +21,20 @@ func TestAccIbmSccRuleBasic(t *testing.T) { var conf securityandcompliancecenterapiv3.Rule description := fmt.Sprintf("tf_description_%d", acctest.RandIntRange(10, 100)) descriptionUpdate := description - resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, CheckDestroy: testAccCheckIbmSccRuleDestroy, Steps: []resource.TestStep{ { - Config: testAccCheckIbmSccRuleConfigBasic(description), + Config: testAccCheckIbmSccRuleConfigBasic(acc.SccInstanceID, description), Check: resource.ComposeAggregateTestCheckFunc( testAccCheckIbmSccRuleExists("ibm_scc_rule.scc_rule_instance", conf), resource.TestCheckResourceAttr("ibm_scc_rule.scc_rule_instance", "description", description), ), }, { - Config: testAccCheckIbmSccRuleConfigBasic(descriptionUpdate), + Config: testAccCheckIbmSccRuleConfigBasic(acc.SccInstanceID, descriptionUpdate), Check: resource.ComposeAggregateTestCheckFunc( resource.TestCheckResourceAttr("ibm_scc_rule.scc_rule_instance", "description", descriptionUpdate), ), @@ -51,12 +51,12 @@ func TestAccIbmSccRuleAllArgs(t *testing.T) { versionUpdate := fmt.Sprintf("0.0.%d", acctest.RandIntRange(2, 100)) resource.Test(t, resource.TestCase{ - PreCheck: func() { acc.TestAccPreCheck(t) }, + PreCheck: func() { acc.TestAccPreCheckScc(t) }, Providers: acc.TestAccProviders, CheckDestroy: testAccCheckIbmSccRuleDestroy, Steps: []resource.TestStep{ { - Config: testAccCheckIbmSccRuleConfig(description, version), + Config: testAccCheckIbmSccRuleConfig(acc.SccInstanceID, description, version), Check: resource.ComposeAggregateTestCheckFunc( testAccCheckIbmSccRuleExists("ibm_scc_rule.scc_rule_instance", conf), resource.TestCheckResourceAttr("ibm_scc_rule.scc_rule_instance", "description", description), @@ -64,7 +64,7 @@ func TestAccIbmSccRuleAllArgs(t *testing.T) { ), }, { - Config: testAccCheckIbmSccRuleConfig(descriptionUpdate, versionUpdate), + Config: testAccCheckIbmSccRuleConfig(acc.SccInstanceID, descriptionUpdate, versionUpdate), Check: resource.ComposeAggregateTestCheckFunc( resource.TestCheckResourceAttr("ibm_scc_rule.scc_rule_instance", "description", descriptionUpdate), resource.TestCheckResourceAttr("ibm_scc_rule.scc_rule_instance", "version", versionUpdate), @@ -79,9 +79,10 @@ func TestAccIbmSccRuleAllArgs(t *testing.T) { }) } -func testAccCheckIbmSccRuleConfigBasic(description string) string { +func testAccCheckIbmSccRuleConfigBasic(instanceID string, description string) string { return fmt.Sprintf(` resource "ibm_scc_rule" "scc_rule_instance" { + instance_id = "%s" description = "%s" version = "0.0.1" target { @@ -110,13 +111,14 @@ func testAccCheckIbmSccRuleConfigBasic(description string) string { } } } - `, description) + `, instanceID, description) } -func testAccCheckIbmSccRuleConfig(description string, version string) string { +func testAccCheckIbmSccRuleConfig(instanceID string, description string, version string) string { return fmt.Sprintf(` resource "ibm_scc_rule" "scc_rule_instance" { + instance_id = "%s" description = "%s" version = "%s" import { @@ -154,7 +156,7 @@ func testAccCheckIbmSccRuleConfig(description string, version string) string { } labels = ["FIXME"] } - `, description, version) + `, instanceID, description, version) } func testAccCheckIbmSccRuleExists(n string, obj securityandcompliancecenterapiv3.Rule) resource.TestCheckFunc { @@ -170,8 +172,9 @@ func testAccCheckIbmSccRuleExists(n string, obj securityandcompliancecenterapiv3 } getRuleOptions := &securityandcompliancecenterapiv3.GetRuleOptions{} - - getRuleOptions.SetRuleID(rs.Primary.ID) + id := strings.Split(rs.Primary.ID, "/") + getRuleOptions.SetInstanceID(id[0]) + getRuleOptions.SetRuleID(id[1]) rule, _, err := configManagerClient.GetRule(getRuleOptions) if err != nil { @@ -195,7 +198,9 @@ func testAccCheckIbmSccRuleDestroy(s *terraform.State) error { getRuleOptions := &securityandcompliancecenterapiv3.GetRuleOptions{} - getRuleOptions.SetRuleID(rs.Primary.ID) + id := strings.Split(rs.Primary.ID, "/") + getRuleOptions.SetInstanceID(id[0]) + getRuleOptions.SetRuleID(id[1]) // Try to find the key _, response, err := configManagerClient.GetRule(getRuleOptions) diff --git a/ibm/service/secretsmanager/data_source_ibm_sm_arbitrary_secret.go b/ibm/service/secretsmanager/data_source_ibm_sm_arbitrary_secret.go index 39a1f2ed4d..7572a8d2f0 100644 --- a/ibm/service/secretsmanager/data_source_ibm_sm_arbitrary_secret.go +++ b/ibm/service/secretsmanager/data_source_ibm_sm_arbitrary_secret.go @@ -6,12 +6,9 @@ package secretsmanager import ( "context" "fmt" - "log" - "github.com/hashicorp/terraform-plugin-sdk/v2/diag" "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" - "github.com/IBM-Cloud/terraform-provider-ibm/ibm/conns" "github.com/IBM-Cloud/terraform-provider-ibm/ibm/flex" "github.com/IBM/secrets-manager-go-sdk/v2/secretsmanagerv2" ) @@ -22,9 +19,11 @@ func DataSourceIbmSmArbitrarySecret() *schema.Resource { Schema: map[string]*schema.Schema{ "secret_id": &schema.Schema{ - Type: schema.TypeString, - Required: true, - Description: "The ID of the secret.", + Type: schema.TypeString, + Optional: true, + Computed: true, + ExactlyOneOf: []string{"secret_id", "name"}, + Description: "The ID of the secret.", }, "created_by": &schema.Schema{ Type: schema.TypeString, @@ -73,15 +72,24 @@ func DataSourceIbmSmArbitrarySecret() *schema.Resource { Description: "The number of locks of the secret.", }, "name": &schema.Schema{ - Type: schema.TypeString, - Computed: true, - Description: "The human-readable name of your secret.", + Type: schema.TypeString, + Optional: true, + Computed: true, + ExactlyOneOf: []string{"secret_id", "name"}, + RequiredWith: []string{"secret_group_name"}, + Description: "The human-readable name of your secret.", }, "secret_group_id": &schema.Schema{ Type: schema.TypeString, Computed: true, Description: "A v4 UUID identifier, or `default` secret group.", }, + "secret_group_name": &schema.Schema{ + Type: schema.TypeString, + Optional: true, + RequiredWith: []string{"name"}, + Description: "The human-readable name of your secret group.", + }, "secret_type": &schema.Schema{ Type: schema.TypeString, Computed: true, @@ -123,29 +131,16 @@ func DataSourceIbmSmArbitrarySecret() *schema.Resource { } func dataSourceIbmSmArbitrarySecretRead(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { - secretsManagerClient, err := meta.(conns.ClientSession).SecretsManagerV2() - if err != nil { - return diag.FromErr(err) - } - - region := getRegion(secretsManagerClient, d) - instanceId := d.Get("instance_id").(string) - secretsManagerClient = getClientWithInstanceEndpoint(secretsManagerClient, instanceId, region, getEndpointType(secretsManagerClient, d)) - - getSecretOptions := &secretsmanagerv2.GetSecretOptions{} - - secretId := d.Get("secret_id").(string) - getSecretOptions.SetID(secretId) - secretIntf, response, err := secretsManagerClient.GetSecretWithContext(context, getSecretOptions) - if err != nil { - log.Printf("[DEBUG] GetSecretWithContext failed %s\n%s", err, response) - return diag.FromErr(fmt.Errorf("GetSecretWithContext failed %s\n%s", err, response)) + secret, region, instanceId, diagError := getSecretByIdOrByName(context, d, meta, ArbitrarySecretType) + if diagError != nil { + return diagError } - arbitrarySecret := secretIntf.(*secretsmanagerv2.ArbitrarySecret) - d.SetId(fmt.Sprintf("%s/%s/%s", region, instanceId, secretId)) + arbitrarySecret := secret.(*secretsmanagerv2.ArbitrarySecret) + d.SetId(fmt.Sprintf("%s/%s/%s", region, instanceId, *arbitrarySecret.ID)) + var err error if err = d.Set("region", region); err != nil { return diag.FromErr(fmt.Errorf("Error setting region: %s", err)) } diff --git a/ibm/service/secretsmanager/data_source_ibm_sm_arbitrary_secret_test.go b/ibm/service/secretsmanager/data_source_ibm_sm_arbitrary_secret_test.go index d5a1064749..9675cb28a4 100644 --- a/ibm/service/secretsmanager/data_source_ibm_sm_arbitrary_secret_test.go +++ b/ibm/service/secretsmanager/data_source_ibm_sm_arbitrary_secret_test.go @@ -29,6 +29,8 @@ func TestAccIbmSmArbitrarySecretDataSourceBasic(t *testing.T) { resource.TestCheckResourceAttrSet("data.ibm_sm_arbitrary_secret.sm_arbitrary_secret", "secret_type"), resource.TestCheckResourceAttrSet("data.ibm_sm_arbitrary_secret.sm_arbitrary_secret", "updated_at"), resource.TestCheckResourceAttrSet("data.ibm_sm_arbitrary_secret.sm_arbitrary_secret", "versions_total"), + resource.TestCheckResourceAttrSet("data.ibm_sm_arbitrary_secret.sm_arbitrary_secret_by_name", "name"), + resource.TestCheckResourceAttrSet("data.ibm_sm_arbitrary_secret.sm_arbitrary_secret_by_name", "secret_group_name"), ), }, }, @@ -53,5 +55,12 @@ func testAccCheckIbmSmArbitrarySecretDataSourceConfigBasic() string { region = "%s" secret_id = ibm_sm_arbitrary_secret.sm_arbitrary_secret_instance.secret_id } - `, acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion, acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion) + + data "ibm_sm_arbitrary_secret" "sm_arbitrary_secret_by_name" { + instance_id = "%s" + region = "%s" + name = ibm_sm_arbitrary_secret.sm_arbitrary_secret_instance.name + secret_group_name = "default" + } + `, acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion, acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion, acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion) } diff --git a/ibm/service/secretsmanager/data_source_ibm_sm_iam_credentials_secret.go b/ibm/service/secretsmanager/data_source_ibm_sm_iam_credentials_secret.go index 97fad84689..75ad6a8306 100644 --- a/ibm/service/secretsmanager/data_source_ibm_sm_iam_credentials_secret.go +++ b/ibm/service/secretsmanager/data_source_ibm_sm_iam_credentials_secret.go @@ -6,12 +6,9 @@ package secretsmanager import ( "context" "fmt" - "log" - "github.com/hashicorp/terraform-plugin-sdk/v2/diag" "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" - "github.com/IBM-Cloud/terraform-provider-ibm/ibm/conns" "github.com/IBM-Cloud/terraform-provider-ibm/ibm/flex" "github.com/IBM/secrets-manager-go-sdk/v2/secretsmanagerv2" ) @@ -22,9 +19,11 @@ func DataSourceIbmSmIamCredentialsSecret() *schema.Resource { Schema: map[string]*schema.Schema{ "secret_id": &schema.Schema{ - Type: schema.TypeString, - Required: true, - Description: "The ID of the secret.", + Type: schema.TypeString, + Optional: true, + Computed: true, + ExactlyOneOf: []string{"secret_id", "name"}, + Description: "The ID of the secret.", }, "created_by": &schema.Schema{ Type: schema.TypeString, @@ -73,15 +72,24 @@ func DataSourceIbmSmIamCredentialsSecret() *schema.Resource { Description: "The number of locks of the secret.", }, "name": &schema.Schema{ - Type: schema.TypeString, - Computed: true, - Description: "The human-readable name of your secret.", + Type: schema.TypeString, + Optional: true, + Computed: true, + ExactlyOneOf: []string{"secret_id", "name"}, + RequiredWith: []string{"secret_group_name"}, + Description: "The human-readable name of your secret.", }, "secret_group_id": &schema.Schema{ Type: schema.TypeString, Computed: true, Description: "A v4 UUID identifier, or `default` secret group.", }, + "secret_group_name": &schema.Schema{ + Type: schema.TypeString, + Optional: true, + RequiredWith: []string{"name"}, + Description: "The human-readable name of your secret group.", + }, "secret_type": &schema.Schema{ Type: schema.TypeString, Computed: true, @@ -185,29 +193,16 @@ func DataSourceIbmSmIamCredentialsSecret() *schema.Resource { } func dataSourceIbmSmIamCredentialsSecretRead(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { - secretsManagerClient, err := meta.(conns.ClientSession).SecretsManagerV2() - if err != nil { - return diag.FromErr(err) - } - - region := getRegion(secretsManagerClient, d) - instanceId := d.Get("instance_id").(string) - secretsManagerClient = getClientWithInstanceEndpoint(secretsManagerClient, instanceId, region, getEndpointType(secretsManagerClient, d)) - - getSecretOptions := &secretsmanagerv2.GetSecretOptions{} - - secretId := d.Get("secret_id").(string) - getSecretOptions.SetID(secretId) - iAMCredentialsSecretIntf, response, err := secretsManagerClient.GetSecretWithContext(context, getSecretOptions) - if err != nil { - log.Printf("[DEBUG] GetSecretWithContext failed %s\n%s", err, response) - return diag.FromErr(fmt.Errorf("GetSecretWithContext failed %s\n%s", err, response)) + iAMCredentialsSecretIntf, region, instanceId, diagError := getSecretByIdOrByName(context, d, meta, IAMCredentialsSecretType) + if diagError != nil { + return diagError } - d.SetId(fmt.Sprintf("%s/%s/%s", region, instanceId, secretId)) iAMCredentialsSecret := iAMCredentialsSecretIntf.(*secretsmanagerv2.IAMCredentialsSecret) + d.SetId(fmt.Sprintf("%s/%s/%s", region, instanceId, *iAMCredentialsSecret.ID)) + var err error if err = d.Set("region", region); err != nil { return diag.FromErr(fmt.Errorf("Error setting region: %s", err)) } diff --git a/ibm/service/secretsmanager/data_source_ibm_sm_imported_certificate.go b/ibm/service/secretsmanager/data_source_ibm_sm_imported_certificate.go index f970710277..cb1b9f4f6c 100644 --- a/ibm/service/secretsmanager/data_source_ibm_sm_imported_certificate.go +++ b/ibm/service/secretsmanager/data_source_ibm_sm_imported_certificate.go @@ -6,12 +6,9 @@ package secretsmanager import ( "context" "fmt" - "log" - "github.com/hashicorp/terraform-plugin-sdk/v2/diag" "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" - "github.com/IBM-Cloud/terraform-provider-ibm/ibm/conns" "github.com/IBM-Cloud/terraform-provider-ibm/ibm/flex" "github.com/IBM/secrets-manager-go-sdk/v2/secretsmanagerv2" ) @@ -22,9 +19,11 @@ func DataSourceIbmSmImportedCertificate() *schema.Resource { Schema: map[string]*schema.Schema{ "secret_id": &schema.Schema{ - Type: schema.TypeString, - Required: true, - Description: "The ID of the secret.", + Type: schema.TypeString, + Optional: true, + Computed: true, + ExactlyOneOf: []string{"secret_id", "name"}, + Description: "The ID of the secret.", }, "created_by": &schema.Schema{ Type: schema.TypeString, @@ -73,15 +72,24 @@ func DataSourceIbmSmImportedCertificate() *schema.Resource { Description: "The number of locks of the secret.", }, "name": &schema.Schema{ - Type: schema.TypeString, - Computed: true, - Description: "The human-readable name of your secret.", + Type: schema.TypeString, + Optional: true, + Computed: true, + ExactlyOneOf: []string{"secret_id", "name"}, + RequiredWith: []string{"secret_group_name"}, + Description: "The human-readable name of your secret.", }, "secret_group_id": &schema.Schema{ Type: schema.TypeString, Computed: true, Description: "A v4 UUID identifier, or `default` secret group.", }, + "secret_group_name": &schema.Schema{ + Type: schema.TypeString, + Optional: true, + RequiredWith: []string{"name"}, + Description: "The human-readable name of your secret group.", + }, "secret_type": &schema.Schema{ Type: schema.TypeString, Computed: true, @@ -197,29 +205,15 @@ func DataSourceIbmSmImportedCertificate() *schema.Resource { } func dataSourceIbmSmImportedCertificateRead(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { - secretsManagerClient, err := meta.(conns.ClientSession).SecretsManagerV2() - if err != nil { - return diag.FromErr(err) - } - - region := getRegion(secretsManagerClient, d) - instanceId := d.Get("instance_id").(string) - secretsManagerClient = getClientWithInstanceEndpoint(secretsManagerClient, instanceId, region, getEndpointType(secretsManagerClient, d)) - - getSecretOptions := &secretsmanagerv2.GetSecretOptions{} - - secretId := d.Get("secret_id").(string) - getSecretOptions.SetID(secretId) - - importedCertificateIntf, response, err := secretsManagerClient.GetSecretWithContext(context, getSecretOptions) - if err != nil { - log.Printf("[DEBUG] GetSecretWithContext failed %s\n%s", err, response) - return diag.FromErr(fmt.Errorf("GetSecretWithContext failed %s\n%s", err, response)) + importedCertificateIntf, region, instanceId, diagError := getSecretByIdOrByName(context, d, meta, ImportedCertSecretType) + if diagError != nil { + return diagError } importedCertificate := importedCertificateIntf.(*secretsmanagerv2.ImportedCertificate) - d.SetId(fmt.Sprintf("%s/%s/%s", region, instanceId, secretId)) + d.SetId(fmt.Sprintf("%s/%s/%s", region, instanceId, *importedCertificate.ID)) + var err error if err = d.Set("region", region); err != nil { return diag.FromErr(fmt.Errorf("Error setting region: %s", err)) } diff --git a/ibm/service/secretsmanager/data_source_ibm_sm_imported_certificate_test.go b/ibm/service/secretsmanager/data_source_ibm_sm_imported_certificate_test.go index c4e2727092..76c9ba5b6a 100644 --- a/ibm/service/secretsmanager/data_source_ibm_sm_imported_certificate_test.go +++ b/ibm/service/secretsmanager/data_source_ibm_sm_imported_certificate_test.go @@ -37,6 +37,8 @@ func TestAccIbmSmImportedCertificateDataSourceBasic(t *testing.T) { resource.TestCheckResourceAttrSet("data.ibm_sm_imported_certificate.sm_imported_certificate", "serial_number"), resource.TestCheckResourceAttrSet("data.ibm_sm_imported_certificate.sm_imported_certificate", "validity.#"), resource.TestCheckResourceAttrSet("data.ibm_sm_imported_certificate.sm_imported_certificate", "certificate"), + resource.TestCheckResourceAttrSet("data.ibm_sm_imported_certificate.sm_imported_certificate_by_name", "name"), + resource.TestCheckResourceAttrSet("data.ibm_sm_imported_certificate.sm_imported_certificate_by_name", "secret_group_name"), ), }, }, @@ -61,5 +63,12 @@ func testAccCheckIbmSmImportedCertificateDataSourceConfigBasic() string { region = "%s" secret_id = ibm_sm_imported_certificate.sm_imported_certificate_instance.secret_id } - `, acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion, acc.SecretsManagerImportedCertificatePathToCertificate, acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion) + + data "ibm_sm_imported_certificate" "sm_imported_certificate_by_name" { + instance_id = "%s" + region = "%s" + name = ibm_sm_imported_certificate.sm_imported_certificate_instance.name + secret_group_name = "default" + } + `, acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion, acc.SecretsManagerImportedCertificatePathToCertificate, acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion, acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion) } diff --git a/ibm/service/secretsmanager/data_source_ibm_sm_kv_secret.go b/ibm/service/secretsmanager/data_source_ibm_sm_kv_secret.go index 0f958d4401..49e78f615f 100644 --- a/ibm/service/secretsmanager/data_source_ibm_sm_kv_secret.go +++ b/ibm/service/secretsmanager/data_source_ibm_sm_kv_secret.go @@ -6,12 +6,9 @@ package secretsmanager import ( "context" "fmt" - "log" - "github.com/hashicorp/terraform-plugin-sdk/v2/diag" "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" - "github.com/IBM-Cloud/terraform-provider-ibm/ibm/conns" "github.com/IBM-Cloud/terraform-provider-ibm/ibm/flex" "github.com/IBM/secrets-manager-go-sdk/v2/secretsmanagerv2" ) @@ -22,9 +19,11 @@ func DataSourceIbmSmKvSecret() *schema.Resource { Schema: map[string]*schema.Schema{ "secret_id": &schema.Schema{ - Type: schema.TypeString, - Required: true, - Description: "The ID of the secret.", + Type: schema.TypeString, + Optional: true, + Computed: true, + ExactlyOneOf: []string{"secret_id", "name"}, + Description: "The ID of the secret.", }, "created_by": &schema.Schema{ Type: schema.TypeString, @@ -73,15 +72,24 @@ func DataSourceIbmSmKvSecret() *schema.Resource { Description: "The number of locks of the secret.", }, "name": &schema.Schema{ - Type: schema.TypeString, - Computed: true, - Description: "The human-readable name of your secret.", + Type: schema.TypeString, + Optional: true, + Computed: true, + ExactlyOneOf: []string{"secret_id", "name"}, + RequiredWith: []string{"secret_group_name"}, + Description: "The human-readable name of your secret.", }, "secret_group_id": &schema.Schema{ Type: schema.TypeString, Computed: true, Description: "A v4 UUID identifier, or `default` secret group.", }, + "secret_group_name": &schema.Schema{ + Type: schema.TypeString, + Optional: true, + RequiredWith: []string{"name"}, + Description: "The human-readable name of your secret group.", + }, "secret_type": &schema.Schema{ Type: schema.TypeString, Computed: true, @@ -121,29 +129,16 @@ func DataSourceIbmSmKvSecret() *schema.Resource { } func dataSourceIbmSmKvSecretRead(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { - secretsManagerClient, err := meta.(conns.ClientSession).SecretsManagerV2() - if err != nil { - return diag.FromErr(err) - } - - region := getRegion(secretsManagerClient, d) - instanceId := d.Get("instance_id").(string) - secretsManagerClient = getClientWithInstanceEndpoint(secretsManagerClient, instanceId, region, getEndpointType(secretsManagerClient, d)) - - getSecretOptions := &secretsmanagerv2.GetSecretOptions{} - - secretId := d.Get("secret_id").(string) - getSecretOptions.SetID(secretId) - kVSecretIntf, response, err := secretsManagerClient.GetSecretWithContext(context, getSecretOptions) - if err != nil { - log.Printf("[DEBUG] GetSecretWithContext failed %s\n%s", err, response) - return diag.FromErr(fmt.Errorf("GetSecretWithContext failed %s\n%s", err, response)) + secret, region, instanceId, diagError := getSecretByIdOrByName(context, d, meta, KvSecretType) + if diagError != nil { + return diagError } - kVSecret := kVSecretIntf.(*secretsmanagerv2.KVSecret) - d.SetId(fmt.Sprintf("%s/%s/%s", region, instanceId, secretId)) + kVSecret := secret.(*secretsmanagerv2.KVSecret) + d.SetId(fmt.Sprintf("%s/%s/%s", region, instanceId, *kVSecret.ID)) + var err error if err = d.Set("region", region); err != nil { return diag.FromErr(fmt.Errorf("Error setting region: %s", err)) } diff --git a/ibm/service/secretsmanager/data_source_ibm_sm_kv_secret_test.go b/ibm/service/secretsmanager/data_source_ibm_sm_kv_secret_test.go index 158241b2d9..072af95792 100644 --- a/ibm/service/secretsmanager/data_source_ibm_sm_kv_secret_test.go +++ b/ibm/service/secretsmanager/data_source_ibm_sm_kv_secret_test.go @@ -30,6 +30,8 @@ func TestAccIbmSmKvSecretDataSourceBasic(t *testing.T) { resource.TestCheckResourceAttrSet("data.ibm_sm_kv_secret.sm_kv_secret", "updated_at"), resource.TestCheckResourceAttrSet("data.ibm_sm_kv_secret.sm_kv_secret", "versions_total"), resource.TestCheckResourceAttrSet("data.ibm_sm_kv_secret.sm_kv_secret", "data.%"), + resource.TestCheckResourceAttrSet("data.ibm_sm_kv_secret.sm_kv_secret_by_name", "name"), + resource.TestCheckResourceAttrSet("data.ibm_sm_kv_secret.sm_kv_secret_by_name", "secret_group_name"), ), }, }, @@ -54,5 +56,12 @@ func testAccCheckIbmSmKvSecretDataSourceConfigBasic() string { region = "%s" secret_id = ibm_sm_kv_secret.sm_kv_secret_instance.secret_id } - `, acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion, acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion) + + data "ibm_sm_kv_secret" "sm_kv_secret_by_name" { + instance_id = "%s" + region = "%s" + name = ibm_sm_kv_secret.sm_kv_secret_instance.name + secret_group_name = "default" + } + `, acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion, acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion, acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion) } diff --git a/ibm/service/secretsmanager/data_source_ibm_sm_private_certificate.go b/ibm/service/secretsmanager/data_source_ibm_sm_private_certificate.go index bb8c07068f..31043b4a78 100644 --- a/ibm/service/secretsmanager/data_source_ibm_sm_private_certificate.go +++ b/ibm/service/secretsmanager/data_source_ibm_sm_private_certificate.go @@ -6,12 +6,9 @@ package secretsmanager import ( "context" "fmt" - "log" - "github.com/hashicorp/terraform-plugin-sdk/v2/diag" "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" - "github.com/IBM-Cloud/terraform-provider-ibm/ibm/conns" "github.com/IBM-Cloud/terraform-provider-ibm/ibm/flex" "github.com/IBM/secrets-manager-go-sdk/v2/secretsmanagerv2" ) @@ -22,9 +19,11 @@ func DataSourceIbmSmPrivateCertificate() *schema.Resource { Schema: map[string]*schema.Schema{ "secret_id": &schema.Schema{ - Type: schema.TypeString, - Required: true, - Description: "The ID of the secret.", + Type: schema.TypeString, + Optional: true, + Computed: true, + ExactlyOneOf: []string{"secret_id", "name"}, + Description: "The ID of the secret.", }, "created_by": &schema.Schema{ Type: schema.TypeString, @@ -73,15 +72,24 @@ func DataSourceIbmSmPrivateCertificate() *schema.Resource { Description: "The number of locks of the secret.", }, "name": &schema.Schema{ - Type: schema.TypeString, - Computed: true, - Description: "The human-readable name of your secret.", + Type: schema.TypeString, + Optional: true, + Computed: true, + ExactlyOneOf: []string{"secret_id", "name"}, + RequiredWith: []string{"secret_group_name"}, + Description: "The human-readable name of your secret.", }, "secret_group_id": &schema.Schema{ Type: schema.TypeString, Computed: true, Description: "A v4 UUID identifier, or `default` secret group.", }, + "secret_group_name": &schema.Schema{ + Type: schema.TypeString, + Optional: true, + RequiredWith: []string{"name"}, + Description: "The human-readable name of your secret group.", + }, "secret_type": &schema.Schema{ Type: schema.TypeString, Computed: true, @@ -250,30 +258,16 @@ func DataSourceIbmSmPrivateCertificate() *schema.Resource { } func dataSourceIbmSmPrivateCertificateRead(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { - secretsManagerClient, err := meta.(conns.ClientSession).SecretsManagerV2() - if err != nil { - return diag.FromErr(err) - } - - region := getRegion(secretsManagerClient, d) - instanceId := d.Get("instance_id").(string) - secretsManagerClient = getClientWithInstanceEndpoint(secretsManagerClient, instanceId, region, getEndpointType(secretsManagerClient, d)) - - getSecretOptions := &secretsmanagerv2.GetSecretOptions{} - - secretId := d.Get("secret_id").(string) - getSecretOptions.SetID(secretId) - - privateCertificateIntf, response, err := secretsManagerClient.GetSecretWithContext(context, getSecretOptions) - if err != nil { - log.Printf("[DEBUG] GetSecretWithContext failed %s\n%s", err, response) - return diag.FromErr(fmt.Errorf("GetSecretWithContext failed %s\n%s", err, response)) + privateCertificateIntf, region, instanceId, diagError := getSecretByIdOrByName(context, d, meta, PrivateCertSecretType) + if diagError != nil { + return diagError } privateCertificate := privateCertificateIntf.(*secretsmanagerv2.PrivateCertificate) - d.SetId(fmt.Sprintf("%s/%s/%s", region, instanceId, secretId)) + d.SetId(fmt.Sprintf("%s/%s/%s", region, instanceId, *privateCertificate.ID)) + var err error if err = d.Set("region", region); err != nil { return diag.FromErr(fmt.Errorf("Error setting region: %s", err)) } diff --git a/ibm/service/secretsmanager/data_source_ibm_sm_private_certificate_test.go b/ibm/service/secretsmanager/data_source_ibm_sm_private_certificate_test.go index d714a0a499..cfe6ad93c3 100644 --- a/ibm/service/secretsmanager/data_source_ibm_sm_private_certificate_test.go +++ b/ibm/service/secretsmanager/data_source_ibm_sm_private_certificate_test.go @@ -37,6 +37,8 @@ func TestAccIbmSmPrivateCertificateDataSourceBasic(t *testing.T) { resource.TestCheckResourceAttrSet("data.ibm_sm_private_certificate.sm_private_certificate", "validity.#"), resource.TestCheckResourceAttrSet("data.ibm_sm_private_certificate.sm_private_certificate", "certificate"), resource.TestCheckResourceAttrSet("data.ibm_sm_private_certificate.sm_private_certificate", "private_key"), + resource.TestCheckResourceAttrSet("data.ibm_sm_private_certificate.sm_private_certificate_by_name", "name"), + resource.TestCheckResourceAttrSet("data.ibm_sm_private_certificate.sm_private_certificate_by_name", "secret_group_name"), ), }, }, @@ -88,8 +90,15 @@ func testAccCheckIbmSmPrivateCertificateDataSourceConfigBasic() string { region = "%s" secret_id = ibm_sm_private_certificate.sm_private_certificate_instance.secret_id } + + data "ibm_sm_private_certificate" "sm_private_certificate_by_name" { + instance_id = "%s" + region = "%s" + name = ibm_sm_private_certificate.sm_private_certificate_instance.name + secret_group_name = "default" + } `, acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion, acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion, acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion, acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion, acc.SecretsManagerInstanceID, - acc.SecretsManagerInstanceRegion) + acc.SecretsManagerInstanceRegion, acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion) } diff --git a/ibm/service/secretsmanager/data_source_ibm_sm_public_certificate.go b/ibm/service/secretsmanager/data_source_ibm_sm_public_certificate.go index 612fe7bcf4..20bfe5e1dd 100644 --- a/ibm/service/secretsmanager/data_source_ibm_sm_public_certificate.go +++ b/ibm/service/secretsmanager/data_source_ibm_sm_public_certificate.go @@ -6,12 +6,9 @@ package secretsmanager import ( "context" "fmt" - "log" - "github.com/hashicorp/terraform-plugin-sdk/v2/diag" "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" - "github.com/IBM-Cloud/terraform-provider-ibm/ibm/conns" "github.com/IBM-Cloud/terraform-provider-ibm/ibm/flex" "github.com/IBM/secrets-manager-go-sdk/v2/secretsmanagerv2" ) @@ -22,11 +19,12 @@ func DataSourceIbmSmPublicCertificate() *schema.Resource { Schema: map[string]*schema.Schema{ "secret_id": &schema.Schema{ - Type: schema.TypeString, - Required: true, - Description: "The ID of the secret.", + Type: schema.TypeString, + Optional: true, + Computed: true, + ExactlyOneOf: []string{"secret_id", "name"}, + Description: "The ID of the secret.", }, - "created_by": &schema.Schema{ Type: schema.TypeString, Computed: true, @@ -74,15 +72,24 @@ func DataSourceIbmSmPublicCertificate() *schema.Resource { Description: "The number of locks of the secret.", }, "name": &schema.Schema{ - Type: schema.TypeString, - Computed: true, - Description: "The human-readable name of your secret.", + Type: schema.TypeString, + Optional: true, + Computed: true, + ExactlyOneOf: []string{"secret_id", "name"}, + RequiredWith: []string{"secret_group_name"}, + Description: "The human-readable name of your secret.", }, "secret_group_id": &schema.Schema{ Type: schema.TypeString, Computed: true, Description: "A v4 UUID identifier, or `default` secret group.", }, + "secret_group_name": &schema.Schema{ + Type: schema.TypeString, + Optional: true, + RequiredWith: []string{"name"}, + Description: "The human-readable name of your secret group.", + }, "secret_type": &schema.Schema{ Type: schema.TypeString, Computed: true, @@ -300,30 +307,16 @@ func DataSourceIbmSmPublicCertificate() *schema.Resource { } func dataSourceIbmSmPublicCertificateSecretRead(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { - secretsManagerClient, err := meta.(conns.ClientSession).SecretsManagerV2() - if err != nil { - return diag.FromErr(err) - } - - region := getRegion(secretsManagerClient, d) - instanceId := d.Get("instance_id").(string) - secretsManagerClient = getClientWithInstanceEndpoint(secretsManagerClient, instanceId, region, getEndpointType(secretsManagerClient, d)) - - getSecretOptions := &secretsmanagerv2.GetSecretOptions{} - - secretId := d.Get("secret_id").(string) - getSecretOptions.SetID(secretId) - - publicCertificateIntf, response, err := secretsManagerClient.GetSecretWithContext(context, getSecretOptions) - if err != nil { - log.Printf("[DEBUG] GetSecretWithContext failed %s\n%s", err, response) - return diag.FromErr(fmt.Errorf("GetSecretWithContext failed %s\n%s", err, response)) + publicCertificateIntf, region, instanceId, diagError := getSecretByIdOrByName(context, d, meta, PublicCertSecretType) + if diagError != nil { + return diagError } publicCertificate := publicCertificateIntf.(*secretsmanagerv2.PublicCertificate) - d.SetId(fmt.Sprintf("%s/%s/%s", region, instanceId, secretId)) + d.SetId(fmt.Sprintf("%s/%s/%s", region, instanceId, *publicCertificate.ID)) + var err error if err = d.Set("region", region); err != nil { return diag.FromErr(fmt.Errorf("Error setting region: %s", err)) } diff --git a/ibm/service/secretsmanager/data_source_ibm_sm_public_certificate_test.go b/ibm/service/secretsmanager/data_source_ibm_sm_public_certificate_test.go index f267181ee3..0b97d93b51 100644 --- a/ibm/service/secretsmanager/data_source_ibm_sm_public_certificate_test.go +++ b/ibm/service/secretsmanager/data_source_ibm_sm_public_certificate_test.go @@ -30,6 +30,8 @@ func TestAccIbmSmPublicCertificateDataSourceBasic(t *testing.T) { resource.TestCheckResourceAttrSet("data.ibm_sm_public_certificate.sm_public_certificate", "common_name"), resource.TestCheckResourceAttrSet("data.ibm_sm_public_certificate.sm_public_certificate", "key_algorithm"), resource.TestCheckResourceAttrSet("data.ibm_sm_public_certificate.sm_public_certificate", "rotation.#"), + resource.TestCheckResourceAttrSet("data.ibm_sm_public_certificate.sm_public_certificate_by_name", "name"), + resource.TestCheckResourceAttrSet("data.ibm_sm_public_certificate.sm_public_certificate_by_name", "secret_group_name"), ), }, }, @@ -68,8 +70,15 @@ func testAccCheckIbmSmPublicCertificateDataSourceConfigBasic() string { region = "%s" secret_id = ibm_sm_public_certificate.sm_public_certificate_instance.secret_id } + + data "ibm_sm_public_certificate" "sm_public_certificate_by_name" { + instance_id = "%s" + region = "%s" + name = ibm_sm_public_certificate.sm_public_certificate_instance.name + secret_group_name = "default" + } `, acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion, acc.SecretsManagerPublicCertificateLetsEncryptEnvironment, acc.SecretsManagerPublicCertificateLetsEncryptPrivateKey, acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion, acc.SecretsManagerPublicCertificateCisCrn, acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion, generatePublicCertCommonName(), - acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion) + acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion, acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion) } diff --git a/ibm/service/secretsmanager/data_source_ibm_sm_username_password_secret.go b/ibm/service/secretsmanager/data_source_ibm_sm_username_password_secret.go index aa45838aaa..5a9fa84aff 100644 --- a/ibm/service/secretsmanager/data_source_ibm_sm_username_password_secret.go +++ b/ibm/service/secretsmanager/data_source_ibm_sm_username_password_secret.go @@ -6,12 +6,9 @@ package secretsmanager import ( "context" "fmt" - "log" - "github.com/hashicorp/terraform-plugin-sdk/v2/diag" "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" - "github.com/IBM-Cloud/terraform-provider-ibm/ibm/conns" "github.com/IBM-Cloud/terraform-provider-ibm/ibm/flex" "github.com/IBM/secrets-manager-go-sdk/v2/secretsmanagerv2" ) @@ -22,9 +19,11 @@ func DataSourceIbmSmUsernamePasswordSecret() *schema.Resource { Schema: map[string]*schema.Schema{ "secret_id": &schema.Schema{ - Type: schema.TypeString, - Required: true, - Description: "The ID of the secret.", + Type: schema.TypeString, + Optional: true, + Computed: true, + ExactlyOneOf: []string{"secret_id", "name"}, + Description: "The ID of the secret.", }, "created_by": &schema.Schema{ Type: schema.TypeString, @@ -73,15 +72,24 @@ func DataSourceIbmSmUsernamePasswordSecret() *schema.Resource { Description: "The number of locks of the secret.", }, "name": &schema.Schema{ - Type: schema.TypeString, - Computed: true, - Description: "The human-readable name of your secret.", + Type: schema.TypeString, + Optional: true, + Computed: true, + ExactlyOneOf: []string{"secret_id", "name"}, + RequiredWith: []string{"secret_group_name"}, + Description: "The human-readable name of your secret.", }, "secret_group_id": &schema.Schema{ Type: schema.TypeString, Computed: true, Description: "A v4 UUID identifier, or `default` secret group.", }, + "secret_group_name": &schema.Schema{ + Type: schema.TypeString, + Optional: true, + RequiredWith: []string{"name"}, + Description: "The human-readable name of your secret group.", + }, "secret_type": &schema.Schema{ Type: schema.TypeString, Computed: true, @@ -162,29 +170,16 @@ func DataSourceIbmSmUsernamePasswordSecret() *schema.Resource { } func dataSourceIbmSmUsernamePasswordSecretRead(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { - secretsManagerClient, err := meta.(conns.ClientSession).SecretsManagerV2() - if err != nil { - return diag.FromErr(err) + secret, region, instanceId, diagError := getSecretByIdOrByName(context, d, meta, UsernamePasswordSecretType) + if diagError != nil { + return diagError } - region := getRegion(secretsManagerClient, d) - instanceId := d.Get("instance_id").(string) - secretsManagerClient = getClientWithInstanceEndpoint(secretsManagerClient, instanceId, region, getEndpointType(secretsManagerClient, d)) - - getSecretOptions := &secretsmanagerv2.GetSecretOptions{} - - secretId := d.Get("secret_id").(string) - getSecretOptions.SetID(secretId) - - usernamePasswordSecretIntf, response, err := secretsManagerClient.GetSecretWithContext(context, getSecretOptions) - if err != nil { - log.Printf("[DEBUG] GetSecretWithContext failed %s\n%s", err, response) - return diag.FromErr(fmt.Errorf("GetSecretWithContext failed %s\n%s", err, response)) - } - usernamePasswordSecret := usernamePasswordSecretIntf.(*secretsmanagerv2.UsernamePasswordSecret) + usernamePasswordSecret := secret.(*secretsmanagerv2.UsernamePasswordSecret) - d.SetId(fmt.Sprintf("%s/%s/%s", region, instanceId, secretId)) + d.SetId(fmt.Sprintf("%s/%s/%s", region, instanceId, *usernamePasswordSecret.ID)) + var err error if err = d.Set("region", region); err != nil { return diag.FromErr(fmt.Errorf("Error setting region: %s", err)) } diff --git a/ibm/service/secretsmanager/data_source_ibm_sm_username_password_secret_test.go b/ibm/service/secretsmanager/data_source_ibm_sm_username_password_secret_test.go index 4a81435667..57c04216e8 100644 --- a/ibm/service/secretsmanager/data_source_ibm_sm_username_password_secret_test.go +++ b/ibm/service/secretsmanager/data_source_ibm_sm_username_password_secret_test.go @@ -32,6 +32,8 @@ func TestAccIbmSmUsernamePasswordSecretDataSourceBasic(t *testing.T) { resource.TestCheckResourceAttrSet("data.ibm_sm_username_password_secret.sm_username_password_secret", "rotation.#"), resource.TestCheckResourceAttrSet("data.ibm_sm_username_password_secret.sm_username_password_secret", "username"), resource.TestCheckResourceAttrSet("data.ibm_sm_username_password_secret.sm_username_password_secret", "password"), + resource.TestCheckResourceAttrSet("data.ibm_sm_username_password_secret.sm_username_password_secret_by_name", "name"), + resource.TestCheckResourceAttrSet("data.ibm_sm_username_password_secret.sm_username_password_secret_by_name", "secret_group_name"), ), }, }, @@ -62,5 +64,12 @@ func testAccCheckIbmSmUsernamePasswordSecretDataSourceConfigBasic() string { region = "%s" secret_id = ibm_sm_username_password_secret.sm_username_password_secret_instance.secret_id } - `, acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion, acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion) + + data "ibm_sm_username_password_secret" "sm_username_password_secret_by_name" { + instance_id = "%s" + region = "%s" + name = ibm_sm_username_password_secret.sm_username_password_secret_instance.name + secret_group_name = "default" + } + `, acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion, acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion, acc.SecretsManagerInstanceID, acc.SecretsManagerInstanceRegion) } diff --git a/ibm/service/secretsmanager/resource_ibm_sm_public_certificate.go b/ibm/service/secretsmanager/resource_ibm_sm_public_certificate.go index 38a9853b6e..fb268ad8ed 100644 --- a/ibm/service/secretsmanager/resource_ibm_sm_public_certificate.go +++ b/ibm/service/secretsmanager/resource_ibm_sm_public_certificate.go @@ -781,8 +781,9 @@ func resourceIbmSmPublicCertificateMapToSecretPrototype(d *schema.ResourceData) model.Dns = core.StringPtr(d.Get("dns").(string)) } } - if _, ok := d.GetOk("bundle_certs"); ok { - model.BundleCerts = core.BoolPtr(d.Get("bundle_certs").(bool)) + bundleCerts, ok := d.GetOkExists("bundle_certs") + if ok { + model.BundleCerts = core.BoolPtr(bundleCerts.(bool)) } if _, ok := d.GetOk("rotation"); ok { RotationModel, err := resourceIbmSmPublicCertificateMapToPublicCertificateRotationPolicy(d.Get("rotation").([]interface{})[0].(map[string]interface{})) diff --git a/ibm/service/secretsmanager/utils.go b/ibm/service/secretsmanager/utils.go index 5de0e6ccd9..a00f44c9af 100644 --- a/ibm/service/secretsmanager/utils.go +++ b/ibm/service/secretsmanager/utils.go @@ -1,16 +1,31 @@ package secretsmanager import ( + "context" "fmt" + "github.com/IBM-Cloud/terraform-provider-ibm/ibm/conns" + "github.com/IBM/go-sdk-core/v5/core" "github.com/IBM/secrets-manager-go-sdk/v2/secretsmanagerv2" "github.com/go-openapi/strfmt" + "github.com/hashicorp/terraform-plugin-sdk/v2/diag" "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" + "log" "os" "strconv" "strings" "time" ) +const ( + ArbitrarySecretType = "arbitrary" + UsernamePasswordSecretType = "username_password" + IAMCredentialsSecretType = "iam_credentials" + KvSecretType = "kv" + ImportedCertSecretType = "imported_cert" + PublicCertSecretType = "public_cert" + PrivateCertSecretType = "private_cert" +) + func getRegion(originalClient *secretsmanagerv2.SecretsManagerV2, d *schema.ResourceData) string { _, ok := d.GetOk("region") if ok { @@ -116,3 +131,53 @@ func DateTimeToRFC3339(dt *strfmt.DateTime) (s string) { } return } + +func getSecretByIdOrByName(context context.Context, d *schema.ResourceData, meta interface{}, secretType string) (secretsmanagerv2.SecretIntf, string, string, diag.Diagnostics) { + + secretsManagerClient, err := meta.(conns.ClientSession).SecretsManagerV2() + if err != nil { + return nil, "", "", diag.FromErr(err) + } + region := getRegion(secretsManagerClient, d) + instanceId := d.Get("instance_id").(string) + secretsManagerClient = getClientWithInstanceEndpoint(secretsManagerClient, instanceId, region, getEndpointType(secretsManagerClient, d)) + + secretId := d.Get("secret_id").(string) + secretName := d.Get("name").(string) + groupName := d.Get("secret_group_name").(string) + + log.Printf("[DEBUG] getSecretByIdOrByName %q %q %q %q\n", secretId, secretName, groupName, secretType) + + var secretIntf secretsmanagerv2.SecretIntf + var response *core.DetailedResponse + + if secretId != "" { + getSecretOptions := &secretsmanagerv2.GetSecretOptions{} + getSecretOptions.SetID(secretId) + + secretIntf, response, err = secretsManagerClient.GetSecretWithContext(context, getSecretOptions) + if err != nil { + log.Printf("[DEBUG] GetSecretWithContext failed %s\n%s", err, response) + return nil, "", "", diag.FromErr(fmt.Errorf("GetSecretWithContext failed %s\n%s", err, response)) + } + return secretIntf, region, instanceId, nil + } + + if secretName != "" && groupName != "" { + // Locate secret by name + getSecretByNameOptions := &secretsmanagerv2.GetSecretByNameTypeOptions{} + + getSecretByNameOptions.SetName(secretName) + getSecretByNameOptions.SetSecretType(secretType) + getSecretByNameOptions.SetSecretGroupName(groupName) + + secretIntf, response, err = secretsManagerClient.GetSecretByNameTypeWithContext(context, getSecretByNameOptions) + if err != nil { + log.Printf("[DEBUG] GetSecretByNameTypeWithContext failed %s\n%s", err, response) + return nil, "", "", diag.FromErr(fmt.Errorf("GetSecretByNameTypeWithContext failed %s\n%s", err, response)) + } + return secretIntf, region, instanceId, nil + } + + return nil, "", "", diag.FromErr(fmt.Errorf("Missing required arguments. Please make sure that either \"secret_id\" or \"name\" and \"secret_group_name\" are provided\n")) +} diff --git a/ibm/service/usagereports/README.md b/ibm/service/usagereports/README.md new file mode 100644 index 0000000000..9b2d5ef7a2 --- /dev/null +++ b/ibm/service/usagereports/README.md @@ -0,0 +1,11 @@ +# Terraform IBM Provider + +This area is primarily for IBM provider contributors and maintainers. For information on _using_ Terraform and the IBM provider, see the links below. + + +## Handy Links +* [Find out about contributing](../../../CONTRIBUTING.md) to the IBM provider! +* IBM Provider Docs: [Home](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs) +* IBM Provider Docs: [One of the resources](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/billing_report_snapshot) +* IBM API Docs: [IBM API Docs for ]() +* IBM SDK: [IBM SDK for ](https://github.com/IBM/appconfiguration-go-admin-sdk/tree/master/usagereportsv4) diff --git a/ibm/service/usagereports/data_source_ibm_billing_snapshot_list.go b/ibm/service/usagereports/data_source_ibm_billing_snapshot_list.go new file mode 100644 index 0000000000..84aa1d014c --- /dev/null +++ b/ibm/service/usagereports/data_source_ibm_billing_snapshot_list.go @@ -0,0 +1,413 @@ +// Copyright IBM Corp. 2023 All Rights Reserved. +// Licensed under the Mozilla Public License v2.0 + +package usagereports + +import ( + "context" + "fmt" + "log" + "time" + + "github.com/hashicorp/terraform-plugin-sdk/v2/diag" + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" + + "github.com/IBM-Cloud/terraform-provider-ibm/ibm/conns" + "github.com/IBM-Cloud/terraform-provider-ibm/ibm/flex" + "github.com/IBM/platform-services-go-sdk/usagereportsv4" +) + +func DataSourceIBMBillingSnapshotList() *schema.Resource { + return &schema.Resource{ + ReadContext: dataSourceIBMBillingSnapshotListRead, + + Schema: map[string]*schema.Schema{ + "month": { + Type: schema.TypeString, + Required: true, + Description: "The month for which billing report snapshot is requested. Format is yyyy-mm.", + }, + "date_from": { + Type: schema.TypeInt, + Optional: true, + Description: "Timestamp in milliseconds for which billing report snapshot is requested.", + }, + "date_to": { + Type: schema.TypeInt, + Optional: true, + Description: "Timestamp in milliseconds for which billing report snapshot is requested.", + }, + "snapshotcount": { + Type: schema.TypeInt, + Computed: true, + Description: "Number of total snapshots.", + }, + "first": { + Type: schema.TypeList, + Computed: true, + Description: "Reference to the first page of the search query.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "href": { + Type: schema.TypeString, + Computed: true, + }, + }, + }, + }, + "next": { + Type: schema.TypeList, + Computed: true, + Description: "Reference to the next page of the search query if any.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "href": { + Type: schema.TypeString, + Computed: true, + }, + }, + }, + }, + "snapshots": { + Type: schema.TypeList, + Computed: true, + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "account_id": { + Type: schema.TypeString, + Computed: true, + Description: "Account ID for which billing report snapshot is configured.", + }, + "month": { + Type: schema.TypeString, + Computed: true, + Description: "Month of captured snapshot.", + }, + "account_type": { + Type: schema.TypeString, + Computed: true, + Description: "Type of account. Possible values are [enterprise, account].", + }, + "expected_processed_at": { + Type: schema.TypeInt, + Computed: true, + Description: "Timestamp of snapshot processed.", + }, + "state": { + Type: schema.TypeString, + Computed: true, + Description: "Status of the billing snapshot configuration. Possible values are [enabled, disabled].", + }, + "billing_period": { + Type: schema.TypeList, + Computed: true, + Description: "Period of billing in snapshot.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "start": { + Type: schema.TypeString, + Computed: true, + Description: "Date and time of start of billing in the respective snapshot.", + }, + "end": { + Type: schema.TypeString, + Computed: true, + Description: "Date and time of end of billing in the respective snapshot.", + }, + }, + }, + }, + "snapshot_id": { + Type: schema.TypeString, + Computed: true, + Description: "Id of the snapshot captured.", + }, + "charset": { + Type: schema.TypeString, + Computed: true, + Description: "Character encoding used.", + }, + "compression": { + Type: schema.TypeString, + Computed: true, + Description: "Compression format of the snapshot report.", + }, + "content_type": { + Type: schema.TypeString, + Computed: true, + Description: "Type of content stored in snapshot report.", + }, + "bucket": { + Type: schema.TypeString, + Computed: true, + Description: "The name of the COS bucket to store the snapshot of the billing reports.", + }, + "version": { + Type: schema.TypeString, + Computed: true, + Description: "Version of the snapshot.", + }, + "created_on": { + Type: schema.TypeString, + Computed: true, + Description: "Date and time of creation of snapshot.", + }, + "report_types": { + Type: schema.TypeList, + Computed: true, + Description: "List of report types configured for the snapshot.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "type": { + Type: schema.TypeString, + Computed: true, + Description: "The type of billing report of the snapshot. Possible values are [account_summary, enterprise_summary, account_resource_instance_usage].", + }, + "version": { + Type: schema.TypeString, + Computed: true, + Description: "Version of the snapshot.", + }, + }, + }, + }, + "files": { + Type: schema.TypeList, + Computed: true, + Description: "List of location of reports.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "report_types": { + Type: schema.TypeString, + Computed: true, + Description: "The type of billing report stored. Possible values are [account_summary, enterprise_summary, account_resource_instance_usage].", + }, + "location": { + Type: schema.TypeString, + Computed: true, + Description: "Absolute path of the billing report in the COS instance.", + }, + "account_id": { + Type: schema.TypeString, + Computed: true, + Description: "Account ID for which billing report is captured.", + }, + }, + }, + }, + "processed_at": { + Type: schema.TypeInt, + Computed: true, + Description: "Timestamp at which snapshot is captured.", + }, + }, + }, + }, + }, + } +} + +func dataSourceIBMBillingSnapshotListRead(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { + usageReportsClient, err := meta.(conns.ClientSession).UsageReportsV4() + if err != nil { + return diag.FromErr(err) + } + + getReportsSnapshotOptions := &usagereportsv4.GetReportsSnapshotOptions{} + + userDetails, err := meta.(conns.ClientSession).BluemixUserDetails() + if err != nil { + return diag.FromErr(err) + } + + getReportsSnapshotOptions.SetAccountID(userDetails.UserAccount) + getReportsSnapshotOptions.SetMonth(d.Get("month").(string)) + if _, ok := d.GetOk("date_from"); ok { + getReportsSnapshotOptions.SetDateFrom(int64(d.Get("date_from").(int))) + } + if _, ok := d.GetOk("date_to"); ok { + getReportsSnapshotOptions.SetDateTo(int64(d.Get("date_to").(int))) + } + + snapshotList, response, err := usageReportsClient.GetReportsSnapshotWithContext(context, getReportsSnapshotOptions) + if err != nil { + log.Printf("[DEBUG] GetReportsSnapshotWithContext failed %s\n%s", err, response) + return diag.FromErr(fmt.Errorf("GetReportsSnapshotWithContext failed %s\n%s", err, response)) + } + + d.SetId(dataSourceIBMBillingSnapshotListID(d)) + + if err = d.Set("snapshotcount", flex.IntValue(snapshotList.Count)); err != nil { + return diag.FromErr(fmt.Errorf("Error setting count: %s", err)) + } + + first := []map[string]interface{}{} + if snapshotList.First != nil { + modelMap, err := dataSourceIBMBillingSnapshotListSnapshotListFirstToMap(snapshotList.First) + if err != nil { + return diag.FromErr(err) + } + first = append(first, modelMap) + } + if err = d.Set("first", first); err != nil { + return diag.FromErr(fmt.Errorf("Error setting first %s", err)) + } + + next := []map[string]interface{}{} + if snapshotList.Next != nil { + modelMap, err := dataSourceIBMBillingSnapshotListSnapshotListNextToMap(snapshotList.Next) + if err != nil { + return diag.FromErr(err) + } + next = append(next, modelMap) + } + if err = d.Set("next", next); err != nil { + return diag.FromErr(fmt.Errorf("Error setting next %s", err)) + } + + snapshots := []map[string]interface{}{} + if snapshotList.Snapshots != nil { + for _, modelItem := range snapshotList.Snapshots { + modelMap, err := dataSourceIBMBillingSnapshotListSnapshotListSnapshotsItemToMap(&modelItem) + if err != nil { + return diag.FromErr(err) + } + snapshots = append(snapshots, modelMap) + } + } + if err = d.Set("snapshots", snapshots); err != nil { + return diag.FromErr(fmt.Errorf("Error setting snapshots %s", err)) + } + + return nil +} + +// dataSourceIBMBillingSnapshotListID returns a reasonable ID for the list. +func dataSourceIBMBillingSnapshotListID(d *schema.ResourceData) string { + return time.Now().UTC().String() +} + +func dataSourceIBMBillingSnapshotListSnapshotListFirstToMap(model *usagereportsv4.SnapshotListFirst) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + if model.Href != nil { + modelMap["href"] = model.Href + } + return modelMap, nil +} + +func dataSourceIBMBillingSnapshotListSnapshotListNextToMap(model *usagereportsv4.SnapshotListNext) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + if model.Href != nil { + modelMap["href"] = model.Href + } + return modelMap, nil +} + +func dataSourceIBMBillingSnapshotListSnapshotListSnapshotsItemToMap(model *usagereportsv4.SnapshotListSnapshotsItem) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + if model.AccountID != nil { + modelMap["account_id"] = model.AccountID + } + if model.Month != nil { + modelMap["month"] = model.Month + } + if model.AccountType != nil { + modelMap["account_type"] = model.AccountType + } + if model.ExpectedProcessedAt != nil { + modelMap["expected_processed_at"] = flex.IntValue(model.ExpectedProcessedAt) + } + if model.State != nil { + modelMap["state"] = model.State + } + if model.BillingPeriod != nil { + billingPeriodMap, err := dataSourceIBMBillingSnapshotListSnapshotListSnapshotsItemBillingPeriodToMap(model.BillingPeriod) + if err != nil { + return modelMap, err + } + modelMap["billing_period"] = []map[string]interface{}{billingPeriodMap} + } + if model.SnapshotID != nil { + modelMap["snapshot_id"] = model.SnapshotID + } + if model.Charset != nil { + modelMap["charset"] = model.Charset + } + if model.Compression != nil { + modelMap["compression"] = model.Compression + } + if model.ContentType != nil { + modelMap["content_type"] = model.ContentType + } + if model.Bucket != nil { + modelMap["bucket"] = model.Bucket + } + if model.Version != nil { + modelMap["version"] = model.Version + } + if model.CreatedOn != nil { + modelMap["created_on"] = model.CreatedOn + } + if model.ReportTypes != nil { + reportTypes := []map[string]interface{}{} + for _, reportTypesItem := range model.ReportTypes { + reportTypesItemMap, err := dataSourceIBMBillingSnapshotListSnapshotListSnapshotsItemReportTypesItemToMap(&reportTypesItem) + if err != nil { + return modelMap, err + } + reportTypes = append(reportTypes, reportTypesItemMap) + } + modelMap["report_types"] = reportTypes + } + if model.Files != nil { + files := []map[string]interface{}{} + for _, filesItem := range model.Files { + filesItemMap, err := dataSourceIBMBillingSnapshotListSnapshotListSnapshotsItemFilesItemToMap(&filesItem) + if err != nil { + return modelMap, err + } + files = append(files, filesItemMap) + } + modelMap["files"] = files + } + if model.ProcessedAt != nil { + modelMap["processed_at"] = flex.IntValue(model.ProcessedAt) + } + return modelMap, nil +} + +func dataSourceIBMBillingSnapshotListSnapshotListSnapshotsItemBillingPeriodToMap(model *usagereportsv4.SnapshotListSnapshotsItemBillingPeriod) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + if model.Start != nil { + modelMap["start"] = model.Start + } + if model.End != nil { + modelMap["end"] = model.End + } + return modelMap, nil +} + +func dataSourceIBMBillingSnapshotListSnapshotListSnapshotsItemReportTypesItemToMap(model *usagereportsv4.SnapshotListSnapshotsItemReportTypesItem) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + if model.Type != nil { + modelMap["type"] = model.Type + } + if model.Version != nil { + modelMap["version"] = model.Version + } + return modelMap, nil +} + +func dataSourceIBMBillingSnapshotListSnapshotListSnapshotsItemFilesItemToMap(model *usagereportsv4.SnapshotListSnapshotsItemFilesItem) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + if model.ReportTypes != nil { + modelMap["report_types"] = model.ReportTypes + } + if model.Location != nil { + modelMap["location"] = model.Location + } + if model.AccountID != nil { + modelMap["account_id"] = model.AccountID + } + return modelMap, nil +} diff --git a/ibm/service/usagereports/data_source_ibm_billing_snapshot_list_test.go b/ibm/service/usagereports/data_source_ibm_billing_snapshot_list_test.go new file mode 100644 index 0000000000..e195d730be --- /dev/null +++ b/ibm/service/usagereports/data_source_ibm_billing_snapshot_list_test.go @@ -0,0 +1,45 @@ +// Copyright IBM Corp. 2023 All Rights Reserved. +// Licensed under the Mozilla Public License v2.0 + +package usagereports_test + +import ( + "fmt" + "strconv" + "testing" + + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource" + + acc "github.com/IBM-Cloud/terraform-provider-ibm/ibm/acctest" +) + +func TestAccIBMBillingSnapshotListDataSourceBasic(t *testing.T) { + month := acc.Snapshot_month + date_from := acc.Snapshot_date_from + date_to := acc.Snapshot_date_to + resource.Test(t, resource.TestCase{ + PreCheck: func() { acc.TestAccPreCheckUsage(t) }, + Providers: acc.TestAccProviders, + Steps: []resource.TestStep{ + { + Config: testAccCheckIBMBillingSnapshotListDataSourceConfigBasic(month, date_from, date_to), + Check: resource.ComposeTestCheckFunc( + resource.TestCheckResourceAttrSet("data.ibm_billing_snapshot_list.billing_snapshot_list_instance", "id"), + resource.TestCheckResourceAttrSet("data.ibm_billing_snapshot_list.billing_snapshot_list_instance", "month"), + ), + }, + }, + }) +} + +func testAccCheckIBMBillingSnapshotListDataSourceConfigBasic(month string, date_from string, date_to string) string { + from, _ := strconv.ParseInt(date_from, 10, 64) + to, _ := strconv.ParseInt(date_to, 10, 64) + return fmt.Sprintf(` + data "ibm_billing_snapshot_list" "billing_snapshot_list_instance" { + month = "%s" + date_from = "%d" + date_to = "%d" + } + `, month, from, to) +} diff --git a/ibm/service/usagereports/resource_ibm_billing_report_snapshot.go b/ibm/service/usagereports/resource_ibm_billing_report_snapshot.go new file mode 100644 index 0000000000..18659e001b --- /dev/null +++ b/ibm/service/usagereports/resource_ibm_billing_report_snapshot.go @@ -0,0 +1,475 @@ +// Copyright IBM Corp. 2023 All Rights Reserved. +// Licensed under the Mozilla Public License v2.0 + +package usagereports + +import ( + "context" + "fmt" + "log" + + "github.com/hashicorp/terraform-plugin-sdk/v2/diag" + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" + + "github.com/IBM-Cloud/terraform-provider-ibm/ibm/conns" + "github.com/IBM-Cloud/terraform-provider-ibm/ibm/flex" + "github.com/IBM-Cloud/terraform-provider-ibm/ibm/validate" + "github.com/IBM/go-sdk-core/v5/core" + "github.com/IBM/platform-services-go-sdk/usagereportsv4" +) + +func ResourceIBMBillingReportSnapshot() *schema.Resource { + return &schema.Resource{ + CreateContext: resourceIBMBillingReportSnapshotCreate, + ReadContext: resourceIBMBillingReportSnapshotRead, + UpdateContext: resourceIBMBillingReportSnapshotUpdate, + DeleteContext: resourceIBMBillingReportSnapshotDelete, + Importer: &schema.ResourceImporter{}, + + Schema: map[string]*schema.Schema{ + "interval": { + Type: schema.TypeString, + Required: true, + ValidateFunc: validate.InvokeValidator("ibm_billing_report_snapshot", "interval"), + Description: "Frequency of taking the snapshot of the billing reports.", + }, + "versioning": { + Type: schema.TypeString, + Optional: true, + Default: "new", + ValidateFunc: validate.InvokeValidator("ibm_billing_report_snapshot", "versioning"), + Description: "A new version of report is created or the existing report version is overwritten with every update.", + }, + "report_types": { + Type: schema.TypeList, + Optional: true, + Description: "The type of billing reports to take snapshot of. Possible values are [account_summary, enterprise_summary, account_resource_instance_usage].", + Elem: &schema.Schema{Type: schema.TypeString}, + }, + "cos_reports_folder": { + Type: schema.TypeString, + Optional: true, + Default: "IBMCloud-Billing-Reports", + Description: "The billing reports root folder to store the billing reports snapshots. Defaults to \"IBMCloud-Billing-Reports\".", + }, + "cos_bucket": { + Type: schema.TypeString, + Required: true, + Description: "The name of the COS bucket to store the snapshot of the billing reports.", + }, + "cos_location": { + Type: schema.TypeString, + Required: true, + Description: "Region of the COS instance.", + }, + "state": { + Type: schema.TypeString, + Computed: true, + Description: "Status of the billing snapshot configuration. Possible values are [enabled, disabled].", + }, + "account_type": { + Type: schema.TypeString, + Computed: true, + Description: "Type of account. Possible values are [enterprise, account].", + }, + "compression": { + Type: schema.TypeString, + Computed: true, + Description: "Compression format of the snapshot report.", + }, + "content_type": { + Type: schema.TypeString, + Computed: true, + Description: "Type of content stored in snapshot report.", + }, + "cos_endpoint": { + Type: schema.TypeString, + Computed: true, + Description: "The endpoint of the COS instance.", + }, + "created_at": { + Type: schema.TypeInt, + Computed: true, + Description: "Timestamp in milliseconds when the snapshot configuration was created.", + }, + "last_updated_at": { + Type: schema.TypeInt, + Computed: true, + Description: "Timestamp in milliseconds when the snapshot configuration was last updated.", + }, + "history": { + Type: schema.TypeList, + Computed: true, + Description: "List of previous versions of the snapshot configurations.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "start_time": { + Type: schema.TypeInt, + Optional: true, + Description: "Timestamp in milliseconds when the snapshot configuration was created.", + }, + "end_time": { + Type: schema.TypeInt, + Optional: true, + Description: "Timestamp in milliseconds when the snapshot configuration ends.", + }, + "updated_by": { + Type: schema.TypeString, + Optional: true, + Description: "Account that updated the billing snapshot configuration.", + }, + "account_id": { + Type: schema.TypeString, + Optional: true, + Description: "Account ID for which billing report snapshot is configured.", + }, + "state": { + Type: schema.TypeString, + Optional: true, + Description: "Status of the billing snapshot configuration. Possible values are [enabled, disabled].", + }, + "account_type": { + Type: schema.TypeString, + Optional: true, + Description: "Type of account. Possible values [enterprise, account].", + }, + "interval": { + Type: schema.TypeString, + Optional: true, + Description: "Frequency of taking the snapshot of the billing reports.", + }, + "versioning": { + Type: schema.TypeString, + Optional: true, + Default: "new", + Description: "A new version of report is created or the existing report version is overwritten with every update.", + }, + "report_types": { + Type: schema.TypeList, + Optional: true, + Description: "The type of billing reports to take snapshot of. Possible values are [account_summary, enterprise_summary, account_resource_instance_usage].", + Elem: &schema.Schema{Type: schema.TypeString}, + }, + "compression": { + Type: schema.TypeString, + Optional: true, + Description: "Compression format of the snapshot report.", + }, + "content_type": { + Type: schema.TypeString, + Optional: true, + Description: "Type of content stored in snapshot report.", + }, + "cos_reports_folder": { + Type: schema.TypeString, + Optional: true, + Default: "IBMCloud-Billing-Reports", + Description: "The billing reports root folder to store the billing reports snapshots. Defaults to \"IBMCloud-Billing-Reports\".", + }, + "cos_bucket": { + Type: schema.TypeString, + Optional: true, + Description: "The name of the COS bucket to store the snapshot of the billing reports.", + }, + "cos_location": { + Type: schema.TypeString, + Optional: true, + Description: "Region of the COS instance.", + }, + "cos_endpoint": { + Type: schema.TypeString, + Optional: true, + Description: "The endpoint of the COS instance.", + }, + }, + }, + }, + }, + } +} + +func ResourceIBMBillingReportSnapshotValidator() *validate.ResourceValidator { + validateSchema := make([]validate.ValidateSchema, 0) + validateSchema = append(validateSchema, + validate.ValidateSchema{ + Identifier: "interval", + ValidateFunctionIdentifier: validate.ValidateAllowedStringValue, + Type: validate.TypeString, + Required: true, + AllowedValues: "daily", + }, + validate.ValidateSchema{ + Identifier: "versioning", + ValidateFunctionIdentifier: validate.ValidateAllowedStringValue, + Type: validate.TypeString, + Optional: true, + AllowedValues: "new, overwrite", + }, + ) + + resourceValidator := validate.ResourceValidator{ResourceName: "ibm_billing_report_snapshot", Schema: validateSchema} + return &resourceValidator +} + +func resourceIBMBillingReportSnapshotCreate(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { + usageReportsClient, err := meta.(conns.ClientSession).UsageReportsV4() + if err != nil { + return diag.FromErr(err) + } + + createReportsSnapshotConfigOptions := &usagereportsv4.CreateReportsSnapshotConfigOptions{} + + userDetails, err := meta.(conns.ClientSession).BluemixUserDetails() + if err != nil { + return diag.FromErr(err) + } + + createReportsSnapshotConfigOptions.SetAccountID(userDetails.UserAccount) + createReportsSnapshotConfigOptions.SetInterval(d.Get("interval").(string)) + createReportsSnapshotConfigOptions.SetCosBucket(d.Get("cos_bucket").(string)) + createReportsSnapshotConfigOptions.SetCosLocation(d.Get("cos_location").(string)) + if _, ok := d.GetOk("cos_reports_folder"); ok { + createReportsSnapshotConfigOptions.SetCosReportsFolder(d.Get("cos_reports_folder").(string)) + } + if _, ok := d.GetOk("report_types"); ok { + var reportTypes []string + for _, v := range d.Get("report_types").([]interface{}) { + reportTypesItem := v.(string) + reportTypes = append(reportTypes, reportTypesItem) + } + createReportsSnapshotConfigOptions.SetReportTypes(reportTypes) + } + if _, ok := d.GetOk("versioning"); ok { + createReportsSnapshotConfigOptions.SetVersioning(d.Get("versioning").(string)) + } + + snapshotConfig, response, err := usageReportsClient.CreateReportsSnapshotConfigWithContext(context, createReportsSnapshotConfigOptions) + if err != nil { + log.Printf("[DEBUG] CreateReportsSnapshotConfigWithContext failed %s\n%s", err, response) + return diag.FromErr(fmt.Errorf("CreateReportsSnapshotConfigWithContext failed %s\n%s", err, response)) + } + + d.SetId(*snapshotConfig.AccountID) + + return resourceIBMBillingReportSnapshotRead(context, d, meta) +} + +func resourceIBMBillingReportSnapshotRead(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { + usageReportsClient, err := meta.(conns.ClientSession).UsageReportsV4() + if err != nil { + return diag.FromErr(err) + } + + getReportsSnapshotConfigOptions := &usagereportsv4.GetReportsSnapshotConfigOptions{} + + getReportsSnapshotConfigOptions.SetAccountID(d.Id()) + + snapshotConfig, response, err := usageReportsClient.GetReportsSnapshotConfigWithContext(context, getReportsSnapshotConfigOptions) + if err != nil { + if response != nil && response.StatusCode == 404 { + d.SetId("") + return nil + } + log.Printf("[DEBUG] GetReportsSnapshotConfigWithContext failed %s\n%s", err, response) + return diag.FromErr(fmt.Errorf("GetReportsSnapshotConfigWithContext failed %s\n%s", err, response)) + } + + if err = d.Set("interval", snapshotConfig.Interval); err != nil { + return diag.FromErr(fmt.Errorf("Error setting interval: %s", err)) + } + if !core.IsNil(snapshotConfig.Versioning) { + if err = d.Set("versioning", snapshotConfig.Versioning); err != nil { + return diag.FromErr(fmt.Errorf("Error setting versioning: %s", err)) + } + } + if !core.IsNil(snapshotConfig.ReportTypes) { + if err = d.Set("report_types", snapshotConfig.ReportTypes); err != nil { + return diag.FromErr(fmt.Errorf("Error setting report_types: %s", err)) + } + } + if !core.IsNil(snapshotConfig.CosReportsFolder) { + if err = d.Set("cos_reports_folder", snapshotConfig.CosReportsFolder); err != nil { + return diag.FromErr(fmt.Errorf("Error setting cos_reports_folder: %s", err)) + } + } + if err = d.Set("cos_bucket", snapshotConfig.CosBucket); err != nil { + return diag.FromErr(fmt.Errorf("Error setting cos_bucket: %s", err)) + } + if err = d.Set("cos_location", snapshotConfig.CosLocation); err != nil { + return diag.FromErr(fmt.Errorf("Error setting cos_location: %s", err)) + } + if !core.IsNil(snapshotConfig.State) { + if err = d.Set("state", snapshotConfig.State); err != nil { + return diag.FromErr(fmt.Errorf("Error setting state: %s", err)) + } + } + if !core.IsNil(snapshotConfig.AccountType) { + if err = d.Set("account_type", snapshotConfig.AccountType); err != nil { + return diag.FromErr(fmt.Errorf("Error setting account_type: %s", err)) + } + } + if !core.IsNil(snapshotConfig.Compression) { + if err = d.Set("compression", snapshotConfig.Compression); err != nil { + return diag.FromErr(fmt.Errorf("Error setting compression: %s", err)) + } + } + if !core.IsNil(snapshotConfig.ContentType) { + if err = d.Set("content_type", snapshotConfig.ContentType); err != nil { + return diag.FromErr(fmt.Errorf("Error setting content_type: %s", err)) + } + } + if !core.IsNil(snapshotConfig.CosEndpoint) { + if err = d.Set("cos_endpoint", snapshotConfig.CosEndpoint); err != nil { + return diag.FromErr(fmt.Errorf("Error setting cos_endpoint: %s", err)) + } + } + if !core.IsNil(snapshotConfig.CreatedAt) { + if err = d.Set("created_at", flex.IntValue(snapshotConfig.CreatedAt)); err != nil { + return diag.FromErr(fmt.Errorf("Error setting created_at: %s", err)) + } + } + if !core.IsNil(snapshotConfig.LastUpdatedAt) { + if err = d.Set("last_updated_at", flex.IntValue(snapshotConfig.LastUpdatedAt)); err != nil { + return diag.FromErr(fmt.Errorf("Error setting last_updated_at: %s", err)) + } + } + if !core.IsNil(snapshotConfig.History) { + history := []map[string]interface{}{} + for _, historyItem := range snapshotConfig.History { + historyItemMap, err := resourceIBMBillingReportSnapshotSnapshotConfigHistoryItemToMap(&historyItem) + if err != nil { + return diag.FromErr(err) + } + history = append(history, historyItemMap) + } + if err = d.Set("history", history); err != nil { + return diag.FromErr(fmt.Errorf("Error setting history: %s", err)) + } + } + + return nil +} + +func resourceIBMBillingReportSnapshotUpdate(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { + usageReportsClient, err := meta.(conns.ClientSession).UsageReportsV4() + if err != nil { + return diag.FromErr(err) + } + + updateReportsSnapshotConfigOptions := &usagereportsv4.UpdateReportsSnapshotConfigOptions{} + + updateReportsSnapshotConfigOptions.SetAccountID(d.Id()) + + hasChange := false + + if d.HasChange("interval") { + updateReportsSnapshotConfigOptions.SetInterval(d.Get("interval").(string)) + hasChange = true + } + if d.HasChange("cos_bucket") { + updateReportsSnapshotConfigOptions.SetCosBucket(d.Get("cos_bucket").(string)) + hasChange = true + } + if d.HasChange("cos_location") { + updateReportsSnapshotConfigOptions.SetCosLocation(d.Get("cos_location").(string)) + hasChange = true + } + if d.HasChange("cos_reports_folder") { + updateReportsSnapshotConfigOptions.SetCosReportsFolder(d.Get("cos_reports_folder").(string)) + hasChange = true + } + if d.HasChange("report_types") { + var reportTypes []string + for _, v := range d.Get("report_types").([]interface{}) { + reportTypesItem := v.(string) + reportTypes = append(reportTypes, reportTypesItem) + } + updateReportsSnapshotConfigOptions.SetReportTypes(reportTypes) + hasChange = true + } + if d.HasChange("versioning") { + updateReportsSnapshotConfigOptions.SetVersioning(d.Get("versioning").(string)) + hasChange = true + } + + if hasChange { + _, response, err := usageReportsClient.UpdateReportsSnapshotConfigWithContext(context, updateReportsSnapshotConfigOptions) + if err != nil { + log.Printf("[DEBUG] UpdateReportsSnapshotConfigWithContext failed %s\n%s", err, response) + return diag.FromErr(fmt.Errorf("UpdateReportsSnapshotConfigWithContext failed %s\n%s", err, response)) + } + } + + return resourceIBMBillingReportSnapshotRead(context, d, meta) +} + +func resourceIBMBillingReportSnapshotDelete(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { + usageReportsClient, err := meta.(conns.ClientSession).UsageReportsV4() + if err != nil { + return diag.FromErr(err) + } + + deleteReportsSnapshotConfigOptions := &usagereportsv4.DeleteReportsSnapshotConfigOptions{} + + deleteReportsSnapshotConfigOptions.SetAccountID(d.Id()) + + response, err := usageReportsClient.DeleteReportsSnapshotConfigWithContext(context, deleteReportsSnapshotConfigOptions) + if err != nil { + log.Printf("[DEBUG] DeleteReportsSnapshotConfigWithContext failed %s\n%s", err, response) + return diag.FromErr(fmt.Errorf("DeleteReportsSnapshotConfigWithContext failed %s\n%s", err, response)) + } + + d.SetId("") + + return nil +} + +func resourceIBMBillingReportSnapshotSnapshotConfigHistoryItemToMap(model *usagereportsv4.SnapshotConfigHistoryItem) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + if model.StartTime != nil { + modelMap["start_time"] = flex.IntValue(model.StartTime) + } + if model.EndTime != nil { + modelMap["end_time"] = flex.IntValue(model.EndTime) + } + if model.UpdatedBy != nil { + modelMap["updated_by"] = model.UpdatedBy + } + if model.AccountID != nil { + modelMap["account_id"] = model.AccountID + } + if model.State != nil { + modelMap["state"] = model.State + } + if model.AccountType != nil { + modelMap["account_type"] = model.AccountType + } + if model.Interval != nil { + modelMap["interval"] = model.Interval + } + if model.Versioning != nil { + modelMap["versioning"] = model.Versioning + } + if model.ReportTypes != nil { + modelMap["report_types"] = model.ReportTypes + } + if model.Compression != nil { + modelMap["compression"] = model.Compression + } + if model.ContentType != nil { + modelMap["content_type"] = model.ContentType + } + if model.CosReportsFolder != nil { + modelMap["cos_reports_folder"] = model.CosReportsFolder + } + if model.CosBucket != nil { + modelMap["cos_bucket"] = model.CosBucket + } + if model.CosLocation != nil { + modelMap["cos_location"] = model.CosLocation + } + if model.CosEndpoint != nil { + modelMap["cos_endpoint"] = model.CosEndpoint + } + return modelMap, nil +} diff --git a/ibm/service/usagereports/resource_ibm_billing_report_snapshot_test.go b/ibm/service/usagereports/resource_ibm_billing_report_snapshot_test.go new file mode 100644 index 0000000000..008725309b --- /dev/null +++ b/ibm/service/usagereports/resource_ibm_billing_report_snapshot_test.go @@ -0,0 +1,116 @@ +// Copyright IBM Corp. 2023 All Rights Reserved. +// Licensed under the Mozilla Public License v2.0 + +package usagereports_test + +import ( + "fmt" + "testing" + + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource" + "github.com/hashicorp/terraform-plugin-sdk/v2/terraform" + + acc "github.com/IBM-Cloud/terraform-provider-ibm/ibm/acctest" + "github.com/IBM-Cloud/terraform-provider-ibm/ibm/conns" + "github.com/IBM/platform-services-go-sdk/usagereportsv4" +) + +func TestAccIBMBillingReportSnapshotBasic(t *testing.T) { + var conf usagereportsv4.SnapshotConfig + interval := "daily" + cosBucket := acc.Cos_bucket + cosLocation := acc.Cos_location + intervalUpdate := "daily" + cosBucketUpdate := acc.Cos_bucket_update + cosLocationUpdate := acc.Cos_location_update + + resource.Test(t, resource.TestCase{ + PreCheck: func() { acc.TestAccPreCheckUsage(t) }, + Providers: acc.TestAccProviders, + CheckDestroy: testAccCheckIBMBillingReportSnapshotDestroy, + Steps: []resource.TestStep{ + { + Config: testAccCheckIBMBillingReportSnapshotConfigBasic(interval, cosBucket, cosLocation), + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckIBMBillingReportSnapshotExists("ibm_billing_report_snapshot.billing_report_snapshot_instance_1", conf), + resource.TestCheckResourceAttr("ibm_billing_report_snapshot.billing_report_snapshot_instance_1", "interval", interval), + resource.TestCheckResourceAttr("ibm_billing_report_snapshot.billing_report_snapshot_instance_1", "cos_bucket", cosBucket), + resource.TestCheckResourceAttr("ibm_billing_report_snapshot.billing_report_snapshot_instance_1", "cos_location", cosLocation), + ), + }, + { + Config: testAccCheckIBMBillingReportSnapshotConfigBasic(intervalUpdate, cosBucketUpdate, cosLocationUpdate), + Check: resource.ComposeAggregateTestCheckFunc( + resource.TestCheckResourceAttr("ibm_billing_report_snapshot.billing_report_snapshot_instance_1", "interval", intervalUpdate), + resource.TestCheckResourceAttr("ibm_billing_report_snapshot.billing_report_snapshot_instance_1", "cos_bucket", cosBucketUpdate), + resource.TestCheckResourceAttr("ibm_billing_report_snapshot.billing_report_snapshot_instance_1", "cos_location", cosLocationUpdate), + ), + }, + }, + }) +} + +func testAccCheckIBMBillingReportSnapshotConfigBasic(interval string, cosBucket string, cosLocation string) string { + return fmt.Sprintf(` + resource "ibm_billing_report_snapshot" "billing_report_snapshot_instance_1" { + interval = "%s" + cos_bucket = "%s" + cos_location = "%s" + report_types = ["account_summary", "account_resource_instance_usage"] + } + `, interval, cosBucket, cosLocation) +} + +func testAccCheckIBMBillingReportSnapshotExists(n string, obj usagereportsv4.SnapshotConfig) resource.TestCheckFunc { + + return func(s *terraform.State) error { + rs, ok := s.RootModule().Resources[n] + if !ok { + return fmt.Errorf("Not found: %s", n) + } + + usageReportsClient, err := acc.TestAccProvider.Meta().(conns.ClientSession).UsageReportsV4() + if err != nil { + return err + } + + getReportsSnapshotConfigOptions := &usagereportsv4.GetReportsSnapshotConfigOptions{} + + getReportsSnapshotConfigOptions.SetAccountID(rs.Primary.ID) + + snapshotConfig, _, err := usageReportsClient.GetReportsSnapshotConfig(getReportsSnapshotConfigOptions) + if err != nil { + return err + } + + obj = *snapshotConfig + return nil + } +} + +func testAccCheckIBMBillingReportSnapshotDestroy(s *terraform.State) error { + usageReportsClient, err := acc.TestAccProvider.Meta().(conns.ClientSession).UsageReportsV4() + if err != nil { + return err + } + for _, rs := range s.RootModule().Resources { + if rs.Type != "ibm_billing_report_snapshot" { + continue + } + + getReportsSnapshotConfigOptions := &usagereportsv4.GetReportsSnapshotConfigOptions{} + + getReportsSnapshotConfigOptions.SetAccountID(rs.Primary.ID) + + // Try to find the key + res, response, err := usageReportsClient.GetReportsSnapshotConfig(getReportsSnapshotConfigOptions) + + if !(response.StatusCode == 200 && *res.State == "disabled") { + return fmt.Errorf("billing_report_snapshot still exists: %s", rs.Primary.ID) + } else if err != nil { + return fmt.Errorf("Error checking for billing_report_snapshot (%s) has been destroyed: %s", rs.Primary.ID, err) + } + } + + return nil +} diff --git a/ibm/service/vpc/data_source_ibm_is_instance_template.go b/ibm/service/vpc/data_source_ibm_is_instance_template.go index e725cab0ba..7a683ccfc2 100644 --- a/ibm/service/vpc/data_source_ibm_is_instance_template.go +++ b/ibm/service/vpc/data_source_ibm_is_instance_template.go @@ -508,7 +508,6 @@ func dataSourceIBMISInstanceTemplateRead(context context.Context, d *schema.Reso } if instance.PrimaryNetworkInterface != nil { - log.Printf("[INFO] UJJK PNI") interfaceList := make([]map[string]interface{}, 0) currentPrimNic := map[string]interface{}{} currentPrimNic[isInstanceTemplateNicName] = *instance.PrimaryNetworkInterface.Name @@ -519,7 +518,7 @@ func dataSourceIBMISInstanceTemplateRead(context context.Context, d *schema.Reso switch reflect.TypeOf(primaryipIntf).String() { case "*vpcv1.NetworkInterfaceIPPrototype": { - log.Printf("[INFO] UJJK NetworkInterfaceIPPrototype") + log.Printf("[INFO] NetworkInterfaceIPPrototype") primaryip := primaryipIntf.(*vpcv1.NetworkInterfaceIPPrototype) if primaryip.Address != nil { currentPrimNic[isInstanceTemplateNicPrimaryIpv4Address] = *primaryip.Address @@ -531,7 +530,7 @@ func dataSourceIBMISInstanceTemplateRead(context context.Context, d *schema.Reso } case "*vpcv1.NetworkInterfaceIPPrototypeReservedIPPrototypeNetworkInterfaceContext": { - log.Printf("[INFO] UJJK NetworkInterfaceIPPrototypeReservedIPPrototypeNetworkInterfaceContext") + log.Printf("[INFO] NetworkInterfaceIPPrototypeReservedIPPrototypeNetworkInterfaceContext") primaryip := primaryipIntf.(*vpcv1.NetworkInterfaceIPPrototypeReservedIPPrototypeNetworkInterfaceContext) if primaryip.Address != nil { currentPrimNic[isInstanceTemplateNicPrimaryIpv4Address] = *primaryip.Address @@ -540,7 +539,7 @@ func dataSourceIBMISInstanceTemplateRead(context context.Context, d *schema.Reso } case "*vpcv1.NetworkInterfaceIPPrototypeReservedIPIdentity": { - log.Printf("[INFO] UJJK NetworkInterfaceIPPrototypeReservedIPIdentity") + log.Printf("[INFO] NetworkInterfaceIPPrototypeReservedIPIdentity") primaryip := primaryipIntf.(*vpcv1.NetworkInterfaceIPPrototypeReservedIPIdentity) if primaryip.ID != nil { currentPrimIp[isInstanceTemplateNicReservedIpId] = *primaryip.ID diff --git a/ibm/service/vpc/data_source_ibm_is_lb_profile.go b/ibm/service/vpc/data_source_ibm_is_lb_profile.go index 9d166645d3..a7151bbd99 100644 --- a/ibm/service/vpc/data_source_ibm_is_lb_profile.go +++ b/ibm/service/vpc/data_source_ibm_is_lb_profile.go @@ -76,10 +76,10 @@ func dataSourceIBMISLbProfileRead(context context.Context, d *schema.ResourceDat d.Set("name", *lbProfile.Name) d.Set("href", *lbProfile.Href) d.Set("family", *lbProfile.Family) - log.Printf("[INFO] UJJK lbprofile udp %v", lbProfile.UDPSupported) + log.Printf("[INFO] lbprofile udp %v", lbProfile.UDPSupported) if lbProfile.UDPSupported != nil { udpSupport := lbProfile.UDPSupported - log.Printf("[INFO] UJJK lbprofile udp %s", reflect.TypeOf(udpSupport).String()) + log.Printf("[INFO] lbprofile udp %s", reflect.TypeOf(udpSupport).String()) switch reflect.TypeOf(udpSupport).String() { case "*vpcv1.LoadBalancerProfileUDPSupportedFixed": diff --git a/ibm/service/vpc/data_source_ibm_is_virtual_endpoint_gateway.go b/ibm/service/vpc/data_source_ibm_is_virtual_endpoint_gateway.go index 8d9894f5fb..8d24c6dbc6 100644 --- a/ibm/service/vpc/data_source_ibm_is_virtual_endpoint_gateway.go +++ b/ibm/service/vpc/data_source_ibm_is_virtual_endpoint_gateway.go @@ -68,6 +68,11 @@ func DataSourceIBMISEndpointGateway() *schema.Resource { Set: schema.HashString, Description: "Endpoint gateway securitygroups list", }, + isVirtualEndpointGatewayAllowDnsResolutionBinding: { + Type: schema.TypeBool, + Computed: true, + Description: "Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true.", + }, isVirtualEndpointGatewayIPs: { Type: schema.TypeList, Computed: true, @@ -163,6 +168,7 @@ func dataSourceIBMISEndpointGatewayRead( result := allrecs[0] d.SetId(*result.ID) d.Set(isVirtualEndpointGatewayName, result.Name) + d.Set(isVirtualEndpointGatewayAllowDnsResolutionBinding, result.AllowDnsResolutionBinding) d.Set(isVirtualEndpointGatewayCRN, result.CRN) d.Set(isVirtualEndpointGatewayHealthState, result.HealthState) d.Set(isVirtualEndpointGatewayCreatedAt, result.CreatedAt.String()) diff --git a/ibm/service/vpc/data_source_ibm_is_virtual_endpoint_gateway_test.go b/ibm/service/vpc/data_source_ibm_is_virtual_endpoint_gateway_test.go index 3bf8afd2aa..2a37efe704 100644 --- a/ibm/service/vpc/data_source_ibm_is_virtual_endpoint_gateway_test.go +++ b/ibm/service/vpc/data_source_ibm_is_virtual_endpoint_gateway_test.go @@ -33,6 +33,29 @@ func TestAccIBMISVirtualEndpointGatewayDataSource_basic(t *testing.T) { }, }) } +func TestAccIBMISVirtualEndpointGatewayDataSource_AllowDnsResolutionBinding(t *testing.T) { + resName := "data.ibm_is_virtual_endpoint_gateway.data_test" + vpcname1 := fmt.Sprintf("tfvpngw-vpc-%d", acctest.RandIntRange(10, 100)) + enable_hub := false + allowbinding := true + name1 := fmt.Sprintf("tfvpngw-createname-%d", acctest.RandIntRange(10, 100)) + resource.Test(t, resource.TestCase{ + PreCheck: func() { acc.TestAccPreCheck(t) }, + Providers: acc.TestAccProviders, + CheckDestroy: testAccCheckisVirtualEndpointGatewayDestroy, + Steps: []resource.TestStep{ + { + Config: testAccCheckIBMISVirtualEndpointGatewayAllowDnsResolutionBindingDataSourceConfig(vpcname1, name1, enable_hub, allowbinding), + Check: resource.ComposeTestCheckFunc( + resource.TestCheckResourceAttr( + resName, "name", name1), + resource.TestCheckResourceAttr( + resName, "allow_dns_resolution_binding", fmt.Sprintf("%t", allowbinding)), + ), + }, + }, + }) +} func testAccCheckIBMISVirtualEndpointGatewayDataSourceConfig(vpcname1, subnetname1, name1 string) string { // status filter defaults to empty @@ -41,6 +64,13 @@ func testAccCheckIBMISVirtualEndpointGatewayDataSourceConfig(vpcname1, subnetnam name = ibm_is_virtual_endpoint_gateway.endpoint_gateway.name }`) } +func testAccCheckIBMISVirtualEndpointGatewayAllowDnsResolutionBindingDataSourceConfig(vpcname1, name1 string, enable_hub, allowbinding bool) string { + // status filter defaults to empty + return testAccCheckisVirtualEndpointGatewayConfigAllowDnsResolutionBinding(vpcname1, name1, enable_hub, allowbinding) + fmt.Sprintf(` + data "ibm_is_virtual_endpoint_gateway" "data_test" { + name = ibm_is_virtual_endpoint_gateway.endpoint_gateway.name + }`) +} // service endpoints func TestAccIBMISVirtualEndpointGatewayDataSource_service_endpoints(t *testing.T) { diff --git a/ibm/service/vpc/data_source_ibm_is_virtual_endpoint_gateways.go b/ibm/service/vpc/data_source_ibm_is_virtual_endpoint_gateways.go index 2f24c7a017..2d27412b0a 100644 --- a/ibm/service/vpc/data_source_ibm_is_virtual_endpoint_gateways.go +++ b/ibm/service/vpc/data_source_ibm_is_virtual_endpoint_gateways.go @@ -48,6 +48,11 @@ func DataSourceIBMISEndpointGateways() *schema.Resource { Computed: true, Description: "Endpoint gateway name", }, + isVirtualEndpointGatewayAllowDnsResolutionBinding: { + Type: schema.TypeBool, + Computed: true, + Description: "Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true.", + }, isVirtualEndpointGatewayResourceType: { Type: schema.TypeString, Computed: true, @@ -211,6 +216,7 @@ func dataSourceIBMISEndpointGatewaysRead(d *schema.ResourceData, meta interface{ endpointGatewayOutput[isVirtualEndpointGatewayResourceGroupID] = *endpointGateway.ResourceGroup.ID endpointGatewayOutput[isVirtualEndpointGatewayCRN] = *endpointGateway.CRN endpointGatewayOutput[isVirtualEndpointGatewayVpcID] = *endpointGateway.VPC.ID + endpointGatewayOutput[isVirtualEndpointGatewayAllowDnsResolutionBinding] = endpointGateway.AllowDnsResolutionBinding endpointGatewayOutput[isVirtualEndpointGatewayTarget] = flattenEndpointGatewayTarget(endpointGateway.Target.(*vpcv1.EndpointGatewayTarget)) if endpointGateway.SecurityGroups != nil { diff --git a/ibm/service/vpc/data_source_ibm_is_virtual_endpoint_gateways_test.go b/ibm/service/vpc/data_source_ibm_is_virtual_endpoint_gateways_test.go index 712401fdf0..6bf123de9d 100644 --- a/ibm/service/vpc/data_source_ibm_is_virtual_endpoint_gateways_test.go +++ b/ibm/service/vpc/data_source_ibm_is_virtual_endpoint_gateways_test.go @@ -33,6 +33,29 @@ func TestAccIBMISVirtualEndpointGatewaysDataSource_basic(t *testing.T) { }, }) } +func TestAccIBMISVirtualEndpointGatewaysDataSource_AllowDnsResolutionBinding(t *testing.T) { + // t.Skip() + resName := "data.ibm_is_virtual_endpoint_gateways.test1" + vpcname1 := fmt.Sprintf("tfvpngw-vpc-%d", acctest.RandIntRange(10, 100)) + name1 := fmt.Sprintf("tfvpngw-createname-%d", acctest.RandIntRange(10, 100)) + enable_hub := false + allowbinding := true + resource.Test(t, resource.TestCase{ + PreCheck: func() { acc.TestAccPreCheck(t) }, + Providers: acc.TestAccProviders, + Steps: []resource.TestStep{ + { + Config: testAccCheckIBMISVirtualEndpointGatewaysAllowDnsResolutionBindingDataSourceConfig(vpcname1, name1, enable_hub, allowbinding), + Check: resource.ComposeTestCheckFunc( + resource.TestCheckResourceAttrSet( + resName, "virtual_endpoint_gateways.0.name"), + resource.TestCheckResourceAttrSet( + resName, "virtual_endpoint_gateways.0.allow_dns_resolution_binding"), + ), + }, + }, + }) +} func testAccCheckIBMISVirtualEndpointGatewaysDataSourceConfig(vpcname1, subnetname1, name1 string) string { // status filter defaults to empty @@ -41,6 +64,13 @@ func testAccCheckIBMISVirtualEndpointGatewaysDataSourceConfig(vpcname1, subnetna depends_on = [ibm_is_virtual_endpoint_gateway.endpoint_gateway] }`) } +func testAccCheckIBMISVirtualEndpointGatewaysAllowDnsResolutionBindingDataSourceConfig(vpcname1, name1 string, enable_hub, allowbinding bool) string { + // status filter defaults to empty + return testAccCheckisVirtualEndpointGatewayConfigAllowDnsResolutionBinding(vpcname1, name1, enable_hub, allowbinding) + fmt.Sprintf(` + data "ibm_is_virtual_endpoint_gateways" "test1" { + depends_on = [ibm_is_virtual_endpoint_gateway.endpoint_gateway] + }`) +} // service endpoints diff --git a/ibm/service/vpc/data_source_ibm_is_vpc.go b/ibm/service/vpc/data_source_ibm_is_vpc.go index 66d014ca93..8122ec6f4a 100644 --- a/ibm/service/vpc/data_source_ibm_is_vpc.go +++ b/ibm/service/vpc/data_source_ibm_is_vpc.go @@ -10,6 +10,7 @@ import ( "github.com/IBM-Cloud/terraform-provider-ibm/ibm/flex" "github.com/IBM-Cloud/terraform-provider-ibm/ibm/validate" + "github.com/IBM/go-sdk-core/v5/core" "github.com/IBM/vpc-go-sdk/vpcv1" "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" ) @@ -163,6 +164,193 @@ func DataSourceIBMISVPC() *schema.Resource { }, }, + isVPCDns: &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "The DNS configuration for this VPC.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + isVPCDnsEnableHub: &schema.Schema{ + Type: schema.TypeBool, + Computed: true, + Description: "Indicates whether this VPC is enabled as a DNS name resolution hub.", + }, + isVPCDnsResolutionBindingCount: &schema.Schema{ + Type: schema.TypeInt, + Computed: true, + Description: "The number of DNS resolution bindings for this VPC.", + }, + isVPCDnsResolver: &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "The DNS resolver configuration for the VPC.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + isVPCDnsResolverServers: &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "The DNS servers for this VPC. The servers are populated:- by the system when `dns.resolver.type` is `system`- using the DNS servers in `dns.resolver.vpc` when `dns.resolver.type` is `delegated`- using `dns.resolver.manual_servers` when the `dns.resolver.type` is `manual`.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + isVPCDnsResolverManualServersAddress: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The IP address.This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.", + }, + isVPCDnsResolverManualServersZoneAffinity: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "Zone name, if present, DHCP configuration for this zone will have this DNS server listed first.", + }, + }, + }, + }, + isVPCDnsResolverType: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The type of the DNS resolver used for the VPC.- `delegated`: DNS server addresses are provided by the DNS resolver of the VPC specified in `dns.resolver.vpc`.- `manual`: DNS server addresses are specified in `dns.resolver.manual_servers`.- `system`: DNS server addresses are provided by the system.", + }, + isVPCDnsResolverVpc: &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "The VPC whose DNS resolver provides the DNS server addresses for this VPC.The VPC may be remote and therefore may not be directly retrievable.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + isVPCDnsResolverVpcCrn: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The CRN for this VPC.", + }, + isVPCDnsResolverVpcDeleted: &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + isVPCDnsResolverVpcDeletedMoreInfo: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "Link to documentation about deleted resources.", + }, + }, + }, + }, + isVPCDnsResolverVpcHref: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The URL for this VPC.", + }, + isVPCDnsResolverVpcId: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The unique identifier for this VPC.", + }, + isVPCDnsResolverVpcName: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The name for this VPC. The name is unique across all VPCs in the region.", + }, + isVPCDnsResolverVpcRemote: &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + isVPCDnsResolverVpcRemoteAccount: &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "If present, this property indicates that the referenced resource is remote to thisaccount, and identifies the owning account.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "id": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The unique identifier for this account.", + }, + isVPCDnsResolverResourceType: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The resource type.", + }, + }, + }, + }, + isVPCDnsResolverVpcRemoteRegion: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "Region name. If present, this property indicates that the referenced resource is remote to this region, and identifies the native region.", + }, + }, + }, + }, + isVPCDnsResolverResourceType: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The resource type.", + }, + }, + }, + }, + isVPCDnsResolverManualServers: &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "The manually specified DNS servers for this VPC.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + isVPCDnsResolverManualServersAddress: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The IP address.This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.", + }, + isVPCDnsResolverManualServersZoneAffinity: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The name of the zone. If present, DHCP configuration for this zone will have this DNS server listed first.", + }, + }, + }, + }, + isVPCDnsResolverConfiguration: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The configuration of the system DNS resolver for this VPC.- `custom_resolver`: A custom DNS resolver is configured for this VPC.- `private_resolver`: A private DNS resolver is configured for this VPC. Applicable when the VPC has either or both of the following: - at least one endpoint gateway residing in it - a [DNS Services](https://cloud.ibm.com/docs/dns-svcs) private zone configured for it- `default`: The provider default DNS resolvers are configured for this VPC. This system DNS resolver configuration is used when the VPC has: - no custom DNS resolver configured for it, and - no endpoint gateways residing in it, and - no [DNS Services](https://cloud.ibm.com/docs/dns-svcs) private zone configured for it.", + }, + }, + }, + }, + }, + }, + }, + + "health_reasons": &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "The reasons for the current `health_state` (if any).The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "code": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "A snake case string succinctly identifying the reason for this health state.", + }, + "message": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "An explanation of the reason for this health state.", + }, + "more_info": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "Link to documentation about the reason for this health state.", + }, + }, + }, + }, + "health_state": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The health of this resource.- `ok`: No abnormal behavior detected- `degraded`: Experiencing compromised performance, capacity, or connectivity- `faulted`: Completely unreachable, inoperative, or otherwise entirely incapacitated- `inapplicable`: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of `failed` or `deleting` will have a health state of `inapplicable`. A `pending` resource may also have this state.", + }, isVPCSecurityGroupList: { Type: schema.TypeList, Computed: true, @@ -407,6 +595,24 @@ func setVpcDetails(d *schema.ResourceData, vpc *vpcv1.VPC, meta interface{}, ses d.Set(isVPCAccessTags, accesstags) d.Set(isVPCCRN, *vpc.CRN) + healthReasons := []map[string]interface{}{} + if vpc.HealthReasons != nil { + for _, modelItem := range vpc.HealthReasons { + modelMap, err := dataSourceIBMIsVPCVPCHealthReasonToMap(&modelItem) + if err != nil { + return err + } + healthReasons = append(healthReasons, modelMap) + } + } + if err = d.Set("health_reasons", healthReasons); err != nil { + return fmt.Errorf("[ERROR] Error setting health_reasons %s", err) + } + + if err = d.Set("health_state", vpc.HealthState); err != nil { + return fmt.Errorf("[ERROR] Error setting health_state: %s", err) + } + controller, err := flex.GetBaseController(meta) if err != nil { return err @@ -602,10 +808,211 @@ func setVpcDetails(d *schema.ResourceData, vpc *vpcv1.VPC, meta interface{}, ses g[isVPCSgRules] = rules securityGroupList = append(securityGroupList, g) } - d.Set(isVPCSecurityGroupList, securityGroupList) - + if !core.IsNil(vpc.Dns) { + dnsMap, err := dataSourceIBMIsVPCVpcdnsToMap(vpc.Dns) + if err != nil { + return err + } + if err = d.Set(isVPCDns, []map[string]interface{}{dnsMap}); err != nil { + return fmt.Errorf("[ERROR] Error setting dns: %s", err) + } + } return nil } return nil } + +func dataSourceIBMIsVPCVpcdnsToMap(model *vpcv1.Vpcdns) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + modelMap["enable_hub"] = model.EnableHub + modelMap["resolution_binding_count"] = flex.IntValue(model.ResolutionBindingCount) + resolverMap, err := dataSourceIBMIsVPCVpcdnsResolverToMap(model.Resolver) + if err != nil { + return modelMap, err + } + modelMap["resolver"] = []map[string]interface{}{resolverMap} + return modelMap, nil +} + +func dataSourceIBMIsVPCVpcdnsResolverToMap(model vpcv1.VpcdnsResolverIntf) (map[string]interface{}, error) { + if _, ok := model.(*vpcv1.VpcdnsResolverTypeDelegated); ok { + return dataSourceIBMIsVPCVpcdnsResolverTypeDelegatedToMap(model.(*vpcv1.VpcdnsResolverTypeDelegated)) + } else if _, ok := model.(*vpcv1.VpcdnsResolverTypeManual); ok { + return dataSourceIBMIsVPCVpcdnsResolverTypeManualToMap(model.(*vpcv1.VpcdnsResolverTypeManual)) + } else if _, ok := model.(*vpcv1.VpcdnsResolverTypeSystem); ok { + return dataSourceIBMIsVPCVpcdnsResolverTypeSystemToMap(model.(*vpcv1.VpcdnsResolverTypeSystem)) + } else if _, ok := model.(*vpcv1.VpcdnsResolver); ok { + modelMap := make(map[string]interface{}) + model := model.(*vpcv1.VpcdnsResolver) + servers := []map[string]interface{}{} + for _, serversItem := range model.Servers { + serversItemMap, err := resourceIBMIsVPCDnsServerToMap(&serversItem) + if err != nil { + return modelMap, err + } + servers = append(servers, serversItemMap) + } + modelMap["servers"] = servers + modelMap["type"] = model.Type + if model.VPC != nil { + vpcMap, err := dataSourceIBMIsVPCVPCReferenceDnsResolverContextToMap(model.VPC) + if err != nil { + return modelMap, err + } + modelMap["vpc"] = []map[string]interface{}{vpcMap} + } + + if model.ManualServers != nil { + manualServers := []map[string]interface{}{} + for _, manualServersItem := range model.ManualServers { + manualServersItemMap, err := resourceIBMIsVPCDnsServerToMap(&manualServersItem) + if err != nil { + return modelMap, err + } + manualServers = append(manualServers, manualServersItemMap) + } + modelMap["manual_servers"] = manualServers + } + if model.Configuration != nil { + modelMap["configuration"] = model.Configuration + } + return modelMap, nil + } else { + return nil, fmt.Errorf("Unrecognized vpcv1.VpcdnsResolverIntf subtype encountered") + } +} + +func dataSourceIBMIsVPCVpcdnsResolverTypeManualToMap(model *vpcv1.VpcdnsResolverTypeManual) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + servers := []map[string]interface{}{} + for _, serversItem := range model.Servers { + serversItemMap, err := resourceIBMIsVPCDnsServerToMap(&serversItem) + if err != nil { + return modelMap, err + } + servers = append(servers, serversItemMap) + } + modelMap["servers"] = servers + manualServers := []map[string]interface{}{} + for _, manualServersItem := range model.ManualServers { + manualServersItemMap, err := resourceIBMIsVPCDnsServerToMap(&manualServersItem) + if err != nil { + return modelMap, err + } + manualServers = append(manualServers, manualServersItemMap) + } + modelMap["manual_servers"] = manualServers + modelMap["type"] = model.Type + return modelMap, nil +} + +func dataSourceIBMIsVPCVpcdnsResolverTypeDelegatedToMap(model *vpcv1.VpcdnsResolverTypeDelegated) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + servers := []map[string]interface{}{} + for _, serversItem := range model.Servers { + serversItemMap, err := resourceIBMIsVPCDnsServerToMap(&serversItem) + if err != nil { + return modelMap, err + } + servers = append(servers, serversItemMap) + } + modelMap["servers"] = servers + modelMap["type"] = model.Type + if model.VPC != nil { + vpcMap, err := dataSourceIBMIsVPCVPCReferenceDnsResolverContextToMap(model.VPC) + if err != nil { + return modelMap, err + } + modelMap["vpc"] = []map[string]interface{}{vpcMap} + } + return modelMap, nil +} +func dataSourceIBMIsVPCVPCHealthReasonToMap(model *vpcv1.VPCHealthReason) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + modelMap["code"] = model.Code + modelMap["message"] = model.Message + if model.MoreInfo != nil { + modelMap["more_info"] = model.MoreInfo + } + return modelMap, nil +} + +func dataSourceIBMIsVPCVpcdnsResolverTypeSystemToMap(model *vpcv1.VpcdnsResolverTypeSystem) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + servers := []map[string]interface{}{} + for _, serversItem := range model.Servers { + serversItemMap, err := resourceIBMIsVPCDnsServerToMap(&serversItem) + if err != nil { + return modelMap, err + } + servers = append(servers, serversItemMap) + } + modelMap["servers"] = servers + modelMap["configuration"] = model.Configuration + modelMap["type"] = model.Type + return modelMap, nil +} + +func dataSourceIBMIsVPCVPCReferenceDnsResolverContextToMap(model *vpcv1.VPCReferenceDnsResolverContext) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + modelMap["crn"] = model.CRN + if model.Deleted != nil { + deletedMap, err := dataSourceIBMIsVPCVPCReferenceDnsResolverContextDeletedToMap(model.Deleted) + if err != nil { + return modelMap, err + } + modelMap["deleted"] = []map[string]interface{}{deletedMap} + } + modelMap["href"] = model.Href + modelMap["id"] = model.ID + modelMap["name"] = model.Name + if model.Remote != nil { + remoteMap, err := dataSourceIBMIsVPCVPCRemoteToMap(model.Remote) + if err != nil { + return modelMap, err + } + modelMap["remote"] = []map[string]interface{}{remoteMap} + } + modelMap["resource_type"] = model.ResourceType + return modelMap, nil +} + +func dataSourceIBMIsVPCVPCReferenceDnsResolverContextDeletedToMap(model *vpcv1.VPCReferenceDnsResolverContextDeleted) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + modelMap["more_info"] = model.MoreInfo + return modelMap, nil +} + +func dataSourceIBMIsVPCVPCRemoteToMap(model *vpcv1.VPCRemote) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + if model.Account != nil { + accountMap, err := dataSourceIBMIsVPCAccountReferenceToMap(model.Account) + if err != nil { + return modelMap, err + } + modelMap["account"] = []map[string]interface{}{accountMap} + } + if model.Region != nil { + regionMap, err := dataSourceIBMIsVPCRegionReferenceToMap(model.Region) + if err != nil { + return modelMap, err + } + modelMap["region"] = []map[string]interface{}{regionMap} + } + return modelMap, nil +} + +func dataSourceIBMIsVPCAccountReferenceToMap(model *vpcv1.AccountReference) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + modelMap["id"] = model.ID + modelMap["resource_type"] = model.ResourceType + return modelMap, nil +} + +func dataSourceIBMIsVPCRegionReferenceToMap(model *vpcv1.RegionReference) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + modelMap["href"] = model.Href + modelMap["name"] = model.Name + return modelMap, nil +} diff --git a/ibm/service/vpc/data_source_ibm_is_vpc_dns_resolution_binding.go b/ibm/service/vpc/data_source_ibm_is_vpc_dns_resolution_binding.go new file mode 100644 index 0000000000..abd955fd57 --- /dev/null +++ b/ibm/service/vpc/data_source_ibm_is_vpc_dns_resolution_binding.go @@ -0,0 +1,376 @@ +// Copyright IBM Corp. 2023 All Rights Reserved. +// Licensed under the Mozilla Public License v2.0 + +package vpc + +import ( + "context" + "fmt" + "log" + + "github.com/hashicorp/terraform-plugin-sdk/v2/diag" + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" + + "github.com/IBM-Cloud/terraform-provider-ibm/ibm/flex" + "github.com/IBM/vpc-go-sdk/vpcv1" +) + +func DataSourceIBMIsVPCDnsResolutionBinding() *schema.Resource { + return &schema.Resource{ + ReadContext: dataSourceIBMIsVPCDnsResolutionBindingRead, + + Schema: map[string]*schema.Schema{ + "vpc_id": &schema.Schema{ + Type: schema.TypeString, + Required: true, + Description: "The VPC identifier.", + }, + "identifier": &schema.Schema{ + Type: schema.TypeString, + Required: true, + Description: "The DNS resolution binding identifier.", + }, + "created_at": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The date and time that the DNS resolution binding was created.", + }, + "endpoint_gateways": &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "The endpoint gateways in the bound to VPC that are allowed to participate in this DNS resolution binding.The endpoint gateways may be remote and therefore may not be directly retrievable.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "crn": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The CRN for this endpoint gateway.", + }, + "href": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The URL for this endpoint gateway.", + }, + "id": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The unique identifier for this endpoint gateway.", + }, + "name": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The name for this endpoint gateway. The name is unique across all endpoint gateways in the VPC.", + }, + "remote": &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "account": &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "If present, this property indicates that the referenced resource is remote to thisaccount, and identifies the owning account.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "id": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The unique identifier for this account.", + }, + "resource_type": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The resource type.", + }, + }, + }, + }, + "region": &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "href": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The URL for this region.", + }, + "name": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The globally unique name for this region.", + }, + }, + }, + }, + }, + }, + }, + "resource_type": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The resource type.", + }, + }, + }, + }, + "href": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The URL for this DNS resolution binding.", + }, + "lifecycle_state": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The lifecycle state of the DNS resolution binding.", + }, + "name": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The name for this DNS resolution binding. The name is unique across all DNS resolution bindings for the VPC.", + }, + "resource_type": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The resource type.", + }, + "vpc": &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "The VPC bound to for DNS resolution.The VPC may be remote and therefore may not be directly retrievable.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "crn": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The CRN for this VPC.", + }, + "href": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The URL for this VPC.", + }, + "id": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The unique identifier for this VPC.", + }, + "name": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The name for this VPC. The name is unique across all VPCs in the region.", + }, + "remote": &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "account": &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "If present, this property indicates that the referenced resource is remote to thisaccount, and identifies the owning account.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "id": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The unique identifier for this account.", + }, + "resource_type": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The resource type.", + }, + }, + }, + }, + "region": &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "href": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The URL for this region.", + }, + "name": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The globally unique name for this region.", + }, + }, + }, + }, + }, + }, + }, + "resource_type": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The resource type.", + }, + }, + }, + }, + }, + } +} + +func dataSourceIBMIsVPCDnsResolutionBindingRead(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { + sess, err := vpcClient(meta) + if err != nil { + return diag.FromErr(err) + } + + getVPCDnsResolutionBindingOptions := &vpcv1.GetVPCDnsResolutionBindingOptions{} + + getVPCDnsResolutionBindingOptions.SetVPCID(d.Get("vpc_id").(string)) + getVPCDnsResolutionBindingOptions.SetID(d.Get("identifier").(string)) + + vpcdnsResolutionBinding, response, err := sess.GetVPCDnsResolutionBindingWithContext(context, getVPCDnsResolutionBindingOptions) + if err != nil { + log.Printf("[DEBUG] GetVPCDnsResolutionBindingWithContext failed %s\n%s", err, response) + return diag.FromErr(fmt.Errorf("GetVPCDnsResolutionBindingWithContext failed %s\n%s", err, response)) + } + + d.SetId(*vpcdnsResolutionBinding.ID) + + if err = d.Set("created_at", flex.DateTimeToString(vpcdnsResolutionBinding.CreatedAt)); err != nil { + return diag.FromErr(fmt.Errorf("Error setting created_at: %s", err)) + } + + endpointGateways := []map[string]interface{}{} + if vpcdnsResolutionBinding.EndpointGateways != nil { + for _, modelItem := range vpcdnsResolutionBinding.EndpointGateways { + modelMap, err := dataSourceIBMIsVPCDnsResolutionBindingEndpointGatewayReferenceRemoteToMap(&modelItem) + if err != nil { + return diag.FromErr(err) + } + endpointGateways = append(endpointGateways, modelMap) + } + } + if err = d.Set("endpoint_gateways", endpointGateways); err != nil { + return diag.FromErr(fmt.Errorf("Error setting endpoint_gateways %s", err)) + } + + if err = d.Set("href", vpcdnsResolutionBinding.Href); err != nil { + return diag.FromErr(fmt.Errorf("Error setting href: %s", err)) + } + + if err = d.Set("lifecycle_state", vpcdnsResolutionBinding.LifecycleState); err != nil { + return diag.FromErr(fmt.Errorf("Error setting lifecycle_state: %s", err)) + } + + if err = d.Set("name", vpcdnsResolutionBinding.Name); err != nil { + return diag.FromErr(fmt.Errorf("Error setting name: %s", err)) + } + + if err = d.Set("resource_type", vpcdnsResolutionBinding.ResourceType); err != nil { + return diag.FromErr(fmt.Errorf("Error setting resource_type: %s", err)) + } + + vpc := []map[string]interface{}{} + if vpcdnsResolutionBinding.VPC != nil { + modelMap, err := dataSourceIBMIsVPCDnsResolutionBindingVPCReferenceRemoteToMap(vpcdnsResolutionBinding.VPC) + if err != nil { + return diag.FromErr(err) + } + vpc = append(vpc, modelMap) + } + if err = d.Set("vpc", vpc); err != nil { + return diag.FromErr(fmt.Errorf("Error setting vpc %s", err)) + } + + return nil +} + +func dataSourceIBMIsVPCDnsResolutionBindingEndpointGatewayReferenceRemoteToMap(model *vpcv1.EndpointGatewayReferenceRemote) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + modelMap["crn"] = model.CRN + modelMap["href"] = model.Href + modelMap["id"] = model.ID + modelMap["name"] = model.Name + if model.Remote != nil { + remoteMap, err := dataSourceIBMIsVPCDnsResolutionBindingEndpointGatewayRemoteToMap(model.Remote) + if err != nil { + return modelMap, err + } + modelMap["remote"] = []map[string]interface{}{remoteMap} + } + modelMap["resource_type"] = model.ResourceType + return modelMap, nil +} + +func dataSourceIBMIsVPCDnsResolutionBindingEndpointGatewayRemoteToMap(model *vpcv1.EndpointGatewayRemote) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + if model.Account != nil { + accountMap, err := dataSourceIBMIsVPCDnsResolutionBindingAccountReferenceToMap(model.Account) + if err != nil { + return modelMap, err + } + modelMap["account"] = []map[string]interface{}{accountMap} + } + if model.Region != nil { + regionMap, err := dataSourceIBMIsVPCDnsResolutionBindingRegionReferenceToMap(model.Region) + if err != nil { + return modelMap, err + } + modelMap["region"] = []map[string]interface{}{regionMap} + } + return modelMap, nil +} + +func dataSourceIBMIsVPCDnsResolutionBindingAccountReferenceToMap(model *vpcv1.AccountReference) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + modelMap["id"] = model.ID + modelMap["resource_type"] = model.ResourceType + return modelMap, nil +} + +func dataSourceIBMIsVPCDnsResolutionBindingRegionReferenceToMap(model *vpcv1.RegionReference) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + modelMap["href"] = model.Href + modelMap["name"] = model.Name + return modelMap, nil +} + +func dataSourceIBMIsVPCDnsResolutionBindingVPCReferenceRemoteToMap(model *vpcv1.VPCReferenceRemote) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + modelMap["crn"] = model.CRN + modelMap["href"] = model.Href + modelMap["id"] = model.ID + modelMap["name"] = model.Name + if model.Remote != nil { + remoteMap, err := dataSourceIBMIsVPCDnsResolutionBindingVPCRemoteToMap(model.Remote) + if err != nil { + return modelMap, err + } + modelMap["remote"] = []map[string]interface{}{remoteMap} + } + modelMap["resource_type"] = model.ResourceType + return modelMap, nil +} + +func dataSourceIBMIsVPCDnsResolutionBindingVPCRemoteToMap(model *vpcv1.VPCRemote) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + if model.Account != nil { + accountMap, err := dataSourceIBMIsVPCDnsResolutionBindingAccountReferenceToMap(model.Account) + if err != nil { + return modelMap, err + } + modelMap["account"] = []map[string]interface{}{accountMap} + } + if model.Region != nil { + regionMap, err := dataSourceIBMIsVPCDnsResolutionBindingRegionReferenceToMap(model.Region) + if err != nil { + return modelMap, err + } + modelMap["region"] = []map[string]interface{}{regionMap} + } + return modelMap, nil +} diff --git a/ibm/service/vpc/data_source_ibm_is_vpc_dns_resolution_binding_test.go b/ibm/service/vpc/data_source_ibm_is_vpc_dns_resolution_binding_test.go new file mode 100644 index 0000000000..7b1ea7884b --- /dev/null +++ b/ibm/service/vpc/data_source_ibm_is_vpc_dns_resolution_binding_test.go @@ -0,0 +1,50 @@ +// Copyright IBM Corp. 2023 All Rights Reserved. +// Licensed under the Mozilla Public License v2.0 + +package vpc_test + +import ( + "fmt" + "testing" + + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/acctest" + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource" + + acc "github.com/IBM-Cloud/terraform-provider-ibm/ibm/acctest" +) + +func TestAccIBMIsVPCDnsResolutionBindingDataSourceBasic(t *testing.T) { + vpcname1 := fmt.Sprintf("tf-vpc-%d", acctest.RandIntRange(10, 100)) + enable_hub1 := true + vpcname2 := fmt.Sprintf("tf-vpc-%d", acctest.RandIntRange(10, 100)) + bindingname := fmt.Sprintf("tf-vpc-dns-binding-%d", acctest.RandIntRange(10, 100)) + enable_hub2 := false + resource.Test(t, resource.TestCase{ + PreCheck: func() { acc.TestAccPreCheck(t) }, + Providers: acc.TestAccProviders, + Steps: []resource.TestStep{ + resource.TestStep{ + Config: testAccCheckIBMIsVPCDnsResolutionBindingDataSourceConfigBasic(vpcname1, vpcname2, bindingname, enable_hub1, enable_hub2), + Check: resource.ComposeTestCheckFunc( + resource.TestCheckResourceAttrSet("data.ibm_is_vpc_dns_resolution_binding.is_vpc_dns_resolution_binding", "id"), + resource.TestCheckResourceAttrSet("data.ibm_is_vpc_dns_resolution_binding.is_vpc_dns_resolution_binding", "vpc_id"), + resource.TestCheckResourceAttrSet("data.ibm_is_vpc_dns_resolution_binding.is_vpc_dns_resolution_binding", "created_at"), + resource.TestCheckResourceAttrSet("data.ibm_is_vpc_dns_resolution_binding.is_vpc_dns_resolution_binding", "href"), + resource.TestCheckResourceAttrSet("data.ibm_is_vpc_dns_resolution_binding.is_vpc_dns_resolution_binding", "lifecycle_state"), + resource.TestCheckResourceAttrSet("data.ibm_is_vpc_dns_resolution_binding.is_vpc_dns_resolution_binding", "name"), + resource.TestCheckResourceAttrSet("data.ibm_is_vpc_dns_resolution_binding.is_vpc_dns_resolution_binding", "resource_type"), + resource.TestCheckResourceAttrSet("data.ibm_is_vpc_dns_resolution_binding.is_vpc_dns_resolution_binding", "vpc.#"), + ), + }, + }, + }) +} + +func testAccCheckIBMIsVPCDnsResolutionBindingDataSourceConfigBasic(vpcname1, vpcname2, bindingname string, enable_hub1, enable_hub2 bool) string { + return testAccCheckIBMIsVPCDnsResolutionBindingResourceConfigBasic(vpcname1, vpcname2, bindingname, enable_hub1, enable_hub2) + fmt.Sprintf(` + data "ibm_is_vpc_dns_resolution_binding" "is_vpc_dns_resolution_binding" { + vpc_id = ibm_is_vpc_dns_resolution_binding.is_vpc_dns_resolution_binding.vpc_id + identifier = split("/", ibm_is_vpc_dns_resolution_binding.is_vpc_dns_resolution_binding.id)[1] + } + `) +} diff --git a/ibm/service/vpc/data_source_ibm_is_vpc_dns_resolution_bindings.go b/ibm/service/vpc/data_source_ibm_is_vpc_dns_resolution_bindings.go new file mode 100644 index 0000000000..64d86577ef --- /dev/null +++ b/ibm/service/vpc/data_source_ibm_is_vpc_dns_resolution_bindings.go @@ -0,0 +1,324 @@ +// Copyright IBM Corp. 2023 All Rights Reserved. +// Licensed under the Mozilla Public License v2.0 + +package vpc + +import ( + "context" + "fmt" + "log" + "time" + + "github.com/hashicorp/terraform-plugin-sdk/v2/diag" + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" + + "github.com/IBM-Cloud/terraform-provider-ibm/ibm/flex" + "github.com/IBM/vpc-go-sdk/vpcv1" +) + +const ( + isVPCDnsResolutionBindings = "dns_resolution_bindings" + isVPCDnsResolutionBindingVpcId = "vpc_id" + isVPCDnsResolutionBindingCreatedAt = "created_at" + isVPCDnsResolutionBindingEndpointGateways = "endpoint_gateways" + isVPCDnsResolutionBindingCrn = "crn" + isVPCDnsResolutionBindingId = "id" + isVPCDnsResolutionBindingHref = "href" + isVPCDnsResolutionBindingLifecycleState = "lifecycle_state" + isVPCDnsResolutionBindingName = "name" + isVPCDnsResolutionBindingResourceType = "resource_type" + isVPCDnsResolutionBindingRemote = "remote" + isVPCDnsResolutionBindingAccount = "account" + isVPCDnsResolutionBindingRegion = "region" +) + +func DataSourceIBMIsVPCDnsResolutionBindings() *schema.Resource { + return &schema.Resource{ + ReadContext: dataSourceIBMIsVPCDnsResolutionBindingsRead, + Schema: map[string]*schema.Schema{ + isVPCDnsResolutionBindings: { + Type: schema.TypeList, + Computed: true, + Description: "Collection of VPC Dns Resolution Bindings.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + isVPCDnsResolutionBindingId: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The DNS resolution binding identifier.", + }, + isVPCDnsResolutionBindingCreatedAt: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The date and time that the DNS resolution binding was created.", + }, + isVPCDnsResolutionBindingEndpointGateways: &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "The endpoint gateways in the bound to VPC that are allowed to participate in this DNS resolution binding.The endpoint gateways may be remote and therefore may not be directly retrievable.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + isVPCDnsResolutionBindingCrn: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The CRN for this endpoint gateway.", + }, + isVPCDnsResolutionBindingHref: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The URL for this endpoint gateway.", + }, + isVPCDnsResolutionBindingId: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The unique identifier for this endpoint gateway.", + }, + isVPCDnsResolutionBindingName: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The name for this endpoint gateway. The name is unique across all endpoint gateways in the VPC.", + }, + isVPCDnsResolutionBindingRemote: &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + isVPCDnsResolutionBindingAccount: &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "If present, this property indicates that the referenced resource is remote to thisaccount, and identifies the owning account.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + isVPCDnsResolutionBindingId: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The unique identifier for this account.", + }, + isVPCDnsResolutionBindingResourceType: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The resource type.", + }, + }, + }, + }, + isVPCDnsResolutionBindingRegion: &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + isVPCDnsResolutionBindingId: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The URL for this region.", + }, + isVPCDnsResolutionBindingName: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The globally unique name for this region.", + }, + }, + }, + }, + }, + }, + }, + isVPCDnsResolutionBindingResourceType: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The resource type.", + }, + }, + }, + }, + isVPCDnsResolutionBindingHref: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The URL for this DNS resolution binding.", + }, + isVPCDnsResolutionBindingLifecycleState: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The lifecycle state of the DNS resolution binding.", + }, + isVPCDnsResolutionBindingName: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The name for this DNS resolution binding. The name is unique across all DNS resolution bindings for the VPC.", + }, + isVPCDnsResolutionBindingResourceType: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The resource type.", + }, + "vpc": &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "The VPC bound to for DNS resolution.The VPC may be remote and therefore may not be directly retrievable.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + isVPCDnsResolutionBindingCrn: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The CRN for this VPC.", + }, + isVPCDnsResolutionBindingHref: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The URL for this VPC.", + }, + isVPCDnsResolutionBindingId: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The unique identifier for this VPC.", + }, + isVPCDnsResolutionBindingName: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The name for this VPC. The name is unique across all VPCs in the region.", + }, + isVPCDnsResolutionBindingRemote: &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + isVPCDnsResolutionBindingAccount: &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "If present, this property indicates that the referenced resource is remote to thisaccount, and identifies the owning account.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + isVPCDnsResolutionBindingId: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The unique identifier for this account.", + }, + isVPCDnsResolutionBindingResourceType: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The resource type.", + }, + }, + }, + }, + isVPCDnsResolutionBindingRegion: &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + isVPCDnsResolutionBindingId: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The URL for this region.", + }, + isVPCDnsResolutionBindingName: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The globally unique name for this region.", + }, + }, + }, + }, + }, + }, + }, + isVPCDnsResolutionBindingResourceType: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The resource type.", + }, + }, + }, + }, + }, + }, + }, + isVPCDnsResolutionBindingVpcId: &schema.Schema{ + Type: schema.TypeString, + Required: true, + Description: "The VPC identifier.", + }, + }, + } +} + +func dataSourceIBMIsVPCDnsResolutionBindingsRead(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { + sess, err := vpcClient(meta) + if err != nil { + return diag.FromErr(err) + } + listVPCDnsResolutionBindingOptions := &vpcv1.ListVPCDnsResolutionBindingsOptions{} + + listVPCDnsResolutionBindingOptions.SetVPCID(d.Get(isVPCDnsResolutionBindingVpcId).(string)) + start := "" + allrecs := []vpcv1.VpcdnsResolutionBinding{} + + for { + if start != "" { + listVPCDnsResolutionBindingOptions.Start = &start + } + vpcdnsResolutionBindingCollection, response, err := sess.ListVPCDnsResolutionBindingsWithContext(context, listVPCDnsResolutionBindingOptions) + if err != nil { + log.Printf("[DEBUG] ListVPCDnsResolutionBindingsWithContext failed %s\n%s", err, response) + return diag.FromErr(fmt.Errorf("ListVPCDnsResolutionBindingsWithContext failed %s\n%s", err, response)) + } + start = flex.GetNext(vpcdnsResolutionBindingCollection.Next) + allrecs = append(allrecs, vpcdnsResolutionBindingCollection.DnsResolutionBindings...) + if start == "" { + break + } + } + vpcdnsResolutionBindingsInfo := make([]map[string]interface{}, 0) + if len(allrecs) != 0 { + for _, dns := range allrecs { + l := map[string]interface{}{} + l[isVPCDnsResolutionBindingId] = *dns.ID + + l[isVPCDnsResolutionBindingCreatedAt] = flex.DateTimeToString(dns.CreatedAt) + + endpointGateways := []map[string]interface{}{} + if dns.EndpointGateways != nil { + for _, modelItem := range dns.EndpointGateways { + modelMap, err := dataSourceIBMIsVPCDnsResolutionBindingEndpointGatewayReferenceRemoteToMap(&modelItem) + if err != nil { + return diag.FromErr(err) + } + endpointGateways = append(endpointGateways, modelMap) + } + } + l[isVPCDnsResolutionBindingEndpointGateways] = endpointGateways + + l[isVPCDnsResolutionBindingId] = dns.ID + + l[isVPCDnsResolutionBindingLifecycleState] = dns.LifecycleState + + l[isVPCDnsResolutionBindingName] = dns.Name + l[isVPCDnsResolutionBindingHref] = dns.Href + + l[isVPCDnsResolutionBindingResourceType] = dns.ResourceType + + vpc := []map[string]interface{}{} + if dns.VPC != nil { + modelMap, err := dataSourceIBMIsVPCDnsResolutionBindingVPCReferenceRemoteToMap(dns.VPC) + if err != nil { + return diag.FromErr(err) + } + vpc = append(vpc, modelMap) + } + l["vpc"] = vpc + vpcdnsResolutionBindingsInfo = append(vpcdnsResolutionBindingsInfo, l) + } + } + d.SetId(dataSourceIBMIsVPCDnsResolutionBindingsId(d)) + d.Set(isVPCDnsResolutionBindings, vpcdnsResolutionBindingsInfo) + return nil +} + +// dataSourceIBMIsVPCDnsResolutionBindingsId returns a reasonable ID for VPC Dns Resolution Bindings list. +func dataSourceIBMIsVPCDnsResolutionBindingsId(d *schema.ResourceData) string { + return time.Now().UTC().String() +} diff --git a/ibm/service/vpc/data_source_ibm_is_vpc_dns_resolution_bindings_test.go b/ibm/service/vpc/data_source_ibm_is_vpc_dns_resolution_bindings_test.go new file mode 100644 index 0000000000..da4dff088b --- /dev/null +++ b/ibm/service/vpc/data_source_ibm_is_vpc_dns_resolution_bindings_test.go @@ -0,0 +1,49 @@ +// Copyright IBM Corp. 2023 All Rights Reserved. +// Licensed under the Mozilla Public License v2.0 + +package vpc_test + +import ( + "fmt" + "testing" + + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/acctest" + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource" + + acc "github.com/IBM-Cloud/terraform-provider-ibm/ibm/acctest" +) + +func TestAccIBMIsVPCDnsResolutionBindingsDataSourceBasic(t *testing.T) { + vpcname1 := fmt.Sprintf("tf-vpc-%d", acctest.RandIntRange(10, 100)) + enable_hub1 := true + vpcname2 := fmt.Sprintf("tf-vpc-%d", acctest.RandIntRange(10, 100)) + bindingname := fmt.Sprintf("tf-vpc-dns-binding-%d", acctest.RandIntRange(10, 100)) + enable_hub2 := false + resource.Test(t, resource.TestCase{ + PreCheck: func() { acc.TestAccPreCheck(t) }, + Providers: acc.TestAccProviders, + Steps: []resource.TestStep{ + resource.TestStep{ + Config: testAccCheckIBMIsVPCDnsResolutionBindingsDataSourceConfigBasic(vpcname1, vpcname2, bindingname, enable_hub1, enable_hub2), + Check: resource.ComposeTestCheckFunc( + resource.TestCheckResourceAttrSet("data.ibm_is_vpc_dns_resolution_bindings.is_vpc_dns_resolution_bindings", "vpc_id"), + resource.TestCheckResourceAttrSet("data.ibm_is_vpc_dns_resolution_bindings.is_vpc_dns_resolution_bindings", "dns_resolution_bindings.0.id"), + resource.TestCheckResourceAttrSet("data.ibm_is_vpc_dns_resolution_bindings.is_vpc_dns_resolution_bindings", "dns_resolution_bindings.0.created_at"), + resource.TestCheckResourceAttrSet("data.ibm_is_vpc_dns_resolution_bindings.is_vpc_dns_resolution_bindings", "dns_resolution_bindings.0.href"), + resource.TestCheckResourceAttrSet("data.ibm_is_vpc_dns_resolution_bindings.is_vpc_dns_resolution_bindings", "dns_resolution_bindings.0.lifecycle_state"), + resource.TestCheckResourceAttrSet("data.ibm_is_vpc_dns_resolution_bindings.is_vpc_dns_resolution_bindings", "dns_resolution_bindings.0.name"), + resource.TestCheckResourceAttrSet("data.ibm_is_vpc_dns_resolution_bindings.is_vpc_dns_resolution_bindings", "dns_resolution_bindings.0.resource_type"), + resource.TestCheckResourceAttrSet("data.ibm_is_vpc_dns_resolution_bindings.is_vpc_dns_resolution_bindings", "dns_resolution_bindings.0.vpc.#"), + ), + }, + }, + }) +} + +func testAccCheckIBMIsVPCDnsResolutionBindingsDataSourceConfigBasic(vpcname1, vpcname2, bindingname string, enable_hub1, enable_hub2 bool) string { + return testAccCheckIBMIsVPCDnsResolutionBindingResourceConfigBasic(vpcname1, vpcname2, bindingname, enable_hub1, enable_hub2) + fmt.Sprintf(` + data "ibm_is_vpc_dns_resolution_bindings" "is_vpc_dns_resolution_bindings" { + vpc_id = ibm_is_vpc_dns_resolution_binding.is_vpc_dns_resolution_binding.vpc_id + } + `) +} diff --git a/ibm/service/vpc/data_source_ibm_is_vpc_test.go b/ibm/service/vpc/data_source_ibm_is_vpc_test.go index 3eeee7d166..99ba4eaf97 100644 --- a/ibm/service/vpc/data_source_ibm_is_vpc_test.go +++ b/ibm/service/vpc/data_source_ibm_is_vpc_test.go @@ -43,6 +43,40 @@ func TestAccIBMISVPCDatasource_basic(t *testing.T) { }, }) } +func TestAccIBMISVPCDatasource_dns(t *testing.T) { + var vpc string + name := acc.ISDelegegatedVPC + enableHubTrue := true + server1Add := "192.168.3.4" + resource.Test(t, resource.TestCase{ + PreCheck: func() { acc.TestAccPreCheck(t) }, + Providers: acc.TestAccProviders, + CheckDestroy: testAccCheckIBMISVPCDestroy, + Steps: []resource.TestStep{ + { + Config: testDSCheckIBMISVPCDnsConfig(name, server1Add, enableHubTrue), + Check: resource.ComposeTestCheckFunc( + testAccCheckIBMISVPCExists("ibm_is_vpc.testacc_vpc1", vpc), + resource.TestCheckResourceAttr( + "data.ibm_is_vpc.ds_vpc", "name", name), + resource.TestCheckResourceAttrSet("data.ibm_is_vpc.ds_vpc", "cse_source_addresses.#"), + resource.TestCheckResourceAttrSet("data.ibm_is_vpc.ds_vpc", "default_network_acl_name"), + resource.TestCheckResourceAttrSet("data.ibm_is_vpc.ds_vpc", "default_security_group_name"), + resource.TestCheckResourceAttrSet("data.ibm_is_vpc.ds_vpc", "default_routing_table_name"), + resource.TestCheckResourceAttrSet("data.ibm_is_vpc.ds_vpc", "cse_source_addresses.#"), + resource.TestCheckResourceAttrSet("data.ibm_is_vpc.ds_vpc", "default_network_acl_name"), + resource.TestCheckResourceAttrSet("data.ibm_is_vpc.ds_vpc", "default_security_group_name"), + resource.TestCheckResourceAttrSet("data.ibm_is_vpc.ds_vpc", "default_routing_table_name"), + resource.TestCheckResourceAttrSet("data.ibm_is_vpc.ds_vpc", "dns.#"), + resource.TestCheckResourceAttrSet("data.ibm_is_vpc.ds_vpc", "dns.0.enable_hub"), + resource.TestCheckResourceAttrSet("data.ibm_is_vpc.ds_vpc", "dns.0.resolver.#"), + resource.TestCheckResourceAttrSet("data.ibm_is_vpc.ds_vpc", "dns.0.resolver.0.servers.#"), + resource.TestCheckResourceAttrSet("data.ibm_is_vpc.ds_vpc", "dns.0.resolver.0.type"), + ), + }, + }, + }) +} func TestAccIBMISVPCDatasource_securityGroup(t *testing.T) { var vpc string @@ -81,6 +115,12 @@ func testDSCheckIBMISVPCConfig(name string) string { identifier = "${ibm_is_vpc.testacc_vpc.id}" }`, name) } +func testDSCheckIBMISVPCDnsConfig(name, server1Add string, enableHubTrue bool) string { + return testAccCheckIBMISVPCDnsManualConfig(name, server1Add, enableHubTrue) + fmt.Sprintf(` + data "ibm_is_vpc" "ds_vpc" { + name = ibm_is_vpc.testacc_vpc1.name + }`) +} func testDSCheckIBMISVPCSgConfig(vpcname, sgname string) string { return fmt.Sprintf(` diff --git a/ibm/service/vpc/data_source_ibm_is_vpcs.go b/ibm/service/vpc/data_source_ibm_is_vpcs.go index 226be33774..bbda155fa4 100644 --- a/ibm/service/vpc/data_source_ibm_is_vpcs.go +++ b/ibm/service/vpc/data_source_ibm_is_vpcs.go @@ -14,6 +14,7 @@ import ( "github.com/IBM-Cloud/terraform-provider-ibm/ibm/conns" "github.com/IBM-Cloud/terraform-provider-ibm/ibm/flex" + "github.com/IBM/go-sdk-core/v5/core" "github.com/IBM/vpc-go-sdk/vpcv1" "github.com/hashicorp/terraform-plugin-sdk/v2/diag" "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" @@ -267,6 +268,196 @@ func DataSourceIBMISVPCs() *schema.Resource { }, }, + // dns changes + + isVPCDns: &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "The DNS configuration for this VPC.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + isVPCDnsEnableHub: &schema.Schema{ + Type: schema.TypeBool, + Computed: true, + Description: "Indicates whether this VPC is enabled as a DNS name resolution hub.", + }, + isVPCDnsResolutionBindingCount: &schema.Schema{ + Type: schema.TypeInt, + Computed: true, + Description: "The number of DNS resolution bindings for this VPC.", + }, + isVPCDnsResolver: &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "The DNS resolver configuration for the VPC.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + isVPCDnsResolverServers: &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "The DNS servers for this VPC. The servers are populated:- by the system when `dns.resolver.type` is `system`- using the DNS servers in `dns.resolver.vpc` when `dns.resolver.type` is `delegated`- using `dns.resolver.manual_servers` when the `dns.resolver.type` is `manual`.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + isVPCDnsResolverManualServersAddress: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The IP address.This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.", + }, + isVPCDnsResolverManualServersZoneAffinity: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "Zone name, if present, DHCP configuration for this zone will have this DNS server listed first.", + }, + }, + }, + }, + isVPCDnsResolverType: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The type of the DNS resolver used for the VPC.- `delegated`: DNS server addresses are provided by the DNS resolver of the VPC specified in `dns.resolver.vpc`.- `manual`: DNS server addresses are specified in `dns.resolver.manual_servers`.- `system`: DNS server addresses are provided by the system.", + }, + isVPCDnsResolverVpc: &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "The VPC whose DNS resolver provides the DNS server addresses for this VPC.The VPC may be remote and therefore may not be directly retrievable.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + isVPCDnsResolverVpcCrn: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The CRN for this VPC.", + }, + isVPCDnsResolverVpcDeleted: &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + isVPCDnsResolverVpcDeletedMoreInfo: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "Link to documentation about deleted resources.", + }, + }, + }, + }, + isVPCDnsResolverVpcHref: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The URL for this VPC.", + }, + isVPCDnsResolverVpcId: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The unique identifier for this VPC.", + }, + isVPCDnsResolverVpcName: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The name for this VPC. The name is unique across all VPCs in the region.", + }, + isVPCDnsResolverVpcRemote: &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + isVPCDnsResolverVpcRemoteAccount: &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "If present, this property indicates that the referenced resource is remote to thisaccount, and identifies the owning account.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "id": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The unique identifier for this account.", + }, + isVPCDnsResolverResourceType: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The resource type.", + }, + }, + }, + }, + isVPCDnsResolverVpcRemoteRegion: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "Region name. If present, this property indicates that the referenced resource is remote to this region, and identifies the native region.", + }, + }, + }, + }, + isVPCDnsResolverResourceType: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The resource type.", + }, + }, + }, + }, + isVPCDnsResolverManualServers: &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "The manually specified DNS servers for this VPC.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + isVPCDnsResolverManualServersAddress: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The IP address.This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.", + }, + isVPCDnsResolverManualServersZoneAffinity: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The name of the zone. If present, DHCP configuration for this zone will have this DNS server listed first.", + }, + }, + }, + }, + isVPCDnsResolverConfiguration: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The configuration of the system DNS resolver for this VPC.- `custom_resolver`: A custom DNS resolver is configured for this VPC.- `private_resolver`: A private DNS resolver is configured for this VPC. Applicable when the VPC has either or both of the following: - at least one endpoint gateway residing in it - a [DNS Services](https://cloud.ibm.com/docs/dns-svcs) private zone configured for it- `default`: The provider default DNS resolvers are configured for this VPC. This system DNS resolver configuration is used when the VPC has: - no custom DNS resolver configured for it, and - no endpoint gateways residing in it, and - no [DNS Services](https://cloud.ibm.com/docs/dns-svcs) private zone configured for it.", + }, + }, + }, + }, + }, + }, + }, + + "health_reasons": &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "The reasons for the current `health_state` (if any).The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "code": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "A snake case string succinctly identifying the reason for this health state.", + }, + "message": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "An explanation of the reason for this health state.", + }, + "more_info": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "Link to documentation about the reason for this health state.", + }, + }, + }, + }, + "health_state": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The health of this resource.- `ok`: No abnormal behavior detected- `degraded`: Experiencing compromised performance, capacity, or connectivity- `faulted`: Completely unreachable, inoperative, or otherwise entirely incapacitated- `inapplicable`: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of `failed` or `deleting` will have a health state of `inapplicable`. A `pending` resource may also have this state.", + }, + subnetsList: { Type: schema.TypeList, Computed: true, @@ -588,6 +779,31 @@ func dataSourceIBMISVPCListRead(context context.Context, d *schema.ResourceData, } } l[isVPCSecurityGroupList] = securityGroupList + + // dns changes + + if !core.IsNil(vpc.Dns) { + dnsMap, err := dataSourceIBMIsVPCVpcdnsToMap(vpc.Dns) + if err != nil { + return diag.FromErr(err) + } + l[isVPCDns] = []map[string]interface{}{dnsMap} + } + + healthReasons := []map[string]interface{}{} + if vpc.HealthReasons != nil { + for _, modelItem := range vpc.HealthReasons { + modelMap, err := dataSourceIBMIsVPCVPCHealthReasonToMap(&modelItem) + if err != nil { + return diag.FromErr(err) + } + healthReasons = append(healthReasons, modelMap) + } + } + l["health_reasons"] = healthReasons + + l["health_state"] = vpc.HealthState + vpcs = append(vpcs, l) } d.SetId(dataSourceIBMISVPCsID(d)) diff --git a/ibm/service/vpc/resource_ibm_is_instance.go b/ibm/service/vpc/resource_ibm_is_instance.go index 1f82d0249d..27323efbc6 100644 --- a/ibm/service/vpc/resource_ibm_is_instance.go +++ b/ibm/service/vpc/resource_ibm_is_instance.go @@ -174,10 +174,6 @@ func ResourceIBMISInstance() *schema.Resource { }, CustomizeDiff: customdiff.All( - customdiff.Sequence( - func(_ context.Context, diff *schema.ResourceDiff, v interface{}) error { - return flex.InstanceProfileValidate(diff) - }), customdiff.Sequence( func(_ context.Context, diff *schema.ResourceDiff, v interface{}) error { return flex.ResourceTagsCustomizeDiff(diff) diff --git a/ibm/service/vpc/resource_ibm_is_instance_template.go b/ibm/service/vpc/resource_ibm_is_instance_template.go index 7fd6eda945..65f01f51c5 100644 --- a/ibm/service/vpc/resource_ibm_is_instance_template.go +++ b/ibm/service/vpc/resource_ibm_is_instance_template.go @@ -1042,7 +1042,7 @@ func instanceTemplateCreateByCatalogOffering(d *schema.ResourceData, meta interf // var reservedipautodeleteok interface{} if v, ok := primip[isInstanceTemplateNicReservedIpAutoDelete].(bool); ok && v { - log.Printf("[INFO] UJJK isInstanceTemplateNicReservedIpAutoDelete is v is %t and okay is %t", v, ok) + log.Printf("[INFO] isInstanceTemplateNicReservedIpAutoDelete is v is %t and okay is %t", v, ok) reservedIpAutoDelete = primip[isInstanceTemplateNicReservedIpAutoDelete].(bool) okAuto = true } @@ -1465,7 +1465,7 @@ func instanceTemplateCreate(d *schema.ResourceData, meta interface{}, profile, n // var reservedipautodeleteok interface{} if v, ok := primip[isInstanceTemplateNicReservedIpAutoDelete].(bool); ok && v { - log.Printf("[INFO] UJJK isInstanceTemplateNicReservedIpAutoDelete is v is %t and okay is %t", v, ok) + log.Printf("[INFO] isInstanceTemplateNicReservedIpAutoDelete is v is %t and okay is %t", v, ok) reservedIpAutoDelete = primip[isInstanceTemplateNicReservedIpAutoDelete].(bool) okAuto = true } diff --git a/ibm/service/vpc/resource_ibm_is_share.go b/ibm/service/vpc/resource_ibm_is_share.go index 298f9ef13e..487479fd42 100644 --- a/ibm/service/vpc/resource_ibm_is_share.go +++ b/ibm/service/vpc/resource_ibm_is_share.go @@ -50,10 +50,6 @@ func ResourceIbmIsShare() *schema.Resource { return flex.ResourceValidateAccessTags(diff, v) }, ), - customdiff.Sequence( - func(_ context.Context, diff *schema.ResourceDiff, v interface{}) error { - return flex.ResourceSharesValidate(diff) - }), ), Schema: map[string]*schema.Schema{ @@ -675,7 +671,7 @@ func ResourceIbmIsShareValidator() *validate.ResourceValidator { Type: validate.TypeInt, Optional: true, MinValue: "100", - MaxValue: "48000", + MaxValue: "96000", }, validate.ValidateSchema{ Identifier: "name", diff --git a/ibm/service/vpc/resource_ibm_is_virtual_endpoint_gateway.go b/ibm/service/vpc/resource_ibm_is_virtual_endpoint_gateway.go index 132b629e86..a680ea0e52 100644 --- a/ibm/service/vpc/resource_ibm_is_virtual_endpoint_gateway.go +++ b/ibm/service/vpc/resource_ibm_is_virtual_endpoint_gateway.go @@ -20,28 +20,29 @@ import ( ) const ( - isVirtualEndpointGatewayName = "name" - isVirtualEndpointGatewayResourceType = "resource_type" - isVirtualEndpointGatewayCRN = "crn" - isVirtualEndpointGatewayResourceGroupID = "resource_group" - isVirtualEndpointGatewayCreatedAt = "created_at" - isVirtualEndpointGatewayIPs = "ips" - isVirtualEndpointGatewayIPsID = "id" - isVirtualEndpointGatewayIPsAddress = "address" - isVirtualEndpointGatewayIPsName = "name" - isVirtualEndpointGatewayIPsSubnet = "subnet" - isVirtualEndpointGatewayIPsResourceType = "resource_type" - isVirtualEndpointGatewayHealthState = "health_state" - isVirtualEndpointGatewayLifecycleState = "lifecycle_state" - isVirtualEndpointGatewayTarget = "target" - isVirtualEndpointGatewayTargetName = "name" - isVirtualEndpointGatewayTargetCRN = "crn" - isVirtualEndpointGatewayTargetResourceType = "resource_type" - isVirtualEndpointGatewayVpcID = "vpc" - isVirtualEndpointGatewayTags = "tags" - isVirtualEndpointGatewaySecurityGroups = "security_groups" - isVirtualEndpointGatewayServiceEndpoints = "service_endpoints" - isVirtualEndpointGatewayAccessTags = "access_tags" + isVirtualEndpointGatewayName = "name" + isVirtualEndpointGatewayResourceType = "resource_type" + isVirtualEndpointGatewayCRN = "crn" + isVirtualEndpointGatewayResourceGroupID = "resource_group" + isVirtualEndpointGatewayCreatedAt = "created_at" + isVirtualEndpointGatewayIPs = "ips" + isVirtualEndpointGatewayIPsID = "id" + isVirtualEndpointGatewayIPsAddress = "address" + isVirtualEndpointGatewayIPsName = "name" + isVirtualEndpointGatewayIPsSubnet = "subnet" + isVirtualEndpointGatewayIPsResourceType = "resource_type" + isVirtualEndpointGatewayHealthState = "health_state" + isVirtualEndpointGatewayLifecycleState = "lifecycle_state" + isVirtualEndpointGatewayTarget = "target" + isVirtualEndpointGatewayTargetName = "name" + isVirtualEndpointGatewayTargetCRN = "crn" + isVirtualEndpointGatewayTargetResourceType = "resource_type" + isVirtualEndpointGatewayVpcID = "vpc" + isVirtualEndpointGatewayTags = "tags" + isVirtualEndpointGatewaySecurityGroups = "security_groups" + isVirtualEndpointGatewayServiceEndpoints = "service_endpoints" + isVirtualEndpointGatewayAccessTags = "access_tags" + isVirtualEndpointGatewayAllowDnsResolutionBinding = "allow_dns_resolution_binding" ) func ResourceIBMISEndpointGateway() *schema.Resource { @@ -210,6 +211,12 @@ func ResourceIBMISEndpointGateway() *schema.Resource { ForceNew: true, Description: "The VPC id", }, + isVirtualEndpointGatewayAllowDnsResolutionBinding: { + Type: schema.TypeBool, + Optional: true, + Computed: true, + Description: "Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true.", + }, isVirtualEndpointGatewayTags: { Type: schema.TypeSet, Optional: true, @@ -334,10 +341,15 @@ func resourceIBMisVirtualEndpointGatewayCreate(d *schema.ResourceData, meta inte opt.SetResourceGroup(resourceGroupOpt) } + // dns resolution binding change + if allowDnsResolutionBindingOk, ok := d.GetOkExists(isVirtualEndpointGatewayAllowDnsResolutionBinding); ok { + allowDnsResolutionBinding := allowDnsResolutionBindingOk.(bool) + opt.AllowDnsResolutionBinding = &allowDnsResolutionBinding + } endpointGateway, response, err := sess.CreateEndpointGateway(opt) if err != nil { log.Printf("Create Endpoint Gateway failed: %v", response) - return fmt.Errorf("Create Endpoint Gateway failed %s\n%s", err, response) + return fmt.Errorf("[ERROR] Create Endpoint Gateway failed %s\n%s", err, response) } d.SetId(*endpointGateway.ID) @@ -373,21 +385,22 @@ func resourceIBMisVirtualEndpointGatewayUpdate(d *schema.ResourceData, meta inte if err != nil { return err } - + // create option + endpointGatewayPatchModel := new(vpcv1.EndpointGatewayPatch) if d.HasChange(isVirtualEndpointGatewayName) { name := d.Get(isVirtualEndpointGatewayName).(string) - - // create option - endpointGatewayPatchModel := new(vpcv1.EndpointGatewayPatch) endpointGatewayPatchModel.Name = core.StringPtr(name) - endpointGatewayPatchModelAsPatch, _ := endpointGatewayPatchModel.AsPatch() - opt := sess.NewUpdateEndpointGatewayOptions(d.Id(), endpointGatewayPatchModelAsPatch) - _, response, err := sess.UpdateEndpointGateway(opt) - if err != nil { - log.Printf("Update Endpoint Gateway failed: %v", response) - return fmt.Errorf("Update Endpoint Gateway failed : %s\n%s", err, response) - } - + } + if d.HasChange(isVirtualEndpointGatewayAllowDnsResolutionBinding) { + allowDnsResolutionBinding := d.Get(isVirtualEndpointGatewayAllowDnsResolutionBinding).(bool) + endpointGatewayPatchModel.AllowDnsResolutionBinding = &allowDnsResolutionBinding + } + endpointGatewayPatchModelAsPatch, _ := endpointGatewayPatchModel.AsPatch() + opt := sess.NewUpdateEndpointGatewayOptions(d.Id(), endpointGatewayPatchModelAsPatch) + _, response, err := sess.UpdateEndpointGateway(opt) + if err != nil { + log.Printf("Update Endpoint Gateway failed: %v", response) + return fmt.Errorf("Update Endpoint Gateway failed : %s\n%s", err, response) } id := d.Id() var remove, add []string @@ -479,12 +492,13 @@ func resourceIBMisVirtualEndpointGatewayRead(d *schema.ResourceData, meta interf return nil } log.Printf("Get Endpoint Gateway failed: %v", response) - return fmt.Errorf("Get Endpoint Gateway failed %s\n%s", err, response) + return fmt.Errorf("[ERROR] Get Endpoint Gateway failed %s\n%s", err, response) } d.Set(isVirtualEndpointGatewayName, endpointGateway.Name) d.Set(isVirtualEndpointGatewayHealthState, endpointGateway.HealthState) d.Set(isVirtualEndpointGatewayCreatedAt, endpointGateway.CreatedAt.String()) d.Set(isVirtualEndpointGatewayLifecycleState, endpointGateway.LifecycleState) + d.Set(isVirtualEndpointGatewayAllowDnsResolutionBinding, endpointGateway.AllowDnsResolutionBinding) d.Set(isVirtualEndpointGatewayResourceType, endpointGateway.ResourceType) d.Set(isVirtualEndpointGatewayCRN, endpointGateway.CRN) d.Set(isVirtualEndpointGatewayIPs, flattenIPs(endpointGateway.Ips)) diff --git a/ibm/service/vpc/resource_ibm_is_virtual_endpoint_gateway_test.go b/ibm/service/vpc/resource_ibm_is_virtual_endpoint_gateway_test.go index d306d8b4db..e0687d2f59 100644 --- a/ibm/service/vpc/resource_ibm_is_virtual_endpoint_gateway_test.go +++ b/ibm/service/vpc/resource_ibm_is_virtual_endpoint_gateway_test.go @@ -36,6 +36,38 @@ func TestAccIBMISVirtualEndpointGateway_Basic(t *testing.T) { }) } +func TestAccIBMISVirtualEndpointGateway_AllowDnsResolutionBinding(t *testing.T) { + var endpointGateway string + vpcname1 := fmt.Sprintf("tfvpngw-vpc-%d", acctest.RandIntRange(10, 100)) + enable_hub := false + name1 := fmt.Sprintf("tfvpngw-createname-%d", acctest.RandIntRange(10, 100)) + name := "ibm_is_virtual_endpoint_gateway.endpoint_gateway" + allowDnsResolutionBindingTrue := true + allowDnsResolutionBindingFalse := false + resource.Test(t, resource.TestCase{ + PreCheck: func() { acc.TestAccPreCheck(t) }, + Providers: acc.TestAccProviders, + Steps: []resource.TestStep{ + { + Config: testAccCheckisVirtualEndpointGatewayConfigAllowDnsResolutionBinding(vpcname1, name1, enable_hub, allowDnsResolutionBindingTrue), + Check: resource.ComposeTestCheckFunc( + testAccCheckisVirtualEndpointGatewayExists(name, &endpointGateway), + resource.TestCheckResourceAttr(name, "name", name1), + resource.TestCheckResourceAttr(name, "allow_dns_resolution_binding", fmt.Sprintf("%t", allowDnsResolutionBindingTrue)), + ), + }, + { + Config: testAccCheckisVirtualEndpointGatewayConfigAllowDnsResolutionBinding(vpcname1, name1, enable_hub, allowDnsResolutionBindingFalse), + Check: resource.ComposeTestCheckFunc( + testAccCheckisVirtualEndpointGatewayExists(name, &endpointGateway), + resource.TestCheckResourceAttr(name, "name", name1), + resource.TestCheckResourceAttr(name, "allow_dns_resolution_binding", fmt.Sprintf("%t", allowDnsResolutionBindingFalse)), + ), + }, + }, + }) +} + func TestAccIBMISVirtualEndpointGateway_CharacterCount(t *testing.T) { var endpointGateway string vpcname1 := fmt.Sprintf("tfvpngw-vpc-%d", acctest.RandIntRange(10, 100)) @@ -253,6 +285,25 @@ func testAccCheckisVirtualEndpointGatewayConfigBasic(vpcname1, subnetname1, name }`, vpcname1, subnetname1, acc.ISZoneName, acc.ISCIDR, name1) } +func testAccCheckisVirtualEndpointGatewayConfigAllowDnsResolutionBinding(vpcname1, name1 string, enable_hub, allowDnsResolutionBinding bool) string { + return fmt.Sprintf(` + resource "ibm_is_vpc" "testacc_vpc" { + name = "%s" + dns { + enable_hub = %t + } + } + resource "ibm_is_virtual_endpoint_gateway" "endpoint_gateway" { + name = "%s" + target { + name = "ibm-ntp-server" + resource_type = "provider_infrastructure_service" + } + vpc = ibm_is_vpc.testacc_vpc.id + allow_dns_resolution_binding = %t + }`, vpcname1, enable_hub, name1, allowDnsResolutionBinding) +} + func testAccCheckisVirtualEndpointGatewayConfigFullySpecified(vpcname1, subnetname1, name1 string) string { return fmt.Sprintf(` data "ibm_resource_group" "test_acc" { diff --git a/ibm/service/vpc/resource_ibm_is_vpc.go b/ibm/service/vpc/resource_ibm_is_vpc.go index 2a91ad93a9..68e75e6fad 100644 --- a/ibm/service/vpc/resource_ibm_is_vpc.go +++ b/ibm/service/vpc/resource_ibm_is_vpc.go @@ -4,64 +4,89 @@ package vpc import ( + "bytes" "context" "fmt" "log" "os" "reflect" + "strings" "time" + "github.com/IBM/go-sdk-core/v5/core" "github.com/IBM/vpc-go-sdk/vpcv1" "github.com/hashicorp/terraform-plugin-sdk/v2/helper/customdiff" "github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource" "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" + "github.com/IBM-Cloud/terraform-provider-ibm/ibm/conns" "github.com/IBM-Cloud/terraform-provider-ibm/ibm/flex" "github.com/IBM-Cloud/terraform-provider-ibm/ibm/validate" ) const ( - isVPCDefaultNetworkACL = "default_network_acl" - isVPCDefaultSecurityGroup = "default_security_group" - isVPCDefaultRoutingTable = "default_routing_table" - isVPCName = "name" - isVPCDefaultNetworkACLName = "default_network_acl_name" - isVPCDefaultNetworkACLCRN = "default_network_acl_crn" - isVPCDefaultSecurityGroupName = "default_security_group_name" - isVPCDefaultSecurityGroupCRN = "default_security_group_crn" - isVPCDefaultRoutingTableName = "default_routing_table_name" - isVPCResourceGroup = "resource_group" - isVPCStatus = "status" - isVPCDeleting = "deleting" - isVPCDeleted = "done" - isVPCTags = "tags" - isVPCClassicAccess = "classic_access" - isVPCAvailable = "available" - isVPCFailed = "failed" - isVPCPending = "pending" - isVPCAddressPrefixManagement = "address_prefix_management" - cseSourceAddresses = "cse_source_addresses" - subnetsList = "subnets" - totalIPV4AddressCount = "total_ipv4_address_count" - availableIPV4AddressCount = "available_ipv4_address_count" - isVPCCRN = "crn" - isVPCSecurityGroupList = "security_group" - isVPCSecurityGroupName = "group_name" - isVPCSgRules = "rules" - isVPCSecurityGroupRuleID = "rule_id" - isVPCSecurityGroupRuleDirection = "direction" - isVPCSecurityGroupRuleIPVersion = "ip_version" - isVPCSecurityGroupRuleRemote = "remote" - isVPCSecurityGroupRuleType = "type" - isVPCSecurityGroupRuleCode = "code" - isVPCSecurityGroupRulePortMax = "port_max" - isVPCSecurityGroupRulePortMin = "port_min" - isVPCSecurityGroupRuleProtocol = "protocol" - isVPCSecurityGroupID = "group_id" - isVPCAccessTags = "access_tags" - isVPCUserTagType = "user" - isVPCAccessTagType = "access" - isVPCNoSgAclRules = "no_sg_acl_rules" + isVPCDefaultNetworkACL = "default_network_acl" + isVPCDefaultSecurityGroup = "default_security_group" + isVPCDefaultRoutingTable = "default_routing_table" + isVPCName = "name" + isVPCDefaultNetworkACLName = "default_network_acl_name" + isVPCDefaultNetworkACLCRN = "default_network_acl_crn" + isVPCDefaultSecurityGroupName = "default_security_group_name" + isVPCDefaultSecurityGroupCRN = "default_security_group_crn" + isVPCDefaultRoutingTableName = "default_routing_table_name" + isVPCResourceGroup = "resource_group" + isVPCStatus = "status" + isVPCDeleting = "deleting" + isVPCDeleted = "done" + isVPCTags = "tags" + isVPCClassicAccess = "classic_access" + isVPCAvailable = "available" + isVPCFailed = "failed" + isVPCPending = "pending" + isVPCAddressPrefixManagement = "address_prefix_management" + cseSourceAddresses = "cse_source_addresses" + subnetsList = "subnets" + totalIPV4AddressCount = "total_ipv4_address_count" + availableIPV4AddressCount = "available_ipv4_address_count" + isVPCCRN = "crn" + isVPCSecurityGroupList = "security_group" + isVPCSecurityGroupName = "group_name" + isVPCSgRules = "rules" + isVPCSecurityGroupRuleID = "rule_id" + isVPCSecurityGroupRuleDirection = "direction" + isVPCSecurityGroupRuleIPVersion = "ip_version" + isVPCSecurityGroupRuleRemote = "remote" + isVPCSecurityGroupRuleType = "type" + isVPCSecurityGroupRuleCode = "code" + isVPCSecurityGroupRulePortMax = "port_max" + isVPCSecurityGroupRulePortMin = "port_min" + isVPCSecurityGroupRuleProtocol = "protocol" + isVPCSecurityGroupID = "group_id" + isVPCAccessTags = "access_tags" + isVPCAccessTagType = "access" + isVPCUserTagType = "user" + isVPCDns = "dns" + isVPCDnsEnableHub = "enable_hub" + isVPCDnsResolutionBindingCount = "resolution_binding_count" + isVPCDnsResolver = "resolver" + isVPCDnsResolverManualServers = "manual_servers" + isVPCDnsResolverServers = "servers" + isVPCDnsResolverManualServersAddress = "address" + isVPCDnsResolverManualServersZoneAffinity = "zone_affinity" + isVPCDnsResolverType = "type" + isVPCDnsResolverVpc = "vpc" + isVPCDnsResolverResourceType = "resource_type" + isVPCDnsResolverConfiguration = "configuration" + isVPCDnsResolverVpcId = "id" + isVPCDnsResolverVpcHref = "href" + isVPCDnsResolverVpcCrn = "crn" + isVPCDnsResolverVpcName = "name" + isVPCDnsResolverVpcDeleted = "deleted" + isVPCDnsResolverVpcDeletedMoreInfo = "more_info" + isVPCDnsResolverVpcRemote = "remote" + isVPCDnsResolverVpcRemoteAccount = "account" + isVPCDnsResolverVpcRemoteRegion = "region" + isVPCNoSgAclRules = "no_sg_acl_rules" ) func ResourceIBMISVPC() *schema.Resource { @@ -112,7 +137,153 @@ func ResourceIBMISVPC() *schema.Resource { Computed: true, Description: "Default routing table associated with VPC", }, + isVPCDns: &schema.Schema{ + Type: schema.TypeList, + MaxItems: 1, + Optional: true, + Computed: true, + Description: "The DNS configuration for this VPC.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + isVPCDnsEnableHub: &schema.Schema{ + Type: schema.TypeBool, + Optional: true, + Computed: true, + Description: "Indicates whether this VPC is enabled as a DNS name resolution hub.", + }, + isVPCDnsResolutionBindingCount: &schema.Schema{ + Type: schema.TypeInt, + Computed: true, + Description: "The number of DNS resolution bindings for this VPC.", + }, + isVPCDnsResolver: &schema.Schema{ + Type: schema.TypeList, + MinItems: 0, + MaxItems: 1, + Optional: true, + Computed: true, + Description: "The DNS resolver configuration for the VPC.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + isVPCDnsResolverServers: &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "The DNS servers for this VPC. The servers are populated:- by the system when `dns.resolver.type` is `system`- using the DNS servers in `dns.resolver.vpc` when `dns.resolver.type` is `delegated`- using `dns.resolver.manual_servers` when the `dns.resolver.type` is `manual`.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + isVPCDnsResolverManualServersAddress: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The IP address.This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.", + }, + isVPCDnsResolverManualServersZoneAffinity: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "Zone name, if present, DHCP configuration for this zone will have this DNS server listed first.", + }, + }, + }, + }, + isVPCDnsResolverType: &schema.Schema{ + Type: schema.TypeString, + Optional: true, + Computed: true, + Description: "The type of the DNS resolver used for the VPC.- `delegated`: DNS server addresses are provided by the DNS resolver of the VPC specified in `dns.resolver.vpc`.- `manual`: DNS server addresses are specified in `dns.resolver.manual_servers`.- `system`: DNS server addresses are provided by the system.", + }, + "vpc_id": &schema.Schema{ + Type: schema.TypeString, + Optional: true, + DiffSuppressFunc: suppressNullVPC, + ConflictsWith: []string{"dns.0.resolver.0.vpc_crn"}, + Description: "The VPC id whose DNS resolver provides the DNS server addresses for this VPC.The VPC may be remote and therefore may not be directly retrievable.", + }, + "vpc_name": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The VPC name whose DNS resolver provides the DNS server addresses for this VPC.The VPC may be remote and therefore may not be directly retrievable.", + }, + "vpc_crn": &schema.Schema{ + Type: schema.TypeString, + Optional: true, + DiffSuppressFunc: suppressNullVPC, + + ConflictsWith: []string{"dns.0.resolver.0.vpc_id"}, + Description: "The VPC crn whose DNS resolver provides the DNS server addresses for this VPC.The VPC may be remote and therefore may not be directly retrievable.", + }, + "vpc_remote_account_id": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The unique identifier for this account.", + }, + "vpc_remote_region": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "Region name. If present, this property indicates that the referenced resource is remote to this region, and identifies the native region.", + }, + isVPCDnsResolverManualServers: &schema.Schema{ + Type: schema.TypeSet, + Optional: true, + Computed: true, + Set: hashManualServersList, + Description: "The manually specified DNS servers for this VPC.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + isVPCDnsResolverManualServersAddress: &schema.Schema{ + Type: schema.TypeString, + Optional: true, + Computed: true, + Description: "The IP address.This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.", + }, + isVPCDnsResolverManualServersZoneAffinity: &schema.Schema{ + Type: schema.TypeString, + Optional: true, + Computed: true, + Description: "The name of the zone. If present, DHCP configuration for this zone will have this DNS server listed first.", + }, + }, + }, + }, + isVPCDnsResolverConfiguration: &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The configuration of the system DNS resolver for this VPC.- `custom_resolver`: A custom DNS resolver is configured for this VPC.- `private_resolver`: A private DNS resolver is configured for this VPC. Applicable when the VPC has either or both of the following: - at least one endpoint gateway residing in it - a [DNS Services](https://cloud.ibm.com/docs/dns-svcs) private zone configured for it- `default`: The provider default DNS resolvers are configured for this VPC. This system DNS resolver configuration is used when the VPC has: - no custom DNS resolver configured for it, and - no endpoint gateways residing in it, and - no [DNS Services](https://cloud.ibm.com/docs/dns-svcs) private zone configured for it.", + }, + }, + }, + }, + }, + }, + }, + "health_reasons": &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "The reasons for the current `health_state` (if any).The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "code": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "A snake case string succinctly identifying the reason for this health state.", + }, + "message": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "An explanation of the reason for this health state.", + }, + "more_info": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "Link to documentation about the reason for this health state.", + }, + }, + }, + }, + "health_state": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The health of this resource.- `ok`: No abnormal behavior detected- `degraded`: Experiencing compromised performance, capacity, or connectivity- `faulted`: Completely unreachable, inoperative, or otherwise entirely incapacitated- `inapplicable`: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of `failed` or `deleting` will have a health state of `inapplicable`. A `pending` resource may also have this state.", + }, isVPCClassicAccess: { Type: schema.TypeBool, ForceNew: true, @@ -502,6 +673,13 @@ func vpcCreate(d *schema.ResourceData, meta interface{}, name, apm, rg string, i options := &vpcv1.CreateVPCOptions{ Name: &name, } + if _, ok := d.GetOk(isVPCDns); ok { + dnsModel, err := resourceIBMIsVPCMapToVpcdnsPrototype(d.Get("dns.0").(map[string]interface{})) + if err != nil { + return err + } + options.SetDns(dnsModel) + } if rg != "" { options.ResourceGroup = &vpcv1.ResourceGroupIdentity{ ID: &rg, @@ -717,6 +895,35 @@ func vpcGet(d *schema.ResourceData, meta interface{}, id string) error { d.Set(isVPCDefaultRoutingTable, *vpc.DefaultRoutingTable.ID) d.Set(isVPCDefaultRoutingTableName, *vpc.DefaultRoutingTable.Name) } + healthReasons := []map[string]interface{}{} + if vpc.HealthReasons != nil { + for _, modelItem := range vpc.HealthReasons { + modelMap, err := dataSourceIBMIsVPCVPCHealthReasonToMap(&modelItem) + if err != nil { + return err + } + healthReasons = append(healthReasons, modelMap) + } + } + if err = d.Set("health_reasons", healthReasons); err != nil { + return fmt.Errorf("[ERROR] Error setting health_reasons %s", err) + } + + if err = d.Set("health_state", vpc.HealthState); err != nil { + return fmt.Errorf("[ERROR] Error setting health_state: %s", err) + } + if !core.IsNil(vpc.Dns) { + vpcCrn := d.Get("dns.0.resolver.0.vpc_crn").(string) + vpcId := d.Get("dns.0.resolver.0.vpc_id").(string) + + dnsMap, err := resourceIBMIsVPCVpcdnsToMap(vpc.Dns, vpcId, vpcCrn) + if err != nil { + return err + } + if err = d.Set(isVPCDns, []map[string]interface{}{dnsMap}); err != nil { + return fmt.Errorf("[ERROR] Error setting dns: %s", err) + } + } tags, err := flex.GetGlobalTagsUsingCRN(meta, *vpc.CRN, "", isVPCUserTagType) if err != nil { log.Printf( @@ -733,6 +940,7 @@ func vpcGet(d *schema.ResourceData, meta interface{}, id string) error { if err != nil { return err } + d.Set(isVPCCRN, *vpc.CRN) d.Set(flex.ResourceControllerURL, controller+"/vpc-ext/network/vpcs") d.Set(flex.ResourceName, *vpc.Name) @@ -748,7 +956,7 @@ func vpcGet(d *schema.ResourceData, meta interface{}, id string) error { for _, sourceIP := range vpc.CseSourceIps { currentCseSourceIp := map[string]interface{}{} if sourceIP.IP != nil { - currentCseSourceIp["address"] = *sourceIP.IP.Address + currentCseSourceIp[isVPCDnsResolverManualServersAddress] = *sourceIP.IP.Address currentCseSourceIp["zone_name"] = *sourceIP.Zone.Name cseSourceIpsList = append(cseSourceIpsList, currentCseSourceIp) } @@ -933,6 +1141,7 @@ func vpcUpdate(d *schema.ResourceData, meta interface{}, id, name string, hasCha if err != nil { return err } + if d.HasChange(isVPCTags) { getvpcOptions := &vpcv1.GetVPCOptions{ ID: &id, @@ -979,22 +1188,151 @@ func vpcUpdate(d *schema.ResourceData, meta interface{}, id, name string, hasCha nwaclNameUpdate(sess, d.Get(isVPCDefaultNetworkACL).(string), defaultACLName.(string)) } } + hasDnsChanged := false + isDnsResolverVPCIDNull := false + isDnsResolverVPCID := "" + isDnsResolverVPCCrn := "" + isDnsResolverVPCCrnNull := false + isDnsResolverManualServerChange := false + isDnsResolverManualServerEtag := "" + var dnsPatch *vpcv1.VpcdnsPatch + if d.HasChange(isVPCDns) { + dnsPatch = &vpcv1.VpcdnsPatch{} + if d.HasChange("dns.0.enable_hub") { + _, newEH := d.GetChange("dns.0.enable_hub") + dnsPatch.EnableHub = core.BoolPtr(newEH.(bool)) + } + if d.HasChange("dns.0.resolver") { + _, newResolver := d.GetChange("dns.0.resolver") + + if newResolver != nil && len(newResolver.([]interface{})) > 0 { + ResolverModel := &vpcv1.VpcdnsResolverPatch{} + if d.HasChange("dns.0.resolver.0.manual_servers") { + + // getting etag + getVpcOptions := &vpcv1.GetVPCOptions{ + ID: &id, + } + _, response, err := sess.GetVPC(getVpcOptions) + if err != nil { + return fmt.Errorf("[ERROR] Error Getting VPC (%s): %s\n%s", id, err, response) + } + isDnsResolverManualServerChange = true + isDnsResolverManualServerEtag = response.Headers.Get("ETag") // Getting Etag from the response headers. + + _, newResolverManualServers := d.GetChange("dns.0.resolver.0.manual_servers") - if hasChanged { + if newResolverManualServers != nil { + manualServers := []vpcv1.DnsServerPrototype{} + for _, manualServersItem := range newResolverManualServers.(*schema.Set).List() { + manualServersItemModel, err := resourceIBMIsVPCMapToDnsServerPrototype(manualServersItem.(map[string]interface{})) + if err != nil { + return err + } + manualServers = append(manualServers, *manualServersItemModel) + } + ResolverModel.ManualServers = manualServers + } + + } + if d.HasChange("dns.0.resolver.0.type") { + _, newResolverType := d.GetChange("dns.0.resolver.0.type") + if newResolverType != nil && newResolverType.(string) != "" { + ResolverModel.Type = core.StringPtr(newResolverType.(string)) + } + } + if d.HasChange("dns.0.resolver.0.vpc_id") { + _, newResolverVpc := d.GetChange("dns.0.resolver.0.vpc_id") + if newResolverVpc != nil && newResolverVpc.(string) != "" { + isDnsResolverVPCID = newResolverVpc.(string) + if isDnsResolverVPCID == "null" { + isDnsResolverVPCIDNull = true + var nullStringPtr *string + ResolverModel.VPC = &vpcv1.VpcdnsResolverVPCPatch{ + ID: nullStringPtr, + } + } else { + ResolverModel.VPC = &vpcv1.VpcdnsResolverVPCPatch{ + ID: &isDnsResolverVPCID, + } + } + } + } + if d.HasChange("dns.0.resolver.0.vpc_crn") { + _, newResolverVpc := d.GetChange("dns.0.resolver.0.vpc_crn") + if newResolverVpc != nil && newResolverVpc.(string) != "" { + isDnsResolverVPCCrn = newResolverVpc.(string) + if isDnsResolverVPCCrn == "null" { + isDnsResolverVPCCrnNull = true + var nullStringPtr *string + ResolverModel.VPC = &vpcv1.VpcdnsResolverVPCPatch{ + CRN: nullStringPtr, + } + } else { + ResolverModel.VPC = &vpcv1.VpcdnsResolverVPCPatch{ + CRN: &isDnsResolverVPCCrn, + } + } + } + } + dnsPatch.Resolver = ResolverModel + } + } + hasDnsChanged = true + } + if hasChanged || hasDnsChanged { updateVpcOptions := &vpcv1.UpdateVPCOptions{ ID: &id, } - vpcPatchModel := &vpcv1.VPCPatch{ - Name: &name, + vpcPatchModel := &vpcv1.VPCPatch{} + if hasChanged { + vpcPatchModel.Name = &name + } + if hasDnsChanged { + vpcPatchModel.Dns = dnsPatch + } + if isDnsResolverManualServerChange && isDnsResolverManualServerEtag != "" { + updateVpcOptions.IfMatch = &isDnsResolverManualServerEtag // if-Match or Etag Change for Patch } vpcPatch, err := vpcPatchModel.AsPatch() if err != nil { return fmt.Errorf("[ERROR] Error calling asPatch for VPCPatch: %s", err) } + if isDnsResolverVPCCrnNull || isDnsResolverVPCIDNull { + dnsMap := vpcPatch["dns"].(map[string]interface{}) + resolverMap := dnsMap["resolver"].(map[string]interface{}) + resolverMap["vpc"] = nil + dnsMap["resolver"] = resolverMap + vpcPatch["dns"] = dnsMap + } + updateVpcOptions.VPCPatch = vpcPatch _, response, err := sess.UpdateVPC(updateVpcOptions) if err != nil { - return fmt.Errorf("[ERROR] Error Updating VPC : %s\n%s", err, response) + responsestring := strings.ToLower(response.String()) + if strings.Contains(strings.ToLower(err.Error()), strings.ToLower("The supplied header is not supported for this request")) && strings.Contains(responsestring, "bad_header") && strings.Contains(responsestring, strings.ToLower("If-Match")) { + log.Printf("[DEBUG] retrying update vpc without If-Match") + updateVpcOptions.IfMatch = nil + _, nestedresponse, nestederr := sess.UpdateVPC(updateVpcOptions) + if nestederr != nil { + return fmt.Errorf("[ERROR] Error Updating VPC on retry : %s\n%s", nestederr, nestedresponse) + } + } else { + return fmt.Errorf("[ERROR] Error Updating VPC : %s\n%s", err, response) + } + } + if isDnsResolverVPCCrnNull || isDnsResolverVPCIDNull { + + dnsList := make([]map[string]interface{}, 0) + currentDns := map[string]interface{}{} + currentResolverList := make([]map[string]interface{}, 0) + currentResolver := map[string]interface{}{} + currentResolver["vpc_id"] = isDnsResolverVPCID + currentResolver["vpc_crn"] = isDnsResolverVPCCrn + currentResolverList = append(currentResolverList, currentResolver) + currentDns["resolver"] = currentResolverList + dnsList = append(dnsList, currentDns) + d.Set("dns", dnsList) } } return nil @@ -1170,3 +1508,276 @@ func suppressNullAddPrefix(k, old, new string, d *schema.ResourceData) bool { } return false } + +func suppressNullVPC(k, old, new string, d *schema.ResourceData) bool { + if new != old && new == "null" && old == "" && d.Id() != "" { + return true + } + return false +} + +func hashManualServersList(v interface{}) int { + var buf bytes.Buffer + a := v.(map[string]interface{}) + buf.WriteString(fmt.Sprintf("%s-", a["address"].(string))) + buf.WriteString(fmt.Sprintf("%s-", a["zone_affinity"].(string))) + return conns.String(buf.String()) +} + +// for create dns +func resourceIBMIsVPCMapToVpcdnsPrototype(modelMap map[string]interface{}) (*vpcv1.VpcdnsPrototype, error) { + model := &vpcv1.VpcdnsPrototype{} + if modelMap["enable_hub"] != nil { + model.EnableHub = core.BoolPtr(modelMap["enable_hub"].(bool)) + } + if modelMap["resolver"] != nil && len(modelMap["resolver"].([]interface{})) > 0 { + ResolverModel, err := resourceIBMIsVPCMapToVpcdnsResolverPrototype(modelMap["resolver"].([]interface{})[0].(map[string]interface{})) + if err != nil { + return model, err + } + model.Resolver = ResolverModel + } + return model, nil +} + +func resourceIBMIsVPCMapToVpcdnsResolverPrototype(modelMap map[string]interface{}) (vpcv1.VpcdnsResolverPrototypeIntf, error) { + model := &vpcv1.VpcdnsResolverPrototype{} + if modelMap["type"] != nil && modelMap["type"].(string) != "" { + model.Type = core.StringPtr(modelMap["type"].(string)) + } + if modelMap["manual_servers"] != nil && modelMap["manual_servers"].(*schema.Set).Len() > 0 { + model.Type = core.StringPtr("manual") + manualServers := []vpcv1.DnsServerPrototype{} + for _, manualServersItem := range modelMap["manual_servers"].(*schema.Set).List() { + manualServersItemModel, err := resourceIBMIsVPCMapToDnsServerPrototype(manualServersItem.(map[string]interface{})) + if err != nil { + return model, err + } + manualServers = append(manualServers, *manualServersItemModel) + } + model.ManualServers = manualServers + } + return model, nil +} + +func resourceIBMIsVPCMapToDnsServerPrototype(modelMap map[string]interface{}) (*vpcv1.DnsServerPrototype, error) { + model := &vpcv1.DnsServerPrototype{} + model.Address = core.StringPtr(modelMap["address"].(string)) + if modelMap[isVPCDnsResolverManualServersZoneAffinity] != nil && modelMap[isVPCDnsResolverManualServersZoneAffinity].(string) != "" { + ZoneAffinityModel := &vpcv1.ZoneIdentity{ + Name: core.StringPtr(modelMap[isVPCDnsResolverManualServersZoneAffinity].(string)), + } + model.ZoneAffinity = ZoneAffinityModel + } + return model, nil +} + +// for dns read + +func resourceIBMIsVPCVpcdnsToMap(model *vpcv1.Vpcdns, vpcId, vpcCrn string) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + modelMap["enable_hub"] = model.EnableHub + modelMap["resolution_binding_count"] = flex.IntValue(model.ResolutionBindingCount) + resolverMap, err := resourceIBMIsVPCVpcdnsResolverToMap(model.Resolver, vpcId, vpcCrn) + if err != nil { + return modelMap, err + } + modelMap["resolver"] = []map[string]interface{}{resolverMap} + return modelMap, nil +} + +func resourceIBMIsVPCVpcdnsResolverToMap(model vpcv1.VpcdnsResolverIntf, vpcId, vpcCrn string) (map[string]interface{}, error) { + if _, ok := model.(*vpcv1.VpcdnsResolverTypeDelegated); ok { + return resourceIBMIsVPCVpcdnsResolverTypeDelegatedToMap(model.(*vpcv1.VpcdnsResolverTypeDelegated), vpcId, vpcCrn) + } else if _, ok := model.(*vpcv1.VpcdnsResolverTypeManual); ok { + return resourceIBMIsVPCVpcdnsResolverTypeManualToMap(model.(*vpcv1.VpcdnsResolverTypeManual), vpcId, vpcCrn) + } else if _, ok := model.(*vpcv1.VpcdnsResolverTypeSystem); ok { + return resourceIBMIsVPCVpcdnsResolverTypeSystemToMap(model.(*vpcv1.VpcdnsResolverTypeSystem), vpcId, vpcCrn) + } else if _, ok := model.(*vpcv1.VpcdnsResolver); ok { + modelMap := make(map[string]interface{}) + model := model.(*vpcv1.VpcdnsResolver) + servers := []map[string]interface{}{} + for _, serversItem := range model.Servers { + serversItemMap, err := resourceIBMIsVPCDnsServerToMap(&serversItem) + if err != nil { + return modelMap, err + } + servers = append(servers, serversItemMap) + } + modelMap["servers"] = servers + modelMap["type"] = model.Type + if model.VPC != nil { + modelMap["vpc_id"] = vpcId + modelMap["vpc_crn"] = vpcCrn + modelMap["vpc_name"] = *model.VPC.Name + if model.VPC.Remote != nil { + if model.VPC.Remote.Account != nil { + modelMap["vpc_remote_account_id"] = *model.VPC.Remote.Account.ID + } + if model.VPC.Remote.Region != nil { + modelMap["vpc_remote_region"] = *model.VPC.Remote.Region.Name + } + } + + } + + if model.ManualServers != nil { + manualServers := []map[string]interface{}{} + for _, manualServersItem := range model.ManualServers { + manualServersItemMap, err := resourceIBMIsVPCDnsServerToMap(&manualServersItem) + if err != nil { + return modelMap, err + } + manualServers = append(manualServers, manualServersItemMap) + } + modelMap["manual_servers"] = manualServers + } + if model.Configuration != nil { + modelMap["configuration"] = model.Configuration + } + return modelMap, nil + } else { + return nil, fmt.Errorf("Unrecognized vpcv1.VpcdnsResolverIntf subtype encountered") + } +} + +func resourceIBMIsVPCDnsServerToMap(model *vpcv1.DnsServer) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + modelMap["address"] = model.Address + if model.ZoneAffinity != nil { + zoneAffinity := *model.ZoneAffinity.Name + modelMap["zone_affinity"] = zoneAffinity + } + return modelMap, nil +} + +func resourceIBMIsVPCVpcdnsResolverTypeDelegatedToMap(model *vpcv1.VpcdnsResolverTypeDelegated, vpcId, vpcCrn string) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + servers := []map[string]interface{}{} + for _, serversItem := range model.Servers { + serversItemMap, err := resourceIBMIsVPCDnsServerToMap(&serversItem) + if err != nil { + return modelMap, err + } + servers = append(servers, serversItemMap) + } + modelMap["servers"] = servers + modelMap["type"] = model.Type + if model.VPC != nil { + modelMap["vpc_id"] = vpcId + modelMap["vpc_crn"] = vpcCrn + modelMap["vpc_name"] = *model.VPC.Name + if model.VPC.Remote != nil { + if model.VPC.Remote.Account != nil { + modelMap["vpc_remote_account_id"] = *model.VPC.Remote.Account.ID + } + if model.VPC.Remote.Region != nil { + modelMap["vpc_remote_region"] = *model.VPC.Remote.Region.Name + } + } + } + return modelMap, nil +} + +func resourceIBMIsVPCVpcdnsResolverTypeManualToMap(model *vpcv1.VpcdnsResolverTypeManual, vpcId, vpcCrn string) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + servers := []map[string]interface{}{} + for _, serversItem := range model.Servers { + serversItemMap, err := resourceIBMIsVPCDnsServerToMap(&serversItem) + if err != nil { + return modelMap, err + } + servers = append(servers, serversItemMap) + } + modelMap["servers"] = servers + manualServers := []map[string]interface{}{} + for _, manualServersItem := range model.ManualServers { + manualServersItemMap, err := resourceIBMIsVPCDnsServerToMap(&manualServersItem) + if err != nil { + return modelMap, err + } + manualServers = append(manualServers, manualServersItemMap) + } + modelMap["manual_servers"] = manualServers + modelMap["type"] = model.Type + if vpcId != "" { + modelMap["vpc_id"] = vpcId + } + if vpcCrn != "" { + modelMap["vpc_crn"] = vpcCrn + } + return modelMap, nil +} + +func resourceIBMIsVPCVpcdnsResolverTypeSystemToMap(model *vpcv1.VpcdnsResolverTypeSystem, vpcId, vpcCrn string) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + servers := []map[string]interface{}{} + for _, serversItem := range model.Servers { + serversItemMap, err := resourceIBMIsVPCDnsServerToMap(&serversItem) + if err != nil { + return modelMap, err + } + servers = append(servers, serversItemMap) + } + modelMap["servers"] = servers + modelMap["configuration"] = model.Configuration + modelMap["type"] = model.Type + if vpcId != "" { + modelMap["vpc_id"] = vpcId + } + if vpcCrn != "" { + modelMap["vpc_crn"] = vpcCrn + } + return modelMap, nil +} + +func resourceIBMIsVPCVPCReferenceDnsResolverContextToMap(model *vpcv1.VPCReferenceDnsResolverContext) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + modelMap["crn"] = model.CRN + if model.Deleted != nil { + deletedMap, err := resourceIBMIsVPCVPCReferenceDnsResolverContextDeletedToMap(model.Deleted) + if err != nil { + return modelMap, err + } + modelMap["deleted"] = []map[string]interface{}{deletedMap} + } + modelMap["href"] = model.Href + modelMap["id"] = model.ID + modelMap["name"] = model.Name + if model.Remote != nil { + remoteMap, err := resourceIBMIsVPCVPCRemoteToMap(model.Remote) + if err != nil { + return modelMap, err + } + modelMap["remote"] = []map[string]interface{}{remoteMap} + } + modelMap["resource_type"] = model.ResourceType + return modelMap, nil +} + +func resourceIBMIsVPCVPCReferenceDnsResolverContextDeletedToMap(model *vpcv1.VPCReferenceDnsResolverContextDeleted) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + modelMap["more_info"] = model.MoreInfo + return modelMap, nil +} + +func resourceIBMIsVPCVPCRemoteToMap(model *vpcv1.VPCRemote) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + if model.Account != nil { + accountMap, err := resourceIBMIsVPCAccountReferenceToMap(model.Account) + if err != nil { + return modelMap, err + } + modelMap["account"] = []map[string]interface{}{accountMap} + } + if model.Region != nil { + modelMap["region"] = model.Region.Name + } + return modelMap, nil +} +func resourceIBMIsVPCAccountReferenceToMap(model *vpcv1.AccountReference) (map[string]interface{}, error) { + modelMap := make(map[string]interface{}) + modelMap["id"] = model.ID + modelMap["resource_type"] = model.ResourceType + return modelMap, nil +} diff --git a/ibm/service/vpc/resource_ibm_is_vpc_dns_resolution_binding.go b/ibm/service/vpc/resource_ibm_is_vpc_dns_resolution_binding.go new file mode 100644 index 0000000000..3ec4a1ff60 --- /dev/null +++ b/ibm/service/vpc/resource_ibm_is_vpc_dns_resolution_binding.go @@ -0,0 +1,432 @@ +// Copyright IBM Corp. 2023 All Rights Reserved. +// Licensed under the Mozilla Public License v2.0 + +package vpc + +import ( + "context" + "fmt" + "log" + "strings" + + "github.com/hashicorp/terraform-plugin-sdk/v2/diag" + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" + + "github.com/IBM-Cloud/terraform-provider-ibm/ibm/flex" + "github.com/IBM/vpc-go-sdk/vpcv1" +) + +func ResourceIBMIsVPCDnsResolutionBinding() *schema.Resource { + return &schema.Resource{ + CreateContext: resourceIBMIsVPCDnsResolutionBindingCreate, + ReadContext: resourceIBMIsVPCDnsResolutionBindingRead, + UpdateContext: resourceIBMIsVPCDnsResolutionBindingUpdate, + DeleteContext: resourceIBMIsVPCDnsResolutionBindingDelete, + Importer: &schema.ResourceImporter{}, + + Schema: map[string]*schema.Schema{ + "vpc_id": &schema.Schema{ + Type: schema.TypeString, + Required: true, + Description: "The VPC identifier.", + }, + "created_at": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The date and time that the DNS resolution binding was created.", + }, + "endpoint_gateways": &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "The endpoint gateways in the bound to VPC that are allowed to participate in this DNS resolution binding.The endpoint gateways may be remote and therefore may not be directly retrievable.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "crn": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The CRN for this endpoint gateway.", + }, + "href": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The URL for this endpoint gateway.", + }, + "id": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The unique identifier for this endpoint gateway.", + }, + "name": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The name for this endpoint gateway. The name is unique across all endpoint gateways in the VPC.", + }, + "remote": &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "account": &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "If present, this property indicates that the referenced resource is remote to thisaccount, and identifies the owning account.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "id": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The unique identifier for this account.", + }, + "resource_type": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The resource type.", + }, + }, + }, + }, + "region": &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "href": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The URL for this region.", + }, + "name": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The globally unique name for this region.", + }, + }, + }, + }, + }, + }, + }, + "resource_type": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The resource type.", + }, + }, + }, + }, + "href": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The URL for this DNS resolution binding.", + }, + "lifecycle_state": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The lifecycle state of the DNS resolution binding.", + }, + "name": &schema.Schema{ + Type: schema.TypeString, + Optional: true, + Computed: true, + Description: "The name for this DNS resolution binding. The name is unique across all DNS resolution bindings for the VPC.", + }, + "resource_type": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The resource type.", + }, + "vpc": &schema.Schema{ + Type: schema.TypeList, + Required: true, + ForceNew: true, + MaxItems: 1, + MinItems: 1, + Description: "The VPC bound to for DNS resolution.The VPC may be remote and therefore may not be directly retrievable.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "crn": &schema.Schema{ + Optional: true, + ExactlyOneOf: []string{"vpc.0.id", "vpc.0.href", "vpc.0.crn"}, + Type: schema.TypeString, + Computed: true, + Description: "The CRN for this VPC.", + }, + "href": &schema.Schema{ + Type: schema.TypeString, + ExactlyOneOf: []string{"vpc.0.id", "vpc.0.href", "vpc.0.crn"}, + Optional: true, + Computed: true, + Description: "The URL for this VPC.", + }, + "id": &schema.Schema{ + Type: schema.TypeString, + ExactlyOneOf: []string{"vpc.0.id", "vpc.0.href", "vpc.0.crn"}, + Optional: true, + Computed: true, + Description: "The unique identifier for this VPC.", + }, + "name": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The name for this VPC. The name is unique across all VPCs in the region.", + }, + "remote": &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "account": &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "If present, this property indicates that the referenced resource is remote to thisaccount, and identifies the owning account.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "id": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The unique identifier for this account.", + }, + "resource_type": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The resource type.", + }, + }, + }, + }, + "region": &schema.Schema{ + Type: schema.TypeList, + Computed: true, + Description: "If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region.", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "href": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The URL for this region.", + }, + "name": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The globally unique name for this region.", + }, + }, + }, + }, + }, + }, + }, + "resource_type": &schema.Schema{ + Type: schema.TypeString, + Computed: true, + Description: "The resource type.", + }, + }, + }, + }, + }, + } +} + +func resourceIBMIsVPCDnsResolutionBindingCreate(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { + sess, err := vpcClient(meta) + if err != nil { + return diag.FromErr(err) + } + spokeVPCID := d.Get("vpc_id").(string) + createVPCDnsResolutionBindingOptions := &vpcv1.CreateVPCDnsResolutionBindingOptions{} + vpchref := d.Get("vpc.0.href").(string) + vpccrn := d.Get("vpc.0.crn").(string) + vpcid := d.Get("vpc.0.id").(string) + + createVPCDnsResolutionBindingOptions.SetVPCID(spokeVPCID) + if d.Get("name").(string) != "" { + createVPCDnsResolutionBindingOptions.SetName(d.Get("name").(string)) + } + if vpchref != "" { + vPCIdentityIntf := &vpcv1.VPCIdentityByHref{ + Href: &vpchref, + } + createVPCDnsResolutionBindingOptions.SetVPC(vPCIdentityIntf) + } else if vpcid != "" { + vPCIdentityIntf := &vpcv1.VPCIdentityByID{ + ID: &vpcid, + } + createVPCDnsResolutionBindingOptions.SetVPC(vPCIdentityIntf) + } else { + vPCIdentityIntf := &vpcv1.VPCIdentityByCRN{ + CRN: &vpccrn, + } + createVPCDnsResolutionBindingOptions.SetVPC(vPCIdentityIntf) + } + vpcdnsResolutionBinding, response, err := sess.CreateVPCDnsResolutionBindingWithContext(context, createVPCDnsResolutionBindingOptions) + if err != nil { + log.Printf("[DEBUG] CreateVPCDnsResolutionBindingWithContext failed %s\n%s", err, response) + return diag.FromErr(fmt.Errorf("CreateVPCDnsResolutionBindingWithContext failed %s\n%s", err, response)) + } + d.SetId(MakeTerraformVPCDNSID(spokeVPCID, *vpcdnsResolutionBinding.ID)) + + err = resourceIBMIsVPCDnsResolutionBindingGet(vpcdnsResolutionBinding, d) + if err != nil { + return diag.FromErr(err) + } + return nil +} +func resourceIBMIsVPCDnsResolutionBindingRead(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { + sess, err := vpcClient(meta) + if err != nil { + return diag.FromErr(err) + } + vpcId, id, err := ParseVPCDNSTerraformID(d.Id()) + if err != nil { + return diag.FromErr(err) + } + getVPCDnsResolutionBindingOptions := &vpcv1.GetVPCDnsResolutionBindingOptions{} + + getVPCDnsResolutionBindingOptions.SetVPCID(vpcId) + getVPCDnsResolutionBindingOptions.SetID(id) + + vpcdnsResolutionBinding, response, err := sess.GetVPCDnsResolutionBindingWithContext(context, getVPCDnsResolutionBindingOptions) + if err != nil { + log.Printf("[DEBUG] GetVPCDnsResolutionBindingWithContext failed %s\n%s", err, response) + if response.StatusCode != 404 { + return diag.FromErr(fmt.Errorf("GetVPCDnsResolutionBindingWithContext failed %s\n%s", err, response)) + } else { + d.SetId("") + return nil + } + } + err = resourceIBMIsVPCDnsResolutionBindingGet(vpcdnsResolutionBinding, d) + if err != nil { + return diag.FromErr(err) + } + return nil +} +func resourceIBMIsVPCDnsResolutionBindingGet(vpcdnsResolutionBinding *vpcv1.VpcdnsResolutionBinding, d *schema.ResourceData) error { + if err := d.Set("created_at", flex.DateTimeToString(vpcdnsResolutionBinding.CreatedAt)); err != nil { + return fmt.Errorf("[ERROR] Error setting created_at: %s", err) + } + + endpointGateways := []map[string]interface{}{} + if vpcdnsResolutionBinding.EndpointGateways != nil { + for _, modelItem := range vpcdnsResolutionBinding.EndpointGateways { + modelMap, err := dataSourceIBMIsVPCDnsResolutionBindingEndpointGatewayReferenceRemoteToMap(&modelItem) + if err != nil { + return err + } + endpointGateways = append(endpointGateways, modelMap) + } + } + if err := d.Set("endpoint_gateways", endpointGateways); err != nil { + return fmt.Errorf("[ERROR] Error setting endpoint_gateways %s", err) + } + + if err := d.Set("href", vpcdnsResolutionBinding.Href); err != nil { + return fmt.Errorf("[ERROR] Error setting href: %s", err) + } + + if err := d.Set("lifecycle_state", vpcdnsResolutionBinding.LifecycleState); err != nil { + return fmt.Errorf("[ERROR] Error setting lifecycle_state: %s", err) + } + + if err := d.Set("name", vpcdnsResolutionBinding.Name); err != nil { + return fmt.Errorf("[ERROR] Error setting name: %s", err) + } + + if err := d.Set("resource_type", vpcdnsResolutionBinding.ResourceType); err != nil { + return fmt.Errorf("[ERROR] Error setting resource_type: %s", err) + } + + vpc := []map[string]interface{}{} + if vpcdnsResolutionBinding.VPC != nil { + modelMap, err := dataSourceIBMIsVPCDnsResolutionBindingVPCReferenceRemoteToMap(vpcdnsResolutionBinding.VPC) + if err != nil { + return err + } + vpc = append(vpc, modelMap) + } + if err := d.Set("vpc", vpc); err != nil { + return fmt.Errorf("[ERROR] Error setting vpc %s", err) + } + return nil +} +func resourceIBMIsVPCDnsResolutionBindingUpdate(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { + sess, err := vpcClient(meta) + if err != nil { + return diag.FromErr(err) + } + vpcId, id, err := ParseVPCDNSTerraformID(d.Id()) + if err != nil { + return diag.FromErr(err) + } + if d.HasChange(isVPCDnsResolutionBindingName) { + nameChange := d.Get(isVPCDnsResolutionBindingName).(string) + vpcdnsResolutionBindingPatch := &vpcv1.VpcdnsResolutionBindingPatch{ + Name: &nameChange, + } + vpcdnsResolutionBindingPatchAsPatch, err := vpcdnsResolutionBindingPatch.AsPatch() + if err != nil { + return diag.FromErr(err) + } + updateVPCDnsResolutionBindingOptions := &vpcv1.UpdateVPCDnsResolutionBindingOptions{} + + updateVPCDnsResolutionBindingOptions.SetVPCID(vpcId) + updateVPCDnsResolutionBindingOptions.SetID(id) + updateVPCDnsResolutionBindingOptions.SetVpcdnsResolutionBindingPatch(vpcdnsResolutionBindingPatchAsPatch) + + vpcdnsResolutionBinding, response, err := sess.UpdateVPCDnsResolutionBindingWithContext(context, updateVPCDnsResolutionBindingOptions) + if err != nil { + log.Printf("[DEBUG] UpdateVPCDnsResolutionBindingWithContext failed %s\n%s", err, response) + return diag.FromErr(fmt.Errorf("UpdateVPCDnsResolutionBindingWithContext failed %s\n%s", err, response)) + } + err = resourceIBMIsVPCDnsResolutionBindingGet(vpcdnsResolutionBinding, d) + if err != nil { + return diag.FromErr(err) + } + } + + return nil +} +func resourceIBMIsVPCDnsResolutionBindingDelete(context context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics { + sess, err := vpcClient(meta) + if err != nil { + return diag.FromErr(err) + } + vpcId, id, err := ParseVPCDNSTerraformID(d.Id()) + if err != nil { + return diag.FromErr(err) + } + deleteVPCDnsResolutionBindingOptions := &vpcv1.DeleteVPCDnsResolutionBindingOptions{} + + deleteVPCDnsResolutionBindingOptions.SetVPCID(vpcId) + deleteVPCDnsResolutionBindingOptions.SetID(id) + + response, err := sess.DeleteVPCDnsResolutionBindingWithContext(context, deleteVPCDnsResolutionBindingOptions) + if err != nil { + log.Printf("[DEBUG] DeleteVPCDnsResolutionBindingWithContext failed %s\n%s", err, response) + if response.StatusCode != 404 { + return diag.FromErr(fmt.Errorf("DeleteVPCDnsResolutionBindingWithContext failed %s\n%s", err, response)) + } + } + d.SetId("") + return nil +} +func MakeTerraformVPCDNSID(id1, id2 string) string { + // Include both vpc id and binding id to create a unique Terraform id. As a bonus, + // we can extract the bindings as needed for API calls such as READ. + return fmt.Sprintf("%s/%s", id1, id2) +} + +func ParseVPCDNSTerraformID(s string) (string, string, error) { + segments := strings.Split(s, "/") + if len(segments) != 2 { + return "", "", fmt.Errorf("invalid terraform Id %s (incorrect number of segments)", s) + } + if segments[0] == "" || segments[1] == "" { + return "", "", fmt.Errorf("invalid terraform Id %s (one or more empty segments)", s) + } + return segments[0], segments[1], nil +} diff --git a/ibm/service/vpc/resource_ibm_is_vpc_dns_resolution_binding_test.go b/ibm/service/vpc/resource_ibm_is_vpc_dns_resolution_binding_test.go new file mode 100644 index 0000000000..c4dad92fb4 --- /dev/null +++ b/ibm/service/vpc/resource_ibm_is_vpc_dns_resolution_binding_test.go @@ -0,0 +1,65 @@ +// Copyright IBM Corp. 2023 All Rights Reserved. +// Licensed under the Mozilla Public License v2.0 + +package vpc_test + +import ( + "fmt" + "testing" + + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/acctest" + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource" + + acc "github.com/IBM-Cloud/terraform-provider-ibm/ibm/acctest" +) + +func TestAccIBMIsVPCDnsResolutionBindingResourceBasic(t *testing.T) { + vpcname1 := fmt.Sprintf("tf-vpc-%d", acctest.RandIntRange(10, 100)) + enable_hub1 := true + vpcname2 := fmt.Sprintf("tf-vpc-%d", acctest.RandIntRange(10, 100)) + bindingname := fmt.Sprintf("tf-vpc-dns-binding-%d", acctest.RandIntRange(10, 100)) + enable_hub2 := false + resource.Test(t, resource.TestCase{ + PreCheck: func() { acc.TestAccPreCheck(t) }, + Providers: acc.TestAccProviders, + Steps: []resource.TestStep{ + resource.TestStep{ + Config: testAccCheckIBMIsVPCDnsResolutionBindingResourceConfigBasic(vpcname1, vpcname2, bindingname, enable_hub1, enable_hub2), + Check: resource.ComposeTestCheckFunc( + resource.TestCheckResourceAttrSet("ibm_is_vpc_dns_resolution_binding.is_vpc_dns_resolution_binding", "id"), + resource.TestCheckResourceAttrSet("ibm_is_vpc_dns_resolution_binding.is_vpc_dns_resolution_binding", "vpc_id"), + resource.TestCheckResourceAttrSet("ibm_is_vpc_dns_resolution_binding.is_vpc_dns_resolution_binding", "created_at"), + resource.TestCheckResourceAttrSet("ibm_is_vpc_dns_resolution_binding.is_vpc_dns_resolution_binding", "href"), + resource.TestCheckResourceAttrSet("ibm_is_vpc_dns_resolution_binding.is_vpc_dns_resolution_binding", "lifecycle_state"), + resource.TestCheckResourceAttrSet("ibm_is_vpc_dns_resolution_binding.is_vpc_dns_resolution_binding", "name"), + resource.TestCheckResourceAttrSet("ibm_is_vpc_dns_resolution_binding.is_vpc_dns_resolution_binding", "resource_type"), + resource.TestCheckResourceAttrSet("ibm_is_vpc_dns_resolution_binding.is_vpc_dns_resolution_binding", "vpc.#"), + ), + }, + }, + }) +} + +func testAccCheckIBMIsVPCDnsResolutionBindingResourceConfigBasic(vpcname1, vpcname2, bindingname string, enablehub1, enablehub2 bool) string { + return fmt.Sprintf(` + resource ibm_is_vpc testacc_vpc1 { + name = "%s" + dns { + enable_hub = %t + } + } + resource ibm_is_vpc testacc_vpc2 { + name = "%s" + dns { + enable_hub = %t + } + } + resource ibm_is_vpc_dns_resolution_binding is_vpc_dns_resolution_binding { + name = "%s" + vpc_id= ibm_is_vpc.testacc_vpc2.id + vpc { + id = ibm_is_vpc.testacc_vpc1.id + } + } + `, vpcname1, enablehub1, vpcname2, enablehub2, bindingname) +} diff --git a/ibm/service/vpc/resource_ibm_is_vpc_test.go b/ibm/service/vpc/resource_ibm_is_vpc_test.go index 392b760153..6f9cc88a66 100644 --- a/ibm/service/vpc/resource_ibm_is_vpc_test.go +++ b/ibm/service/vpc/resource_ibm_is_vpc_test.go @@ -69,6 +69,235 @@ func TestAccIBMISVPC_basic(t *testing.T) { }, }) } +func TestAccIBMISVPC_dns_manual(t *testing.T) { + var vpc string + name1 := fmt.Sprintf("terraformvpcuat-%d", acctest.RandIntRange(10, 100)) + name2 := fmt.Sprintf("terraformvpcuat-%d", acctest.RandIntRange(10, 100)) + enableHubTrue := true + server1Add := "192.168.3.4" + server2Add := "192.168.0.4" + resource.Test(t, resource.TestCase{ + PreCheck: func() { acc.TestAccPreCheck(t) }, + Providers: acc.TestAccProviders, + CheckDestroy: testAccCheckIBMISVPCDestroy, + Steps: []resource.TestStep{ + { + Config: testAccCheckIBMISVPCDnsManualConfig(name1, server1Add, enableHubTrue), + Check: resource.ComposeTestCheckFunc( + testAccCheckIBMISVPCExists("ibm_is_vpc.testacc_vpc1", vpc), + resource.TestCheckResourceAttr( + "ibm_is_vpc.testacc_vpc1", "name", name1), + resource.TestCheckResourceAttr( + "ibm_is_vpc.testacc_vpc1", "dns.0.enable_hub", fmt.Sprintf("%t", enableHubTrue)), + resource.TestCheckResourceAttr( + "ibm_is_vpc.testacc_vpc1", "dns.0.resolver.0.type", "manual"), + resource.TestCheckResourceAttrSet( + "ibm_is_vpc.testacc_vpc1", "dns.0.resolver.#"), + resource.TestCheckResourceAttrSet( + "ibm_is_vpc.testacc_vpc1", "dns.0.resolver.0.servers.#"), + resource.TestCheckResourceAttr( + "ibm_is_vpc.testacc_vpc1", "dns.0.resolver.0.servers.#", "1"), + ), + }, + { + Config: testAccCheckIBMISVPCDnsManualConfigUpdate(name2, server1Add, server2Add, enableHubTrue), + Check: resource.ComposeTestCheckFunc( + testAccCheckIBMISVPCExists("ibm_is_vpc.testacc_vpc1", vpc), + resource.TestCheckResourceAttr( + "ibm_is_vpc.testacc_vpc1", "name", name2), + resource.TestCheckResourceAttr( + "ibm_is_vpc.testacc_vpc1", "dns.0.enable_hub", fmt.Sprintf("%t", enableHubTrue)), + resource.TestCheckResourceAttr( + "ibm_is_vpc.testacc_vpc1", "dns.0.resolver.0.type", "manual"), + resource.TestCheckResourceAttrSet( + "ibm_is_vpc.testacc_vpc1", "dns.0.resolver.#"), + resource.TestCheckResourceAttrSet( + "ibm_is_vpc.testacc_vpc1", "dns.0.resolver.0.servers.#"), + resource.TestCheckResourceAttr( + "ibm_is_vpc.testacc_vpc1", "dns.0.resolver.0.servers.#", "2"), + ), + }, + }, + }) +} +func TestAccIBMISVPC_dns_manual2(t *testing.T) { + var vpc string + name1 := fmt.Sprintf("terraformvpcuat-%d", acctest.RandIntRange(10, 100)) + name2 := fmt.Sprintf("terraformvpcuat-%d", acctest.RandIntRange(10, 100)) + enableHubTrue := true + server1Add := "192.168.3.4" + server2Add := "192.168.0.4" + server3Add := "192.168.128.4" + resource.Test(t, resource.TestCase{ + PreCheck: func() { acc.TestAccPreCheck(t) }, + Providers: acc.TestAccProviders, + CheckDestroy: testAccCheckIBMISVPCDestroy, + Steps: []resource.TestStep{ + { + Config: testAccCheckIBMISVPCDnsManual2Config(name1, server1Add, server2Add, server3Add, enableHubTrue), + Check: resource.ComposeTestCheckFunc( + testAccCheckIBMISVPCExists("ibm_is_vpc.testacc_vpc1", vpc), + resource.TestCheckResourceAttr( + "ibm_is_vpc.testacc_vpc1", "name", name1), + resource.TestCheckResourceAttr( + "ibm_is_vpc.testacc_vpc1", "dns.0.enable_hub", fmt.Sprintf("%t", enableHubTrue)), + resource.TestCheckResourceAttr( + "ibm_is_vpc.testacc_vpc1", "dns.0.resolver.0.type", "manual"), + resource.TestCheckResourceAttrSet( + "ibm_is_vpc.testacc_vpc1", "dns.0.resolver.#"), + resource.TestCheckResourceAttrSet( + "ibm_is_vpc.testacc_vpc1", "dns.0.resolver.0.servers.#"), + resource.TestCheckResourceAttr( + "ibm_is_vpc.testacc_vpc1", "dns.0.resolver.0.servers.#", "3"), + ), + }, + { + Config: testAccCheckIBMISVPCDnsManual2Config(name2, server1Add, server2Add, server3Add, enableHubTrue), + Check: resource.ComposeTestCheckFunc( + testAccCheckIBMISVPCExists("ibm_is_vpc.testacc_vpc1", vpc), + resource.TestCheckResourceAttr( + "ibm_is_vpc.testacc_vpc1", "name", name2), + resource.TestCheckResourceAttr( + "ibm_is_vpc.testacc_vpc1", "dns.0.enable_hub", fmt.Sprintf("%t", enableHubTrue)), + resource.TestCheckResourceAttr( + "ibm_is_vpc.testacc_vpc1", "dns.0.resolver.0.type", "manual"), + resource.TestCheckResourceAttrSet( + "ibm_is_vpc.testacc_vpc1", "dns.0.resolver.#"), + resource.TestCheckResourceAttrSet( + "ibm_is_vpc.testacc_vpc1", "dns.0.resolver.0.servers.#"), + resource.TestCheckResourceAttr( + "ibm_is_vpc.testacc_vpc1", "dns.0.resolver.0.servers.#", "3"), + ), + }, + }, + }) +} +func TestAccIBMISVPC_dns_system(t *testing.T) { + var vpc string + name1 := fmt.Sprintf("terraformvpcuat-%d", acctest.RandIntRange(10, 100)) + name2 := fmt.Sprintf("terraformvpcuat-%d", acctest.RandIntRange(10, 100)) + enableHubTrue := true + enableHubFalse := false + resource.Test(t, resource.TestCase{ + PreCheck: func() { acc.TestAccPreCheck(t) }, + Providers: acc.TestAccProviders, + CheckDestroy: testAccCheckIBMISVPCDestroy, + Steps: []resource.TestStep{ + { + Config: testAccCheckIBMISVPCDnsSystemConfig(name1, enableHubTrue), + Check: resource.ComposeTestCheckFunc( + testAccCheckIBMISVPCExists("ibm_is_vpc.testacc_vpc", vpc), + resource.TestCheckResourceAttr( + "ibm_is_vpc.testacc_vpc", "name", name1), + resource.TestCheckResourceAttr( + "ibm_is_vpc.testacc_vpc", "dns.0.enable_hub", fmt.Sprintf("%t", enableHubTrue)), + resource.TestCheckResourceAttr( + "ibm_is_vpc.testacc_vpc", "dns.0.resolver.0.type", "system"), + resource.TestCheckResourceAttrSet( + "ibm_is_vpc.testacc_vpc", "dns.0.resolver.#"), + ), + }, + { + Config: testAccCheckIBMISVPCDnsSystemConfig(name2, enableHubFalse), + Check: resource.ComposeTestCheckFunc( + testAccCheckIBMISVPCExists("ibm_is_vpc.testacc_vpc", vpc), + resource.TestCheckResourceAttr( + "ibm_is_vpc.testacc_vpc", "name", name2), + resource.TestCheckResourceAttr( + "ibm_is_vpc.testacc_vpc", "dns.0.enable_hub", fmt.Sprintf("%t", enableHubFalse)), + resource.TestCheckResourceAttr( + "ibm_is_vpc.testacc_vpc", "dns.0.resolver.0.type", "system"), + resource.TestCheckResourceAttrSet( + "ibm_is_vpc.testacc_vpc", "dns.0.resolver.#"), + ), + }, + }, + }) +} +func TestAccIBMISVPC_dns_delegated(t *testing.T) { + var vpc string + name1 := fmt.Sprintf("terraformvpcuat-%d", acctest.RandIntRange(10, 100)) + name2 := fmt.Sprintf("terraformvpcuat-%d", acctest.RandIntRange(10, 100)) + subnet1 := fmt.Sprintf("terraformsubnet-%d", acctest.RandIntRange(10, 100)) + subnet2 := fmt.Sprintf("terraformsubnet-%d", acctest.RandIntRange(10, 100)) + subnet3 := fmt.Sprintf("terraformsubnet-%d", acctest.RandIntRange(10, 100)) + subnet4 := fmt.Sprintf("terraformsubnet-%d", acctest.RandIntRange(10, 100)) + resourecinstance := fmt.Sprintf("terraformresource-%d", acctest.RandIntRange(10, 100)) + resolver1 := fmt.Sprintf("terraformresolver-%d", acctest.RandIntRange(10, 100)) + resolver2 := fmt.Sprintf("terraformresolver-%d", acctest.RandIntRange(10, 100)) + binding := fmt.Sprintf("terraformbinding-%d", acctest.RandIntRange(10, 100)) + enableHubTrue := true + enableHubFalse := false + resource.Test(t, resource.TestCase{ + PreCheck: func() { acc.TestAccPreCheck(t) }, + Providers: acc.TestAccProviders, + CheckDestroy: testAccCheckIBMISVPCDestroy, + Steps: []resource.TestStep{ + { + Config: testAccCheckIBMISVPCDnsDelegatedConfig(name1, name2, subnet1, subnet2, subnet3, subnet4, resourecinstance, resolver1, resolver2, binding, enableHubTrue, enableHubFalse), + Check: resource.ComposeTestCheckFunc( + testAccCheckIBMISVPCExists("ibm_is_vpc.hub_true", vpc), + resource.TestCheckResourceAttr( + "ibm_is_vpc.hub_true", "name", name1), + resource.TestCheckResourceAttr( + "ibm_is_vpc.hub_false_delegated", "name", name2), + resource.TestCheckResourceAttr( + "ibm_is_vpc.hub_true", "dns.0.enable_hub", fmt.Sprintf("%t", enableHubTrue)), + resource.TestCheckResourceAttr( + "ibm_is_vpc.hub_true", "dns.0.resolver.0.type", "system"), + resource.TestCheckResourceAttr( + "ibm_is_vpc.hub_false_delegated", "dns.0.enable_hub", fmt.Sprintf("%t", enableHubFalse)), + resource.TestCheckResourceAttr( + "ibm_is_vpc.hub_false_delegated", "dns.0.resolver.0.type", "system"), + ), + }, + { + Config: testAccCheckIBMISVPCDnsDelegatedUpdate1Config(name1, name2, subnet1, subnet2, subnet3, subnet4, resourecinstance, resolver1, resolver2, binding, enableHubTrue, enableHubFalse), + Check: resource.ComposeTestCheckFunc( + testAccCheckIBMISVPCExists("ibm_is_vpc.hub_true", vpc), + resource.TestCheckResourceAttr( + "ibm_is_vpc.hub_true", "name", name1), + resource.TestCheckResourceAttr( + "ibm_is_vpc.hub_false_delegated", "name", name2), + resource.TestCheckResourceAttr( + "ibm_is_vpc.hub_true", "dns.0.resolution_binding_count", "1"), + resource.TestCheckResourceAttr( + "ibm_is_vpc.hub_true", "dns.0.enable_hub", fmt.Sprintf("%t", enableHubTrue)), + resource.TestCheckResourceAttr( + "ibm_is_vpc.hub_true", "dns.0.resolver.0.type", "system"), + resource.TestCheckResourceAttr( + "ibm_is_vpc.hub_false_delegated", "dns.0.enable_hub", fmt.Sprintf("%t", enableHubFalse)), + resource.TestCheckResourceAttr( + "ibm_is_vpc.hub_false_delegated", "dns.0.resolver.0.type", "delegated"), + resource.TestCheckResourceAttr( + "ibm_is_vpc.hub_false_delegated", "dns.0.resolution_binding_count", "1"), + ), + }, + { + Config: testAccCheckIBMISVPCDnsDelegatedUpdate2Config(name1, name2, subnet1, subnet2, subnet3, subnet4, resourecinstance, resolver1, resolver2, binding, enableHubTrue, enableHubFalse), + Check: resource.ComposeTestCheckFunc( + testAccCheckIBMISVPCExists("ibm_is_vpc.hub_true", vpc), + resource.TestCheckResourceAttr( + "ibm_is_vpc.hub_true", "name", name1), + resource.TestCheckResourceAttr( + "ibm_is_vpc.hub_false_delegated", "name", name2), + resource.TestCheckResourceAttr( + "ibm_is_vpc.hub_true", "dns.0.enable_hub", fmt.Sprintf("%t", enableHubTrue)), + resource.TestCheckResourceAttr( + "ibm_is_vpc.hub_true", "dns.0.resolution_binding_count", "1"), + resource.TestCheckResourceAttr( + "ibm_is_vpc.hub_true", "dns.0.resolver.0.type", "system"), + resource.TestCheckResourceAttr( + "ibm_is_vpc.hub_false_delegated", "dns.0.enable_hub", fmt.Sprintf("%t", enableHubFalse)), + resource.TestCheckResourceAttr( + "ibm_is_vpc.hub_false_delegated", "dns.0.resolver.0.type", "system"), + resource.TestCheckResourceAttr( + "ibm_is_vpc.hub_false_delegated", "dns.0.resolution_binding_count", "1"), + ), + }, + }, + }) +} func TestAccIBMISVPC_basic_apm(t *testing.T) { var vpc string @@ -205,6 +434,363 @@ func testAccCheckIBMISVPCConfig(name string) string { tags = ["Tag1", "tag2"] }`, name) +} +func testAccCheckIBMISVPCDnsSystemConfig(name string, enableHub bool) string { + return fmt.Sprintf(` + resource "ibm_is_vpc" "testacc_vpc" { + name = "%s" + dns { + enable_hub = %t + } + }`, name, enableHub) + +} +func testAccCheckIBMISVPCDnsManualConfig(name, server1Add string, enableHub bool) string { + return fmt.Sprintf(` + resource "ibm_is_vpc" "testacc_vpc1" { + name = "%s" + dns { + enable_hub = %t + resolver { + manual_servers { + address = "%s" + } + } + } + } + `, name, enableHub, server1Add) + +} +func testAccCheckIBMISVPCDnsManualConfigUpdate(name, server1Add, server2Add string, enableHub bool) string { + return fmt.Sprintf(` + resource "ibm_is_vpc" "testacc_vpc1" { + name = "%s" + dns { + enable_hub = %t + resolver { + manual_servers { + address = "%s" + } + manual_servers { + address = "%s" + } + } + } + } + `, name, enableHub, server1Add, server2Add) + +} +func testAccCheckIBMISVPCDnsManual2Config(name, server1Add, server2Add, server3Add string, enableHub bool) string { + return fmt.Sprintf(` + resource "ibm_is_vpc" "testacc_vpc1" { + name = "%s" + dns { + enable_hub = %t + resolver { + manual_servers { + address = "%s" + zone_affinity= "%s-1" + } + manual_servers{ + address = "%s" + zone_affinity = "%s-2" + } + manual_servers{ + address= "%s" + zone_affinity ="%s-3" + } + } + } + } + `, name, enableHub, server1Add, acc.RegionName, server2Add, acc.RegionName, server3Add, acc.RegionName) + +} +func testAccCheckIBMISVPCDnsDelegatedConfig(vpcname, vpcname2, subnetname1, subnetname2, subnetname3, subnetname4, resourceinstance, resolver1, resolver2, bindingname string, enableHub, enablehubfalse bool) string { + return fmt.Sprintf(` + data "ibm_resource_group" "rg" { + is_default = true + } + + resource ibm_is_vpc hub_true { + name = "%s" + dns { + enable_hub = %t + } + } + + resource ibm_is_vpc hub_false_delegated { + name = "%s" + dns { + enable_hub = %t + } + } + + resource "ibm_is_subnet" "hub_true_sub1" { + name = "%s" + vpc = ibm_is_vpc.hub_true.id + zone = "%s" + total_ipv4_address_count = 16 + } + resource "ibm_is_subnet" "hub_true_sub2" { + name = "%s" + vpc = ibm_is_vpc.hub_true.id + zone = "%s" + total_ipv4_address_count = 16 + } + resource "ibm_is_subnet" "hub_false_delegated_sub1" { + name = "%s" + vpc = ibm_is_vpc.hub_false_delegated.id + zone = "%s" + total_ipv4_address_count = 16 + } + resource "ibm_is_subnet" "hub_false_delegated_sub2" { + name = "%s" + vpc = ibm_is_vpc.hub_false_delegated.id + zone = "%s" + total_ipv4_address_count = 16 + } + resource "ibm_resource_instance" "dns-cr-instance" { + name = "%s" + resource_group_id = data.ibm_resource_group.rg.id + location = "global" + service = "dns-svcs" + plan = "standard-dns" + } + resource "ibm_dns_custom_resolver" "test_hub_true" { + name = "%s" + instance_id = ibm_resource_instance.dns-cr-instance.guid + description = "new test CR - TF" + high_availability = true + enabled = true + locations { + subnet_crn = ibm_is_subnet.hub_true_sub1.crn + enabled = true + } + locations { + subnet_crn = ibm_is_subnet.hub_true_sub2.crn + enabled = true + } + } + resource "ibm_dns_custom_resolver" "test_hub_false_delegated" { + name = "%s" + instance_id = ibm_resource_instance.dns-cr-instance.guid + description = "new test CR - TF" + high_availability = true + enabled = true + locations { + subnet_crn = ibm_is_subnet.hub_false_delegated_sub1.crn + enabled = true + } + locations { + subnet_crn = ibm_is_subnet.hub_false_delegated_sub2.crn + enabled = true + } + } + + resource ibm_is_vpc_dns_resolution_binding dnstrue { + name = "%s" + vpc_id= ibm_is_vpc.hub_false_delegated.id + vpc { + id = ibm_is_vpc.hub_true.id + } + } + + `, vpcname, enableHub, vpcname2, enablehubfalse, subnetname1, acc.ISZoneName, subnetname2, acc.ISZoneName, subnetname3, acc.ISZoneName, subnetname4, acc.ISZoneName, resourceinstance, resolver1, resolver2, bindingname) + +} +func testAccCheckIBMISVPCDnsDelegatedUpdate1Config(vpcname, vpcname2, subnetname1, subnetname2, subnetname3, subnetname4, resourceinstance, resolver1, resolver2, bindingname string, enableHub, enablehubfalse bool) string { + return fmt.Sprintf(` + data "ibm_resource_group" "rg" { + is_default = true + } + + resource ibm_is_vpc hub_true { + name = "%s" + dns { + enable_hub = %t + } + } + + resource ibm_is_vpc hub_false_delegated { + name = "%s" + dns { + enable_hub = %t + resolver { + type = "delegated" + vpc_id = ibm_is_vpc.hub_true.id + } + } + } + + resource "ibm_is_subnet" "hub_true_sub1" { + name = "%s" + vpc = ibm_is_vpc.hub_true.id + zone = "%s" + total_ipv4_address_count = 16 + } + resource "ibm_is_subnet" "hub_true_sub2" { + name = "%s" + vpc = ibm_is_vpc.hub_true.id + zone = "%s" + total_ipv4_address_count = 16 + } + resource "ibm_is_subnet" "hub_false_delegated_sub1" { + name = "%s" + vpc = ibm_is_vpc.hub_false_delegated.id + zone = "%s" + total_ipv4_address_count = 16 + } + resource "ibm_is_subnet" "hub_false_delegated_sub2" { + name = "%s" + vpc = ibm_is_vpc.hub_false_delegated.id + zone = "%s" + total_ipv4_address_count = 16 + } + resource "ibm_resource_instance" "dns-cr-instance" { + name = "%s" + resource_group_id = data.ibm_resource_group.rg.id + location = "global" + service = "dns-svcs" + plan = "standard-dns" + } + resource "ibm_dns_custom_resolver" "test_hub_true" { + name = "%s" + instance_id = ibm_resource_instance.dns-cr-instance.guid + description = "new test CR - TF" + high_availability = true + enabled = true + locations { + subnet_crn = ibm_is_subnet.hub_true_sub1.crn + enabled = true + } + locations { + subnet_crn = ibm_is_subnet.hub_true_sub2.crn + enabled = true + } + } + resource "ibm_dns_custom_resolver" "test_hub_false_delegated" { + name = "%s" + instance_id = ibm_resource_instance.dns-cr-instance.guid + description = "new test CR - TF" + high_availability = true + enabled = true + locations { + subnet_crn = ibm_is_subnet.hub_false_delegated_sub1.crn + enabled = true + } + locations { + subnet_crn = ibm_is_subnet.hub_false_delegated_sub2.crn + enabled = true + } + } + + resource ibm_is_vpc_dns_resolution_binding dnstrue { + name = "%s" + vpc_id= ibm_is_vpc.hub_false_delegated.id + vpc { + id = ibm_is_vpc.hub_true.id + } + } + + `, vpcname, enableHub, vpcname2, enablehubfalse, subnetname1, acc.ISZoneName, subnetname2, acc.ISZoneName, subnetname3, acc.ISZoneName, subnetname4, acc.ISZoneName, resourceinstance, resolver1, resolver2, bindingname) + +} +func testAccCheckIBMISVPCDnsDelegatedUpdate2Config(vpcname, vpcname2, subnetname1, subnetname2, subnetname3, subnetname4, resourceinstance, resolver1, resolver2, bindingname string, enableHub, enablehubfalse bool) string { + return fmt.Sprintf(` + data "ibm_resource_group" "rg" { + is_default = true + } + + resource ibm_is_vpc hub_true { + name = "%s" + dns { + enable_hub = %t + } + } + + resource ibm_is_vpc hub_false_delegated { + name = "%s" + dns { + enable_hub = %t + resolver { + type = "system" + vpc_id = "null" + } + } + } + + resource "ibm_is_subnet" "hub_true_sub1" { + name = "%s" + vpc = ibm_is_vpc.hub_true.id + zone = "%s" + total_ipv4_address_count = 16 + } + resource "ibm_is_subnet" "hub_true_sub2" { + name = "%s" + vpc = ibm_is_vpc.hub_true.id + zone = "%s" + total_ipv4_address_count = 16 + } + resource "ibm_is_subnet" "hub_false_delegated_sub1" { + name = "%s" + vpc = ibm_is_vpc.hub_false_delegated.id + zone = "%s" + total_ipv4_address_count = 16 + } + resource "ibm_is_subnet" "hub_false_delegated_sub2" { + name = "%s" + vpc = ibm_is_vpc.hub_false_delegated.id + zone = "%s" + total_ipv4_address_count = 16 + } + resource "ibm_resource_instance" "dns-cr-instance" { + name = "%s" + resource_group_id = data.ibm_resource_group.rg.id + location = "global" + service = "dns-svcs" + plan = "standard-dns" + } + resource "ibm_dns_custom_resolver" "test_hub_true" { + name = "%s" + instance_id = ibm_resource_instance.dns-cr-instance.guid + description = "new test CR - TF" + high_availability = true + enabled = true + locations { + subnet_crn = ibm_is_subnet.hub_true_sub1.crn + enabled = true + } + locations { + subnet_crn = ibm_is_subnet.hub_true_sub2.crn + enabled = true + } + } + resource "ibm_dns_custom_resolver" "test_hub_false_delegated" { + name = "%s" + instance_id = ibm_resource_instance.dns-cr-instance.guid + description = "new test CR - TF" + high_availability = true + enabled = true + locations { + subnet_crn = ibm_is_subnet.hub_false_delegated_sub1.crn + enabled = true + } + locations { + subnet_crn = ibm_is_subnet.hub_false_delegated_sub2.crn + enabled = true + } + } + + resource ibm_is_vpc_dns_resolution_binding dnstrue { + name = "%s" + vpc_id= ibm_is_vpc.hub_false_delegated.id + vpc { + id = ibm_is_vpc.hub_true.id + } + } + + `, vpcname, enableHub, vpcname2, enablehubfalse, subnetname1, acc.ISZoneName, subnetname2, acc.ISZoneName, subnetname3, acc.ISZoneName, subnetname4, acc.ISZoneName, resourceinstance, resolver1, resolver2, bindingname) + } func testAccCheckIBMISVPCConfigUpdate(name string) string { diff --git a/metadata/provider_metadata.json b/metadata/provider_metadata.json index a3fc5bd896..3493ca9b88 100644 --- a/metadata/provider_metadata.json +++ b/metadata/provider_metadata.json @@ -143,22 +143,37 @@ ], "ibm_app": [ { - "name": "disk_quota", + "name": "instances", "type": "TypeInt", - "description": "The maximum amount of disk available to an instance of an app. In megabytes.", + "description": "The number of instances", "computed": true }, { - "name": "state", + "name": "buildpack", "type": "TypeString", - "description": "The state of the application", + "description": "Buildpack to build the app. 3 options: a) Blank means autodetection; b) A Git Url pointing to a buildpack; c) Name of an installed buildpack.", "computed": true }, { - "name": "space_guid", + "name": "environment_json", + "type": "TypeMap", + "description": "Key/value pairs of all the environment variables to run in your app. Does not include any system or service variables.", + "computed": true + }, + { + "name": "service_instance_guid", + "type": "TypeSet", + "description": "Define the service instance guids that should be bound to this application.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "state", "type": "TypeString", - "description": "Define space guid to which app belongs", - "required": true + "description": "The state of the application", + "computed": true }, { "name": "memory", @@ -167,10 +182,13 @@ "computed": true }, { - "name": "instances", - "type": "TypeInt", - "description": "The number of instances", - "computed": true + "name": "route_guid", + "type": "TypeSet", + "description": "Define the route guids which should be bound to the application.", + "computed": true, + "elem": { + "type": "TypeString" + } }, { "name": "package_state", @@ -178,6 +196,24 @@ "description": "The state of the application package whether staged, pending etc", "computed": true }, + { + "name": "disk_quota", + "type": "TypeInt", + "description": "The maximum amount of disk available to an instance of an app. In megabytes.", + "computed": true + }, + { + "name": "space_guid", + "type": "TypeString", + "description": "Define space guid to which app belongs", + "required": true + }, + { + "name": "health_check_timeout", + "type": "TypeInt", + "description": "Timeout in seconds for health checking of an staged app when starting up.", + "computed": true + }, { "name": "name", "type": "TypeString", @@ -191,60 +227,50 @@ "computed": true }, { - "name": "buildpack", + "name": "health_check_http_endpoint", "type": "TypeString", - "description": "Buildpack to build the app. 3 options: a) Blank means autodetection; b) A Git Url pointing to a buildpack; c) Name of an installed buildpack.", + "description": "Endpoint called to determine if the app is healthy.", "computed": true - }, + } + ], + "ibm_app_config_collection": [ { - "name": "route_guid", - "type": "TypeSet", - "description": "Define the route guids which should be bound to the application.", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "name", + "type": "TypeString", + "description": "Collection name.", + "computed": true }, { - "name": "service_instance_guid", - "type": "TypeSet", - "description": "Define the service instance guids that should be bound to this application.", - "computed": true, + "name": "include", + "type": "TypeList", + "description": "Include feature, property details in the response.", + "optional": true, "elem": { "type": "TypeString" } }, { - "name": "health_check_http_endpoint", + "name": "updated_time", "type": "TypeString", - "description": "Endpoint called to determine if the app is healthy.", + "description": "Last modified time of the collection data.", "computed": true }, { - "name": "health_check_timeout", - "type": "TypeInt", - "description": "Timeout in seconds for health checking of an staged app when starting up.", + "name": "href", + "type": "TypeString", + "description": "Collection URL.", "computed": true }, { - "name": "environment_json", - "type": "TypeMap", - "description": "Key/value pairs of all the environment variables to run in your app. Does not include any system or service variables.", - "computed": true - } - ], - "ibm_app_config_collection": [ - { - "name": "tags", + "name": "collection_id", "type": "TypeString", - "description": "Tags associated with the collection.", - "cloud_data_type": "tags", - "computed": true + "description": "Collection Id of the collection.", + "required": true }, { - "name": "features_count", - "type": "TypeInt", - "description": "Number of features associated with the collection.", + "name": "created_time", + "type": "TypeString", + "description": "Creation time of the collection.", "computed": true }, { @@ -267,6 +293,12 @@ } } }, + { + "name": "expand", + "type": "TypeBool", + "description": "If set to true, returns expanded view of the resource details.", + "optional": true + }, { "name": "properties", "type": "TypeList", @@ -288,48 +320,28 @@ } }, { - "name": "description", + "name": "guid", "type": "TypeString", - "description": "Collection description.", - "computed": true + "description": "GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.", + "required": true }, { - "name": "href", + "name": "description", "type": "TypeString", - "description": "Collection URL.", + "description": "Collection description.", "computed": true }, { - "name": "created_time", + "name": "tags", "type": "TypeString", - "description": "Creation time of the collection.", + "description": "Tags associated with the collection.", + "cloud_data_type": "tags", "computed": true }, { - "name": "collection_id", - "type": "TypeString", - "description": "Collection Id of the collection.", - "required": true - }, - { - "name": "include", - "type": "TypeList", - "description": "Include feature, property details in the response.", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "expand", - "type": "TypeBool", - "description": "If set to true, returns expanded view of the resource details.", - "optional": true - }, - { - "name": "updated_time", - "type": "TypeString", - "description": "Last modified time of the collection data.", + "name": "features_count", + "type": "TypeInt", + "description": "Number of features associated with the collection.", "computed": true }, { @@ -337,27 +349,9 @@ "type": "TypeInt", "description": "Number of properties associated with the collection.", "computed": true - }, - { - "name": "guid", - "type": "TypeString", - "description": "GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.", - "required": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Collection name.", - "computed": true } ], "ibm_app_config_collections": [ - { - "name": "expand", - "type": "TypeBool", - "description": "If set to true, returns expanded view of the resource details.", - "optional": true - }, { "name": "collections", "type": "TypeList", @@ -492,20 +486,31 @@ "elem": { "type": "TypeString" } + }, + { + "name": "expand", + "type": "TypeBool", + "description": "If set to true, returns expanded view of the resource details.", + "optional": true } ], "ibm_app_config_environment": [ { - "name": "tags", + "name": "href", "type": "TypeString", - "description": "Tags associated with the environment.", - "cloud_data_type": "tags", + "description": "Environment URL.", "computed": true }, { - "name": "color_code", + "name": "environment_id", "type": "TypeString", - "description": "Color code to distinguish the environment. The Hex code for the color. For example `#FF0000` for `red`.", + "description": "Environment Id.", + "required": true + }, + { + "name": "name", + "type": "TypeString", + "description": "Environment name.", "computed": true }, { @@ -515,9 +520,22 @@ "computed": true }, { - "name": "environment_id", + "name": "updated_time", "type": "TypeString", - "description": "Environment Id.", + "description": "Last modified time of the environment data.", + "computed": true + }, + { + "name": "created_time", + "type": "TypeString", + "description": "Creation time of the environment.", + "computed": true + }, + { + "name": "guid", + "type": "TypeString", + "description": "GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.", + "immutable": true, "required": true }, { @@ -527,28 +545,47 @@ "optional": true }, { - "name": "name", + "name": "tags", "type": "TypeString", - "description": "Environment name.", + "description": "Tags associated with the environment.", + "cloud_data_type": "tags", "computed": true }, { - "name": "created_time", + "name": "color_code", "type": "TypeString", - "description": "Creation time of the environment.", + "description": "Color code to distinguish the environment. The Hex code for the color. For example `#FF0000` for `red`.", "computed": true - }, + } + ], + "ibm_app_config_environments": [ { - "name": "updated_time", - "type": "TypeString", - "description": "Last modified time of the environment data.", - "computed": true + "name": "first", + "type": "TypeList", + "description": "URL to navigate to the first page of records.", + "computed": true, + "elem": { + "href": { + "name": "href", + "type": "TypeString", + "description": "URL of the response.", + "computed": true + } + } }, { - "name": "href", - "type": "TypeString", - "description": "Environment URL.", - "computed": true + "name": "previous", + "type": "TypeList", + "description": "URL to navigate to the previous list of records.", + "computed": true, + "elem": { + "href": { + "name": "href", + "type": "TypeString", + "description": "URL of the response.", + "computed": true + } + } }, { "name": "guid", @@ -556,13 +593,11 @@ "description": "GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.", "immutable": true, "required": true - } - ], - "ibm_app_config_environments": [ + }, { - "name": "limit", + "name": "offset", "type": "TypeInt", - "description": "The number of records to retrieve. By default, the list operation return the first 10 records. To retrieve different set of records, use `limit` with `offset` to page through the available records.", + "description": "The number of records to skip. By specifying `offset`, you retrieve a subset of items that starts with the `offset` value. Use `offset` with `limit` to page through the available records.", "optional": true }, { @@ -622,23 +657,15 @@ } }, { - "name": "first", - "type": "TypeList", - "description": "URL to navigate to the first page of records.", - "computed": true, - "elem": { - "href": { - "name": "href", - "type": "TypeString", - "description": "URL of the response.", - "computed": true - } - } + "name": "total_count", + "type": "TypeInt", + "description": "Total number of records.", + "computed": true }, { - "name": "previous", + "name": "next", "type": "TypeList", - "description": "URL to navigate to the previous list of records.", + "description": "URL to navigate to the next list of records.", "computed": true, "elem": { "href": { @@ -663,21 +690,15 @@ "optional": true }, { - "name": "offset", + "name": "limit", "type": "TypeInt", - "description": "The number of records to skip. By specifying `offset`, you retrieve a subset of items that starts with the `offset` value. Use `offset` with `limit` to page through the available records.", + "description": "The number of records to retrieve. By default, the list operation return the first 10 records. To retrieve different set of records, use `limit` with `offset` to page through the available records.", "optional": true }, { - "name": "total_count", - "type": "TypeInt", - "description": "Total number of records.", - "computed": true - }, - { - "name": "next", + "name": "last", "type": "TypeList", - "description": "URL to navigate to the next list of records.", + "description": "URL to navigate to the last page of records.", "computed": true, "elem": { "href": { @@ -687,30 +708,54 @@ "computed": true } } + } + ], + "ibm_app_config_feature": [ + { + "name": "feature_id", + "type": "TypeString", + "description": "Feature Id.", + "required": true }, { - "name": "last", + "name": "description", + "type": "TypeString", + "description": "Feature description.", + "computed": true + }, + { + "name": "tags", + "type": "TypeString", + "description": "Tags associated with the feature.", + "cloud_data_type": "tags", + "computed": true + }, + { + "name": "collections", "type": "TypeList", - "description": "URL to navigate to the last page of records.", + "description": "List of collection id representing the collections that are associated with the specified feature flag.", "computed": true, "elem": { - "href": { - "name": "href", + "collection_id": { + "name": "collection_id", "type": "TypeString", - "description": "URL of the response.", + "description": "Collection id.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Name of the collection.", "computed": true } } }, { - "name": "guid", + "name": "href", "type": "TypeString", - "description": "GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.", - "immutable": true, - "required": true - } - ], - "ibm_app_config_feature": [ + "description": "Feature flag URL.", + "computed": true + }, { "name": "guid", "type": "TypeString", @@ -718,10 +763,10 @@ "required": true }, { - "name": "includes", - "type": "TypeString", - "description": "Include the associated collections in the response.", - "optional": true + "name": "enabled", + "type": "TypeBool", + "description": "The state of the feature flag.", + "computed": true }, { "name": "segment_rules", @@ -766,26 +811,6 @@ } } }, - { - "name": "collections", - "type": "TypeList", - "description": "List of collection id representing the collections that are associated with the specified feature flag.", - "computed": true, - "elem": { - "collection_id": { - "name": "collection_id", - "type": "TypeString", - "description": "Collection id.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Name of the collection.", - "computed": true - } - } - }, { "name": "type", "type": "TypeString", @@ -793,9 +818,9 @@ "computed": true }, { - "name": "enabled_value", + "name": "name", "type": "TypeString", - "description": "Value of the feature when it is enabled. The value can be Boolean, String or a Numeric value as per the `type` attribute.", + "description": "Feature name.", "computed": true }, { @@ -816,12 +841,6 @@ "description": "Rollout percentage of the feature.", "computed": true }, - { - "name": "href", - "type": "TypeString", - "description": "Feature flag URL.", - "computed": true - }, { "name": "environment_id", "type": "TypeString", @@ -829,21 +848,9 @@ "required": true }, { - "name": "feature_id", - "type": "TypeString", - "description": "Feature Id.", - "required": true - }, - { - "name": "description", + "name": "enabled_value", "type": "TypeString", - "description": "Feature description.", - "computed": true - }, - { - "name": "enabled", - "type": "TypeBool", - "description": "The state of the feature flag.", + "description": "Value of the feature when it is enabled. The value can be Boolean, String or a Numeric value as per the `type` attribute.", "computed": true }, { @@ -853,26 +860,25 @@ "computed": true }, { - "name": "name", - "type": "TypeString", - "description": "Feature name.", - "computed": true - }, - { - "name": "tags", + "name": "updated_time", "type": "TypeString", - "description": "Tags associated with the feature.", - "cloud_data_type": "tags", + "description": "Last modified time of the feature flag data.", "computed": true }, { - "name": "updated_time", + "name": "includes", "type": "TypeString", - "description": "Last modified time of the feature flag data.", - "computed": true + "description": "Include the associated collections in the response.", + "optional": true } ], "ibm_app_config_features": [ + { + "name": "sort", + "type": "TypeString", + "description": "Sort the feature details based on the specified attribute.", + "optional": true + }, { "name": "tags", "type": "TypeString", @@ -880,6 +886,125 @@ "cloud_data_type": "tags", "optional": true }, + { + "name": "segments", + "type": "TypeList", + "description": "Filter features by a list of comma separated segments.", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "expand", + "type": "TypeBool", + "description": "If set to `true`, returns expanded view of the resource details.", + "optional": true + }, + { + "name": "previous", + "type": "TypeList", + "description": "URL to navigate to the previous list of records.", + "computed": true, + "elem": { + "href": { + "name": "href", + "type": "TypeString", + "description": "URL of the response.", + "computed": true + } + } + }, + { + "name": "guid", + "type": "TypeString", + "description": "GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.", + "required": true + }, + { + "name": "collections", + "type": "TypeList", + "description": "Filter features by a list of comma separated collections.", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "includes", + "type": "TypeList", + "description": "Include the associated collections or targeting rules details in the response.", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "next", + "type": "TypeList", + "description": "URL to navigate to the next list of records.", + "computed": true, + "elem": { + "href": { + "name": "href", + "type": "TypeString", + "description": "URL of the response.", + "computed": true + } + } + }, + { + "name": "last", + "type": "TypeList", + "description": "URL to navigate to the last page of records.", + "computed": true, + "elem": { + "href": { + "name": "href", + "type": "TypeString", + "description": "URL of the response.", + "computed": true + } + } + }, + { + "name": "environment_id", + "type": "TypeString", + "description": "Environment Id.", + "required": true + }, + { + "name": "offset", + "type": "TypeInt", + "description": "The number of records to skip. By specifying `offset`, you retrieve a subset of items that starts with the `offset` value. Use `offset` with `limit` to page through the available records.", + "optional": true + }, + { + "name": "total_count", + "type": "TypeInt", + "description": "Number of records returned in the current response.", + "computed": true + }, + { + "name": "first", + "type": "TypeList", + "description": "URL to navigate to the first page of records.", + "computed": true, + "elem": { + "href": { + "name": "href", + "type": "TypeString", + "description": "URL of the response.", + "computed": true + } + } + }, + { + "name": "limit", + "type": "TypeInt", + "description": "The number of records to retrieve. By default, the list operation return the first 10 records. To retrieve different set of records, use `limit` with `offset` to page through the available records.", + "optional": true + }, { "name": "features", "type": "TypeList", @@ -1028,41 +1153,25 @@ "computed": true } } - }, + } + ], + "ibm_app_config_properties": [ { - "name": "first", - "type": "TypeList", - "description": "URL to navigate to the first page of records.", - "computed": true, - "elem": { - "href": { - "name": "href", - "type": "TypeString", - "description": "URL of the response.", - "computed": true - } - } + "name": "tags", + "type": "TypeString", + "description": "Filter the resources to be returned based on the associated tags. Specify the parameter as a list of comma separated tags. Returns resources associated with any of the specified tags.", + "cloud_data_type": "tags", + "optional": true }, { - "name": "previous", + "name": "collections", "type": "TypeList", - "description": "URL to navigate to the previous list of records.", - "computed": true, + "description": "Filter features by a list of comma separated collections.", + "optional": true, "elem": { - "href": { - "name": "href", - "type": "TypeString", - "description": "URL of the response.", - "computed": true - } + "type": "TypeString" } }, - { - "name": "environment_id", - "type": "TypeString", - "description": "Environment Id.", - "required": true - }, { "name": "segments", "type": "TypeList", @@ -1079,34 +1188,7 @@ "optional": true }, { - "name": "limit", - "type": "TypeInt", - "description": "The number of records to retrieve. By default, the list operation return the first 10 records. To retrieve different set of records, use `limit` with `offset` to page through the available records.", - "optional": true - }, - { - "name": "total_count", - "type": "TypeInt", - "description": "Number of records returned in the current response.", - "computed": true - }, - { - "name": "collections", - "type": "TypeList", - "description": "Filter features by a list of comma separated collections.", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "sort", - "type": "TypeString", - "description": "Sort the feature details based on the specified attribute.", - "optional": true - }, - { - "name": "includes", + "name": "include", "type": "TypeList", "description": "Include the associated collections or targeting rules details in the response.", "optional": true, @@ -1114,60 +1196,6 @@ "type": "TypeString" } }, - { - "name": "guid", - "type": "TypeString", - "description": "GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.", - "required": true - }, - { - "name": "next", - "type": "TypeList", - "description": "URL to navigate to the next list of records.", - "computed": true, - "elem": { - "href": { - "name": "href", - "type": "TypeString", - "description": "URL of the response.", - "computed": true - } - } - }, - { - "name": "last", - "type": "TypeList", - "description": "URL to navigate to the last page of records.", - "computed": true, - "elem": { - "href": { - "name": "href", - "type": "TypeString", - "description": "URL of the response.", - "computed": true - } - } - }, - { - "name": "offset", - "type": "TypeInt", - "description": "The number of records to skip. By specifying `offset`, you retrieve a subset of items that starts with the `offset` value. Use `offset` with `limit` to page through the available records.", - "optional": true - } - ], - "ibm_app_config_properties": [ - { - "name": "sort", - "type": "TypeString", - "description": "Sort the feature details based on the specified attribute.", - "optional": true - }, - { - "name": "limit", - "type": "TypeInt", - "description": "The number of records to retrieve. By default, the list operation return the first 10 records. To retrieve different set of records, use `limit` with `offset` to page through the available records.", - "optional": true - }, { "name": "offset", "type": "TypeInt", @@ -1299,12 +1327,6 @@ } } }, - { - "name": "total_count", - "type": "TypeInt", - "description": "Number of records returned in the current response.", - "computed": true - }, { "name": "guid", "type": "TypeString", @@ -1318,51 +1340,47 @@ "required": true }, { - "name": "segments", - "type": "TypeList", - "description": "Filter features by a list of comma separated segments.", - "optional": true, - "elem": { - "type": "TypeString" - } + "name": "sort", + "type": "TypeString", + "description": "Sort the feature details based on the specified attribute.", + "optional": true }, { - "name": "expand", - "type": "TypeBool", - "description": "If set to `true`, returns expanded view of the resource details.", + "name": "limit", + "type": "TypeInt", + "description": "The number of records to retrieve. By default, the list operation return the first 10 records. To retrieve different set of records, use `limit` with `offset` to page through the available records.", "optional": true }, { - "name": "include", - "type": "TypeList", - "description": "Include the associated collections or targeting rules details in the response.", - "optional": true, - "elem": { - "type": "TypeString" - } + "name": "total_count", + "type": "TypeInt", + "description": "Number of records returned in the current response.", + "computed": true + } + ], + "ibm_app_config_property": [ + { + "name": "name", + "type": "TypeString", + "description": "Property name.", + "computed": true }, { - "name": "tags", + "name": "segment_exists", + "type": "TypeBool", + "description": "Denotes if the targeting rules are specified for the property.", + "computed": true + }, + { + "name": "include", "type": "TypeString", - "description": "Filter the resources to be returned based on the associated tags. Specify the parameter as a list of comma separated tags. Returns resources associated with any of the specified tags.", - "cloud_data_type": "tags", + "description": "Include the associated collections in the response.", "optional": true }, { - "name": "collections", - "type": "TypeList", - "description": "Filter features by a list of comma separated collections.", - "optional": true, - "elem": { - "type": "TypeString" - } - } - ], - "ibm_app_config_property": [ - { - "name": "type", + "name": "description", "type": "TypeString", - "description": "Type of the Property (BOOLEAN, STRING, NUMERIC).", + "description": "Property description.", "computed": true }, { @@ -1409,15 +1427,15 @@ "computed": true }, { - "name": "guid", + "name": "updated_time", "type": "TypeString", - "description": "GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.", - "required": true + "description": "Last modified time of the property data.", + "computed": true }, { - "name": "environment_id", + "name": "guid", "type": "TypeString", - "description": "Environment Id.", + "description": "GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.", "required": true }, { @@ -1426,12 +1444,6 @@ "description": "Property Id.", "required": true }, - { - "name": "name", - "type": "TypeString", - "description": "Property name.", - "computed": true - }, { "name": "value", "type": "TypeString", @@ -1459,9 +1471,21 @@ } }, { - "name": "description", + "name": "href", "type": "TypeString", - "description": "Property description.", + "description": "Property URL.", + "computed": true + }, + { + "name": "environment_id", + "type": "TypeString", + "description": "Environment Id.", + "required": true + }, + { + "name": "type", + "type": "TypeString", + "description": "Type of the Property (BOOLEAN, STRING, NUMERIC).", "computed": true }, { @@ -1470,37 +1494,59 @@ "description": "Tags associated with the property.", "cloud_data_type": "tags", "computed": true + } + ], + "ibm_app_config_segment": [ + { + "name": "name", + "type": "TypeString", + "description": "Segment name.", + "computed": true }, { - "name": "segment_exists", - "type": "TypeBool", - "description": "Denotes if the targeting rules are specified for the property.", + "name": "description", + "type": "TypeString", + "description": "Segment description.", "computed": true }, { - "name": "href", + "name": "includes", + "type": "TypeList", + "description": "Include feature and property details in the response.", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "created_time", "type": "TypeString", - "description": "Property URL.", + "description": "Creation time of the segment.", "computed": true }, { - "name": "include", + "name": "guid", "type": "TypeString", - "description": "Include the associated collections in the response.", - "optional": true + "description": "GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.", + "required": true + }, + { + "name": "tags", + "type": "TypeString", + "description": "Tags associated with the segment.", + "cloud_data_type": "tags", + "computed": true }, { "name": "updated_time", "type": "TypeString", - "description": "Last modified time of the property data.", + "description": "Last modified time of the segment data.", "computed": true - } - ], - "ibm_app_config_segment": [ + }, { - "name": "created_time", + "name": "href", "type": "TypeString", - "description": "Creation time of the segment.", + "description": "Segment flag URL.", "computed": true }, { @@ -1572,52 +1618,6 @@ } } }, - { - "name": "description", - "type": "TypeString", - "description": "Segment description.", - "computed": true - }, - { - "name": "tags", - "type": "TypeString", - "description": "Tags associated with the segment.", - "cloud_data_type": "tags", - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Segment name.", - "computed": true - }, - { - "name": "includes", - "type": "TypeList", - "description": "Include feature and property details in the response.", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "updated_time", - "type": "TypeString", - "description": "Last modified time of the segment data.", - "computed": true - }, - { - "name": "href", - "type": "TypeString", - "description": "Segment flag URL.", - "computed": true - }, - { - "name": "guid", - "type": "TypeString", - "description": "GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.", - "required": true - }, { "name": "segment_id", "type": "TypeString", @@ -1627,10 +1627,9 @@ ], "ibm_app_config_segments": [ { - "name": "tags", + "name": "include", "type": "TypeString", - "description": "Filter the resources to be returned based on the associated tags.", - "cloud_data_type": "tags", + "description": "Segment details to include the associated rules in the response", "optional": true }, { @@ -1651,30 +1650,6 @@ "description": "The number of records to skip. By specifying `offset`, you retrieve a subset of items that starts with the `offset` value. Use `offset` with `limit` to page through the available records.", "optional": true }, - { - "name": "guid", - "type": "TypeString", - "description": "GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.", - "required": true - }, - { - "name": "sort", - "type": "TypeString", - "description": "Sort the segment details based on the specified attribute.", - "optional": true - }, - { - "name": "include", - "type": "TypeString", - "description": "Segment details to include the associated rules in the response", - "optional": true - }, - { - "name": "limit", - "type": "TypeInt", - "description": "The number of records to retrieve. By default, the list operation return the first 10 records. To retrieve different set of records, use `limit` with `offset` to page through the available records.", - "optional": true - }, { "name": "segments", "type": "TypeList", @@ -1793,31 +1768,38 @@ "computed": true } } - } - ], - "ibm_app_config_snapshot": [ + }, { - "name": "git_config_id", + "name": "tags", "type": "TypeString", - "description": "Git config id. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only", - "required": true + "description": "Filter the resources to be returned based on the associated tags.", + "cloud_data_type": "tags", + "optional": true }, { - "name": "git_branch", + "name": "sort", "type": "TypeString", - "description": "Branch name to which you need to write or update the configuration.", - "computed": true + "description": "Sort the segment details based on the specified attribute.", + "optional": true }, { - "name": "git_file_path", + "name": "guid", "type": "TypeString", - "description": "Git file path, this is a path where your configuration file will be written.", - "computed": true + "description": "GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.", + "required": true }, { - "name": "updated_time", + "name": "limit", + "type": "TypeInt", + "description": "The number of records to retrieve. By default, the list operation return the first 10 records. To retrieve different set of records, use `limit` with `offset` to page through the available records.", + "optional": true + } + ], + "ibm_app_config_snapshot": [ + { + "name": "last_sync_time", "type": "TypeString", - "description": "Last modified time of the git config data.", + "description": "Latest time when the snapshot was synced to git.", "computed": true }, { @@ -1847,33 +1829,33 @@ } }, { - "name": "guid", + "name": "git_config_id", "type": "TypeString", - "description": "GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.", + "description": "Git config id. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only", "required": true }, { - "name": "git_config_name", + "name": "git_file_path", "type": "TypeString", - "description": "Git config name. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only", + "description": "Git file path, this is a path where your configuration file will be written.", "computed": true }, { - "name": "git_url", + "name": "created_time", "type": "TypeString", - "description": "Git url which will be used to connect to the github account.", + "description": "Creation time of the git config.", "computed": true }, { - "name": "created_time", + "name": "git_branch", "type": "TypeString", - "description": "Creation time of the git config.", + "description": "Branch name to which you need to write or update the configuration.", "computed": true }, { - "name": "last_sync_time", + "name": "updated_time", "type": "TypeString", - "description": "Latest time when the snapshot was synced to git.", + "description": "Last modified time of the git config data.", "computed": true }, { @@ -1901,21 +1883,27 @@ "computed": true } } - } - ], - "ibm_app_config_snapshots": [ + }, { - "name": "collection_id", + "name": "guid", "type": "TypeString", - "description": "Filters the response based on the specified collection_id.", - "optional": true + "description": "GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.", + "required": true }, { - "name": "environment_id", + "name": "git_config_name", "type": "TypeString", - "description": "Filters the response based on the specified environment_id.", - "optional": true + "description": "Git config name. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only", + "computed": true }, + { + "name": "git_url", + "type": "TypeString", + "description": "Git url which will be used to connect to the github account.", + "computed": true + } + ], + "ibm_app_config_snapshots": [ { "name": "limit", "type": "TypeInt", @@ -2047,6 +2035,18 @@ "type": "TypeString", "description": "GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.", "required": true + }, + { + "name": "collection_id", + "type": "TypeString", + "description": "Filters the response based on the specified collection_id.", + "optional": true + }, + { + "name": "environment_id", + "type": "TypeString", + "description": "Filters the response based on the specified environment_id.", + "optional": true } ], "ibm_app_domain_private": [ @@ -2066,6 +2066,12 @@ } ], "ibm_app_route": [ + { + "name": "space_guid", + "type": "TypeString", + "description": "The guid of the space", + "required": true + }, { "name": "domain_guid", "type": "TypeString", @@ -2089,12 +2095,6 @@ "type": "TypeString", "description": "The port of the route", "optional": true - }, - { - "name": "space_guid", - "type": "TypeString", - "description": "The guid of the space", - "required": true } ], "ibm_appid_action_url": [ @@ -2119,13 +2119,47 @@ ], "ibm_appid_apm": [ { - "name": "password_expiration", + "name": "tenant_id", + "type": "TypeString", + "description": "The AppID instance GUID", + "required": true + }, + { + "name": "enabled", + "type": "TypeBool", + "description": "`true` if APM is enabled", + "computed": true + }, + { + "name": "prevent_password_with_username", + "type": "TypeBool", + "computed": true + }, + { + "name": "password_reuse", "type": "TypeList", "computed": true, "elem": { - "days_to_expire": { - "name": "days_to_expire", - "type": "TypeInt", + "enabled": { + "name": "enabled", + "type": "TypeBool", + "computed": true + }, + "max_password_reuse": { + "name": "max_password_reuse", + "type": "TypeInt", + "computed": true + } + } + }, + { + "name": "password_expiration", + "type": "TypeList", + "computed": true, + "elem": { + "days_to_expire": { + "name": "days_to_expire", + "type": "TypeInt", "computed": true }, "enabled": { @@ -2173,54 +2207,9 @@ "computed": true } } - }, - { - "name": "tenant_id", - "type": "TypeString", - "description": "The AppID instance GUID", - "required": true - }, - { - "name": "enabled", - "type": "TypeBool", - "description": "`true` if APM is enabled", - "computed": true - }, - { - "name": "prevent_password_with_username", - "type": "TypeBool", - "computed": true - }, - { - "name": "password_reuse", - "type": "TypeList", - "computed": true, - "elem": { - "enabled": { - "name": "enabled", - "type": "TypeBool", - "computed": true - }, - "max_password_reuse": { - "name": "max_password_reuse", - "type": "TypeInt", - "computed": true - } - } } ], "ibm_appid_application": [ - { - "name": "profiles_url", - "type": "TypeString", - "computed": true - }, - { - "name": "discovery_endpoint", - "type": "TypeString", - "description": "This URL returns OAuth Authorization Server Metadata", - "computed": true - }, { "name": "type", "type": "TypeString", @@ -2257,6 +2246,17 @@ "type": "TypeString", "description": "Base URL for common OAuth endpoints, like `/authorization`, `/token` and `/publickeys`", "computed": true + }, + { + "name": "profiles_url", + "type": "TypeString", + "computed": true + }, + { + "name": "discovery_endpoint", + "type": "TypeString", + "description": "This URL returns OAuth Authorization Server Metadata", + "computed": true } ], "ibm_appid_application_roles": [ @@ -2388,25 +2388,6 @@ } ], "ibm_appid_cloud_directory_template": [ - { - "name": "tenant_id", - "type": "TypeString", - "description": "The AppID instance GUID", - "required": true - }, - { - "name": "template_name", - "type": "TypeString", - "description": "The type of email template. This can be `USER_VERIFICATION`, `WELCOME`, `PASSWORD_CHANGED`, `RESET_PASSWORD` or `MFA_VERIFICATION`", - "required": true - }, - { - "name": "language", - "type": "TypeString", - "description": "Preferred language for resource. Format as described at RFC5646. According to the configured languages codes returned from the `GET /management/v4/{tenantId}/config/ui/languages API`.", - "default_value": "en", - "optional": true - }, { "name": "subject", "type": "TypeString", @@ -2430,9 +2411,7 @@ "type": "TypeString", "description": "The text body of the email.", "computed": true - } - ], - "ibm_appid_cloud_directory_user": [ + }, { "name": "tenant_id", "type": "TypeString", @@ -2440,27 +2419,42 @@ "required": true }, { - "name": "active", - "type": "TypeBool", - "description": "Determines if the user account is active or not", + "name": "template_name", + "type": "TypeString", + "description": "The type of email template. This can be `USER_VERIFICATION`, `WELCOME`, `PASSWORD_CHANGED`, `RESET_PASSWORD` or `MFA_VERIFICATION`", + "required": true + }, + { + "name": "language", + "type": "TypeString", + "description": "Preferred language for resource. Format as described at RFC5646. According to the configured languages codes returned from the `GET /management/v4/{tenantId}/config/ui/languages API`.", + "default_value": "en", + "optional": true + } + ], + "ibm_appid_cloud_directory_user": [ + { + "name": "subject", + "type": "TypeString", + "description": "The user's identifier ('subject' in identity token)", "computed": true }, { - "name": "locked_until", - "type": "TypeInt", - "description": "Integer (epoch time in milliseconds), determines till when the user account will be locked", + "name": "user_name", + "type": "TypeString", + "description": "Optional username", "computed": true }, { - "name": "user_id", + "name": "tenant_id", "type": "TypeString", - "description": "Cloud Directory user ID", + "description": "The AppID instance GUID", "required": true }, { - "name": "subject", - "type": "TypeString", - "description": "The user's identifier ('subject' in identity token)", + "name": "active", + "type": "TypeBool", + "description": "Determines if the user account is active or not", "computed": true }, { @@ -2469,12 +2463,6 @@ "description": "Cloud Directory user display name", "computed": true }, - { - "name": "user_name", - "type": "TypeString", - "description": "Optional username", - "computed": true - }, { "name": "status", "type": "TypeString", @@ -2520,9 +2508,32 @@ "computed": true } } + }, + { + "name": "locked_until", + "type": "TypeInt", + "description": "Integer (epoch time in milliseconds), determines till when the user account will be locked", + "computed": true + }, + { + "name": "user_id", + "type": "TypeString", + "description": "Cloud Directory user ID", + "required": true } ], "ibm_appid_idp_cloud_directory": [ + { + "name": "tenant_id", + "type": "TypeString", + "description": "The service `tenantId`", + "required": true + }, + { + "name": "is_active", + "type": "TypeBool", + "computed": true + }, { "name": "self_service_enabled", "type": "TypeBool", @@ -2530,7 +2541,13 @@ "computed": true }, { - "name": "reset_password_notification_enabled", + "name": "signup_enabled", + "type": "TypeBool", + "description": "Allow users to sign-up to your app", + "computed": true + }, + { + "name": "reset_password_enabled", "type": "TypeBool", "computed": true }, @@ -2540,7 +2557,7 @@ "computed": true }, { - "name": "reset_password_enabled", + "name": "reset_password_notification_enabled", "type": "TypeBool", "computed": true }, @@ -2561,32 +2578,9 @@ "name": "identity_field", "type": "TypeString", "computed": true - }, - { - "name": "tenant_id", - "type": "TypeString", - "description": "The service `tenantId`", - "required": true - }, - { - "name": "is_active", - "type": "TypeBool", - "computed": true - }, - { - "name": "signup_enabled", - "type": "TypeBool", - "description": "Allow users to sign-up to your app", - "computed": true } ], "ibm_appid_idp_custom": [ - { - "name": "tenant_id", - "type": "TypeString", - "description": "The AppID instance GUID", - "required": true - }, { "name": "is_active", "type": "TypeBool", @@ -2597,6 +2591,12 @@ "type": "TypeString", "description": "This is the public key used to validate your signed JWT. It is required to be a PEM in the RS256 or greater format.", "computed": true + }, + { + "name": "tenant_id", + "type": "TypeString", + "description": "The AppID instance GUID", + "required": true } ], "ibm_appid_idp_facebook": [ @@ -2681,18 +2681,6 @@ } ], "ibm_appid_idp_saml": [ - { - "name": "tenant_id", - "type": "TypeString", - "description": "The AppID instance GUID", - "required": true - }, - { - "name": "is_active", - "type": "TypeBool", - "description": "SAML IDP activation", - "computed": true - }, { "name": "config", "type": "TypeList", @@ -2767,6 +2755,18 @@ "computed": true } } + }, + { + "name": "tenant_id", + "type": "TypeString", + "description": "The AppID instance GUID", + "required": true + }, + { + "name": "is_active", + "type": "TypeBool", + "description": "SAML IDP activation", + "computed": true } ], "ibm_appid_idp_saml_metadata": [ @@ -3002,15 +3002,15 @@ ], "ibm_appid_theme_color": [ { - "name": "tenant_id", + "name": "header_color", "type": "TypeString", - "description": "The AppID instance GUID", - "required": true + "computed": true }, { - "name": "header_color", + "name": "tenant_id", "type": "TypeString", - "computed": true + "description": "The AppID instance GUID", + "required": true } ], "ibm_appid_theme_text": [ @@ -3497,6 +3497,71 @@ } ], "ibm_cbr_rule": [ + { + "name": "rule_id", + "type": "TypeString", + "description": "The ID of a rule.", + "required": true + }, + { + "name": "crn", + "type": "TypeString", + "description": "The rule CRN.", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "contexts", + "type": "TypeList", + "description": "The contexts this rule applies to.", + "computed": true, + "elem": { + "attributes": { + "name": "attributes", + "type": "TypeList", + "description": "The attributes.", + "computed": true, + "elem": { + "name": { + "name": "name", + "type": "TypeString", + "description": "The attribute name.", + "computed": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "The attribute value.", + "computed": true + } + } + } + } + }, + { + "name": "enforcement_mode", + "type": "TypeString", + "description": "The rule enforcement mode: * `enabled` - The restrictions are enforced and reported. This is the default. * `disabled` - The restrictions are disabled. Nothing is enforced or reported. * `report` - The restrictions are evaluated and reported, but not enforced.", + "computed": true + }, + { + "name": "href", + "type": "TypeString", + "description": "The href link to the resource.", + "computed": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "The time the resource was created.", + "computed": true + }, + { + "name": "last_modified_at", + "type": "TypeString", + "description": "The last time the resource was modified.", + "computed": true + }, { "name": "description", "type": "TypeString", @@ -3563,53 +3628,6 @@ } } }, - { - "name": "href", - "type": "TypeString", - "description": "The href link to the resource.", - "computed": true - }, - { - "name": "rule_id", - "type": "TypeString", - "description": "The ID of a rule.", - "required": true - }, - { - "name": "crn", - "type": "TypeString", - "description": "The rule CRN.", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "contexts", - "type": "TypeList", - "description": "The contexts this rule applies to.", - "computed": true, - "elem": { - "attributes": { - "name": "attributes", - "type": "TypeList", - "description": "The attributes.", - "computed": true, - "elem": { - "name": { - "name": "name", - "type": "TypeString", - "description": "The attribute name.", - "computed": true - }, - "value": { - "name": "value", - "type": "TypeString", - "description": "The attribute value.", - "computed": true - } - } - } - } - }, { "name": "operations", "type": "TypeList", @@ -3631,30 +3649,12 @@ } } }, - { - "name": "enforcement_mode", - "type": "TypeString", - "description": "The rule enforcement mode: * `enabled` - The restrictions are enforced and reported. This is the default. * `disabled` - The restrictions are disabled. Nothing is enforced or reported. * `report` - The restrictions are evaluated and reported, but not enforced.", - "computed": true - }, - { - "name": "created_at", - "type": "TypeString", - "description": "The time the resource was created.", - "computed": true - }, { "name": "created_by_id", "type": "TypeString", "description": "IAM ID of the user or service which created the resource.", "computed": true }, - { - "name": "last_modified_at", - "type": "TypeString", - "description": "The last time the resource was modified.", - "computed": true - }, { "name": "last_modified_by_id", "type": "TypeString", @@ -3664,15 +3664,15 @@ ], "ibm_cbr_zone": [ { - "name": "excluded_count", - "type": "TypeInt", - "description": "The number of excluded addresses in the zone.", - "computed": true + "name": "zone_id", + "type": "TypeString", + "description": "The ID of a zone.", + "required": true }, { - "name": "account_id", - "type": "TypeString", - "description": "The id of the account owning this zone.", + "name": "address_count", + "type": "TypeInt", + "description": "The number of addresses in the zone.", "computed": true }, { @@ -3734,16 +3734,22 @@ } }, { - "name": "created_by_id", + "name": "href", "type": "TypeString", - "description": "IAM ID of the user or service which created the resource.", + "description": "The href link to the resource.", "computed": true }, { - "name": "zone_id", + "name": "created_at", "type": "TypeString", - "description": "The ID of a zone.", - "required": true + "description": "The time the resource was created.", + "computed": true + }, + { + "name": "created_by_id", + "type": "TypeString", + "description": "IAM ID of the user or service which created the resource.", + "computed": true }, { "name": "crn", @@ -3759,21 +3765,9 @@ "computed": true }, { - "name": "href", - "type": "TypeString", - "description": "The href link to the resource.", - "computed": true - }, - { - "name": "last_modified_by_id", + "name": "account_id", "type": "TypeString", - "description": "IAM ID of the user or service which modified the resource.", - "computed": true - }, - { - "name": "address_count", - "type": "TypeInt", - "description": "The number of addresses in the zone.", + "description": "The id of the account owning this zone.", "computed": true }, { @@ -3803,54 +3797,129 @@ } }, { - "name": "created_at", + "name": "last_modified_at", "type": "TypeString", - "description": "The time the resource was created.", + "description": "The last time the resource was modified.", "computed": true }, { - "name": "last_modified_at", + "name": "excluded_count", + "type": "TypeInt", + "description": "The number of excluded addresses in the zone.", + "computed": true + }, + { + "name": "last_modified_by_id", "type": "TypeString", - "description": "The last time the resource was modified.", + "description": "IAM ID of the user or service which modified the resource.", "computed": true } ], "ibm_cd_tekton_pipeline": [ { - "name": "build_number", - "type": "TypeInt", - "description": "The latest pipeline run build number. If this property is absent, the pipeline hasn't had any pipeline runs.", + "name": "enable_partial_cloning", + "type": "TypeBool", + "description": "Flag whether to enable partial cloning for this pipeline. When partial clone is enabled, only the files contained within the paths specified in definition repositories are read and cloned, this means that symbolic links might not work. If omitted, this feature is disabled by default.", "computed": true }, { - "name": "enable_partial_cloning", + "name": "enabled", "type": "TypeBool", - "description": "Flag whether to enable partial cloning for this pipeline. When partial clone is enabled, only the files contained within the paths specified in definition repositories are read and cloned, this means that symbolic links might not work. If omitted, this feature is disabled by default.", + "description": "Flag whether this pipeline is enabled.", "computed": true }, { - "name": "pipeline_id", - "type": "TypeString", - "description": "ID of current instance.", - "required": true + "name": "resource_group", + "type": "TypeList", + "description": "The resource group in which the pipeline was created.", + "cloud_data_type": "resource_group", + "computed": true, + "elem": { + "id": { + "name": "id", + "type": "TypeString", + "description": "ID.", + "computed": true + } + } }, { - "name": "toolchain", + "name": "definitions", "type": "TypeList", - "description": "Toolchain object containing references to the parent toolchain.", + "description": "Definition list.", "computed": true, "elem": { - "crn": { - "name": "crn", + "href": { + "name": "href", "type": "TypeString", - "description": "The CRN for the toolchain that contains the Tekton pipeline.", + "description": "API URL for interacting with the definition.", "computed": true }, "id": { "name": "id", "type": "TypeString", - "description": "UUID.", + "description": "The aggregated definition ID.", "computed": true + }, + "source": { + "name": "source", + "type": "TypeList", + "description": "Source repository containing the Tekton pipeline definition.", + "computed": true, + "elem": { + "properties": { + "name": "properties", + "type": "TypeList", + "description": "Properties of the source, which define the URL of the repository and a branch or tag.", + "computed": true, + "elem": { + "branch": { + "name": "branch", + "type": "TypeString", + "description": "A branch from the repo, specify one of branch or tag only.", + "computed": true + }, + "path": { + "name": "path", + "type": "TypeString", + "description": "The path to the definition's YAML files.", + "computed": true + }, + "tag": { + "name": "tag", + "type": "TypeString", + "description": "A tag from the repo, specify one of branch or tag only.", + "computed": true + }, + "tool": { + "name": "tool", + "type": "TypeList", + "description": "Reference to the repository tool in the parent toolchain.", + "computed": true, + "elem": { + "id": { + "name": "id", + "type": "TypeString", + "description": "ID of the repository tool instance in the parent toolchain.", + "computed": true + } + } + }, + "url": { + "name": "url", + "type": "TypeString", + "description": "URL of the definition repository.", + "computed": true + } + } + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "The only supported source type is \"git\", indicating that the source is a git repository.", + "computed": true + } + } } } }, @@ -3902,32 +3971,11 @@ } }, { - "name": "runs_url", - "type": "TypeString", - "description": "URL for this pipeline showing the list of pipeline runs.", - "computed": true - }, - { - "name": "name", + "name": "created_at", "type": "TypeString", - "description": "String.", + "description": "Standard RFC 3339 Date Time String.", "computed": true }, - { - "name": "resource_group", - "type": "TypeList", - "description": "The resource group in which the pipeline was created.", - "cloud_data_type": "resource_group", - "computed": true, - "elem": { - "id": { - "name": "id", - "type": "TypeString", - "description": "ID.", - "computed": true - } - } - }, { "name": "triggers", "type": "TypeList", @@ -4197,24 +4245,12 @@ } } }, - { - "name": "enabled", - "type": "TypeBool", - "description": "Flag whether this pipeline is enabled.", - "computed": true - }, { "name": "status", "type": "TypeString", "description": "Pipeline status.", "computed": true }, - { - "name": "updated_at", - "type": "TypeString", - "description": "Standard RFC 3339 Date Time String.", - "computed": true - }, { "name": "worker", "type": "TypeList", @@ -4242,107 +4278,71 @@ } }, { - "name": "href", - "type": "TypeString", - "description": "API URL for interacting with the pipeline.", + "name": "next_build_number", + "type": "TypeInt", + "description": "The build number that will be used for the next pipeline run.", "computed": true }, { - "name": "definitions", + "name": "enable_notifications", + "type": "TypeBool", + "description": "Flag whether to enable notifications for this pipeline. When enabled, pipeline run events will be published on all slack integration specified channels in the parent toolchain. If omitted, this feature is disabled by default.", + "computed": true + }, + { + "name": "pipeline_id", + "type": "TypeString", + "description": "ID of current instance.", + "required": true + }, + { + "name": "toolchain", "type": "TypeList", - "description": "Definition list.", + "description": "Toolchain object containing references to the parent toolchain.", "computed": true, "elem": { - "href": { - "name": "href", + "crn": { + "name": "crn", "type": "TypeString", - "description": "API URL for interacting with the definition.", + "description": "The CRN for the toolchain that contains the Tekton pipeline.", "computed": true }, "id": { "name": "id", "type": "TypeString", - "description": "The aggregated definition ID.", + "description": "UUID.", "computed": true - }, - "source": { - "name": "source", - "type": "TypeList", - "description": "Source repository containing the Tekton pipeline definition.", - "computed": true, - "elem": { - "properties": { - "name": "properties", - "type": "TypeList", - "description": "Properties of the source, which define the URL of the repository and a branch or tag.", - "computed": true, - "elem": { - "branch": { - "name": "branch", - "type": "TypeString", - "description": "A branch from the repo, specify one of branch or tag only.", - "computed": true - }, - "path": { - "name": "path", - "type": "TypeString", - "description": "The path to the definition's YAML files.", - "computed": true - }, - "tag": { - "name": "tag", - "type": "TypeString", - "description": "A tag from the repo, specify one of branch or tag only.", - "computed": true - }, - "tool": { - "name": "tool", - "type": "TypeList", - "description": "Reference to the repository tool in the parent toolchain.", - "computed": true, - "elem": { - "id": { - "name": "id", - "type": "TypeString", - "description": "ID of the repository tool instance in the parent toolchain.", - "computed": true - } - } - }, - "url": { - "name": "url", - "type": "TypeString", - "description": "URL of the definition repository.", - "computed": true - } - } - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "The only supported source type is \"git\", indicating that the source is a git repository.", - "computed": true - } - } } } }, { - "name": "created_at", + "name": "build_number", + "type": "TypeInt", + "description": "The latest pipeline run build number. If this property is absent, the pipeline hasn't had any pipeline runs.", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "String.", + "computed": true + }, + { + "name": "updated_at", "type": "TypeString", "description": "Standard RFC 3339 Date Time String.", "computed": true }, { - "name": "next_build_number", - "type": "TypeInt", - "description": "The build number that will be used for the next pipeline run.", + "name": "runs_url", + "type": "TypeString", + "description": "URL for this pipeline showing the list of pipeline runs.", "computed": true }, { - "name": "enable_notifications", - "type": "TypeBool", - "description": "Flag whether to enable notifications for this pipeline. When enabled, pipeline run events will be published on all slack integration specified channels in the parent toolchain. If omitted, this feature is disabled by default.", + "name": "href", + "type": "TypeString", + "description": "API URL for interacting with the pipeline.", "computed": true } ], @@ -4427,6 +4427,36 @@ } ], "ibm_cd_tekton_pipeline_property": [ + { + "name": "pipeline_id", + "type": "TypeString", + "description": "The Tekton pipeline ID.", + "required": true + }, + { + "name": "property_name", + "type": "TypeString", + "description": "The property name.", + "required": true + }, + { + "name": "name", + "type": "TypeString", + "description": "Property name.", + "computed": true + }, + { + "name": "value", + "type": "TypeString", + "description": "Property value. Any string value is valid.", + "computed": true + }, + { + "name": "href", + "type": "TypeString", + "description": "API URL for interacting with the property.", + "computed": true + }, { "name": "enum", "type": "TypeList", @@ -4447,39 +4477,65 @@ "type": "TypeString", "description": "A dot notation path for `integration` type properties only, that selects a value from the tool integration. If left blank the full tool integration data will be used.", "computed": true - }, - { - "name": "pipeline_id", - "type": "TypeString", - "description": "The Tekton pipeline ID.", - "required": true - }, + } + ], + "ibm_cd_tekton_pipeline_trigger": [ { - "name": "property_name", + "name": "trigger_id", "type": "TypeString", - "description": "The property name.", + "description": "The trigger ID.", "required": true }, { - "name": "name", + "name": "type", "type": "TypeString", - "description": "Property name.", + "description": "Trigger type.", "computed": true }, { - "name": "value", - "type": "TypeString", - "description": "Property value. Any string value is valid.", - "computed": true + "name": "secret", + "type": "TypeList", + "description": "Only needed for generic webhook trigger type. Secret used to start generic webhook trigger.", + "computed": true, + "elem": { + "algorithm": { + "name": "algorithm", + "type": "TypeString", + "description": "Algorithm used for `digest_matches` secret type. Only needed for `digest_matches` secret type.", + "computed": true + }, + "key_name": { + "name": "key_name", + "type": "TypeString", + "description": "Secret name, not needed if type is `internal_validation`.", + "computed": true + }, + "source": { + "name": "source", + "type": "TypeString", + "description": "Secret location, not needed if secret type is `internal_validation`.", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "Secret type.", + "computed": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "Secret value, not needed if secret type is `internal_validation`.", + "computed": true + } + } }, { - "name": "href", + "name": "webhook_url", "type": "TypeString", - "description": "API URL for interacting with the property.", + "description": "Webhook URL that can be used to trigger pipeline runs.", "computed": true - } - ], - "ibm_cd_tekton_pipeline_trigger": [ + }, { "name": "href", "type": "TypeString", @@ -4534,69 +4590,81 @@ } }, { - "name": "timezone", + "name": "name", "type": "TypeString", - "description": "Only used for timer triggers. Specify the timezone used for this timer trigger, which will ensure the cron activates this trigger relative to the specified timezone. If no timezone is specified, the default timezone used is UTC. Valid timezones are those listed in the IANA timezone database, https://www.iana.org/time-zones.", + "description": "Trigger name.", "computed": true }, { - "name": "secret", + "name": "event_listener", + "type": "TypeString", + "description": "Event listener name. The name of the event listener to which the trigger is associated. The event listeners are defined in the definition repositories of the Tekton pipeline.", + "computed": true + }, + { + "name": "tags", "type": "TypeList", - "description": "Only needed for generic webhook trigger type. Secret used to start generic webhook trigger.", + "description": "Optional trigger tags array.", + "cloud_data_type": "tags", "computed": true, "elem": { - "algorithm": { - "name": "algorithm", - "type": "TypeString", - "description": "Algorithm used for `digest_matches` secret type. Only needed for `digest_matches` secret type.", - "computed": true - }, - "key_name": { - "name": "key_name", + "type": "TypeString" + } + }, + { + "name": "enabled", + "type": "TypeBool", + "description": "Flag whether the trigger is enabled.", + "computed": true + }, + { + "name": "cron", + "type": "TypeString", + "description": "Only needed for timer triggers. Cron expression that indicates when this trigger will activate. Maximum frequency is every 5 minutes. The string is based on UNIX crontab syntax: minute, hour, day of month, month, day of week. Example: 0 *_/2 * * * - every 2 hours.", + "computed": true + }, + { + "name": "pipeline_id", + "type": "TypeString", + "description": "The Tekton pipeline ID.", + "required": true + }, + { + "name": "worker", + "type": "TypeList", + "description": "Details of the worker used to run the trigger.", + "computed": true, + "elem": { + "id": { + "name": "id", "type": "TypeString", - "description": "Secret name, not needed if type is `internal_validation`.", + "description": "ID of the worker.", "computed": true }, - "source": { - "name": "source", + "name": { + "name": "name", "type": "TypeString", - "description": "Secret location, not needed if secret type is `internal_validation`.", + "description": "Name of the worker. Computed based on the worker ID.", "computed": true }, "type": { "name": "type", "type": "TypeString", - "description": "Secret type.", - "computed": true - }, - "value": { - "name": "value", - "type": "TypeString", - "description": "Secret value, not needed if secret type is `internal_validation`.", + "description": "Type of the worker. Computed based on the worker ID.", "computed": true } } }, { - "name": "pipeline_id", - "type": "TypeString", - "description": "The Tekton pipeline ID.", - "required": true - }, - { - "name": "tags", - "type": "TypeList", - "description": "Optional trigger tags array.", - "cloud_data_type": "tags", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "max_concurrent_runs", + "type": "TypeInt", + "description": "Defines the maximum number of concurrent runs for this trigger. If omitted then the concurrency limit is disabled for this trigger.", + "computed": true }, { - "name": "enabled", + "name": "favorite", "type": "TypeBool", - "description": "Flag whether the trigger is enabled.", + "description": "Mark the trigger as a favorite.", "computed": true }, { @@ -4665,36 +4733,6 @@ } } }, - { - "name": "cron", - "type": "TypeString", - "description": "Only needed for timer triggers. Cron expression that indicates when this trigger will activate. Maximum frequency is every 5 minutes. The string is based on UNIX crontab syntax: minute, hour, day of month, month, day of week. Example: 0 *_/2 * * * - every 2 hours.", - "computed": true - }, - { - "name": "type", - "type": "TypeString", - "description": "Trigger type.", - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Trigger name.", - "computed": true - }, - { - "name": "event_listener", - "type": "TypeString", - "description": "Event listener name. The name of the event listener to which the trigger is associated. The event listeners are defined in the definition repositories of the Tekton pipeline.", - "computed": true - }, - { - "name": "max_concurrent_runs", - "type": "TypeInt", - "description": "Defines the maximum number of concurrent runs for this trigger. If omitted then the concurrency limit is disabled for this trigger.", - "computed": true - }, { "name": "events", "type": "TypeList", @@ -4705,55 +4743,32 @@ } }, { - "name": "trigger_id", + "name": "timezone", "type": "TypeString", - "description": "The trigger ID.", + "description": "Only used for timer triggers. Specify the timezone used for this timer trigger, which will ensure the cron activates this trigger relative to the specified timezone. If no timezone is specified, the default timezone used is UTC. Valid timezones are those listed in the IANA timezone database, https://www.iana.org/time-zones.", + "computed": true + } + ], + "ibm_cd_tekton_pipeline_trigger_property": [ + { + "name": "property_name", + "type": "TypeString", + "description": "The property name.", "required": true }, { - "name": "worker", + "name": "enum", "type": "TypeList", - "description": "Details of the worker used to run the trigger.", + "description": "Options for `single_select` property type. Only needed for `single_select` property type.", "computed": true, "elem": { - "id": { - "name": "id", - "type": "TypeString", - "description": "ID of the worker.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Name of the worker. Computed based on the worker ID.", - "computed": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "Type of the worker. Computed based on the worker ID.", - "computed": true - } + "type": "TypeString" } }, { - "name": "favorite", - "type": "TypeBool", - "description": "Mark the trigger as a favorite.", - "computed": true - }, - { - "name": "webhook_url", - "type": "TypeString", - "description": "Webhook URL that can be used to trigger pipeline runs.", - "computed": true - } - ], - "ibm_cd_tekton_pipeline_trigger_property": [ - { - "name": "href", + "name": "path", "type": "TypeString", - "description": "API URL for interacting with the trigger property.", + "description": "A dot notation path for `integration` type properties only, that selects a value from the tool integration. If left blank the full tool integration data will be used.", "computed": true }, { @@ -4762,12 +4777,6 @@ "description": "Property type.", "computed": true }, - { - "name": "path", - "type": "TypeString", - "description": "A dot notation path for `integration` type properties only, that selects a value from the tool integration. If left blank the full tool integration data will be used.", - "computed": true - }, { "name": "pipeline_id", "type": "TypeString", @@ -4775,9 +4784,9 @@ "required": true }, { - "name": "property_name", + "name": "trigger_id", "type": "TypeString", - "description": "The property name.", + "description": "The trigger ID.", "required": true }, { @@ -4793,33 +4802,17 @@ "computed": true }, { - "name": "trigger_id", + "name": "href", "type": "TypeString", - "description": "The trigger ID.", - "required": true - }, - { - "name": "enum", - "type": "TypeList", - "description": "Options for `single_select` property type. Only needed for `single_select` property type.", - "computed": true, - "elem": { - "type": "TypeString" - } + "description": "API URL for interacting with the trigger property.", + "computed": true } ], "ibm_cd_toolchain": [ { - "name": "account_id", - "type": "TypeString", - "description": "Account ID where toolchain can be found.", - "computed": true - }, - { - "name": "location", + "name": "name", "type": "TypeString", - "description": "Toolchain region.", - "cloud_data_type": "region", + "description": "Toolchain name.", "computed": true }, { @@ -4835,49 +4828,12 @@ "description": "URI that can be used to retrieve toolchain.", "computed": true }, - { - "name": "ui_href", - "type": "TypeString", - "description": "URL of a user-facing user interface for this toolchain.", - "computed": true - }, { "name": "created_at", "type": "TypeString", "description": "Toolchain creation timestamp.", "computed": true }, - { - "name": "toolchain_id", - "type": "TypeString", - "description": "ID of the toolchain.", - "required": true - }, - { - "name": "description", - "type": "TypeString", - "description": "Toolchain description.", - "computed": true - }, - { - "name": "crn", - "type": "TypeString", - "description": "Toolchain CRN.", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "updated_at", - "type": "TypeString", - "description": "Latest toolchain update timestamp.", - "computed": true - }, - { - "name": "created_by", - "type": "TypeString", - "description": "Identity that created the toolchain.", - "computed": true - }, { "name": "tags", "type": "TypeSet", @@ -4888,14 +4844,6 @@ "type": "TypeString" } }, - { - "name": "name", - "type": "TypeString", - "description": "Toolchain name.", - "computed": true - } - ], - "ibm_cd_toolchain_tool_appconfig": [ { "name": "toolchain_id", "type": "TypeString", @@ -4903,36 +4851,51 @@ "required": true }, { - "name": "tool_id", + "name": "account_id", "type": "TypeString", - "description": "ID of the tool bound to the toolchain.", - "required": true + "description": "Account ID where toolchain can be found.", + "computed": true + }, + { + "name": "location", + "type": "TypeString", + "description": "Toolchain region.", + "cloud_data_type": "region", + "computed": true }, { "name": "crn", "type": "TypeString", - "description": "Tool CRN.", + "description": "Toolchain CRN.", "cloud_data_type": "crn", "computed": true }, { - "name": "toolchain_crn", + "name": "ui_href", "type": "TypeString", - "description": "CRN of toolchain which the tool is bound to.", + "description": "URL of a user-facing user interface for this toolchain.", "computed": true }, { - "name": "name", + "name": "updated_at", "type": "TypeString", - "description": "Tool name.", + "description": "Latest toolchain update timestamp.", "computed": true }, { - "name": "state", + "name": "created_by", "type": "TypeString", - "description": "Current configuration state of the tool.", + "description": "Identity that created the toolchain.", "computed": true }, + { + "name": "description", + "type": "TypeString", + "description": "Describes the toolchain.", + "computed": true + } + ], + "ibm_cd_toolchain_tool_appconfig": [ { "name": "resource_group_id", "type": "TypeString", @@ -4966,6 +4929,37 @@ } } }, + { + "name": "toolchain_id", + "type": "TypeString", + "description": "ID of the toolchain.", + "required": true + }, + { + "name": "tool_id", + "type": "TypeString", + "description": "ID of the tool bound to the toolchain.", + "required": true + }, + { + "name": "crn", + "type": "TypeString", + "description": "Tool CRN.", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "toolchain_crn", + "type": "TypeString", + "description": "CRN of toolchain which the tool is bound to.", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "Name of the tool.", + "computed": true + }, { "name": "updated_at", "type": "TypeString", @@ -5015,6 +5009,12 @@ "computed": true } } + }, + { + "name": "state", + "type": "TypeString", + "description": "Current configuration state of the tool.", + "computed": true } ], "ibm_cd_toolchain_tool_artifactory": [ @@ -5024,76 +5024,12 @@ "description": "ID of the tool bound to the toolchain.", "required": true }, - { - "name": "toolchain_crn", - "type": "TypeString", - "description": "CRN of toolchain which the tool is bound to.", - "computed": true - }, - { - "name": "href", - "type": "TypeString", - "description": "URI representing the tool.", - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Tool name.", - "computed": true - }, { "name": "updated_at", "type": "TypeString", "description": "Latest tool update timestamp.", "computed": true }, - { - "name": "state", - "type": "TypeString", - "description": "Current configuration state of the tool.", - "computed": true - }, - { - "name": "toolchain_id", - "type": "TypeString", - "description": "ID of the toolchain.", - "required": true - }, - { - "name": "resource_group_id", - "type": "TypeString", - "description": "Resource group where the tool is located.", - "cloud_data_type": "resource_group", - "computed": true - }, - { - "name": "crn", - "type": "TypeString", - "description": "Tool CRN.", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "referent", - "type": "TypeList", - "description": "Information on URIs to access this resource through the UI or API.", - "computed": true, - "elem": { - "api_href": { - "name": "api_href", - "type": "TypeString", - "description": "URI representing this resource through an API.", - "computed": true - }, - "ui_href": { - "name": "ui_href", - "type": "TypeString", - "description": "URI representing this resource through the UI.", - "computed": true - } - } - }, { "name": "parameters", "type": "TypeList", @@ -5162,9 +5098,19 @@ "computed": true } } - } - ], - "ibm_cd_toolchain_tool_bitbucketgit": [ + }, + { + "name": "toolchain_crn", + "type": "TypeString", + "description": "CRN of toolchain which the tool is bound to.", + "computed": true + }, + { + "name": "href", + "type": "TypeString", + "description": "URI representing the tool.", + "computed": true + }, { "name": "referent", "type": "TypeList", @@ -5186,21 +5132,21 @@ } }, { - "name": "updated_at", + "name": "name", "type": "TypeString", - "description": "Latest tool update timestamp.", + "description": "Name of the tool.", "computed": true }, { - "name": "toolchain_id", + "name": "state", "type": "TypeString", - "description": "ID of the toolchain.", - "required": true + "description": "Current configuration state of the tool.", + "computed": true }, { - "name": "tool_id", + "name": "toolchain_id", "type": "TypeString", - "description": "ID of the tool bound to the toolchain.", + "description": "ID of the toolchain.", "required": true }, { @@ -5216,23 +5162,32 @@ "description": "Tool CRN.", "cloud_data_type": "crn", "computed": true + } + ], + "ibm_cd_toolchain_tool_bitbucketgit": [ + { + "name": "tool_id", + "type": "TypeString", + "description": "ID of the tool bound to the toolchain.", + "required": true }, { - "name": "toolchain_crn", + "name": "crn", "type": "TypeString", - "description": "CRN of toolchain which the tool is bound to.", + "description": "Tool CRN.", + "cloud_data_type": "crn", "computed": true }, { - "name": "href", + "name": "toolchain_crn", "type": "TypeString", - "description": "URI representing the tool.", + "description": "CRN of toolchain which the tool is bound to.", "computed": true }, { - "name": "name", + "name": "updated_at", "type": "TypeString", - "description": "Tool name.", + "description": "Latest tool update timestamp.", "computed": true }, { @@ -5327,20 +5282,6 @@ } } }, - { - "name": "state", - "type": "TypeString", - "description": "Current configuration state of the tool.", - "computed": true - } - ], - "ibm_cd_toolchain_tool_custom": [ - { - "name": "name", - "type": "TypeString", - "description": "Tool name.", - "computed": true - }, { "name": "state", "type": "TypeString", @@ -5360,6 +5301,40 @@ "cloud_data_type": "resource_group", "computed": true }, + { + "name": "href", + "type": "TypeString", + "description": "URI representing the tool.", + "computed": true + }, + { + "name": "referent", + "type": "TypeList", + "description": "Information on URIs to access this resource through the UI or API.", + "computed": true, + "elem": { + "api_href": { + "name": "api_href", + "type": "TypeString", + "description": "URI representing this resource through an API.", + "computed": true + }, + "ui_href": { + "name": "ui_href", + "type": "TypeString", + "description": "URI representing this resource through the UI.", + "computed": true + } + } + }, + { + "name": "name", + "type": "TypeString", + "description": "Name of the tool.", + "computed": true + } + ], + "ibm_cd_toolchain_tool_custom": [ { "name": "crn", "type": "TypeString", @@ -5393,18 +5368,43 @@ } } }, + { + "name": "state", + "type": "TypeString", + "description": "Current configuration state of the tool.", + "computed": true + }, + { + "name": "toolchain_id", + "type": "TypeString", + "description": "ID of the toolchain.", + "required": true + }, { "name": "tool_id", "type": "TypeString", "description": "ID of the tool bound to the toolchain.", "required": true }, + { + "name": "resource_group_id", + "type": "TypeString", + "description": "Resource group where the tool is located.", + "cloud_data_type": "resource_group", + "computed": true + }, { "name": "href", "type": "TypeString", "description": "URI representing the tool.", "computed": true }, + { + "name": "name", + "type": "TypeString", + "description": "Name of the tool.", + "computed": true + }, { "name": "updated_at", "type": "TypeString", @@ -5470,16 +5470,17 @@ ], "ibm_cd_toolchain_tool_devopsinsights": [ { - "name": "toolchain_id", + "name": "tool_id", "type": "TypeString", - "description": "ID of the toolchain.", + "description": "ID of the tool bound to the toolchain.", "required": true }, { - "name": "tool_id", + "name": "crn", "type": "TypeString", - "description": "ID of the tool bound to the toolchain.", - "required": true + "description": "Tool CRN.", + "cloud_data_type": "crn", + "computed": true }, { "name": "toolchain_crn", @@ -5488,9 +5489,29 @@ "computed": true }, { - "name": "updated_at", + "name": "referent", + "type": "TypeList", + "description": "Information on URIs to access this resource through the UI or API.", + "computed": true, + "elem": { + "api_href": { + "name": "api_href", + "type": "TypeString", + "description": "URI representing this resource through an API.", + "computed": true + }, + "ui_href": { + "name": "ui_href", + "type": "TypeString", + "description": "URI representing this resource through the UI.", + "computed": true + } + } + }, + { + "name": "name", "type": "TypeString", - "description": "Latest tool update timestamp.", + "description": "Name of the tool.", "computed": true }, { @@ -5500,25 +5521,32 @@ "computed": true }, { - "name": "resource_group_id", + "name": "toolchain_id", "type": "TypeString", - "description": "Resource group where the tool is located.", - "cloud_data_type": "resource_group", - "computed": true + "description": "ID of the toolchain.", + "required": true }, { - "name": "crn", + "name": "href", "type": "TypeString", - "description": "Tool CRN.", - "cloud_data_type": "crn", + "description": "URI representing the tool.", "computed": true }, { - "name": "href", + "name": "updated_at", "type": "TypeString", - "description": "URI representing the tool.", + "description": "Latest tool update timestamp.", "computed": true }, + { + "name": "resource_group_id", + "type": "TypeString", + "description": "Resource group where the tool is located.", + "cloud_data_type": "resource_group", + "computed": true + } + ], + "ibm_cd_toolchain_tool_eventnotifications": [ { "name": "referent", "type": "TypeList", @@ -5542,17 +5570,29 @@ { "name": "name", "type": "TypeString", - "description": "Tool name.", + "description": "Name of the tool.", "computed": true - } - ], - "ibm_cd_toolchain_tool_eventnotifications": [ + }, + { + "name": "crn", + "type": "TypeString", + "description": "Tool CRN.", + "cloud_data_type": "crn", + "computed": true + }, { "name": "tool_id", "type": "TypeString", "description": "ID of the tool bound to the toolchain.", "required": true }, + { + "name": "resource_group_id", + "type": "TypeString", + "description": "Resource group where the tool is located.", + "cloud_data_type": "resource_group", + "computed": true + }, { "name": "toolchain_crn", "type": "TypeString", @@ -5560,9 +5600,9 @@ "computed": true }, { - "name": "state", + "name": "href", "type": "TypeString", - "description": "Current configuration state of the tool.", + "description": "URI representing the tool.", "computed": true }, { @@ -5592,56 +5632,16 @@ } }, { - "name": "toolchain_id", - "type": "TypeString", - "description": "ID of the toolchain.", - "required": true - }, - { - "name": "resource_group_id", - "type": "TypeString", - "description": "Resource group where the tool is located.", - "cloud_data_type": "resource_group", - "computed": true - }, - { - "name": "crn", - "type": "TypeString", - "description": "Tool CRN.", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "href", + "name": "state", "type": "TypeString", - "description": "URI representing the tool.", + "description": "Current configuration state of the tool.", "computed": true }, { - "name": "referent", - "type": "TypeList", - "description": "Information on URIs to access this resource through the UI or API.", - "computed": true, - "elem": { - "api_href": { - "name": "api_href", - "type": "TypeString", - "description": "URI representing this resource through an API.", - "computed": true - }, - "ui_href": { - "name": "ui_href", - "type": "TypeString", - "description": "URI representing this resource through the UI.", - "computed": true - } - } - }, - { - "name": "name", + "name": "toolchain_id", "type": "TypeString", - "description": "Tool name.", - "computed": true + "description": "ID of the toolchain.", + "required": true } ], "ibm_cd_toolchain_tool_githubconsolidated": [ @@ -5665,37 +5665,12 @@ } } }, - { - "name": "name", - "type": "TypeString", - "description": "Tool name.", - "computed": true - }, { "name": "updated_at", "type": "TypeString", "description": "Latest tool update timestamp.", "computed": true }, - { - "name": "toolchain_id", - "type": "TypeString", - "description": "ID of the toolchain.", - "required": true - }, - { - "name": "tool_id", - "type": "TypeString", - "description": "ID of the tool bound to the toolchain.", - "required": true - }, - { - "name": "crn", - "type": "TypeString", - "description": "Tool CRN.", - "cloud_data_type": "crn", - "computed": true - }, { "name": "parameters", "type": "TypeList", @@ -5748,7 +5723,7 @@ "git_id": { "name": "git_id", "type": "TypeString", - "description": "Set this value to 'github' for github.com, the GUID of an existing custom GitHub Enterprise server, or 'githubcustom'.", + "description": "Set this value to 'github' for github.com, or 'githubcustom' for a custom GitHub Enterprise server.", "computed": true }, "integration_owner": { @@ -5825,12 +5800,42 @@ } } }, + { + "name": "tool_id", + "type": "TypeString", + "description": "ID of the tool bound to the toolchain.", + "required": true + }, + { + "name": "toolchain_crn", + "type": "TypeString", + "description": "CRN of toolchain which the tool is bound to.", + "computed": true + }, + { + "name": "href", + "type": "TypeString", + "description": "URI representing the tool.", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "Name of the tool.", + "computed": true + }, { "name": "state", "type": "TypeString", "description": "Current configuration state of the tool.", "computed": true }, + { + "name": "toolchain_id", + "type": "TypeString", + "description": "ID of the toolchain.", + "required": true + }, { "name": "resource_group_id", "type": "TypeString", @@ -5839,25 +5844,45 @@ "computed": true }, { - "name": "toolchain_crn", + "name": "crn", "type": "TypeString", - "description": "CRN of toolchain which the tool is bound to.", + "description": "Tool CRN.", + "cloud_data_type": "crn", "computed": true - }, + } + ], + "ibm_cd_toolchain_tool_gitlab": [ { "name": "href", "type": "TypeString", "description": "URI representing the tool.", "computed": true - } - ], - "ibm_cd_toolchain_tool_gitlab": [ + }, + { + "name": "name", + "type": "TypeString", + "description": "Name of the tool.", + "computed": true + }, + { + "name": "state", + "type": "TypeString", + "description": "Current configuration state of the tool.", + "computed": true + }, { "name": "tool_id", "type": "TypeString", "description": "ID of the tool bound to the toolchain.", "required": true }, + { + "name": "resource_group_id", + "type": "TypeString", + "description": "Resource group where the tool is located.", + "cloud_data_type": "resource_group", + "computed": true + }, { "name": "crn", "type": "TypeString", @@ -5865,6 +5890,12 @@ "cloud_data_type": "crn", "computed": true }, + { + "name": "toolchain_crn", + "type": "TypeString", + "description": "CRN of toolchain which the tool is bound to.", + "computed": true + }, { "name": "referent", "type": "TypeList", @@ -5937,7 +5968,7 @@ "git_id": { "name": "git_id", "type": "TypeString", - "description": "Set this value to 'gitlab' for gitlab.com, the GUID of an existing custom GitLab server, or 'gitlabcustom'.", + "description": "Set this value to 'gitlab' for gitlab.com, or 'gitlabcustom' for a custom GitLab server.", "computed": true }, "integration_owner": { @@ -6014,30 +6045,19 @@ } } }, - { - "name": "state", - "type": "TypeString", - "description": "Current configuration state of the tool.", - "computed": true - }, { "name": "toolchain_id", "type": "TypeString", "description": "ID of the toolchain.", "required": true - }, - { - "name": "resource_group_id", - "type": "TypeString", - "description": "Resource group where the tool is located.", - "cloud_data_type": "resource_group", - "computed": true - }, + } + ], + "ibm_cd_toolchain_tool_hashicorpvault": [ { - "name": "toolchain_crn", + "name": "toolchain_id", "type": "TypeString", - "description": "CRN of toolchain which the tool is bound to.", - "computed": true + "description": "ID of the toolchain.", + "required": true }, { "name": "href", @@ -6045,14 +6065,32 @@ "description": "URI representing the tool.", "computed": true }, + { + "name": "referent", + "type": "TypeList", + "description": "Information on URIs to access this resource through the UI or API.", + "computed": true, + "elem": { + "api_href": { + "name": "api_href", + "type": "TypeString", + "description": "URI representing this resource through an API.", + "computed": true + }, + "ui_href": { + "name": "ui_href", + "type": "TypeString", + "description": "URI representing this resource through the UI.", + "computed": true + } + } + }, { "name": "name", "type": "TypeString", - "description": "Tool name.", + "description": "Name of the tool.", "computed": true - } - ], - "ibm_cd_toolchain_tool_hashicorpvault": [ + }, { "name": "parameters", "type": "TypeList", @@ -6144,16 +6182,10 @@ "computed": true }, { - "name": "href", - "type": "TypeString", - "description": "URI representing the tool.", - "computed": true - }, - { - "name": "updated_at", + "name": "tool_id", "type": "TypeString", - "description": "Latest tool update timestamp.", - "computed": true + "description": "ID of the tool bound to the toolchain.", + "required": true }, { "name": "resource_group_id", @@ -6175,6 +6207,14 @@ "description": "CRN of toolchain which the tool is bound to.", "computed": true }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Latest tool update timestamp.", + "computed": true + } + ], + "ibm_cd_toolchain_tool_hostedgit": [ { "name": "referent", "type": "TypeList", @@ -6198,84 +6238,7 @@ { "name": "name", "type": "TypeString", - "description": "Tool name.", - "computed": true - }, - { - "name": "toolchain_id", - "type": "TypeString", - "description": "ID of the toolchain.", - "required": true - }, - { - "name": "tool_id", - "type": "TypeString", - "description": "ID of the tool bound to the toolchain.", - "required": true - } - ], - "ibm_cd_toolchain_tool_hostedgit": [ - { - "name": "state", - "type": "TypeString", - "description": "Current configuration state of the tool.", - "computed": true - }, - { - "name": "tool_id", - "type": "TypeString", - "description": "ID of the tool bound to the toolchain.", - "required": true - }, - { - "name": "toolchain_crn", - "type": "TypeString", - "description": "CRN of toolchain which the tool is bound to.", - "computed": true - }, - { - "name": "crn", - "type": "TypeString", - "description": "Tool CRN.", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "href", - "type": "TypeString", - "description": "URI representing the tool.", - "computed": true - }, - { - "name": "referent", - "type": "TypeList", - "description": "Information on URIs to access this resource through the UI or API.", - "computed": true, - "elem": { - "api_href": { - "name": "api_href", - "type": "TypeString", - "description": "URI representing this resource through an API.", - "computed": true - }, - "ui_href": { - "name": "ui_href", - "type": "TypeString", - "description": "URI representing this resource through the UI.", - "computed": true - } - } - }, - { - "name": "name", - "type": "TypeString", - "description": "Tool name.", - "computed": true - }, - { - "name": "updated_at", - "type": "TypeString", - "description": "Latest tool update timestamp.", + "description": "Name of the tool.", "computed": true }, { @@ -6384,10 +6347,10 @@ } }, { - "name": "toolchain_id", + "name": "state", "type": "TypeString", - "description": "ID of the toolchain.", - "required": true + "description": "Current configuration state of the tool.", + "computed": true }, { "name": "resource_group_id", @@ -6395,6 +6358,43 @@ "description": "Resource group where the tool is located.", "cloud_data_type": "resource_group", "computed": true + }, + { + "name": "href", + "type": "TypeString", + "description": "URI representing the tool.", + "computed": true + }, + { + "name": "crn", + "type": "TypeString", + "description": "Tool CRN.", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "toolchain_crn", + "type": "TypeString", + "description": "CRN of toolchain which the tool is bound to.", + "computed": true + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Latest tool update timestamp.", + "computed": true + }, + { + "name": "toolchain_id", + "type": "TypeString", + "description": "ID of the toolchain.", + "required": true + }, + { + "name": "tool_id", + "type": "TypeString", + "description": "ID of the tool bound to the toolchain.", + "required": true } ], "ibm_cd_toolchain_tool_jenkins": [ @@ -6404,6 +6404,12 @@ "description": "CRN of toolchain which the tool is bound to.", "computed": true }, + { + "name": "href", + "type": "TypeString", + "description": "URI representing the tool.", + "computed": true + }, { "name": "referent", "type": "TypeList", @@ -6427,7 +6433,7 @@ { "name": "name", "type": "TypeString", - "description": "Tool name.", + "description": "Name of the tool.", "computed": true }, { @@ -6436,6 +6442,12 @@ "description": "Current configuration state of the tool.", "computed": true }, + { + "name": "tool_id", + "type": "TypeString", + "description": "ID of the tool bound to the toolchain.", + "required": true + }, { "name": "resource_group_id", "type": "TypeString", @@ -6451,10 +6463,10 @@ "computed": true }, { - "name": "href", + "name": "toolchain_id", "type": "TypeString", - "description": "URI representing the tool.", - "computed": true + "description": "ID of the toolchain.", + "required": true }, { "name": "updated_at", @@ -6501,57 +6513,15 @@ "computed": true } } - }, - { - "name": "toolchain_id", - "type": "TypeString", - "description": "ID of the toolchain.", - "required": true - }, - { - "name": "tool_id", - "type": "TypeString", - "description": "ID of the tool bound to the toolchain.", - "required": true } ], "ibm_cd_toolchain_tool_jira": [ - { - "name": "href", - "type": "TypeString", - "description": "URI representing the tool.", - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Tool name.", - "computed": true - }, - { - "name": "updated_at", - "type": "TypeString", - "description": "Latest tool update timestamp.", - "computed": true - }, - { - "name": "state", - "type": "TypeString", - "description": "Current configuration state of the tool.", - "computed": true - }, { "name": "tool_id", "type": "TypeString", "description": "ID of the tool bound to the toolchain.", "required": true }, - { - "name": "toolchain_crn", - "type": "TypeString", - "description": "CRN of toolchain which the tool is bound to.", - "computed": true - }, { "name": "crn", "type": "TypeString", @@ -6560,24 +6530,10 @@ "computed": true }, { - "name": "referent", - "type": "TypeList", - "description": "Information on URIs to access this resource through the UI or API.", - "computed": true, - "elem": { - "api_href": { - "name": "api_href", - "type": "TypeString", - "description": "URI representing this resource through an API.", - "computed": true - }, - "ui_href": { - "name": "ui_href", - "type": "TypeString", - "description": "URI representing this resource through the UI.", - "computed": true - } - } + "name": "updated_at", + "type": "TypeString", + "description": "Latest tool update timestamp.", + "computed": true }, { "name": "parameters", @@ -6618,6 +6574,12 @@ } } }, + { + "name": "state", + "type": "TypeString", + "description": "Current configuration state of the tool.", + "computed": true + }, { "name": "toolchain_id", "type": "TypeString", @@ -6630,9 +6592,7 @@ "description": "Resource group where the tool is located.", "cloud_data_type": "resource_group", "computed": true - } - ], - "ibm_cd_toolchain_tool_keyprotect": [ + }, { "name": "toolchain_crn", "type": "TypeString", @@ -6645,10 +6605,71 @@ "description": "URI representing the tool.", "computed": true }, + { + "name": "referent", + "type": "TypeList", + "description": "Information on URIs to access this resource through the UI or API.", + "computed": true, + "elem": { + "api_href": { + "name": "api_href", + "type": "TypeString", + "description": "URI representing this resource through an API.", + "computed": true + }, + "ui_href": { + "name": "ui_href", + "type": "TypeString", + "description": "URI representing this resource through the UI.", + "computed": true + } + } + }, + { + "name": "name", + "type": "TypeString", + "description": "Name of the tool.", + "computed": true + } + ], + "ibm_cd_toolchain_tool_keyprotect": [ + { + "name": "toolchain_id", + "type": "TypeString", + "description": "ID of the toolchain.", + "required": true + }, + { + "name": "crn", + "type": "TypeString", + "description": "Tool CRN.", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "referent", + "type": "TypeList", + "description": "Information on URIs to access this resource through the UI or API.", + "computed": true, + "elem": { + "api_href": { + "name": "api_href", + "type": "TypeString", + "description": "URI representing this resource through an API.", + "computed": true + }, + "ui_href": { + "name": "ui_href", + "type": "TypeString", + "description": "URI representing this resource through the UI.", + "computed": true + } + } + }, { "name": "name", "type": "TypeString", - "description": "Tool name.", + "description": "Name of the tool.", "computed": true }, { @@ -6689,12 +6710,6 @@ } } }, - { - "name": "toolchain_id", - "type": "TypeString", - "description": "ID of the toolchain.", - "required": true - }, { "name": "tool_id", "type": "TypeString", @@ -6709,57 +6724,9 @@ "computed": true }, { - "name": "state", - "type": "TypeString", - "description": "Current configuration state of the tool.", - "computed": true - }, - { - "name": "crn", - "type": "TypeString", - "description": "Tool CRN.", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "referent", - "type": "TypeList", - "description": "Information on URIs to access this resource through the UI or API.", - "computed": true, - "elem": { - "api_href": { - "name": "api_href", - "type": "TypeString", - "description": "URI representing this resource through an API.", - "computed": true - }, - "ui_href": { - "name": "ui_href", - "type": "TypeString", - "description": "URI representing this resource through the UI.", - "computed": true - } - } - } - ], - "ibm_cd_toolchain_tool_nexus": [ - { - "name": "toolchain_id", - "type": "TypeString", - "description": "ID of the toolchain.", - "required": true - }, - { - "name": "tool_id", - "type": "TypeString", - "description": "ID of the tool bound to the toolchain.", - "required": true - }, - { - "name": "crn", + "name": "toolchain_crn", "type": "TypeString", - "description": "Tool CRN.", - "cloud_data_type": "crn", + "description": "CRN of toolchain which the tool is bound to.", "computed": true }, { @@ -6769,17 +6736,13 @@ "computed": true }, { - "name": "name", - "type": "TypeString", - "description": "Tool name.", - "computed": true - }, - { - "name": "updated_at", + "name": "state", "type": "TypeString", - "description": "Latest tool update timestamp.", + "description": "Current configuration state of the tool.", "computed": true - }, + } + ], + "ibm_cd_toolchain_tool_nexus": [ { "name": "parameters", "type": "TypeList", @@ -6843,6 +6806,18 @@ "description": "Current configuration state of the tool.", "computed": true }, + { + "name": "toolchain_id", + "type": "TypeString", + "description": "ID of the toolchain.", + "required": true + }, + { + "name": "tool_id", + "type": "TypeString", + "description": "ID of the tool bound to the toolchain.", + "required": true + }, { "name": "resource_group_id", "type": "TypeString", @@ -6850,6 +6825,25 @@ "cloud_data_type": "resource_group", "computed": true }, + { + "name": "href", + "type": "TypeString", + "description": "URI representing the tool.", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "Name of the tool.", + "computed": true + }, + { + "name": "crn", + "type": "TypeString", + "description": "Tool CRN.", + "cloud_data_type": "crn", + "computed": true + }, { "name": "toolchain_crn", "type": "TypeString", @@ -6875,26 +6869,45 @@ "computed": true } } + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Latest tool update timestamp.", + "computed": true } ], "ibm_cd_toolchain_tool_pagerduty": [ { - "name": "name", + "name": "toolchain_id", + "type": "TypeString", + "description": "ID of the toolchain.", + "required": true + }, + { + "name": "tool_id", + "type": "TypeString", + "description": "ID of the tool bound to the toolchain.", + "required": true + }, + { + "name": "href", "type": "TypeString", - "description": "Tool name.", + "description": "URI representing the tool.", "computed": true }, { - "name": "state", + "name": "name", "type": "TypeString", - "description": "Current configuration state of the tool.", + "description": "Name of the tool.", "computed": true }, { - "name": "tool_id", + "name": "resource_group_id", "type": "TypeString", - "description": "ID of the tool bound to the toolchain.", - "required": true + "description": "Resource group where the tool is located.", + "cloud_data_type": "resource_group", + "computed": true }, { "name": "crn", @@ -6909,12 +6922,6 @@ "description": "CRN of toolchain which the tool is bound to.", "computed": true }, - { - "name": "href", - "type": "TypeString", - "description": "URI representing the tool.", - "computed": true - }, { "name": "referent", "type": "TypeList", @@ -6935,19 +6942,6 @@ } } }, - { - "name": "toolchain_id", - "type": "TypeString", - "description": "ID of the toolchain.", - "required": true - }, - { - "name": "resource_group_id", - "type": "TypeString", - "description": "Resource group where the tool is located.", - "cloud_data_type": "resource_group", - "computed": true - }, { "name": "updated_at", "type": "TypeString", @@ -6980,9 +6974,27 @@ "computed": true } } + }, + { + "name": "state", + "type": "TypeString", + "description": "Current configuration state of the tool.", + "computed": true } ], "ibm_cd_toolchain_tool_pipeline": [ + { + "name": "tool_id", + "type": "TypeString", + "description": "ID of the tool bound to the toolchain.", + "required": true + }, + { + "name": "toolchain_crn", + "type": "TypeString", + "description": "CRN of toolchain which the tool is bound to.", + "computed": true + }, { "name": "href", "type": "TypeString", @@ -6990,24 +7002,10 @@ "computed": true }, { - "name": "referent", - "type": "TypeList", - "description": "Information on URIs to access this resource through the UI or API.", - "computed": true, - "elem": { - "api_href": { - "name": "api_href", - "type": "TypeString", - "description": "URI representing this resource through an API.", - "computed": true - }, - "ui_href": { - "name": "ui_href", - "type": "TypeString", - "description": "URI representing this resource through the UI.", - "computed": true - } - } + "name": "name", + "type": "TypeString", + "description": "Name of the tool.", + "computed": true }, { "name": "updated_at", @@ -7041,12 +7039,6 @@ "description": "ID of the toolchain.", "required": true }, - { - "name": "tool_id", - "type": "TypeString", - "description": "ID of the tool bound to the toolchain.", - "required": true - }, { "name": "resource_group_id", "type": "TypeString", @@ -7062,24 +7054,59 @@ "computed": true }, { - "name": "toolchain_crn", - "type": "TypeString", - "description": "CRN of toolchain which the tool is bound to.", - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Tool name.", - "computed": true + "name": "referent", + "type": "TypeList", + "description": "Information on URIs to access this resource through the UI or API.", + "computed": true, + "elem": { + "api_href": { + "name": "api_href", + "type": "TypeString", + "description": "URI representing this resource through an API.", + "computed": true + }, + "ui_href": { + "name": "ui_href", + "type": "TypeString", + "description": "URI representing this resource through the UI.", + "computed": true + } + } } ], "ibm_cd_toolchain_tool_privateworker": [ { - "name": "tool_id", + "name": "parameters", + "type": "TypeList", + "description": "Unique key-value pairs representing parameters to be used to create the tool. A list of parameters for each tool integration can be found in the \u003ca href=\"https://cloud.ibm.com/docs/ContinuousDelivery?topic=ContinuousDelivery-integrations\"\u003eConfiguring tool integrations page\u003c/a\u003e.", + "computed": true, + "elem": { + "name": { + "name": "name", + "type": "TypeString", + "description": "The name used for this tool integration.", + "computed": true + }, + "worker_queue_credentials": { + "name": "worker_queue_credentials", + "type": "TypeString", + "description": "The service ID API key that is used by the private worker to authenticate access to the work queue. You can use a toolchain secret reference for this parameter. For more information, see [Protecting your sensitive data in Continuous Delivery](https://cloud.ibm.com/docs/ContinuousDelivery?topic=ContinuousDelivery-cd_data_security#cd_secure_credentials).", + "secure": true, + "computed": true + }, + "worker_queue_identifier": { + "name": "worker_queue_identifier", + "type": "TypeString", + "description": "The service ID which identifies this private workers run request queue.", + "computed": true + } + } + }, + { + "name": "state", "type": "TypeString", - "description": "ID of the tool bound to the toolchain.", - "required": true + "description": "Current configuration state of the tool.", + "computed": true }, { "name": "resource_group_id", @@ -7096,9 +7123,9 @@ "computed": true }, { - "name": "toolchain_crn", + "name": "href", "type": "TypeString", - "description": "CRN of toolchain which the tool is bound to.", + "description": "URI representing the tool.", "computed": true }, { @@ -7127,12 +7154,6 @@ "description": "Latest tool update timestamp.", "computed": true }, - { - "name": "state", - "type": "TypeString", - "description": "Current configuration state of the tool.", - "computed": true - }, { "name": "toolchain_id", "type": "TypeString", @@ -7140,50 +7161,30 @@ "required": true }, { - "name": "name", + "name": "tool_id", "type": "TypeString", - "description": "Tool name.", - "computed": true + "description": "ID of the tool bound to the toolchain.", + "required": true }, { - "name": "parameters", - "type": "TypeList", - "description": "Unique key-value pairs representing parameters to be used to create the tool. A list of parameters for each tool integration can be found in the \u003ca href=\"https://cloud.ibm.com/docs/ContinuousDelivery?topic=ContinuousDelivery-integrations\"\u003eConfiguring tool integrations page\u003c/a\u003e.", - "computed": true, - "elem": { - "name": { - "name": "name", - "type": "TypeString", - "description": "The name used for this tool integration.", - "computed": true - }, - "worker_queue_credentials": { - "name": "worker_queue_credentials", - "type": "TypeString", - "description": "The service ID API key that is used by the private worker to authenticate access to the work queue. You can use a toolchain secret reference for this parameter. For more information, see [Protecting your sensitive data in Continuous Delivery](https://cloud.ibm.com/docs/ContinuousDelivery?topic=ContinuousDelivery-cd_data_security#cd_secure_credentials).", - "secure": true, - "computed": true - }, - "worker_queue_identifier": { - "name": "worker_queue_identifier", - "type": "TypeString", - "description": "The service ID which identifies this private workers run request queue.", - "computed": true - } - } + "name": "toolchain_crn", + "type": "TypeString", + "description": "CRN of toolchain which the tool is bound to.", + "computed": true }, { - "name": "href", + "name": "name", "type": "TypeString", - "description": "URI representing the tool.", + "description": "Name of the tool.", "computed": true } ], "ibm_cd_toolchain_tool_saucelabs": [ { - "name": "updated_at", + "name": "crn", "type": "TypeString", - "description": "Latest tool update timestamp.", + "description": "Tool CRN.", + "cloud_data_type": "crn", "computed": true }, { @@ -7192,12 +7193,6 @@ "description": "CRN of toolchain which the tool is bound to.", "computed": true }, - { - "name": "href", - "type": "TypeString", - "description": "URI representing the tool.", - "computed": true - }, { "name": "referent", "type": "TypeList", @@ -7218,19 +7213,6 @@ } } }, - { - "name": "crn", - "type": "TypeString", - "description": "Tool CRN.", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Tool name.", - "computed": true - }, { "name": "parameters", "type": "TypeList", @@ -7252,6 +7234,37 @@ } } }, + { + "name": "tool_id", + "type": "TypeString", + "description": "ID of the tool bound to the toolchain.", + "required": true + }, + { + "name": "resource_group_id", + "type": "TypeString", + "description": "Resource group where the tool is located.", + "cloud_data_type": "resource_group", + "computed": true + }, + { + "name": "href", + "type": "TypeString", + "description": "URI representing the tool.", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "Name of the tool.", + "computed": true + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Latest tool update timestamp.", + "computed": true + }, { "name": "state", "type": "TypeString", @@ -7263,33 +7276,32 @@ "type": "TypeString", "description": "ID of the toolchain.", "required": true - }, + } + ], + "ibm_cd_toolchain_tool_secretsmanager": [ { - "name": "tool_id", + "name": "name", "type": "TypeString", - "description": "ID of the tool bound to the toolchain.", - "required": true + "description": "Name of the tool.", + "computed": true }, { - "name": "resource_group_id", + "name": "updated_at", "type": "TypeString", - "description": "Resource group where the tool is located.", - "cloud_data_type": "resource_group", + "description": "Latest tool update timestamp.", "computed": true - } - ], - "ibm_cd_toolchain_tool_secretsmanager": [ + }, { - "name": "toolchain_id", + "name": "toolchain_crn", "type": "TypeString", - "description": "ID of the toolchain.", - "required": true + "description": "CRN of toolchain which the tool is bound to.", + "computed": true }, { - "name": "tool_id", + "name": "href", "type": "TypeString", - "description": "ID of the tool bound to the toolchain.", - "required": true + "description": "URI representing the tool.", + "computed": true }, { "name": "referent", @@ -7312,9 +7324,10 @@ } }, { - "name": "updated_at", + "name": "crn", "type": "TypeString", - "description": "Latest tool update timestamp.", + "description": "Tool CRN.", + "cloud_data_type": "crn", "computed": true }, { @@ -7368,43 +7381,15 @@ "computed": true }, { - "name": "resource_group_id", - "type": "TypeString", - "description": "Resource group where the tool is located.", - "cloud_data_type": "resource_group", - "computed": true - }, - { - "name": "crn", - "type": "TypeString", - "description": "Tool CRN.", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "toolchain_crn", - "type": "TypeString", - "description": "CRN of toolchain which the tool is bound to.", - "computed": true - }, - { - "name": "href", + "name": "toolchain_id", "type": "TypeString", - "description": "URI representing the tool.", - "computed": true + "description": "ID of the toolchain.", + "required": true }, { - "name": "name", - "type": "TypeString", - "description": "Tool name.", - "computed": true - } - ], - "ibm_cd_toolchain_tool_securitycompliance": [ - { - "name": "toolchain_id", + "name": "tool_id", "type": "TypeString", - "description": "ID of the toolchain.", + "description": "ID of the tool bound to the toolchain.", "required": true }, { @@ -7413,13 +7398,9 @@ "description": "Resource group where the tool is located.", "cloud_data_type": "resource_group", "computed": true - }, - { - "name": "toolchain_crn", - "type": "TypeString", - "description": "CRN of toolchain which the tool is bound to.", - "computed": true - }, + } + ], + "ibm_cd_toolchain_tool_securitycompliance": [ { "name": "referent", "type": "TypeList", @@ -7440,12 +7421,6 @@ } } }, - { - "name": "state", - "type": "TypeString", - "description": "Current configuration state of the tool.", - "computed": true - }, { "name": "parameters", "type": "TypeList", @@ -7458,7 +7433,7 @@ "description": "The IBM Cloud API key used to access the Security and Compliance Center API. This parameter is only relevant when the `trigger_scan` parameter is `enabled`. For information about the deprecation see the `trigger_scan` parameter. You can use a toolchain secret reference for this parameter. For more information, see [Protecting your sensitive data in Continuous Delivery](https://cloud.ibm.com/docs/ContinuousDelivery?topic=ContinuousDelivery-cd_data_security#cd_secure_credentials).", "secure": true, "computed": true, - "deprecated": "This argument is deprecated and will be removed in a future release. Refer to the provider documentation for details." + "deprecated": "This argument is deprecated and may be removed in a future release" }, "attachment_id": { "name": "attachment_id", @@ -7495,7 +7470,7 @@ "type": "TypeString", "description": "The name of a Security and Compliance Center, Hybrid cloud profile. Usually, use the predefined profile \"IBM Cloud Security Best Practices v1.0.0\", which contains the DevSecOps toolchain goals. Or use a user-authored customized profile that has been configured to contain those goals. When the `trigger_scan` parameter is set to `enabled`, then the Validation scan will use the controls and goals in the configured profile. If configured with a profile that does not check the DevSecOps toolchain goals, it might incorrectly indicate that the toolchain status is passed even though some of the DevSecOps scans had actually failed. This parameter is only relevant when the `trigger_scan` parameter is `enabled`. For information about the deprecation see the `trigger_scan` parameter.", "computed": true, - "deprecated": "This argument is deprecated and will be removed in a future release. Refer to the provider documentation for details." + "deprecated": "This argument is deprecated and may be removed in a future release" }, "profile_name": { "name": "profile_name", @@ -7521,14 +7496,14 @@ "type": "TypeString", "description": "The name of a Security and Compliance Center scope, which has previously been created in that service. When the `trigger_scan` parameter is set to `enabled`, then the Validation scan will scan all the resources in that scope. Select a scope that contains this toolchain, so that the scan will find the evidence that has been recently updated by the DevSecOps pipeline-run. This parameter is only relevant when the `trigger_scan` parameter is `enabled`. For information about the deprecation see the `trigger_scan` parameter.", "computed": true, - "deprecated": "This argument is deprecated and will be removed in a future release. Refer to the provider documentation for details." + "deprecated": "This argument is deprecated and may be removed in a future release" }, "trigger_scan": { "name": "trigger_scan", "type": "TypeString", "description": "Set to `enabled` to indicate that a DevSecOps pipeline task should trigger a Security and Compliance Center run of a Hybrid cloud validation scan. Note, each scan may incur charges. When enabled, other parameters become relevant that are needed to trigger that scan; `api_key`, `scope`, `profile`. Hybrid cloud scans are deprecated and are planned to be removed. This option will stop working at that time. For more information see the [Security and Compliance Center Release Notes](https://cloud.ibm.com/docs/security-compliance?topic=security-compliance-release-notes#security-compliance-march312023).", "computed": true, - "deprecated": "This argument is deprecated and will be removed in a future release. Refer to the provider documentation for details." + "deprecated": "This argument is deprecated and may be removed in a future release" }, "use_profile_attachment": { "name": "use_profile_attachment", @@ -7538,12 +7513,25 @@ } } }, + { + "name": "href", + "type": "TypeString", + "description": "URI representing the tool.", + "computed": true + }, { "name": "tool_id", "type": "TypeString", "description": "ID of the tool bound to the toolchain.", "required": true }, + { + "name": "resource_group_id", + "type": "TypeString", + "description": "Resource group where the tool is located.", + "cloud_data_type": "resource_group", + "computed": true + }, { "name": "crn", "type": "TypeString", @@ -7552,15 +7540,15 @@ "computed": true }, { - "name": "href", + "name": "toolchain_crn", "type": "TypeString", - "description": "URI representing the tool.", + "description": "CRN of toolchain which the tool is bound to.", "computed": true }, { "name": "name", "type": "TypeString", - "description": "Tool name.", + "description": "Name of the tool.", "computed": true }, { @@ -7568,27 +7556,53 @@ "type": "TypeString", "description": "Latest tool update timestamp.", "computed": true + }, + { + "name": "state", + "type": "TypeString", + "description": "Current configuration state of the tool.", + "computed": true + }, + { + "name": "toolchain_id", + "type": "TypeString", + "description": "ID of the toolchain.", + "required": true } ], "ibm_cd_toolchain_tool_slack": [ { - "name": "crn", + "name": "tool_id", "type": "TypeString", - "description": "Tool CRN.", - "cloud_data_type": "crn", - "computed": true + "description": "ID of the tool bound to the toolchain.", + "required": true }, { - "name": "toolchain_crn", + "name": "crn", "type": "TypeString", - "description": "CRN of toolchain which the tool is bound to.", + "description": "Tool CRN.", + "cloud_data_type": "crn", "computed": true }, { - "name": "href", - "type": "TypeString", - "description": "URI representing the tool.", - "computed": true + "name": "referent", + "type": "TypeList", + "description": "Information on URIs to access this resource through the UI or API.", + "computed": true, + "elem": { + "api_href": { + "name": "api_href", + "type": "TypeString", + "description": "URI representing this resource through an API.", + "computed": true + }, + "ui_href": { + "name": "ui_href", + "type": "TypeString", + "description": "URI representing this resource through the UI.", + "computed": true + } + } }, { "name": "parameters", @@ -7653,6 +7667,12 @@ "description": "Current configuration state of the tool.", "computed": true }, + { + "name": "toolchain_id", + "type": "TypeString", + "description": "ID of the toolchain.", + "required": true + }, { "name": "resource_group_id", "type": "TypeString", @@ -7661,35 +7681,21 @@ "computed": true }, { - "name": "tool_id", + "name": "toolchain_crn", "type": "TypeString", - "description": "ID of the tool bound to the toolchain.", - "required": true + "description": "CRN of toolchain which the tool is bound to.", + "computed": true }, { - "name": "referent", - "type": "TypeList", - "description": "Information on URIs to access this resource through the UI or API.", - "computed": true, - "elem": { - "api_href": { - "name": "api_href", - "type": "TypeString", - "description": "URI representing this resource through an API.", - "computed": true - }, - "ui_href": { - "name": "ui_href", - "type": "TypeString", - "description": "URI representing this resource through the UI.", - "computed": true - } - } + "name": "href", + "type": "TypeString", + "description": "URI representing the tool.", + "computed": true }, { "name": "name", "type": "TypeString", - "description": "Tool name.", + "description": "Name of the tool.", "computed": true }, { @@ -7697,45 +7703,21 @@ "type": "TypeString", "description": "Latest tool update timestamp.", "computed": true - }, - { - "name": "toolchain_id", - "type": "TypeString", - "description": "ID of the toolchain.", - "required": true } ], "ibm_cd_toolchain_tool_sonarqube": [ { - "name": "href", - "type": "TypeString", - "description": "URI representing the tool.", - "computed": true - }, - { - "name": "updated_at", + "name": "name", "type": "TypeString", - "description": "Latest tool update timestamp.", + "description": "Name of the tool.", "computed": true }, - { - "name": "toolchain_id", - "type": "TypeString", - "description": "ID of the toolchain.", - "required": true - }, { "name": "tool_id", "type": "TypeString", "description": "ID of the tool bound to the toolchain.", "required": true }, - { - "name": "toolchain_crn", - "type": "TypeString", - "description": "CRN of toolchain which the tool is bound to.", - "computed": true - }, { "name": "referent", "type": "TypeList", @@ -7757,9 +7739,28 @@ } }, { - "name": "name", + "name": "crn", + "type": "TypeString", + "description": "Tool CRN.", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "toolchain_crn", + "type": "TypeString", + "description": "CRN of toolchain which the tool is bound to.", + "computed": true + }, + { + "name": "href", + "type": "TypeString", + "description": "URI representing the tool.", + "computed": true + }, + { + "name": "updated_at", "type": "TypeString", - "description": "Tool name.", + "description": "Latest tool update timestamp.", "computed": true }, { @@ -7808,39 +7809,119 @@ "computed": true }, { - "name": "resource_group_id", + "name": "toolchain_id", "type": "TypeString", - "description": "Resource group where the tool is located.", - "cloud_data_type": "resource_group", - "computed": true + "description": "ID of the toolchain.", + "required": true }, { - "name": "crn", + "name": "resource_group_id", "type": "TypeString", - "description": "Tool CRN.", - "cloud_data_type": "crn", + "description": "Resource group where the tool is located.", + "cloud_data_type": "resource_group", "computed": true } ], - "ibm_cis": [ + "ibm_cd_toolchains": [ { "name": "resource_group_id", "type": "TypeString", - "description": "The id of the resource group in which the cis instance is present", + "description": "The resource group ID where the toolchains exist.", "cloud_data_type": "resource_group", - "optional": true + "required": true }, { - "name": "location", + "name": "name", "type": "TypeString", - "description": "The location or the environment in which cis instance exists", - "cloud_data_type": "region", - "computed": true + "description": "Name of toolchain to look up.", + "optional": true }, { - "name": "service", + "name": "toolchains", + "type": "TypeList", + "description": "Toolchain results returned from the collection.", + "computed": true, + "elem": { + "account_id": { + "name": "account_id", + "type": "TypeString", + "description": "Account ID where toolchain can be found.", + "computed": true + }, + "created_at": { + "name": "created_at", + "type": "TypeString", + "description": "Toolchain creation timestamp.", + "computed": true + }, + "created_by": { + "name": "created_by", + "type": "TypeString", + "description": "Identity that created the toolchain.", + "computed": true + }, + "crn": { + "name": "crn", + "type": "TypeString", + "description": "Toolchain CRN.", + "computed": true + }, + "description": { + "name": "description", + "type": "TypeString", + "description": "Describes the toolchain.", + "computed": true + }, + "href": { + "name": "href", + "type": "TypeString", + "description": "URI that can be used to retrieve toolchain.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "Toolchain ID.", + "computed": true + }, + "location": { + "name": "location", + "type": "TypeString", + "description": "Toolchain region.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Toolchain name.", + "computed": true + }, + "resource_group_id": { + "name": "resource_group_id", + "type": "TypeString", + "description": "Resource group where the toolchain is located.", + "computed": true + }, + "ui_href": { + "name": "ui_href", + "type": "TypeString", + "description": "URL of a user-facing user interface for this toolchain.", + "computed": true + }, + "updated_at": { + "name": "updated_at", + "type": "TypeString", + "description": "Latest toolchain update timestamp.", + "computed": true + } + } + } + ], + "ibm_cis": [ + { + "name": "plan", "type": "TypeString", - "description": "The name of the Cloud Internet Services offering, 'internet-svcs'", + "description": "The plan type of the cis instance", "computed": true }, { @@ -7856,21 +7937,15 @@ "computed": true }, { - "name": "resource_controller_url", + "name": "resource_group_name", "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource", + "description": "The resource group name in which resource is provisioned", "computed": true }, { - "name": "name", - "type": "TypeString", - "description": "Resource instance name for example, my cis instance", - "required": true - }, - { - "name": "plan", + "name": "service", "type": "TypeString", - "description": "The plan type of the cis instance", + "description": "The name of the Cloud Internet Services offering, 'internet-svcs'", "computed": true }, { @@ -7886,16 +7961,36 @@ "computed": true }, { - "name": "resource_group_name", + "name": "resource_controller_url", "type": "TypeString", - "description": "The resource group name in which resource is provisioned", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource", "computed": true }, + { + "name": "name", + "type": "TypeString", + "description": "Resource instance name for example, my cis instance", + "required": true + }, + { + "name": "resource_group_id", + "type": "TypeString", + "description": "The id of the resource group in which the cis instance is present", + "cloud_data_type": "resource_group", + "optional": true + }, { "name": "guid", "type": "TypeString", "description": "Unique identifier of resource instance", "computed": true + }, + { + "name": "location", + "type": "TypeString", + "description": "The location or the environment in which cis instance exists", + "cloud_data_type": "region", + "computed": true } ], "ibm_cis_alerts": [ @@ -7985,6 +8080,16 @@ } ], "ibm_cis_bot_analytics": [ + { + "name": "cis_id", + "type": "TypeString", + "description": "CIS instance crn", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:internet-svcs" + ] + }, { "name": "domain_id", "type": "TypeString", @@ -8017,43 +8122,11 @@ "elem": { "type": "TypeMap" } - }, - { - "name": "cis_id", - "type": "TypeString", - "description": "CIS instance crn", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:internet-svcs" - ] } ], "ibm_cis_bot_managements": [ { - "name": "cis_id", - "type": "TypeString", - "description": "CIS instance crn", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:internet-svcs" - ] - }, - { - "name": "domain_id", - "type": "TypeString", - "description": "Associated CIS domain", - "required": true - }, - { - "name": "fight_mode", - "type": "TypeString", - "description": "Fight Mode", - "computed": true - }, - { - "name": "session_score", + "name": "session_score", "type": "TypeString", "description": "Session Score", "computed": true @@ -8075,9 +8148,7 @@ "type": "TypeString", "description": "Use Latest Model", "computed": true - } - ], - "ibm_cis_cache_settings": [ + }, { "name": "cis_id", "type": "TypeString", @@ -8095,37 +8166,13 @@ "required": true }, { - "name": "caching_level", - "type": "TypeList", - "description": "Cache Level Setting", - "computed": true, - "elem": { - "editable": { - "name": "editable", - "type": "TypeBool", - "description": "cache level editable", - "computed": true - }, - "id": { - "name": "id", - "type": "TypeString", - "description": "cache level id", - "computed": true - }, - "modified_on": { - "name": "modified_on", - "type": "TypeString", - "description": "cache level modified on", - "computed": true - }, - "value": { - "name": "value", - "type": "TypeString", - "description": "cache level value", - "computed": true - } - } - }, + "name": "fight_mode", + "type": "TypeString", + "description": "Fight Mode", + "computed": true + } + ], + "ibm_cis_cache_settings": [ { "name": "serve_stale_content", "type": "TypeList", @@ -8253,6 +8300,54 @@ "computed": true } } + }, + { + "name": "cis_id", + "type": "TypeString", + "description": "CIS instance crn", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:internet-svcs" + ] + }, + { + "name": "domain_id", + "type": "TypeString", + "description": "Associated CIS domain", + "required": true + }, + { + "name": "caching_level", + "type": "TypeList", + "description": "Cache Level Setting", + "computed": true, + "elem": { + "editable": { + "name": "editable", + "type": "TypeBool", + "description": "cache level editable", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "cache level id", + "computed": true + }, + "modified_on": { + "name": "modified_on", + "type": "TypeString", + "description": "cache level modified on", + "computed": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "cache level value", + "computed": true + } + } } ], "ibm_cis_certificates": [ @@ -8441,16 +8536,6 @@ } ], "ibm_cis_custom_pages": [ - { - "name": "cis_id", - "type": "TypeString", - "description": "CIS instance crn", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:internet-svcs" - ] - }, { "name": "domain_id", "type": "TypeString", @@ -8513,31 +8598,19 @@ "computed": true } } - } - ], - "ibm_cis_dns_records": [ + }, { "name": "cis_id", "type": "TypeString", - "description": "DNS Zone CRN", + "description": "CIS instance crn", "cloud_data_type": "resource_instance", "required": true, "cloud_data_range": [ "service:internet-svcs" ] - }, - { - "name": "domain_id", - "type": "TypeString", - "description": "Zone Id", - "required": true - }, - { - "name": "file", - "type": "TypeString", - "description": "file to be exported", - "optional": true - }, + } + ], + "ibm_cis_dns_records": [ { "name": "cis_dns_records", "type": "TypeList", @@ -8623,20 +8696,31 @@ "computed": true } } - } - ], - "ibm_cis_domain": [ + }, { - "name": "domain_id", + "name": "cis_id", "type": "TypeString", - "computed": true + "description": "DNS Zone CRN", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:internet-svcs" + ] }, { - "name": "domain", + "name": "domain_id", "type": "TypeString", - "description": "CISzone - Domain", + "description": "Zone Id", "required": true }, + { + "name": "file", + "type": "TypeString", + "description": "file to be exported", + "optional": true + } + ], + "ibm_cis_domain": [ { "name": "type", "type": "TypeString", @@ -8644,8 +8728,16 @@ "computed": true }, { - "name": "paused", - "type": "TypeBool", + "name": "name_servers", + "type": "TypeList", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "domain_id", + "type": "TypeString", "computed": true }, { @@ -8654,7 +8746,7 @@ "computed": true }, { - "name": "name_servers", + "name": "original_name_servers", "type": "TypeList", "computed": true, "elem": { @@ -8662,12 +8754,16 @@ } }, { - "name": "original_name_servers", - "type": "TypeList", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "verification_key", + "type": "TypeString", + "optional": true, + "computed": true + }, + { + "name": "cname_suffix", + "type": "TypeString", + "optional": true, + "computed": true }, { "name": "cis_id", @@ -8680,19 +8776,28 @@ ] }, { - "name": "verification_key", + "name": "domain", "type": "TypeString", - "optional": true, - "computed": true + "description": "CISzone - Domain", + "required": true }, { - "name": "cname_suffix", - "type": "TypeString", - "optional": true, + "name": "paused", + "type": "TypeBool", "computed": true } ], "ibm_cis_edge_functions_actions": [ + { + "name": "cis_id", + "type": "TypeString", + "description": "CIS Intance CRN", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:internet-svcs" + ] + }, { "name": "domain_id", "type": "TypeString", @@ -8765,16 +8870,6 @@ } } } - }, - { - "name": "cis_id", - "type": "TypeString", - "description": "CIS Intance CRN", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:internet-svcs" - ] } ], "ibm_cis_edge_functions_triggers": [ @@ -8884,6 +8979,57 @@ } ], "ibm_cis_firewall": [ + { + "name": "ua_rule", + "type": "TypeList", + "description": "User Agent Rule Data", + "computed": true, + "elem": { + "configuration": { + "name": "configuration", + "type": "TypeList", + "computed": true, + "elem": { + "target": { + "name": "target", + "type": "TypeString", + "description": "Target type", + "computed": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "Target value", + "computed": true + } + } + }, + "description": { + "name": "description", + "type": "TypeString", + "description": "description", + "computed": true + }, + "mode": { + "name": "mode", + "type": "TypeString", + "description": "user agent rule mode", + "computed": true + }, + "paused": { + "name": "paused", + "type": "TypeBool", + "description": "Rule whether paused or not", + "computed": true + }, + "ua_rule_id": { + "name": "ua_rule_id", + "type": "TypeString", + "description": "firewall identifier", + "computed": true + } + } + }, { "name": "cis_id", "type": "TypeString", @@ -9010,60 +9156,19 @@ "computed": true } } - }, - { - "name": "ua_rule", - "type": "TypeList", - "description": "User Agent Rule Data", - "computed": true, - "elem": { - "configuration": { - "name": "configuration", - "type": "TypeList", - "computed": true, - "elem": { - "target": { - "name": "target", - "type": "TypeString", - "description": "Target type", - "computed": true - }, - "value": { - "name": "value", - "type": "TypeString", - "description": "Target value", - "computed": true - } - } - }, - "description": { - "name": "description", - "type": "TypeString", - "description": "description", - "computed": true - }, - "mode": { - "name": "mode", - "type": "TypeString", - "description": "user agent rule mode", - "computed": true - }, - "paused": { - "name": "paused", - "type": "TypeBool", - "description": "Rule whether paused or not", - "computed": true - }, - "ua_rule_id": { - "name": "ua_rule_id", - "type": "TypeString", - "description": "firewall identifier", - "computed": true - } - } } ], "ibm_cis_firewall_rules": [ + { + "name": "cis_id", + "type": "TypeString", + "description": "Full url-encoded cloud resource name (CRN) of resource instance.", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:internet-svcs" + ] + }, { "name": "domain_id", "type": "TypeString", @@ -9107,19 +9212,19 @@ "computed": true } } - }, + } + ], + "ibm_cis_global_load_balancers": [ { "name": "cis_id", "type": "TypeString", - "description": "Full url-encoded cloud resource name (CRN) of resource instance.", + "description": "CIS instance crn", "cloud_data_type": "resource_instance", "required": true, "cloud_data_range": [ "service:internet-svcs" ] - } - ], - "ibm_cis_global_load_balancers": [ + }, { "name": "domain_id", "type": "TypeString", @@ -9255,16 +9360,6 @@ "computed": true } } - }, - { - "name": "cis_id", - "type": "TypeString", - "description": "CIS instance crn", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:internet-svcs" - ] } ], "ibm_cis_healthchecks": [ @@ -9408,7 +9503,7 @@ ], "ibm_cis_ip_addresses": [ { - "name": "ipv6_cidrs", + "name": "ipv4_cidrs", "type": "TypeList", "computed": true, "elem": { @@ -9416,7 +9511,7 @@ } }, { - "name": "ipv4_cidrs", + "name": "ipv6_cidrs", "type": "TypeList", "computed": true, "elem": { @@ -9425,6 +9520,22 @@ } ], "ibm_cis_logpush_jobs": [ + { + "name": "cis_id", + "type": "TypeString", + "description": "CIS instance crn", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:internet-svcs" + ] + }, + { + "name": "domain_id", + "type": "TypeString", + "description": "Associated CIS domain", + "required": true + }, { "name": "logpush_job_pack", "type": "TypeList", @@ -9474,25 +9585,59 @@ "computed": true } } - }, - { - "name": "cis_id", - "type": "TypeString", - "description": "CIS instance crn", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:internet-svcs" - ] - }, - { - "name": "domain_id", - "type": "TypeString", - "description": "Associated CIS domain", - "required": true } ], "ibm_cis_mtls_apps": [ + { + "name": "mtls_access_app_policies", + "type": "TypeList", + "description": "Access Policies Information", + "computed": true, + "elem": { + "policy_created_at": { + "name": "policy_created_at", + "type": "TypeString", + "description": "Application Created At", + "computed": true + }, + "policy_decision": { + "name": "policy_decision", + "type": "TypeString", + "description": "Policy Decision", + "computed": true + }, + "policy_id": { + "name": "policy_id", + "type": "TypeString", + "description": "Policy ID", + "computed": true + }, + "policy_name": { + "name": "policy_name", + "type": "TypeString", + "description": "Policy name", + "computed": true + }, + "policy_precedence": { + "name": "policy_precedence", + "type": "TypeInt", + "description": "Policy Precedence", + "computed": true + }, + "policy_uid": { + "name": "policy_uid", + "type": "TypeString", + "description": "Policy UID", + "computed": true + }, + "policy_updated_at": { + "name": "policy_updated_at", + "type": "TypeString", + "description": "Application Updated At", + "computed": true + } + } + }, { "name": "cis_id", "type": "TypeString", @@ -9585,56 +9730,6 @@ "computed": true } } - }, - { - "name": "mtls_access_app_policies", - "type": "TypeList", - "description": "Access Policies Information", - "computed": true, - "elem": { - "policy_created_at": { - "name": "policy_created_at", - "type": "TypeString", - "description": "Application Created At", - "computed": true - }, - "policy_decision": { - "name": "policy_decision", - "type": "TypeString", - "description": "Policy Decision", - "computed": true - }, - "policy_id": { - "name": "policy_id", - "type": "TypeString", - "description": "Policy ID", - "computed": true - }, - "policy_name": { - "name": "policy_name", - "type": "TypeString", - "description": "Policy name", - "computed": true - }, - "policy_precedence": { - "name": "policy_precedence", - "type": "TypeInt", - "description": "Policy Precedence", - "computed": true - }, - "policy_uid": { - "name": "policy_uid", - "type": "TypeString", - "description": "Policy UID", - "computed": true - }, - "policy_updated_at": { - "name": "policy_updated_at", - "type": "TypeString", - "description": "Application Updated At", - "computed": true - } - } } ], "ibm_cis_mtlss": [ @@ -9709,6 +9804,16 @@ } ], "ibm_cis_origin_auths": [ + { + "name": "cis_id", + "type": "TypeString", + "description": "CIS instance crn", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:internet-svcs" + ] + }, { "name": "domain_id", "type": "TypeString", @@ -9791,29 +9896,9 @@ "computed": true } } - }, - { - "name": "cis_id", - "type": "TypeString", - "description": "CIS instance crn", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:internet-svcs" - ] } ], "ibm_cis_origin_pools": [ - { - "name": "cis_id", - "type": "TypeString", - "description": "DNS Zone CRN", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:internet-svcs" - ] - }, { "name": "cis_origin_pools", "type": "TypeList", @@ -9939,6 +10024,16 @@ "computed": true } } + }, + { + "name": "cis_id", + "type": "TypeString", + "description": "DNS Zone CRN", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:internet-svcs" + ] } ], "ibm_cis_page_rules": [ @@ -10075,22 +10170,6 @@ } ], "ibm_cis_range_apps": [ - { - "name": "cis_id", - "type": "TypeString", - "description": "CIS Intance CRN", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:internet-svcs" - ] - }, - { - "name": "domain_id", - "type": "TypeString", - "description": "CIS Domain ID", - "required": true - }, { "name": "range_apps", "type": "TypeList", @@ -10185,6 +10264,22 @@ "computed": true } } + }, + { + "name": "cis_id", + "type": "TypeString", + "description": "CIS Intance CRN", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:internet-svcs" + ] + }, + { + "name": "domain_id", + "type": "TypeString", + "description": "CIS Domain ID", + "required": true } ], "ibm_cis_rate_limit": [ @@ -10449,22 +10544,6 @@ } ], "ibm_cis_waf_packages": [ - { - "name": "cis_id", - "type": "TypeString", - "description": "DNS Zone CRN", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:internet-svcs" - ] - }, - { - "name": "domain_id", - "type": "TypeString", - "description": "CIS domain id", - "required": true - }, { "name": "waf_packages", "type": "TypeList", @@ -10502,9 +10581,47 @@ "computed": true } } + }, + { + "name": "cis_id", + "type": "TypeString", + "description": "DNS Zone CRN", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:internet-svcs" + ] + }, + { + "name": "domain_id", + "type": "TypeString", + "description": "CIS domain id", + "required": true } ], "ibm_cis_waf_rules": [ + { + "name": "cis_id", + "type": "TypeString", + "description": "CIS instance crn", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:internet-svcs" + ] + }, + { + "name": "domain_id", + "type": "TypeString", + "description": "CISzone - Domain", + "required": true + }, + { + "name": "package_id", + "type": "TypeString", + "description": "WAF rule package id", + "required": true + }, { "name": "waf_rules", "type": "TypeList", @@ -10577,41 +10694,9 @@ "computed": true } } - }, - { - "name": "cis_id", - "type": "TypeString", - "description": "CIS instance crn", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:internet-svcs" - ] - }, - { - "name": "domain_id", - "type": "TypeString", - "description": "CISzone - Domain", - "required": true - }, - { - "name": "package_id", - "type": "TypeString", - "description": "WAF rule package id", - "required": true } ], "ibm_cis_webhooks": [ - { - "name": "cis_id", - "type": "TypeString", - "description": "CIS instance crn", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:internet-svcs" - ] - }, { "name": "cis_webhooks", "type": "TypeList", @@ -10643,15 +10728,19 @@ "computed": true } } + }, + { + "name": "cis_id", + "type": "TypeString", + "description": "CIS instance crn", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:internet-svcs" + ] } ], "ibm_cloud_shell_account_settings": [ - { - "name": "updated_at", - "type": "TypeInt", - "description": "Timestamp of last update in Unix epoch time.", - "computed": true - }, { "name": "account_id", "type": "TypeString", @@ -10659,9 +10748,9 @@ "required": true }, { - "name": "created_by", - "type": "TypeString", - "description": "IAM ID of creator.", + "name": "created_at", + "type": "TypeInt", + "description": "Creation timestamp in Unix epoch time.", "computed": true }, { @@ -10683,9 +10772,9 @@ "computed": true }, { - "name": "type", + "name": "updated_by", "type": "TypeString", - "description": "Type of api response object.", + "description": "IAM ID of last updater.", "computed": true }, { @@ -10695,9 +10784,9 @@ "computed": true }, { - "name": "created_at", - "type": "TypeInt", - "description": "Creation timestamp in Unix epoch time.", + "name": "created_by", + "type": "TypeString", + "description": "IAM ID of creator.", "computed": true }, { @@ -10741,13 +10830,25 @@ } }, { - "name": "updated_by", + "name": "type", "type": "TypeString", - "description": "IAM ID of last updater.", + "description": "Type of api response object.", + "computed": true + }, + { + "name": "updated_at", + "type": "TypeInt", + "description": "Timestamp of last update in Unix epoch time.", "computed": true } ], "ibm_cloudant": [ + { + "name": "resource_name", + "type": "TypeString", + "description": "The name of the resource", + "computed": true + }, { "name": "location", "type": "TypeString", @@ -10763,34 +10864,33 @@ "computed": true }, { - "name": "resource_crn", + "name": "version", "type": "TypeString", - "description": "The crn of the resource", + "description": "Vendor version.", "computed": true }, { - "name": "resource_group_name", + "name": "status", "type": "TypeString", - "description": "The resource group name in which resource is provisioned", + "description": "The resource instance status", "computed": true }, { - "name": "include_data_events", - "type": "TypeBool", - "description": "Include data event types in events sent to IBM Cloud Activity Tracker with LogDNA for the IBM Cloudant instance. By default only emitted events are of \"management\" type.", + "name": "resource_group_name", + "type": "TypeString", + "description": "The resource group name in which resource is provisioned", "computed": true }, { - "name": "enable_cors", - "type": "TypeBool", - "description": "Boolean value to turn CORS on and off.", + "name": "guid", + "type": "TypeString", + "description": "Guid of resource instance", "computed": true }, { - "name": "crn", + "name": "resource_crn", "type": "TypeString", - "description": "CRN of resource instance", - "cloud_data_type": "crn", + "description": "The crn of the resource", "computed": true }, { @@ -10800,60 +10900,34 @@ "computed": true }, { - "name": "extensions", - "type": "TypeMap", - "description": "The extended metadata as a map associated with the resource instance.", + "name": "resource_controller_url", + "type": "TypeString", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource", "computed": true }, { - "name": "features", - "type": "TypeList", - "description": "List of enabled optional features.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "features_flags", - "type": "TypeList", - "description": "List of feature flags.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "throughput", - "type": "TypeMap", - "description": "Schema for detailed information about throughput capacity with breakdown by specific throughput requests classes.", - "computed": true, - "elem": { - "type": "TypeInt" - } - }, - { - "name": "service", - "type": "TypeString", - "description": "The service type of the instance", + "name": "include_data_events", + "type": "TypeBool", + "description": "Include data event types in events sent to IBM Cloud Activity Tracker with LogDNA for the IBM Cloudant instance. By default only emitted events are of \"management\" type.", "computed": true }, { - "name": "guid", - "type": "TypeString", - "description": "Guid of resource instance", + "name": "capacity", + "type": "TypeInt", + "description": "A number of blocks of throughput units. A block consists of 100 reads/sec, 50 writes/sec, and 5 global queries/sec of provisioned throughput capacity.", "computed": true }, { - "name": "resource_name", + "name": "name", "type": "TypeString", - "description": "The name of the resource", - "computed": true + "description": "Resource instance name for example, myobjectstorage", + "required": true }, { - "name": "version", + "name": "crn", "type": "TypeString", - "description": "Vendor version.", + "description": "CRN of resource instance", + "cloud_data_type": "crn", "computed": true }, { @@ -10880,59 +10954,80 @@ } }, { - "name": "name", - "type": "TypeString", - "description": "Resource instance name for example, myobjectstorage", - "required": true + "name": "tags", + "type": "TypeSet", + "description": "Tags of Resource Instance", + "cloud_data_type": "tags", + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "resource_group_id", - "type": "TypeString", - "description": "The id of the resource group in which the instance is present", - "cloud_data_type": "resource_group", - "optional": true, + "name": "extensions", + "type": "TypeMap", + "description": "The extended metadata as a map associated with the resource instance.", "computed": true }, { - "name": "status", - "type": "TypeString", - "description": "The resource instance status", - "computed": true + "name": "features", + "type": "TypeList", + "description": "List of enabled optional features.", + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "tags", - "type": "TypeSet", - "description": "Tags of Resource Instance", - "cloud_data_type": "tags", + "name": "features_flags", + "type": "TypeList", + "description": "List of feature flags.", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "resource_controller_url", + "name": "throughput", + "type": "TypeMap", + "description": "Schema for detailed information about throughput capacity with breakdown by specific throughput requests classes.", + "computed": true, + "elem": { + "type": "TypeInt" + } + }, + { + "name": "enable_cors", + "type": "TypeBool", + "description": "Boolean value to turn CORS on and off.", + "computed": true + }, + { + "name": "resource_group_id", "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource", + "description": "The id of the resource group in which the instance is present", + "cloud_data_type": "resource_group", + "optional": true, "computed": true }, { - "name": "capacity", - "type": "TypeInt", - "description": "A number of blocks of throughput units. A block consists of 100 reads/sec, 50 writes/sec, and 5 global queries/sec of provisioned throughput capacity.", + "name": "service", + "type": "TypeString", + "description": "The service type of the instance", "computed": true } ], "ibm_cloudant_database": [ { - "name": "compact_running", - "type": "TypeBool", - "description": "True if the database compaction routine is operating on this database.", - "computed": true + "name": "instance_crn", + "type": "TypeString", + "description": "Cloudant Instance CRN.", + "required": true }, { - "name": "doc_del_count", + "name": "disk_format_version", "type": "TypeInt", - "description": "Number of deleted documents.", + "description": "The version of the physical format used for the data when it is stored on disk.", "computed": true }, { @@ -10950,33 +11045,39 @@ } }, { - "name": "uuid", - "type": "TypeString", - "description": "The UUID of the database.", + "name": "compact_running", + "type": "TypeBool", + "description": "True if the database compaction routine is operating on this database.", "computed": true }, { - "name": "db", + "name": "compacted_seq", "type": "TypeString", - "description": "Path parameter to specify the database name.", - "required": true + "description": "An opaque string that describes the compaction state of the database.", + "computed": true }, { - "name": "committed_update_seq", - "type": "TypeString", - "description": "An opaque string that describes the committed state of the database.", + "name": "doc_count", + "type": "TypeInt", + "description": "A count of the documents in the specified database.", "computed": true }, { - "name": "compacted_seq", - "type": "TypeString", - "description": "An opaque string that describes the compaction state of the database.", + "name": "doc_del_count", + "type": "TypeInt", + "description": "Number of deleted documents.", "computed": true }, { - "name": "engine", + "name": "db", "type": "TypeString", - "description": "The engine used for the database.", + "description": "Path parameter to specify the database name.", + "required": true + }, + { + "name": "committed_update_seq", + "type": "TypeString", + "description": "An opaque string that describes the committed state of the database.", "computed": true }, { @@ -11005,12 +11106,6 @@ } } }, - { - "name": "update_seq", - "type": "TypeString", - "description": "An opaque string that describes the state of the database. Do not rely on this string for counting the number of updates.", - "computed": true - }, { "name": "cluster", "type": "TypeList", @@ -11044,98 +11139,25 @@ } }, { - "name": "disk_format_version", - "type": "TypeInt", - "description": "The version of the physical format used for the data when it is stored on disk.", - "computed": true - }, - { - "name": "doc_count", - "type": "TypeInt", - "description": "A count of the documents in the specified database.", - "computed": true - }, - { - "name": "instance_crn", - "type": "TypeString", - "description": "Cloudant Instance CRN.", - "required": true - } - ], - "ibm_cm_catalog": [ - { - "name": "rev", - "type": "TypeString", - "description": "Cloudant revision.", - "computed": true - }, - { - "name": "catalog_banner_url", - "type": "TypeString", - "description": "URL for a banner image for this catalog.", - "computed": true - }, - { - "name": "owning_account", - "type": "TypeString", - "description": "Account that owns catalog.", - "computed": true - }, - { - "name": "short_description", - "type": "TypeString", - "description": "Description in the requested language.", - "computed": true - }, - { - "name": "short_description_i18n", - "type": "TypeMap", - "description": "A map of translated strings, by language code.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "updated", - "type": "TypeString", - "description": "The date-time this catalog was last updated.", - "computed": true - }, - { - "name": "catalog_identifier", - "type": "TypeString", - "description": "Catalog identifier.", - "required": true - }, - { - "name": "id", + "name": "engine", "type": "TypeString", - "description": "Unique ID.", + "description": "The engine used for the database.", "computed": true }, { - "name": "label", + "name": "update_seq", "type": "TypeString", - "description": "Display Name in the requested language.", + "description": "An opaque string that describes the state of the database. Do not rely on this string for counting the number of updates.", "computed": true }, { - "name": "label_i18n", - "type": "TypeMap", - "description": "A map of translated strings, by language code.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "crn", + "name": "uuid", "type": "TypeString", - "description": "CRN associated with the catalog.", - "cloud_data_type": "crn", + "description": "The UUID of the database.", "computed": true - }, + } + ], + "ibm_cm_catalog": [ { "name": "features", "type": "TypeList", @@ -11175,101 +11197,40 @@ } }, { - "name": "disabled", - "type": "TypeBool", - "description": "Denotes whether a catalog is disabled.", + "name": "created", + "type": "TypeString", + "description": "The date-time this catalog was created.", "computed": true }, { - "name": "created", + "name": "updated", "type": "TypeString", - "description": "The date-time this catalog was created.", + "description": "The date-time this catalog was last updated.", "computed": true }, { - "name": "catalog_filters", - "type": "TypeList", - "description": "Filters for account and catalog filters.", - "computed": true, - "elem": { - "category_filters": { - "name": "category_filters", - "type": "TypeMap", - "description": "Filter against offering properties.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "id_filters": { - "name": "id_filters", - "type": "TypeList", - "description": "Filter on offering ID's. There is an include filter and an exclule filter. Both can be set.", - "computed": true, - "elem": { - "exclude": { - "name": "exclude", - "type": "TypeList", - "description": "Offering filter terms.", - "computed": true, - "elem": { - "filter_terms": { - "name": "filter_terms", - "type": "TypeList", - "description": "List of values to match against. If include is true, then if the offering has one of the values then the offering is included. If include is false, then if the offering has one of the values then the offering is excluded.", - "computed": true, - "elem": { - "type": "TypeString" - } - } - } - }, - "include": { - "name": "include", - "type": "TypeList", - "description": "Offering filter terms.", - "computed": true, - "elem": { - "filter_terms": { - "name": "filter_terms", - "type": "TypeList", - "description": "List of values to match against. If include is true, then if the offering has one of the values then the offering is included. If include is false, then if the offering has one of the values then the offering is excluded.", - "computed": true, - "elem": { - "type": "TypeString" - } - } - } - } - } - }, - "include_all": { - "name": "include_all", - "type": "TypeBool", - "description": "-\u003e true - Include all of the public catalog when filtering. Further settings will specifically exclude some offerings. false - Exclude all of the public catalog when filtering. Further settings will specifically include some offerings.", - "computed": true - } - } + "name": "resource_group_id", + "type": "TypeString", + "description": "Resource group id the catalog is owned by.", + "cloud_data_type": "resource_group", + "computed": true }, { - "name": "kind", + "name": "rev", "type": "TypeString", - "description": "Kind of catalog. Supported kinds are offering and vpe.", + "description": "Cloudant revision.", "computed": true }, { - "name": "metadata", - "type": "TypeMap", - "description": "Catalog specific metadata.", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "short_description", + "type": "TypeString", + "description": "Description in the requested language.", + "computed": true }, { - "name": "catalog_icon_url", + "name": "catalog_banner_url", "type": "TypeString", - "description": "URL for an icon associated with this catalog.", + "description": "URL for a banner image for this catalog.", "computed": true }, { @@ -11283,9 +11244,10 @@ } }, { - "name": "url", + "name": "crn", "type": "TypeString", - "description": "The url for this specific catalog.", + "description": "CRN associated with the catalog.", + "cloud_data_type": "crn", "computed": true }, { @@ -11295,10 +11257,89 @@ "computed": true }, { - "name": "resource_group_id", + "name": "owning_account", "type": "TypeString", - "description": "Resource group id the catalog is owned by.", - "cloud_data_type": "resource_group", + "description": "Account that owns catalog.", + "computed": true + }, + { + "name": "target_account_contexts", + "type": "TypeList", + "description": "List of target accounts contexts on this catalog.", + "computed": true, + "elem": { + "api_key": { + "name": "api_key", + "type": "TypeString", + "description": "API key of the target account.", + "secure": true, + "computed": true + }, + "label": { + "name": "label", + "type": "TypeString", + "description": "Label for this target account context.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Unique identifier/name for this target account context.", + "computed": true + }, + "project_id": { + "name": "project_id", + "type": "TypeString", + "description": "Project ID.", + "computed": true + }, + "trusted_profile": { + "name": "trusted_profile", + "type": "TypeList", + "description": "Trusted profile information.", + "computed": true, + "elem": { + "catalog_crn": { + "name": "catalog_crn", + "type": "TypeString", + "description": "CRN of this catalog.", + "computed": true + }, + "catalog_name": { + "name": "catalog_name", + "type": "TypeString", + "description": "Name of this catalog.", + "computed": true + }, + "target_service_id": { + "name": "target_service_id", + "type": "TypeString", + "description": "Target service ID.", + "computed": true + }, + "trusted_profile_id": { + "name": "trusted_profile_id", + "type": "TypeString", + "description": "Trusted profile ID.", + "computed": true + } + } + } + } + }, + { + "name": "label_i18n", + "type": "TypeMap", + "description": "A map of translated strings, by language code.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "catalog_icon_url", + "type": "TypeString", + "description": "URL for an icon associated with this catalog.", "computed": true }, { @@ -11465,72 +11506,132 @@ } }, { - "name": "target_account_contexts", + "name": "metadata", + "type": "TypeMap", + "description": "Catalog specific metadata.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "url", + "type": "TypeString", + "description": "The url for this specific catalog.", + "computed": true + }, + { + "name": "disabled", + "type": "TypeBool", + "description": "Denotes whether a catalog is disabled.", + "computed": true + }, + { + "name": "label", + "type": "TypeString", + "description": "Display Name in the requested language.", + "computed": true + }, + { + "name": "short_description_i18n", + "type": "TypeMap", + "description": "A map of translated strings, by language code.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "catalog_filters", "type": "TypeList", - "description": "List of target accounts contexts on this catalog.", + "description": "Filters for account and catalog filters.", "computed": true, "elem": { - "api_key": { - "name": "api_key", - "type": "TypeString", - "description": "API key of the target account.", - "secure": true, - "computed": true - }, - "label": { - "name": "label", - "type": "TypeString", - "description": "Label for this target account context.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Unique identifier/name for this target account context.", - "computed": true - }, - "project_id": { - "name": "project_id", - "type": "TypeString", - "description": "Project ID.", - "computed": true + "category_filters": { + "name": "category_filters", + "type": "TypeMap", + "description": "Filter against offering properties.", + "computed": true, + "elem": { + "type": "TypeString" + } }, - "trusted_profile": { - "name": "trusted_profile", + "id_filters": { + "name": "id_filters", "type": "TypeList", - "description": "Trusted profile information.", + "description": "Filter on offering ID's. There is an include filter and an exclule filter. Both can be set.", "computed": true, "elem": { - "catalog_crn": { - "name": "catalog_crn", - "type": "TypeString", - "description": "CRN of this catalog.", - "computed": true - }, - "catalog_name": { - "name": "catalog_name", - "type": "TypeString", - "description": "Name of this catalog.", - "computed": true - }, - "target_service_id": { - "name": "target_service_id", - "type": "TypeString", - "description": "Target service ID.", - "computed": true + "exclude": { + "name": "exclude", + "type": "TypeList", + "description": "Offering filter terms.", + "computed": true, + "elem": { + "filter_terms": { + "name": "filter_terms", + "type": "TypeList", + "description": "List of values to match against. If include is true, then if the offering has one of the values then the offering is included. If include is false, then if the offering has one of the values then the offering is excluded.", + "computed": true, + "elem": { + "type": "TypeString" + } + } + } }, - "trusted_profile_id": { - "name": "trusted_profile_id", - "type": "TypeString", - "description": "Trusted profile ID.", - "computed": true + "include": { + "name": "include", + "type": "TypeList", + "description": "Offering filter terms.", + "computed": true, + "elem": { + "filter_terms": { + "name": "filter_terms", + "type": "TypeList", + "description": "List of values to match against. If include is true, then if the offering has one of the values then the offering is included. If include is false, then if the offering has one of the values then the offering is excluded.", + "computed": true, + "elem": { + "type": "TypeString" + } + } + } } } + }, + "include_all": { + "name": "include_all", + "type": "TypeBool", + "description": "-\u003e true - Include all of the public catalog when filtering. Further settings will specifically exclude some offerings. false - Exclude all of the public catalog when filtering. Further settings will specifically include some offerings.", + "computed": true } } + }, + { + "name": "kind", + "type": "TypeString", + "description": "Kind of catalog. Supported kinds are offering and vpe.", + "computed": true + }, + { + "name": "catalog_identifier", + "type": "TypeString", + "description": "Catalog identifier.", + "required": true + }, + { + "name": "id", + "type": "TypeString", + "description": "Unique ID.", + "computed": true } ], "ibm_cm_object": [ + { + "name": "object_id", + "type": "TypeString", + "description": "Object identifier.", + "required": true + }, { "name": "parent_id", "type": "TypeString", @@ -11538,21 +11639,43 @@ "computed": true }, { - "name": "tags", + "name": "publish", "type": "TypeList", - "description": "List of tags associated with this catalog.", - "cloud_data_type": "tags", + "description": "Publish information.", "computed": true, "elem": { - "type": "TypeString" + "ibm_approved": { + "name": "ibm_approved", + "type": "TypeBool", + "description": "Indicates if this offering has been approved for use by all IBMers.", + "computed": true + }, + "permit_ibm_public_publish": { + "name": "permit_ibm_public_publish", + "type": "TypeBool", + "description": "Is it permitted to request publishing to IBM or Public.", + "computed": true + }, + "portal_approval_record": { + "name": "portal_approval_record", + "type": "TypeString", + "description": "The portal's approval record ID.", + "computed": true + }, + "portal_url": { + "name": "portal_url", + "type": "TypeString", + "description": "The portal UI URL.", + "computed": true + }, + "public_approved": { + "name": "public_approved", + "type": "TypeBool", + "description": "Indicates if this offering has been approved for use by all IBM Cloud users.", + "computed": true + } } }, - { - "name": "kind", - "type": "TypeString", - "description": "Kind of object.", - "computed": true - }, { "name": "state", "type": "TypeList", @@ -11598,16 +11721,15 @@ "computed": true }, { - "name": "catalog_id", + "name": "catalog_object_id", "type": "TypeString", - "description": "Catalog identifier.", - "required": true + "description": "unique id.", + "computed": true }, { - "name": "crn", + "name": "rev", "type": "TypeString", - "description": "The crn for this specific object.", - "cloud_data_type": "crn", + "description": "Cloudant revision.", "computed": true }, { @@ -11617,7 +11739,7 @@ "computed": true }, { - "name": "short_description_i18n", + "name": "label_i18n", "type": "TypeMap", "description": "A map of translated strings, by language code.", "computed": true, @@ -11625,44 +11747,6 @@ "type": "TypeString" } }, - { - "name": "publish", - "type": "TypeList", - "description": "Publish information.", - "computed": true, - "elem": { - "ibm_approved": { - "name": "ibm_approved", - "type": "TypeBool", - "description": "Indicates if this offering has been approved for use by all IBMers.", - "computed": true - }, - "permit_ibm_public_publish": { - "name": "permit_ibm_public_publish", - "type": "TypeBool", - "description": "Is it permitted to request publishing to IBM or Public.", - "computed": true - }, - "portal_approval_record": { - "name": "portal_approval_record", - "type": "TypeString", - "description": "The portal's approval record ID.", - "computed": true - }, - "portal_url": { - "name": "portal_url", - "type": "TypeString", - "description": "The portal UI URL.", - "computed": true - }, - "public_approved": { - "name": "public_approved", - "type": "TypeBool", - "description": "Indicates if this offering has been approved for use by all IBM Cloud users.", - "computed": true - } - } - }, { "name": "short_description", "type": "TypeString", @@ -11670,25 +11754,16 @@ "computed": true }, { - "name": "object_id", - "type": "TypeString", - "description": "Object identifier.", - "required": true - }, - { - "name": "rev", + "name": "kind", "type": "TypeString", - "description": "Cloudant revision.", + "description": "Kind of object.", "computed": true }, { - "name": "label_i18n", - "type": "TypeMap", - "description": "A map of translated strings, by language code.", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "catalog_id", + "type": "TypeString", + "description": "Catalog identifier.", + "required": true }, { "name": "label", @@ -11703,11 +11778,20 @@ "computed": true }, { - "name": "catalog_object_id", + "name": "updated", "type": "TypeString", - "description": "unique id.", + "description": "The date and time this catalog was last updated.", "computed": true }, + { + "name": "short_description_i18n", + "type": "TypeMap", + "description": "A map of translated strings, by language code.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, { "name": "name", "type": "TypeString", @@ -11715,11 +11799,22 @@ "computed": true }, { - "name": "updated", + "name": "crn", "type": "TypeString", - "description": "The date and time this catalog was last updated.", + "description": "The crn for this specific object.", + "cloud_data_type": "crn", "computed": true }, + { + "name": "tags", + "type": "TypeList", + "description": "List of tags associated with this catalog.", + "cloud_data_type": "tags", + "computed": true, + "elem": { + "type": "TypeString" + } + }, { "name": "data", "type": "TypeString", @@ -11729,263 +11824,197 @@ ], "ibm_cm_offering": [ { - "name": "share_with_ibm", - "type": "TypeBool", - "description": "Denotes IBM employee availability of an Offering - if share_enabled is true.", + "name": "portal_ui_url", + "type": "TypeString", + "description": "The portal UI URL.", "computed": true }, { - "name": "media", - "type": "TypeList", - "description": "A list of media items related to this offering.", - "computed": true, - "elem": { - "api_url": { - "name": "api_url", - "type": "TypeString", - "description": "CM API specific URL of the specified media item.", - "computed": true - }, - "caption": { - "name": "caption", - "type": "TypeString", - "description": "Caption for this media item.", - "computed": true - }, - "caption_i18n": { - "name": "caption_i18n", - "type": "TypeMap", - "description": "A map of translated strings, by language code.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "thumbnail_url": { - "name": "thumbnail_url", - "type": "TypeString", - "description": "Thumbnail URL for this media item.", - "computed": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "Type of this media item.", - "computed": true - }, - "url": { - "name": "url", - "type": "TypeString", - "description": "URL of the specified media item.", - "computed": true - }, - "url_proxy": { - "name": "url_proxy", - "type": "TypeList", - "description": "Offering URL proxy information.", - "computed": true, - "elem": { - "sha": { - "name": "sha", - "type": "TypeString", - "description": "SHA256 fingerprint of image.", - "computed": true - }, - "url": { - "name": "url", - "type": "TypeString", - "description": "URL of the specified media item being proxied.", - "computed": true - } - } - } - } + "name": "catalog_id", + "type": "TypeString", + "description": "Catalog identifier.", + "immutable": true, + "required": true }, { - "name": "rev", + "name": "offering_docs_url", "type": "TypeString", - "description": "Cloudant revision.", + "description": "URL for an additional docs with this offering.", "computed": true }, { - "name": "offering_icon_url", + "name": "short_description", "type": "TypeString", - "description": "URL for an icon associated with this offering.", + "description": "Short description in the requested language.", "computed": true }, { - "name": "created", - "type": "TypeString", - "description": "The date and time this catalog was created.", + "name": "long_description_i18n", + "type": "TypeMap", + "description": "A map of translated strings, by language code.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "pc_managed", + "type": "TypeBool", + "description": "Offering is managed by Partner Center.", "computed": true }, { - "name": "long_description", - "type": "TypeString", - "description": "Long description in the requested language.", + "name": "share_with_all", + "type": "TypeBool", + "description": "Denotes public availability of an Offering - if share_enabled is true.", "computed": true }, { - "name": "portal_approval_record", + "name": "publish_public_crn", "type": "TypeString", - "description": "The portal's approval record ID.", + "description": "The crn of the public catalog entry of this offering.", "computed": true }, { - "name": "metadata", - "type": "TypeMap", - "description": "Map of metadata values for this offering.", + "name": "deprecate_pending", + "type": "TypeList", + "description": "Deprecation information for an Offering.", "computed": true, "elem": { - "type": "TypeString" + "deprecate_date": { + "name": "deprecate_date", + "type": "TypeString", + "description": "Date of deprecation.", + "computed": true + }, + "deprecate_state": { + "name": "deprecate_state", + "type": "TypeString", + "description": "Deprecation state.", + "computed": true + }, + "description": { + "name": "description", + "type": "TypeString", + "computed": true + } } }, { - "name": "name", + "name": "offering_identifier", "type": "TypeString", - "description": "The programmatic name of this offering.", + "description": "Computed Offering ID.", "computed": true }, { - "name": "offering_docs_url", + "name": "url", "type": "TypeString", - "description": "URL for an additional docs with this offering.", + "description": "The url for this specific offering.", "computed": true }, { - "name": "ibm_publish_approved", - "type": "TypeBool", - "description": "Indicates if this offering has been approved for use by all IBMers.", - "computed": true, - "deprecated": "This argument is deprecated" - }, - { - "name": "public_publish_approved", - "type": "TypeBool", - "description": "Indicates if this offering has been approved for use by all IBM Cloud users.", - "computed": true, - "deprecated": "This argument is deprecated" - }, - { - "name": "publish_public_crn", + "name": "crn", "type": "TypeString", - "description": "The crn of the public catalog entry of this offering.", + "description": "The crn for this specific offering.", + "cloud_data_type": "crn", "computed": true }, { - "name": "catalog_name", + "name": "label", "type": "TypeString", - "description": "The name of the catalog.", + "description": "Display Name in the requested language.", "computed": true }, { - "name": "disclaimer", + "name": "updated", "type": "TypeString", - "description": "A disclaimer for this offering.", + "description": "The date and time this catalog was last updated.", "computed": true }, { - "name": "provider_info", + "name": "features", "type": "TypeList", - "description": "Information on the provider for this offering, or omitted if no provider information is given.", + "description": "list of features associated with this offering.", "computed": true, "elem": { - "id": { - "name": "id", + "description": { + "name": "description", "type": "TypeString", - "description": "The id of this provider.", + "description": "Feature description.", "computed": true }, - "name": { - "name": "name", + "description_i18n": { + "name": "description_i18n", + "type": "TypeMap", + "description": "A map of translated strings, by language code.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "title": { + "name": "title", "type": "TypeString", - "description": "The name of this provider.", + "description": "Heading.", "computed": true + }, + "title_i18n": { + "name": "title_i18n", + "type": "TypeMap", + "description": "A map of translated strings, by language code.", + "computed": true, + "elem": { + "type": "TypeString" + } } } }, { - "name": "tags", - "type": "TypeList", - "description": "List of tags associated with this catalog.", - "cloud_data_type": "tags", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "permit_request_ibm_public_publish", - "type": "TypeBool", - "description": "Is it permitted to request publishing to IBM or Public.", - "computed": true, - "deprecated": "This argument is deprecated" - }, - { - "name": "deprecate_pending", + "name": "image_pull_keys", "type": "TypeList", - "description": "Deprecation information for an Offering.", + "description": "Image pull keys for this offering.", "computed": true, "elem": { - "deprecate_date": { - "name": "deprecate_date", + "description": { + "name": "description", "type": "TypeString", - "description": "Date of deprecation.", + "description": "Key description.", "computed": true }, - "deprecate_state": { - "name": "deprecate_state", + "name": { + "name": "name", "type": "TypeString", - "description": "Deprecation state.", + "description": "Key name.", "computed": true }, - "description": { - "name": "description", + "value": { + "name": "value", "type": "TypeString", + "description": "Key value.", "computed": true } } }, { - "name": "badges", + "name": "media", "type": "TypeList", - "description": "A list of badges for this offering.", + "description": "A list of media items related to this offering.", "computed": true, "elem": { - "authority": { - "name": "authority", + "api_url": { + "name": "api_url", "type": "TypeString", - "description": "Authority for the current badge.", + "description": "CM API specific URL of the specified media item.", "computed": true }, - "constraints": { - "name": "constraints", - "type": "TypeList", - "description": "An optional set of constraints indicating which versions in an Offering have this particular badge.", - "computed": true, - "elem": { - "rule": { - "name": "rule", - "type": "TypeString", - "description": "Rule for the current constraint.", - "computed": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "Type of the current constraint.", - "computed": true - } - } - }, - "description": { - "name": "description", + "caption": { + "name": "caption", "type": "TypeString", - "description": "Description of the current badge.", + "description": "Caption for this media item.", "computed": true }, - "description_i18n": { - "name": "description_i18n", + "caption_i18n": { + "name": "caption_i18n", "type": "TypeMap", "description": "A map of translated strings, by language code.", "computed": true, @@ -11993,61 +12022,64 @@ "type": "TypeString" } }, - "icon": { - "name": "icon", + "thumbnail_url": { + "name": "thumbnail_url", "type": "TypeString", - "description": "Icon for the current badge.", + "description": "Thumbnail URL for this media item.", "computed": true }, - "id": { - "name": "id", + "type": { + "name": "type", "type": "TypeString", - "description": "ID of the current badge.", + "description": "Type of this media item.", "computed": true }, - "label": { - "name": "label", + "url": { + "name": "url", "type": "TypeString", - "description": "Display name for the current badge.", + "description": "URL of the specified media item.", "computed": true }, - "label_i18n": { - "name": "label_i18n", - "type": "TypeMap", - "description": "A map of translated strings, by language code.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "learn_more_links": { - "name": "learn_more_links", + "url_proxy": { + "name": "url_proxy", "type": "TypeList", - "description": "Learn more links for a badge.", + "description": "Offering URL proxy information.", "computed": true, "elem": { - "first_party": { - "name": "first_party", + "sha": { + "name": "sha", "type": "TypeString", - "description": "First party link.", + "description": "SHA256 fingerprint of image.", "computed": true }, - "third_party": { - "name": "third_party", + "url": { + "name": "url", "type": "TypeString", - "description": "Third party link.", + "description": "URL of the specified media item being proxied.", "computed": true } } - }, - "tag": { - "name": "tag", - "type": "TypeString", - "description": "Tag for the current badge.", - "computed": true } } }, + { + "name": "short_description_i18n", + "type": "TypeMap", + "description": "A map of translated strings, by language code.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "metadata", + "type": "TypeMap", + "description": "Map of metadata values for this offering.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, { "name": "repo_info", "type": "TypeList", @@ -12069,30 +12101,16 @@ } }, { - "name": "image_pull_keys", - "type": "TypeList", - "description": "Image pull keys for this offering.", - "computed": true, - "elem": { - "description": { - "name": "description", - "type": "TypeString", - "description": "Key description.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Key name.", - "computed": true - }, - "value": { - "name": "value", - "type": "TypeString", - "description": "Key value.", - "computed": true - } - } + "name": "rev", + "type": "TypeString", + "description": "Cloudant revision.", + "computed": true + }, + { + "name": "offering_icon_url", + "type": "TypeString", + "description": "URL for an icon associated with this offering.", + "computed": true }, { "name": "publish_approved", @@ -12101,52 +12119,445 @@ "computed": true }, { - "name": "product_kind", - "type": "TypeString", - "description": "The product kind. Valid values are module, solution, or empty string.", - "computed": true + "name": "share_with_access_list", + "type": "TypeList", + "description": "A list of account IDs to add to this offering's access list.", + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "short_description", - "type": "TypeString", - "description": "Short description in the requested language.", - "computed": true + "name": "public_publish_approved", + "type": "TypeBool", + "description": "Indicates if this offering has been approved for use by all IBM Cloud users.", + "computed": true, + "deprecated": "This argument is deprecated" }, { - "name": "kinds", + "name": "support", "type": "TypeList", - "description": "Array of kind.", + "description": "Offering Support information.", "computed": true, "elem": { - "additional_features": { - "name": "additional_features", + "locations": { + "name": "locations", "type": "TypeList", - "description": "List of features associated with this offering.", + "description": "A list of country codes indicating where support is provided.", "computed": true, "elem": { - "description": { - "name": "description", - "type": "TypeString", - "description": "Feature description.", - "computed": true - }, - "description_i18n": { - "name": "description_i18n", - "type": "TypeMap", - "description": "A map of translated strings, by language code.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "title": { - "name": "title", - "type": "TypeString", - "description": "Heading.", - "computed": true - }, - "title_i18n": { - "name": "title_i18n", + "type": "TypeString" + } + }, + "process": { + "name": "process", + "type": "TypeString", + "description": "Support process as provided by an ISV.", + "computed": true + }, + "process_i18n": { + "name": "process_i18n", + "type": "TypeMap", + "description": "A map of translated strings, by language code.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "support_details": { + "name": "support_details", + "type": "TypeList", + "description": "A list of support options (e.g. email, phone, slack, other).", + "computed": true, + "elem": { + "availability": { + "name": "availability", + "type": "TypeList", + "description": "Times when support is available.", + "computed": true, + "elem": { + "always_available": { + "name": "always_available", + "type": "TypeBool", + "description": "Is this support always available.", + "computed": true + }, + "times": { + "name": "times", + "type": "TypeList", + "description": "A list of support times.", + "computed": true, + "elem": { + "day": { + "name": "day", + "type": "TypeInt", + "description": "The day of the week, represented as an integer.", + "computed": true + }, + "end_time": { + "name": "end_time", + "type": "TypeString", + "description": "HOURS:MINUTES:SECONDS using 24 hour time (e.g. 8:15:00).", + "computed": true + }, + "start_time": { + "name": "start_time", + "type": "TypeString", + "description": "HOURS:MINUTES:SECONDS using 24 hour time (e.g. 8:15:00).", + "computed": true + } + } + }, + "timezone": { + "name": "timezone", + "type": "TypeString", + "description": "Timezone (e.g. America/New_York).", + "computed": true + } + } + }, + "contact": { + "name": "contact", + "type": "TypeString", + "description": "Contact for the current support detail.", + "computed": true + }, + "response_wait_time": { + "name": "response_wait_time", + "type": "TypeList", + "description": "Time descriptor.", + "computed": true, + "elem": { + "type": { + "name": "type", + "type": "TypeString", + "description": "Valid values are hour or day.", + "computed": true + }, + "value": { + "name": "value", + "type": "TypeInt", + "description": "Amount of time to wait in unit 'type'.", + "computed": true + } + } + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "Type of the current support detail.", + "computed": true + } + } + }, + "support_escalation": { + "name": "support_escalation", + "type": "TypeList", + "description": "Support escalation policy.", + "computed": true, + "elem": { + "contact": { + "name": "contact", + "type": "TypeString", + "description": "Escalation contact.", + "computed": true + }, + "escalation_wait_time": { + "name": "escalation_wait_time", + "type": "TypeList", + "description": "Time descriptor.", + "computed": true, + "elem": { + "type": { + "name": "type", + "type": "TypeString", + "description": "Valid values are hour or day.", + "computed": true + }, + "value": { + "name": "value", + "type": "TypeInt", + "description": "Amount of time to wait in unit 'type'.", + "computed": true + } + } + }, + "response_wait_time": { + "name": "response_wait_time", + "type": "TypeList", + "description": "Time descriptor.", + "computed": true, + "elem": { + "type": { + "name": "type", + "type": "TypeString", + "description": "Valid values are hour or day.", + "computed": true + }, + "value": { + "name": "value", + "type": "TypeInt", + "description": "Amount of time to wait in unit 'type'.", + "computed": true + } + } + } + } + }, + "support_type": { + "name": "support_type", + "type": "TypeString", + "description": "Support type for this product.", + "computed": true + }, + "url": { + "name": "url", + "type": "TypeString", + "description": "URL to be displayed in the Consumption UI for getting support on this offering.", + "computed": true + } + } + }, + { + "name": "product_kind", + "type": "TypeString", + "description": "The product kind. Valid values are module, solution, or empty string.", + "computed": true + }, + { + "name": "offering_support_url", + "type": "TypeString", + "description": "[deprecated] - Use offering.support instead. URL to be displayed in the Consumption UI for getting support on this offering.", + "computed": true + }, + { + "name": "created", + "type": "TypeString", + "description": "The date and time this catalog was created.", + "computed": true + }, + { + "name": "provider_info", + "type": "TypeList", + "description": "Information on the provider for this offering, or omitted if no provider information is given.", + "computed": true, + "elem": { + "id": { + "name": "id", + "type": "TypeString", + "description": "The id of this provider.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The name of this provider.", + "computed": true + } + } + }, + { + "name": "badges", + "type": "TypeList", + "description": "A list of badges for this offering.", + "computed": true, + "elem": { + "authority": { + "name": "authority", + "type": "TypeString", + "description": "Authority for the current badge.", + "computed": true + }, + "constraints": { + "name": "constraints", + "type": "TypeList", + "description": "An optional set of constraints indicating which versions in an Offering have this particular badge.", + "computed": true, + "elem": { + "rule": { + "name": "rule", + "type": "TypeString", + "description": "Rule for the current constraint.", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "Type of the current constraint.", + "computed": true + } + } + }, + "description": { + "name": "description", + "type": "TypeString", + "description": "Description of the current badge.", + "computed": true + }, + "description_i18n": { + "name": "description_i18n", + "type": "TypeMap", + "description": "A map of translated strings, by language code.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "icon": { + "name": "icon", + "type": "TypeString", + "description": "Icon for the current badge.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "ID of the current badge.", + "computed": true + }, + "label": { + "name": "label", + "type": "TypeString", + "description": "Display name for the current badge.", + "computed": true + }, + "label_i18n": { + "name": "label_i18n", + "type": "TypeMap", + "description": "A map of translated strings, by language code.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "learn_more_links": { + "name": "learn_more_links", + "type": "TypeList", + "description": "Learn more links for a badge.", + "computed": true, + "elem": { + "first_party": { + "name": "first_party", + "type": "TypeString", + "description": "First party link.", + "computed": true + }, + "third_party": { + "name": "third_party", + "type": "TypeString", + "description": "Third party link.", + "computed": true + } + } + }, + "tag": { + "name": "tag", + "type": "TypeString", + "description": "Tag for the current badge.", + "computed": true + } + } + }, + { + "name": "long_description", + "type": "TypeString", + "description": "Long description in the requested language.", + "computed": true + }, + { + "name": "share_with_ibm", + "type": "TypeBool", + "description": "Denotes IBM employee availability of an Offering - if share_enabled is true.", + "computed": true + }, + { + "name": "catalog_name", + "type": "TypeString", + "description": "The name of the catalog.", + "computed": true + }, + { + "name": "hidden", + "type": "TypeBool", + "description": "Determine if this offering should be displayed in the Consumption UI.", + "computed": true + }, + { + "name": "portal_approval_record", + "type": "TypeString", + "description": "The portal's approval record ID.", + "computed": true + }, + { + "name": "offering_id", + "type": "TypeString", + "description": "Offering identifier.", + "immutable": true, + "required": true + }, + { + "name": "label_i18n", + "type": "TypeMap", + "description": "A map of translated strings, by language code.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "tags", + "type": "TypeList", + "description": "List of tags associated with this catalog.", + "cloud_data_type": "tags", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "keywords", + "type": "TypeList", + "description": "List of keywords associated with offering, typically used to search for it.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "kinds", + "type": "TypeList", + "description": "Array of kind.", + "computed": true, + "elem": { + "additional_features": { + "name": "additional_features", + "type": "TypeList", + "description": "List of features associated with this offering.", + "computed": true, + "elem": { + "description": { + "name": "description", + "type": "TypeString", + "description": "Feature description.", + "computed": true + }, + "description_i18n": { + "name": "description_i18n", + "type": "TypeMap", + "description": "A map of translated strings, by language code.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "title": { + "name": "title", + "type": "TypeString", + "description": "Heading.", + "computed": true + }, + "title_i18n": { + "name": "title_i18n", "type": "TypeMap", "description": "A map of translated strings, by language code.", "computed": true, @@ -14152,20 +14563,24 @@ } }, { - "name": "offering_id", - "type": "TypeString", - "description": "Offering identifier.", - "immutable": true, - "required": true + "name": "permit_request_ibm_public_publish", + "type": "TypeBool", + "description": "Is it permitted to request publishing to IBM or Public.", + "computed": true, + "deprecated": "This argument is deprecated" }, { - "name": "label_i18n", - "type": "TypeMap", - "description": "A map of translated strings, by language code.", + "name": "ibm_publish_approved", + "type": "TypeBool", + "description": "Indicates if this offering has been approved for use by all IBMers.", "computed": true, - "elem": { - "type": "TypeString" - } + "deprecated": "This argument is deprecated" + }, + { + "name": "name", + "type": "TypeString", + "description": "The programmatic name of this offering.", + "computed": true }, { "name": "rating", @@ -14200,355 +14615,99 @@ } }, { - "name": "updated", - "type": "TypeString", - "description": "The date and time this catalog was last updated.", - "computed": true - }, - { - "name": "short_description_i18n", - "type": "TypeMap", - "description": "A map of translated strings, by language code.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "pc_managed", + "name": "share_enabled", "type": "TypeBool", - "description": "Offering is managed by Partner Center.", + "description": "Denotes sharing including access list availability of an Offering is enabled.", "computed": true }, { - "name": "url", + "name": "public_original_crn", "type": "TypeString", - "description": "The url for this specific offering.", + "description": "The original offering CRN that this publish entry came from.", "computed": true }, { - "name": "crn", + "name": "disclaimer", "type": "TypeString", - "description": "The crn for this specific offering.", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "features", - "type": "TypeList", - "description": "list of features associated with this offering.", - "computed": true, - "elem": { - "description": { - "name": "description", - "type": "TypeString", - "description": "Feature description.", - "computed": true - }, - "description_i18n": { - "name": "description_i18n", - "type": "TypeMap", - "description": "A map of translated strings, by language code.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "title": { - "name": "title", - "type": "TypeString", - "description": "Heading.", - "computed": true - }, - "title_i18n": { - "name": "title_i18n", - "type": "TypeMap", - "description": "A map of translated strings, by language code.", - "computed": true, - "elem": { - "type": "TypeString" - } - } - } - }, - { - "name": "share_with_all", - "type": "TypeBool", - "description": "Denotes public availability of an Offering - if share_enabled is true.", + "description": "A disclaimer for this offering.", "computed": true - }, + } + ], + "ibm_cm_offering_instance": [ { - "name": "support", + "name": "cluster_namespaces", "type": "TypeList", - "description": "Offering Support information.", + "description": "List of target namespaces to install into.", "computed": true, "elem": { - "locations": { - "name": "locations", - "type": "TypeList", - "description": "A list of country codes indicating where support is provided.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "process": { - "name": "process", - "type": "TypeString", - "description": "Support process as provided by an ISV.", - "computed": true - }, - "process_i18n": { - "name": "process_i18n", - "type": "TypeMap", - "description": "A map of translated strings, by language code.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "support_details": { - "name": "support_details", - "type": "TypeList", - "description": "A list of support options (e.g. email, phone, slack, other).", - "computed": true, - "elem": { - "availability": { - "name": "availability", - "type": "TypeList", - "description": "Times when support is available.", - "computed": true, - "elem": { - "always_available": { - "name": "always_available", - "type": "TypeBool", - "description": "Is this support always available.", - "computed": true - }, - "times": { - "name": "times", - "type": "TypeList", - "description": "A list of support times.", - "computed": true, - "elem": { - "day": { - "name": "day", - "type": "TypeInt", - "description": "The day of the week, represented as an integer.", - "computed": true - }, - "end_time": { - "name": "end_time", - "type": "TypeString", - "description": "HOURS:MINUTES:SECONDS using 24 hour time (e.g. 8:15:00).", - "computed": true - }, - "start_time": { - "name": "start_time", - "type": "TypeString", - "description": "HOURS:MINUTES:SECONDS using 24 hour time (e.g. 8:15:00).", - "computed": true - } - } - }, - "timezone": { - "name": "timezone", - "type": "TypeString", - "description": "Timezone (e.g. America/New_York).", - "computed": true - } - } - }, - "contact": { - "name": "contact", - "type": "TypeString", - "description": "Contact for the current support detail.", - "computed": true - }, - "response_wait_time": { - "name": "response_wait_time", - "type": "TypeList", - "description": "Time descriptor.", - "computed": true, - "elem": { - "type": { - "name": "type", - "type": "TypeString", - "description": "Valid values are hour or day.", - "computed": true - }, - "value": { - "name": "value", - "type": "TypeInt", - "description": "Amount of time to wait in unit 'type'.", - "computed": true - } - } - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "Type of the current support detail.", - "computed": true - } - } - }, - "support_escalation": { - "name": "support_escalation", - "type": "TypeList", - "description": "Support escalation policy.", - "computed": true, - "elem": { - "contact": { - "name": "contact", - "type": "TypeString", - "description": "Escalation contact.", - "computed": true - }, - "escalation_wait_time": { - "name": "escalation_wait_time", - "type": "TypeList", - "description": "Time descriptor.", - "computed": true, - "elem": { - "type": { - "name": "type", - "type": "TypeString", - "description": "Valid values are hour or day.", - "computed": true - }, - "value": { - "name": "value", - "type": "TypeInt", - "description": "Amount of time to wait in unit 'type'.", - "computed": true - } - } - }, - "response_wait_time": { - "name": "response_wait_time", - "type": "TypeList", - "description": "Time descriptor.", - "computed": true, - "elem": { - "type": { - "name": "type", - "type": "TypeString", - "description": "Valid values are hour or day.", - "computed": true - }, - "value": { - "name": "value", - "type": "TypeInt", - "description": "Amount of time to wait in unit 'type'.", - "computed": true - } - } - } - } - }, - "support_type": { - "name": "support_type", - "type": "TypeString", - "description": "Support type for this product.", - "computed": true - }, - "url": { - "name": "url", - "type": "TypeString", - "description": "URL to be displayed in the Consumption UI for getting support on this offering.", - "computed": true - } + "type": "TypeString" } }, { - "name": "label", + "name": "schematics_workspace_id", "type": "TypeString", - "description": "Display Name in the requested language.", + "description": "id of the schematics workspace, for offerings installed through schematics", "computed": true }, { - "name": "long_description_i18n", - "type": "TypeMap", - "description": "A map of translated strings, by language code.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "keywords", - "type": "TypeList", - "description": "List of keywords associated with offering, typically used to search for it.", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "instance_identifier", + "type": "TypeString", + "description": "ID for this instance", + "required": true }, { - "name": "share_enabled", - "type": "TypeBool", - "description": "Denotes sharing including access list availability of an Offering is enabled.", + "name": "crn", + "type": "TypeString", + "description": "platform CRN for this instance.", + "cloud_data_type": "crn", "computed": true }, { - "name": "share_with_access_list", - "type": "TypeList", - "description": "A list of account IDs to add to this offering's access list.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "public_original_crn", + "name": "channel", "type": "TypeString", - "description": "The original offering CRN that this publish entry came from.", + "description": "channel to target for the operator subscription. Required for operator bundles", "computed": true }, { - "name": "portal_ui_url", + "name": "catalog_id", "type": "TypeString", - "description": "The portal UI URL.", + "description": "Catalog ID this instance was created from.", "computed": true }, { - "name": "hidden", + "name": "cluster_all_namespaces", "type": "TypeBool", - "description": "Determine if this offering should be displayed in the Consumption UI.", + "description": "designate to install into all namespaces.", "computed": true }, { - "name": "catalog_id", + "name": "version", "type": "TypeString", - "description": "Catalog identifier.", - "immutable": true, - "required": true + "description": "The version this instance was installed from (not version id).", + "computed": true }, { - "name": "offering_support_url", + "name": "cluster_id", "type": "TypeString", - "description": "[deprecated] - Use offering.support instead. URL to be displayed in the Consumption UI for getting support on this offering.", + "description": "Cluster ID.", "computed": true }, { - "name": "offering_identifier", + "name": "label", "type": "TypeString", - "description": "Computed Offering ID.", + "description": "the label for this instance.", "computed": true - } - ], - "ibm_cm_offering_instance": [ + }, { - "name": "version", + "name": "offering_id", "type": "TypeString", - "description": "The version this instance was installed from (not version id).", + "description": "Offering ID this instance was created from.", "computed": true }, { - "name": "cluster_id", + "name": "kind_format", "type": "TypeString", - "description": "Cluster ID.", + "description": "the format this instance has (helm, operator, ova...).", "computed": true }, { @@ -14558,9 +14717,10 @@ "computed": true }, { - "name": "cluster_all_namespaces", - "type": "TypeBool", - "description": "designate to install into all namespaces.", + "name": "resource_group_id", + "type": "TypeString", + "description": "id of the resource group", + "cloud_data_type": "resource_group", "computed": true }, { @@ -14570,98 +14730,119 @@ "computed": true }, { - "name": "crn", + "name": "url", "type": "TypeString", - "description": "platform CRN for this instance.", - "cloud_data_type": "crn", + "description": "url reference to this object.", "computed": true }, { - "name": "schematics_workspace_id", + "name": "_rev", "type": "TypeString", - "description": "id of the schematics workspace, for offerings installed through schematics", + "description": "Cloudant Revision for this instance", "computed": true - }, + } + ], + "ibm_cm_preset": [ { - "name": "resource_group_id", + "name": "id", "type": "TypeString", - "description": "id of the resource group", - "cloud_data_type": "resource_group", - "computed": true + "description": "The ID of the preset. Format is \u003ccatalog_id\u003e-\u003cobject_name\u003e@\u003cversion\u003e", + "required": true }, { - "name": "channel", + "name": "preset", "type": "TypeString", - "description": "channel to target for the operator subscription. Required for operator bundles", + "description": "The map of preset values as a JSON string.", "computed": true - }, + } + ], + "ibm_cm_version": [ { - "name": "url", + "name": "kind_id", "type": "TypeString", - "description": "url reference to this object.", + "description": "Kind ID.", "computed": true }, { - "name": "catalog_id", - "type": "TypeString", - "description": "Catalog ID this instance was created from.", - "computed": true + "name": "iam_permissions", + "type": "TypeList", + "description": "List of IAM permissions that are required to consume this version.", + "computed": true, + "elem": { + "resources": { + "name": "resources", + "type": "TypeList", + "description": "Resources for this permission.", + "computed": true, + "elem": { + "description": { + "name": "description", + "type": "TypeString", + "description": "Resource description.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Resource name.", + "computed": true + }, + "role_crns": { + "name": "role_crns", + "type": "TypeList", + "description": "Role CRNs for this permission.", + "computed": true, + "elem": { + "type": "TypeString" + } + } + } + }, + "role_crns": { + "name": "role_crns", + "type": "TypeList", + "description": "Role CRNs for this permission.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "service_name": { + "name": "service_name", + "type": "TypeString", + "description": "Service name.", + "computed": true + } + } }, { - "name": "cluster_namespaces", - "type": "TypeList", - "description": "List of target namespaces to install into.", + "name": "long_description_i18n", + "type": "TypeMap", + "description": "A map of translated strings, by language code.", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "instance_identifier", + "name": "version_loc_id", "type": "TypeString", - "description": "ID for this instance", + "description": "A dotted value of `catalogID`.`versionID`.", "required": true }, { - "name": "_rev", - "type": "TypeString", - "description": "Cloudant Revision for this instance", - "computed": true - }, - { - "name": "label", - "type": "TypeString", - "description": "the label for this instance.", - "computed": true - }, - { - "name": "offering_id", + "name": "crn", "type": "TypeString", - "description": "Offering ID this instance was created from.", + "description": "Version's CRN.", + "cloud_data_type": "crn", "computed": true }, { - "name": "kind_format", + "name": "version", "type": "TypeString", - "description": "the format this instance has (helm, operator, ova...).", + "description": "Version of content type.", "computed": true - } - ], - "ibm_cm_preset": [ - { - "name": "id", - "type": "TypeString", - "description": "The ID of the preset. Format is \u003ccatalog_id\u003e-\u003cobject_name\u003e@\u003cversion\u003e", - "required": true }, - { - "name": "preset", - "type": "TypeString", - "description": "The map of preset values as a JSON string.", - "computed": true - } - ], - "ibm_cm_version": [ { "name": "flavor", "type": "TypeList", @@ -14698,809 +14879,221 @@ } }, { - "name": "metadata", + "name": "catalog_id", + "type": "TypeString", + "description": "Catalog ID.", + "computed": true + }, + { + "name": "tags", "type": "TypeList", - "description": "Generic data to be included with content being onboarded. Required for virtual server image for VPC.", + "description": "List of tags associated with this catalog.", + "cloud_data_type": "tags", "computed": true, "elem": { - "end_deploy_time": { - "name": "end_deploy_time", + "type": "TypeString" + } + }, + { + "name": "outputs", + "type": "TypeList", + "description": "List of output values for this version.", + "computed": true, + "elem": { + "description": { + "name": "description", "type": "TypeString", - "description": "The time validation ended.", + "description": "Output description.", "computed": true }, - "est_deploy_time": { - "name": "est_deploy_time", - "type": "TypeFloat", - "description": "The estimated time validation takes.", + "key": { + "name": "key", + "type": "TypeString", + "description": "Output key.", "computed": true - }, - "example_name": { - "name": "example_name", + } + } + }, + { + "name": "licenses", + "type": "TypeList", + "description": "List of licenses the product was built with.", + "computed": true, + "elem": { + "description": { + "name": "description", "type": "TypeString", - "description": "Working directory of source files.", + "description": "License description.", "computed": true }, - "file": { - "name": "file", - "type": "TypeList", - "description": "Details for the stored image file. Required for virtual server image for VPC.", - "computed": true, - "elem": { - "size": { - "name": "size", - "type": "TypeInt", - "description": "Size of the stored image file rounded up to the next gigabyte. Required for virtual server image for VPC.", - "computed": true - } - } + "id": { + "name": "id", + "type": "TypeString", + "description": "License ID.", + "computed": true }, - "images": { - "name": "images", - "type": "TypeList", - "description": "Image operating system. Required for virtual server image for VPC.", - "computed": true, - "elem": { - "id": { - "name": "id", - "type": "TypeString", - "description": "Programmatic ID of virtual server image. Required for virtual server image for VPC.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Programmatic name of virtual server image. Required for virtual server image for VPC.", - "computed": true - }, - "region": { - "name": "region", - "type": "TypeString", - "description": "Region the virtual server image is available in. Required for virtual server image for VPC.", - "computed": true - } - } + "name": { + "name": "name", + "type": "TypeString", + "description": "license name.", + "computed": true }, - "minimum_provisioned_size": { - "name": "minimum_provisioned_size", - "type": "TypeInt", - "description": "Minimum size (in gigabytes) of a volume onto which this image may be provisioned. Required for virtual server image for VPC.", + "type": { + "name": "type", + "type": "TypeString", + "description": "type of license e.g., Apache xxx.", "computed": true }, - "modules": { - "name": "modules", + "url": { + "name": "url", + "type": "TypeString", + "description": "URL for the license text.", + "computed": true + } + } + }, + { + "name": "solution_info", + "type": "TypeList", + "description": "Version Solution Information. Only supported for Product kind Solution.", + "computed": true, + "elem": { + "architecture_diagrams": { + "name": "architecture_diagrams", "type": "TypeList", - "description": "Terraform modules.", + "description": "Architecture diagrams for this solution.", "computed": true, "elem": { - "name": { - "name": "name", + "description": { + "name": "description", "type": "TypeString", - "description": "Name of the module.", + "description": "Description of this diagram.", "computed": true }, - "offering_reference": { - "name": "offering_reference", + "description_i18n": { + "name": "description_i18n", + "type": "TypeMap", + "description": "A map of translated strings, by language code.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "diagram": { + "name": "diagram", "type": "TypeList", - "description": "Terraform modules.", + "description": "Offering Media information.", "computed": true, "elem": { - "catalog_id": { - "name": "catalog_id", + "api_url": { + "name": "api_url", "type": "TypeString", - "description": "Catalog ID of the module reference.", + "description": "CM API specific URL of the specified media item.", "computed": true }, - "flavor": { - "name": "flavor", + "caption": { + "name": "caption", "type": "TypeString", - "description": "Flavor of the module.", + "description": "Caption for this media item.", "computed": true }, - "flavors": { - "name": "flavors", - "type": "TypeList", - "description": "Flavors of the module.", + "caption_i18n": { + "name": "caption_i18n", + "type": "TypeMap", + "description": "A map of translated strings, by language code.", "computed": true, "elem": { "type": "TypeString" } }, - "id": { - "name": "id", - "type": "TypeString", - "description": "ID of the offering module.", - "computed": true - }, - "kind": { - "name": "kind", + "thumbnail_url": { + "name": "thumbnail_url", "type": "TypeString", - "description": "Kind of the offeringmodule.", + "description": "Thumbnail URL for this media item.", "computed": true }, - "metadata": { - "name": "metadata", + "type": { + "name": "type", "type": "TypeString", - "description": "Metadata of the module.", + "description": "Type of this media item.", "computed": true }, - "name": { - "name": "name", + "url": { + "name": "url", "type": "TypeString", - "description": "Name of the offering module.", + "description": "URL of the specified media item.", "computed": true }, - "version": { - "name": "version", - "type": "TypeString", - "description": "Version of the offering module.", - "computed": true + "url_proxy": { + "name": "url_proxy", + "type": "TypeList", + "description": "Offering URL proxy information.", + "computed": true, + "elem": { + "sha": { + "name": "sha", + "type": "TypeString", + "description": "SHA256 fingerprint of image.", + "computed": true + }, + "url": { + "name": "url", + "type": "TypeString", + "description": "URL of the specified media item being proxied.", + "computed": true + } + } } } - }, - "source": { - "name": "source", - "type": "TypeString", - "description": "Source of the module.", - "computed": true } } }, - "operating_system": { - "name": "operating_system", + "cost_estimate": { + "name": "cost_estimate", "type": "TypeList", - "description": "Operating system included in this image. Required for virtual server image for VPC.", + "description": "Cost estimate definition.", "computed": true, "elem": { - "architecture": { - "name": "architecture", - "type": "TypeString", - "description": "Operating system architecture. Required for virtual server image for VPC.", - "computed": true - }, - "dedicated_host_only": { - "name": "dedicated_host_only", - "type": "TypeBool", - "description": "Images with this operating system can only be used on dedicated hosts or dedicated host groups. Required for virtual server image for VPC.", - "computed": true - }, - "display_name": { - "name": "display_name", - "type": "TypeString", - "description": "Unique, display-friendly name for the operating system. Required for virtual server image for VPC.", - "computed": true - }, - "family": { - "name": "family", + "currency": { + "name": "currency", "type": "TypeString", - "description": "Software family for this operating system. Required for virtual server image for VPC.", + "description": "Cost estimate currency.", "computed": true }, - "href": { - "name": "href", + "diff_total_hourly_cost": { + "name": "diff_total_hourly_cost", "type": "TypeString", - "description": "URL for this operating system. Required for virtual server image for VPC.", + "description": "Difference in total hourly cost.", "computed": true }, - "name": { - "name": "name", + "diff_total_monthly_cost": { + "name": "diff_total_monthly_cost", "type": "TypeString", - "description": "Globally unique name for this operating system Required for virtual server image for VPC.", + "description": "Difference in total monthly cost.", "computed": true }, - "vendor": { - "name": "vendor", + "past_total_hourly_cost": { + "name": "past_total_hourly_cost", "type": "TypeString", - "description": "Vendor of the operating system. Required for virtual server image for VPC.", + "description": "Past total hourly cost.", "computed": true }, - "version": { - "name": "version", + "past_total_monthly_cost": { + "name": "past_total_monthly_cost", "type": "TypeString", - "description": "Major release version of this operating system. Required for virtual server image for VPC.", - "computed": true - } - } - }, - "source_url": { - "name": "source_url", - "type": "TypeString", - "description": "Version source URL.", - "computed": true - }, - "start_deploy_time": { - "name": "start_deploy_time", - "type": "TypeString", - "description": "The time validation started.", - "computed": true - }, - "terraform_version": { - "name": "terraform_version", - "type": "TypeString", - "description": "Terraform version.", - "computed": true - }, - "usage": { - "name": "usage", - "type": "TypeString", - "description": "Usage text for the version.", - "computed": true - }, - "usage_template": { - "name": "usage_template", - "type": "TypeString", - "description": "Usage text for the version.", - "computed": true - }, - "validated_terraform_version": { - "name": "validated_terraform_version", - "type": "TypeString", - "description": "Version name.", - "computed": true - }, - "version_name": { - "name": "version_name", - "type": "TypeString", - "description": "Version name.", - "computed": true - }, - "vsi_vpc": { - "name": "vsi_vpc", - "type": "TypeList", - "description": "VSI VPC version information", - "computed": true, - "elem": { - "file": { - "name": "file", - "type": "TypeList", - "description": "Details for the stored image file. Required for virtual server image for VPC.", - "computed": true, - "elem": { - "size": { - "name": "size", - "type": "TypeInt", - "description": "Size of the stored image file rounded up to the next gigabyte. Required for virtual server image for VPC.", - "computed": true - } - } - }, - "images": { - "name": "images", - "type": "TypeList", - "description": "Image operating system. Required for virtual server image for VPC.", - "computed": true, - "elem": { - "id": { - "name": "id", - "type": "TypeString", - "description": "Programmatic ID of virtual server image. Required for virtual server image for VPC.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Programmatic name of virtual server image. Required for virtual server image for VPC.", - "computed": true - }, - "region": { - "name": "region", - "type": "TypeString", - "description": "Region the virtual server image is available in. Required for virtual server image for VPC.", - "computed": true - } - } - }, - "minimum_provisioned_size": { - "name": "minimum_provisioned_size", - "type": "TypeInt", - "description": "Minimum size (in gigabytes) of a volume onto which this image may be provisioned. Required for virtual server image for VPC.", + "description": "Past total monthly cost.", "computed": true }, - "operating_system": { - "name": "operating_system", - "type": "TypeList", - "description": "Operating system included in this image. Required for virtual server image for VPC.", - "computed": true, - "elem": { - "architecture": { - "name": "architecture", - "type": "TypeString", - "description": "Operating system architecture. Required for virtual server image for VPC.", - "computed": true - }, - "dedicated_host_only": { - "name": "dedicated_host_only", - "type": "TypeBool", - "description": "Images with this operating system can only be used on dedicated hosts or dedicated host groups. Required for virtual server image for VPC.", - "computed": true - }, - "display_name": { - "name": "display_name", - "type": "TypeString", - "description": "Unique, display-friendly name for the operating system. Required for virtual server image for VPC.", - "computed": true - }, - "family": { - "name": "family", - "type": "TypeString", - "description": "Software family for this operating system. Required for virtual server image for VPC.", - "computed": true - }, - "href": { - "name": "href", - "type": "TypeString", - "description": "URL for this operating system. Required for virtual server image for VPC.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Globally unique name for this operating system Required for virtual server image for VPC.", - "computed": true - }, - "vendor": { - "name": "vendor", - "type": "TypeString", - "description": "Vendor of the operating system. Required for virtual server image for VPC.", - "computed": true - }, - "version": { - "name": "version", - "type": "TypeString", - "description": "Major release version of this operating system. Required for virtual server image for VPC.", - "computed": true - } - } - } - } - }, - "working_directory": { - "name": "working_directory", - "type": "TypeString", - "description": "Working directory of source files.", - "computed": true - } - } - }, - { - "name": "state", - "type": "TypeList", - "description": "Offering state.", - "computed": true, - "elem": { - "current": { - "name": "current", - "type": "TypeString", - "description": "one of: new, validated, account-published, ibm-published, public-published.", - "computed": true - }, - "current_entered": { - "name": "current_entered", - "type": "TypeString", - "description": "Date and time of current request.", - "computed": true - }, - "pending": { - "name": "pending", - "type": "TypeString", - "description": "one of: new, validated, account-published, ibm-published, public-published.", - "computed": true - }, - "pending_requested": { - "name": "pending_requested", - "type": "TypeString", - "description": "Date and time of pending request.", - "computed": true - }, - "previous": { - "name": "previous", - "type": "TypeString", - "description": "one of: new, validated, account-published, ibm-published, public-published.", - "computed": true - } - } - }, - { - "name": "version_locator", - "type": "TypeString", - "description": "A dotted value of `catalogID`.`versionID`.", - "computed": true - }, - { - "name": "tgz_url", - "type": "TypeString", - "description": "File used to on-board this version.", - "computed": true - }, - { - "name": "configuration", - "type": "TypeList", - "description": "List of user solicited overrides.", - "computed": true, - "elem": { - "custom_config": { - "name": "custom_config", - "type": "TypeList", - "description": "Render type.", - "computed": true, - "elem": { - "associations": { - "name": "associations", + "projects": { + "name": "projects", "type": "TypeList", - "description": "List of parameters that are associated with this configuration.", + "description": "Cost estimate projects.", "computed": true, "elem": { - "parameters": { - "name": "parameters", + "breakdown": { + "name": "breakdown", "type": "TypeList", - "description": "Parameters for this association.", - "computed": true, - "elem": { - "name": { - "name": "name", - "type": "TypeString", - "description": "Name of this parameter.", - "computed": true - }, - "options_refresh": { - "name": "options_refresh", - "type": "TypeBool", - "description": "Refresh options.", - "computed": true - } - } - } - } - }, - "config_constraints": { - "name": "config_constraints", - "type": "TypeMap", - "description": "Map of constraint parameters that will be passed to the custom widget.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "grouping": { - "name": "grouping", - "type": "TypeString", - "description": "Determines where this configuration type is rendered (3 sections today - Target, Resource, and Deployment).", - "computed": true - }, - "grouping_index": { - "name": "grouping_index", - "type": "TypeInt", - "description": "Determines the order that this configuration item shows in that particular grouping.", - "computed": true - }, - "original_grouping": { - "name": "original_grouping", - "type": "TypeString", - "description": "Original grouping type for this configuration (3 types - Target, Resource, and Deployment).", - "computed": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "ID of the widget type.", - "computed": true - } - } - }, - "default_value": { - "name": "default_value", - "type": "TypeString", - "description": "The default value as a JSON encoded string. To use a secret when the type is password, specify a JSON encoded value of $ref:#/components/schemas/SecretInstance, prefixed with `cmsm_v1:`.", - "computed": true - }, - "description": { - "name": "description", - "type": "TypeString", - "description": "Key description.", - "computed": true - }, - "display_name": { - "name": "display_name", - "type": "TypeString", - "description": "Display name for configuration type.", - "computed": true - }, - "hidden": { - "name": "hidden", - "type": "TypeBool", - "description": "Hide values.", - "computed": true - }, - "key": { - "name": "key", - "type": "TypeString", - "description": "Configuration key.", - "computed": true - }, - "options": { - "name": "options", - "type": "TypeList", - "description": "List of options of type.", - "computed": true, - "elem": { - "type": "TypeMap" - } - }, - "required": { - "name": "required", - "type": "TypeBool", - "description": "Is key required to install.", - "computed": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "Value type (string, boolean, int).", - "computed": true - }, - "type_metadata": { - "name": "type_metadata", - "type": "TypeString", - "description": "The original type, as found in the source being onboarded.", - "computed": true - }, - "value_constraint": { - "name": "value_constraint", - "type": "TypeString", - "description": "Constraint associated with value, e.g., for string type - regx:[a-z].", - "computed": true - } - } - }, - { - "name": "required_resources", - "type": "TypeList", - "description": "Resource requirments for installation.", - "computed": true, - "elem": { - "type": { - "name": "type", - "type": "TypeString", - "description": "Type of requirement.", - "computed": true - }, - "value": { - "name": "value", - "type": "TypeString", - "description": "mem, disk, cores, and nodes can be parsed as an int. targetVersion will be a semver range value.", - "computed": true - } - } - }, - { - "name": "pre_install", - "type": "TypeList", - "description": "Optional pre-install instructions.", - "computed": true, - "elem": { - "delete_script": { - "name": "delete_script", - "type": "TypeString", - "description": "Optional script that if run will remove the installed version.", - "computed": true - }, - "instructions": { - "name": "instructions", - "type": "TypeString", - "description": "Instruction on step and by whom (role) that are needed to take place to prepare the target for installing this version.", - "computed": true - }, - "instructions_i18n": { - "name": "instructions_i18n", - "type": "TypeMap", - "description": "A map of translated strings, by language code.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "scope": { - "name": "scope", - "type": "TypeString", - "description": "Optional value indicating if this script is scoped to a namespace or the entire cluster.", - "computed": true - }, - "script": { - "name": "script", - "type": "TypeString", - "description": "Optional script that needs to be run post any pre-condition script.", - "computed": true - }, - "script_permission": { - "name": "script_permission", - "type": "TypeString", - "description": "Optional iam permissions that are required on the target cluster to run this script.", - "computed": true - } - } - }, - { - "name": "whitelisted_accounts", - "type": "TypeList", - "description": "Whitelisted accounts for version.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "rev", - "type": "TypeString", - "description": "Cloudant revision.", - "computed": true - }, - { - "name": "crn", - "type": "TypeString", - "description": "Version's CRN.", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "sha", - "type": "TypeString", - "description": "hash of the content.", - "computed": true - }, - { - "name": "created", - "type": "TypeString", - "description": "The date and time this version was created.", - "computed": true - }, - { - "name": "deprecated", - "type": "TypeBool", - "description": "read only field, indicating if this version is deprecated.", - "computed": true - }, - { - "name": "solution_info", - "type": "TypeList", - "description": "Version Solution Information. Only supported for Product kind Solution.", - "computed": true, - "elem": { - "architecture_diagrams": { - "name": "architecture_diagrams", - "type": "TypeList", - "description": "Architecture diagrams for this solution.", - "computed": true, - "elem": { - "description": { - "name": "description", - "type": "TypeString", - "description": "Description of this diagram.", - "computed": true - }, - "description_i18n": { - "name": "description_i18n", - "type": "TypeMap", - "description": "A map of translated strings, by language code.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "diagram": { - "name": "diagram", - "type": "TypeList", - "description": "Offering Media information.", - "computed": true, - "elem": { - "api_url": { - "name": "api_url", - "type": "TypeString", - "description": "CM API specific URL of the specified media item.", - "computed": true - }, - "caption": { - "name": "caption", - "type": "TypeString", - "description": "Caption for this media item.", - "computed": true - }, - "caption_i18n": { - "name": "caption_i18n", - "type": "TypeMap", - "description": "A map of translated strings, by language code.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "thumbnail_url": { - "name": "thumbnail_url", - "type": "TypeString", - "description": "Thumbnail URL for this media item.", - "computed": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "Type of this media item.", - "computed": true - }, - "url": { - "name": "url", - "type": "TypeString", - "description": "URL of the specified media item.", - "computed": true - }, - "url_proxy": { - "name": "url_proxy", - "type": "TypeList", - "description": "Offering URL proxy information.", - "computed": true, - "elem": { - "sha": { - "name": "sha", - "type": "TypeString", - "description": "SHA256 fingerprint of image.", - "computed": true - }, - "url": { - "name": "url", - "type": "TypeString", - "description": "URL of the specified media item being proxied.", - "computed": true - } - } - } - } - } - } - }, - "cost_estimate": { - "name": "cost_estimate", - "type": "TypeList", - "description": "Cost estimate definition.", - "computed": true, - "elem": { - "currency": { - "name": "currency", - "type": "TypeString", - "description": "Cost estimate currency.", - "computed": true - }, - "diff_total_hourly_cost": { - "name": "diff_total_hourly_cost", - "type": "TypeString", - "description": "Difference in total hourly cost.", - "computed": true - }, - "diff_total_monthly_cost": { - "name": "diff_total_monthly_cost", - "type": "TypeString", - "description": "Difference in total monthly cost.", - "computed": true - }, - "past_total_hourly_cost": { - "name": "past_total_hourly_cost", - "type": "TypeString", - "description": "Past total hourly cost.", - "computed": true - }, - "past_total_monthly_cost": { - "name": "past_total_monthly_cost", - "type": "TypeString", - "description": "Past total monthly cost.", - "computed": true - }, - "projects": { - "name": "projects", - "type": "TypeList", - "description": "Cost estimate projects.", - "computed": true, - "elem": { - "breakdown": { - "name": "breakdown", - "type": "TypeList", - "description": "Cost breakdown definition.", + "description": "Cost breakdown definition.", "computed": true, "elem": { "resources": { @@ -16049,58 +15642,76 @@ } }, { - "name": "repo_url", + "name": "created", "type": "TypeString", - "description": "Content's repo URL.", + "description": "The date and time this version was created.", "computed": true }, { - "name": "validation", + "name": "pre_install", "type": "TypeList", - "description": "Validation response.", + "description": "Optional pre-install instructions.", "computed": true, "elem": { - "last_operation": { - "name": "last_operation", - "type": "TypeString", - "description": "Last operation (e.g. submit_deployment, generate_installer, install_offering.", - "computed": true - }, - "message": { - "name": "message", - "type": "TypeString", - "description": "Any message needing to be conveyed as part of the validation job.", - "computed": true - }, - "requested": { - "name": "requested", + "delete_script": { + "name": "delete_script", "type": "TypeString", - "description": "Date and time of last validation was requested.", + "description": "Optional script that if run will remove the installed version.", "computed": true }, - "state": { - "name": "state", + "instructions": { + "name": "instructions", "type": "TypeString", - "description": "Current validation state - \u003cempty\u003e, in_progress, valid, invalid, expired.", + "description": "Instruction on step and by whom (role) that are needed to take place to prepare the target for installing this version.", "computed": true }, - "target": { - "name": "target", + "instructions_i18n": { + "name": "instructions_i18n", "type": "TypeMap", - "description": "Validation target information (e.g. cluster_id, region, namespace, etc). Values will vary by Content type.", + "description": "A map of translated strings, by language code.", "computed": true, "elem": { "type": "TypeString" } }, - "validated": { - "name": "validated", + "scope": { + "name": "scope", "type": "TypeString", - "description": "Date and time of last successful validation.", + "description": "Optional value indicating if this script is scoped to a namespace or the entire cluster.", + "computed": true + }, + "script": { + "name": "script", + "type": "TypeString", + "description": "Optional script that needs to be run post any pre-condition script.", + "computed": true + }, + "script_permission": { + "name": "script_permission", + "type": "TypeString", + "description": "Optional iam permissions that are required on the target cluster to run this script.", "computed": true } } }, + { + "name": "version_locator", + "type": "TypeString", + "description": "A dotted value of `catalogID`.`versionID`.", + "computed": true + }, + { + "name": "is_consumable", + "type": "TypeBool", + "description": "Is the version able to be shared.", + "computed": true + }, + { + "name": "offering_id", + "type": "TypeString", + "description": "Offering ID.", + "computed": true + }, { "name": "install", "type": "TypeList", @@ -16149,184 +15760,378 @@ } }, { - "name": "long_description_i18n", - "type": "TypeMap", - "description": "A map of translated strings, by language code.", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "long_description", + "type": "TypeString", + "description": "Long description for version.", + "computed": true }, { - "name": "kind_id", + "name": "rev", "type": "TypeString", - "description": "Kind ID.", + "description": "Cloudant revision.", "computed": true }, { - "name": "iam_permissions", + "name": "metadata", "type": "TypeList", - "description": "List of IAM permissions that are required to consume this version.", + "description": "Generic data to be included with content being onboarded. Required for virtual server image for VPC.", "computed": true, "elem": { - "resources": { - "name": "resources", + "end_deploy_time": { + "name": "end_deploy_time", + "type": "TypeString", + "description": "The time validation ended.", + "computed": true + }, + "est_deploy_time": { + "name": "est_deploy_time", + "type": "TypeFloat", + "description": "The estimated time validation takes.", + "computed": true + }, + "example_name": { + "name": "example_name", + "type": "TypeString", + "description": "Working directory of source files.", + "computed": true + }, + "file": { + "name": "file", "type": "TypeList", - "description": "Resources for this permission.", + "description": "Details for the stored image file. Required for virtual server image for VPC.", "computed": true, "elem": { - "description": { - "name": "description", + "size": { + "name": "size", + "type": "TypeInt", + "description": "Size of the stored image file rounded up to the next gigabyte. Required for virtual server image for VPC.", + "computed": true + } + } + }, + "images": { + "name": "images", + "type": "TypeList", + "description": "Image operating system. Required for virtual server image for VPC.", + "computed": true, + "elem": { + "id": { + "name": "id", "type": "TypeString", - "description": "Resource description.", + "description": "Programmatic ID of virtual server image. Required for virtual server image for VPC.", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "Resource name.", + "description": "Programmatic name of virtual server image. Required for virtual server image for VPC.", "computed": true }, - "role_crns": { - "name": "role_crns", + "region": { + "name": "region", + "type": "TypeString", + "description": "Region the virtual server image is available in. Required for virtual server image for VPC.", + "computed": true + } + } + }, + "minimum_provisioned_size": { + "name": "minimum_provisioned_size", + "type": "TypeInt", + "description": "Minimum size (in gigabytes) of a volume onto which this image may be provisioned. Required for virtual server image for VPC.", + "computed": true + }, + "modules": { + "name": "modules", + "type": "TypeList", + "description": "Terraform modules.", + "computed": true, + "elem": { + "name": { + "name": "name", + "type": "TypeString", + "description": "Name of the module.", + "computed": true + }, + "offering_reference": { + "name": "offering_reference", "type": "TypeList", - "description": "Role CRNs for this permission.", + "description": "Terraform modules.", "computed": true, "elem": { - "type": "TypeString" + "catalog_id": { + "name": "catalog_id", + "type": "TypeString", + "description": "Catalog ID of the module reference.", + "computed": true + }, + "flavor": { + "name": "flavor", + "type": "TypeString", + "description": "Flavor of the module.", + "computed": true + }, + "flavors": { + "name": "flavors", + "type": "TypeList", + "description": "Flavors of the module.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "ID of the offering module.", + "computed": true + }, + "kind": { + "name": "kind", + "type": "TypeString", + "description": "Kind of the offeringmodule.", + "computed": true + }, + "metadata": { + "name": "metadata", + "type": "TypeString", + "description": "Metadata of the module.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Name of the offering module.", + "computed": true + }, + "version": { + "name": "version", + "type": "TypeString", + "description": "Version of the offering module.", + "computed": true + } } + }, + "source": { + "name": "source", + "type": "TypeString", + "description": "Source of the module.", + "computed": true } } }, - "role_crns": { - "name": "role_crns", + "operating_system": { + "name": "operating_system", "type": "TypeList", - "description": "Role CRNs for this permission.", + "description": "Operating system included in this image. Required for virtual server image for VPC.", "computed": true, "elem": { - "type": "TypeString" + "architecture": { + "name": "architecture", + "type": "TypeString", + "description": "Operating system architecture. Required for virtual server image for VPC.", + "computed": true + }, + "dedicated_host_only": { + "name": "dedicated_host_only", + "type": "TypeBool", + "description": "Images with this operating system can only be used on dedicated hosts or dedicated host groups. Required for virtual server image for VPC.", + "computed": true + }, + "display_name": { + "name": "display_name", + "type": "TypeString", + "description": "Unique, display-friendly name for the operating system. Required for virtual server image for VPC.", + "computed": true + }, + "family": { + "name": "family", + "type": "TypeString", + "description": "Software family for this operating system. Required for virtual server image for VPC.", + "computed": true + }, + "href": { + "name": "href", + "type": "TypeString", + "description": "URL for this operating system. Required for virtual server image for VPC.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Globally unique name for this operating system Required for virtual server image for VPC.", + "computed": true + }, + "vendor": { + "name": "vendor", + "type": "TypeString", + "description": "Vendor of the operating system. Required for virtual server image for VPC.", + "computed": true + }, + "version": { + "name": "version", + "type": "TypeString", + "description": "Major release version of this operating system. Required for virtual server image for VPC.", + "computed": true + } } }, - "service_name": { - "name": "service_name", + "source_url": { + "name": "source_url", "type": "TypeString", - "description": "Service name.", + "description": "Version source URL.", "computed": true - } - } - }, - { - "name": "package_version", - "type": "TypeString", - "description": "Version of the package used to create this version.", - "computed": true - }, - { - "name": "is_consumable", - "type": "TypeBool", - "description": "Is the version able to be shared.", - "computed": true - }, - { - "name": "version_loc_id", - "type": "TypeString", - "description": "A dotted value of `catalogID`.`versionID`.", - "required": true - }, - { - "name": "version_id", - "type": "TypeString", - "description": "Unique ID.", - "computed": true - }, - { - "name": "updated", - "type": "TypeString", - "description": "The date and time this version was last updated.", - "computed": true - }, - { - "name": "licenses", - "type": "TypeList", - "description": "List of licenses the product was built with.", - "computed": true, - "elem": { - "description": { - "name": "description", + }, + "start_deploy_time": { + "name": "start_deploy_time", "type": "TypeString", - "description": "License description.", + "description": "The time validation started.", "computed": true }, - "id": { - "name": "id", + "terraform_version": { + "name": "terraform_version", "type": "TypeString", - "description": "License ID.", + "description": "Terraform version.", "computed": true }, - "name": { - "name": "name", + "usage": { + "name": "usage", "type": "TypeString", - "description": "license name.", + "description": "Usage text for the version.", "computed": true }, - "type": { - "name": "type", + "usage_template": { + "name": "usage_template", "type": "TypeString", - "description": "type of license e.g., Apache xxx.", + "description": "Usage text for the version.", "computed": true }, - "url": { - "name": "url", + "validated_terraform_version": { + "name": "validated_terraform_version", "type": "TypeString", - "description": "URL for the license text.", + "description": "Version name.", "computed": true - } - } - }, - { - "name": "image_manifest_url", - "type": "TypeString", - "description": "If set, denotes a url to a YAML file with list of container images used by this version.", - "computed": true - }, - { - "name": "long_description", - "type": "TypeString", - "description": "Long description for version.", - "computed": true - }, - { - "name": "version", - "type": "TypeString", - "description": "Version of content type.", - "computed": true - }, - { - "name": "tags", - "type": "TypeList", - "description": "List of tags associated with this catalog.", - "cloud_data_type": "tags", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "outputs", - "type": "TypeList", - "description": "List of output values for this version.", - "computed": true, - "elem": { - "description": { - "name": "description", + }, + "version_name": { + "name": "version_name", "type": "TypeString", - "description": "Output description.", + "description": "Version name.", "computed": true }, - "key": { - "name": "key", + "vsi_vpc": { + "name": "vsi_vpc", + "type": "TypeList", + "description": "VSI VPC version information", + "computed": true, + "elem": { + "file": { + "name": "file", + "type": "TypeList", + "description": "Details for the stored image file. Required for virtual server image for VPC.", + "computed": true, + "elem": { + "size": { + "name": "size", + "type": "TypeInt", + "description": "Size of the stored image file rounded up to the next gigabyte. Required for virtual server image for VPC.", + "computed": true + } + } + }, + "images": { + "name": "images", + "type": "TypeList", + "description": "Image operating system. Required for virtual server image for VPC.", + "computed": true, + "elem": { + "id": { + "name": "id", + "type": "TypeString", + "description": "Programmatic ID of virtual server image. Required for virtual server image for VPC.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Programmatic name of virtual server image. Required for virtual server image for VPC.", + "computed": true + }, + "region": { + "name": "region", + "type": "TypeString", + "description": "Region the virtual server image is available in. Required for virtual server image for VPC.", + "computed": true + } + } + }, + "minimum_provisioned_size": { + "name": "minimum_provisioned_size", + "type": "TypeInt", + "description": "Minimum size (in gigabytes) of a volume onto which this image may be provisioned. Required for virtual server image for VPC.", + "computed": true + }, + "operating_system": { + "name": "operating_system", + "type": "TypeList", + "description": "Operating system included in this image. Required for virtual server image for VPC.", + "computed": true, + "elem": { + "architecture": { + "name": "architecture", + "type": "TypeString", + "description": "Operating system architecture. Required for virtual server image for VPC.", + "computed": true + }, + "dedicated_host_only": { + "name": "dedicated_host_only", + "type": "TypeBool", + "description": "Images with this operating system can only be used on dedicated hosts or dedicated host groups. Required for virtual server image for VPC.", + "computed": true + }, + "display_name": { + "name": "display_name", + "type": "TypeString", + "description": "Unique, display-friendly name for the operating system. Required for virtual server image for VPC.", + "computed": true + }, + "family": { + "name": "family", + "type": "TypeString", + "description": "Software family for this operating system. Required for virtual server image for VPC.", + "computed": true + }, + "href": { + "name": "href", + "type": "TypeString", + "description": "URL for this operating system. Required for virtual server image for VPC.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Globally unique name for this operating system Required for virtual server image for VPC.", + "computed": true + }, + "vendor": { + "name": "vendor", + "type": "TypeString", + "description": "Vendor of the operating system. Required for virtual server image for VPC.", + "computed": true + }, + "version": { + "name": "version", + "type": "TypeString", + "description": "Major release version of this operating system. Required for virtual server image for VPC.", + "computed": true + } + } + } + } + }, + "working_directory": { + "name": "working_directory", "type": "TypeString", - "description": "Output key.", + "description": "Working directory of source files.", "computed": true } } @@ -16337,24 +16142,6 @@ "description": "Denotes if single instance can be deployed to a given cluster.", "computed": true }, - { - "name": "offering_id", - "type": "TypeString", - "description": "Offering ID.", - "computed": true - }, - { - "name": "catalog_id", - "type": "TypeString", - "description": "Catalog ID.", - "computed": true - }, - { - "name": "source_url", - "type": "TypeString", - "description": "Content's source URL (e.g git repo).", - "computed": true - }, { "name": "entitlement", "type": "TypeList", @@ -16397,184 +16184,414 @@ } }, { - "name": "image_pull_key_name", + "name": "image_manifest_url", "type": "TypeString", - "description": "ID of the image pull key to use from Offering.ImagePullKeys.", + "description": "If set, denotes a url to a YAML file with list of container images used by this version.", "computed": true }, { - "name": "deprecate_pending", + "name": "deprecated", + "type": "TypeBool", + "description": "read only field, indicating if this version is deprecated.", + "computed": true + }, + { + "name": "whitelisted_accounts", "type": "TypeList", - "description": "Deprecation information for an Offering.", + "description": "Whitelisted accounts for version.", "computed": true, "elem": { - "deprecate_date": { - "name": "deprecate_date", - "type": "TypeString", - "description": "Date of deprecation.", - "computed": true - }, - "deprecate_state": { - "name": "deprecate_state", - "type": "TypeString", - "description": "Deprecation state.", - "computed": true - }, - "description": { - "name": "description", - "type": "TypeString", - "computed": true - } + "type": "TypeString" } - } - ], - "ibm_code_engine_app": [ - { - "name": "name", - "type": "TypeString", - "description": "The name of your application.", - "required": true - }, - { - "name": "image_secret", - "type": "TypeString", - "description": "Optional name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image. If the image reference points to a registry that requires authentication, the app will be created but cannot reach the ready status, until this property is provided, too.", - "computed": true - }, - { - "name": "resource_type", - "type": "TypeString", - "description": "The type of the app.", - "computed": true - }, - { - "name": "endpoint", - "type": "TypeString", - "description": "Optional URL to invoke app. Depending on visibility this is accessible publicly or in the private network only. Empty in case 'managed_domain_mappings' is set to 'local'.", - "computed": true }, { - "name": "endpoint_internal", + "name": "sha", "type": "TypeString", - "description": "URL to app that is only visible within the project.", - "computed": true - }, - { - "name": "image_port", - "type": "TypeInt", - "description": "Optional port the app listens on. While the app will always be exposed via port `443` for end users, this port is used to connect to the port that is exposed by the container image.", + "description": "hash of the content.", "computed": true }, { - "name": "app_id", + "name": "tgz_url", "type": "TypeString", - "description": "The identifier of the resource.", + "description": "File used to on-board this version.", "computed": true }, { - "name": "managed_domain_mappings", + "name": "version_id", "type": "TypeString", - "description": "Optional value controlling which of the system managed domain mappings will be setup for the application. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports application private visibility.", - "computed": true - }, - { - "name": "scale_concurrency_target", - "type": "TypeInt", - "description": "Optional threshold of concurrent requests per instance at which one or more additional instances are created. Use this value to scale up instances based on concurrent number of requests. This option defaults to the value of the `scale_concurrency` option, if not specified.", - "computed": true - }, - { - "name": "scale_initial_instances", - "type": "TypeInt", - "description": "Optional initial number of instances that are created upon app creation or app update.", + "description": "Unique ID.", "computed": true }, { - "name": "scale_cpu_limit", + "name": "repo_url", "type": "TypeString", - "description": "Optional number of CPU set for the instance of the app. For valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).", - "computed": true - }, - { - "name": "scale_request_timeout", - "type": "TypeInt", - "description": "Optional amount of time in seconds that is allowed for a running app to respond to a request.", + "description": "Content's repo URL.", "computed": true }, { - "name": "image_reference", + "name": "source_url", "type": "TypeString", - "description": "The name of the image that is used for this app. The format is `REGISTRY/NAMESPACE/REPOSITORY:TAG` where `REGISTRY` and `TAG` are optional. If `REGISTRY` is not specified, the default is `docker.io`. If `TAG` is not specified, the default is `latest`. If the image reference points to a registry that requires authentication, make sure to also specify the property `image_secret`.", - "computed": true - }, - { - "name": "run_arguments", - "type": "TypeList", - "description": "Optional arguments for the app that are passed to start the container. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "scale_min_instances", - "type": "TypeInt", - "description": "Optional minimum number of instances for this app. If you set this value to `0`, the app will scale down to zero, if not hit by any request for some time.", + "description": "Content's source URL (e.g git repo).", "computed": true }, { - "name": "run_commands", - "type": "TypeList", - "description": "Optional commands for the app that are passed to start the container. If not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "run_volume_mounts", + "name": "configuration", "type": "TypeList", - "description": "Mounts of config maps or secrets.", + "description": "List of user solicited overrides.", "computed": true, "elem": { - "mount_path": { - "name": "mount_path", + "custom_config": { + "name": "custom_config", + "type": "TypeList", + "description": "Render type.", + "computed": true, + "elem": { + "associations": { + "name": "associations", + "type": "TypeList", + "description": "List of parameters that are associated with this configuration.", + "computed": true, + "elem": { + "parameters": { + "name": "parameters", + "type": "TypeList", + "description": "Parameters for this association.", + "computed": true, + "elem": { + "name": { + "name": "name", + "type": "TypeString", + "description": "Name of this parameter.", + "computed": true + }, + "options_refresh": { + "name": "options_refresh", + "type": "TypeBool", + "description": "Refresh options.", + "computed": true + } + } + } + } + }, + "config_constraints": { + "name": "config_constraints", + "type": "TypeMap", + "description": "Map of constraint parameters that will be passed to the custom widget.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "grouping": { + "name": "grouping", + "type": "TypeString", + "description": "Determines where this configuration type is rendered (3 sections today - Target, Resource, and Deployment).", + "computed": true + }, + "grouping_index": { + "name": "grouping_index", + "type": "TypeInt", + "description": "Determines the order that this configuration item shows in that particular grouping.", + "computed": true + }, + "original_grouping": { + "name": "original_grouping", + "type": "TypeString", + "description": "Original grouping type for this configuration (3 types - Target, Resource, and Deployment).", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "ID of the widget type.", + "computed": true + } + } + }, + "default_value": { + "name": "default_value", "type": "TypeString", - "description": "The path that should be mounted.", + "description": "The default value as a JSON encoded string. To use a secret when the type is password, specify a JSON encoded value of $ref:#/components/schemas/SecretInstance, prefixed with `cmsm_v1:`.", "computed": true }, - "name": { - "name": "name", + "description": { + "name": "description", "type": "TypeString", - "description": "The name of the mount.", + "description": "Key description.", "computed": true }, - "reference": { - "name": "reference", + "display_name": { + "name": "display_name", "type": "TypeString", - "description": "The name of the referenced secret or config map.", + "description": "Display name for configuration type.", + "computed": true + }, + "hidden": { + "name": "hidden", + "type": "TypeBool", + "description": "Hide values.", + "computed": true + }, + "key": { + "name": "key", + "type": "TypeString", + "description": "Configuration key.", + "computed": true + }, + "options": { + "name": "options", + "type": "TypeList", + "description": "List of options of type.", + "computed": true, + "elem": { + "type": "TypeMap" + } + }, + "required": { + "name": "required", + "type": "TypeBool", + "description": "Is key required to install.", "computed": true }, "type": { "name": "type", "type": "TypeString", - "description": "Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.", + "description": "Value type (string, boolean, int).", + "computed": true + }, + "type_metadata": { + "name": "type_metadata", + "type": "TypeString", + "description": "The original type, as found in the source being onboarded.", + "computed": true + }, + "value_constraint": { + "name": "value_constraint", + "type": "TypeString", + "description": "Constraint associated with value, e.g., for string type - regx:[a-z].", "computed": true } } }, { - "name": "scale_memory_limit", + "name": "package_version", "type": "TypeString", - "description": "Optional amount of memory set for the instance of the app. For valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo). The units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", + "description": "Version of the package used to create this version.", "computed": true }, { - "name": "created_at", + "name": "image_pull_key_name", "type": "TypeString", - "description": "The timestamp when the resource was created.", + "description": "ID of the image pull key to use from Offering.ImagePullKeys.", + "computed": true + }, + { + "name": "updated", + "type": "TypeString", + "description": "The date and time this version was last updated.", + "computed": true + }, + { + "name": "validation", + "type": "TypeList", + "description": "Validation response.", + "computed": true, + "elem": { + "last_operation": { + "name": "last_operation", + "type": "TypeString", + "description": "Last operation (e.g. submit_deployment, generate_installer, install_offering.", + "computed": true + }, + "message": { + "name": "message", + "type": "TypeString", + "description": "Any message needing to be conveyed as part of the validation job.", + "computed": true + }, + "requested": { + "name": "requested", + "type": "TypeString", + "description": "Date and time of last validation was requested.", + "computed": true + }, + "state": { + "name": "state", + "type": "TypeString", + "description": "Current validation state - \u003cempty\u003e, in_progress, valid, invalid, expired.", + "computed": true + }, + "target": { + "name": "target", + "type": "TypeMap", + "description": "Validation target information (e.g. cluster_id, region, namespace, etc). Values will vary by Content type.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "validated": { + "name": "validated", + "type": "TypeString", + "description": "Date and time of last successful validation.", + "computed": true + } + } + }, + { + "name": "required_resources", + "type": "TypeList", + "description": "Resource requirments for installation.", + "computed": true, + "elem": { + "type": { + "name": "type", + "type": "TypeString", + "description": "Type of requirement.", + "computed": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "mem, disk, cores, and nodes can be parsed as an int. targetVersion will be a semver range value.", + "computed": true + } + } + }, + { + "name": "state", + "type": "TypeList", + "description": "Offering state.", + "computed": true, + "elem": { + "current": { + "name": "current", + "type": "TypeString", + "description": "one of: new, validated, account-published, ibm-published, public-published.", + "computed": true + }, + "current_entered": { + "name": "current_entered", + "type": "TypeString", + "description": "Date and time of current request.", + "computed": true + }, + "pending": { + "name": "pending", + "type": "TypeString", + "description": "one of: new, validated, account-published, ibm-published, public-published.", + "computed": true + }, + "pending_requested": { + "name": "pending_requested", + "type": "TypeString", + "description": "Date and time of pending request.", + "computed": true + }, + "previous": { + "name": "previous", + "type": "TypeString", + "description": "one of: new, validated, account-published, ibm-published, public-published.", + "computed": true + } + } + }, + { + "name": "deprecate_pending", + "type": "TypeList", + "description": "Deprecation information for an Offering.", + "computed": true, + "elem": { + "deprecate_date": { + "name": "deprecate_date", + "type": "TypeString", + "description": "Date of deprecation.", + "computed": true + }, + "deprecate_state": { + "name": "deprecate_state", + "type": "TypeString", + "description": "Deprecation state.", + "computed": true + }, + "description": { + "name": "description", + "type": "TypeString", + "computed": true + } + } + } + ], + "ibm_code_engine_app": [ + { + "name": "endpoint", + "type": "TypeString", + "description": "Optional URL to invoke app. Depending on visibility this is accessible publicly or in the private network only. Empty in case 'managed_domain_mappings' is set to 'local'.", + "computed": true + }, + { + "name": "entity_tag", + "type": "TypeString", + "description": "The version of the app instance, which is used to achieve optimistic locking.", + "computed": true + }, + { + "name": "scale_concurrency", + "type": "TypeInt", + "description": "Optional maximum number of requests that can be processed concurrently per instance.", + "computed": true + }, + { + "name": "scale_min_instances", + "type": "TypeInt", + "description": "Optional minimum number of instances for this app. If you set this value to `0`, the app will scale down to zero, if not hit by any request for some time.", + "computed": true + }, + { + "name": "endpoint_internal", + "type": "TypeString", + "description": "URL to app that is only visible within the project.", "computed": true }, + { + "name": "run_as_user", + "type": "TypeInt", + "description": "Optional user ID (UID) to run the app (e.g., `1001`).", + "computed": true + }, + { + "name": "scale_max_instances", + "type": "TypeInt", + "description": "Optional maximum number of instances for this app. If you set this value to `0`, this property does not set a upper scaling limit. However, the app scaling is still limited by the project quota for instances. See [Limits and quotas for Code Engine](https://cloud.ibm.com/docs/codeengine?topic=codeengine-limits).", + "computed": true + }, + { + "name": "status_details", + "type": "TypeList", + "description": "The detailed status of the application.", + "computed": true, + "elem": { + "latest_created_revision": { + "name": "latest_created_revision", + "type": "TypeString", + "description": "Latest app revision that has been created.", + "computed": true + }, + "latest_ready_revision": { + "name": "latest_ready_revision", + "type": "TypeString", + "description": "Latest app revision that reached a ready state.", + "computed": true + }, + "reason": { + "name": "reason", + "type": "TypeString", + "description": "Optional information to provide more context in case of a 'failed' or 'warning' status.", + "computed": true + } + } + }, { "name": "run_env_variables", "type": "TypeList", @@ -16626,47 +16643,89 @@ "computed": true }, { - "name": "scale_concurrency", - "type": "TypeInt", - "description": "Optional maximum number of requests that can be processed concurrently per instance.", + "name": "scale_cpu_limit", + "type": "TypeString", + "description": "Optional number of CPU set for the instance of the app. For valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).", "computed": true }, { - "name": "status_details", + "name": "scale_ephemeral_storage_limit", + "type": "TypeString", + "description": "Optional amount of ephemeral storage to set for the instance of the app. The amount specified as ephemeral storage, must not exceed the amount of `scale_memory_limit`. The units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", + "computed": true + }, + { + "name": "scale_memory_limit", + "type": "TypeString", + "description": "Optional amount of memory set for the instance of the app. For valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo). The units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", + "computed": true + }, + { + "name": "app_id", + "type": "TypeString", + "description": "The identifier of the resource.", + "computed": true + }, + { + "name": "image_reference", + "type": "TypeString", + "description": "The name of the image that is used for this app. The format is `REGISTRY/NAMESPACE/REPOSITORY:TAG` where `REGISTRY` and `TAG` are optional. If `REGISTRY` is not specified, the default is `docker.io`. If `TAG` is not specified, the default is `latest`. If the image reference points to a registry that requires authentication, make sure to also specify the property `image_secret`.", + "computed": true + }, + { + "name": "managed_domain_mappings", + "type": "TypeString", + "description": "Optional value controlling which of the system managed domain mappings will be setup for the application. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports application private visibility.", + "computed": true + }, + { + "name": "run_volume_mounts", "type": "TypeList", - "description": "The detailed status of the application.", + "description": "Mounts of config maps or secrets.", "computed": true, "elem": { - "latest_created_revision": { - "name": "latest_created_revision", + "mount_path": { + "name": "mount_path", "type": "TypeString", - "description": "Latest app revision that has been created.", + "description": "The path that should be mounted.", "computed": true }, - "latest_ready_revision": { - "name": "latest_ready_revision", + "name": { + "name": "name", "type": "TypeString", - "description": "Latest app revision that reached a ready state.", + "description": "The name of the mount.", "computed": true }, - "reason": { - "name": "reason", + "reference": { + "name": "reference", "type": "TypeString", - "description": "Optional information to provide more context in case of a 'failed' or 'warning' status.", + "description": "The name of the referenced secret or config map.", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.", "computed": true } } }, { - "name": "project_id", - "type": "TypeString", - "description": "The ID of the project.", - "required": true + "name": "scale_initial_instances", + "type": "TypeInt", + "description": "Optional initial number of instances that are created upon app creation or app update.", + "computed": true }, { - "name": "entity_tag", + "name": "scale_concurrency_target", + "type": "TypeInt", + "description": "Optional threshold of concurrent requests per instance at which one or more additional instances are created. Use this value to scale up instances based on concurrent number of requests. This option defaults to the value of the `scale_concurrency` option, if not specified.", + "computed": true + }, + { + "name": "status", "type": "TypeString", - "description": "The version of the app instance, which is used to achieve optimistic locking.", + "description": "The current status of the app.", "computed": true }, { @@ -16676,31 +16735,85 @@ "computed": true }, { - "name": "run_as_user", - "type": "TypeInt", - "description": "Optional user ID (UID) to run the app (e.g., `1001`).", + "name": "image_secret", + "type": "TypeString", + "description": "Optional name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image. If the image reference points to a registry that requires authentication, the app will be created but cannot reach the ready status, until this property is provided, too.", "computed": true }, { - "name": "scale_ephemeral_storage_limit", + "name": "run_commands", + "type": "TypeList", + "description": "Optional commands for the app that are passed to start the container. If not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "project_id", "type": "TypeString", - "description": "Optional amount of ephemeral storage to set for the instance of the app. The amount specified as ephemeral storage, must not exceed the amount of `scale_memory_limit`. The units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", + "description": "The ID of the project.", + "required": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "The timestamp when the resource was created.", "computed": true }, { - "name": "scale_max_instances", + "name": "image_port", "type": "TypeInt", - "description": "Optional maximum number of instances for this app. If you set this value to `0`, this property does not set a upper scaling limit. However, the app scaling is still limited by the project quota for instances. See [Limits and quotas for Code Engine](https://cloud.ibm.com/docs/codeengine?topic=codeengine-limits).", + "description": "Optional port the app listens on. While the app will always be exposed via port `443` for end users, this port is used to connect to the port that is exposed by the container image.", "computed": true }, { - "name": "status", + "name": "resource_type", "type": "TypeString", - "description": "The current status of the app.", + "description": "The type of the app.", + "computed": true + }, + { + "name": "run_arguments", + "type": "TypeList", + "description": "Optional arguments for the app that are passed to start the container. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "name", + "type": "TypeString", + "description": "The name of your application.", + "required": true + }, + { + "name": "scale_request_timeout", + "type": "TypeInt", + "description": "Optional amount of time in seconds that is allowed for a running app to respond to a request.", "computed": true } ], "ibm_code_engine_binding": [ + { + "name": "binding_id", + "type": "TypeString", + "description": "The ID of the binding.", + "required": true + }, + { + "name": "prefix", + "type": "TypeString", + "description": "The value that is set as prefix in the component that is bound.", + "computed": true + }, + { + "name": "resource_type", + "type": "TypeString", + "description": "The type of the binding.", + "computed": true + }, { "name": "secret_name", "type": "TypeString", @@ -16744,49 +16857,31 @@ "type": "TypeString", "description": "When you provision a new binding, a URL is created identifying the location of the instance.", "computed": true - }, - { - "name": "binding_id", - "type": "TypeString", - "description": "The ID of the binding.", - "required": true - }, - { - "name": "prefix", - "type": "TypeString", - "description": "The value that is set as prefix in the component that is bound.", - "computed": true - }, - { - "name": "resource_type", - "type": "TypeString", - "description": "The type of the binding.", - "computed": true } ], "ibm_code_engine_build": [ { - "name": "name", + "name": "project_id", "type": "TypeString", - "description": "The name of your build.", + "description": "The ID of the project.", "required": true }, { - "name": "project_id", + "name": "name", "type": "TypeString", - "description": "The ID of the project.", + "description": "The name of your build.", "required": true }, { - "name": "entity_tag", + "name": "resource_type", "type": "TypeString", - "description": "The version of the build instance, which is used to achieve optimistic locking.", + "description": "The type of the build.", "computed": true }, { - "name": "href", + "name": "source_type", "type": "TypeString", - "description": "When you provision a new build, a URL is created identifying the location of the instance.", + "description": "Specifies the type of source to determine if your build source is in a repository or based on local source code.* local - For builds from local source code.* git - For builds from git version controlled source code.", "computed": true }, { @@ -16803,12 +16898,6 @@ } } }, - { - "name": "strategy_spec_file", - "type": "TypeString", - "description": "Optional path to the specification file that is used for build strategies for building an image.", - "computed": true - }, { "name": "strategy_type", "type": "TypeString", @@ -16816,21 +16905,21 @@ "computed": true }, { - "name": "output_image", - "type": "TypeString", - "description": "The name of the image.", + "name": "timeout", + "type": "TypeInt", + "description": "The maximum amount of time, in seconds, that can pass before the build must succeed or fail.", "computed": true }, { - "name": "resource_type", + "name": "created_at", "type": "TypeString", - "description": "The type of the build.", + "description": "The timestamp when the resource was created.", "computed": true }, { - "name": "source_context_dir", + "name": "output_secret", "type": "TypeString", - "description": "Option directory in the repository that contains the buildpacks file or the Dockerfile.", + "description": "The secret that is required to access the image registry. Make sure that the secret is granted with push permissions towards the specified container registry namespace.", "computed": true }, { @@ -16846,15 +16935,21 @@ "computed": true }, { - "name": "timeout", - "type": "TypeInt", - "description": "The maximum amount of time, in seconds, that can pass before the build must succeed or fail.", + "name": "strategy_size", + "type": "TypeString", + "description": "Optional size for the build, which determines the amount of resources used. Build sizes are `small`, `medium`, `large`, `xlarge`.", "computed": true }, { - "name": "created_at", + "name": "strategy_spec_file", "type": "TypeString", - "description": "The timestamp when the resource was created.", + "description": "Optional path to the specification file that is used for build strategies for building an image.", + "computed": true + }, + { + "name": "entity_tag", + "type": "TypeString", + "description": "The version of the build instance, which is used to achieve optimistic locking.", "computed": true }, { @@ -16864,9 +16959,9 @@ "computed": true }, { - "name": "output_secret", + "name": "source_context_dir", "type": "TypeString", - "description": "The secret that is required to access the image registry. Make sure that the secret is granted with push permissions towards the specified container registry namespace.", + "description": "Option directory in the repository that contains the buildpacks file or the Dockerfile.", "computed": true }, { @@ -16876,43 +16971,25 @@ "computed": true }, { - "name": "source_type", + "name": "source_url", "type": "TypeString", - "description": "Specifies the type of source to determine if your build source is in a repository or based on local source code.* local - For builds from local source code.* git - For builds from git version controlled source code.", + "description": "The URL of the code repository. This field is required if the `source_type` is `git`. If the `source_type` value is `local`, this field must be omitted. If the repository is publicly available you can provide a 'https' URL like `https://github.com/IBM/CodeEngine`. If the repository requires authentication, you need to provide a 'ssh' URL like `git@github.com:IBM/CodeEngine.git` along with a `source_secret` that points to a secret of format `ssh_auth`.", "computed": true }, { - "name": "source_url", + "name": "href", "type": "TypeString", - "description": "The URL of the code repository. This field is required if the `source_type` is `git`. If the `source_type` value is `local`, this field must be omitted. If the repository is publicly available you can provide a 'https' URL like `https://github.com/IBM/CodeEngine`. If the repository requires authentication, you need to provide a 'ssh' URL like `git@github.com:IBM/CodeEngine.git` along with a `source_secret` that points to a secret of format `ssh_auth`.", + "description": "When you provision a new build, a URL is created identifying the location of the instance.", "computed": true }, { - "name": "strategy_size", + "name": "output_image", "type": "TypeString", - "description": "Optional size for the build, which determines the amount of resources used. Build sizes are `small`, `medium`, `large`, `xlarge`.", + "description": "The name of the image.", "computed": true } ], "ibm_code_engine_config_map": [ - { - "name": "project_id", - "type": "TypeString", - "description": "The ID of the project.", - "required": true - }, - { - "name": "name", - "type": "TypeString", - "description": "The name of your configmap.", - "required": true - }, - { - "name": "created_at", - "type": "TypeString", - "description": "The timestamp when the resource was created.", - "computed": true - }, { "name": "data", "type": "TypeMap", @@ -16945,43 +17022,43 @@ "type": "TypeString", "description": "The type of the config map.", "computed": true - } - ], - "ibm_code_engine_job": [ + }, { - "name": "scale_array_spec", + "name": "project_id", "type": "TypeString", - "description": "Define a custom set of array indices as comma-separated list containing single values and hyphen-separated ranges like `5,12-14,23,27`. Each instance can pick up its array index via environment variable `JOB_INDEX`. The number of unique array indices specified here determines the number of job instances to run.", - "computed": true + "description": "The ID of the project.", + "required": true }, { - "name": "scale_memory_limit", + "name": "name", "type": "TypeString", - "description": "Optional amount of memory set for the instance of the job. For valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo). The units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", - "computed": true + "description": "The name of your configmap.", + "required": true }, { - "name": "scale_retry_limit", - "type": "TypeInt", - "description": "The number of times to rerun an instance of the job before the job is marked as failed. This property can only be specified if `run_mode` is `task`.", + "name": "created_at", + "type": "TypeString", + "description": "The timestamp when the resource was created.", "computed": true - }, + } + ], + "ibm_code_engine_job": [ { - "name": "run_mode", - "type": "TypeString", - "description": "The mode for runs of the job. Valid values are `task` and `daemon`. In `task` mode, the `max_execution_time` and `retry_limit` properties apply. In `daemon` mode, since there is no timeout and failed instances are restarted indefinitely, the `max_execution_time` and `retry_limit` properties are not allowed.", + "name": "scale_max_execution_time", + "type": "TypeInt", + "description": "The maximum execution time in seconds for runs of the job. This property can only be specified if `run_mode` is `task`.", "computed": true }, { - "name": "created_at", + "name": "entity_tag", "type": "TypeString", - "description": "The timestamp when the resource was created.", + "description": "The version of the job instance, which is used to achieve optimistic locking.", "computed": true }, { - "name": "job_id", + "name": "resource_type", "type": "TypeString", - "description": "The identifier of the resource.", + "description": "The type of the job.", "computed": true }, { @@ -16994,139 +17071,169 @@ } }, { - "name": "run_env_variables", + "name": "run_mode", + "type": "TypeString", + "description": "The mode for runs of the job. Valid values are `task` and `daemon`. In `task` mode, the `max_execution_time` and `retry_limit` properties apply. In `daemon` mode, since there is no timeout and failed instances are restarted indefinitely, the `max_execution_time` and `retry_limit` properties are not allowed.", + "computed": true + }, + { + "name": "run_service_account", + "type": "TypeString", + "description": "The name of the service account. For built-in service accounts, you can use the shortened names `manager`, `none`, `reader`, and `writer`. This property must not be set on a job run, which references a job template.", + "computed": true + }, + { + "name": "run_volume_mounts", "type": "TypeList", - "description": "References to config maps, secrets or literal values, which are exposed as environment variables in the job run.", + "description": "Optional mounts of config maps or a secrets.", "computed": true, "elem": { - "key": { - "name": "key", + "mount_path": { + "name": "mount_path", "type": "TypeString", - "description": "The key to reference as environment variable.", + "description": "The path that should be mounted.", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "The name of the environment variable.", - "computed": true - }, - "prefix": { - "name": "prefix", - "type": "TypeString", - "description": "A prefix that can be added to all keys of a full secret or config map reference.", + "description": "The name of the mount.", "computed": true }, "reference": { "name": "reference", "type": "TypeString", - "description": "The name of the secret or config map.", + "description": "The name of the referenced secret or config map.", "computed": true }, "type": { "name": "type", "type": "TypeString", - "description": "Specify the type of the environment variable.", - "computed": true - }, - "value": { - "name": "value", - "type": "TypeString", - "description": "The literal value of the environment variable.", + "description": "Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.", "computed": true } } }, { - "name": "run_volume_mounts", + "name": "name", + "type": "TypeString", + "description": "The name of your job.", + "required": true + }, + { + "name": "image_secret", + "type": "TypeString", + "description": "The name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image. If the image reference points to a registry that requires authentication, the job / job runs will be created but submitted job runs will fail, until this property is provided, too. This property must not be set on a job run, which references a job template.", + "computed": true + }, + { + "name": "run_as_user", + "type": "TypeInt", + "description": "The user ID (UID) to run the job (e.g., 1001).", + "computed": true + }, + { + "name": "run_env_variables", "type": "TypeList", - "description": "Optional mounts of config maps or a secrets.", + "description": "References to config maps, secrets or literal values, which are exposed as environment variables in the job run.", "computed": true, "elem": { - "mount_path": { - "name": "mount_path", + "key": { + "name": "key", "type": "TypeString", - "description": "The path that should be mounted.", + "description": "The key to reference as environment variable.", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "The name of the mount.", + "description": "The name of the environment variable.", + "computed": true + }, + "prefix": { + "name": "prefix", + "type": "TypeString", + "description": "A prefix that can be added to all keys of a full secret or config map reference.", "computed": true }, "reference": { "name": "reference", "type": "TypeString", - "description": "The name of the referenced secret or config map.", + "description": "The name of the secret or config map.", "computed": true }, "type": { "name": "type", "type": "TypeString", - "description": "Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.", + "description": "Specify the type of the environment variable.", + "computed": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "The literal value of the environment variable.", "computed": true } } }, { - "name": "project_id", - "type": "TypeString", - "description": "The ID of the project.", - "required": true + "name": "scale_retry_limit", + "type": "TypeInt", + "description": "The number of times to rerun an instance of the job before the job is marked as failed. This property can only be specified if `run_mode` is `task`.", + "computed": true }, { - "name": "image_reference", + "name": "scale_memory_limit", "type": "TypeString", - "description": "The name of the image that is used for this job. The format is `REGISTRY/NAMESPACE/REPOSITORY:TAG` where `REGISTRY` and `TAG` are optional. If `REGISTRY` is not specified, the default is `docker.io`. If `TAG` is not specified, the default is `latest`. If the image reference points to a registry that requires authentication, make sure to also specify the property `image_secret`.", + "description": "Optional amount of memory set for the instance of the job. For valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo). The units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", "computed": true }, { - "name": "image_secret", + "name": "project_id", "type": "TypeString", - "description": "The name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image. If the image reference points to a registry that requires authentication, the job / job runs will be created but submitted job runs will fail, until this property is provided, too. This property must not be set on a job run, which references a job template.", - "computed": true + "description": "The ID of the project.", + "required": true }, { - "name": "resource_type", + "name": "job_id", "type": "TypeString", - "description": "The type of the job.", + "description": "The identifier of the resource.", "computed": true }, { - "name": "run_service_account", + "name": "image_reference", "type": "TypeString", - "description": "The name of the service account. For built-in service accounts, you can use the shortened names `manager`, `none`, `reader`, and `writer`. This property must not be set on a job run, which references a job template.", + "description": "The name of the image that is used for this job. The format is `REGISTRY/NAMESPACE/REPOSITORY:TAG` where `REGISTRY` and `TAG` are optional. If `REGISTRY` is not specified, the default is `docker.io`. If `TAG` is not specified, the default is `latest`. If the image reference points to a registry that requires authentication, make sure to also specify the property `image_secret`.", "computed": true }, { - "name": "scale_cpu_limit", + "name": "scale_array_spec", "type": "TypeString", - "description": "Optional amount of CPU set for the instance of the job. For valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).", + "description": "Define a custom set of array indices as comma-separated list containing single values and hyphen-separated ranges like `5,12-14,23,27`. Each instance can pick up its array index via environment variable `JOB_INDEX`. The number of unique array indices specified here determines the number of job instances to run.", "computed": true }, { - "name": "scale_max_execution_time", - "type": "TypeInt", - "description": "The maximum execution time in seconds for runs of the job. This property can only be specified if `run_mode` is `task`.", + "name": "scale_cpu_limit", + "type": "TypeString", + "description": "Optional amount of CPU set for the instance of the job. For valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).", "computed": true }, { - "name": "href", + "name": "scale_ephemeral_storage_limit", "type": "TypeString", - "description": "When you provision a new job, a URL is created identifying the location of the instance.", + "description": "Optional amount of ephemeral storage to set for the instance of the job. The amount specified as ephemeral storage, must not exceed the amount of `scale_memory_limit`. The units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", "computed": true }, { - "name": "entity_tag", + "name": "created_at", "type": "TypeString", - "description": "The version of the job instance, which is used to achieve optimistic locking.", + "description": "The timestamp when the resource was created.", "computed": true }, { - "name": "run_as_user", - "type": "TypeInt", - "description": "The user ID (UID) to run the job (e.g., 1001).", + "name": "href", + "type": "TypeString", + "description": "When you provision a new job, a URL is created identifying the location of the instance.", "computed": true }, { @@ -17137,28 +17244,9 @@ "elem": { "type": "TypeString" } - }, - { - "name": "scale_ephemeral_storage_limit", - "type": "TypeString", - "description": "Optional amount of ephemeral storage to set for the instance of the job. The amount specified as ephemeral storage, must not exceed the amount of `scale_memory_limit`. The units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "The name of your job.", - "required": true } ], "ibm_code_engine_project": [ - { - "name": "crn", - "type": "TypeString", - "description": "The CRN of the project.", - "cloud_data_type": "crn", - "computed": true - }, { "name": "href", "type": "TypeString", @@ -17185,17 +17273,11 @@ "computed": true }, { - "name": "status", + "name": "created_at", "type": "TypeString", - "description": "The current state of the project. For example, if the project is created and ready to get used, it will return active.", + "description": "The timestamp when the project was created.", "computed": true }, - { - "name": "project_id", - "type": "TypeString", - "description": "The ID of the project.", - "required": true - }, { "name": "account_id", "type": "TypeString", @@ -17203,9 +17285,10 @@ "computed": true }, { - "name": "created_at", + "name": "crn", "type": "TypeString", - "description": "The timestamp when the project was created.", + "description": "The CRN of the project.", + "cloud_data_type": "crn", "computed": true }, { @@ -17214,27 +17297,21 @@ "description": "The ID of the resource group.", "cloud_data_type": "resource_group", "computed": true - } - ], - "ibm_code_engine_secret": [ - { - "name": "created_at", - "type": "TypeString", - "description": "The timestamp when the resource was created.", - "computed": true }, { - "name": "href", + "name": "status", "type": "TypeString", - "description": "When you provision a new secret, a URL is created identifying the location of the instance.", + "description": "The current state of the project. For example, if the project is created and ready to get used, it will return active.", "computed": true }, { - "name": "resource_type", + "name": "project_id", "type": "TypeString", - "description": "The type of the secret.", - "computed": true - }, + "description": "The ID of the project.", + "required": true + } + ], + "ibm_code_engine_secret": [ { "name": "secret_id", "type": "TypeString", @@ -17336,48 +17413,67 @@ "description": "The version of the secret instance, which is used to achieve optimistic locking.", "computed": true }, + { + "name": "created_at", + "type": "TypeString", + "description": "The timestamp when the resource was created.", + "computed": true + }, { "name": "format", "type": "TypeString", "description": "Specify the format of the secret.", "computed": true + }, + { + "name": "href", + "type": "TypeString", + "description": "When you provision a new secret, a URL is created identifying the location of the instance.", + "computed": true + }, + { + "name": "resource_type", + "type": "TypeString", + "description": "The type of the secret.", + "computed": true } ], "ibm_compute_bare_metal": [ { - "name": "secondary_ip_count", - "type": "TypeInt", - "description": "The number of secondary IPv4 addresses of the bare metal server.", + "name": "private_network_only", + "type": "TypeBool", + "description": "Specifies whether the server only has access to the private network.", "computed": true }, { - "name": "domain", - "type": "TypeString", - "description": "The domain of the bare metal server", - "optional": true, + "name": "unbonded_network", + "type": "TypeBool", + "description": "When the value is `true`, two physical network interfaces are provided without a bonding configuration.", "computed": true }, { - "name": "datacenter", + "name": "os_reference_code", "type": "TypeString", - "description": "Datacenter in which the bare metal is deployed", "computed": true }, { - "name": "private_ipv4_address_id", - "type": "TypeInt", + "name": "ipv6_enabled", + "type": "TypeBool", + "description": "Indicates whether the public IPv6 address enabled or not", "computed": true }, { - "name": "private_subnet", - "type": "TypeInt", - "description": "The private subnet used for the private network interface of the server.", - "computed": true + "name": "most_recent", + "type": "TypeBool", + "description": "If true and multiple entries are found, the most recently created bare metal is used. If false, an error is returned", + "default_value": false, + "optional": true }, { - "name": "redundant_network", - "type": "TypeBool", - "description": "When the value is `true`, two physical network interfaces are provided with a bonding configuration.", + "name": "hostname", + "type": "TypeString", + "description": "The hostname of the bare metal server", + "optional": true, "computed": true }, { @@ -17387,21 +17483,30 @@ "computed": true }, { - "name": "user_metadata", - "type": "TypeString", - "description": "Arbitrary data available to the computing server.", + "name": "redundant_network", + "type": "TypeBool", + "description": "When the value is `true`, two physical network interfaces are provided with a bonding configuration.", "computed": true }, { - "name": "os_reference_code", - "type": "TypeString", + "name": "secondary_ip_addresses", + "type": "TypeList", + "description": "The public secondary IPv4 addresses of the bare metal server.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "hourly_billing", + "type": "TypeBool", + "description": "The billing type of the server.", "computed": true }, { - "name": "global_identifier", - "type": "TypeString", - "description": "The unique global identifier of the bare metal server", - "optional": true, + "name": "memory", + "type": "TypeInt", + "description": "The amount of memory in gigabytes, for the server.", "computed": true }, { @@ -17410,56 +17515,43 @@ "computed": true }, { - "name": "ipv6_address", + "name": "user_metadata", "type": "TypeString", - "description": "The public IPv6 address of the bare metal server", + "description": "Arbitrary data available to the computing server.", "computed": true }, { - "name": "most_recent", - "type": "TypeBool", - "description": "If true and multiple entries are found, the most recently created bare metal is used. If false, an error is returned", - "default_value": false, - "optional": true - }, - { - "name": "block_storage_ids", - "type": "TypeSet", - "description": "Block storage to which this computing server have access.", - "computed": true, - "elem": { - "type": "TypeInt" - } + "name": "notes", + "type": "TypeString", + "description": "Notes associated with the server.", + "computed": true }, { - "name": "hostname", - "type": "TypeString", - "description": "The hostname of the bare metal server", - "optional": true, + "name": "redundant_power_supply", + "type": "TypeBool", + "description": "When the value is `true`, it indicates additional power supply is provided.", "computed": true }, { - "name": "public_ipv4_address", + "name": "ipv6_address", "type": "TypeString", - "description": "The public IPv4 address of the bare metal server.", + "description": "The public IPv6 address of the bare metal server", "computed": true }, { - "name": "private_vlan_id", + "name": "ipv6_address_id", "type": "TypeInt", - "description": "The private VLAN used for the private network interface of the server.", "computed": true }, { - "name": "notes", + "name": "public_ipv4_address", "type": "TypeString", - "description": "Notes associated with the server.", + "description": "The public IPv4 address of the bare metal server.", "computed": true }, { - "name": "memory", + "name": "private_ipv4_address_id", "type": "TypeInt", - "description": "The amount of memory in gigabytes, for the server.", "computed": true }, { @@ -17473,26 +17565,30 @@ } }, { - "name": "private_ipv4_address", - "type": "TypeString", - "description": "The private IPv4 address of the bare metal server.", - "computed": true + "name": "block_storage_ids", + "type": "TypeSet", + "description": "Block storage to which this computing server have access.", + "computed": true, + "elem": { + "type": "TypeInt" + } }, { - "name": "redundant_power_supply", - "type": "TypeBool", - "description": "When the value is `true`, it indicates additional power supply is provided.", + "name": "secondary_ip_count", + "type": "TypeInt", + "description": "The number of secondary IPv4 addresses of the bare metal server.", "computed": true }, { - "name": "ipv6_enabled", - "type": "TypeBool", - "description": "Indicates whether the public IPv6 address enabled or not", + "name": "private_ipv4_address", + "type": "TypeString", + "description": "The private IPv4 address of the bare metal server.", "computed": true }, { - "name": "ipv6_address_id", + "name": "private_vlan_id", "type": "TypeInt", + "description": "The private VLAN used for the private network interface of the server.", "computed": true }, { @@ -17502,52 +17598,51 @@ "computed": true }, { - "name": "secondary_ip_addresses", - "type": "TypeList", - "description": "The public secondary IPv4 addresses of the bare metal server.", + "name": "public_subnet", + "type": "TypeInt", + "description": "The public subnet used for the public network interface of the server.", + "computed": true + }, + { + "name": "file_storage_ids", + "type": "TypeSet", + "description": "File storage to which this computing server have access.", "computed": true, "elem": { - "type": "TypeString" + "type": "TypeInt" } }, { - "name": "network_speed", - "type": "TypeInt", - "description": "The connection speed, expressed in Mbps, for the server network components.", + "name": "domain", + "type": "TypeString", + "description": "The domain of the bare metal server", + "optional": true, "computed": true }, { - "name": "public_subnet", - "type": "TypeInt", - "description": "The public subnet used for the public network interface of the server.", + "name": "datacenter", + "type": "TypeString", + "description": "Datacenter in which the bare metal is deployed", "computed": true }, { - "name": "hourly_billing", - "type": "TypeBool", - "description": "The billing type of the server.", + "name": "private_subnet", + "type": "TypeInt", + "description": "The private subnet used for the private network interface of the server.", "computed": true }, { - "name": "private_network_only", - "type": "TypeBool", - "description": "Specifies whether the server only has access to the private network.", + "name": "global_identifier", + "type": "TypeString", + "description": "The unique global identifier of the bare metal server", + "optional": true, "computed": true }, { - "name": "unbonded_network", - "type": "TypeBool", - "description": "When the value is `true`, two physical network interfaces are provided without a bonding configuration.", + "name": "network_speed", + "type": "TypeInt", + "description": "The connection speed, expressed in Mbps, for the server network components.", "computed": true - }, - { - "name": "file_storage_ids", - "type": "TypeSet", - "description": "File storage to which this computing server have access.", - "computed": true, - "elem": { - "type": "TypeInt" - } } ], "ibm_compute_image_template": [ @@ -17565,6 +17660,11 @@ } ], "ibm_compute_placement_group": [ + { + "name": "name", + "type": "TypeString", + "required": true + }, { "name": "datacenter", "type": "TypeString", @@ -17601,14 +17701,28 @@ "computed": true } } - }, + } + ], + "ibm_compute_reserved_capacity": [ { "name": "name", "type": "TypeString", + "description": "Name of reserved instance", "required": true - } - ], - "ibm_compute_reserved_capacity": [ + }, + { + "name": "most_recent", + "type": "TypeBool", + "description": "If true and multiple entries are found, the most recently created reserved capacity is used. If false, an error is returned", + "default_value": false, + "optional": true + }, + { + "name": "datacenter", + "type": "TypeString", + "description": "Dataceneter name", + "computed": true + }, { "name": "pod", "type": "TypeString", @@ -17648,28 +17762,21 @@ "computed": true } } - }, + } + ], + "ibm_compute_ssh_key": [ { - "name": "name", + "name": "label", "type": "TypeString", - "description": "Name of reserved instance", + "description": "The label associated with the ssh key", "required": true }, { - "name": "most_recent", - "type": "TypeBool", - "description": "If true and multiple entries are found, the most recently created reserved capacity is used. If false, an error is returned", - "default_value": false, - "optional": true - }, - { - "name": "datacenter", + "name": "public_key", "type": "TypeString", - "description": "Dataceneter name", + "description": "The public ssh key", "computed": true - } - ], - "ibm_compute_ssh_key": [ + }, { "name": "fingerprint", "type": "TypeString", @@ -17688,97 +17795,101 @@ "description": "If true and multiple entries are found, the most recently created key is used. If false, an error is returned", "default_value": false, "optional": true - }, + } + ], + "ibm_compute_vm_instance": [ { - "name": "label", + "name": "datacenter", "type": "TypeString", - "description": "The label associated with the ssh key", - "required": true + "description": "Datacenter in which the virtual guest is deployed", + "computed": true }, { - "name": "public_key", + "name": "private_subnet_id", + "type": "TypeInt", + "computed": true + }, + { + "name": "public_ipv6_subnet", "type": "TypeString", - "description": "The public ssh key", "computed": true - } - ], - "ibm_compute_vm_instance": [ + }, { "name": "public_ipv6_subnet_id", "type": "TypeString", "computed": true }, { - "name": "secondary_ip_addresses", - "type": "TypeList", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "hostname", + "type": "TypeString", + "description": "The hostname of the virtual guest", + "required": true }, { - "name": "last_known_power_state", + "name": "status", "type": "TypeString", - "description": "The last known power state of a virtual guest in the event the guest is turned off outside of IMS or has gone offline.", + "description": "The VSI status", "computed": true }, { - "name": "private_interface_id", + "name": "public_interface_id", "type": "TypeInt", "computed": true }, { - "name": "ipv6_address", - "type": "TypeString", + "name": "public_subnet_id", + "type": "TypeInt", "computed": true }, { - "name": "ipv6_address_id", + "name": "ip_address_id", "type": "TypeInt", "computed": true }, { - "name": "public_ipv6_subnet", - "type": "TypeString", + "name": "secondary_ip_count", + "type": "TypeInt", "computed": true }, { - "name": "ipv4_address_private", + "name": "last_known_power_state", "type": "TypeString", + "description": "The last known power state of a virtual guest in the event the guest is turned off outside of IMS or has gone offline.", "computed": true }, { - "name": "hostname", + "name": "ipv4_address", "type": "TypeString", - "description": "The hostname of the virtual guest", - "required": true + "computed": true }, { - "name": "domain", + "name": "ipv4_address_private", "type": "TypeString", - "description": "The domain of the virtual guest", - "required": true + "computed": true }, { - "name": "public_interface_id", + "name": "ipv6_address_id", "type": "TypeInt", "computed": true }, { - "name": "public_subnet_id", - "type": "TypeInt", - "computed": true + "name": "secondary_ip_addresses", + "type": "TypeList", + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "private_subnet_id", - "type": "TypeInt", + "name": "ipv6_address", + "type": "TypeString", "computed": true }, { - "name": "datacenter", + "name": "domain", "type": "TypeString", - "description": "Datacenter in which the virtual guest is deployed", - "computed": true + "description": "The domain of the virtual guest", + "required": true }, { "name": "cores", @@ -17787,20 +17898,14 @@ "computed": true }, { - "name": "power_state", - "type": "TypeString", - "description": "The current power state of a virtual guest.", - "computed": true - }, - { - "name": "secondary_ip_count", + "name": "private_interface_id", "type": "TypeInt", "computed": true }, { - "name": "status", + "name": "power_state", "type": "TypeString", - "description": "The VSI status", + "description": "The current power state of a virtual guest.", "computed": true }, { @@ -17810,16 +17915,6 @@ "default_value": false, "optional": true }, - { - "name": "ipv4_address", - "type": "TypeString", - "computed": true - }, - { - "name": "ip_address_id", - "type": "TypeInt", - "computed": true - }, { "name": "ip_address_id_private", "type": "TypeInt", @@ -17923,6 +18018,24 @@ } ], "ibm_container_alb": [ + { + "name": "name", + "type": "TypeString", + "description": "ALB name", + "computed": true + }, + { + "name": "zone", + "type": "TypeString", + "description": "ALB zone", + "computed": true + }, + { + "name": "alb_id", + "type": "TypeString", + "description": "ALB ID", + "required": true + }, { "name": "alb_type", "type": "TypeString", @@ -17952,27 +18065,34 @@ "type": "TypeBool", "description": "Set to true if ALB needs to be disabled", "computed": true - }, + } + ], + "ibm_container_alb_cert": [ { - "name": "name", + "name": "namespace", "type": "TypeString", - "description": "ALB name", + "description": "Namespace of the secret", + "default_value": "ibm-cert-store", + "optional": true + }, + { + "name": "persistence", + "type": "TypeBool", + "description": "Persistence of secret", "computed": true }, { - "name": "zone", + "name": "cloud_cert_instance_id", "type": "TypeString", - "description": "ALB zone", + "description": "cloud cert instance ID", "computed": true }, { - "name": "alb_id", + "name": "secret_name", "type": "TypeString", - "description": "ALB ID", + "description": "Secret name", "required": true - } - ], - "ibm_container_alb_cert": [ + }, { "name": "cluster_id", "type": "TypeString", @@ -17984,16 +18104,15 @@ ] }, { - "name": "namespace", + "name": "status", "type": "TypeString", - "description": "Namespace of the secret", - "default_value": "ibm-cert-store", - "optional": true + "description": "Secret Status", + "computed": true }, { - "name": "status", + "name": "domain_name", "type": "TypeString", - "description": "Secret Status", + "description": "Domain name", "computed": true }, { @@ -18016,44 +18135,14 @@ "computed": true, "deprecated": "This field is depricated and is not available in v2 version of ingress api" }, - { - "name": "cloud_cert_instance_id", - "type": "TypeString", - "description": "cloud cert instance ID", - "computed": true - }, { "name": "cert_crn", "type": "TypeString", "description": "Certificate CRN id", "computed": true - }, - { - "name": "secret_name", - "type": "TypeString", - "description": "Secret name", - "required": true - }, - { - "name": "persistence", - "type": "TypeBool", - "description": "Persistence of secret", - "computed": true - }, - { - "name": "domain_name", - "type": "TypeString", - "description": "Domain name", - "computed": true } ], "ibm_container_bind_service": [ - { - "name": "service_key_name", - "type": "TypeString", - "description": "Key info", - "computed": true - }, { "name": "cluster_name_id", "type": "TypeString", @@ -18083,72 +18172,56 @@ "type": "TypeString", "description": "namespace ID", "required": true + }, + { + "name": "service_key_name", + "type": "TypeString", + "description": "Key info", + "computed": true } ], "ibm_container_cluster": [ { - "name": "worker_pools", + "name": "vlans", "type": "TypeList", "computed": true, "elem": { - "hardware": { - "name": "hardware", - "type": "TypeString", - "computed": true - }, "id": { "name": "id", "type": "TypeString", "computed": true }, - "labels": { - "name": "labels", - "type": "TypeMap", - "computed": true - }, - "machine_type": { - "name": "machine_type", - "type": "TypeString", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "computed": true - }, - "size_per_zone": { - "name": "size_per_zone", - "type": "TypeInt", - "computed": true - }, - "state": { - "name": "state", - "type": "TypeString", - "computed": true - }, - "zones": { - "name": "zones", + "subnets": { + "name": "subnets", "type": "TypeList", "computed": true, "elem": { - "private_vlan": { - "name": "private_vlan", + "cidr": { + "name": "cidr", "type": "TypeString", "computed": true }, - "public_vlan": { - "name": "public_vlan", + "id": { + "name": "id", "type": "TypeString", "computed": true }, - "worker_count": { - "name": "worker_count", - "type": "TypeInt", + "ips": { + "name": "ips", + "type": "TypeList", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "is_byoip": { + "name": "is_byoip", + "type": "TypeBool", "computed": true }, - "zone": { - "name": "zone", - "type": "TypeString", + "is_public": { + "name": "is_public", + "type": "TypeBool", "computed": true } } @@ -18156,22 +18229,10 @@ } }, { - "name": "account_guid", - "type": "TypeString", - "description": "The bluemix account guid this cluster belongs to", - "optional": true, - "deprecated": "This field is deprecated" - }, - { - "name": "resource_status", + "name": "alb_type", "type": "TypeString", - "description": "The status of the resource", - "computed": true - }, - { - "name": "is_trusted", - "type": "TypeBool", - "computed": true + "default_value": "all", + "optional": true }, { "name": "albs", @@ -18226,31 +18287,49 @@ } }, { - "name": "space_guid", + "name": "list_bounded_services", + "type": "TypeBool", + "description": "If set to false bounded services won't be listed.", + "default_value": true, + "optional": true + }, + { + "name": "resource_controller_url", "type": "TypeString", - "description": "The bluemix space guid this cluster belongs to", - "optional": true, - "deprecated": "This field is deprecated" + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster", + "computed": true }, { - "name": "crn", + "name": "name", "type": "TypeString", - "description": "CRN of resource instance", - "cloud_data_type": "crn", + "description": "Name or id of the cluster", + "cloud_data_type": "cluster", + "optional": true, + "cloud_data_range": [ + "resolved_to:id" + ] + }, + { + "name": "private_service_endpoint", + "type": "TypeBool", "computed": true }, { - "name": "api_key_id", + "name": "public_service_endpoint_url", "type": "TypeString", - "description": "ID of APIkey", "computed": true }, { - "name": "cluster_name_id", + "name": "api_key_owner_name", "type": "TypeString", - "description": "Name or id of the cluster", - "optional": true, - "deprecated": "use name instead" + "description": "Name of the key owner", + "computed": true + }, + { + "name": "image_security_enforcement", + "type": "TypeBool", + "description": "True if image security enforcement is enabled", + "computed": true }, { "name": "bounded_services", @@ -18280,65 +18359,62 @@ } }, { - "name": "public_service_endpoint_url", + "name": "ingress_hostname", "type": "TypeString", "computed": true }, { - "name": "resource_group_id", + "name": "api_key_id", "type": "TypeString", - "description": "ID of the resource group.", - "cloud_data_type": "resource_group", - "optional": true, - "computed": true - }, - { - "name": "public_service_endpoint", - "type": "TypeBool", + "description": "ID of APIkey", "computed": true }, { - "name": "api_key_owner_email", + "name": "resource_status", "type": "TypeString", - "description": "email id of the key owner", + "description": "The status of the resource", "computed": true }, { - "name": "resource_group_name", + "name": "ingress_secret", "type": "TypeString", - "description": "The resource group name in which resource is provisioned", + "secure": true, "computed": true }, { - "name": "worker_count", - "type": "TypeInt", - "description": "Number of workers", - "computed": true + "name": "account_guid", + "type": "TypeString", + "description": "The bluemix account guid this cluster belongs to", + "optional": true, + "deprecated": "This field is deprecated" }, { - "name": "alb_type", + "name": "region", "type": "TypeString", - "default_value": "all", - "optional": true + "description": "The cluster region", + "cloud_data_type": "region", + "optional": true, + "computed": true, + "deprecated": "This field is deprecated" }, { - "name": "ingress_secret", + "name": "resource_group_id", "type": "TypeString", - "secure": true, + "description": "ID of the resource group.", + "cloud_data_type": "resource_group", + "optional": true, "computed": true }, { - "name": "workers", - "type": "TypeList", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "crn", + "type": "TypeString", + "description": "CRN of resource instance", + "cloud_data_type": "crn", + "computed": true }, { - "name": "api_key_owner_name", + "name": "server_url", "type": "TypeString", - "description": "Name of the key owner", "computed": true }, { @@ -18348,89 +18424,111 @@ "computed": true }, { - "name": "org_guid", + "name": "resource_group_name", "type": "TypeString", - "description": "The bluemix organization guid this cluster belongs to", - "optional": true, - "deprecated": "This field is deprecated" + "description": "The resource group name in which resource is provisioned", + "computed": true }, { - "name": "region", - "type": "TypeString", - "description": "The cluster region", - "cloud_data_type": "region", - "optional": true, + "name": "workers", + "type": "TypeList", "computed": true, - "deprecated": "This field is deprecated" + "elem": { + "type": "TypeString" + } }, { - "name": "private_service_endpoint", + "name": "is_trusted", "type": "TypeBool", "computed": true }, { - "name": "server_url", - "type": "TypeString", + "name": "public_service_endpoint", + "type": "TypeBool", "computed": true }, { - "name": "list_bounded_services", - "type": "TypeBool", - "description": "If set to false bounded services won't be listed.", - "default_value": true, - "optional": true + "name": "resource_crn", + "type": "TypeString", + "description": "The crn of the resource", + "computed": true }, { - "name": "name", + "name": "cluster_name_id", "type": "TypeString", "description": "Name or id of the cluster", - "cloud_data_type": "cluster", "optional": true, - "cloud_data_range": [ - "resolved_to:id" - ] + "deprecated": "use name instead" }, { - "name": "vlans", + "name": "worker_count", + "type": "TypeInt", + "description": "Number of workers", + "computed": true + }, + { + "name": "worker_pools", "type": "TypeList", "computed": true, "elem": { + "hardware": { + "name": "hardware", + "type": "TypeString", + "computed": true + }, "id": { "name": "id", "type": "TypeString", "computed": true }, - "subnets": { - "name": "subnets", + "labels": { + "name": "labels", + "type": "TypeMap", + "computed": true + }, + "machine_type": { + "name": "machine_type", + "type": "TypeString", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "computed": true + }, + "size_per_zone": { + "name": "size_per_zone", + "type": "TypeInt", + "computed": true + }, + "state": { + "name": "state", + "type": "TypeString", + "computed": true + }, + "zones": { + "name": "zones", "type": "TypeList", "computed": true, "elem": { - "cidr": { - "name": "cidr", + "private_vlan": { + "name": "private_vlan", "type": "TypeString", "computed": true }, - "id": { - "name": "id", + "public_vlan": { + "name": "public_vlan", "type": "TypeString", "computed": true }, - "ips": { - "name": "ips", - "type": "TypeList", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "is_byoip": { - "name": "is_byoip", - "type": "TypeBool", + "worker_count": { + "name": "worker_count", + "type": "TypeInt", "computed": true }, - "is_public": { - "name": "is_public", - "type": "TypeBool", + "zone": { + "name": "zone", + "type": "TypeString", "computed": true } } @@ -18438,21 +18536,18 @@ } }, { - "name": "ingress_hostname", - "type": "TypeString", - "computed": true - }, - { - "name": "resource_controller_url", + "name": "org_guid", "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster", - "computed": true + "description": "The bluemix organization guid this cluster belongs to", + "optional": true, + "deprecated": "This field is deprecated" }, { - "name": "resource_crn", + "name": "space_guid", "type": "TypeString", - "description": "The crn of the resource", - "computed": true + "description": "The bluemix space guid this cluster belongs to", + "optional": true, + "deprecated": "This field is deprecated" }, { "name": "private_service_endpoint_url", @@ -18460,19 +18555,24 @@ "computed": true }, { - "name": "image_security_enforcement", - "type": "TypeBool", - "description": "True if image security enforcement is enabled", + "name": "api_key_owner_email", + "type": "TypeString", + "description": "email id of the key owner", "computed": true } ], "ibm_container_cluster_config": [ { - "name": "admin", - "type": "TypeBool", - "description": "If set to true will download the config for admin", - "default_value": false, - "optional": true + "name": "config_file_path", + "type": "TypeString", + "description": "The absolute path to the kubernetes config yml file", + "computed": true + }, + { + "name": "admin_certificate", + "type": "TypeString", + "secure": true, + "computed": true }, { "name": "space_guid", @@ -18489,65 +18589,42 @@ "deprecated": "This field is deprecated" }, { - "name": "cluster_name_id", - "type": "TypeString", - "description": "The name/id of the cluster", - "cloud_data_type": "cluster", - "required": true, - "cloud_data_range": [ - "resolved_to:id" - ] - }, - { - "name": "download", + "name": "network", "type": "TypeBool", - "description": "If set to false will not download the config, otherwise they are downloaded each time but onto the same path for a given cluster name/id", - "default_value": true, + "description": "If set to true will download the Calico network config with the Admin config", + "default_value": false, "optional": true }, { - "name": "config_file_path", - "type": "TypeString", - "description": "The absolute path to the kubernetes config yml file", - "computed": true - }, - { - "name": "ca_certificate", - "type": "TypeString", - "secure": true, - "computed": true - }, - { - "name": "admin_certificate", + "name": "region", "type": "TypeString", - "secure": true, - "computed": true + "description": "The cluster region", + "cloud_data_type": "region", + "optional": true, + "deprecated": "This field is deprecated" }, { - "name": "resource_group_id", - "type": "TypeString", - "description": "ID of the resource group.", - "cloud_data_type": "resource_group", + "name": "admin", + "type": "TypeBool", + "description": "If set to true will download the config for admin", + "default_value": false, "optional": true }, { - "name": "config_dir", + "name": "host", "type": "TypeString", - "description": "The directory where the cluster config to be downloaded. Default is home directory", - "optional": true, "computed": true }, { - "name": "network", - "type": "TypeBool", - "description": "If set to true will download the Calico network config with the Admin config", - "default_value": false, + "name": "endpoint_type", + "type": "TypeString", + "description": "It can specify what kind of server URL will be used for the cluster context", "optional": true }, { - "name": "admin_key", + "name": "calico_config_file_path", "type": "TypeString", - "secure": true, + "description": "The absolute path to the calico network config file", "computed": true }, { @@ -18564,40 +18641,50 @@ "deprecated": "This field is deprecated" }, { - "name": "region", + "name": "cluster_name_id", "type": "TypeString", - "description": "The cluster region", - "cloud_data_type": "region", - "optional": true, - "deprecated": "This field is deprecated" + "description": "The name/id of the cluster", + "cloud_data_type": "cluster", + "required": true, + "cloud_data_range": [ + "resolved_to:id" + ] }, { - "name": "calico_config_file_path", - "type": "TypeString", - "description": "The absolute path to the calico network config file", - "computed": true + "name": "download", + "type": "TypeBool", + "description": "If set to false will not download the config, otherwise they are downloaded each time but onto the same path for a given cluster name/id", + "default_value": true, + "optional": true }, { - "name": "host", + "name": "ca_certificate", "type": "TypeString", + "secure": true, "computed": true - } - ], - "ibm_container_cluster_versions": [ + }, { - "name": "org_guid", + "name": "resource_group_id", "type": "TypeString", - "description": "The bluemix organization guid this cluster belongs to", - "optional": true, - "deprecated": "This field is deprecated" + "description": "ID of the resource group.", + "cloud_data_type": "resource_group", + "optional": true }, { - "name": "space_guid", + "name": "config_dir", "type": "TypeString", - "description": "The bluemix space guid this cluster belongs to", + "description": "The directory where the cluster config to be downloaded. Default is home directory", "optional": true, - "deprecated": "This field is deprecated" + "computed": true }, + { + "name": "admin_key", + "type": "TypeString", + "secure": true, + "computed": true + } + ], + "ibm_container_cluster_versions": [ { "name": "account_guid", "type": "TypeString", @@ -18613,13 +18700,6 @@ "optional": true, "deprecated": "This field is deprecated" }, - { - "name": "resource_group_id", - "type": "TypeString", - "description": "ID of the resource group.", - "cloud_data_type": "resource_group", - "optional": true - }, { "name": "valid_kube_versions", "type": "TypeList", @@ -18637,27 +18717,17 @@ "elem": { "type": "TypeString" } - } - ], - "ibm_container_cluster_worker": [ - { - "name": "private_vlan", - "type": "TypeString", - "computed": true - }, - { - "name": "public_vlan", - "type": "TypeString", - "computed": true }, { - "name": "private_ip", + "name": "default_openshift_version", "type": "TypeString", + "description": "Default openshift-version", "computed": true }, { - "name": "public_ip", + "name": "default_kube_version", "type": "TypeString", + "description": "Default kube-version", "computed": true }, { @@ -18675,24 +18745,32 @@ "deprecated": "This field is deprecated" }, { - "name": "account_guid", + "name": "resource_group_id", "type": "TypeString", - "description": "The bluemix account guid this cluster belongs to", - "optional": true, - "deprecated": "This field is deprecated" - }, + "description": "ID of the resource group.", + "cloud_data_type": "resource_group", + "optional": true + } + ], + "ibm_container_cluster_worker": [ { - "name": "status", + "name": "public_vlan", "type": "TypeString", - "description": "Status of the worker", "computed": true }, { - "name": "resource_controller_url", + "name": "private_ip", "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster", "computed": true }, + { + "name": "region", + "type": "TypeString", + "description": "The cluster region", + "cloud_data_type": "region", + "optional": true, + "deprecated": "This field is deprecated" + }, { "name": "resource_group_id", "type": "TypeString", @@ -18700,6 +18778,12 @@ "cloud_data_type": "resource_group", "optional": true }, + { + "name": "worker_id", + "type": "TypeString", + "description": "ID of the worker", + "required": true + }, { "name": "state", "type": "TypeString", @@ -18707,21 +18791,56 @@ "computed": true }, { - "name": "region", + "name": "status", "type": "TypeString", - "description": "The cluster region", - "cloud_data_type": "region", + "description": "Status of the worker", + "computed": true + }, + { + "name": "private_vlan", + "type": "TypeString", + "computed": true + }, + { + "name": "resource_controller_url", + "type": "TypeString", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster", + "computed": true + }, + { + "name": "public_ip", + "type": "TypeString", + "computed": true + }, + { + "name": "org_guid", + "type": "TypeString", + "description": "The bluemix organization guid this cluster belongs to", "optional": true, "deprecated": "This field is deprecated" }, { - "name": "worker_id", + "name": "space_guid", "type": "TypeString", - "description": "ID of the worker", - "required": true + "description": "The bluemix space guid this cluster belongs to", + "optional": true, + "deprecated": "This field is deprecated" + }, + { + "name": "account_guid", + "type": "TypeString", + "description": "The bluemix account guid this cluster belongs to", + "optional": true, + "deprecated": "This field is deprecated" } ], "ibm_container_dedicated_host": [ + { + "name": "host_id", + "type": "TypeString", + "description": "The id of the dedicated host", + "required": true + }, { "name": "host_pool_id", "type": "TypeString", @@ -18852,15 +18971,39 @@ "type": "TypeString", "description": "The zone of the dedicated host", "computed": true - }, - { - "name": "host_id", - "type": "TypeString", - "description": "The id of the dedicated host", - "required": true } ], "ibm_container_dedicated_host_flavor": [ + { + "name": "max_vcpus", + "type": "TypeInt", + "description": "The maximum available vcpus in the dedicated host flavor", + "computed": true + }, + { + "name": "max_memory", + "type": "TypeInt", + "description": "The maximum available memory in the dedicated host flavor", + "computed": true + }, + { + "name": "instance_storage", + "type": "TypeList", + "description": "The instance storage of the dedicated host flavor", + "computed": true, + "elem": { + "count": { + "name": "count", + "type": "TypeInt", + "computed": true + }, + "size": { + "name": "size", + "type": "TypeInt", + "computed": true + } + } + }, { "name": "zone", "type": "TypeString", @@ -18891,36 +19034,6 @@ "type": "TypeBool", "description": "Describes if the dedicated host flavor is deprecated", "computed": true - }, - { - "name": "max_vcpus", - "type": "TypeInt", - "description": "The maximum available vcpus in the dedicated host flavor", - "computed": true - }, - { - "name": "max_memory", - "type": "TypeInt", - "description": "The maximum available memory in the dedicated host flavor", - "computed": true - }, - { - "name": "instance_storage", - "type": "TypeList", - "description": "The instance storage of the dedicated host flavor", - "computed": true, - "elem": { - "count": { - "name": "count", - "type": "TypeInt", - "computed": true - }, - "size": { - "name": "size", - "type": "TypeInt", - "computed": true - } - } } ], "ibm_container_dedicated_host_flavors": [ @@ -18993,18 +19106,6 @@ } ], "ibm_container_dedicated_host_pool": [ - { - "name": "flavor_class", - "type": "TypeString", - "description": "The flavor class of the dedicated host pool", - "computed": true - }, - { - "name": "host_count", - "type": "TypeInt", - "description": "The count of the hosts under the dedicated host pool", - "computed": true - }, { "name": "state", "type": "TypeString", @@ -19081,6 +19182,18 @@ "type": "TypeString", "description": "The metro to create the dedicated host pool in", "computed": true + }, + { + "name": "flavor_class", + "type": "TypeString", + "description": "The flavor class of the dedicated host pool", + "computed": true + }, + { + "name": "host_count", + "type": "TypeInt", + "description": "The count of the hosts under the dedicated host pool", + "computed": true } ], "ibm_container_ingress_instance": [ @@ -19094,6 +19207,12 @@ "resolved_to:id" ] }, + { + "name": "secret_group_id", + "type": "TypeString", + "description": "Secret group for the instance registration", + "computed": true + }, { "name": "status", "type": "TypeString", @@ -19118,12 +19237,6 @@ "description": "Instance registration name", "required": true }, - { - "name": "secret_group_id", - "type": "TypeString", - "description": "Secret group for the instance registration", - "computed": true - }, { "name": "is_default", "type": "TypeBool", @@ -19144,6 +19257,18 @@ } ], "ibm_container_ingress_secret_opaque": [ + { + "name": "secret_namespace", + "type": "TypeString", + "description": "Secret namespace", + "required": true + }, + { + "name": "type", + "type": "TypeString", + "description": "Opaque secret type", + "computed": true + }, { "name": "persistence", "type": "TypeBool", @@ -19209,42 +19334,36 @@ "type": "TypeString", "description": "Secret name", "required": true - }, + } + ], + "ibm_container_ingress_secret_tls": [ { - "name": "secret_namespace", + "name": "cluster", "type": "TypeString", - "description": "Secret namespace", - "required": true + "description": "Cluster ID or name", + "cloud_data_type": "cluster", + "required": true, + "cloud_data_range": [ + "resolved_to:id" + ] }, { "name": "type", "type": "TypeString", - "description": "Opaque secret type", - "computed": true - } - ], - "ibm_container_ingress_secret_tls": [ - { - "name": "domain_name", - "type": "TypeString", - "description": "Domain name", + "description": "Type TLS", "computed": true }, { - "name": "expires_on", + "name": "status", "type": "TypeString", - "description": "Certificate expires on date", + "description": "Secret Status", "computed": true }, { - "name": "cluster", + "name": "last_updated_timestamp", "type": "TypeString", - "description": "Cluster ID or name", - "cloud_data_type": "cluster", - "required": true, - "cloud_data_range": [ - "resolved_to:id" - ] + "description": "Timestamp secret was last updated", + "computed": true }, { "name": "secret_name", @@ -19253,15 +19372,15 @@ "required": true }, { - "name": "type", + "name": "secret_namespace", "type": "TypeString", - "description": "Type TLS", - "computed": true + "description": "Secret namespace", + "required": true }, { - "name": "status", + "name": "cert_crn", "type": "TypeString", - "description": "Secret Status", + "description": "Certificate CRN", "computed": true }, { @@ -19277,21 +19396,15 @@ "computed": true }, { - "name": "last_updated_timestamp", + "name": "domain_name", "type": "TypeString", - "description": "Timestamp secret was last updated", + "description": "Domain name", "computed": true }, { - "name": "secret_namespace", - "type": "TypeString", - "description": "Secret namespace", - "required": true - }, - { - "name": "cert_crn", + "name": "expires_on", "type": "TypeString", - "description": "Certificate CRN", + "description": "Certificate expires on date", "computed": true } ], @@ -19433,44 +19546,43 @@ ], "ibm_container_vpc_alb": [ { - "name": "alb_id", + "name": "state", "type": "TypeString", - "description": "ALB ID", - "required": true + "computed": true }, { - "name": "alb_type", + "name": "status", "type": "TypeString", "computed": true }, { - "name": "cluster", - "type": "TypeString", + "name": "disable_deployment", + "type": "TypeBool", "computed": true }, { - "name": "enable", - "type": "TypeBool", + "name": "name", + "type": "TypeString", "computed": true }, { - "name": "load_balancer_hostname", + "name": "cluster", "type": "TypeString", "computed": true }, { - "name": "resize", + "name": "enable", "type": "TypeBool", "computed": true }, { - "name": "state", + "name": "load_balancer_hostname", "type": "TypeString", "computed": true }, { - "name": "status", - "type": "TypeString", + "name": "resize", + "type": "TypeBool", "computed": true }, { @@ -19486,56 +19598,54 @@ "optional": true }, { - "name": "disable_deployment", - "type": "TypeBool", - "computed": true + "name": "alb_id", + "type": "TypeString", + "description": "ALB ID", + "required": true }, { - "name": "name", + "name": "alb_type", "type": "TypeString", "computed": true } ], "ibm_container_vpc_cluster": [ { - "name": "worker_count", - "type": "TypeInt", - "description": "Number of workers", + "name": "health", + "type": "TypeString", "computed": true }, { - "name": "pod_subnet", + "name": "resource_status", "type": "TypeString", - "description": "Custom subnet CIDR to provide private IP addresses for pods", + "description": "The status of the resource", "computed": true }, { - "name": "private_service_endpoint", - "type": "TypeBool", - "computed": true - }, - { - "name": "master_url", + "name": "cluster_name_id", "type": "TypeString", - "computed": true + "description": "Name or id of the cluster", + "optional": true, + "deprecated": "use name instead" }, { - "name": "kube_version", + "name": "crn", "type": "TypeString", + "description": "CRN of resource instance", + "cloud_data_type": "crn", "computed": true }, { - "name": "resource_name", + "name": "api_key_owner_name", "type": "TypeString", - "description": "The name of the resource", + "description": "Name of the key owner", "computed": true }, { - "name": "cluster_name_id", + "name": "resource_crn", "type": "TypeString", - "description": "Name or id of the cluster", - "optional": true, - "deprecated": "use name instead" + "description": "The crn of the resource", + "computed": true }, { "name": "albs", @@ -19584,6 +19694,11 @@ } } }, + { + "name": "kube_version", + "type": "TypeString", + "computed": true + }, { "name": "ingress_secret", "type": "TypeString", @@ -19591,35 +19706,58 @@ "computed": true }, { - "name": "state", + "name": "api_key_id", "type": "TypeString", + "description": "ID of APIkey", "computed": true }, { - "name": "api_key_owner_email", + "name": "workers", + "type": "TypeList", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "ingress_hostname", "type": "TypeString", - "description": "email id of the key owner", "computed": true }, { - "name": "resource_status", + "name": "private_service_endpoint_url", "type": "TypeString", - "description": "The status of the resource", "computed": true }, { - "name": "api_key_owner_name", + "name": "pod_subnet", "type": "TypeString", - "description": "Name of the key owner", + "description": "Custom subnet CIDR to provide private IP addresses for pods", "computed": true }, { - "name": "workers", - "type": "TypeList", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "private_service_endpoint", + "type": "TypeBool", + "computed": true + }, + { + "name": "service_subnet", + "type": "TypeString", + "description": "Custom subnet CIDR to provide private IP addresses for services", + "computed": true + }, + { + "name": "resource_group_id", + "type": "TypeString", + "description": "ID of the resource group.", + "cloud_data_type": "resource_group", + "optional": true, + "computed": true + }, + { + "name": "state", + "type": "TypeString", + "computed": true }, { "name": "public_service_endpoint", @@ -19627,19 +19765,47 @@ "computed": true }, { - "name": "public_service_endpoint_url", + "name": "status", "type": "TypeString", + "description": "The status of the cluster master", "computed": true }, { - "name": "crn", + "name": "api_key_owner_email", "type": "TypeString", - "description": "CRN of resource instance", - "cloud_data_type": "crn", + "description": "email id of the key owner", "computed": true }, { - "name": "health", + "name": "name", + "type": "TypeString", + "description": "Name or id of the cluster", + "cloud_data_type": "cluster", + "optional": true, + "cloud_data_range": [ + "resolved_to:id" + ] + }, + { + "name": "worker_count", + "type": "TypeInt", + "description": "Number of workers", + "computed": true + }, + { + "name": "resource_group_name", + "type": "TypeString", + "description": "The resource group name in which resource is provisioned", + "computed": true + }, + { + "name": "alb_type", + "type": "TypeString", + "default_value": "all", + "optional": true + }, + { + "name": "public_service_endpoint_url", "type": "TypeString", "computed": true }, @@ -19653,25 +19819,22 @@ } }, { - "name": "service_subnet", - "type": "TypeString", - "description": "Custom subnet CIDR to provide private IP addresses for services", + "name": "image_security_enforcement", + "type": "TypeBool", + "description": "True if image security enforcement is enabled", "computed": true }, { - "name": "ingress_hostname", + "name": "resource_controller_url", "type": "TypeString", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster", "computed": true }, { - "name": "name", + "name": "resource_name", "type": "TypeString", - "description": "Name or id of the cluster", - "cloud_data_type": "cluster", - "optional": true, - "cloud_data_range": [ - "resolved_to:id" - ] + "description": "The name of the resource", + "computed": true }, { "name": "worker_pools", @@ -19799,58 +19962,8 @@ } }, { - "name": "alb_type", - "type": "TypeString", - "default_value": "all", - "optional": true - }, - { - "name": "private_service_endpoint_url", - "type": "TypeString", - "computed": true - }, - { - "name": "api_key_id", - "type": "TypeString", - "description": "ID of APIkey", - "computed": true - }, - { - "name": "image_security_enforcement", - "type": "TypeBool", - "description": "True if image security enforcement is enabled", - "computed": true - }, - { - "name": "resource_controller_url", - "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster", - "computed": true - }, - { - "name": "resource_crn", - "type": "TypeString", - "description": "The crn of the resource", - "computed": true - }, - { - "name": "resource_group_name", - "type": "TypeString", - "description": "The resource group name in which resource is provisioned", - "computed": true - }, - { - "name": "status", - "type": "TypeString", - "description": "The status of the cluster master", - "computed": true - }, - { - "name": "resource_group_id", + "name": "master_url", "type": "TypeString", - "description": "ID of the resource group.", - "cloud_data_type": "resource_group", - "optional": true, "computed": true } ], @@ -19861,17 +19974,12 @@ "computed": true }, { - "name": "state", - "type": "TypeString", - "computed": true - }, - { - "name": "status", + "name": "load_balancer_hostname", "type": "TypeString", "computed": true }, { - "name": "zone", + "name": "state", "type": "TypeString", "computed": true }, @@ -19889,17 +19997,7 @@ "required": true }, { - "name": "alb_type", - "type": "TypeString", - "computed": true - }, - { - "name": "cluster", - "type": "TypeString", - "computed": true - }, - { - "name": "resize", + "name": "disable_deployment", "type": "TypeBool", "computed": true }, @@ -19909,52 +20007,48 @@ "computed": true }, { - "name": "disable_deployment", + "name": "resize", "type": "TypeBool", "computed": true }, { - "name": "load_balancer_hostname", + "name": "status", "type": "TypeString", "computed": true - } - ], - "ibm_container_vpc_cluster_worker": [ + }, { - "name": "kube_version", + "name": "zone", "type": "TypeString", - "description": "kube version of the worker", "computed": true }, { - "name": "state", + "name": "alb_type", "type": "TypeString", - "description": "State of the worker", "computed": true }, { - "name": "pool_name", + "name": "cluster", "type": "TypeString", - "description": "worker pool name", "computed": true - }, + } + ], + "ibm_container_vpc_cluster_worker": [ { - "name": "resource_group_id", + "name": "flavor", "type": "TypeString", - "description": "ID of the resource group.", - "cloud_data_type": "resource_group", - "optional": true + "description": "flavor of the worker", + "computed": true }, { - "name": "worker_id", + "name": "kube_version", "type": "TypeString", - "description": "ID of the worker", - "required": true + "description": "kube version of the worker", + "computed": true }, { - "name": "flavor", + "name": "pool_name", "type": "TypeString", - "description": "flavor of the worker", + "description": "worker pool name", "computed": true }, { @@ -19979,6 +20073,13 @@ } } }, + { + "name": "resource_group_id", + "type": "TypeString", + "description": "ID of the resource group.", + "cloud_data_type": "resource_group", + "optional": true + }, { "name": "host_pool_id", "type": "TypeString", @@ -20001,14 +20102,47 @@ "resolved_to:id" ] }, + { + "name": "state", + "type": "TypeString", + "description": "State of the worker", + "computed": true + }, { "name": "pool_id", "type": "TypeString", "description": "worker pool id", "computed": true + }, + { + "name": "worker_id", + "type": "TypeString", + "description": "ID of the worker", + "required": true } ], "ibm_container_vpc_cluster_worker_pool": [ + { + "name": "operating_system", + "type": "TypeString", + "description": "The operating system of the workers in the worker pool", + "computed": true + }, + { + "name": "isolation", + "type": "TypeString", + "computed": true + }, + { + "name": "cluster", + "type": "TypeString", + "description": "Cluster name", + "cloud_data_type": "cluster", + "required": true, + "cloud_data_range": [ + "resolved_to:id" + ] + }, { "name": "secondary_storage", "type": "TypeList", @@ -20048,10 +20182,56 @@ } }, { - "name": "host_pool_id", + "name": "worker_count", + "type": "TypeInt", + "computed": true + }, + { + "name": "flavor", + "type": "TypeString", + "computed": true + }, + { + "name": "zones", + "type": "TypeSet", + "computed": true, + "elem": { + "name": { + "name": "name", + "type": "TypeString", + "computed": true + }, + "subnet_id": { + "name": "subnet_id", + "type": "TypeString", + "computed": true + } + } + }, + { + "name": "labels", + "type": "TypeMap", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "kms_instance_id", + "type": "TypeString", + "computed": true + }, + { + "name": "crk", "type": "TypeString", "computed": true }, + { + "name": "worker_pool_name", + "type": "TypeString", + "description": "worker pool name", + "required": true + }, { "name": "resource_group_id", "type": "TypeString", @@ -20059,17 +20239,35 @@ "computed": true }, { - "name": "worker_count", - "type": "TypeInt", + "name": "vpc_id", + "type": "TypeString", + "computed": true + }, + { + "name": "host_pool_id", + "type": "TypeString", + "computed": true + }, + { + "name": "kms_account_id", + "type": "TypeString", "computed": true }, + { + "name": "autoscale_enabled", + "type": "TypeBool", + "description": "Autoscaling is enabled on the workerpool", + "computed": true + } + ], + "ibm_container_vpc_worker_pool": [ { "name": "kms_instance_id", "type": "TypeString", "computed": true }, { - "name": "flavor", + "name": "crk", "type": "TypeString", "computed": true }, @@ -20091,22 +20289,29 @@ } }, { - "name": "vpc_id", + "name": "operating_system", "type": "TypeString", + "description": "The operating system of the workers in the worker pool", "computed": true }, { - "name": "isolation", + "name": "resource_group_id", "type": "TypeString", + "cloud_data_type": "resource_group", "computed": true }, { - "name": "crk", + "name": "vpc_id", "type": "TypeString", "computed": true }, { - "name": "kms_account_id", + "name": "worker_count", + "type": "TypeInt", + "computed": true + }, + { + "name": "host_pool_id", "type": "TypeString", "computed": true }, @@ -20116,16 +20321,6 @@ "description": "Autoscaling is enabled on the workerpool", "computed": true }, - { - "name": "cluster", - "type": "TypeString", - "description": "Cluster name", - "cloud_data_type": "cluster", - "required": true, - "cloud_data_range": [ - "resolved_to:id" - ] - }, { "name": "worker_pool_name", "type": "TypeString", @@ -20141,23 +20336,7 @@ } }, { - "name": "operating_system", - "type": "TypeString", - "description": "The operating system of the workers in the worker pool", - "computed": true - } - ], - "ibm_container_vpc_worker_pool": [ - { - "name": "labels", - "type": "TypeMap", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "kms_instance_id", + "name": "kms_account_id", "type": "TypeString", "computed": true }, @@ -20167,17 +20346,6 @@ "description": "Cluster name", "required": true }, - { - "name": "flavor", - "type": "TypeString", - "computed": true - }, - { - "name": "operating_system", - "type": "TypeString", - "description": "The operating system of the workers in the worker pool", - "computed": true - }, { "name": "secondary_storage", "type": "TypeList", @@ -20217,42 +20385,17 @@ } }, { - "name": "zones", - "type": "TypeSet", - "computed": true, - "elem": { - "name": { - "name": "name", - "type": "TypeString", - "computed": true - }, - "subnet_id": { - "name": "subnet_id", - "type": "TypeString", - "computed": true - } - } - }, - { - "name": "worker_count", - "type": "TypeInt", - "computed": true - }, - { - "name": "isolation", - "type": "TypeString", - "computed": true - }, - { - "name": "crk", + "name": "flavor", "type": "TypeString", "computed": true }, { - "name": "kms_account_id", + "name": "isolation", "type": "TypeString", "computed": true - }, + } + ], + "ibm_container_worker_pool": [ { "name": "autoscale_enabled", "type": "TypeBool", @@ -20260,49 +20403,56 @@ "computed": true }, { - "name": "worker_pool_name", + "name": "cluster", "type": "TypeString", - "description": "worker pool name", - "required": true + "description": "Name or ID of the cluster", + "cloud_data_type": "cluster", + "required": true, + "cloud_data_range": [ + "resolved_to:id" + ] }, { - "name": "resource_group_id", + "name": "machine_type", "type": "TypeString", - "cloud_data_type": "resource_group", + "description": "worker nodes machine type", "computed": true }, { - "name": "vpc_id", - "type": "TypeString", + "name": "size_per_zone", + "type": "TypeInt", + "description": "Number of nodes per zone", "computed": true }, { - "name": "host_pool_id", + "name": "hardware", "type": "TypeString", + "description": "Hardware type", "computed": true - } - ], - "ibm_container_worker_pool": [ + }, { - "name": "operating_system", - "type": "TypeString", - "description": "The operating system of the workers in the worker pool", + "name": "labels", + "type": "TypeMap", + "description": "list of labels to worker pool", "computed": true }, { - "name": "cluster", + "name": "resource_group_id", "type": "TypeString", - "description": "Name or ID of the cluster", - "cloud_data_type": "cluster", - "required": true, - "cloud_data_range": [ - "resolved_to:id" - ] + "description": "ID of the resource group.", + "cloud_data_type": "resource_group", + "computed": true }, { - "name": "hardware", + "name": "worker_pool_name", "type": "TypeString", - "description": "Hardware type", + "description": "worker pool name", + "required": true + }, + { + "name": "disk_encryption", + "type": "TypeBool", + "description": "worker node disk encrypted if set to true", "computed": true }, { @@ -20311,12 +20461,6 @@ "description": "worker pool state", "computed": true }, - { - "name": "labels", - "type": "TypeMap", - "description": "list of labels to worker pool", - "computed": true - }, { "name": "zones", "type": "TypeList", @@ -20350,44 +20494,19 @@ } }, { - "name": "resource_group_id", + "name": "operating_system", "type": "TypeString", - "description": "ID of the resource group.", - "cloud_data_type": "resource_group", - "computed": true - }, - { - "name": "autoscale_enabled", - "type": "TypeBool", - "description": "Autoscaling is enabled on the workerpool", + "description": "The operating system of the workers in the worker pool", "computed": true - }, - { - "name": "worker_pool_name", - "type": "TypeString", - "description": "worker pool name", - "required": true - }, + } + ], + "ibm_cos_bucket": [ { - "name": "machine_type", + "name": "s3_endpoint_public", "type": "TypeString", - "description": "worker nodes machine type", - "computed": true - }, - { - "name": "size_per_zone", - "type": "TypeInt", - "description": "Number of nodes per zone", + "description": "Public endpoint for the COS bucket", "computed": true }, - { - "name": "disk_encryption", - "type": "TypeBool", - "description": "worker node disk encrypted if set to true", - "computed": true - } - ], - "ibm_cos_bucket": [ { "name": "activity_tracking", "type": "TypeList", @@ -20439,19 +20558,25 @@ } }, { - "name": "object_versioning", + "name": "hard_quota", + "type": "TypeInt", + "description": "sets a maximum amount of storage (in bytes) available for a bucket", + "computed": true + }, + { + "name": "allowed_ip", "type": "TypeList", - "description": "Protect objects from accidental deletion or overwrites. Versioning allows you to keep multiple versions of an object protecting from unintentional data loss.", + "description": "List of IPv4 or IPv6 addresses", "computed": true, "elem": { - "enable": { - "name": "enable", - "type": "TypeBool", - "description": "Enable or suspend the versioning for objects in the bucket", - "computed": true - } + "type": "TypeString" } }, + { + "name": "website_endpoint", + "type": "TypeString", + "computed": true + }, { "name": "endpoint_type", "type": "TypeString", @@ -20467,107 +20592,131 @@ "computed": true }, { - "name": "single_site_location", - "type": "TypeString", - "computed": true - }, - { - "name": "cross_region_location", - "type": "TypeString", - "computed": true - }, - { - "name": "bucket_region", - "type": "TypeString", - "optional": true - }, - { - "name": "archive_rule", + "name": "website_configuration", "type": "TypeList", - "description": "Enable configuration archive_rule (glacier/accelerated) to COS Bucket after a defined period of time", "computed": true, "elem": { - "days": { - "name": "days", - "type": "TypeInt", - "computed": true - }, - "enable": { - "name": "enable", - "type": "TypeBool", - "description": "Enable or disable an archive rule for a bucket", - "computed": true + "error_document": { + "name": "error_document", + "type": "TypeList", + "computed": true, + "elem": { + "key": { + "name": "key", + "type": "TypeString", + "computed": true + } + } }, - "rule_id": { - "name": "rule_id", - "type": "TypeString", - "computed": true + "index_document": { + "name": "index_document", + "type": "TypeList", + "computed": true, + "elem": { + "suffix": { + "name": "suffix", + "type": "TypeString", + "computed": true + } + } }, - "type": { - "name": "type", - "type": "TypeString", - "computed": true - } - } - }, - { - "name": "hard_quota", - "type": "TypeInt", - "description": "sets a maximum amount of storage (in bytes) available for a bucket", - "computed": true - }, - { - "name": "object_lock_configuration", - "type": "TypeList", - "description": "Bucket level object lock settings includes Days, Years, Mode.", - "computed": true, - "elem": { - "object_lock_enabled": { - "name": "object_lock_enabled", - "type": "TypeString", - "description": "Enable object lock on a COS bucket. This can be used to enable objectlock on an existing bucket", - "computed": true + "redirect_all_requests_to": { + "name": "redirect_all_requests_to", + "type": "TypeList", + "computed": true, + "elem": { + "host_name": { + "name": "host_name", + "type": "TypeString", + "computed": true + }, + "protocol": { + "name": "protocol", + "type": "TypeString", + "computed": true + } + } }, - "object_lock_rule": { - "name": "object_lock_rule", + "routing_rule": { + "name": "routing_rule", "type": "TypeList", + "description": "Rules that define when a redirect is applied and the redirect behavior.", "computed": true, "elem": { - "default_retention": { - "name": "default_retention", + "condition": { + "name": "condition", "type": "TypeList", - "description": "An object lock configuration on the object at a bucket level, in the form of a days , years and mode that establishes a point in time after which the object can be deleted. This is applied at bucket level hence it is by default applied to all the object in the bucket unless a seperate retention period is set on the object.", + "description": "A condition that must be met for the specified redirect to be applie.", "computed": true, "elem": { - "days": { - "name": "days", - "type": "TypeInt", - "description": "Retention period in terms of days after which the object can be deleted.", + "http_error_code_returned_equals": { + "name": "http_error_code_returned_equals", + "type": "TypeString", + "description": "The HTTP error code when the redirect is applied. Valid codes are 4XX or 5XX..", "computed": true }, - "mode": { - "name": "mode", + "key_prefix_equals": { + "name": "key_prefix_equals", "type": "TypeString", - "description": "Retention modes apply different levels of protection to the objects.", + "description": "The object key name prefix when the redirect is applied..", + "computed": true + } + } + }, + "redirect": { + "name": "redirect", + "type": "TypeList", + "description": ".", + "computed": true, + "elem": { + "host_name": { + "name": "host_name", + "type": "TypeString", + "description": "The host name the request should be redirected to.", "computed": true }, - "years": { - "name": "years", - "type": "TypeInt", - "description": "Retention period in terms of years after which the object can be deleted.", + "http_redirect_code": { + "name": "http_redirect_code", + "type": "TypeString", + "description": "The HTTP redirect code to use on the response. Valid codes are 3XX except 300..", + "computed": true + }, + "protocol": { + "name": "protocol", + "type": "TypeString", + "description": "Protocol to be used in the Location header that is returned in the response.", + "computed": true + }, + "replace_key_prefix_with": { + "name": "replace_key_prefix_with", + "type": "TypeString", + "description": "The prefix of the object key name that replaces the value of KeyPrefixEquals in the redirect request.", + "computed": true + }, + "replace_key_with": { + "name": "replace_key_with", + "type": "TypeString", + "description": "The object key to be used in the Location header that is returned in the response.", "computed": true } } } } + }, + "routing_rules": { + "name": "routing_rules", + "type": "TypeString", + "description": "Rules that define when a redirect is applied and the redirect behavior.", + "optional": true, + "computed": true } } }, { - "name": "bucket_type", - "type": "TypeString", - "options": "single_site_location,region_location,cross_region_location", - "optional": true + "name": "object_lock", + "type": "TypeBool", + "description": "Description", + "computed": true }, { "name": "resource_instance_id", @@ -20579,58 +20728,32 @@ ] }, { - "name": "abort_incomplete_multipart_upload_days", - "type": "TypeList", - "computed": true, - "elem": { - "days_after_initiation": { - "name": "days_after_initiation", - "type": "TypeInt", - "description": "Specifies the number of days when the specific rule action takes effect.", - "computed": true - }, - "enable": { - "name": "enable", - "type": "TypeBool", - "description": "Enable or disable rule for a bucket", - "computed": true - }, - "prefix": { - "name": "prefix", - "type": "TypeString", - "description": "The rule applies to any objects with keys that match this prefix", - "computed": true - }, - "rule_id": { - "name": "rule_id", - "type": "TypeString", - "description": "Unique identifier for the rule. Rules allow you to set a specific time frame after which objects are deleted. Set Rule ID for cos bucket", - "computed": true - } - } + "name": "crn", + "type": "TypeString", + "description": "CRN of resource instance", + "cloud_data_type": "crn", + "computed": true }, { - "name": "object_lock", - "type": "TypeBool", - "description": "Description", + "name": "single_site_location", + "type": "TypeString", "computed": true }, { - "name": "expire_rule", + "name": "s3_endpoint_private", + "type": "TypeString", + "description": "Private endpoint for the COS bucket", + "computed": true + }, + { + "name": "archive_rule", "type": "TypeList", - "description": "Enable configuration expire_rule to COS Bucket", + "description": "Enable configuration archive_rule (glacier/accelerated) to COS Bucket after a defined period of time", "computed": true, "elem": { - "date": { - "name": "date", - "type": "TypeString", - "description": "Specifies the date when the specific rule action takes effect.", - "computed": true - }, "days": { "name": "days", "type": "TypeInt", - "description": "Specifies the number of days when the specific rule action takes effect.", "computed": true }, "enable": { @@ -20639,20 +20762,13 @@ "description": "Enable or disable an archive rule for a bucket", "computed": true }, - "expired_object_delete_marker": { - "name": "expired_object_delete_marker", - "type": "TypeBool", - "description": "Expired object delete markers can be automatically cleaned up to improve performance in bucket. This cannot be used alongside version expiration.", - "computed": true - }, - "prefix": { - "name": "prefix", + "rule_id": { + "name": "rule_id", "type": "TypeString", - "description": "The rule applies to any objects with keys that match this prefix", "computed": true }, - "rule_id": { - "name": "rule_id", + "type": { + "name": "type", "type": "TypeString", "computed": true } @@ -20696,35 +20812,35 @@ "required": true }, { - "name": "region_location", + "name": "bucket_type", "type": "TypeString", - "computed": true + "options": "single_site_location,region_location,cross_region_location", + "optional": true }, { - "name": "s3_endpoint_direct", + "name": "satellite_location_id", + "type": "TypeString", + "optional": true + }, + { + "name": "region_location", "type": "TypeString", - "description": "Direct endpoint for the COS bucket", "computed": true }, { - "name": "allowed_ip", - "type": "TypeList", - "description": "List of IPv4 or IPv6 addresses", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "storage_class", + "type": "TypeString", + "computed": true }, { - "name": "s3_endpoint_public", + "name": "cross_region_location", "type": "TypeString", - "description": "Public endpoint for the COS bucket", "computed": true }, { - "name": "kms_key_crn", + "name": "s3_endpoint_direct", "type": "TypeString", - "description": "CRN of the key you want to use data at rest encryption", + "description": "Direct endpoint for the COS bucket", "computed": true }, { @@ -20759,19 +20875,6 @@ } } }, - { - "name": "crn", - "type": "TypeString", - "description": "CRN of resource instance", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "s3_endpoint_private", - "type": "TypeString", - "description": "Private endpoint for the COS bucket", - "computed": true - }, { "name": "replication_rule", "type": "TypeList", @@ -20816,22 +20919,157 @@ } }, { - "name": "satellite_location_id", + "name": "abort_incomplete_multipart_upload_days", + "type": "TypeList", + "computed": true, + "elem": { + "days_after_initiation": { + "name": "days_after_initiation", + "type": "TypeInt", + "description": "Specifies the number of days when the specific rule action takes effect.", + "computed": true + }, + "enable": { + "name": "enable", + "type": "TypeBool", + "description": "Enable or disable rule for a bucket", + "computed": true + }, + "prefix": { + "name": "prefix", + "type": "TypeString", + "description": "The rule applies to any objects with keys that match this prefix", + "computed": true + }, + "rule_id": { + "name": "rule_id", + "type": "TypeString", + "description": "Unique identifier for the rule. Rules allow you to set a specific time frame after which objects are deleted. Set Rule ID for cos bucket", + "computed": true + } + } + }, + { + "name": "expire_rule", + "type": "TypeList", + "description": "Enable configuration expire_rule to COS Bucket", + "computed": true, + "elem": { + "date": { + "name": "date", + "type": "TypeString", + "description": "Specifies the date when the specific rule action takes effect.", + "computed": true + }, + "days": { + "name": "days", + "type": "TypeInt", + "description": "Specifies the number of days when the specific rule action takes effect.", + "computed": true + }, + "enable": { + "name": "enable", + "type": "TypeBool", + "description": "Enable or disable an archive rule for a bucket", + "computed": true + }, + "expired_object_delete_marker": { + "name": "expired_object_delete_marker", + "type": "TypeBool", + "description": "Expired object delete markers can be automatically cleaned up to improve performance in bucket. This cannot be used alongside version expiration.", + "computed": true + }, + "prefix": { + "name": "prefix", + "type": "TypeString", + "description": "The rule applies to any objects with keys that match this prefix", + "computed": true + }, + "rule_id": { + "name": "rule_id", + "type": "TypeString", + "computed": true + } + } + }, + { + "name": "bucket_region", "type": "TypeString", "optional": true }, { - "name": "storage_class", + "name": "kms_key_crn", "type": "TypeString", + "description": "CRN of the key you want to use data at rest encryption", "computed": true + }, + { + "name": "object_versioning", + "type": "TypeList", + "description": "Protect objects from accidental deletion or overwrites. Versioning allows you to keep multiple versions of an object protecting from unintentional data loss.", + "computed": true, + "elem": { + "enable": { + "name": "enable", + "type": "TypeBool", + "description": "Enable or suspend the versioning for objects in the bucket", + "computed": true + } + } + }, + { + "name": "object_lock_configuration", + "type": "TypeList", + "description": "Bucket level object lock settings includes Days, Years, Mode.", + "computed": true, + "elem": { + "object_lock_enabled": { + "name": "object_lock_enabled", + "type": "TypeString", + "description": "Enable object lock on a COS bucket. This can be used to enable objectlock on an existing bucket", + "computed": true + }, + "object_lock_rule": { + "name": "object_lock_rule", + "type": "TypeList", + "computed": true, + "elem": { + "default_retention": { + "name": "default_retention", + "type": "TypeList", + "description": "An object lock configuration on the object at a bucket level, in the form of a days , years and mode that establishes a point in time after which the object can be deleted. This is applied at bucket level hence it is by default applied to all the object in the bucket unless a seperate retention period is set on the object.", + "computed": true, + "elem": { + "days": { + "name": "days", + "type": "TypeInt", + "description": "Retention period in terms of days after which the object can be deleted.", + "computed": true + }, + "mode": { + "name": "mode", + "type": "TypeString", + "description": "Retention modes apply different levels of protection to the objects.", + "computed": true + }, + "years": { + "name": "years", + "type": "TypeInt", + "description": "Retention period in terms of years after which the object can be deleted.", + "computed": true + } + } + } + } + } + } } ], "ibm_cos_bucket_object": [ { - "name": "bucket_crn", + "name": "object_lock_mode", "type": "TypeString", - "description": "COS bucket CRN", - "required": true + "computed": true }, { "name": "bucket_location", @@ -20840,70 +21078,76 @@ "required": true }, { - "name": "object_lock_mode", - "type": "TypeString", + "name": "content_length", + "type": "TypeInt", + "description": "COS object content length", "computed": true }, { - "name": "body", + "name": "etag", "type": "TypeString", - "description": "COS object body", + "description": "COS object MD5 hexdigest", "computed": true }, { - "name": "content_length", - "type": "TypeInt", - "description": "COS object content length", + "name": "version_id", + "type": "TypeString", "computed": true }, { - "name": "content_type", + "name": "object_lock_retain_until_date", "type": "TypeString", - "description": "COS object content type", "computed": true }, { - "name": "endpoint_type", + "name": "bucket_crn", "type": "TypeString", - "description": "COS endpoint type: public, private, direct", - "default_value": "public", - "optional": true + "description": "COS bucket CRN", + "required": true }, { - "name": "last_modified", + "name": "object_lock_legal_hold_status", "type": "TypeString", - "description": "COS object last modified date", "computed": true }, { - "name": "etag", + "name": "website_redirect", "type": "TypeString", - "description": "COS object MD5 hexdigest", "computed": true }, { - "name": "key", + "name": "body", "type": "TypeString", - "description": "COS object key", - "required": true + "description": "COS object body", + "computed": true }, { - "name": "version_id", + "name": "content_type", "type": "TypeString", + "description": "COS object content type", "computed": true }, { - "name": "object_sql_url", + "name": "endpoint_type", "type": "TypeString", - "computed": true + "description": "COS endpoint type: public, private, direct", + "default_value": "public", + "optional": true }, { - "name": "object_lock_legal_hold_status", + "name": "key", + "type": "TypeString", + "description": "COS object key", + "required": true + }, + { + "name": "last_modified", "type": "TypeString", + "description": "COS object last modified date", "computed": true }, { - "name": "object_lock_retain_until_date", + "name": "object_sql_url", "type": "TypeString", "computed": true } @@ -20976,29 +21220,15 @@ ], "ibm_database": [ { - "name": "allowlist", - "type": "TypeSet", - "computed": true, - "elem": { - "address": { - "name": "address", - "type": "TypeString", - "description": "Allowlist IP address in CIDR notation", - "computed": true - }, - "description": { - "name": "description", - "type": "TypeString", - "description": "Unique allowlist description", - "computed": true - } - } + "name": "service", + "type": "TypeString", + "description": "The name of the Cloud Database service", + "optional": true }, { - "name": "adminpassword", + "name": "status", "type": "TypeString", - "description": "The admin user id for the instance", - "secure": true, + "description": "The resource instance status", "computed": true }, { @@ -21007,6 +21237,13 @@ "description": "The database version to provision if specified", "computed": true }, + { + "name": "members_memory_allocation_mb", + "type": "TypeInt", + "description": "Memory allocation required for cluster", + "computed": true, + "deprecated": "This field is deprecated please use groups" + }, { "name": "members_disk_allocation_mb", "type": "TypeInt", @@ -21014,6 +21251,44 @@ "computed": true, "deprecated": "This field is deprecated please use groups" }, + { + "name": "name", + "type": "TypeString", + "description": "Resource instance name for example, my Database instance", + "cloud_data_type": "cloud-database", + "required": true, + "cloud_data_range": [ + "resolved_to:name" + ] + }, + { + "name": "location", + "type": "TypeString", + "description": "The location or the region in which the Database instance exists", + "cloud_data_type": "region", + "optional": true + }, + { + "name": "guid", + "type": "TypeString", + "description": "Unique identifier of resource instance", + "computed": true + }, + { + "name": "adminuser", + "type": "TypeString", + "description": "The admin user id for the instance", + "computed": true + }, + { + "name": "tags", + "type": "TypeSet", + "cloud_data_type": "tags", + "optional": true, + "elem": { + "type": "TypeString" + } + }, { "name": "users", "type": "TypeSet", @@ -21034,6 +21309,49 @@ } } }, + { + "name": "resource_status", + "type": "TypeString", + "description": "The status of the resource", + "computed": true + }, + { + "name": "resource_group_name", + "type": "TypeString", + "description": "The resource group name in which resource is provisioned", + "computed": true + }, + { + "name": "resource_controller_url", + "type": "TypeString", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource", + "computed": true + }, + { + "name": "plan", + "type": "TypeString", + "description": "The plan type of the Database instance", + "computed": true + }, + { + "name": "allowlist", + "type": "TypeSet", + "computed": true, + "elem": { + "address": { + "name": "address", + "type": "TypeString", + "description": "Allowlist IP address in CIDR notation", + "computed": true + }, + "description": { + "name": "description", + "type": "TypeString", + "description": "Unique allowlist description", + "computed": true + } + } + }, { "name": "auto_scaling", "type": "TypeList", @@ -21212,38 +21530,47 @@ } }, { - "name": "resource_group_name", - "type": "TypeString", - "description": "The resource group name in which resource is provisioned", - "computed": true - }, - { - "name": "resource_controller_url", + "name": "resource_crn", "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource", + "description": "The crn of the resource", "computed": true }, { - "name": "name", + "name": "resource_group_id", "type": "TypeString", - "description": "Resource instance name for example, my Database instance", - "cloud_data_type": "cloud-database", - "required": true, + "description": "The id of the resource group in which the Database instance is present", + "cloud_data_type": "resource_group", + "optional": true, "cloud_data_range": [ - "resolved_to:name" + "resolved_to:id" ] }, { - "name": "guid", + "name": "adminpassword", "type": "TypeString", - "description": "Unique identifier of resource instance", + "description": "The admin user id for the instance", + "secure": true, "computed": true }, { - "name": "service", - "type": "TypeString", - "description": "The name of the Cloud Database service", - "optional": true + "name": "platform_options", + "type": "TypeSet", + "description": "Platform-specific options for this deployment.r", + "computed": true, + "elem": { + "backup_encryption_key_crn": { + "name": "backup_encryption_key_crn", + "type": "TypeString", + "description": "Backup encryption key crn", + "computed": true + }, + "disk_encryption_key_crn": { + "name": "disk_encryption_key_crn", + "type": "TypeString", + "description": "Disk encryption key crn", + "computed": true + } + } }, { "name": "groups", @@ -21399,97 +21726,26 @@ "description": "The configuration schema in JSON format", "computed": true }, - { - "name": "resource_crn", - "type": "TypeString", - "description": "The crn of the resource", - "computed": true - }, - { - "name": "location", - "type": "TypeString", - "description": "The location or the region in which the Database instance exists", - "cloud_data_type": "region", - "optional": true - }, - { - "name": "adminuser", - "type": "TypeString", - "description": "The admin user id for the instance", - "computed": true - }, - { - "name": "members_memory_allocation_mb", - "type": "TypeInt", - "description": "Memory allocation required for cluster", - "computed": true, - "deprecated": "This field is deprecated please use groups" - }, - { - "name": "platform_options", - "type": "TypeSet", - "description": "Platform-specific options for this deployment.r", - "computed": true, - "elem": { - "backup_encryption_key_crn": { - "name": "backup_encryption_key_crn", - "type": "TypeString", - "description": "Backup encryption key crn", - "computed": true - }, - "disk_encryption_key_crn": { - "name": "disk_encryption_key_crn", - "type": "TypeString", - "description": "Disk encryption key crn", - "computed": true - } - } - }, { "name": "resource_name", "type": "TypeString", "description": "The name of the resource", "computed": true - }, - { - "name": "resource_status", - "type": "TypeString", - "description": "The status of the resource", - "computed": true - }, - { - "name": "resource_group_id", - "type": "TypeString", - "description": "The id of the resource group in which the Database instance is present", - "cloud_data_type": "resource_group", - "optional": true, - "cloud_data_range": [ - "resolved_to:id" - ] - }, + } + ], + "ibm_database_backup": [ { - "name": "plan", + "name": "download_link", "type": "TypeString", - "description": "The plan type of the Database instance", + "description": "URI which is currently available for file downloading.", "computed": true }, { - "name": "status", + "name": "created_at", "type": "TypeString", - "description": "The resource instance status", + "description": "Date and time when this backup was created.", "computed": true }, - { - "name": "tags", - "type": "TypeSet", - "cloud_data_type": "tags", - "optional": true, - "elem": { - "type": "TypeString" - } - } - ], - "ibm_database_backup": [ { "name": "backup_id", "type": "TypeString", @@ -21525,18 +21781,6 @@ "type": "TypeBool", "description": "Can this backup be used to restore an instance?.", "computed": true - }, - { - "name": "download_link", - "type": "TypeString", - "description": "URI which is currently available for file downloading.", - "computed": true - }, - { - "name": "created_at", - "type": "TypeString", - "description": "Date and time when this backup was created.", - "computed": true } ], "ibm_database_backups": [ @@ -21609,13 +21853,7 @@ ], "ibm_database_connection": [ { - "name": "user_id", - "type": "TypeString", - "description": "User ID.", - "required": true - }, - { - "name": "analytics", + "name": "stomp_ssl", "type": "TypeList", "computed": true, "elem": { @@ -21733,7 +21971,7 @@ } }, { - "name": "mongodb", + "name": "grpc", "type": "TypeList", "computed": true, "elem": { @@ -21796,12 +22034,6 @@ "type": "TypeString" } }, - "database": { - "name": "database", - "type": "TypeString", - "description": "Name of the database to use in the URI connection.", - "computed": true - }, "hosts": { "name": "hosts", "type": "TypeList", @@ -21836,12 +22068,6 @@ "type": "TypeString" } }, - "replica_set": { - "name": "replica_set", - "type": "TypeString", - "description": "Name of the replica set to use in the URI connection.", - "computed": true - }, "scheme": { "name": "scheme", "type": "TypeString", @@ -21863,7 +22089,78 @@ } }, { - "name": "ops_manager", + "name": "secure", + "type": "TypeList", + "computed": true, + "elem": { + "authentication": { + "name": "authentication", + "type": "TypeList", + "description": "Authentication data for Connection String.", + "computed": true, + "elem": { + "method": { + "name": "method", + "type": "TypeString", + "description": "Authentication method for this credential.", + "computed": true + }, + "password": { + "name": "password", + "type": "TypeString", + "description": "Password part of credential.", + "computed": true + }, + "username": { + "name": "username", + "type": "TypeString", + "description": "Username part of credential.", + "computed": true + } + } + }, + "bundle": { + "name": "bundle", + "type": "TypeList", + "computed": true, + "elem": { + "bundle_base64": { + "name": "bundle_base64", + "type": "TypeString", + "description": "Base64 encoded version of the certificate bundle.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Name associated with the certificate.", + "computed": true + } + } + }, + "hosts": { + "name": "hosts", + "type": "TypeList", + "computed": true, + "elem": { + "hostname": { + "name": "hostname", + "type": "TypeString", + "description": "Hostname for connection.", + "computed": true + }, + "port": { + "name": "port", + "type": "TypeInt", + "description": "Port number for connection.", + "computed": true + } + } + } + } + }, + { + "name": "amqps", "type": "TypeList", "computed": true, "elem": { @@ -21981,7 +22278,7 @@ } }, { - "name": "mysql", + "name": "mongodb", "type": "TypeList", "computed": true, "elem": { @@ -22084,6 +22381,12 @@ "type": "TypeString" } }, + "replica_set": { + "name": "replica_set", + "type": "TypeString", + "description": "Name of the replica set to use in the URI connection.", + "computed": true + }, "scheme": { "name": "scheme", "type": "TypeString", @@ -22105,7 +22408,7 @@ } }, { - "name": "secure", + "name": "bi_connector", "type": "TypeList", "computed": true, "elem": { @@ -22135,15 +22438,21 @@ } } }, - "bundle": { - "name": "bundle", + "browser_accessible": { + "name": "browser_accessible", + "type": "TypeBool", + "description": "Indicates the address is accessible by browser.", + "computed": true + }, + "certificate": { + "name": "certificate", "type": "TypeList", "computed": true, "elem": { - "bundle_base64": { - "name": "bundle_base64", + "certificate_base64": { + "name": "certificate_base64", "type": "TypeString", - "description": "Base64 encoded version of the certificate bundle.", + "description": "Base64 encoded version of the certificate.", "computed": true }, "name": { @@ -22154,6 +22463,14 @@ } } }, + "composed": { + "name": "composed", + "type": "TypeList", + "computed": true, + "elem": { + "type": "TypeString" + } + }, "hosts": { "name": "hosts", "type": "TypeList", @@ -22172,17 +22489,44 @@ "computed": true } } + }, + "path": { + "name": "path", + "type": "TypeString", + "description": "Path for URI connection.", + "computed": true + }, + "query_options": { + "name": "query_options", + "type": "TypeMap", + "description": "Query options to add to the URI connection.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "scheme": { + "name": "scheme", + "type": "TypeString", + "description": "Scheme/protocol for URI connection.", + "computed": true + }, + "ssl": { + "name": "ssl", + "type": "TypeBool", + "description": "Indicates ssl is required for the connection.", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "Type of connection being described.", + "computed": true } } }, { - "name": "user_type", - "type": "TypeString", - "description": "User type.", - "required": true - }, - { - "name": "rediss", + "name": "mysql", "type": "TypeList", "computed": true, "elem": { @@ -22247,8 +22591,8 @@ }, "database": { "name": "database", - "type": "TypeInt", - "description": "Number of the database to use in the URI connection.", + "type": "TypeString", + "description": "Name of the database to use in the URI connection.", "computed": true }, "hosts": { @@ -22306,7 +22650,24 @@ } }, { - "name": "https", + "name": "deployment_id", + "type": "TypeString", + "description": "Deployment ID.", + "cloud_data_type": "cloud-database", + "required": true, + "cloud_data_range": [ + "resolved_to:id" + ] + }, + { + "name": "endpoint_type", + "type": "TypeString", + "description": "Endpoint Type. The endpoint must be enabled on the deployment before its connection information can be fetched.", + "required": true, + "options": "public, private, public-and-private" + }, + { + "name": "postgres", "type": "TypeList", "computed": true, "elem": { @@ -22369,6 +22730,12 @@ "type": "TypeString" } }, + "database": { + "name": "database", + "type": "TypeString", + "description": "Name of the database to use in the URI connection.", + "computed": true + }, "hosts": { "name": "hosts", "type": "TypeList", @@ -22424,7 +22791,84 @@ } }, { - "name": "stomp_ssl", + "name": "cli", + "type": "TypeList", + "description": "CLI Connection.", + "computed": true, + "elem": { + "arguments": { + "name": "arguments", + "type": "TypeList", + "description": "Sets of arguments to call the executable with. The outer array corresponds to a possible way to call the CLI; the inner array is the set of arguments to use with that call.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "bin": { + "name": "bin", + "type": "TypeString", + "description": "The name of the executable the CLI should run.", + "computed": true + }, + "certificate": { + "name": "certificate", + "type": "TypeList", + "computed": true, + "elem": { + "certificate_base64": { + "name": "certificate_base64", + "type": "TypeString", + "description": "Base64 encoded version of the certificate.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Name associated with the certificate.", + "computed": true + } + } + }, + "composed": { + "name": "composed", + "type": "TypeList", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "environment": { + "name": "environment", + "type": "TypeMap", + "description": "A map of environment variables for a CLI connection.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "Type of connection being described.", + "computed": true + } + } + }, + { + "name": "user_type", + "type": "TypeString", + "description": "User type.", + "required": true + }, + { + "name": "user_id", + "type": "TypeString", + "description": "User ID.", + "required": true + }, + { + "name": "https", "type": "TypeList", "computed": true, "elem": { @@ -22542,125 +22986,7 @@ } }, { - "name": "grpc", - "type": "TypeList", - "computed": true, - "elem": { - "authentication": { - "name": "authentication", - "type": "TypeList", - "description": "Authentication data for Connection String.", - "computed": true, - "elem": { - "method": { - "name": "method", - "type": "TypeString", - "description": "Authentication method for this credential.", - "computed": true - }, - "password": { - "name": "password", - "type": "TypeString", - "description": "Password part of credential.", - "computed": true - }, - "username": { - "name": "username", - "type": "TypeString", - "description": "Username part of credential.", - "computed": true - } - } - }, - "browser_accessible": { - "name": "browser_accessible", - "type": "TypeBool", - "description": "Indicates the address is accessible by browser.", - "computed": true - }, - "certificate": { - "name": "certificate", - "type": "TypeList", - "computed": true, - "elem": { - "certificate_base64": { - "name": "certificate_base64", - "type": "TypeString", - "description": "Base64 encoded version of the certificate.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Name associated with the certificate.", - "computed": true - } - } - }, - "composed": { - "name": "composed", - "type": "TypeList", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "hosts": { - "name": "hosts", - "type": "TypeList", - "computed": true, - "elem": { - "hostname": { - "name": "hostname", - "type": "TypeString", - "description": "Hostname for connection.", - "computed": true - }, - "port": { - "name": "port", - "type": "TypeInt", - "description": "Port number for connection.", - "computed": true - } - } - }, - "path": { - "name": "path", - "type": "TypeString", - "description": "Path for URI connection.", - "computed": true - }, - "query_options": { - "name": "query_options", - "type": "TypeMap", - "description": "Query options to add to the URI connection.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "scheme": { - "name": "scheme", - "type": "TypeString", - "description": "Scheme/protocol for URI connection.", - "computed": true - }, - "ssl": { - "name": "ssl", - "type": "TypeBool", - "description": "Indicates ssl is required for the connection.", - "computed": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "Type of connection being described.", - "computed": true - } - } - }, - { - "name": "bi_connector", + "name": "ops_manager", "type": "TypeList", "computed": true, "elem": { @@ -22895,16 +23221,6 @@ } } }, - { - "name": "deployment_id", - "type": "TypeString", - "description": "Deployment ID.", - "cloud_data_type": "cloud-database", - "required": true, - "cloud_data_range": [ - "resolved_to:id" - ] - }, { "name": "certificate_root", "type": "TypeString", @@ -22912,7 +23228,7 @@ "optional": true }, { - "name": "postgres", + "name": "rediss", "type": "TypeList", "computed": true, "elem": { @@ -22977,8 +23293,8 @@ }, "database": { "name": "database", - "type": "TypeString", - "description": "Name of the database to use in the URI connection.", + "type": "TypeInt", + "description": "Number of the database to use in the URI connection.", "computed": true }, "hosts": { @@ -23154,79 +23470,7 @@ } }, { - "name": "endpoint_type", - "type": "TypeString", - "description": "Endpoint Type. The endpoint must be enabled on the deployment before its connection information can be fetched.", - "required": true, - "options": "public, private, public-and-private" - }, - { - "name": "cli", - "type": "TypeList", - "description": "CLI Connection.", - "computed": true, - "elem": { - "arguments": { - "name": "arguments", - "type": "TypeList", - "description": "Sets of arguments to call the executable with. The outer array corresponds to a possible way to call the CLI; the inner array is the set of arguments to use with that call.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "bin": { - "name": "bin", - "type": "TypeString", - "description": "The name of the executable the CLI should run.", - "computed": true - }, - "certificate": { - "name": "certificate", - "type": "TypeList", - "computed": true, - "elem": { - "certificate_base64": { - "name": "certificate_base64", - "type": "TypeString", - "description": "Base64 encoded version of the certificate.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Name associated with the certificate.", - "computed": true - } - } - }, - "composed": { - "name": "composed", - "type": "TypeList", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "environment": { - "name": "environment", - "type": "TypeMap", - "description": "A map of environment variables for a CLI connection.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "Type of connection being described.", - "computed": true - } - } - }, - { - "name": "amqps", + "name": "analytics", "type": "TypeList", "computed": true, "elem": { @@ -23362,6 +23606,15 @@ } ], "ibm_database_remotes": [ + { + "name": "replicas", + "type": "TypeList", + "description": "Replica IDs, if applicable.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, { "name": "deployment_id", "type": "TypeString", @@ -23377,18 +23630,15 @@ "type": "TypeString", "description": "Leader ID, if applicable.", "computed": true - }, - { - "name": "replicas", - "type": "TypeList", - "description": "Replica IDs, if applicable.", - "computed": true, - "elem": { - "type": "TypeString" - } } ], "ibm_database_task": [ + { + "name": "task_id", + "type": "TypeString", + "description": "Task ID.", + "required": true + }, { "name": "description", "type": "TypeString", @@ -23418,12 +23668,6 @@ "type": "TypeString", "description": "Date and time when the task was created.", "computed": true - }, - { - "name": "task_id", - "type": "TypeString", - "description": "Task ID.", - "required": true } ], "ibm_database_tasks": [ @@ -23495,9 +23739,15 @@ "computed": true }, { - "name": "ge", + "name": "created_at", + "type": "TypeString", + "description": "The date and time of the export route filter was created", + "computed": true + }, + { + "name": "le", "type": "TypeInt", - "description": "The minimum matching length of the prefix-set", + "description": "The maximum matching length of the prefix-set", "computed": true }, { @@ -23525,15 +23775,9 @@ "computed": true }, { - "name": "created_at", - "type": "TypeString", - "description": "The date and time of the export route filter was created", - "computed": true - }, - { - "name": "le", + "name": "ge", "type": "TypeInt", - "description": "The maximum matching length of the prefix-set", + "description": "The minimum matching length of the prefix-set", "computed": true } ], @@ -23603,6 +23847,18 @@ } ], "ibm_dl_gateway": [ + { + "name": "global", + "type": "TypeBool", + "description": "Gateways with global routing (true) can connect to networks outside their associated region", + "computed": true + }, + { + "name": "type", + "type": "TypeString", + "description": "Gateway type", + "computed": true + }, { "name": "as_prepends", "type": "TypeList", @@ -23663,9 +23919,15 @@ "computed": true }, { - "name": "bgp_ibm_asn", - "type": "TypeInt", - "description": "IBM BGP ASN", + "name": "created_at", + "type": "TypeString", + "description": "The date and time resource was created", + "computed": true + }, + { + "name": "bfd_status", + "type": "TypeString", + "description": "BFD Status", "computed": true }, { @@ -23675,71 +23937,115 @@ "computed": true }, { - "name": "bfd_interval", - "type": "TypeInt", - "description": "BFD Interval", + "name": "port", + "type": "TypeString", + "description": "Gateway port", "computed": true }, { - "name": "bfd_status", + "name": "link_status_updated_at", "type": "TypeString", - "description": "BFD Status", + "description": "Date and time Link status was updated", + "optional": true, "computed": true }, { - "name": "bgp_asn", - "type": "TypeInt", - "description": "BGP ASN", + "name": "metered", + "type": "TypeBool", + "description": "Metered billing option", "computed": true }, { - "name": "bgp_cer_cidr", + "name": "resource_group", "type": "TypeString", - "description": "BGP customer edge router CIDR", + "description": "Gateway resource group", + "cloud_data_type": "resource_group", "computed": true }, { - "name": "crn", - "type": "TypeString", - "description": "The CRN (Cloud Resource Name) of this gateway", - "cloud_data_type": "crn", + "name": "vlan", + "type": "TypeInt", + "description": "VLAN allocated for this gateway", "computed": true }, { - "name": "cross_connect_router", - "type": "TypeString", - "description": "Cross connect router", - "computed": true + "name": "gateway_vcs", + "type": "TypeList", + "description": "Collection of direct link gateway virtual connections", + "computed": true, + "elem": { + "created_at": { + "name": "created_at", + "type": "TypeString", + "description": "The date and time resource was created", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this virtual connection", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The user-defined name for this virtual connection. Virtualconnection names are unique within a gateway. This is the name of thevirtual connection itself, the network being connected may have its ownname attribute", + "computed": true + }, + "network_account": { + "name": "network_account", + "type": "TypeString", + "description": "For virtual connections across two different IBM Cloud Accounts network_account indicates the account that owns the target network.", + "computed": true + }, + "network_id": { + "name": "network_id", + "type": "TypeString", + "description": "Unique identifier of the target network. For type=vpc virtual connections this is the CRN of the target VPC. This field does not apply to type=classic connections.", + "computed": true + }, + "status": { + "name": "status", + "type": "TypeString", + "description": "Status of the virtual connection.Possible values: [pending,attached,approval_pending,rejected,expired,deleting,detached_by_network_pending,detached_by_network]", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "The type of virtual connection. (classic,vpc)", + "computed": true + } + } }, { - "name": "default_export_route_filter", - "type": "TypeString", - "description": "The default directional route filter action that applies to routes that do not match any directional route filters", + "name": "bfd_multiplier", + "type": "TypeInt", + "description": "BFD Multiplier", "computed": true }, { - "name": "default_import_route_filter", + "name": "link_status", "type": "TypeString", - "description": "The default directional route filter action that applies to routes that do not match any directional route filters", + "description": "Gateway link status", "computed": true }, { - "name": "completion_notice_reject_reason", + "name": "operational_status", "type": "TypeString", - "description": "Reason for completion notice rejection", + "description": "Gateway operational status", "computed": true }, { - "name": "bfd_multiplier", + "name": "bgp_ibm_asn", "type": "TypeInt", - "description": "BFD Multiplier", + "description": "IBM BGP ASN", "computed": true }, { - "name": "bgp_status_updated_at", + "name": "bgp_status", "type": "TypeString", - "description": "Date and time BGP status was updated", - "optional": true, + "description": "Gateway BGP status", "computed": true }, { @@ -23823,57 +24129,40 @@ } }, { - "name": "speed_mbps", - "type": "TypeInt", - "description": "Gateway speed in megabits per second", + "name": "location_display_name", + "type": "TypeString", + "description": "Gateway location long name", "computed": true }, { - "name": "vlan", - "type": "TypeInt", - "description": "VLAN allocated for this gateway", + "name": "provider_api_managed", + "type": "TypeBool", + "description": "Indicates whether gateway was created through a provider portal", "computed": true }, { - "name": "name", - "type": "TypeString", - "description": "The unique user-defined name for this gateway", - "required": true - }, - { - "name": "authentication_key", + "name": "bfd_status_updated_at", "type": "TypeString", - "description": "BGP MD5 authentication key", + "description": "BFD Status", "computed": true }, { - "name": "connection_mode", + "name": "crn", "type": "TypeString", - "description": "Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway Service and direct means this Gateway will be attached to vpc or classic connection", - "computed": true - }, - { - "name": "global", - "type": "TypeBool", - "description": "Gateways with global routing (true) can connect to networks outside their associated region", - "computed": true - }, - { - "name": "metered", - "type": "TypeBool", - "description": "Metered billing option", + "description": "The CRN (Cloud Resource Name) of this gateway", + "cloud_data_type": "crn", "computed": true }, { - "name": "operational_status", + "name": "cross_connect_router", "type": "TypeString", - "description": "Gateway operational status", + "description": "Cross connect router", "computed": true }, { - "name": "bgp_status", + "name": "authentication_key", "type": "TypeString", - "description": "Gateway BGP status", + "description": "BGP MD5 authentication key", "computed": true }, { @@ -23883,115 +24172,70 @@ "computed": true }, { - "name": "type", + "name": "completion_notice_reject_reason", "type": "TypeString", - "description": "Gateway type", + "description": "Reason for completion notice rejection", "computed": true }, { - "name": "gateway_vcs", - "type": "TypeList", - "description": "Collection of direct link gateway virtual connections", - "computed": true, - "elem": { - "created_at": { - "name": "created_at", - "type": "TypeString", - "description": "The date and time resource was created", - "computed": true - }, - "id": { - "name": "id", - "type": "TypeString", - "description": "The unique identifier for this virtual connection", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "The user-defined name for this virtual connection. Virtualconnection names are unique within a gateway. This is the name of thevirtual connection itself, the network being connected may have its ownname attribute", - "computed": true - }, - "network_account": { - "name": "network_account", - "type": "TypeString", - "description": "For virtual connections across two different IBM Cloud Accounts network_account indicates the account that owns the target network.", - "computed": true - }, - "network_id": { - "name": "network_id", - "type": "TypeString", - "description": "Unique identifier of the target network. For type=vpc virtual connections this is the CRN of the target VPC. This field does not apply to type=classic connections.", - "computed": true - }, - "status": { - "name": "status", - "type": "TypeString", - "description": "Status of the virtual connection.Possible values: [pending,attached,approval_pending,rejected,expired,deleting,detached_by_network_pending,detached_by_network]", - "computed": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "The type of virtual connection. (classic,vpc)", - "computed": true - } - } + "name": "bfd_interval", + "type": "TypeInt", + "description": "BFD Interval", + "computed": true }, { - "name": "bfd_status_updated_at", + "name": "bgp_cer_cidr", "type": "TypeString", - "description": "BFD Status", + "description": "BGP customer edge router CIDR", "computed": true }, { - "name": "created_at", + "name": "bgp_status_updated_at", "type": "TypeString", - "description": "The date and time resource was created", + "description": "Date and time BGP status was updated", + "optional": true, "computed": true }, { - "name": "link_status", + "name": "connection_mode", "type": "TypeString", - "description": "Gateway link status", + "description": "Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway Service and direct means this Gateway will be attached to vpc or classic connection", "computed": true }, { - "name": "port", - "type": "TypeString", - "description": "Gateway port", + "name": "speed_mbps", + "type": "TypeInt", + "description": "Gateway speed in megabits per second", "computed": true }, { - "name": "link_status_updated_at", + "name": "name", "type": "TypeString", - "description": "Date and time Link status was updated", - "optional": true, - "computed": true + "description": "The unique user-defined name for this gateway", + "required": true }, { - "name": "location_display_name", + "name": "default_export_route_filter", "type": "TypeString", - "description": "Gateway location long name", + "description": "The default directional route filter action that applies to routes that do not match any directional route filters", "computed": true }, { - "name": "location_name", + "name": "default_import_route_filter", "type": "TypeString", - "description": "Gateway location", + "description": "The default directional route filter action that applies to routes that do not match any directional route filters", "computed": true }, { - "name": "provider_api_managed", - "type": "TypeBool", - "description": "Indicates whether gateway was created through a provider portal", + "name": "bgp_asn", + "type": "TypeInt", + "description": "BGP ASN", "computed": true }, { - "name": "resource_group", + "name": "location_name", "type": "TypeString", - "description": "Gateway resource group", - "cloud_data_type": "resource_group", + "description": "Gateway location", "computed": true } ], @@ -24366,21 +24610,27 @@ "required": true }, { - "name": "action", + "name": "before", "type": "TypeString", - "description": "Determines whether the routes that match the prefix-set will be permit or deny", + "description": "Identifier of the next route filter to be considered", "computed": true }, { - "name": "ge", + "name": "le", "type": "TypeInt", - "description": "The minimum matching length of the prefix-set", + "description": "The maximum matching length of the prefix-set", "computed": true }, { - "name": "before", + "name": "updated_at", "type": "TypeString", - "description": "Identifier of the next route filter to be considered", + "description": "The date and time of the import route filter was last updated", + "computed": true + }, + { + "name": "action", + "type": "TypeString", + "description": "Determines whether the routes that match the prefix-set will be permit or deny", "computed": true }, { @@ -24390,9 +24640,9 @@ "computed": true }, { - "name": "le", + "name": "ge", "type": "TypeInt", - "description": "The maximum matching length of the prefix-set", + "description": "The minimum matching length of the prefix-set", "computed": true }, { @@ -24400,12 +24650,6 @@ "type": "TypeString", "description": "IP prefix representing an address and mask length of the prefix-set", "computed": true - }, - { - "name": "updated_at", - "type": "TypeString", - "description": "The date and time of the import route filter was last updated", - "computed": true } ], "ibm_dl_import_route_filters": [ @@ -24474,6 +24718,12 @@ } ], "ibm_dl_locations": [ + { + "name": "offering_type", + "type": "TypeString", + "description": "The Direct Link offering type. Current supported values (dedicated and connect).", + "required": true + }, { "name": "locations", "type": "TypeList", @@ -24553,12 +24803,6 @@ "computed": true } } - }, - { - "name": "offering_type", - "type": "TypeString", - "description": "The Direct Link offering type. Current supported values (dedicated and connect).", - "required": true } ], "ibm_dl_offering_speeds": [ @@ -24600,12 +24844,6 @@ } ], "ibm_dl_port": [ - { - "name": "port_id", - "type": "TypeString", - "description": "Port ID", - "required": true - }, { "name": "direct_link_count", "type": "TypeInt", @@ -24644,6 +24882,12 @@ "elem": { "type": "TypeInt" } + }, + { + "name": "port_id", + "type": "TypeString", + "description": "Port ID", + "required": true } ], "ibm_dl_ports": [ @@ -24875,85 +25119,6 @@ } ], "ibm_dl_route_report": [ - { - "name": "status", - "type": "TypeString", - "description": "Route report status", - "computed": true - }, - { - "name": "created_at", - "type": "TypeString", - "description": "The date and time report was created", - "computed": true - }, - { - "name": "route_report", - "type": "TypeString", - "description": "Id of the route report", - "immutable": true, - "required": true - }, - { - "name": "on_prem_routes", - "type": "TypeList", - "description": "List of onprem routes", - "computed": true, - "elem": { - "as_path": { - "name": "as_path", - "type": "TypeString", - "description": "The BGP AS path of the route", - "computed": true - }, - "next_hop": { - "name": "next_hop", - "type": "TypeString", - "description": "Next Hop address", - "computed": true - }, - "prefix": { - "name": "prefix", - "type": "TypeString", - "description": "Prefix for onprem routes", - "computed": true - } - } - }, - { - "name": "overlapping_routes", - "type": "TypeList", - "description": "List of overlapping routes", - "computed": true, - "elem": { - "routes": { - "name": "routes", - "type": "TypeList", - "description": "overlapping routes", - "computed": true, - "elem": { - "prefix": { - "name": "prefix", - "type": "TypeString", - "description": "Prefix for overlapping routes", - "computed": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "Type of route", - "computed": true - }, - "virtual_connection_id": { - "name": "virtual_connection_id", - "type": "TypeString", - "description": "Virtual connection ID", - "computed": true - } - } - } - } - }, { "name": "virtual_connection_routes", "type": "TypeList", @@ -25007,16 +25172,48 @@ } }, { - "name": "gateway", + "name": "status", "type": "TypeString", - "description": "The Direct Link gateway identifier", + "description": "Route report status", + "computed": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "The date and time report was created", + "computed": true + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "The date and time resource was created", + "computed": true + }, + { + "name": "route_report", + "type": "TypeString", + "description": "Id of the route report", "immutable": true, "required": true }, { - "name": "advertised_routes", + "name": "gateway_routes", "type": "TypeList", - "description": "List of connection prefixes advertised to the on-prem network", + "description": "List of gateway routes", + "computed": true, + "elem": { + "prefix": { + "name": "prefix", + "type": "TypeString", + "description": "Prefix for gateway routes", + "computed": true + } + } + }, + { + "name": "on_prem_routes", + "type": "TypeList", + "description": "List of onprem routes", "computed": true, "elem": { "as_path": { @@ -25025,20 +25222,39 @@ "description": "The BGP AS path of the route", "computed": true }, + "next_hop": { + "name": "next_hop", + "type": "TypeString", + "description": "Next Hop address", + "computed": true + }, "prefix": { "name": "prefix", "type": "TypeString", - "description": "Prefix for gateway routes", + "description": "Prefix for onprem routes", "computed": true } } }, { - "name": "gateway_routes", + "name": "gateway", + "type": "TypeString", + "description": "The Direct Link gateway identifier", + "immutable": true, + "required": true + }, + { + "name": "advertised_routes", "type": "TypeList", - "description": "List of gateway routes", + "description": "List of connection prefixes advertised to the on-prem network", "computed": true, "elem": { + "as_path": { + "name": "as_path", + "type": "TypeString", + "description": "The BGP AS path of the route", + "computed": true + }, "prefix": { "name": "prefix", "type": "TypeString", @@ -25048,10 +25264,38 @@ } }, { - "name": "updated_at", - "type": "TypeString", - "description": "The date and time resource was created", - "computed": true + "name": "overlapping_routes", + "type": "TypeList", + "description": "List of overlapping routes", + "computed": true, + "elem": { + "routes": { + "name": "routes", + "type": "TypeList", + "description": "overlapping routes", + "computed": true, + "elem": { + "prefix": { + "name": "prefix", + "type": "TypeString", + "description": "Prefix for overlapping routes", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "Type of route", + "computed": true + }, + "virtual_connection_id": { + "name": "virtual_connection_id", + "type": "TypeString", + "description": "Virtual connection ID", + "computed": true + } + } + } + } } ], "ibm_dl_route_reports": [ @@ -25242,13 +25486,6 @@ } ], "ibm_dl_routers": [ - { - "name": "offering_type", - "type": "TypeString", - "description": "The Direct Link offering type", - "required": true, - "options": "dedicated" - }, { "name": "location_name", "type": "TypeString", @@ -25283,19 +25520,16 @@ "computed": true } } - } - ], - "ibm_dns_custom_resolver_forwarding_rules": [ + }, { - "name": "instance_id", + "name": "offering_type", "type": "TypeString", - "description": "The unique identifier of a service instance.", - "cloud_data_type": "resource_instance", + "description": "The Direct Link offering type", "required": true, - "cloud_data_range": [ - "service:dns-svcs" - ] - }, + "options": "dedicated" + } + ], + "ibm_dns_custom_resolver_forwarding_rules": [ { "name": "resolver_id", "type": "TypeString", @@ -25341,6 +25575,16 @@ "computed": true } } + }, + { + "name": "instance_id", + "type": "TypeString", + "description": "The unique identifier of a service instance.", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:dns-svcs" + ] } ], "ibm_dns_custom_resolver_secondary_zones": [ @@ -25533,16 +25777,6 @@ } ], "ibm_dns_glb_monitors": [ - { - "name": "instance_id", - "type": "TypeString", - "description": "The GUID of the private DNS.", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:dns-svcs" - ] - }, { "name": "dns_glb_monitors", "type": "TypeList", @@ -25640,6 +25874,16 @@ "computed": true } } + }, + { + "name": "instance_id", + "type": "TypeString", + "description": "The GUID of the private DNS.", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:dns-svcs" + ] } ], "ibm_dns_glb_pools": [ @@ -25894,6 +26138,22 @@ } ], "ibm_dns_permitted_networks": [ + { + "name": "instance_id", + "type": "TypeString", + "description": "Instance ID", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:dns-svcs" + ] + }, + { + "name": "zone_id", + "type": "TypeString", + "description": "Zone ID", + "required": true + }, { "name": "dns_permitted_networks", "type": "TypeList", @@ -25949,22 +26209,6 @@ "computed": true } } - }, - { - "name": "instance_id", - "type": "TypeString", - "description": "Instance ID", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:dns-svcs" - ] - }, - { - "name": "zone_id", - "type": "TypeString", - "description": "Zone ID", - "required": true } ], "ibm_dns_resource_records": [ @@ -26024,6 +26268,17 @@ } ], "ibm_dns_secondary": [ + { + "name": "zone_name", + "type": "TypeString", + "description": "The name of the secondary", + "required": true + }, + { + "name": "master_ip_address", + "type": "TypeString", + "computed": true + }, { "name": "transfer_frequency", "type": "TypeInt", @@ -26038,17 +26293,6 @@ "name": "status_text", "type": "TypeString", "computed": true - }, - { - "name": "zone_name", - "type": "TypeString", - "description": "The name of the secondary", - "required": true - }, - { - "name": "master_ip_address", - "type": "TypeString", - "computed": true } ], "ibm_dns_zones": [ @@ -26121,11 +26365,26 @@ ], "ibm_en_destination_android": [ { - "name": "subscription_count", - "type": "TypeInt", - "description": "Number of subscriptions.", + "name": "name", + "type": "TypeString", + "description": "Destination name.", + "computed": true + }, + { + "name": "type", + "type": "TypeString", + "description": "Destination type push_android.", "computed": true }, + { + "name": "subscription_names", + "type": "TypeList", + "description": "List of subscriptions.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, { "name": "instance_guid", "type": "TypeString", @@ -26133,15 +26392,15 @@ "required": true }, { - "name": "description", + "name": "destination_id", "type": "TypeString", - "description": "Destination description.", - "computed": true + "description": "Unique identifier for Destination.", + "required": true }, { - "name": "type", + "name": "description", "type": "TypeString", - "description": "Destination type push_android.", + "description": "Destination description.", "computed": true }, { @@ -26189,62 +26448,14 @@ "description": "Last updated time.", "computed": true }, - { - "name": "subscription_names", - "type": "TypeList", - "description": "List of subscriptions.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "destination_id", - "type": "TypeString", - "description": "Unique identifier for Destination.", - "required": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Destination name.", - "computed": true - } - ], - "ibm_en_destination_ce": [ - { - "name": "destination_id", - "type": "TypeString", - "description": "Unique identifier for Destination.", - "required": true - }, - { - "name": "description", - "type": "TypeString", - "description": "Destination description.", - "computed": true - }, - { - "name": "type", - "type": "TypeString", - "description": "Destination type Webhook.", - "computed": true - }, - { - "name": "subscription_names", - "type": "TypeList", - "description": "List of subscriptions.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, { "name": "subscription_count", "type": "TypeInt", "description": "Number of subscriptions.", "computed": true - }, + } + ], + "ibm_en_destination_ce": [ { "name": "instance_guid", "type": "TypeString", @@ -26257,6 +26468,12 @@ "description": "Destination name.", "computed": true }, + { + "name": "description", + "type": "TypeString", + "description": "Destination description.", + "computed": true + }, { "name": "config", "type": "TypeList", @@ -26302,6 +26519,33 @@ } } }, + { + "name": "subscription_count", + "type": "TypeInt", + "description": "Number of subscriptions.", + "computed": true + }, + { + "name": "subscription_names", + "type": "TypeList", + "description": "List of subscriptions.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "destination_id", + "type": "TypeString", + "description": "Unique identifier for Destination.", + "required": true + }, + { + "name": "type", + "type": "TypeString", + "description": "Destination type Webhook.", + "computed": true + }, { "name": "updated_at", "type": "TypeString", @@ -26310,6 +26554,33 @@ } ], "ibm_en_destination_cf": [ + { + "name": "name", + "type": "TypeString", + "description": "Destination name.", + "computed": true + }, + { + "name": "subscription_names", + "type": "TypeList", + "description": "List of subscriptions.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "subscription_count", + "type": "TypeInt", + "description": "Number of subscriptions.", + "computed": true + }, + { + "name": "instance_guid", + "type": "TypeString", + "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "required": true + }, { "name": "destination_id", "type": "TypeString", @@ -26360,75 +26631,9 @@ "type": "TypeString", "description": "Last updated time.", "computed": true - }, - { - "name": "instance_guid", - "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", - "required": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Destination name.", - "computed": true - }, - { - "name": "subscription_count", - "type": "TypeInt", - "description": "Number of subscriptions.", - "computed": true - }, - { - "name": "subscription_names", - "type": "TypeList", - "description": "List of subscriptions.", - "computed": true, - "elem": { - "type": "TypeString" - } } ], "ibm_en_destination_chrome": [ - { - "name": "name", - "type": "TypeString", - "description": "Destination name.", - "computed": true - }, - { - "name": "updated_at", - "type": "TypeString", - "description": "Last updated time.", - "computed": true - }, - { - "name": "subscription_count", - "type": "TypeInt", - "description": "Number of subscriptions.", - "computed": true - }, - { - "name": "subscription_names", - "type": "TypeList", - "description": "List of subscriptions.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "instance_guid", - "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", - "required": true - }, - { - "name": "destination_id", - "type": "TypeString", - "description": "Unique identifier for Destination.", - "required": true - }, { "name": "config", "type": "TypeList", @@ -26464,19 +26669,11 @@ } }, { - "name": "description", - "type": "TypeString", - "description": "Destination description.", + "name": "subscription_count", + "type": "TypeInt", + "description": "Number of subscriptions.", "computed": true }, - { - "name": "type", - "type": "TypeString", - "description": "Destination type push_chrome.", - "computed": true - } - ], - "ibm_en_destination_cos": [ { "name": "subscription_names", "type": "TypeList", @@ -26486,16 +26683,54 @@ "type": "TypeString" } }, + { + "name": "instance_guid", + "type": "TypeString", + "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "required": true + }, + { + "name": "destination_id", + "type": "TypeString", + "description": "Unique identifier for Destination.", + "required": true + }, { "name": "name", "type": "TypeString", "description": "Destination name.", "computed": true }, + { + "name": "description", + "type": "TypeString", + "description": "Destination description.", + "computed": true + }, { "name": "type", "type": "TypeString", - "description": "Destination type ibmcf.", + "description": "Destination type push_chrome.", + "computed": true + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Last updated time.", + "computed": true + } + ], + "ibm_en_destination_cos": [ + { + "name": "destination_id", + "type": "TypeString", + "description": "Unique identifier for Destination.", + "required": true + }, + { + "name": "name", + "type": "TypeString", + "description": "Destination name.", "computed": true }, { @@ -26531,43 +26766,20 @@ } } }, - { - "name": "subscription_count", - "type": "TypeInt", - "description": "Number of subscriptions.", - "computed": true - }, - { - "name": "instance_guid", - "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", - "required": true - }, - { - "name": "destination_id", - "type": "TypeString", - "description": "Unique identifier for Destination.", - "required": true - }, - { - "name": "description", - "type": "TypeString", - "description": "Destination description.", - "computed": true - }, { "name": "updated_at", "type": "TypeString", "description": "Last updated time.", "computed": true - } - ], - "ibm_en_destination_firefox": [ + }, { - "name": "updated_at", - "type": "TypeString", - "description": "Last updated time.", - "computed": true + "name": "subscription_names", + "type": "TypeList", + "description": "List of subscriptions.", + "computed": true, + "elem": { + "type": "TypeString" + } }, { "name": "instance_guid", @@ -26575,18 +26787,6 @@ "description": "Unique identifier for IBM Cloud Event Notifications instance.", "required": true }, - { - "name": "destination_id", - "type": "TypeString", - "description": "Unique identifier for Destination.", - "required": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Destination name.", - "computed": true - }, { "name": "description", "type": "TypeString", @@ -26596,9 +26796,17 @@ { "name": "type", "type": "TypeString", - "description": "Destination type push_firefox.", + "description": "Destination type ibmcf.", "computed": true }, + { + "name": "subscription_count", + "type": "TypeInt", + "description": "Number of subscriptions.", + "computed": true + } + ], + "ibm_en_destination_firefox": [ { "name": "config", "type": "TypeList", @@ -26627,9 +26835,9 @@ } }, { - "name": "subscription_count", - "type": "TypeInt", - "description": "Number of subscriptions.", + "name": "updated_at", + "type": "TypeString", + "description": "Last updated time.", "computed": true }, { @@ -26640,6 +26848,42 @@ "elem": { "type": "TypeString" } + }, + { + "name": "name", + "type": "TypeString", + "description": "Destination name.", + "computed": true + }, + { + "name": "description", + "type": "TypeString", + "description": "Destination description.", + "computed": true + }, + { + "name": "type", + "type": "TypeString", + "description": "Destination type push_firefox.", + "computed": true + }, + { + "name": "subscription_count", + "type": "TypeInt", + "description": "Number of subscriptions.", + "computed": true + }, + { + "name": "instance_guid", + "type": "TypeString", + "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "required": true + }, + { + "name": "destination_id", + "type": "TypeString", + "description": "Unique identifier for Destination.", + "required": true } ], "ibm_en_destination_huawei": [ @@ -26677,24 +26921,15 @@ } }, { - "name": "subscription_count", - "type": "TypeInt", - "description": "Number of subscriptions.", + "name": "updated_at", + "type": "TypeString", + "description": "Last updated time.", "computed": true }, { - "name": "subscription_names", - "type": "TypeList", - "description": "List of subscriptions.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "instance_guid", + "name": "destination_id", "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "description": "Unique identifier for Destination.", "required": true }, { @@ -26716,23 +26951,32 @@ "computed": true }, { - "name": "updated_at", - "type": "TypeString", - "description": "Last updated time.", + "name": "subscription_count", + "type": "TypeInt", + "description": "Number of subscriptions.", "computed": true }, { - "name": "destination_id", + "name": "subscription_names", + "type": "TypeList", + "description": "List of subscriptions.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "instance_guid", "type": "TypeString", - "description": "Unique identifier for Destination.", + "description": "Unique identifier for IBM Cloud Event Notifications instance.", "required": true } ], "ibm_en_destination_ios": [ { - "name": "certificate_content_type", + "name": "certificate", "type": "TypeString", - "description": "The Certificate Content Type to be set p8/p12.", + "description": "The Certificate File.", "computed": true }, { @@ -26751,10 +26995,10 @@ } }, { - "name": "instance_guid", + "name": "description", "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", - "required": true + "description": "Destination description.", + "computed": true }, { "name": "destination_id", @@ -26768,12 +27012,6 @@ "description": "Destination name.", "computed": true }, - { - "name": "description", - "type": "TypeString", - "description": "Destination description.", - "computed": true - }, { "name": "type", "type": "TypeString", @@ -26781,9 +27019,9 @@ "computed": true }, { - "name": "certificate", + "name": "certificate_content_type", "type": "TypeString", - "description": "The Certificate File.", + "description": "The Certificate Content Type to be set p8/p12.", "computed": true }, { @@ -26848,45 +27086,21 @@ "type": "TypeInt", "description": "Number of subscriptions.", "computed": true - } - ], - "ibm_en_destination_msteams": [ + }, { "name": "instance_guid", "type": "TypeString", "description": "Unique identifier for IBM Cloud Event Notifications instance.", "required": true - }, - { - "name": "destination_id", - "type": "TypeString", - "description": "Unique identifier for Destination.", - "required": true - }, + } + ], + "ibm_en_destination_msteams": [ { "name": "description", "type": "TypeString", "description": "Destination description.", "computed": true }, - { - "name": "updated_at", - "type": "TypeString", - "description": "Last updated time.", - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Destination name.", - "computed": true - }, - { - "name": "type", - "type": "TypeString", - "description": "Destination type msteams.", - "computed": true - }, { "name": "config", "type": "TypeList", @@ -26922,15 +27136,39 @@ "elem": { "type": "TypeString" } - } - ], - "ibm_en_destination_pagerduty": [ + }, { "name": "updated_at", "type": "TypeString", "description": "Last updated time.", "computed": true }, + { + "name": "instance_guid", + "type": "TypeString", + "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "required": true + }, + { + "name": "destination_id", + "type": "TypeString", + "description": "Unique identifier for Destination.", + "required": true + }, + { + "name": "name", + "type": "TypeString", + "description": "Destination name.", + "computed": true + }, + { + "name": "type", + "type": "TypeString", + "description": "Destination type msteams.", + "computed": true + } + ], + "ibm_en_destination_pagerduty": [ { "name": "subscription_count", "type": "TypeInt", @@ -26938,13 +27176,10 @@ "computed": true }, { - "name": "subscription_names", - "type": "TypeList", - "description": "List of subscriptions.", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "description", + "type": "TypeString", + "description": "Destination description.", + "computed": true }, { "name": "destination_id", @@ -26953,15 +27188,15 @@ "required": true }, { - "name": "type", + "name": "name", "type": "TypeString", - "description": "Destination type push_chrome.", + "description": "Destination name.", "computed": true }, { - "name": "description", + "name": "type", "type": "TypeString", - "description": "Destination description.", + "description": "Destination type push_chrome.", "computed": true }, { @@ -26991,62 +27226,12 @@ } } }, - { - "name": "instance_guid", - "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", - "required": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Destination name.", - "computed": true - } - ], - "ibm_en_destination_safari": [ - { - "name": "destination_id", - "type": "TypeString", - "description": "Unique identifier for Destination.", - "required": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Destination name.", - "computed": true - }, - { - "name": "description", - "type": "TypeString", - "description": "Destination description.", - "computed": true - }, - { - "name": "type", - "type": "TypeString", - "description": "Destination type push_ios.", - "computed": true - }, - { - "name": "instance_guid", - "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", - "required": true - }, { "name": "updated_at", "type": "TypeString", "description": "Last updated time.", "computed": true }, - { - "name": "subscription_count", - "type": "TypeInt", - "description": "Number of subscriptions.", - "computed": true - }, { "name": "subscription_names", "type": "TypeList", @@ -27056,6 +27241,20 @@ "type": "TypeString" } }, + { + "name": "instance_guid", + "type": "TypeString", + "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "required": true + } + ], + "ibm_en_destination_safari": [ + { + "name": "type", + "type": "TypeString", + "description": "Destination type push_ios.", + "computed": true + }, { "name": "config", "type": "TypeList", @@ -27112,15 +27311,19 @@ } } } - } - ], - "ibm_en_destination_slack": [ + }, { "name": "updated_at", "type": "TypeString", "description": "Last updated time.", "computed": true }, + { + "name": "subscription_count", + "type": "TypeInt", + "description": "Number of subscriptions.", + "computed": true + }, { "name": "subscription_names", "type": "TypeList", @@ -27130,6 +27333,18 @@ "type": "TypeString" } }, + { + "name": "name", + "type": "TypeString", + "description": "Destination name.", + "computed": true + }, + { + "name": "destination_id", + "type": "TypeString", + "description": "Unique identifier for Destination.", + "required": true + }, { "name": "description", "type": "TypeString", @@ -27137,15 +27352,29 @@ "computed": true }, { - "name": "type", + "name": "instance_guid", "type": "TypeString", - "description": "Destination type slack.", + "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "required": true + } + ], + "ibm_en_destination_slack": [ + { + "name": "destination_id", + "type": "TypeString", + "description": "Unique identifier for Destination.", + "required": true + }, + { + "name": "description", + "type": "TypeString", + "description": "Destination description.", "computed": true }, { - "name": "name", + "name": "type", "type": "TypeString", - "description": "Destination name.", + "description": "Destination type slack.", "computed": true }, { @@ -27182,13 +27411,55 @@ "required": true }, { - "name": "destination_id", + "name": "name", "type": "TypeString", - "description": "Unique identifier for Destination.", - "required": true + "description": "Destination name.", + "computed": true + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Last updated time.", + "computed": true + }, + { + "name": "subscription_names", + "type": "TypeList", + "description": "List of subscriptions.", + "computed": true, + "elem": { + "type": "TypeString" + } } ], "ibm_en_destination_sn": [ + { + "name": "name", + "type": "TypeString", + "description": "Destination name.", + "computed": true + }, + { + "name": "type", + "type": "TypeString", + "description": "Destination type push_chrome.", + "computed": true + }, + { + "name": "subscription_names", + "type": "TypeList", + "description": "List of subscriptions.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "subscription_count", + "type": "TypeInt", + "description": "Number of subscriptions.", + "computed": true + }, { "name": "instance_guid", "type": "TypeString", @@ -27201,24 +27472,12 @@ "description": "Unique identifier for Destination.", "required": true }, - { - "name": "name", - "type": "TypeString", - "description": "Destination name.", - "computed": true - }, { "name": "description", "type": "TypeString", "description": "Destination description.", "computed": true }, - { - "name": "type", - "type": "TypeString", - "description": "Destination type push_chrome.", - "computed": true - }, { "name": "config", "type": "TypeList", @@ -27264,6 +27523,14 @@ } } }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Last updated time.", + "computed": true + } + ], + "ibm_en_destination_webhook": [ { "name": "subscription_count", "type": "TypeInt", @@ -27279,32 +27546,12 @@ "type": "TypeString" } }, - { - "name": "updated_at", - "type": "TypeString", - "description": "Last updated time.", - "computed": true - } - ], - "ibm_en_destination_webhook": [ - { - "name": "subscription_count", - "type": "TypeInt", - "description": "Number of subscriptions.", - "computed": true - }, { "name": "instance_guid", "type": "TypeString", "description": "Unique identifier for IBM Cloud Event Notifications instance.", "required": true }, - { - "name": "description", - "type": "TypeString", - "description": "Destination description.", - "computed": true - }, { "name": "type", "type": "TypeString", @@ -27356,6 +27603,12 @@ } } }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Last updated time.", + "computed": true + }, { "name": "destination_id", "type": "TypeString", @@ -27369,22 +27622,31 @@ "computed": true }, { - "name": "updated_at", + "name": "description", "type": "TypeString", - "description": "Last updated time.", + "description": "Destination description.", "computed": true - }, - { - "name": "subscription_names", - "type": "TypeList", - "description": "List of subscriptions.", - "computed": true, - "elem": { - "type": "TypeString" - } } ], "ibm_en_destinations": [ + { + "name": "instance_guid", + "type": "TypeString", + "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "required": true + }, + { + "name": "search_key", + "type": "TypeString", + "description": "Filter the destinations by name or type.", + "optional": true + }, + { + "name": "total_count", + "type": "TypeInt", + "description": "Total number of destinations.", + "computed": true + }, { "name": "destinations", "type": "TypeList", @@ -27437,24 +27699,6 @@ "computed": true } } - }, - { - "name": "instance_guid", - "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", - "required": true - }, - { - "name": "search_key", - "type": "TypeString", - "description": "Filter the destinations by name or type.", - "optional": true - }, - { - "name": "total_count", - "type": "TypeInt", - "description": "Total number of destinations.", - "computed": true } ], "ibm_en_integration": [ @@ -27632,6 +27876,18 @@ } ], "ibm_en_subscription_android": [ + { + "name": "instance_guid", + "type": "TypeString", + "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "required": true + }, + { + "name": "subscription_id", + "type": "TypeString", + "description": "Unique identifier for result.", + "required": true + }, { "name": "name", "type": "TypeString", @@ -27661,21 +27917,15 @@ "type": "TypeString", "description": "Last updated time.", "computed": true - }, - { - "name": "instance_guid", - "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", - "required": true - }, - { - "name": "subscription_id", - "type": "TypeString", - "description": "Unique identifier for result.", - "required": true } ], "ibm_en_subscription_ce": [ + { + "name": "updated_at", + "type": "TypeString", + "description": "Last updated time.", + "computed": true + }, { "name": "instance_guid", "type": "TypeString", @@ -27711,12 +27961,6 @@ "type": "TypeString", "description": "Topic ID.", "computed": true - }, - { - "name": "updated_at", - "type": "TypeString", - "description": "Last updated time.", - "computed": true } ], "ibm_en_subscription_cf": [ @@ -27852,24 +28096,6 @@ } ], "ibm_en_subscription_email": [ - { - "name": "updated_at", - "type": "TypeString", - "description": "Last updated time.", - "computed": true - }, - { - "name": "instance_guid", - "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", - "required": true - }, - { - "name": "subscription_id", - "type": "TypeString", - "description": "Unique identifier for result.", - "required": true - }, { "name": "name", "type": "TypeString", @@ -28000,6 +28226,24 @@ } } } + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Last updated time.", + "computed": true + }, + { + "name": "instance_guid", + "type": "TypeString", + "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "required": true + }, + { + "name": "subscription_id", + "type": "TypeString", + "description": "Unique identifier for result.", + "required": true } ], "ibm_en_subscription_firefox": [ @@ -28047,12 +28291,6 @@ } ], "ibm_en_subscription_huawei": [ - { - "name": "description", - "type": "TypeString", - "description": "Subscription description.", - "computed": true - }, { "name": "destination_id", "type": "TypeString", @@ -28071,26 +28309,6 @@ "description": "Last updated time.", "computed": true }, - { - "name": "instance_guid", - "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", - "required": true - }, - { - "name": "subscription_id", - "type": "TypeString", - "description": "Unique identifier for result.", - "required": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Subscription name.", - "computed": true - } - ], - "ibm_en_subscription_ios": [ { "name": "instance_guid", "type": "TypeString", @@ -28114,39 +28332,9 @@ "type": "TypeString", "description": "Subscription description.", "computed": true - }, - { - "name": "destination_id", - "type": "TypeString", - "description": "The destination ID.", - "computed": true - }, - { - "name": "topic_id", - "type": "TypeString", - "description": "Topic ID.", - "computed": true - }, - { - "name": "updated_at", - "type": "TypeString", - "description": "Last updated time.", - "computed": true } ], - "ibm_en_subscription_msteams": [ - { - "name": "topic_id", - "type": "TypeString", - "description": "Topic ID.", - "computed": true - }, - { - "name": "updated_at", - "type": "TypeString", - "description": "Last updated time.", - "computed": true - }, + "ibm_en_subscription_ios": [ { "name": "instance_guid", "type": "TypeString", @@ -28176,9 +28364,7 @@ "type": "TypeString", "description": "The destination ID.", "computed": true - } - ], - "ibm_en_subscription_pagerduty": [ + }, { "name": "topic_id", "type": "TypeString", @@ -28190,39 +28376,9 @@ "type": "TypeString", "description": "Last updated time.", "computed": true - }, - { - "name": "instance_guid", - "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", - "required": true - }, - { - "name": "subscription_id", - "type": "TypeString", - "description": "Unique identifier for result.", - "required": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Subscription name.", - "computed": true - }, - { - "name": "description", - "type": "TypeString", - "description": "Subscription description.", - "computed": true - }, - { - "name": "destination_id", - "type": "TypeString", - "description": "The destination ID.", - "computed": true } ], - "ibm_en_subscription_safari": [ + "ibm_en_subscription_msteams": [ { "name": "topic_id", "type": "TypeString", @@ -28266,26 +28422,7 @@ "computed": true } ], - "ibm_en_subscription_slack": [ - { - "name": "attributes", - "type": "TypeList", - "computed": true, - "elem": { - "attachment_color": { - "name": "attachment_color", - "type": "TypeString", - "description": "attachment color code", - "optional": true - } - } - }, - { - "name": "updated_at", - "type": "TypeString", - "description": "Last updated time.", - "computed": true - }, + "ibm_en_subscription_pagerduty": [ { "name": "instance_guid", "type": "TypeString", @@ -28321,108 +28458,15 @@ "type": "TypeString", "description": "Topic ID.", "computed": true - } - ], - "ibm_en_subscription_sms": [ - { - "name": "attributes", - "type": "TypeList", - "description": "The additional attributes", - "computed": true, - "elem": { - "invited": { - "name": "invited", - "type": "TypeList", - "description": "The phone number to send the SMS to.", - "computed": true, - "elem": { - "expires_at": { - "name": "expires_at", - "type": "TypeString", - "description": "The email address user name to reply to.", - "optional": true, - "computed": true - }, - "phone_number": { - "name": "phone_number", - "type": "TypeString", - "description": "The email address to reply to.", - "optional": true, - "computed": true - }, - "updated_at": { - "name": "updated_at", - "type": "TypeString", - "description": "The email address user name to reply to.", - "optional": true, - "computed": true - } - } - }, - "subscribed": { - "name": "subscribed", - "type": "TypeList", - "description": "The phone number to send the SMS to.", - "computed": true, - "elem": { - "phone_number": { - "name": "phone_number", - "type": "TypeString", - "description": "The email address to reply to.", - "optional": true, - "computed": true - }, - "updated_at": { - "name": "updated_at", - "type": "TypeString", - "description": "The email address user name to reply to.", - "optional": true, - "computed": true - } - } - }, - "unsubscribed": { - "name": "unsubscribed", - "type": "TypeList", - "description": "The phone number to send the SMS to.", - "computed": true, - "elem": { - "phone_number": { - "name": "phone_number", - "type": "TypeString", - "description": "The email address to reply to.", - "optional": true, - "computed": true - }, - "updated_at": { - "name": "updated_at", - "type": "TypeString", - "description": "The email address user name to reply to.", - "optional": true, - "computed": true - } - } - } - } }, { "name": "updated_at", "type": "TypeString", "description": "Last updated time.", "computed": true - }, - { - "name": "instance_guid", - "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", - "required": true - }, - { - "name": "subscription_id", - "type": "TypeString", - "description": "Unique identifier for result.", - "required": true - }, + } + ], + "ibm_en_subscription_safari": [ { "name": "name", "type": "TypeString", @@ -28446,15 +28490,209 @@ "type": "TypeString", "description": "Topic ID.", "computed": true + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Last updated time.", + "computed": true + }, + { + "name": "instance_guid", + "type": "TypeString", + "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "required": true + }, + { + "name": "subscription_id", + "type": "TypeString", + "description": "Unique identifier for result.", + "required": true } ], - "ibm_en_subscription_sn": [ + "ibm_en_subscription_slack": [ + { + "name": "destination_id", + "type": "TypeString", + "description": "The destination ID.", + "computed": true + }, + { + "name": "topic_id", + "type": "TypeString", + "description": "Topic ID.", + "computed": true + }, + { + "name": "attributes", + "type": "TypeList", + "computed": true, + "elem": { + "attachment_color": { + "name": "attachment_color", + "type": "TypeString", + "description": "attachment color code", + "optional": true + } + } + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Last updated time.", + "computed": true + }, + { + "name": "instance_guid", + "type": "TypeString", + "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "required": true + }, + { + "name": "subscription_id", + "type": "TypeString", + "description": "Unique identifier for result.", + "required": true + }, + { + "name": "name", + "type": "TypeString", + "description": "Subscription name.", + "computed": true + }, + { + "name": "description", + "type": "TypeString", + "description": "Subscription description.", + "computed": true + } + ], + "ibm_en_subscription_sms": [ { "name": "instance_guid", "type": "TypeString", "description": "Unique identifier for IBM Cloud Event Notifications instance.", "required": true }, + { + "name": "subscription_id", + "type": "TypeString", + "description": "Unique identifier for result.", + "required": true + }, + { + "name": "name", + "type": "TypeString", + "description": "Subscription name.", + "computed": true + }, + { + "name": "description", + "type": "TypeString", + "description": "Subscription description.", + "computed": true + }, + { + "name": "destination_id", + "type": "TypeString", + "description": "The destination ID.", + "computed": true + }, + { + "name": "topic_id", + "type": "TypeString", + "description": "Topic ID.", + "computed": true + }, + { + "name": "attributes", + "type": "TypeList", + "description": "The additional attributes", + "computed": true, + "elem": { + "invited": { + "name": "invited", + "type": "TypeList", + "description": "The phone number to send the SMS to.", + "computed": true, + "elem": { + "expires_at": { + "name": "expires_at", + "type": "TypeString", + "description": "The email address user name to reply to.", + "optional": true, + "computed": true + }, + "phone_number": { + "name": "phone_number", + "type": "TypeString", + "description": "The email address to reply to.", + "optional": true, + "computed": true + }, + "updated_at": { + "name": "updated_at", + "type": "TypeString", + "description": "The email address user name to reply to.", + "optional": true, + "computed": true + } + } + }, + "subscribed": { + "name": "subscribed", + "type": "TypeList", + "description": "The phone number to send the SMS to.", + "computed": true, + "elem": { + "phone_number": { + "name": "phone_number", + "type": "TypeString", + "description": "The email address to reply to.", + "optional": true, + "computed": true + }, + "updated_at": { + "name": "updated_at", + "type": "TypeString", + "description": "The email address user name to reply to.", + "optional": true, + "computed": true + } + } + }, + "unsubscribed": { + "name": "unsubscribed", + "type": "TypeList", + "description": "The phone number to send the SMS to.", + "computed": true, + "elem": { + "phone_number": { + "name": "phone_number", + "type": "TypeString", + "description": "The email address to reply to.", + "optional": true, + "computed": true + }, + "updated_at": { + "name": "updated_at", + "type": "TypeString", + "description": "The email address user name to reply to.", + "optional": true, + "computed": true + } + } + } + } + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Last updated time.", + "computed": true + } + ], + "ibm_en_subscription_sn": [ { "name": "subscription_id", "type": "TypeString", @@ -28490,9 +28728,21 @@ "type": "TypeString", "description": "Last updated time.", "computed": true + }, + { + "name": "instance_guid", + "type": "TypeString", + "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "required": true } ], "ibm_en_subscription_webhook": [ + { + "name": "destination_id", + "type": "TypeString", + "description": "The destination ID.", + "computed": true + }, { "name": "topic_id", "type": "TypeString", @@ -28550,15 +28800,21 @@ "type": "TypeString", "description": "Subscription description.", "computed": true - }, - { - "name": "destination_id", - "type": "TypeString", - "description": "The destination ID.", - "computed": true } ], "ibm_en_subscriptions": [ + { + "name": "instance_guid", + "type": "TypeString", + "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "required": true + }, + { + "name": "search_key", + "type": "TypeString", + "description": "Filter the subscriptions by name", + "optional": true + }, { "name": "total_count", "type": "TypeInt", @@ -28626,26 +28882,14 @@ "computed": true } } - }, - { - "name": "instance_guid", - "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", - "required": true - }, - { - "name": "search_key", - "type": "TypeString", - "description": "Filter the subscriptions by name", - "optional": true } ], "ibm_en_topic": [ { - "name": "instance_guid", + "name": "name", "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", - "required": true + "description": "Name of the topic.", + "computed": true }, { "name": "description", @@ -28653,74 +28897,6 @@ "description": "Description of the topic.", "computed": true }, - { - "name": "updated_at", - "type": "TypeString", - "description": "Last time the topic was updated.", - "computed": true - }, - { - "name": "subscriptions", - "type": "TypeList", - "description": "List of subscriptions.", - "computed": true, - "elem": { - "description": { - "name": "description", - "type": "TypeString", - "description": "Subscription description.", - "computed": true - }, - "destination_id": { - "name": "destination_id", - "type": "TypeString", - "description": "The destination ID.", - "computed": true - }, - "destination_type": { - "name": "destination_type", - "type": "TypeString", - "description": "The type of destination.", - "computed": true - }, - "id": { - "name": "id", - "type": "TypeString", - "description": "Subscription ID.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Subscription name.", - "computed": true - }, - "topic_id": { - "name": "topic_id", - "type": "TypeString", - "description": "Topic ID.", - "computed": true - }, - "updated_at": { - "name": "updated_at", - "type": "TypeString", - "description": "Last updated time.", - "computed": true - } - } - }, - { - "name": "topic_id", - "type": "TypeString", - "description": "Unique identifier for Topic.", - "required": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Name of the topic.", - "computed": true - }, { "name": "source_count", "type": "TypeInt", @@ -28790,9 +28966,63 @@ "type": "TypeInt", "description": "Number of subscriptions.", "computed": true - } - ], - "ibm_en_topics": [ + }, + { + "name": "subscriptions", + "type": "TypeList", + "description": "List of subscriptions.", + "computed": true, + "elem": { + "description": { + "name": "description", + "type": "TypeString", + "description": "Subscription description.", + "computed": true + }, + "destination_id": { + "name": "destination_id", + "type": "TypeString", + "description": "The destination ID.", + "computed": true + }, + "destination_type": { + "name": "destination_type", + "type": "TypeString", + "description": "The type of destination.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "Subscription ID.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Subscription name.", + "computed": true + }, + "topic_id": { + "name": "topic_id", + "type": "TypeString", + "description": "Topic ID.", + "computed": true + }, + "updated_at": { + "name": "updated_at", + "type": "TypeString", + "description": "Last updated time.", + "computed": true + } + } + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Last time the topic was updated.", + "computed": true + }, { "name": "instance_guid", "type": "TypeString", @@ -28800,11 +29030,13 @@ "required": true }, { - "name": "total_count", - "type": "TypeInt", - "description": "Number of topics.", - "computed": true - }, + "name": "topic_id", + "type": "TypeString", + "description": "Unique identifier for Topic.", + "required": true + } + ], + "ibm_en_topics": [ { "name": "search_key", "type": "TypeString", @@ -28857,6 +29089,18 @@ "computed": true } } + }, + { + "name": "instance_guid", + "type": "TypeString", + "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "required": true + }, + { + "name": "total_count", + "type": "TypeInt", + "description": "Number of topics.", + "computed": true } ], "ibm_enterprise_account_groups": [ @@ -28966,6 +29210,12 @@ } ], "ibm_enterprise_accounts": [ + { + "name": "name", + "type": "TypeString", + "description": "The name of the account.", + "optional": true + }, { "name": "accounts", "type": "TypeList", @@ -29075,15 +29325,15 @@ "computed": true } } - }, + } + ], + "ibm_enterprises": [ { "name": "name", "type": "TypeString", - "description": "The name of the account.", + "description": "The name of the enterprise.", "optional": true - } - ], - "ibm_enterprises": [ + }, { "name": "enterprises", "type": "TypeList", @@ -29169,12 +29419,6 @@ "computed": true } } - }, - { - "name": "name", - "type": "TypeString", - "description": "The name of the enterprise.", - "optional": true } ], "ibm_event_streams_schema": [ @@ -29202,15 +29446,6 @@ } ], "ibm_event_streams_topic": [ - { - "name": "kafka_brokers_sasl", - "type": "TypeList", - "description": "Kafka brokers addresses for interacting with Kafka native API", - "computed": true, - "elem": { - "type": "TypeString" - } - }, { "name": "name", "type": "TypeString", @@ -29244,9 +29479,36 @@ "type": "TypeString", "description": "The API endpoint for interacting with Event Streams REST API", "computed": true + }, + { + "name": "kafka_brokers_sasl", + "type": "TypeList", + "description": "Kafka brokers addresses for interacting with Kafka native API", + "computed": true, + "elem": { + "type": "TypeString" + } } ], "ibm_function_action": [ + { + "name": "annotations", + "type": "TypeString", + "description": "All annotations set on action by user and those set by the IBM Cloud Function backend/API.", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "Name of action.", + "required": true + }, + { + "name": "namespace", + "type": "TypeString", + "description": "Name of the namespace.", + "required": true + }, { "name": "limits", "type": "TypeList", @@ -29273,40 +29535,17 @@ } }, { - "name": "annotations", - "type": "TypeString", - "description": "All annotations set on action by user and those set by the IBM Cloud Function backend/API.", - "computed": true - }, - { - "name": "parameters", - "type": "TypeString", - "description": "All paramters set on action by user and those set by the IBM Cloud Function backend/API.", - "computed": true - }, - { - "name": "action_id", - "type": "TypeString", + "name": "publish", + "type": "TypeBool", + "description": "Action visibilty.", "computed": true }, { - "name": "target_endpoint_url", + "name": "version", "type": "TypeString", - "description": "Action target endpoint URL.", + "description": "Semantic version of the item.", "computed": true }, - { - "name": "name", - "type": "TypeString", - "description": "Name of action.", - "required": true - }, - { - "name": "namespace", - "type": "TypeString", - "description": "Name of the namespace.", - "required": true - }, { "name": "exec", "type": "TypeList", @@ -29354,19 +29593,30 @@ } }, { - "name": "publish", - "type": "TypeBool", - "description": "Action visibilty.", + "name": "parameters", + "type": "TypeString", + "description": "All paramters set on action by user and those set by the IBM Cloud Function backend/API.", "computed": true }, { - "name": "version", + "name": "action_id", "type": "TypeString", - "description": "Semantic version of the item.", + "computed": true + }, + { + "name": "target_endpoint_url", + "type": "TypeString", + "description": "Action target endpoint URL.", "computed": true } ], "ibm_function_namespace": [ + { + "name": "name", + "type": "TypeString", + "description": "Name of namespace.", + "required": true + }, { "name": "description", "type": "TypeString", @@ -29386,12 +29636,6 @@ "description": "Namespace Location.", "cloud_data_type": "region", "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Name of namespace.", - "required": true } ], "ibm_function_package": [ @@ -29444,6 +29688,30 @@ } ], "ibm_function_rule": [ + { + "name": "trigger_name", + "type": "TypeString", + "description": "Name of the trigger.", + "computed": true + }, + { + "name": "action_name", + "type": "TypeString", + "description": "Name of an action.", + "computed": true + }, + { + "name": "status", + "type": "TypeString", + "description": "Status of the rule.", + "computed": true + }, + { + "name": "publish", + "type": "TypeBool", + "description": "Rule Visibility.", + "computed": true + }, { "name": "version", "type": "TypeString", @@ -29466,33 +29734,26 @@ "type": "TypeString", "description": "Name of the namespace.", "required": true - }, + } + ], + "ibm_function_trigger": [ { - "name": "trigger_name", + "name": "parameters", "type": "TypeString", - "description": "Name of the trigger.", + "description": "All parameters set on trigger by user and those set by the IBM Cloud Function backend/API.", "computed": true }, { - "name": "action_name", + "name": "trigger_id", "type": "TypeString", - "description": "Name of an action.", "computed": true }, { - "name": "status", + "name": "name", "type": "TypeString", - "description": "Status of the rule.", - "computed": true + "description": "Name of Trigger.", + "required": true }, - { - "name": "publish", - "type": "TypeBool", - "description": "Rule Visibility.", - "computed": true - } - ], - "ibm_function_trigger": [ { "name": "namespace", "type": "TypeString", @@ -29516,31 +29777,15 @@ "type": "TypeString", "description": "All annotations set on trigger by user and those set by the IBM Cloud Function backend/API.", "computed": true - }, - { - "name": "parameters", - "type": "TypeString", - "description": "All parameters set on trigger by user and those set by the IBM Cloud Function backend/API.", - "computed": true - }, - { - "name": "trigger_id", - "type": "TypeString", - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Name of Trigger.", - "required": true } ], "ibm_hpcs": [ { - "name": "name", + "name": "service", "type": "TypeString", - "description": "Resource instance name for example, myobjectstorage", - "required": true + "description": "The service type of the instance", + "default_value": "hs-crypto", + "optional": true }, { "name": "failover_units", @@ -29555,65 +29800,12 @@ "cloud_data_type": "crn", "computed": true }, - { - "name": "extensions", - "type": "TypeMap", - "description": "The extended metadata as a map associated with the resource instance.", - "computed": true - }, - { - "name": "service_endpoints", - "type": "TypeString", - "description": "Types of the service endpoints. Possible values are `public-and-private`, `private-only`.", - "computed": true - }, - { - "name": "plan", - "type": "TypeString", - "description": "The plan type of the instance", - "computed": true - }, - { - "name": "status", - "type": "TypeString", - "description": "The resource instance status", - "computed": true - }, { "name": "guid", "type": "TypeString", "description": "Guid of resource instance", "computed": true }, - { - "name": "resource_group_id", - "type": "TypeString", - "description": "The id of the resource group in which the instance is present", - "cloud_data_type": "resource_group", - "optional": true, - "computed": true - }, - { - "name": "location", - "type": "TypeString", - "description": "The location or the environment in which instance exists", - "cloud_data_type": "region", - "optional": true, - "computed": true - }, - { - "name": "service", - "type": "TypeString", - "description": "The service type of the instance", - "default_value": "hs-crypto", - "optional": true - }, - { - "name": "units", - "type": "TypeInt", - "description": "The number of operational crypto units for your service instance", - "computed": true - }, { "name": "hsm_info", "type": "TypeList", @@ -29683,101 +29875,73 @@ "computed": true } } - } - ], - "ibm_hpcs_key_template": [ - { - "name": "uko_vault", - "type": "TypeString", - "description": "The UUID of the Vault in which the update is to take place.", - "required": true }, { - "name": "created_at", + "name": "location", "type": "TypeString", - "description": "Date and time when the key template was created.", + "description": "The location or the environment in which instance exists", + "cloud_data_type": "region", + "optional": true, "computed": true }, { - "name": "updated_by", + "name": "resource_group_id", "type": "TypeString", - "description": "ID of the user that updated the key.", + "description": "The id of the resource group in which the instance is present", + "cloud_data_type": "resource_group", + "optional": true, "computed": true }, { - "name": "instance_id", - "type": "TypeString", - "description": "The ID of the UKO instance this resource exists in.", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:hs-crypto" - ] + "name": "units", + "type": "TypeInt", + "description": "The number of operational crypto units for your service instance", + "computed": true }, { - "name": "description", + "name": "service_endpoints", "type": "TypeString", - "description": "Description of the key template.", + "description": "Types of the service endpoints. Possible values are `public-and-private`, `private-only`.", "computed": true }, { - "name": "updated_at", + "name": "plan", "type": "TypeString", - "description": "Date and time when the key template was updated.", + "description": "The plan type of the instance", "computed": true }, { - "name": "created_by", + "name": "status", "type": "TypeString", - "description": "ID of the user that created the key template.", + "description": "The resource instance status", "computed": true }, { - "name": "keystores", - "type": "TypeList", - "computed": true, - "elem": { - "google_key_protection_level": { - "name": "google_key_protection_level", - "type": "TypeString", - "computed": true - }, - "google_key_purpose": { - "name": "google_key_purpose", - "type": "TypeString", - "computed": true - }, - "google_kms_algorithm": { - "name": "google_kms_algorithm", - "type": "TypeString", - "computed": true - }, - "group": { - "name": "group", - "type": "TypeString", - "description": "Which keystore group to distribute the key to.", - "computed": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "Type of keystore.", - "computed": true - } - } + "name": "extensions", + "type": "TypeMap", + "description": "The extended metadata as a map associated with the resource instance.", + "computed": true }, { - "name": "href", + "name": "name", "type": "TypeString", - "description": "A URL that uniquely identifies your cloud resource.", - "computed": true - }, + "description": "Resource instance name for example, myobjectstorage", + "required": true + } + ], + "ibm_hpcs_key_template": [ { "name": "template_id", "type": "TypeString", "description": "UUID of the template.", "required": true }, + { + "name": "created_at", + "type": "TypeString", + "description": "Date and time when the key template was created.", + "computed": true + }, { "name": "vault", "type": "TypeList", @@ -29804,12 +29968,6 @@ } } }, - { - "name": "name", - "type": "TypeString", - "description": "Name of the key template.", - "computed": true - }, { "name": "key", "type": "TypeList", @@ -29849,131 +30007,124 @@ } }, { - "name": "region", - "type": "TypeString", - "description": "The region of the UKO instance this resource exists in.", - "cloud_data_type": "region", - "required": true - }, - { - "name": "version", - "type": "TypeInt", - "description": "Version of the key template. Every time the key template is updated, the version will be updated automatically.", - "computed": true - } - ], - "ibm_hpcs_keystore": [ - { - "name": "href", - "type": "TypeString", - "description": "A URL that uniquely identifies your cloud resource.", - "computed": true - }, - { - "name": "google_key_ring", + "name": "created_by", "type": "TypeString", - "description": "A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys.", + "description": "ID of the user that created the key template.", "computed": true }, { - "name": "vault", + "name": "keystores", "type": "TypeList", - "description": "Reference to a vault.", "computed": true, "elem": { - "href": { - "name": "href", + "google_key_protection_level": { + "name": "google_key_protection_level", "type": "TypeString", - "description": "A URL that uniquely identifies your cloud resource.", "computed": true }, - "id": { - "name": "id", + "google_key_purpose": { + "name": "google_key_purpose", "type": "TypeString", - "description": "The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.", "computed": true }, - "name": { - "name": "name", + "google_kms_algorithm": { + "name": "google_kms_algorithm", "type": "TypeString", - "description": "Name of the referenced vault.", + "computed": true + }, + "group": { + "name": "group", + "type": "TypeString", + "description": "Which keystore group to distribute the key to.", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "Type of keystore.", "computed": true } } }, { - "name": "updated_at", - "type": "TypeString", - "description": "Date and time when the target keystore was last updated.", + "name": "version", + "type": "TypeInt", + "description": "Version of the key template. Every time the key template is updated, the version will be updated automatically.", "computed": true }, { - "name": "created_by", + "name": "description", "type": "TypeString", - "description": "ID of the user that created the key.", + "description": "Description of the key template.", "computed": true }, { - "name": "ibm_api_endpoint", + "name": "href", "type": "TypeString", - "description": "API endpoint of the IBM Cloud keystore.", + "description": "A URL that uniquely identifies your cloud resource.", "computed": true }, { - "name": "uko_vault", + "name": "instance_id", "type": "TypeString", - "description": "The UUID of the Vault in which the update is to take place.", - "required": true - }, - { - "name": "groups", - "type": "TypeList", - "description": "List of groups that this keystore belongs to.", - "computed": true, - "elem": { - "type": "TypeString" - } + "description": "The ID of the UKO instance this resource exists in.", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:hs-crypto" + ] }, { - "name": "azure_tenant", + "name": "region", "type": "TypeString", - "description": "Azure tenant that the Key Vault is associated with,.", - "computed": true + "description": "The region of the UKO instance this resource exists in.", + "cloud_data_type": "region", + "required": true }, { - "name": "keystore_id", + "name": "uko_vault", "type": "TypeString", - "description": "UUID of the keystore.", + "description": "The UUID of the Vault in which the update is to take place.", "required": true }, { - "name": "azure_service_name", + "name": "name", "type": "TypeString", - "description": "Service name of the key vault instance from the Azure portal.", + "description": "Name of the key template.", "computed": true }, { - "name": "azure_environment", + "name": "updated_at", "type": "TypeString", - "description": "Azure environment, usually 'Azure'.", + "description": "Date and time when the key template was updated.", "computed": true }, { - "name": "aws_region", + "name": "updated_by", "type": "TypeString", - "description": "AWS Region.", + "description": "ID of the user that updated the key.", + "computed": true + } + ], + "ibm_hpcs_keystore": [ + { + "name": "google_location", + "type": "TypeString", + "description": "Location represents the geographical region where a Cloud KMS resource is stored and can be accessed. A key's location impacts the performance of applications using the key.", "computed": true }, { - "name": "ibm_iam_endpoint", + "name": "aws_access_key_id", "type": "TypeString", - "description": "Endpoint of the IAM service for this IBM Cloud keystore.", + "description": "The access key id used for connecting to this instance of AWS KMS.", + "secure": true, "computed": true }, { - "name": "ibm_variant", + "name": "aws_secret_access_key", "type": "TypeString", - "description": "Possible IBM Cloud KMS variants.", + "description": "The secret access key used for connecting to this instance of AWS KMS.", + "secure": true, "computed": true }, { @@ -29983,27 +30134,27 @@ "computed": true }, { - "name": "name", + "name": "created_by", "type": "TypeString", - "description": "Name of the target keystore. It can be changed in the future.", + "description": "ID of the user that created the key.", "computed": true }, { - "name": "google_credentials", + "name": "updated_by", "type": "TypeString", - "description": "The value of the JSON key represented in the Base64 format.", + "description": "ID of the user that last updated the key.", "computed": true }, { - "name": "google_location", + "name": "google_project_id", "type": "TypeString", - "description": "Location represents the geographical region where a Cloud KMS resource is stored and can be accessed. A key's location impacts the performance of applications using the key.", + "description": "The project id associated with this keystore.", "computed": true }, { - "name": "azure_service_principal_client_id", + "name": "ibm_iam_endpoint", "type": "TypeString", - "description": "Azure service principal client ID.", + "description": "Endpoint of the IAM service for this IBM Cloud keystore.", "computed": true }, { @@ -30014,82 +30165,78 @@ "computed": true }, { - "name": "instance_id", + "name": "description", "type": "TypeString", - "description": "The ID of the UKO instance this resource exists in.", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:hs-crypto" - ] + "description": "Description of the keystore.", + "computed": true }, { - "name": "created_at", + "name": "href", "type": "TypeString", - "description": "Date and time when the target keystore was created.", + "description": "A URL that uniquely identifies your cloud resource.", "computed": true }, { - "name": "aws_access_key_id", + "name": "google_credentials", "type": "TypeString", - "description": "The access key id used for connecting to this instance of AWS KMS.", - "secure": true, + "description": "The value of the JSON key represented in the Base64 format.", "computed": true }, { - "name": "google_project_id", + "name": "aws_region", "type": "TypeString", - "description": "The project id associated with this keystore.", + "description": "AWS Region.", "computed": true }, { - "name": "google_private_key_id", + "name": "azure_service_principal_client_id", "type": "TypeString", - "description": "The private key id associated with this keystore.", + "description": "Azure service principal client ID.", "computed": true }, { - "name": "azure_service_principal_password", + "name": "azure_environment", "type": "TypeString", - "description": "Azure service principal password.", - "secure": true, + "description": "Azure environment, usually 'Azure'.", "computed": true }, { - "name": "azure_subscription_id", + "name": "keystore_id", "type": "TypeString", - "description": "Subscription ID in Azure.", - "computed": true + "description": "UUID of the keystore.", + "required": true }, { - "name": "ibm_instance_id", + "name": "uko_vault", "type": "TypeString", - "description": "The instance ID of the IBM Cloud keystore.", - "computed": true + "description": "The UUID of the Vault in which the update is to take place.", + "required": true }, { - "name": "location", + "name": "azure_subscription_id", "type": "TypeString", - "description": "Geographic location of the keystore, if available.", - "cloud_data_type": "region", + "description": "Subscription ID in Azure.", "computed": true }, { - "name": "description", - "type": "TypeString", - "description": "Description of the keystore.", - "computed": true + "name": "groups", + "type": "TypeList", + "description": "List of groups that this keystore belongs to.", + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "type", + "name": "updated_at", "type": "TypeString", - "description": "Type of keystore.", + "description": "Date and time when the target keystore was last updated.", "computed": true }, { - "name": "azure_resource_group", + "name": "created_at", "type": "TypeString", - "description": "Resource group in Azure.", + "description": "Date and time when the target keystore was created.", "computed": true }, { @@ -30099,96 +30246,140 @@ "computed": true }, { - "name": "region", + "name": "ibm_api_endpoint", "type": "TypeString", - "description": "The region of the UKO instance this resource exists in.", - "cloud_data_type": "region", - "required": true + "description": "API endpoint of the IBM Cloud keystore.", + "computed": true }, { - "name": "updated_by", + "name": "google_key_ring", "type": "TypeString", - "description": "ID of the user that last updated the key.", + "description": "A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys.", "computed": true }, { - "name": "aws_secret_access_key", + "name": "azure_service_principal_password", "type": "TypeString", - "description": "The secret access key used for connecting to this instance of AWS KMS.", + "description": "Azure service principal password.", "secure": true, "computed": true - } - ], - "ibm_hpcs_managed_key": [ + }, { - "name": "verification_patterns", + "name": "region", + "type": "TypeString", + "description": "The region of the UKO instance this resource exists in.", + "cloud_data_type": "region", + "required": true + }, + { + "name": "vault", "type": "TypeList", - "description": "A list of verification patterns of the key (e.g. public key hash for RSA keys).", + "description": "Reference to a vault.", "computed": true, "elem": { - "method": { - "name": "method", + "href": { + "name": "href", "type": "TypeString", - "description": "The method used for calculating the verification pattern.", + "description": "A URL that uniquely identifies your cloud resource.", "computed": true }, - "value": { - "name": "value", + "id": { + "name": "id", "type": "TypeString", - "description": "The calculated value.", + "description": "The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Name of the referenced vault.", "computed": true } } }, { - "name": "created_at", + "name": "name", "type": "TypeString", - "description": "Date and time when the key was created.", + "description": "Name of the target keystore. It can be changed in the future.", "computed": true }, { - "name": "href", + "name": "location", "type": "TypeString", - "description": "A URL that uniquely identifies your cloud resource.", + "description": "Geographic location of the keystore, if available.", + "cloud_data_type": "region", "computed": true }, { - "name": "uko_vault", + "name": "type", "type": "TypeString", - "description": "The UUID of the Vault in which the update is to take place.", - "required": true + "description": "Type of keystore.", + "computed": true }, { - "name": "label", + "name": "google_private_key_id", "type": "TypeString", - "description": "The label of the key.", + "description": "The private key id associated with this keystore.", "computed": true }, { - "name": "algorithm", + "name": "azure_tenant", "type": "TypeString", - "description": "The algorithm of the key.", + "description": "Azure tenant that the Key Vault is associated with,.", "computed": true }, { - "name": "instances", + "name": "ibm_instance_id", + "type": "TypeString", + "description": "The instance ID of the IBM Cloud keystore.", + "computed": true + }, + { + "name": "ibm_variant", + "type": "TypeString", + "description": "Possible IBM Cloud KMS variants.", + "computed": true + }, + { + "name": "instance_id", + "type": "TypeString", + "description": "The ID of the UKO instance this resource exists in.", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:hs-crypto" + ] + }, + { + "name": "azure_service_name", + "type": "TypeString", + "description": "Service name of the key vault instance from the Azure portal.", + "computed": true + }, + { + "name": "azure_resource_group", + "type": "TypeString", + "description": "Resource group in Azure.", + "computed": true + } + ], + "ibm_hpcs_managed_key": [ + { + "name": "created_by", + "type": "TypeString", + "description": "ID of the user that created the key.", + "computed": true + }, + { + "name": "referenced_keystores", "type": "TypeList", - "description": "key instances.", + "description": "referenced keystores.", "computed": true, "elem": { - "google_key_protection_level": { - "name": "google_key_protection_level", - "type": "TypeString", - "computed": true - }, - "google_key_purpose": { - "name": "google_key_purpose", - "type": "TypeString", - "computed": true - }, - "google_kms_algorithm": { - "name": "google_kms_algorithm", + "href": { + "name": "href", "type": "TypeString", + "description": "A URL that uniquely identifies your cloud resource.", "computed": true }, "id": { @@ -30197,39 +30388,32 @@ "description": "The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.", "computed": true }, - "keystore": { - "name": "keystore", - "type": "TypeList", - "description": "Description of properties of a key within the context of keystores.", - "computed": true, - "elem": { - "group": { - "name": "group", - "type": "TypeString", - "computed": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "Type of keystore.", - "computed": true - } - } - }, - "label_in_keystore": { - "name": "label_in_keystore", + "name": { + "name": "name", "type": "TypeString", - "description": "The label of the key.", + "description": "Name of the target keystore.", "computed": true }, "type": { "name": "type", "type": "TypeString", - "description": "Type of the key instance.", + "description": "Type of keystore.", "computed": true } } }, + { + "name": "href", + "type": "TypeString", + "description": "A URL that uniquely identifies your cloud resource.", + "computed": true + }, + { + "name": "key_id", + "type": "TypeString", + "description": "UUID of the key.", + "required": true + }, { "name": "vault", "type": "TypeList", @@ -30256,12 +30440,6 @@ } } }, - { - "name": "size", - "type": "TypeString", - "description": "The size of the underlying cryptographic key or key pair. E.g. \"256\" for AES keys, or \"2048\" for RSA.", - "computed": true - }, { "name": "template", "type": "TypeList", @@ -30289,15 +30467,9 @@ } }, { - "name": "state", - "type": "TypeString", - "description": "The state of the key.", - "computed": true - }, - { - "name": "activation_date", + "name": "expiration_date", "type": "TypeString", - "description": "First day when the key is active.", + "description": "Last day when the key is active.", "computed": true }, { @@ -30322,55 +30494,42 @@ } }, { - "name": "updated_at", - "type": "TypeString", - "description": "Date and time when the key was last updated.", - "computed": true - }, - { - "name": "created_by", - "type": "TypeString", - "description": "ID of the user that created the key.", - "computed": true - }, - { - "name": "instance_id", - "type": "TypeString", - "description": "The ID of the UKO instance this resource exists in.", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:hs-crypto" - ] - }, - { - "name": "key_id", + "name": "uko_vault", "type": "TypeString", - "description": "UUID of the key.", + "description": "The UUID of the Vault in which the update is to take place.", "required": true }, { - "name": "updated_by", + "name": "description", "type": "TypeString", - "description": "ID of the user that last updated the key.", + "description": "Description of the managed key.", "computed": true }, { - "name": "expiration_date", + "name": "algorithm", "type": "TypeString", - "description": "Last day when the key is active.", + "description": "The algorithm of the key.", "computed": true }, { - "name": "referenced_keystores", + "name": "instances", "type": "TypeList", - "description": "referenced keystores.", + "description": "key instances.", "computed": true, "elem": { - "href": { - "name": "href", + "google_key_protection_level": { + "name": "google_key_protection_level", + "type": "TypeString", + "computed": true + }, + "google_key_purpose": { + "name": "google_key_purpose", + "type": "TypeString", + "computed": true + }, + "google_kms_algorithm": { + "name": "google_kms_algorithm", "type": "TypeString", - "description": "A URL that uniquely identifies your cloud resource.", "computed": true }, "id": { @@ -30379,16 +30538,35 @@ "description": "The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.", "computed": true }, - "name": { - "name": "name", + "keystore": { + "name": "keystore", + "type": "TypeList", + "description": "Description of properties of a key within the context of keystores.", + "computed": true, + "elem": { + "group": { + "name": "group", + "type": "TypeString", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "Type of keystore.", + "computed": true + } + } + }, + "label_in_keystore": { + "name": "label_in_keystore", "type": "TypeString", - "description": "Name of the target keystore.", + "description": "The label of the key.", "computed": true }, "type": { "name": "type", "type": "TypeString", - "description": "Type of keystore.", + "description": "Type of the key instance.", "computed": true } } @@ -30401,55 +30579,102 @@ "required": true }, { - "name": "description", + "name": "state", "type": "TypeString", - "description": "Description of the managed key.", + "description": "The state of the key.", "computed": true - } - ], - "ibm_hpcs_vault": [ + }, { - "name": "name", + "name": "verification_patterns", + "type": "TypeList", + "description": "A list of verification patterns of the key (e.g. public key hash for RSA keys).", + "computed": true, + "elem": { + "method": { + "name": "method", + "type": "TypeString", + "description": "The method used for calculating the verification pattern.", + "computed": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "The calculated value.", + "computed": true + } + } + }, + { + "name": "created_at", "type": "TypeString", - "description": "Name of the vault.", + "description": "Date and time when the key was created.", "computed": true }, { - "name": "description", + "name": "updated_at", "type": "TypeString", - "description": "Description of the vault.", + "description": "Date and time when the key was last updated.", "computed": true }, { - "name": "created_at", + "name": "instance_id", "type": "TypeString", - "description": "Date and time when the vault was created.", + "description": "The ID of the UKO instance this resource exists in.", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:hs-crypto" + ] + }, + { + "name": "label", + "type": "TypeString", + "description": "The label of the key.", "computed": true }, { - "name": "updated_at", + "name": "size", "type": "TypeString", - "description": "Date and time when the vault was last updated.", + "description": "The size of the underlying cryptographic key or key pair. E.g. \"256\" for AES keys, or \"2048\" for RSA.", + "computed": true + }, + { + "name": "activation_date", + "type": "TypeString", + "description": "First day when the key is active.", "computed": true }, { "name": "updated_by", "type": "TypeString", - "description": "ID of the user that last updated the vault.", + "description": "ID of the user that last updated the key.", + "computed": true + } + ], + "ibm_hpcs_vault": [ + { + "name": "name", + "type": "TypeString", + "description": "Name of the vault.", "computed": true }, { - "name": "vault_id", + "name": "description", "type": "TypeString", - "description": "UUID of the vault.", - "required": true + "description": "Description of the vault.", + "computed": true }, { - "name": "region", + "name": "updated_at", "type": "TypeString", - "description": "The region of the UKO instance this resource exists in.", - "cloud_data_type": "region", - "required": true + "description": "Date and time when the vault was last updated.", + "computed": true + }, + { + "name": "href", + "type": "TypeString", + "description": "A URL that uniquely identifies your cloud resource.", + "computed": true }, { "name": "created_by", @@ -30458,9 +30683,9 @@ "computed": true }, { - "name": "href", + "name": "updated_by", "type": "TypeString", - "description": "A URL that uniquely identifies your cloud resource.", + "description": "ID of the user that last updated the vault.", "computed": true }, { @@ -30472,20 +30697,28 @@ "cloud_data_range": [ "service:hs-crypto" ] - } - ], - "ibm_iam_access_group": [ + }, { - "name": "access_group_name", + "name": "region", "type": "TypeString", - "description": "Name of the access group", - "cloud_data_type": "iam", - "optional": true, - "cloud_data_range": [ - "service:access_group", - "resolved_to:name" - ] + "description": "The region of the UKO instance this resource exists in.", + "cloud_data_type": "region", + "required": true + }, + { + "name": "vault_id", + "type": "TypeString", + "description": "UUID of the vault.", + "required": true }, + { + "name": "created_at", + "type": "TypeString", + "description": "Date and time when the vault was created.", + "computed": true + } + ], + "ibm_iam_access_group": [ { "name": "groups", "type": "TypeList", @@ -30585,9 +30818,44 @@ } } } + }, + { + "name": "access_group_name", + "type": "TypeString", + "description": "Name of the access group", + "cloud_data_type": "iam", + "optional": true, + "cloud_data_range": [ + "service:access_group", + "resolved_to:name" + ] } ], "ibm_iam_access_group_policy": [ + { + "name": "access_group_id", + "type": "TypeString", + "description": "ID of access group", + "cloud_data_type": "iam", + "required": true, + "cloud_data_range": [ + "service:access_group", + "resolved_to:id" + ] + }, + { + "name": "sort", + "type": "TypeString", + "description": "Sort query for policies", + "optional": true + }, + { + "name": "transaction_id", + "type": "TypeString", + "description": "Set transactionID for debug", + "optional": true, + "computed": true + }, { "name": "policies", "type": "TypeList", @@ -30790,33 +31058,33 @@ } } } - }, + } + ], + "ibm_iam_access_group_template_assignment": [ { - "name": "access_group_id", + "name": "template_id", "type": "TypeString", - "description": "ID of access group", - "cloud_data_type": "iam", - "required": true, - "cloud_data_range": [ - "service:access_group", - "resolved_to:id" - ] + "description": "Filter results by Template Id.", + "optional": true }, { - "name": "sort", + "name": "transaction_id", "type": "TypeString", - "description": "Sort query for policies", + "description": "An optional transaction id for the request.", "optional": true }, { - "name": "transaction_id", + "name": "total_count", + "type": "TypeInt", + "description": "Total number of items matching the query.", + "computed": true + }, + { + "name": "account_id", "type": "TypeString", - "description": "Set transactionID for debug", - "optional": true, + "description": "Enterprise account ID.", "computed": true - } - ], - "ibm_iam_access_group_template_assignment": [ + }, { "name": "target", "type": "TypeString", @@ -30830,11 +31098,31 @@ "optional": true }, { - "name": "total_count", + "name": "limit", "type": "TypeInt", - "description": "Total number of items matching the query.", + "description": "Maximum number of items returned in the response.", "computed": true }, + { + "name": "offset", + "type": "TypeInt", + "description": "Index of the first item returned in the response.", + "computed": true + }, + { + "name": "first", + "type": "TypeList", + "description": "A link object.", + "computed": true, + "elem": { + "href": { + "name": "href", + "type": "TypeString", + "description": "A string containing the link’s URL.", + "computed": true + } + } + }, { "name": "last", "type": "TypeList", @@ -30935,55 +31223,11 @@ } } }, - { - "name": "account_id", - "type": "TypeString", - "description": "Enterprise account ID.", - "computed": true - }, - { - "name": "template_id", - "type": "TypeString", - "description": "Filter results by Template Id.", - "optional": true - }, { "name": "template_version", "type": "TypeString", "description": "Filter results by Template Version.", "optional": true - }, - { - "name": "transaction_id", - "type": "TypeString", - "description": "An optional transaction id for the request.", - "optional": true - }, - { - "name": "limit", - "type": "TypeInt", - "description": "Maximum number of items returned in the response.", - "computed": true - }, - { - "name": "offset", - "type": "TypeInt", - "description": "Index of the first item returned in the response.", - "computed": true - }, - { - "name": "first", - "type": "TypeList", - "description": "A link object.", - "computed": true, - "elem": { - "href": { - "name": "href", - "type": "TypeString", - "description": "A string containing the link’s URL.", - "computed": true - } - } } ], "ibm_iam_access_group_template_versions": [ @@ -31308,9 +31552,66 @@ ], "ibm_iam_account_settings": [ { - "name": "restrict_create_service_id", + "name": "restrict_create_platform_apikey", "type": "TypeString", - "description": "Defines whether or not creating a Service Id is access controlled. Valid values: * RESTRICTED - to apply access control * NOT_RESTRICTED - to remove access control * NOT_SET - to 'unset' a previous set value.", + "description": "Defines whether or not creating platform API keys is access controlled. Valid values: * RESTRICTED - to apply access control * NOT_RESTRICTED - to remove access control * NOT_SET - to 'unset' a previous set value.", + "computed": true + }, + { + "name": "user_mfa", + "type": "TypeList", + "description": "List of users that are exempted from the MFA requirement of the account.", + "computed": true, + "elem": { + "iam_id": { + "name": "iam_id", + "type": "TypeString", + "description": "The iam_id of the user.", + "computed": true + }, + "mfa": { + "name": "mfa", + "type": "TypeString", + "description": "Defines the MFA requirement for the user. Valid values: * NONE - No MFA trait set * TOTP - For all non-federated IBMId users * TOTP4ALL - For all users * LEVEL1 - Email-based MFA for all users * LEVEL2 - TOTP-based MFA for all users * LEVEL3 - U2F MFA for all users.", + "computed": true + } + } + }, + { + "name": "session_expiration_in_seconds", + "type": "TypeString", + "description": "Defines the session expiration in seconds for the account. Valid values: * Any whole number between between '900' and '86400' * NOT_SET - To unset account setting and use service default.", + "computed": true + }, + { + "name": "include_history", + "type": "TypeBool", + "description": "Defines if the entity history is included in the response.", + "default_value": false, + "optional": true + }, + { + "name": "account_id", + "type": "TypeString", + "description": "Unique ID of the account.", + "computed": true + }, + { + "name": "allowed_ip_addresses", + "type": "TypeString", + "description": "Defines the IP addresses and subnets from which IAM tokens can be created for the account.", + "computed": true + }, + { + "name": "session_invalidation_in_seconds", + "type": "TypeString", + "description": "Defines the period of time in seconds in which a session will be invalidated due to inactivity. Valid values: * Any whole number between '900' and '7200' * NOT_SET - To unset account setting and use service default.", + "computed": true + }, + { + "name": "system_access_token_expiration_in_seconds", + "type": "TypeString", + "description": "Defines the access token expiration in seconds. Valid values: * Any whole number between '900' and '3600' * NOT_SET - To unset account setting and use service default.", "computed": true }, { @@ -31360,12 +31661,6 @@ } } }, - { - "name": "session_expiration_in_seconds", - "type": "TypeString", - "description": "Defines the session expiration in seconds for the account. Valid values: * Any whole number between between '900' and '86400' * NOT_SET - To unset account setting and use service default.", - "computed": true - }, { "name": "max_sessions_per_identity", "type": "TypeString", @@ -31373,9 +31668,9 @@ "computed": true }, { - "name": "system_access_token_expiration_in_seconds", + "name": "mfa", "type": "TypeString", - "description": "Defines the access token expiration in seconds. Valid values: * Any whole number between '900' and '3600' * NOT_SET - To unset account setting and use service default.", + "description": "Defines the MFA trait for the account. Valid values: * NONE - No MFA trait set * TOTP - For all non-federated IBMId users * TOTP4ALL - For all users * LEVEL1 - Email-based MFA for all users * LEVEL2 - TOTP-based MFA for all users * LEVEL3 - U2F MFA for all users.", "computed": true }, { @@ -31385,70 +31680,126 @@ "computed": true }, { - "name": "include_history", - "type": "TypeBool", - "description": "Defines if the entity history is included in the response.", - "default_value": false, - "optional": true + "name": "restrict_create_service_id", + "type": "TypeString", + "description": "Defines whether or not creating a Service Id is access controlled. Valid values: * RESTRICTED - to apply access control * NOT_RESTRICTED - to remove access control * NOT_SET - to 'unset' a previous set value.", + "computed": true }, { "name": "entity_tag", "type": "TypeString", "description": "Version of the account settings.", "computed": true + } + ], + "ibm_iam_account_settings_template": [ + { + "name": "name", + "type": "TypeString", + "description": "The name of the trusted profile template. This is visible only in the enterprise account.", + "computed": true }, { - "name": "session_invalidation_in_seconds", + "name": "history", + "type": "TypeList", + "description": "History of the Template.", + "computed": true, + "elem": { + "action": { + "name": "action", + "type": "TypeString", + "description": "Action of the history entry.", + "computed": true + }, + "iam_id": { + "name": "iam_id", + "type": "TypeString", + "description": "IAM ID of the identity which triggered the action.", + "computed": true + }, + "iam_id_account": { + "name": "iam_id_account", + "type": "TypeString", + "description": "Account of the identity which triggered the action.", + "computed": true + }, + "message": { + "name": "message", + "type": "TypeString", + "description": "Message which summarizes the executed action.", + "computed": true + }, + "params": { + "name": "params", + "type": "TypeList", + "description": "Params of the history entry.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "timestamp": { + "name": "timestamp", + "type": "TypeString", + "description": "Timestamp when the action was triggered.", + "computed": true + } + } + }, + { + "name": "entity_tag", "type": "TypeString", - "description": "Defines the period of time in seconds in which a session will be invalidated due to inactivity. Valid values: * Any whole number between '900' and '7200' * NOT_SET - To unset account setting and use service default.", + "description": "Entity tag for this templateId-version combination.", "computed": true }, { - "name": "account_id", + "name": "last_modified_by_id", "type": "TypeString", - "description": "Unique ID of the account.", + "description": "IAMid of the identity that made the latest modification.", "computed": true }, { - "name": "restrict_create_platform_apikey", + "name": "id", "type": "TypeString", - "description": "Defines whether or not creating platform API keys is access controlled. Valid values: * RESTRICTED - to apply access control * NOT_RESTRICTED - to remove access control * NOT_SET - to 'unset' a previous set value.", + "description": "ID of the the template.", "computed": true }, { - "name": "mfa", + "name": "account_id", "type": "TypeString", - "description": "Defines the MFA trait for the account. Valid values: * NONE - No MFA trait set * TOTP - For all non-federated IBMId users * TOTP4ALL - For all users * LEVEL1 - Email-based MFA for all users * LEVEL2 - TOTP-based MFA for all users * LEVEL3 - U2F MFA for all users.", + "description": "ID of the account where the template resides.", "computed": true }, { - "name": "allowed_ip_addresses", + "name": "description", "type": "TypeString", - "description": "Defines the IP addresses and subnets from which IAM tokens can be created for the account.", + "description": "The description of the trusted profile template. Describe the template for enterprise account users.", "computed": true }, { - "name": "user_mfa", - "type": "TypeList", - "description": "List of users that are exempted from the MFA requirement of the account.", - "computed": true, - "elem": { - "iam_id": { - "name": "iam_id", - "type": "TypeString", - "description": "The iam_id of the user.", - "computed": true - }, - "mfa": { - "name": "mfa", - "type": "TypeString", - "description": "Defines the MFA requirement for the user. Valid values: * NONE - No MFA trait set * TOTP - For all non-federated IBMId users * TOTP4ALL - For all users * LEVEL1 - Email-based MFA for all users * LEVEL2 - TOTP-based MFA for all users * LEVEL3 - U2F MFA for all users.", - "computed": true - } - } - } - ], - "ibm_iam_account_settings_template": [ + "name": "committed", + "type": "TypeBool", + "description": "Committed flag determines if the template is ready for assignment.", + "computed": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "Template Created At.", + "computed": true + }, + { + "name": "template_id", + "type": "TypeString", + "description": "ID of the account settings template.", + "required": true + }, + { + "name": "version", + "type": "TypeString", + "description": "Version of the account settings template.", + "optional": true + }, { "name": "crn", "type": "TypeString", @@ -31457,15 +31808,15 @@ "computed": true }, { - "name": "created_at", + "name": "created_by_id", "type": "TypeString", - "description": "Template Created At.", + "description": "IAMid of the creator.", "computed": true }, { - "name": "name", + "name": "last_modified_at", "type": "TypeString", - "description": "The name of the trusted profile template. This is visible only in the enterprise account.", + "description": "Template last modified at.", "computed": true }, { @@ -31555,35 +31906,19 @@ } } } - }, - { - "name": "entity_tag", - "type": "TypeString", - "description": "Entity tag for this templateId-version combination.", - "computed": true - }, - { - "name": "created_by_id", - "type": "TypeString", - "description": "IAMid of the creator.", - "computed": true - }, + } + ], + "ibm_iam_account_settings_template_assignment": [ { - "name": "description", + "name": "target", "type": "TypeString", - "description": "The description of the trusted profile template. Describe the template for enterprise account users.", - "computed": true - }, - { - "name": "committed", - "type": "TypeBool", - "description": "Committed flag determines if the template is ready for assignment.", - "computed": true + "description": "Assignment target.", + "optional": true }, { "name": "history", "type": "TypeList", - "description": "History of the Template.", + "description": "Assignment history.", "computed": true, "elem": { "action": { @@ -31628,117 +31963,17 @@ } }, { - "name": "last_modified_at", + "name": "last_modified_by_id", "type": "TypeString", - "description": "Template last modified at.", + "description": "IAMid of the identity that last modified the assignment.", "computed": true }, { - "name": "template_id", - "type": "TypeString", - "description": "ID of the account settings template.", - "required": true - }, - { - "name": "version", - "type": "TypeString", - "description": "Version of the account settings template.", - "optional": true - }, - { - "name": "id", + "name": "entity_tag", "type": "TypeString", - "description": "ID of the the template.", + "description": "Entity tag for this assignment record.", "computed": true }, - { - "name": "account_id", - "type": "TypeString", - "description": "ID of the account where the template resides.", - "computed": true - }, - { - "name": "last_modified_by_id", - "type": "TypeString", - "description": "IAMid of the identity that made the latest modification.", - "computed": true - } - ], - "ibm_iam_account_settings_template_assignment": [ - { - "name": "context", - "type": "TypeList", - "description": "Context with key properties for problem determination.", - "computed": true, - "elem": { - "cluster_name": { - "name": "cluster_name", - "type": "TypeString", - "description": "The cluster name.", - "computed": true - }, - "elapsed_time": { - "name": "elapsed_time", - "type": "TypeString", - "description": "The elapsed time in msec.", - "computed": true - }, - "end_time": { - "name": "end_time", - "type": "TypeString", - "description": "The finish time of the request.", - "computed": true - }, - "host": { - "name": "host", - "type": "TypeString", - "description": "The host of the server instance processing the request.", - "computed": true - }, - "instance_id": { - "name": "instance_id", - "type": "TypeString", - "description": "The instance ID of the server instance processing the request.", - "computed": true - }, - "operation": { - "name": "operation", - "type": "TypeString", - "description": "The operation of the inbound REST request.", - "computed": true - }, - "start_time": { - "name": "start_time", - "type": "TypeString", - "description": "The start time of the request.", - "computed": true - }, - "thread_id": { - "name": "thread_id", - "type": "TypeString", - "description": "The thread ID of the server instance processing the request.", - "computed": true - }, - "transaction_id": { - "name": "transaction_id", - "type": "TypeString", - "description": "The transaction ID of the inbound REST request.", - "computed": true - }, - "url": { - "name": "url", - "type": "TypeString", - "description": "The URL of that cluster.", - "computed": true - }, - "user_agent": { - "name": "user_agent", - "type": "TypeString", - "description": "The user agent of the inbound REST request.", - "computed": true - } - } - }, { "name": "account_id", "type": "TypeString", @@ -31746,30 +31981,17 @@ "computed": true }, { - "name": "template_version", - "type": "TypeInt", - "description": "Template version.", - "optional": true - }, - { - "name": "target_type", + "name": "href", "type": "TypeString", - "description": "Assignment target type.", - "optional": true + "description": "Href.", + "computed": true }, { - "name": "status", + "name": "created_at", "type": "TypeString", - "description": "Assignment status.", + "description": "Assignment created at.", "computed": true }, - { - "name": "include_history", - "type": "TypeBool", - "description": "Defines if the entity history is included in the response.", - "default_value": false, - "optional": true - }, { "name": "template_id", "type": "TypeString", @@ -31777,10 +31999,10 @@ "optional": true }, { - "name": "created_at", + "name": "target_type", "type": "TypeString", - "description": "Assignment created at.", - "computed": true + "description": "Assignment target type.", + "optional": true }, { "name": "created_by_id", @@ -31789,17 +32011,11 @@ "computed": true }, { - "name": "last_modified_by_id", + "name": "status", "type": "TypeString", - "description": "IAMid of the identity that last modified the assignment.", + "description": "Assignment status.", "computed": true }, - { - "name": "assignment_id", - "type": "TypeString", - "description": "ID of the Assignment Record.", - "required": true - }, { "name": "resources", "type": "TypeList", @@ -31886,88 +32102,134 @@ } }, { - "name": "history", + "name": "last_modified_at", + "type": "TypeString", + "description": "Assignment modified at.", + "computed": true + }, + { + "name": "assignment_id", + "type": "TypeString", + "description": "ID of the Assignment Record.", + "required": true + }, + { + "name": "include_history", + "type": "TypeBool", + "description": "Defines if the entity history is included in the response.", + "default_value": false, + "optional": true + }, + { + "name": "context", "type": "TypeList", - "description": "Assignment history.", + "description": "Context with key properties for problem determination.", "computed": true, "elem": { - "action": { - "name": "action", + "cluster_name": { + "name": "cluster_name", "type": "TypeString", - "description": "Action of the history entry.", + "description": "The cluster name.", "computed": true }, - "iam_id": { - "name": "iam_id", + "elapsed_time": { + "name": "elapsed_time", "type": "TypeString", - "description": "IAM ID of the identity which triggered the action.", + "description": "The elapsed time in msec.", "computed": true }, - "iam_id_account": { - "name": "iam_id_account", + "end_time": { + "name": "end_time", "type": "TypeString", - "description": "Account of the identity which triggered the action.", + "description": "The finish time of the request.", "computed": true }, - "message": { - "name": "message", + "host": { + "name": "host", "type": "TypeString", - "description": "Message which summarizes the executed action.", + "description": "The host of the server instance processing the request.", "computed": true }, - "params": { - "name": "params", - "type": "TypeList", - "description": "Params of the history entry.", - "computed": true, - "elem": { - "type": "TypeString" - } + "instance_id": { + "name": "instance_id", + "type": "TypeString", + "description": "The instance ID of the server instance processing the request.", + "computed": true }, - "timestamp": { - "name": "timestamp", + "operation": { + "name": "operation", "type": "TypeString", - "description": "Timestamp when the action was triggered.", + "description": "The operation of the inbound REST request.", + "computed": true + }, + "start_time": { + "name": "start_time", + "type": "TypeString", + "description": "The start time of the request.", + "computed": true + }, + "thread_id": { + "name": "thread_id", + "type": "TypeString", + "description": "The thread ID of the server instance processing the request.", + "computed": true + }, + "transaction_id": { + "name": "transaction_id", + "type": "TypeString", + "description": "The transaction ID of the inbound REST request.", + "computed": true + }, + "url": { + "name": "url", + "type": "TypeString", + "description": "The URL of that cluster.", + "computed": true + }, + "user_agent": { + "name": "user_agent", + "type": "TypeString", + "description": "The user agent of the inbound REST request.", "computed": true } } }, { - "name": "href", + "name": "id", "type": "TypeString", - "description": "Href.", + "description": "Assignment record Id.", "computed": true }, { - "name": "last_modified_at", + "name": "template_version", + "type": "TypeInt", + "description": "Template version.", + "optional": true + } + ], + "ibm_iam_api_key": [ + { + "name": "created_at", "type": "TypeString", - "description": "Assignment modified at.", + "description": "If set contains a date time string of the creation date in ISO format.", "computed": true }, { - "name": "entity_tag", + "name": "created_by", "type": "TypeString", - "description": "Entity tag for this assignment record.", + "description": "IAM ID of the user or service which created the API key.", "computed": true }, { - "name": "id", + "name": "modified_at", "type": "TypeString", - "description": "Assignment record Id.", + "description": "If set contains a date time string of the last modification date in ISO format.", "computed": true }, { - "name": "target", - "type": "TypeString", - "description": "Assignment target.", - "optional": true - } - ], - "ibm_iam_api_key": [ - { - "name": "name", + "name": "description", "type": "TypeString", - "description": "Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.", + "description": "The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.", "computed": true }, { @@ -31982,13 +32244,6 @@ "description": "Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.", "computed": true }, - { - "name": "crn", - "type": "TypeString", - "description": "Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'.", - "cloud_data_type": "crn", - "computed": true - }, { "name": "locked", "type": "TypeBool", @@ -31996,27 +32251,22 @@ "computed": true }, { - "name": "created_by", - "type": "TypeString", - "description": "IAM ID of the user or service which created the API key.", - "computed": true - }, - { - "name": "modified_at", + "name": "account_id", "type": "TypeString", - "description": "If set contains a date time string of the last modification date in ISO format.", + "description": "ID of the account that this API key authenticates for.", "computed": true }, { - "name": "created_at", + "name": "crn", "type": "TypeString", - "description": "If set contains a date time string of the creation date in ISO format.", + "description": "Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'.", + "cloud_data_type": "crn", "computed": true }, { - "name": "description", + "name": "name", "type": "TypeString", - "description": "The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.", + "description": "Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.", "computed": true }, { @@ -32024,20 +32274,9 @@ "type": "TypeString", "description": "The iam_id that this API key authenticates.", "computed": true - }, - { - "name": "account_id", - "type": "TypeString", - "description": "ID of the account that this API key authenticates for.", - "computed": true } ], "ibm_iam_auth_token": [ - { - "name": "uaa_refresh_token", - "type": "TypeString", - "computed": true - }, { "name": "iam_access_token", "type": "TypeString", @@ -32052,29 +32291,14 @@ "name": "uaa_access_token", "type": "TypeString", "computed": true - } - ], - "ibm_iam_authorization_policies": [ - { - "name": "account_id", - "type": "TypeString", - "description": "The unique ID of an account", - "optional": true, - "computed": true - }, - { - "name": "sort", - "type": "TypeString", - "description": "Sort query for policies", - "optional": true }, { - "name": "transaction_id", + "name": "uaa_refresh_token", "type": "TypeString", - "description": "Set transactionID for debug", - "optional": true, "computed": true - }, + } + ], + "ibm_iam_authorization_policies": [ { "name": "policies", "type": "TypeList", @@ -32160,95 +32384,35 @@ "computed": true } } - } - ], - "ibm_iam_policy_assignment": [ - { - "name": "target_type", - "type": "TypeString", - "description": "Assignment target type.", - "computed": true - }, - { - "name": "created_by_id", - "type": "TypeString", - "description": "The iam ID of the entity that created the policy assignment.", - "computed": true - }, - { - "name": "last_modified_at", - "type": "TypeString", - "description": "The UTC timestamp when the policy assignment was last modified.", - "computed": true - }, - { - "name": "options", - "type": "TypeList", - "description": "List of objects with required properties for a policy assignment.", - "computed": true, - "elem": { - "root_requester_id": { - "name": "root_requester_id", - "type": "TypeString", - "description": "The policy assignment requester id.", - "computed": true - }, - "root_template_id": { - "name": "root_template_id", - "type": "TypeString", - "description": "The template id where this policy is being assigned from.", - "computed": true - }, - "root_template_version": { - "name": "root_template_version", - "type": "TypeString", - "description": "The template version where this policy is being assigned from.", - "computed": true - }, - "subject_id": { - "name": "subject_id", - "type": "TypeString", - "description": "The policy subject id.", - "computed": true - }, - "subject_type": { - "name": "subject_type", - "type": "TypeString", - "description": "The policy subject type; either 'iam_id' or 'access_group_id'.", - "computed": true - } - } }, { "name": "account_id", "type": "TypeString", - "description": "Enterprise accountID.", + "description": "The unique ID of an account", + "optional": true, "computed": true }, { - "name": "assignment_id", + "name": "sort", "type": "TypeString", - "description": "The policy template assignment ID.", - "required": true + "description": "Sort query for policies", + "optional": true }, { - "name": "template_id", + "name": "transaction_id", "type": "TypeString", - "description": "policy template id.", + "description": "Set transactionID for debug", + "optional": true, "computed": true - }, + } + ], + "ibm_iam_policy_assignment": [ { "name": "target", "type": "TypeString", "description": "assignment target id.", "computed": true }, - { - "name": "id", - "type": "TypeString", - "description": "Policy assignment ID.", - "computed": true - }, { "name": "created_at", "type": "TypeString", @@ -32256,21 +32420,9 @@ "computed": true }, { - "name": "template_version", - "type": "TypeString", - "description": "policy template version.", - "computed": true - }, - { - "name": "href", - "type": "TypeString", - "description": "The href URL that links to the policies assignments API by policy assignment ID.", - "computed": true - }, - { - "name": "last_modified_by_id", + "name": "last_modified_at", "type": "TypeString", - "description": "The iam ID of the entity that last modified the policy assignment.", + "description": "The UTC timestamp when the policy assignment was last modified.", "computed": true }, { @@ -32394,6 +32546,98 @@ "computed": true } } + }, + { + "name": "options", + "type": "TypeList", + "description": "List of objects with required properties for a policy assignment.", + "computed": true, + "elem": { + "root_requester_id": { + "name": "root_requester_id", + "type": "TypeString", + "description": "The policy assignment requester id.", + "computed": true + }, + "root_template_id": { + "name": "root_template_id", + "type": "TypeString", + "description": "The template id where this policy is being assigned from.", + "computed": true + }, + "root_template_version": { + "name": "root_template_version", + "type": "TypeString", + "description": "The template version where this policy is being assigned from.", + "computed": true + }, + "subject_id": { + "name": "subject_id", + "type": "TypeString", + "description": "The policy subject id.", + "computed": true + }, + "subject_type": { + "name": "subject_type", + "type": "TypeString", + "description": "The policy subject type; either 'iam_id' or 'access_group_id'.", + "computed": true + } + } + }, + { + "name": "account_id", + "type": "TypeString", + "description": "Enterprise accountID.", + "computed": true + }, + { + "name": "assignment_id", + "type": "TypeString", + "description": "The policy template assignment ID.", + "required": true + }, + { + "name": "template_version", + "type": "TypeString", + "description": "policy template version.", + "computed": true + }, + { + "name": "created_by_id", + "type": "TypeString", + "description": "The iam ID of the entity that created the policy assignment.", + "computed": true + }, + { + "name": "last_modified_by_id", + "type": "TypeString", + "description": "The iam ID of the entity that last modified the policy assignment.", + "computed": true + }, + { + "name": "template_id", + "type": "TypeString", + "description": "policy template id.", + "computed": true + }, + { + "name": "id", + "type": "TypeString", + "description": "Policy assignment ID.", + "computed": true + }, + { + "name": "target_type", + "type": "TypeString", + "description": "Assignment target type.", + "computed": true + }, + { + "name": "href", + "type": "TypeString", + "description": "The href URL that links to the policies assignments API by policy assignment ID.", + "computed": true } ], "ibm_iam_policy_assignments": [ @@ -32827,6 +33071,36 @@ } ], "ibm_iam_policy_template_version": [ + { + "name": "id", + "type": "TypeString", + "description": "The policy template ID.", + "computed": true + }, + { + "name": "policy_template_id", + "type": "TypeString", + "description": "The policy template ID.", + "required": true + }, + { + "name": "version", + "type": "TypeString", + "description": "The policy template version.", + "required": true + }, + { + "name": "name", + "type": "TypeString", + "description": "name of template.", + "computed": true + }, + { + "name": "description", + "type": "TypeString", + "description": "description of template purpose.", + "computed": true + }, { "name": "account_id", "type": "TypeString", @@ -32968,39 +33242,33 @@ "computed": true } } - }, - { - "name": "id", - "type": "TypeString", - "description": "The policy template ID.", - "computed": true - }, + } + ], + "ibm_iam_role_actions": [ { - "name": "policy_template_id", - "type": "TypeString", - "description": "The policy template ID.", - "required": true + "name": "reader_plus", + "type": "TypeList", + "description": "readerplus action ids", + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "version", - "type": "TypeString", - "description": "The policy template version.", - "required": true + "name": "writer", + "type": "TypeList", + "description": "writer action ids", + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "name", - "type": "TypeString", - "description": "name of template.", + "name": "actions", + "type": "TypeMap", + "description": "List of actions for different services roles", "computed": true }, - { - "name": "description", - "type": "TypeString", - "description": "description of template purpose.", - "computed": true - } - ], - "ibm_iam_role_actions": [ { "name": "service", "type": "TypeString", @@ -33025,30 +33293,6 @@ "elem": { "type": "TypeString" } - }, - { - "name": "reader_plus", - "type": "TypeList", - "description": "readerplus action ids", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "writer", - "type": "TypeList", - "description": "writer action ids", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "actions", - "type": "TypeMap", - "description": "List of actions for different services roles", - "computed": true } ], "ibm_iam_roles": [ @@ -33337,40 +33581,39 @@ ], "ibm_iam_trusted_profile": [ { - "name": "crn", + "name": "name", "type": "TypeString", - "description": "Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::profile:Profile-94497d0d-2ac3-41bf-a993-a49d1b14627c'.", - "cloud_data_type": "crn", + "description": "Name of the trusted profile. The name is checked for uniqueness. Therefore trusted profiles with the same names can not exist in the same account.", "computed": true }, { - "name": "created_at", + "name": "description", "type": "TypeString", - "description": "If set contains a date time string of the creation date in ISO format.", + "description": "The optional description of the trusted profile. The 'description' property is only available if a description was provided during a create of a trusted profile.", "computed": true }, { - "name": "iam_id", + "name": "account_id", "type": "TypeString", - "description": "The iam_id of this trusted profile.", + "description": "ID of the account that this trusted profile belong to.", "computed": true }, { - "name": "account_id", + "name": "iam_id", "type": "TypeString", - "description": "ID of the account that this trusted profile belong to.", + "description": "The iam_id of this trusted profile.", "computed": true }, { - "name": "assignment_id", + "name": "template_id", "type": "TypeString", - "description": "Id of assignment that assigned the template.", + "description": "Template id the profile was created from.", "computed": true }, { - "name": "description", + "name": "assignment_id", "type": "TypeString", - "description": "The optional description of the trusted profile. The 'description' property is only available if a description was provided during a create of a trusted profile.", + "description": "Id of assignment that assigned the template.", "computed": true }, { @@ -33421,9 +33664,16 @@ } }, { - "name": "ims_account_id", - "type": "TypeInt", - "description": "IMS acount ID of the trusted profile.", + "name": "crn", + "type": "TypeString", + "description": "Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::profile:Profile-94497d0d-2ac3-41bf-a993-a49d1b14627c'.", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "If set contains a date time string of the creation date in ISO format.", "computed": true }, { @@ -33433,9 +33683,9 @@ "computed": true }, { - "name": "template_id", - "type": "TypeString", - "description": "Template id the profile was created from.", + "name": "ims_account_id", + "type": "TypeInt", + "description": "IMS acount ID of the trusted profile.", "computed": true }, { @@ -33455,12 +33705,6 @@ "description": "Version of the trusted profile details object. You need to specify this value when updating the trusted profile to avoid stale updates.", "computed": true }, - { - "name": "name", - "type": "TypeString", - "description": "Name of the trusted profile. The name is checked for uniqueness. Therefore trusted profiles with the same names can not exist in the same account.", - "computed": true - }, { "name": "modified_at", "type": "TypeString", @@ -33470,15 +33714,28 @@ ], "ibm_iam_trusted_profile_claim_rule": [ { - "name": "profile_id", + "name": "rule_id", "type": "TypeString", - "description": "ID of the trusted profile.", - "cloud_data_type": "iam", - "required": true, - "cloud_data_range": [ - "service:trusted_profile", - "resolved_to:id" - ] + "description": "ID of the claim rule to get.", + "required": true + }, + { + "name": "entity_tag", + "type": "TypeString", + "description": "version of the claim rule.", + "computed": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "If set contains a date time string of the creation date in ISO format.", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "The optional claim rule name.", + "computed": true }, { "name": "type", @@ -33519,21 +33776,26 @@ } }, { - "name": "rule_id", + "name": "profile_id", "type": "TypeString", - "description": "ID of the claim rule to get.", - "required": true + "description": "ID of the trusted profile.", + "cloud_data_type": "iam", + "required": true, + "cloud_data_range": [ + "service:trusted_profile", + "resolved_to:id" + ] }, { - "name": "entity_tag", - "type": "TypeString", - "description": "version of the claim rule.", + "name": "expiration", + "type": "TypeInt", + "description": "Session expiration in seconds.", "computed": true }, { - "name": "created_at", + "name": "cr_type", "type": "TypeString", - "description": "If set contains a date time string of the creation date in ISO format.", + "description": "The compute resource type. Not required if type is Profile-SAML. Valid values are VSI, IKS_SA, ROKS_SA.", "computed": true }, { @@ -33541,24 +33803,6 @@ "type": "TypeString", "description": "If set contains a date time string of the last modification date in ISO format.", "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "The optional claim rule name.", - "computed": true - }, - { - "name": "expiration", - "type": "TypeInt", - "description": "Session expiration in seconds.", - "computed": true - }, - { - "name": "cr_type", - "type": "TypeString", - "description": "The compute resource type. Not required if type is Profile-SAML. Valid values are VSI, IKS_SA, ROKS_SA.", - "computed": true } ], "ibm_iam_trusted_profile_claim_rules": [ @@ -33718,6 +33962,30 @@ } ], "ibm_iam_trusted_profile_identity": [ + { + "name": "identifier_id", + "type": "TypeString", + "description": "Identifier of the identity that can assume the trusted profiles.", + "required": true + }, + { + "name": "iam_id", + "type": "TypeString", + "description": "IAM ID of the identity.", + "computed": true + }, + { + "name": "identifier", + "type": "TypeString", + "description": "Identifier of the identity that can assume the trusted profiles. This can be a user identifier (IAM id), serviceid or crn. Internally it uses account id of the service id for the identifier 'serviceid' and for the identifier 'crn' it uses account id contained in the CRN.", + "computed": true + }, + { + "name": "type", + "type": "TypeString", + "description": "Type of the identity.", + "computed": true + }, { "name": "accounts", "type": "TypeList", @@ -33744,33 +34012,15 @@ "type": "TypeString", "description": "Type of the identity.", "required": true - }, + } + ], + "ibm_iam_trusted_profile_link": [ { - "name": "identifier_id", + "name": "link_id", "type": "TypeString", - "description": "Identifier of the identity that can assume the trusted profiles.", + "description": "ID of the link.", "required": true }, - { - "name": "iam_id", - "type": "TypeString", - "description": "IAM ID of the identity.", - "computed": true - }, - { - "name": "identifier", - "type": "TypeString", - "description": "Identifier of the identity that can assume the trusted profiles. This can be a user identifier (IAM id), serviceid or crn. Internally it uses account id of the service id for the identifier 'serviceid' and for the identifier 'crn' it uses account id contained in the CRN.", - "computed": true - }, - { - "name": "type", - "type": "TypeString", - "description": "Type of the identity.", - "computed": true - } - ], - "ibm_iam_trusted_profile_link": [ { "name": "entity_tag", "type": "TypeString", @@ -33836,12 +34086,6 @@ "service:trusted_profile", "resolved_to:id" ] - }, - { - "name": "link_id", - "type": "TypeString", - "description": "ID of the link.", - "required": true } ], "ibm_iam_trusted_profile_links": [ @@ -33927,6 +34171,36 @@ } ], "ibm_iam_trusted_profile_policy": [ + { + "name": "profile_id", + "type": "TypeString", + "description": "UUID of trusted profile", + "cloud_data_type": "iam", + "optional": true, + "cloud_data_range": [ + "service:trusted_profile", + "resolved_to:id" + ] + }, + { + "name": "iam_id", + "type": "TypeString", + "description": "IAM ID of trusted profile", + "optional": true + }, + { + "name": "sort", + "type": "TypeString", + "description": "Sort query for policies", + "optional": true + }, + { + "name": "transaction_id", + "type": "TypeString", + "description": "Set transactionID for debug", + "optional": true, + "computed": true + }, { "name": "policies", "type": "TypeList", @@ -34133,70 +34407,40 @@ } } } - }, - { - "name": "profile_id", - "type": "TypeString", - "description": "UUID of trusted profile", - "cloud_data_type": "iam", - "optional": true, - "cloud_data_range": [ - "service:trusted_profile", - "resolved_to:id" - ] - }, - { - "name": "iam_id", - "type": "TypeString", - "description": "IAM ID of trusted profile", - "optional": true - }, - { - "name": "sort", - "type": "TypeString", - "description": "Sort query for policies", - "optional": true - }, - { - "name": "transaction_id", - "type": "TypeString", - "description": "Set transactionID for debug", - "optional": true, - "computed": true } ], "ibm_iam_trusted_profile_template": [ { - "name": "entity_tag", + "name": "version", "type": "TypeString", - "description": "Entity tag for this templateId-version combination.", - "computed": true + "description": "Version of the Profile Template.", + "optional": true }, { - "name": "created_by_id", + "name": "account_id", "type": "TypeString", - "description": "IAMid of the creator.", + "description": "ID of the account where the template resides.", "computed": true }, { - "name": "last_modified_by_id", + "name": "crn", "type": "TypeString", - "description": "IAMid of the identity that made the latest modification.", + "description": "Cloud resource name.", + "cloud_data_type": "crn", "computed": true }, - { - "name": "include_history", - "type": "TypeBool", - "description": "Defines if the entity history is included in the response.", - "default_value": false, - "optional": true - }, { "name": "name", "type": "TypeString", "description": "The name of the trusted profile template. This is visible only in the enterprise account.", "computed": true }, + { + "name": "committed", + "type": "TypeBool", + "description": "Committed flag determines if the template is ready for assignment.", + "computed": true + }, { "name": "profile", "type": "TypeList", @@ -34316,96 +34560,6 @@ } } }, - { - "name": "history", - "type": "TypeList", - "description": "History of the trusted profile template.", - "computed": true, - "elem": { - "action": { - "name": "action", - "type": "TypeString", - "description": "Action of the history entry.", - "computed": true - }, - "iam_id": { - "name": "iam_id", - "type": "TypeString", - "description": "IAM ID of the identity which triggered the action.", - "computed": true - }, - "iam_id_account": { - "name": "iam_id_account", - "type": "TypeString", - "description": "Account of the identity which triggered the action.", - "computed": true - }, - "message": { - "name": "message", - "type": "TypeString", - "description": "Message which summarizes the executed action.", - "computed": true - }, - "params": { - "name": "params", - "type": "TypeList", - "description": "Params of the history entry.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "timestamp": { - "name": "timestamp", - "type": "TypeString", - "description": "Timestamp when the action was triggered.", - "computed": true - } - } - }, - { - "name": "created_at", - "type": "TypeString", - "description": "Timestamp of when the template was created.", - "computed": true - }, - { - "name": "id", - "type": "TypeString", - "description": "ID of the the template.", - "computed": true - }, - { - "name": "account_id", - "type": "TypeString", - "description": "ID of the account where the template resides.", - "computed": true - }, - { - "name": "description", - "type": "TypeString", - "description": "The description of the trusted profile template. Describe the template for enterprise account users.", - "computed": true - }, - { - "name": "crn", - "type": "TypeString", - "description": "Cloud resource name.", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "version", - "type": "TypeString", - "description": "Version of the Profile Template.", - "optional": true - }, - { - "name": "committed", - "type": "TypeBool", - "description": "Committed flag determines if the template is ready for assignment.", - "computed": true - }, { "name": "policy_template_references", "type": "TypeList", @@ -34427,36 +34581,22 @@ } }, { - "name": "template_id", + "name": "entity_tag", "type": "TypeString", - "description": "ID of the trusted profile template.", - "required": true + "description": "Entity tag for this templateId-version combination.", + "computed": true }, { "name": "last_modified_at", "type": "TypeString", "description": "Timestamp of when the template was last modified.", "computed": true - } - ], - "ibm_iam_trusted_profile_template_assignment": [ - { - "name": "status", - "type": "TypeString", - "description": "Assignment status.", - "computed": true }, { - "name": "href", - "type": "TypeString", - "description": "Href.", - "computed": true - }, - { - "name": "created_at", + "name": "template_id", "type": "TypeString", - "description": "Assignment created at.", - "computed": true + "description": "ID of the trusted profile template.", + "required": true }, { "name": "include_history", @@ -34468,37 +34608,19 @@ { "name": "id", "type": "TypeString", - "description": "Assignment record Id.", - "computed": true - }, - { - "name": "account_id", - "type": "TypeString", - "description": "Enterprise account Id.", - "computed": true - }, - { - "name": "target", - "type": "TypeString", - "description": "Assignment target.", + "description": "ID of the the template.", "computed": true }, { - "name": "template_id", + "name": "description", "type": "TypeString", - "description": "Template Id.", - "computed": true - }, - { - "name": "template_version", - "type": "TypeInt", - "description": "Template version.", + "description": "The description of the trusted profile template. Describe the template for enterprise account users.", "computed": true }, { "name": "history", "type": "TypeList", - "description": "Assignment history.", + "description": "History of the trusted profile template.", "computed": true, "elem": { "action": { @@ -34545,89 +34667,23 @@ { "name": "last_modified_by_id", "type": "TypeString", - "description": "IAMid of the identity that last modified the assignment.", + "description": "IAMid of the identity that made the latest modification.", "computed": true }, { - "name": "context", - "type": "TypeList", - "description": "Context with key properties for problem determination.", - "computed": true, - "elem": { - "cluster_name": { - "name": "cluster_name", - "type": "TypeString", - "description": "The cluster name.", - "computed": true - }, - "elapsed_time": { - "name": "elapsed_time", - "type": "TypeString", - "description": "The elapsed time in msec.", - "computed": true - }, - "end_time": { - "name": "end_time", - "type": "TypeString", - "description": "The finish time of the request.", - "computed": true - }, - "host": { - "name": "host", - "type": "TypeString", - "description": "The host of the server instance processing the request.", - "computed": true - }, - "instance_id": { - "name": "instance_id", - "type": "TypeString", - "description": "The instance ID of the server instance processing the request.", - "computed": true - }, - "operation": { - "name": "operation", - "type": "TypeString", - "description": "The operation of the inbound REST request.", - "computed": true - }, - "start_time": { - "name": "start_time", - "type": "TypeString", - "description": "The start time of the request.", - "computed": true - }, - "thread_id": { - "name": "thread_id", - "type": "TypeString", - "description": "The thread ID of the server instance processing the request.", - "computed": true - }, - "transaction_id": { - "name": "transaction_id", - "type": "TypeString", - "description": "The transaction ID of the inbound REST request.", - "computed": true - }, - "url": { - "name": "url", - "type": "TypeString", - "description": "The URL of that cluster.", - "computed": true - }, - "user_agent": { - "name": "user_agent", - "type": "TypeString", - "description": "The user agent of the inbound REST request.", - "computed": true - } - } + "name": "created_at", + "type": "TypeString", + "description": "Timestamp of when the template was created.", + "computed": true }, { - "name": "target_type", + "name": "created_by_id", "type": "TypeString", - "description": "Assignment target type.", + "description": "IAMid of the creator.", "computed": true - }, + } + ], + "ibm_iam_trusted_profile_template_assignment": [ { "name": "resources", "type": "TypeList", @@ -34785,6 +34841,12 @@ } } }, + { + "name": "created_by_id", + "type": "TypeString", + "description": "IAMid of the identity that created the assignment.", + "computed": true + }, { "name": "entity_tag", "type": "TypeString", @@ -34798,9 +34860,191 @@ "required": true }, { - "name": "created_by_id", + "name": "id", "type": "TypeString", - "description": "IAMid of the identity that created the assignment.", + "description": "Assignment record Id.", + "computed": true + }, + { + "name": "account_id", + "type": "TypeString", + "description": "Enterprise account Id.", + "computed": true + }, + { + "name": "template_id", + "type": "TypeString", + "description": "Template Id.", + "computed": true + }, + { + "name": "status", + "type": "TypeString", + "description": "Assignment status.", + "computed": true + }, + { + "name": "target", + "type": "TypeString", + "description": "Assignment target.", + "computed": true + }, + { + "name": "history", + "type": "TypeList", + "description": "Assignment history.", + "computed": true, + "elem": { + "action": { + "name": "action", + "type": "TypeString", + "description": "Action of the history entry.", + "computed": true + }, + "iam_id": { + "name": "iam_id", + "type": "TypeString", + "description": "IAM ID of the identity which triggered the action.", + "computed": true + }, + "iam_id_account": { + "name": "iam_id_account", + "type": "TypeString", + "description": "Account of the identity which triggered the action.", + "computed": true + }, + "message": { + "name": "message", + "type": "TypeString", + "description": "Message which summarizes the executed action.", + "computed": true + }, + "params": { + "name": "params", + "type": "TypeList", + "description": "Params of the history entry.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "timestamp": { + "name": "timestamp", + "type": "TypeString", + "description": "Timestamp when the action was triggered.", + "computed": true + } + } + }, + { + "name": "include_history", + "type": "TypeBool", + "description": "Defines if the entity history is included in the response.", + "default_value": false, + "optional": true + }, + { + "name": "href", + "type": "TypeString", + "description": "Href.", + "computed": true + }, + { + "name": "last_modified_by_id", + "type": "TypeString", + "description": "IAMid of the identity that last modified the assignment.", + "computed": true + }, + { + "name": "context", + "type": "TypeList", + "description": "Context with key properties for problem determination.", + "computed": true, + "elem": { + "cluster_name": { + "name": "cluster_name", + "type": "TypeString", + "description": "The cluster name.", + "computed": true + }, + "elapsed_time": { + "name": "elapsed_time", + "type": "TypeString", + "description": "The elapsed time in msec.", + "computed": true + }, + "end_time": { + "name": "end_time", + "type": "TypeString", + "description": "The finish time of the request.", + "computed": true + }, + "host": { + "name": "host", + "type": "TypeString", + "description": "The host of the server instance processing the request.", + "computed": true + }, + "instance_id": { + "name": "instance_id", + "type": "TypeString", + "description": "The instance ID of the server instance processing the request.", + "computed": true + }, + "operation": { + "name": "operation", + "type": "TypeString", + "description": "The operation of the inbound REST request.", + "computed": true + }, + "start_time": { + "name": "start_time", + "type": "TypeString", + "description": "The start time of the request.", + "computed": true + }, + "thread_id": { + "name": "thread_id", + "type": "TypeString", + "description": "The thread ID of the server instance processing the request.", + "computed": true + }, + "transaction_id": { + "name": "transaction_id", + "type": "TypeString", + "description": "The transaction ID of the inbound REST request.", + "computed": true + }, + "url": { + "name": "url", + "type": "TypeString", + "description": "The URL of that cluster.", + "computed": true + }, + "user_agent": { + "name": "user_agent", + "type": "TypeString", + "description": "The user agent of the inbound REST request.", + "computed": true + } + } + }, + { + "name": "template_version", + "type": "TypeInt", + "description": "Template version.", + "computed": true + }, + { + "name": "target_type", + "type": "TypeString", + "description": "Assignment target type.", + "computed": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "Assignment created at.", "computed": true }, { @@ -34811,6 +35055,23 @@ } ], "ibm_iam_trusted_profiles": [ + { + "name": "account_id", + "type": "TypeString", + "description": "Account ID to query for trusted profiles.", + "optional": true + }, + { + "name": "name", + "type": "TypeString", + "description": "Name of the profile", + "cloud_data_type": "iam", + "optional": true, + "cloud_data_range": [ + "service:trusted_profile", + "resolved_to:name" + ] + }, { "name": "include_history", "type": "TypeBool", @@ -34937,23 +35198,6 @@ "computed": true } } - }, - { - "name": "account_id", - "type": "TypeString", - "description": "Account ID to query for trusted profiles.", - "optional": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Name of the profile", - "cloud_data_type": "iam", - "optional": true, - "cloud_data_range": [ - "service:trusted_profile", - "resolved_to:name" - ] } ], "ibm_iam_user_mfa_enrollments": [ @@ -35078,6 +35322,12 @@ } ], "ibm_iam_user_policy": [ + { + "name": "ibm_id", + "type": "TypeString", + "description": "The ibm id or email of user", + "required": true + }, { "name": "sort", "type": "TypeString", @@ -35249,15 +35499,39 @@ "optional": true } } + } + ], + "ibm_iam_user_profile": [ + { + "name": "email", + "type": "TypeString", + "description": "The email of the user.", + "computed": true }, { - "name": "ibm_id", + "name": "phonenumber", "type": "TypeString", - "description": "The ibm id or email of user", + "description": "The phone for the user.", + "computed": true + }, + { + "name": "iam_id", + "type": "TypeString", + "description": "User's IAM ID or or email of user", "required": true - } - ], - "ibm_iam_user_profile": [ + }, + { + "name": "user_id", + "type": "TypeString", + "description": "The user ID used for login.", + "computed": true + }, + { + "name": "lastname", + "type": "TypeString", + "description": "The last name of the user.", + "computed": true + }, { "name": "altphonenumber", "type": "TypeString", @@ -35291,41 +35565,11 @@ "description": "The first name of the user.", "computed": true }, - { - "name": "email", - "type": "TypeString", - "description": "The email of the user.", - "computed": true - }, { "name": "state", "type": "TypeString", "description": "The state of the user. Possible values are PROCESSING, PENDING, ACTIVE, DISABLED_CLASSIC_INFRASTRUCTURE, and VPN_ONLY.", "computed": true - }, - { - "name": "phonenumber", - "type": "TypeString", - "description": "The phone for the user.", - "computed": true - }, - { - "name": "iam_id", - "type": "TypeString", - "description": "User's IAM ID or or email of user", - "required": true - }, - { - "name": "user_id", - "type": "TypeString", - "description": "The user ID used for login.", - "computed": true - }, - { - "name": "lastname", - "type": "TypeString", - "description": "The last name of the user.", - "computed": true } ], "ibm_iam_users": [ @@ -35399,6 +35643,13 @@ } ], "ibm_is_backup_policies": [ + { + "name": "resource_group", + "type": "TypeString", + "description": "Filters the collection to resources in the resource group with the specified identifier", + "cloud_data_type": "resource_group", + "optional": true + }, { "name": "name", "type": "TypeString", @@ -35556,34 +35807,15 @@ "computed": true } } - }, - { - "name": "resource_group", - "type": "TypeString", - "description": "Filters the collection to resources in the resource group with the specified identifier", - "cloud_data_type": "resource_group", - "optional": true } ], "ibm_is_backup_policy": [ - { - "name": "created_at", - "type": "TypeString", - "description": "The date and time that the backup policy was created.", - "computed": true - }, { "name": "last_job_completed_at", "type": "TypeString", "description": "The date and time that the most recent job for this backup policy completed.", "computed": true }, - { - "name": "lifecycle_state", - "type": "TypeString", - "description": "The lifecycle state of the backup policy.", - "computed": true - }, { "name": "match_resource_types", "type": "TypeList", @@ -35593,6 +35825,40 @@ "type": "TypeString" } }, + { + "name": "match_user_tags", + "type": "TypeList", + "description": "The user tags this backup policy applies to. Resources that have both a matching user tag and a matching type will be subject to the backup policy.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "resource_type", + "type": "TypeString", + "description": "The type of resource referenced.", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "The unique user-defined name for this backup policy.", + "optional": true, + "computed": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "The date and time that the backup policy was created.", + "computed": true + }, + { + "name": "href", + "type": "TypeString", + "description": "The URL for this backup policy.", + "computed": true + }, { "name": "plans", "type": "TypeList", @@ -35666,25 +35932,12 @@ } } }, - { - "name": "resource_type", - "type": "TypeString", - "description": "The type of resource referenced.", - "computed": true - }, { "name": "identifier", "type": "TypeString", "description": "The backup policy identifier.", "optional": true }, - { - "name": "name", - "type": "TypeString", - "description": "The unique user-defined name for this backup policy.", - "optional": true, - "computed": true - }, { "name": "crn", "type": "TypeString", @@ -35693,34 +35946,13 @@ "computed": true }, { - "name": "href", + "name": "lifecycle_state", "type": "TypeString", - "description": "The URL for this backup policy.", + "description": "The lifecycle state of the backup policy.", "computed": true - }, - { - "name": "match_user_tags", - "type": "TypeList", - "description": "The user tags this backup policy applies to. Resources that have both a matching user tag and a matching type will be subject to the backup policy.", - "computed": true, - "elem": { - "type": "TypeString" - } } ], "ibm_is_backup_policy_job": [ - { - "name": "job_type", - "type": "TypeString", - "description": "The type of backup policy job.The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the backup policy job on which the unexpected property value was encountered.", - "computed": true - }, - { - "name": "backup_policy_id", - "type": "TypeString", - "description": "The backup policy identifier.", - "required": true - }, { "name": "backup_policy_plan", "type": "TypeList", @@ -35768,88 +36000,28 @@ } }, { - "name": "created_at", + "name": "href", "type": "TypeString", - "description": "The date and time that the backup policy job was created.", + "description": "The URL for this backup policy job.", "computed": true }, { - "name": "status_reasons", - "type": "TypeList", - "description": "The reasons for the current status (if any).The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered.", - "computed": true, - "elem": { - "code": { - "name": "code", - "type": "TypeString", - "description": "A snake case string succinctly identifying the status reason:- `internal_error`: Internal error (contact IBM support)- `snapshot_pending`: Cannot delete backup (snapshot) in the `pending` lifecycle state- `snapshot_volume_limit`: The snapshot limit for the source volume has been reached- `source_volume_busy`: The source volume has `busy` set (after multiple retries).", - "computed": true - }, - "message": { - "name": "message", - "type": "TypeString", - "description": "An explanation of the status reason.", - "computed": true - }, - "more_info": { - "name": "more_info", - "type": "TypeString", - "description": "Link to documentation about this status reason.", - "computed": true - } - } + "name": "completed_at", + "type": "TypeString", + "description": "The date and time that the backup policy job was completed.", + "computed": true }, { - "name": "target_snapshot", - "type": "TypeList", - "description": "The snapshot operated on by this backup policy job (may be[deleted](https://cloud.ibm.com/apidocs/vpc#deleted-resources)).", - "computed": true, - "elem": { - "crn": { - "name": "crn", - "type": "TypeString", - "description": "The CRN for this snapshot.", - "computed": true - }, - "deleted": { - "name": "deleted", - "type": "TypeList", - "description": "If present, this property indicates the referenced resource has been deleted and providessome supplementary information.", - "computed": true, - "elem": { - "more_info": { - "name": "more_info", - "type": "TypeString", - "description": "Link to documentation about deleted resources.", - "computed": true - } - } - }, - "href": { - "name": "href", - "type": "TypeString", - "description": "The URL for this snapshot.", - "computed": true - }, - "id": { - "name": "id", - "type": "TypeString", - "description": "The unique identifier for this snapshot.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "The user-defined name for this snapshot.", - "computed": true - }, - "resource_type": { - "name": "resource_type", - "type": "TypeString", - "description": "The resource type.", - "computed": true - } - } + "name": "created_at", + "type": "TypeString", + "description": "The date and time that the backup policy job was created.", + "computed": true + }, + { + "name": "auto_delete_after", + "type": "TypeInt", + "description": "If `auto_delete` is `true`, the days after completion that this backup policy job will be deleted. This value may be modifiable in the future.", + "computed": true }, { "name": "identifier", @@ -35863,6 +36035,12 @@ "description": "Indicates whether this backup policy job will be automatically deleted after it completes. At present, this is always `true`, but may be modifiable in the future.", "computed": true }, + { + "name": "job_type", + "type": "TypeString", + "description": "The type of backup policy job.The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the backup policy job on which the unexpected property value was encountered.", + "computed": true + }, { "name": "resource_type", "type": "TypeString", @@ -35922,22 +36100,88 @@ "computed": true }, { - "name": "auto_delete_after", - "type": "TypeInt", - "description": "If `auto_delete` is `true`, the days after completion that this backup policy job will be deleted. This value may be modifiable in the future.", - "computed": true + "name": "status_reasons", + "type": "TypeList", + "description": "The reasons for the current status (if any).The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered.", + "computed": true, + "elem": { + "code": { + "name": "code", + "type": "TypeString", + "description": "A snake case string succinctly identifying the status reason:- `internal_error`: Internal error (contact IBM support)- `snapshot_pending`: Cannot delete backup (snapshot) in the `pending` lifecycle state- `snapshot_volume_limit`: The snapshot limit for the source volume has been reached- `source_volume_busy`: The source volume has `busy` set (after multiple retries).", + "computed": true + }, + "message": { + "name": "message", + "type": "TypeString", + "description": "An explanation of the status reason.", + "computed": true + }, + "more_info": { + "name": "more_info", + "type": "TypeString", + "description": "Link to documentation about this status reason.", + "computed": true + } + } }, { - "name": "completed_at", + "name": "backup_policy_id", "type": "TypeString", - "description": "The date and time that the backup policy job was completed.", - "computed": true + "description": "The backup policy identifier.", + "required": true }, { - "name": "href", - "type": "TypeString", - "description": "The URL for this backup policy job.", - "computed": true + "name": "target_snapshot", + "type": "TypeList", + "description": "The snapshot operated on by this backup policy job (may be[deleted](https://cloud.ibm.com/apidocs/vpc#deleted-resources)).", + "computed": true, + "elem": { + "crn": { + "name": "crn", + "type": "TypeString", + "description": "The CRN for this snapshot.", + "computed": true + }, + "deleted": { + "name": "deleted", + "type": "TypeList", + "description": "If present, this property indicates the referenced resource has been deleted and providessome supplementary information.", + "computed": true, + "elem": { + "more_info": { + "name": "more_info", + "type": "TypeString", + "description": "Link to documentation about deleted resources.", + "computed": true + } + } + }, + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this snapshot.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this snapshot.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The user-defined name for this snapshot.", + "computed": true + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true + } + } } ], "ibm_is_backup_policy_jobs": [ @@ -36218,15 +36462,24 @@ ], "ibm_is_backup_policy_plan": [ { - "name": "created_at", - "type": "TypeString", - "description": "The date and time that the backup policy plan was created.", + "name": "attach_user_tags", + "type": "TypeList", + "description": "User tags to attach to each resource created by this plan.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "copy_user_tags", + "type": "TypeBool", + "description": "Indicates whether to copy the source's user tags to the created resource.", "computed": true }, { - "name": "cron_spec", + "name": "href", "type": "TypeString", - "description": "The cron specification for the backup schedule.", + "description": "The URL for this backup policy plan.", "computed": true }, { @@ -36252,42 +36505,16 @@ } }, { - "name": "remote_region_policy", - "type": "TypeList", - "description": "Policies for creating remote copies of this backup.", - "computed": true, - "elem": { - "delete_over_count": { - "name": "delete_over_count", - "type": "TypeInt", - "description": "The maximum number of recent remote copies to keep in this region.", - "computed": true - }, - "encryption_key": { - "name": "encryption_key", - "type": "TypeString", - "description": "The CRN of the [Key Protect Root Key](https://cloud.ibm.com/docs/key-protect?topic=key-protect-getting-started-tutorial) or [Hyper Protect Crypto Services Root Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started) for this resource.", - "computed": true - }, - "region": { - "name": "region", - "type": "TypeString", - "description": "The globally unique name for this region.", - "computed": true - } - } - }, - { - "name": "active", - "type": "TypeBool", - "description": "Indicates whether the plan is active.", + "name": "resource_type", + "type": "TypeString", + "description": "The type of resource referenced.", "computed": true }, { - "name": "href", + "name": "backup_policy_id", "type": "TypeString", - "description": "The URL for this backup policy plan.", - "computed": true + "description": "The backup policy identifier.", + "required": true }, { "name": "lifecycle_state", @@ -36296,31 +36523,21 @@ "computed": true }, { - "name": "resource_type", + "name": "created_at", "type": "TypeString", - "description": "The type of resource referenced.", + "description": "The date and time that the backup policy plan was created.", "computed": true }, { - "name": "attach_user_tags", - "type": "TypeList", - "description": "User tags to attach to each resource created by this plan.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "identifier", - "type": "TypeString", - "description": "The backup policy plan identifier.", - "optional": true + "name": "active", + "type": "TypeBool", + "description": "Indicates whether the plan is active.", + "computed": true }, { - "name": "name", + "name": "cron_spec", "type": "TypeString", - "description": "The unique user-defined name for this backup policy plan.", - "optional": true, + "description": "The cron specification for the backup schedule.", "computed": true }, { @@ -36343,16 +36560,43 @@ } }, { - "name": "backup_policy_id", - "type": "TypeString", - "description": "The backup policy identifier.", - "required": true + "name": "remote_region_policy", + "type": "TypeList", + "description": "Policies for creating remote copies of this backup.", + "computed": true, + "elem": { + "delete_over_count": { + "name": "delete_over_count", + "type": "TypeInt", + "description": "The maximum number of recent remote copies to keep in this region.", + "computed": true + }, + "encryption_key": { + "name": "encryption_key", + "type": "TypeString", + "description": "The CRN of the [Key Protect Root Key](https://cloud.ibm.com/docs/key-protect?topic=key-protect-getting-started-tutorial) or [Hyper Protect Crypto Services Root Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started) for this resource.", + "computed": true + }, + "region": { + "name": "region", + "type": "TypeString", + "description": "The globally unique name for this region.", + "computed": true + } + } }, { - "name": "copy_user_tags", - "type": "TypeBool", - "description": "Indicates whether to copy the source's user tags to the created resource.", + "name": "name", + "type": "TypeString", + "description": "The unique user-defined name for this backup policy plan.", + "optional": true, "computed": true + }, + { + "name": "identifier", + "type": "TypeString", + "description": "The backup policy plan identifier.", + "optional": true } ], "ibm_is_backup_policy_plans": [ @@ -36508,6 +36752,43 @@ } ], "ibm_is_bare_metal_server": [ + { + "name": "vpc", + "type": "TypeString", + "description": "The VPC the bare metal server is to be a part of", + "computed": true + }, + { + "name": "status", + "type": "TypeString", + "description": "Bare metal server status", + "computed": true + }, + { + "name": "crn", + "type": "TypeString", + "description": "The CRN for this bare metal server", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "image", + "type": "TypeString", + "description": "image name", + "computed": true + }, + { + "name": "profile", + "type": "TypeString", + "description": "profil name", + "computed": true + }, + { + "name": "resource_type", + "type": "TypeString", + "description": "Resource type name", + "computed": true + }, { "name": "identifier", "type": "TypeString", @@ -36515,37 +36796,47 @@ "computed": true }, { - "name": "trusted_platform_module", + "name": "bandwidth", + "type": "TypeInt", + "description": "The total bandwidth (in megabits per second)", + "computed": true + }, + { + "name": "cpu", "type": "TypeList", + "description": "The bare metal server CPU configuration", "computed": true, "elem": { - "enabled": { - "name": "enabled", - "type": "TypeBool", - "description": "Indicates whether the trusted platform module is enabled.", + "architecture": { + "name": "architecture", + "type": "TypeString", + "description": "The CPU architecture", "computed": true }, - "mode": { - "name": "mode", - "type": "TypeString", - "description": "The trusted platform module mode to use. The specified value must be listed in the bare metal server profile's supported_trusted_platform_module_modes", + "core_count": { + "name": "core_count", + "type": "TypeInt", + "description": "The total number of cores", "computed": true }, - "supported_modes": { - "name": "supported_modes", - "type": "TypeSet", - "description": "The trusted platform module (TPM) mode:: disabled: No TPM functionality, tpm_2: TPM 2.0. The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected property value was encountered. Enum: [ disabled, tpm_2 ]", - "computed": true, - "elem": { - "type": "TypeString" - } + "socket_count": { + "name": "socket_count", + "type": "TypeInt", + "description": "The total number of CPU sockets", + "computed": true + }, + "threads_per_core": { + "name": "threads_per_core", + "type": "TypeInt", + "description": "The total number of hardware threads per core", + "computed": true } } }, { - "name": "boot_target", + "name": "href", "type": "TypeString", - "description": "The unique identifier for this bare metal server disk", + "description": "The URL for this bare metal server", "computed": true }, { @@ -36635,56 +36926,81 @@ } }, { - "name": "tags", - "type": "TypeSet", - "description": "Tags for the Bare metal server", - "min_length": 1, - "max_length": 128, - "matches": "^[A-Za-z0-9:_ .-]+$", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "bandwidth", - "type": "TypeInt", - "description": "The total bandwidth (in megabits per second)", + "name": "zone", + "type": "TypeString", + "description": "Zone name", "computed": true }, { - "name": "keys", - "type": "TypeSet", - "description": "SSH key Ids for the bare metal server", + "name": "status_reasons", + "type": "TypeList", "computed": true, "elem": { - "type": "TypeString" + "code": { + "name": "code", + "type": "TypeString", + "description": "A snake case string succinctly identifying the status reason", + "computed": true + }, + "message": { + "name": "message", + "type": "TypeString", + "description": "An explanation of the status reason", + "computed": true + }, + "more_info": { + "name": "more_info", + "type": "TypeString", + "description": "Link to documentation about this status reason", + "computed": true + } } }, { - "name": "zone", + "name": "name", "type": "TypeString", - "description": "Zone name", + "description": "Bare metal server name", + "optional": true, "computed": true }, { - "name": "resource_group", - "type": "TypeString", - "description": "Resource group name", - "cloud_data_type": "resource_group", - "computed": true + "name": "trusted_platform_module", + "type": "TypeList", + "computed": true, + "elem": { + "enabled": { + "name": "enabled", + "type": "TypeBool", + "description": "Indicates whether the trusted platform module is enabled.", + "computed": true + }, + "mode": { + "name": "mode", + "type": "TypeString", + "description": "The trusted platform module mode to use. The specified value must be listed in the bare metal server profile's supported_trusted_platform_module_modes", + "computed": true + }, + "supported_modes": { + "name": "supported_modes", + "type": "TypeSet", + "description": "The trusted platform module (TPM) mode:: disabled: No TPM functionality, tpm_2: TPM 2.0. The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected property value was encountered. Enum: [ disabled, tpm_2 ]", + "computed": true, + "elem": { + "type": "TypeString" + } + } + } }, { - "name": "enable_secure_boot", - "type": "TypeBool", - "description": "Indicates whether secure boot is enabled. If enabled, the image must support secure boot or the server will fail to boot.", + "name": "boot_target", + "type": "TypeString", + "description": "The unique identifier for this bare metal server disk", "computed": true }, { - "name": "crn", - "type": "TypeString", - "description": "The CRN for this bare metal server", - "cloud_data_type": "crn", + "name": "memory", + "type": "TypeInt", + "description": "The amount of memory, truncated to whole gibibytes", "computed": true }, { @@ -36768,41 +37084,37 @@ } }, { - "name": "status_reasons", - "type": "TypeList", + "name": "keys", + "type": "TypeSet", + "description": "SSH key Ids for the bare metal server", "computed": true, "elem": { - "code": { - "name": "code", - "type": "TypeString", - "description": "A snake case string succinctly identifying the status reason", - "computed": true - }, - "message": { - "name": "message", - "type": "TypeString", - "description": "An explanation of the status reason", - "computed": true - }, - "more_info": { - "name": "more_info", - "type": "TypeString", - "description": "Link to documentation about this status reason", - "computed": true - } + "type": "TypeString" } }, { - "name": "profile", + "name": "resource_group", "type": "TypeString", - "description": "profil name", + "description": "Resource group name", + "cloud_data_type": "resource_group", "computed": true }, { - "name": "name", - "type": "TypeString", - "description": "Bare metal server name", - "optional": true, + "name": "tags", + "type": "TypeSet", + "description": "Tags for the Bare metal server", + "min_length": 1, + "max_length": 128, + "matches": "^[A-Za-z0-9:_ .-]+$", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "enable_secure_boot", + "type": "TypeBool", + "description": "Indicates whether secure boot is enabled. If enabled, the image must support secure boot or the server will fail to boot.", "computed": true }, { @@ -36811,38 +37123,6 @@ "description": "The date and time that the bare metal server was created", "computed": true }, - { - "name": "cpu", - "type": "TypeList", - "description": "The bare metal server CPU configuration", - "computed": true, - "elem": { - "architecture": { - "name": "architecture", - "type": "TypeString", - "description": "The CPU architecture", - "computed": true - }, - "core_count": { - "name": "core_count", - "type": "TypeInt", - "description": "The total number of cores", - "computed": true - }, - "socket_count": { - "name": "socket_count", - "type": "TypeInt", - "description": "The total number of CPU sockets", - "computed": true - }, - "threads_per_core": { - "name": "threads_per_core", - "type": "TypeInt", - "description": "The total number of hardware threads per core", - "computed": true - } - } - }, { "name": "disks", "type": "TypeList", @@ -36888,52 +37168,34 @@ } }, { - "name": "href", - "type": "TypeString", - "description": "The URL for this bare metal server", - "computed": true - }, - { - "name": "memory", - "type": "TypeInt", - "description": "The amount of memory, truncated to whole gibibytes", - "computed": true - }, - { - "name": "image", - "type": "TypeString", - "description": "image name", - "computed": true - }, + "name": "access_tags", + "type": "TypeSet", + "description": "List of access tags", + "computed": true, + "elem": { + "type": "TypeString" + } + } + ], + "ibm_is_bare_metal_server_disk": [ { - "name": "vpc", + "name": "name", "type": "TypeString", - "description": "The VPC the bare metal server is to be a part of", + "description": "The user-defined name for this disk", "computed": true }, { "name": "resource_type", "type": "TypeString", - "description": "Resource type name", + "description": "The resource type", "computed": true }, { - "name": "status", - "type": "TypeString", - "description": "Bare metal server status", + "name": "size", + "type": "TypeInt", + "description": "The size of the disk in GB (gigabytes)", "computed": true }, - { - "name": "access_tags", - "type": "TypeSet", - "description": "List of access tags", - "computed": true, - "elem": { - "type": "TypeString" - } - } - ], - "ibm_is_bare_metal_server_disk": [ { "name": "bare_metal_server", "type": "TypeString", @@ -36963,24 +37225,6 @@ "type": "TypeString", "description": "The disk interface used for attaching the disk. Supported values are [ nvme, sata ]", "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "The user-defined name for this disk", - "computed": true - }, - { - "name": "resource_type", - "type": "TypeString", - "description": "The resource type", - "computed": true - }, - { - "name": "size", - "type": "TypeInt", - "description": "The size of the disk in GB (gigabytes)", - "computed": true } ], "ibm_is_bare_metal_server_disks": [ @@ -37119,56 +37363,6 @@ } ], "ibm_is_bare_metal_server_network_interface": [ - { - "name": "name", - "type": "TypeString", - "description": "The user-defined name for this network interface", - "computed": true - }, - { - "name": "primary_ip", - "type": "TypeList", - "description": "IPv4, The IP address.", - "computed": true, - "elem": { - "address": { - "name": "address", - "type": "TypeString", - "description": "The globally unique IP address", - "computed": true - }, - "href": { - "name": "href", - "type": "TypeString", - "description": "The URL for this reserved IP", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "The user-defined name for this reserved IP. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the subnet the reserved IP resides in.", - "computed": true - }, - "reserved_ip": { - "name": "reserved_ip", - "type": "TypeString", - "description": "Identifies a reserved IP by a unique property.", - "computed": true - }, - "resource_type": { - "name": "resource_type", - "type": "TypeString", - "description": "The resource type", - "computed": true - } - } - }, - { - "name": "resource_type", - "type": "TypeString", - "description": "The resource type : [ subnet_reserved_ip ]", - "computed": true - }, { "name": "allowed_vlans", "type": "TypeSet", @@ -37179,15 +37373,9 @@ } }, { - "name": "network_interface", - "type": "TypeString", - "description": "The bare metal server network interface identifier", - "required": true - }, - { - "name": "enable_infrastructure_nat", + "name": "allow_ip_spoofing", "type": "TypeBool", - "description": "If true, the VPC infrastructure performs any needed NAT operations. If false, the packet is passed unmodified to/from the network interface, allowing the workload to perform any needed NAT operations.", + "description": "Indicates whether source IP spoofing is allowed on this interface. If false, source IP spoofing is prevented on this interface. If true, source IP spoofing is allowed on this interface.", "computed": true }, { @@ -37242,27 +37430,33 @@ "computed": true }, { - "name": "vlan", - "type": "TypeInt", - "description": "Indicates the 802.1Q VLAN ID tag that must be used for all traffic on this interface", + "name": "name", + "type": "TypeString", + "description": "The user-defined name for this network interface", "computed": true }, { - "name": "status", + "name": "subnet", "type": "TypeString", - "description": "The status of the network interface : [ available, deleting, failed, pending ]", + "description": "The id of the associated subnet", "computed": true }, { - "name": "allow_interface_to_float", - "type": "TypeBool", - "description": "Indicates if the interface can float to any other server within the same resource_group. The interface will float automatically if the network detects a GARP or RARP on another bare metal server in the resource group. Applies only to vlan type interfaces.", + "name": "bare_metal_server", + "type": "TypeString", + "description": "The bare metal server identifier", + "required": true + }, + { + "name": "href", + "type": "TypeString", + "description": "The URL for this network interface", "computed": true }, { - "name": "allow_ip_spoofing", + "name": "allow_interface_to_float", "type": "TypeBool", - "description": "Indicates whether source IP spoofing is allowed on this interface. If false, source IP spoofing is prevented on this interface. If true, source IP spoofing is allowed on this interface.", + "description": "Indicates if the interface can float to any other server within the same resource_group. The interface will float automatically if the network detects a GARP or RARP on another bare metal server in the resource group. Applies only to vlan type interfaces.", "computed": true }, { @@ -37272,9 +37466,15 @@ "computed": true }, { - "name": "port_speed", + "name": "type", + "type": "TypeString", + "description": "The type of this bare metal server network interface : [ primary, secondary ]", + "computed": true + }, + { + "name": "vlan", "type": "TypeInt", - "description": "The network interface port speed in Mbps", + "description": "Indicates the 802.1Q VLAN ID tag that must be used for all traffic on this interface", "computed": true }, { @@ -37287,31 +37487,87 @@ } }, { - "name": "href", + "name": "status", "type": "TypeString", - "description": "The URL for this network interface", + "description": "The status of the network interface : [ available, deleting, failed, pending ]", "computed": true }, { - "name": "subnet", + "name": "network_interface", "type": "TypeString", - "description": "The id of the associated subnet", + "description": "The bare metal server network interface identifier", + "required": true + }, + { + "name": "enable_infrastructure_nat", + "type": "TypeBool", + "description": "If true, the VPC infrastructure performs any needed NAT operations. If false, the packet is passed unmodified to/from the network interface, allowing the workload to perform any needed NAT operations.", "computed": true }, { - "name": "bare_metal_server", - "type": "TypeString", - "description": "The bare metal server identifier", - "required": true + "name": "port_speed", + "type": "TypeInt", + "description": "The network interface port speed in Mbps", + "computed": true }, { - "name": "type", + "name": "primary_ip", + "type": "TypeList", + "description": "IPv4, The IP address.", + "computed": true, + "elem": { + "address": { + "name": "address", + "type": "TypeString", + "description": "The globally unique IP address", + "computed": true + }, + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this reserved IP", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The user-defined name for this reserved IP. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the subnet the reserved IP resides in.", + "computed": true + }, + "reserved_ip": { + "name": "reserved_ip", + "type": "TypeString", + "description": "Identifies a reserved IP by a unique property.", + "computed": true + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type", + "computed": true + } + } + }, + { + "name": "resource_type", "type": "TypeString", - "description": "The type of this bare metal server network interface : [ primary, secondary ]", + "description": "The resource type : [ subnet_reserved_ip ]", "computed": true } ], "ibm_is_bare_metal_server_network_interface_floating_ip": [ + { + "name": "bare_metal_server", + "type": "TypeString", + "description": "The bare metal server identifier", + "required": true + }, + { + "name": "network_interface", + "type": "TypeString", + "description": "The network interface identifier of bare metal server", + "required": true + }, { "name": "floating_ip", "type": "TypeString", @@ -37324,12 +37580,6 @@ "description": "Floating IP address", "computed": true }, - { - "name": "target", - "type": "TypeString", - "description": "Target info", - "computed": true - }, { "name": "status", "type": "TypeString", @@ -37343,23 +37593,17 @@ "computed": true }, { - "name": "crn", + "name": "target", "type": "TypeString", - "description": "Floating IP crn", - "cloud_data_type": "crn", + "description": "Target info", "computed": true }, { - "name": "bare_metal_server", - "type": "TypeString", - "description": "The bare metal server identifier", - "required": true - }, - { - "name": "network_interface", + "name": "crn", "type": "TypeString", - "description": "The network interface identifier of bare metal server", - "required": true + "description": "Floating IP crn", + "cloud_data_type": "crn", + "computed": true }, { "name": "name", @@ -37433,6 +37677,12 @@ } ], "ibm_is_bare_metal_server_network_interface_reserved_ip": [ + { + "name": "auto_delete", + "type": "TypeBool", + "description": "If set to true, this reserved IP will be automatically deleted", + "computed": true + }, { "name": "created_at", "type": "TypeString", @@ -37452,21 +37702,21 @@ "computed": true }, { - "name": "target", + "name": "owner", "type": "TypeString", - "description": "Reserved IP target id.", + "description": "The owner of a reserved IP, defining whether it is managed by the user or the provider.", "computed": true }, { - "name": "address", + "name": "resource_type", "type": "TypeString", - "description": "The IP address", + "description": "The resource type.", "computed": true }, { - "name": "network_interface", + "name": "bare_metal_server", "type": "TypeString", - "description": "The Bare Metal Server network interface identifier.", + "description": "The Bare Metal Server identifier.", "required": true }, { @@ -37476,28 +37726,22 @@ "required": true }, { - "name": "auto_delete", - "type": "TypeBool", - "description": "If set to true, this reserved IP will be automatically deleted", - "computed": true - }, - { - "name": "owner", + "name": "target", "type": "TypeString", - "description": "The owner of a reserved IP, defining whether it is managed by the user or the provider.", + "description": "Reserved IP target id.", "computed": true }, { - "name": "resource_type", + "name": "network_interface", "type": "TypeString", - "description": "The resource type.", - "computed": true + "description": "The Bare Metal Server network interface identifier.", + "required": true }, { - "name": "bare_metal_server", + "name": "address", "type": "TypeString", - "description": "The Bare Metal Server identifier.", - "required": true + "description": "The IP address", + "computed": true } ], "ibm_is_bare_metal_server_network_interface_reserved_ips": [ @@ -37583,12 +37827,6 @@ } ], "ibm_is_bare_metal_server_network_interfaces": [ - { - "name": "bare_metal_server", - "type": "TypeString", - "description": "The bare metal server identifier", - "required": true - }, { "name": "network_interfaces", "type": "TypeList", @@ -37781,19 +38019,42 @@ "computed": true } } + }, + { + "name": "bare_metal_server", + "type": "TypeString", + "description": "The bare metal server identifier", + "required": true } ], "ibm_is_bare_metal_server_profile": [ { - "name": "resource_type", - "type": "TypeString", - "description": "The resource type for this bare metal server profile", - "computed": true + "name": "console_types", + "type": "TypeList", + "description": "The console type configuration for a bare metal server with this profile.", + "computed": true, + "elem": { + "type": { + "name": "type", + "type": "TypeString", + "description": "The type for this profile field.", + "computed": true + }, + "values": { + "name": "values", + "type": "TypeList", + "description": "The console types for a bare metal server with this profile.", + "computed": true, + "elem": { + "type": "TypeString" + } + } + } }, { - "name": "memory", + "name": "cpu_socket_count", "type": "TypeList", - "description": "The memory (in gibibytes) for a bare metal server with this profile", + "description": "The number of CPU sockets for a bare metal server with this profile", "computed": true, "elem": { "type": { @@ -37810,6 +38071,47 @@ } } }, + { + "name": "name", + "type": "TypeString", + "description": "The name for this bare metal server profile", + "required": true + }, + { + "name": "href", + "type": "TypeString", + "description": "The URL for this bare metal server profile", + "computed": true + }, + { + "name": "os_architecture", + "type": "TypeList", + "description": "The supported OS architecture(s) for a bare metal server with this profile", + "computed": true, + "elem": { + "default": { + "name": "default", + "type": "TypeString", + "description": "The default for this profile field", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "The type for this profile field", + "computed": true + }, + "values": { + "name": "values", + "type": "TypeSet", + "description": "The supported OS architecture(s) for a bare metal server with this profile", + "computed": true, + "elem": { + "type": "TypeString" + } + } + } + }, { "name": "disks", "type": "TypeList", @@ -37894,9 +38196,9 @@ "computed": true }, { - "name": "cpu_core_count", + "name": "bandwidth", "type": "TypeList", - "description": "The CPU core count for a bare metal server with this profile", + "description": "The total bandwidth (in megabits per second) shared across the network interfaces of a bare metal server with this profile", "computed": true, "elem": { "type": { @@ -37914,87 +38216,60 @@ } }, { - "name": "cpu_socket_count", + "name": "network_interface_count", "type": "TypeList", - "description": "The number of CPU sockets for a bare metal server with this profile", "computed": true, "elem": { - "type": { - "name": "type", - "type": "TypeString", - "description": "The type for this profile field", + "max": { + "name": "max", + "type": "TypeInt", + "description": "The maximum value for this profile field.", "computed": true }, - "value": { - "name": "value", + "min": { + "name": "min", "type": "TypeInt", - "description": "The value for this profile field", + "description": "The minimum value for this profile field.", "computed": true - } - } - }, - { - "name": "supported_trusted_platform_module_modes", - "type": "TypeList", - "description": "An array of supported trusted platform module (TPM) modes for this bare metal server profile", - "computed": true, - "elem": { + }, "type": { "name": "type", "type": "TypeString", - "description": "The type for this profile field", + "description": "The type for this profile field.", "computed": true - }, - "values": { - "name": "values", - "type": "TypeSet", - "description": "The supported trusted platform module (TPM) modes", - "computed": true, - "elem": { - "type": "TypeString" - } } } }, { - "name": "os_architecture", + "name": "cpu_architecture", "type": "TypeList", - "description": "The supported OS architecture(s) for a bare metal server with this profile", + "description": "The CPU architecture for a bare metal server with this profile", "computed": true, "elem": { - "default": { - "name": "default", - "type": "TypeString", - "description": "The default for this profile field", - "computed": true - }, "type": { "name": "type", "type": "TypeString", "description": "The type for this profile field", "computed": true }, - "values": { - "name": "values", - "type": "TypeSet", - "description": "The supported OS architecture(s) for a bare metal server with this profile", - "computed": true, - "elem": { - "type": "TypeString" - } + "value": { + "name": "value", + "type": "TypeString", + "description": "The value for this profile field", + "computed": true } } }, { - "name": "name", + "name": "resource_type", "type": "TypeString", - "description": "The name for this bare metal server profile", - "required": true + "description": "The resource type for this bare metal server profile", + "computed": true }, { - "name": "bandwidth", + "name": "cpu_core_count", "type": "TypeList", - "description": "The total bandwidth (in megabits per second) shared across the network interfaces of a bare metal server with this profile", + "description": "The CPU core count for a bare metal server with this profile", "computed": true, "elem": { "type": { @@ -38012,32 +38287,9 @@ } }, { - "name": "console_types", - "type": "TypeList", - "description": "The console type configuration for a bare metal server with this profile.", - "computed": true, - "elem": { - "type": { - "name": "type", - "type": "TypeString", - "description": "The type for this profile field.", - "computed": true - }, - "values": { - "name": "values", - "type": "TypeList", - "description": "The console types for a bare metal server with this profile.", - "computed": true, - "elem": { - "type": "TypeString" - } - } - } - }, - { - "name": "cpu_architecture", + "name": "memory", "type": "TypeList", - "description": "The CPU architecture for a bare metal server with this profile", + "description": "The memory (in gibibytes) for a bare metal server with this profile", "computed": true, "elem": { "type": { @@ -38048,40 +38300,32 @@ }, "value": { "name": "value", - "type": "TypeString", + "type": "TypeInt", "description": "The value for this profile field", "computed": true } } }, { - "name": "href", - "type": "TypeString", - "description": "The URL for this bare metal server profile", - "computed": true - }, - { - "name": "network_interface_count", + "name": "supported_trusted_platform_module_modes", "type": "TypeList", + "description": "An array of supported trusted platform module (TPM) modes for this bare metal server profile", "computed": true, "elem": { - "max": { - "name": "max", - "type": "TypeInt", - "description": "The maximum value for this profile field.", - "computed": true - }, - "min": { - "name": "min", - "type": "TypeInt", - "description": "The minimum value for this profile field.", - "computed": true - }, "type": { "name": "type", "type": "TypeString", - "description": "The type for this profile field.", + "description": "The type for this profile field", "computed": true + }, + "values": { + "name": "values", + "type": "TypeSet", + "description": "The supported trusted platform module (TPM) modes", + "computed": true, + "elem": { + "type": "TypeString" + } } } } @@ -38411,36 +38655,12 @@ "cloud_data_type": "resource_group", "optional": true }, - { - "name": "vpc", - "type": "TypeString", - "description": "The vpc ID this bare metal server is in", - "optional": true - }, - { - "name": "vpc_name", - "type": "TypeString", - "description": "The vpc name this bare metal server is in", - "optional": true - }, { "name": "vpc_crn", "type": "TypeString", "description": "The vpc CRN this bare metal server is in", "optional": true }, - { - "name": "network_interfaces_subnet_crn", - "type": "TypeString", - "description": "The crn of the subnet of the bare metal server network interfaces", - "optional": true - }, - { - "name": "name", - "type": "TypeString", - "description": "The name of the bare metal server", - "optional": true - }, { "name": "network_interfaces_subnet", "type": "TypeString", @@ -38448,9 +38668,9 @@ "optional": true }, { - "name": "network_interfaces_subnet_name", + "name": "network_interfaces_subnet_crn", "type": "TypeString", - "description": "The name of the subnet of the bare metal server network interfaces", + "description": "The crn of the subnet of the bare metal server network interfaces", "optional": true }, { @@ -38878,9 +39098,74 @@ "computed": true } } + }, + { + "name": "vpc", + "type": "TypeString", + "description": "The vpc ID this bare metal server is in", + "optional": true + }, + { + "name": "vpc_name", + "type": "TypeString", + "description": "The vpc name this bare metal server is in", + "optional": true + }, + { + "name": "name", + "type": "TypeString", + "description": "The name of the bare metal server", + "optional": true + }, + { + "name": "network_interfaces_subnet_name", + "type": "TypeString", + "description": "The name of the subnet of the bare metal server network interfaces", + "optional": true } ], "ibm_is_dedicated_host": [ + { + "name": "resource_group", + "type": "TypeString", + "description": "The unique identifier of the resource group this dedicated host belongs to", + "cloud_data_type": "resource_group", + "optional": true, + "computed": true + }, + { + "name": "available_vcpu", + "type": "TypeList", + "description": "The available VCPU for the dedicated host.", + "computed": true, + "elem": { + "architecture": { + "name": "architecture", + "type": "TypeString", + "description": "The VCPU architecture.", + "computed": true + }, + "count": { + "name": "count", + "type": "TypeInt", + "description": "The number of VCPUs assigned.", + "computed": true + }, + "manufacturer": { + "name": "manufacturer", + "type": "TypeString", + "description": "The VCPU manufacturer.", + "computed": true + } + } + }, + { + "name": "crn", + "type": "TypeString", + "description": "The CRN for this dedicated host.", + "cloud_data_type": "crn", + "computed": true + }, { "name": "disks", "type": "TypeList", @@ -39010,6 +39295,42 @@ "description": "If set to true, instances can be placed on this dedicated host.", "computed": true }, + { + "name": "resource_type", + "type": "TypeString", + "description": "The type of resource referenced.", + "computed": true + }, + { + "name": "state", + "type": "TypeString", + "description": "The administrative state of the dedicated host.The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the dedicated host on which the unexpected property value was encountered.", + "computed": true + }, + { + "name": "zone", + "type": "TypeString", + "description": "The globally unique name of the zone this dedicated host resides in.", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "The unique name of this dedicated host", + "required": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "The date and time that the dedicated host was created.", + "computed": true + }, + { + "name": "href", + "type": "TypeString", + "description": "The URL for this dedicated host.", + "computed": true + }, { "name": "instances", "type": "TypeList", @@ -39056,6 +39377,12 @@ } } }, + { + "name": "memory", + "type": "TypeInt", + "description": "The total amount of memory in gibibytes for this host.", + "computed": true + }, { "name": "provisionable", "type": "TypeBool", @@ -39063,9 +39390,9 @@ "computed": true }, { - "name": "state", - "type": "TypeString", - "description": "The administrative state of the dedicated host.The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the dedicated host on which the unexpected property value was encountered.", + "name": "socket_count", + "type": "TypeInt", + "description": "The total number of sockets for this host.", "computed": true }, { @@ -39094,12 +39421,27 @@ } } }, + { + "name": "access_tags", + "type": "TypeSet", + "description": "List of access tags", + "computed": true, + "elem": { + "type": "TypeString" + } + }, { "name": "host_group", "type": "TypeString", "description": "The unique identifier of the dedicated host group this dedicated host belongs to", "required": true }, + { + "name": "lifecycle_state", + "type": "TypeString", + "description": "The lifecycle state of the dedicated host resource.", + "computed": true + }, { "name": "available_memory", "type": "TypeInt", @@ -39126,53 +39468,6 @@ } } }, - { - "name": "socket_count", - "type": "TypeInt", - "description": "The total number of sockets for this host.", - "computed": true - }, - { - "name": "access_tags", - "type": "TypeSet", - "description": "List of access tags", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "available_vcpu", - "type": "TypeList", - "description": "The available VCPU for the dedicated host.", - "computed": true, - "elem": { - "architecture": { - "name": "architecture", - "type": "TypeString", - "description": "The VCPU architecture.", - "computed": true - }, - "count": { - "name": "count", - "type": "TypeInt", - "description": "The number of VCPUs assigned.", - "computed": true - }, - "manufacturer": { - "name": "manufacturer", - "type": "TypeString", - "description": "The VCPU manufacturer.", - "computed": true - } - } - }, - { - "name": "lifecycle_state", - "type": "TypeString", - "description": "The lifecycle state of the dedicated host resource.", - "computed": true - }, { "name": "supported_instance_profiles", "type": "TypeList", @@ -39192,84 +39487,15 @@ "computed": true } } - }, - { - "name": "name", - "type": "TypeString", - "description": "The unique name of this dedicated host", - "required": true - }, - { - "name": "resource_type", - "type": "TypeString", - "description": "The type of resource referenced.", - "computed": true - }, - { - "name": "crn", - "type": "TypeString", - "description": "The CRN for this dedicated host.", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "href", - "type": "TypeString", - "description": "The URL for this dedicated host.", - "computed": true - }, - { - "name": "memory", - "type": "TypeInt", - "description": "The total amount of memory in gibibytes for this host.", - "computed": true - }, - { - "name": "zone", - "type": "TypeString", - "description": "The globally unique name of the zone this dedicated host resides in.", - "computed": true - }, - { - "name": "resource_group", - "type": "TypeString", - "description": "The unique identifier of the resource group this dedicated host belongs to", - "cloud_data_type": "resource_group", - "optional": true, - "computed": true - }, - { - "name": "created_at", - "type": "TypeString", - "description": "The date and time that the dedicated host was created.", - "computed": true } ], "ibm_is_dedicated_host_disk": [ - { - "name": "disk", - "type": "TypeString", - "description": "The dedicated host disk identifier.", - "required": true - }, - { - "name": "available", - "type": "TypeInt", - "description": "The remaining space left for instance placement in GB (gigabytes).", - "computed": true - }, { "name": "created_at", "type": "TypeString", "description": "The date and time that the disk was created.", "computed": true }, - { - "name": "href", - "type": "TypeString", - "description": "The URL for this disk.", - "computed": true - }, { "name": "interface_type", "type": "TypeString", @@ -39289,11 +39515,23 @@ "computed": true }, { - "name": "dedicated_host", + "name": "available", + "type": "TypeInt", + "description": "The remaining space left for instance placement in GB (gigabytes).", + "computed": true + }, + { + "name": "disk", "type": "TypeString", - "description": "The dedicated host identifier.", + "description": "The dedicated host disk identifier.", "required": true }, + { + "name": "href", + "type": "TypeString", + "description": "The URL for this disk.", + "computed": true + }, { "name": "instance_disks", "type": "TypeList", @@ -39366,15 +39604,15 @@ "elem": { "type": "TypeString" } - } - ], - "ibm_is_dedicated_host_disks": [ + }, { "name": "dedicated_host", "type": "TypeString", "description": "The dedicated host identifier.", "required": true - }, + } + ], + "ibm_is_dedicated_host_disks": [ { "name": "disks", "type": "TypeList", @@ -39497,39 +39735,32 @@ } } } + }, + { + "name": "dedicated_host", + "type": "TypeString", + "description": "The dedicated host identifier.", + "required": true } ], "ibm_is_dedicated_host_group": [ { - "name": "supported_instance_profiles", - "type": "TypeList", - "description": "Array of instance profiles that can be used by instances placed on this dedicated host group.", - "computed": true, - "elem": { - "href": { - "name": "href", - "type": "TypeString", - "description": "The URL for this virtual server instance profile.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "The globally unique name for this virtual server instance profile.", - "computed": true - } - } + "name": "resource_group", + "type": "TypeString", + "description": "The unique identifier of the resource group for this dedicated host group.", + "cloud_data_type": "resource_group", + "computed": true }, { - "name": "name", + "name": "resource_type", "type": "TypeString", - "description": "The unique user-defined name for this dedicated host. If unspecified, the name will be a hyphenated list of randomly-selected words.", - "required": true + "description": "The type of resource referenced.", + "computed": true }, { - "name": "class", + "name": "zone", "type": "TypeString", - "description": "The dedicated host profile class for hosts in this group.", + "description": "The globally unique name of the zone this dedicated host group resides in.", "computed": true }, { @@ -39591,12 +39822,6 @@ } } }, - { - "name": "family", - "type": "TypeString", - "description": "The dedicated host profile family for hosts in this group.", - "computed": true - }, { "name": "href", "type": "TypeString", @@ -39604,28 +39829,47 @@ "computed": true }, { - "name": "created_at", + "name": "family", "type": "TypeString", - "description": "The date and time that the dedicated host group was created.", + "description": "The dedicated host profile family for hosts in this group.", "computed": true }, { - "name": "resource_group", + "name": "supported_instance_profiles", + "type": "TypeList", + "description": "Array of instance profiles that can be used by instances placed on this dedicated host group.", + "computed": true, + "elem": { + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this virtual server instance profile.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The globally unique name for this virtual server instance profile.", + "computed": true + } + } + }, + { + "name": "name", "type": "TypeString", - "description": "The unique identifier of the resource group for this dedicated host group.", - "cloud_data_type": "resource_group", - "computed": true + "description": "The unique user-defined name for this dedicated host. If unspecified, the name will be a hyphenated list of randomly-selected words.", + "required": true }, { - "name": "resource_type", + "name": "class", "type": "TypeString", - "description": "The type of resource referenced.", + "description": "The dedicated host profile class for hosts in this group.", "computed": true }, { - "name": "zone", + "name": "created_at", "type": "TypeString", - "description": "The globally unique name of the zone this dedicated host group resides in.", + "description": "The date and time that the dedicated host group was created.", "computed": true } ], @@ -39798,39 +40042,26 @@ ], "ibm_is_dedicated_host_profile": [ { - "name": "name", - "type": "TypeString", - "description": "The globally unique name for this virtual server instance profile.", - "optional": true - }, - { - "name": "href", - "type": "TypeString", - "description": "The URL for this dedicated host.", - "computed": true - }, - { - "name": "supported_instance_profiles", + "name": "vcpu_architecture", "type": "TypeList", - "description": "Array of instance profiles that can be used by instances placed on dedicated hosts with this profile.", "computed": true, "elem": { - "href": { - "name": "href", + "type": { + "name": "type", "type": "TypeString", - "description": "The URL for this virtual server instance profile.", + "description": "The type for this profile field.", "computed": true }, - "name": { - "name": "name", + "value": { + "name": "value", "type": "TypeString", - "description": "The globally unique name for this virtual server instance profile.", + "description": "The VCPU architecture for a dedicated host with this profile.", "computed": true } } }, { - "name": "memory", + "name": "vcpu_count", "type": "TypeList", "computed": true, "elem": { @@ -39882,7 +40113,32 @@ } }, { - "name": "socket_count", + "name": "vcpu_manufacturer", + "type": "TypeList", + "computed": true, + "elem": { + "type": { + "name": "type", + "type": "TypeString", + "description": "The type for this profile field.", + "computed": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "The VCPU manufacturer for a dedicated host with this profile.", + "computed": true + } + } + }, + { + "name": "name", + "type": "TypeString", + "description": "The globally unique name for this virtual server instance profile.", + "optional": true + }, + { + "name": "memory", "type": "TypeList", "computed": true, "elem": { @@ -39934,26 +40190,7 @@ } }, { - "name": "vcpu_architecture", - "type": "TypeList", - "computed": true, - "elem": { - "type": { - "name": "type", - "type": "TypeString", - "description": "The type for this profile field.", - "computed": true - }, - "value": { - "name": "value", - "type": "TypeString", - "description": "The VCPU architecture for a dedicated host with this profile.", - "computed": true - } - } - }, - { - "name": "vcpu_count", + "name": "socket_count", "type": "TypeList", "computed": true, "elem": { @@ -40005,20 +40242,21 @@ } }, { - "name": "vcpu_manufacturer", + "name": "supported_instance_profiles", "type": "TypeList", + "description": "Array of instance profiles that can be used by instances placed on dedicated hosts with this profile.", "computed": true, "elem": { - "type": { - "name": "type", + "href": { + "name": "href", "type": "TypeString", - "description": "The type for this profile field.", + "description": "The URL for this virtual server instance profile.", "computed": true }, - "value": { - "name": "value", + "name": { + "name": "name", "type": "TypeString", - "description": "The VCPU manufacturer for a dedicated host with this profile.", + "description": "The globally unique name for this virtual server instance profile.", "computed": true } } @@ -40123,6 +40361,12 @@ "type": "TypeString", "description": "The product family this dedicated host profile belongs toThe enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected property value was encountered.", "computed": true + }, + { + "name": "href", + "type": "TypeString", + "description": "The URL for this dedicated host.", + "computed": true } ], "ibm_is_dedicated_host_profiles": [ @@ -40469,12 +40713,6 @@ } ], "ibm_is_dedicated_hosts": [ - { - "name": "host_group", - "type": "TypeString", - "description": "The unique identifier of the dedicated host group this dedicated host belongs to", - "optional": true - }, { "name": "resource_group", "type": "TypeString", @@ -40873,6 +41111,12 @@ "type": "TypeInt", "description": "The total number of resources across all pages.", "computed": true + }, + { + "name": "host_group", + "type": "TypeString", + "description": "The unique identifier of the dedicated host group this dedicated host belongs to", + "optional": true } ], "ibm_is_endpoint_gateway_targets": [ @@ -40932,17 +41176,37 @@ ], "ibm_is_floating_ip": [ { - "name": "address", + "name": "target", "type": "TypeString", - "description": "Floating IP address", + "description": "Target info", "computed": true }, { - "name": "zone", + "name": "crn", "type": "TypeString", - "description": "Zone name", + "description": "Floating IP crn", + "cloud_data_type": "crn", "computed": true }, + { + "name": "tags", + "type": "TypeSet", + "description": "Floating IP tags", + "cloud_data_type": "tags", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "access_tags", + "type": "TypeSet", + "description": "List of access management tags", + "computed": true, + "elem": { + "type": "TypeString" + } + }, { "name": "name", "type": "TypeString", @@ -40950,9 +41214,9 @@ "required": true }, { - "name": "target", + "name": "address", "type": "TypeString", - "description": "Target info", + "description": "Floating IP address", "computed": true }, { @@ -41046,46 +41310,19 @@ } }, { - "name": "crn", + "name": "status", "type": "TypeString", - "description": "Floating IP crn", - "cloud_data_type": "crn", + "description": "Floating IP status", "computed": true }, { - "name": "tags", - "type": "TypeSet", - "description": "Floating IP tags", - "cloud_data_type": "tags", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "access_tags", - "type": "TypeSet", - "description": "List of access management tags", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "status", + "name": "zone", "type": "TypeString", - "description": "Floating IP status", + "description": "Zone name", "computed": true } ], "ibm_is_floating_ips": [ - { - "name": "resource_group", - "type": "TypeString", - "description": "The unique identifier of the resource group this floating ips belongs to", - "cloud_data_type": "resource_group", - "optional": true - }, { "name": "name", "type": "TypeString", @@ -41292,6 +41529,13 @@ } } } + }, + { + "name": "resource_group", + "type": "TypeString", + "description": "The unique identifier of the resource group this floating ips belongs to", + "cloud_data_type": "resource_group", + "optional": true } ], "ibm_is_flow_log": [ @@ -41307,12 +41551,72 @@ "description": "Indicates whether this collector is active.", "computed": true }, + { + "name": "href", + "type": "TypeString", + "description": "The URL for this flow log collector.", + "computed": true + }, + { + "name": "lifecycle_state", + "type": "TypeString", + "description": "The lifecycle state of the flow log collector.", + "computed": true + }, + { + "name": "resource_group", + "type": "TypeList", + "description": "The resource group for this flow log collector.", + "cloud_data_type": "resource_group", + "computed": true, + "elem": { + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this resource group.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this resource group.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The user-defined name for this resource group.", + "computed": true + } + } + }, + { + "name": "access_tags", + "type": "TypeSet", + "description": "List of access management tags", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "name", + "type": "TypeString", + "description": "The unique user-defined name for this flow log collector.", + "optional": true + }, { "name": "auto_delete", "type": "TypeBool", "description": "If set to `true`, this flow log collector will be automatically deleted when the target is deleted.", "computed": true }, + { + "name": "created_at", + "type": "TypeString", + "description": "The date and time that the flow log collector was created.", + "computed": true + }, { "name": "crn", "type": "TypeString", @@ -41431,93 +41735,9 @@ "computed": true } } - }, - { - "name": "access_tags", - "type": "TypeSet", - "description": "List of access management tags", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "name", - "type": "TypeString", - "description": "The unique user-defined name for this flow log collector.", - "optional": true - }, - { - "name": "created_at", - "type": "TypeString", - "description": "The date and time that the flow log collector was created.", - "computed": true - }, - { - "name": "href", - "type": "TypeString", - "description": "The URL for this flow log collector.", - "computed": true - }, - { - "name": "lifecycle_state", - "type": "TypeString", - "description": "The lifecycle state of the flow log collector.", - "computed": true - }, - { - "name": "resource_group", - "type": "TypeList", - "description": "The resource group for this flow log collector.", - "cloud_data_type": "resource_group", - "computed": true, - "elem": { - "href": { - "name": "href", - "type": "TypeString", - "description": "The URL for this resource group.", - "computed": true - }, - "id": { - "name": "id", - "type": "TypeString", - "description": "The unique identifier for this resource group.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "The user-defined name for this resource group.", - "computed": true - } - } } ], "ibm_is_flow_logs": [ - { - "name": "vpc_name", - "type": "TypeString", - "description": "The vpc name this flow log is in", - "optional": true - }, - { - "name": "vpc_crn", - "type": "TypeString", - "description": "The vpc CRN this flow log is in", - "optional": true - }, - { - "name": "name", - "type": "TypeString", - "description": "The name of the flow log", - "optional": true - }, - { - "name": "target", - "type": "TypeString", - "description": "The target id of the flow log", - "optional": true - }, { "name": "target_resource_type", "type": "TypeString", @@ -41628,6 +41848,30 @@ "type": "TypeString", "description": "The vpc ID this flow log is in", "optional": true + }, + { + "name": "vpc_name", + "type": "TypeString", + "description": "The vpc name this flow log is in", + "optional": true + }, + { + "name": "vpc_crn", + "type": "TypeString", + "description": "The vpc CRN this flow log is in", + "optional": true + }, + { + "name": "name", + "type": "TypeString", + "description": "The name of the flow log", + "optional": true + }, + { + "name": "target", + "type": "TypeString", + "description": "The target id of the flow log", + "optional": true } ], "ibm_is_ike_policies": [ @@ -41780,50 +42024,75 @@ ], "ibm_is_ike_policy": [ { - "name": "href", + "name": "ike_policy", "type": "TypeString", - "description": "The IKE policy's canonical URL.", - "computed": true - }, - { - "name": "key_lifetime", - "type": "TypeInt", - "description": "The key lifetime in seconds.", - "computed": true + "description": "The IKE policy identifier.", + "optional": true }, { - "name": "resource_group", + "name": "connections", "type": "TypeList", - "description": "The resource group for this IKE policy.", - "cloud_data_type": "resource_group", + "description": "The VPN gateway connections that use this IKE policy.", "computed": true, "elem": { + "deleted": { + "name": "deleted", + "type": "TypeList", + "description": "If present, this property indicates the referenced resource has been deleted and providessome supplementary information.", + "computed": true, + "elem": { + "more_info": { + "name": "more_info", + "type": "TypeString", + "description": "Link to documentation about deleted resources.", + "computed": true + } + } + }, "href": { "name": "href", "type": "TypeString", - "description": "The URL for this resource group.", + "description": "The VPN connection's canonical URL.", "computed": true }, "id": { "name": "id", "type": "TypeString", - "description": "The unique identifier for this resource group.", + "description": "The unique identifier for this VPN gateway connection.", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "The user-defined name for this resource group.", + "description": "The user-defined name for this VPN connection.", + "computed": true + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", "computed": true } } }, + { + "name": "ike_version", + "type": "TypeInt", + "description": "The IKE protocol version.", + "computed": true + }, { "name": "resource_type", "type": "TypeString", "description": "The resource type.", "computed": true }, + { + "name": "negotiation_mode", + "type": "TypeString", + "description": "The IKE negotiation mode. Only `main` is supported.", + "computed": true + }, { "name": "name", "type": "TypeString", @@ -41837,9 +42106,9 @@ "computed": true }, { - "name": "encryption_algorithm", + "name": "created_at", "type": "TypeString", - "description": "The encryption algorithm.", + "description": "The date and time that this IKE policy was created.", "computed": true }, { @@ -41849,82 +42118,57 @@ "computed": true }, { - "name": "ike_version", - "type": "TypeInt", - "description": "The IKE protocol version.", + "name": "encryption_algorithm", + "type": "TypeString", + "description": "The encryption algorithm.", "computed": true }, { - "name": "negotiation_mode", + "name": "href", "type": "TypeString", - "description": "The IKE negotiation mode. Only `main` is supported.", + "description": "The IKE policy's canonical URL.", "computed": true }, { - "name": "ike_policy", - "type": "TypeString", - "description": "The IKE policy identifier.", - "optional": true + "name": "key_lifetime", + "type": "TypeInt", + "description": "The key lifetime in seconds.", + "computed": true }, { - "name": "connections", + "name": "resource_group", "type": "TypeList", - "description": "The VPN gateway connections that use this IKE policy.", + "description": "The resource group for this IKE policy.", + "cloud_data_type": "resource_group", "computed": true, "elem": { - "deleted": { - "name": "deleted", - "type": "TypeList", - "description": "If present, this property indicates the referenced resource has been deleted and providessome supplementary information.", - "computed": true, - "elem": { - "more_info": { - "name": "more_info", - "type": "TypeString", - "description": "Link to documentation about deleted resources.", - "computed": true - } - } - }, "href": { "name": "href", "type": "TypeString", - "description": "The VPN connection's canonical URL.", + "description": "The URL for this resource group.", "computed": true }, "id": { "name": "id", "type": "TypeString", - "description": "The unique identifier for this VPN gateway connection.", + "description": "The unique identifier for this resource group.", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "The user-defined name for this VPN connection.", - "computed": true - }, - "resource_type": { - "name": "resource_type", - "type": "TypeString", - "description": "The resource type.", + "description": "The user-defined name for this resource group.", "computed": true } } - }, - { - "name": "created_at", - "type": "TypeString", - "description": "The date and time that this IKE policy was created.", - "computed": true } ], "ibm_is_image": [ { - "name": "status", + "name": "name", "type": "TypeString", - "description": "The status of this image", - "computed": true + "description": "Image name", + "optional": true }, { "name": "os", @@ -41933,38 +42177,11 @@ "computed": true }, { - "name": "deprecation_at", - "type": "TypeString", - "description": "The deprecation date and time (UTC) for this image. If absent, no deprecation date and time has been set.", - "computed": true - }, - { - "name": "encryption", - "type": "TypeString", - "description": "The type of encryption used on the image", - "computed": true - }, - { - "name": "created_at", + "name": "architecture", "type": "TypeString", - "description": "The date and time that the image was created", + "description": "The operating system architecture", "computed": true }, - { - "name": "access_tags", - "type": "TypeSet", - "description": "List of access tags", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "name", - "type": "TypeString", - "description": "Image name", - "optional": true - }, { "name": "crn", "type": "TypeString", @@ -41972,12 +42189,6 @@ "cloud_data_type": "crn", "computed": true }, - { - "name": "encryption_key", - "type": "TypeString", - "description": "The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource", - "computed": true - }, { "name": "checksum", "type": "TypeString", @@ -41985,15 +42196,15 @@ "computed": true }, { - "name": "source_volume", + "name": "visibility", "type": "TypeString", - "description": "Source volume id of the image", - "computed": true + "description": "Whether the image is publicly visible or private to the account", + "optional": true }, { - "name": "obsolescence_at", + "name": "source_volume", "type": "TypeString", - "description": "The obsolescence date and time (UTC) for this image. If absent, no obsolescence date and time has been set.", + "description": "Source volume id of the image", "computed": true }, { @@ -42030,43 +42241,58 @@ "optional": true }, { - "name": "visibility", + "name": "status", "type": "TypeString", - "description": "Whether the image is publicly visible or private to the account", - "optional": true + "description": "The status of this image", + "computed": true }, { - "name": "architecture", + "name": "encryption", "type": "TypeString", - "description": "The operating system architecture", + "description": "The type of encryption used on the image", "computed": true - } - ], - "ibm_is_image_export_job": [ + }, { - "name": "format", + "name": "created_at", "type": "TypeString", - "description": "The format of the exported image.", + "description": "The date and time that the image was created", "computed": true }, { - "name": "href", + "name": "deprecation_at", "type": "TypeString", - "description": "The URL for this image export job.", + "description": "The deprecation date and time (UTC) for this image. If absent, no deprecation date and time has been set.", "computed": true }, { - "name": "status", + "name": "encryption_key", "type": "TypeString", - "description": "The status of this image export job:- `deleting`: Export job is being deleted- `failed`: Export job could not be completed successfully- `queued`: Export job is queued- `running`: Export job is in progress- `succeeded`: Export job was completed successfullyThe exported image object is automatically deleted for `failed` jobs.", + "description": "The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource", "computed": true }, { - "name": "encrypted_data_key", + "name": "obsolescence_at", "type": "TypeString", - "description": "A base64-encoded, encrypted representation of the key that was used to encrypt the data for the exported image. This key can be unwrapped with the image's `encryption_key` root key using either Key Protect or Hyper Protect Crypto Service.If absent, the export job is for an unencrypted image.", + "description": "The obsolescence date and time (UTC) for this image. If absent, no obsolescence date and time has been set.", "computed": true }, + { + "name": "access_tags", + "type": "TypeSet", + "description": "List of access tags", + "computed": true, + "elem": { + "type": "TypeString" + } + } + ], + "ibm_is_image_export_job": [ + { + "name": "image", + "type": "TypeString", + "description": "The image identifier.", + "required": true + }, { "name": "name", "type": "TypeString", @@ -42080,9 +42306,23 @@ "computed": true }, { - "name": "storage_href", + "name": "storage_object", + "type": "TypeList", + "description": "The Cloud Object Storage object for the exported image. This object may not exist untilthe job is started, and will not be complete until the job completes.", + "computed": true, + "elem": { + "name": { + "name": "name", + "type": "TypeString", + "description": "The name of this Cloud Object Storage object. Names are unique within a Cloud Object Storage bucket.", + "computed": true + } + } + }, + { + "name": "status", "type": "TypeString", - "description": "The Cloud Object Storage location of the exported image object. The object at this location may not exist until the job is started, and will be incomplete while the job is running.After the job completes, the exported image object is not managed by the IBM VPC service, and may be removed or replaced with a different object by any user or service with IAM authorization to the bucket.", + "description": "The status of this image export job:- `deleting`: Export job is being deleted- `failed`: Export job could not be completed successfully- `queued`: Export job is queued- `running`: Export job is in progress- `succeeded`: Export job was completed successfullyThe exported image object is automatically deleted for `failed` jobs.", "computed": true }, { @@ -42106,35 +42346,27 @@ } }, { - "name": "storage_object", - "type": "TypeList", - "description": "The Cloud Object Storage object for the exported image. This object may not exist untilthe job is started, and will not be complete until the job completes.", - "computed": true, - "elem": { - "name": { - "name": "name", - "type": "TypeString", - "description": "The name of this Cloud Object Storage object. Names are unique within a Cloud Object Storage bucket.", - "computed": true - } - } + "name": "storage_href", + "type": "TypeString", + "description": "The Cloud Object Storage location of the exported image object. The object at this location may not exist until the job is started, and will be incomplete while the job is running.After the job completes, the exported image object is not managed by the IBM VPC service, and may be removed or replaced with a different object by any user or service with IAM authorization to the bucket.", + "computed": true }, { - "name": "image_export_job", + "name": "format", "type": "TypeString", - "description": "The image export job identifier.", - "required": true + "description": "The format of the exported image.", + "computed": true }, { - "name": "completed_at", + "name": "resource_type", "type": "TypeString", - "description": "The date and time that the image export job was completed.If absent, the export job has not yet completed.", + "description": "The type of resource referenced.", "computed": true }, { - "name": "created_at", + "name": "href", "type": "TypeString", - "description": "The date and time that the image export job was created.", + "description": "The URL for this image export job.", "computed": true }, { @@ -42164,15 +42396,27 @@ } }, { - "name": "image", + "name": "image_export_job", "type": "TypeString", - "description": "The image identifier.", + "description": "The image export job identifier.", "required": true }, { - "name": "resource_type", + "name": "completed_at", "type": "TypeString", - "description": "The type of resource referenced.", + "description": "The date and time that the image export job was completed.If absent, the export job has not yet completed.", + "computed": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "The date and time that the image export job was created.", + "computed": true + }, + { + "name": "encrypted_data_key", + "type": "TypeString", + "description": "A base64-encoded, encrypted representation of the key that was used to encrypt the data for the exported image. This key can be unwrapped with the image's `encryption_key` root key using either Key Protect or Hyper Protect Crypto Service.If absent, the export job is for an unencrypted image.", "computed": true } ], @@ -42478,18 +42722,9 @@ ], "ibm_is_instance": [ { - "name": "volumes", - "type": "TypeSet", - "description": "List of volumes", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "lifecycle_state", + "name": "zone", "type": "TypeString", - "description": "The lifecycle state of the virtual server instance.", + "description": "Zone name", "computed": true }, { @@ -42503,57 +42738,40 @@ } }, { - "name": "image", - "type": "TypeString", - "description": "Instance Image", - "computed": true - }, - { - "name": "resource_name", - "type": "TypeString", - "description": "The name of the resource", - "computed": true - }, - { - "name": "resource_crn", - "type": "TypeString", - "description": "The crn of the resource", - "computed": true - }, - { - "name": "resource_group_name", + "name": "resource_group", "type": "TypeString", - "description": "The resource group name in which resource is provisioned", - "computed": true - }, - { - "name": "metadata_service_enabled", - "type": "TypeBool", - "description": "Indicates whether the metadata service endpoint is available to the virtual server instance", + "description": "Instance resource group", + "cloud_data_type": "resource_group", "computed": true }, { - "name": "status_reasons", + "name": "gpu", "type": "TypeList", - "description": "The reasons for the current status (if any).", + "description": "Instance GPU", "computed": true, "elem": { - "code": { - "name": "code", - "type": "TypeString", - "description": "A snake case string succinctly identifying the status reason", + "count": { + "name": "count", + "type": "TypeInt", + "description": "Instance GPU Count", "computed": true }, - "message": { - "name": "message", + "manufacturer": { + "name": "manufacturer", "type": "TypeString", - "description": "An explanation of the status reason", + "description": "Instance GPU Manufacturer", "computed": true }, - "more_info": { - "name": "more_info", + "memory": { + "name": "memory", + "type": "TypeInt", + "description": "Instance GPU Memory", + "computed": true + }, + "model": { + "name": "model", "type": "TypeString", - "description": "Link to documentation about this status reason", + "description": "Instance GPU Model", "computed": true } } @@ -42565,65 +42783,74 @@ "computed": true }, { - "name": "boot_volume", + "name": "keys", "type": "TypeList", - "description": "Instance Boot Volume", + "description": "Instance keys", "computed": true, "elem": { - "device": { - "name": "device", - "type": "TypeString", - "description": "Instance Boot Volume device", - "computed": true - }, "id": { "name": "id", "type": "TypeString", - "description": "Instance Boot Volume id", + "description": "Instance key id", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "Instance Boot Volume name", - "computed": true - }, - "volume_crn": { - "name": "volume_crn", - "type": "TypeString", - "description": "Instance Boot Volume's volume CRN", - "computed": true - }, - "volume_id": { - "name": "volume_id", - "type": "TypeString", - "description": "Instance Boot Volume's volume id", - "computed": true - }, - "volume_name": { - "name": "volume_name", - "type": "TypeString", - "description": "Instance Boot Volume's volume name", + "description": "Instance key name", "computed": true } } }, { - "name": "volume_attachments", + "name": "vpc", + "type": "TypeString", + "description": "VPC id", + "computed": true + }, + { + "name": "total_volume_bandwidth", + "type": "TypeInt", + "description": "The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes", + "computed": true + }, + { + "name": "total_network_bandwidth", + "type": "TypeInt", + "description": "The amount of bandwidth (in megabits per second) allocated exclusively to instance network interfaces.", + "computed": true + }, + { + "name": "access_tags", + "type": "TypeSet", + "description": "list of access tags for the instance", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "boot_volume", "type": "TypeList", - "description": "Instance Volume Attachments", + "description": "Instance Boot Volume", "computed": true, "elem": { + "device": { + "name": "device", + "type": "TypeString", + "description": "Instance Boot Volume device", + "computed": true + }, "id": { "name": "id", "type": "TypeString", - "description": "Instance Volume Attachment id", + "description": "Instance Boot Volume id", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "Instance Volume Attachment name", + "description": "Instance Boot Volume name", "computed": true }, "volume_crn": { @@ -42647,27 +42874,21 @@ } }, { - "name": "primary_network_interface", + "name": "network_interfaces", "type": "TypeList", - "description": "Primary Network interface info", + "description": "Instance Network interface info", "computed": true, "elem": { "id": { "name": "id", "type": "TypeString", - "description": "Instance Primary Network Interface id", + "description": "Instance Network Interface id", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "Instance Primary Network Interface name", - "computed": true - }, - "port_speed": { - "name": "port_speed", - "type": "TypeInt", - "description": "Instance Primary Network Interface port speed", + "description": "Instance Network Interface name", "computed": true }, "primary_ip": { @@ -42711,13 +42932,13 @@ "primary_ipv4_address": { "name": "primary_ipv4_address", "type": "TypeString", - "description": "Instance Primary Network Interface IPV4 Address", + "description": "Instance Network Interface IPV4 Address", "computed": true }, "security_groups": { "name": "security_groups", "type": "TypeSet", - "description": "Instance Primary Network Interface Security groups", + "description": "Instance Network Interface Security Groups", "computed": true, "elem": { "type": "TypeString" @@ -42726,54 +42947,116 @@ "subnet": { "name": "subnet", "type": "TypeString", - "description": "Instance Primary Network Interface subnet", + "description": "Instance Network Interface subnet", "computed": true } } }, { - "name": "resource_group", - "type": "TypeString", - "description": "Instance resource group", - "cloud_data_type": "resource_group", - "computed": true - }, - { - "name": "resource_status", - "type": "TypeString", - "description": "The status of the resource", - "computed": true - }, - { - "name": "private_key", - "type": "TypeString", - "description": "Instance Private Key file", - "optional": true - }, - { - "name": "keys", + "name": "disks", "type": "TypeList", - "description": "Instance keys", + "description": "Collection of the instance's disks.", "computed": true, "elem": { + "created_at": { + "name": "created_at", + "type": "TypeString", + "description": "The date and time that the disk was created.", + "computed": true + }, + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this instance disk.", + "computed": true + }, "id": { "name": "id", "type": "TypeString", - "description": "Instance key id", + "description": "The unique identifier for this instance disk.", + "computed": true + }, + "interface_type": { + "name": "interface_type", + "type": "TypeString", + "description": "The disk interface used for attaching the disk.The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected property value was encountered.", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "Instance key name", + "description": "The user-defined name for this disk.", + "computed": true + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true + }, + "size": { + "name": "size", + "type": "TypeInt", + "description": "The size of the disk in GB (gigabytes).", "computed": true } } }, { - "name": "bandwidth", + "name": "metadata_service", + "type": "TypeList", + "description": "The metadata service configuration", + "computed": true, + "elem": { + "enabled": { + "name": "enabled", + "type": "TypeBool", + "description": "Indicates whether the metadata service endpoint will be available to the virtual server instance", + "computed": true + }, + "protocol": { + "name": "protocol", + "type": "TypeString", + "description": "The communication protocol to use for the metadata service endpoint. Applies only when the metadata service is enabled.", + "computed": true + }, + "response_hop_limit": { + "name": "response_hop_limit", + "type": "TypeInt", + "description": "The hop limit (IP time to live) for IP response packets from the metadata service", + "computed": true + } + } + }, + { + "name": "memory", "type": "TypeInt", - "description": "The total bandwidth (in megabits per second) shared across the instance's network interfaces and storage volumes", + "description": "Instance memory", + "computed": true + }, + { + "name": "availability_policy_host_failure", + "type": "TypeString", + "description": "The availability policy to use for this virtual server instance. The action to perform if the compute host experiences a failure.", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "Instance name", + "required": true + }, + { + "name": "password", + "type": "TypeString", + "description": "password for Windows Instance", + "secure": true, + "computed": true + }, + { + "name": "image", + "type": "TypeString", + "description": "Instance Image", "computed": true }, { @@ -42829,93 +43112,69 @@ } }, { - "name": "disks", + "name": "catalog_offering", "type": "TypeList", - "description": "Collection of the instance's disks.", + "description": "The catalog offering or offering version to use when provisioning this virtual server instance. If an offering is specified, the latest version of that offering will be used. The specified offering or offering version may be in a different account in the same enterprise, subject to IAM policies.", "computed": true, "elem": { - "created_at": { - "name": "created_at", - "type": "TypeString", - "description": "The date and time that the disk was created.", - "computed": true - }, - "href": { - "name": "href", + "offering_crn": { + "name": "offering_crn", "type": "TypeString", - "description": "The URL for this instance disk.", + "description": "Identifies a catalog offering by a unique CRN property", "computed": true }, - "id": { - "name": "id", + "version_crn": { + "name": "version_crn", "type": "TypeString", - "description": "The unique identifier for this instance disk.", + "description": "Identifies a version of a catalog offering by a unique CRN property", "computed": true - }, - "interface_type": { - "name": "interface_type", + } + } + }, + { + "name": "status_reasons", + "type": "TypeList", + "description": "The reasons for the current status (if any).", + "computed": true, + "elem": { + "code": { + "name": "code", "type": "TypeString", - "description": "The disk interface used for attaching the disk.The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected property value was encountered.", + "description": "A snake case string succinctly identifying the status reason", "computed": true }, - "name": { - "name": "name", + "message": { + "name": "message", "type": "TypeString", - "description": "The user-defined name for this disk.", + "description": "An explanation of the status reason", "computed": true }, - "resource_type": { - "name": "resource_type", + "more_info": { + "name": "more_info", "type": "TypeString", - "description": "The resource type.", - "computed": true - }, - "size": { - "name": "size", - "type": "TypeInt", - "description": "The size of the disk in GB (gigabytes).", + "description": "Link to documentation about this status reason", "computed": true } } }, { - "name": "zone", + "name": "resource_crn", "type": "TypeString", - "description": "Zone name", + "description": "The crn of the resource", "computed": true }, { - "name": "profile", + "name": "resource_status", "type": "TypeString", - "description": "Profile info", + "description": "The status of the resource", "computed": true }, { - "name": "memory", - "type": "TypeInt", - "description": "Instance memory", + "name": "metadata_service_enabled", + "type": "TypeBool", + "description": "Indicates whether the metadata service endpoint is available to the virtual server instance", "computed": true }, - { - "name": "catalog_offering", - "type": "TypeList", - "description": "The catalog offering or offering version to use when provisioning this virtual server instance. If an offering is specified, the latest version of that offering will be used. The specified offering or offering version may be in a different account in the same enterprise, subject to IAM policies.", - "computed": true, - "elem": { - "offering_crn": { - "name": "offering_crn", - "type": "TypeString", - "description": "Identifies a catalog offering by a unique CRN property", - "computed": true - }, - "version_crn": { - "name": "version_crn", - "type": "TypeString", - "description": "Identifies a version of a catalog offering by a unique CRN property", - "computed": true - } - } - }, { "name": "vcpu", "type": "TypeList", @@ -42943,69 +43202,128 @@ } }, { - "name": "availability_policy_host_failure", + "name": "resource_name", "type": "TypeString", - "description": "The availability policy to use for this virtual server instance. The action to perform if the compute host experiences a failure.", + "description": "The name of the resource", "computed": true }, { - "name": "metadata_service", + "name": "status", + "type": "TypeString", + "description": "instance status", + "computed": true + }, + { + "name": "private_key", + "type": "TypeString", + "description": "Instance Private Key file", + "optional": true + }, + { + "name": "passphrase", + "type": "TypeString", + "description": "Passphrase for Instance Private Key file", + "secure": true, + "optional": true + }, + { + "name": "bandwidth", + "type": "TypeInt", + "description": "The total bandwidth (in megabits per second) shared across the instance's network interfaces and storage volumes", + "computed": true + }, + { + "name": "lifecycle_state", + "type": "TypeString", + "description": "The lifecycle state of the virtual server instance.", + "computed": true + }, + { + "name": "lifecycle_reasons", "type": "TypeList", - "description": "The metadata service configuration", + "description": "The reasons for the current lifecycle_state (if any).", "computed": true, "elem": { - "enabled": { - "name": "enabled", - "type": "TypeBool", - "description": "Indicates whether the metadata service endpoint will be available to the virtual server instance", + "code": { + "name": "code", + "type": "TypeString", + "description": "A snake case string succinctly identifying the reason for this lifecycle state.", "computed": true }, - "protocol": { - "name": "protocol", + "message": { + "name": "message", "type": "TypeString", - "description": "The communication protocol to use for the metadata service endpoint. Applies only when the metadata service is enabled.", + "description": "An explanation of the reason for this lifecycle state.", "computed": true }, - "response_hop_limit": { - "name": "response_hop_limit", - "type": "TypeInt", - "description": "The hop limit (IP time to live) for IP response packets from the metadata service", + "more_info": { + "name": "more_info", + "type": "TypeString", + "description": "Link to documentation about the reason for this lifecycle state.", "computed": true } } }, { - "name": "passphrase", - "type": "TypeString", - "description": "Passphrase for Instance Private Key file", - "secure": true, - "optional": true - }, - { - "name": "access_tags", - "type": "TypeSet", - "description": "list of access tags for the instance", + "name": "volume_attachments", + "type": "TypeList", + "description": "Instance Volume Attachments", "computed": true, "elem": { - "type": "TypeString" + "id": { + "name": "id", + "type": "TypeString", + "description": "Instance Volume Attachment id", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Instance Volume Attachment name", + "computed": true + }, + "volume_crn": { + "name": "volume_crn", + "type": "TypeString", + "description": "Instance Boot Volume's volume CRN", + "computed": true + }, + "volume_id": { + "name": "volume_id", + "type": "TypeString", + "description": "Instance Boot Volume's volume id", + "computed": true + }, + "volume_name": { + "name": "volume_name", + "type": "TypeString", + "description": "Instance Boot Volume's volume name", + "computed": true + } } }, { - "name": "network_interfaces", + "name": "primary_network_interface", "type": "TypeList", - "description": "Instance Network interface info", + "description": "Primary Network interface info", "computed": true, "elem": { "id": { "name": "id", "type": "TypeString", - "description": "Instance Network Interface id", + "description": "Instance Primary Network Interface id", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "Instance Network Interface name", + "description": "Instance Primary Network Interface name", + "computed": true + }, + "port_speed": { + "name": "port_speed", + "type": "TypeInt", + "description": "Instance Primary Network Interface port speed", "computed": true }, "primary_ip": { @@ -43049,13 +43367,13 @@ "primary_ipv4_address": { "name": "primary_ipv4_address", "type": "TypeString", - "description": "Instance Network Interface IPV4 Address", + "description": "Instance Primary Network Interface IPV4 Address", "computed": true }, "security_groups": { "name": "security_groups", "type": "TypeSet", - "description": "Instance Network Interface Security Groups", + "description": "Instance Primary Network Interface Security groups", "computed": true, "elem": { "type": "TypeString" @@ -43064,7 +43382,7 @@ "subnet": { "name": "subnet", "type": "TypeString", - "description": "Instance Network Interface subnet", + "description": "Instance Primary Network Interface subnet", "computed": true } } @@ -43077,102 +43395,40 @@ "computed": true }, { - "name": "vpc", + "name": "profile", "type": "TypeString", - "description": "VPC id", - "computed": true - }, - { - "name": "total_network_bandwidth", - "type": "TypeInt", - "description": "The amount of bandwidth (in megabits per second) allocated exclusively to instance network interfaces.", + "description": "Profile info", "computed": true }, { - "name": "lifecycle_reasons", - "type": "TypeList", - "description": "The reasons for the current lifecycle_state (if any).", - "computed": true, - "elem": { - "code": { - "name": "code", - "type": "TypeString", - "description": "A snake case string succinctly identifying the reason for this lifecycle state.", - "computed": true - }, - "message": { - "name": "message", - "type": "TypeString", - "description": "An explanation of the reason for this lifecycle state.", - "computed": true - }, - "more_info": { - "name": "more_info", - "type": "TypeString", - "description": "Link to documentation about the reason for this lifecycle state.", - "computed": true - } - } - }, - { - "name": "gpu", - "type": "TypeList", - "description": "Instance GPU", + "name": "volumes", + "type": "TypeSet", + "description": "List of volumes", "computed": true, "elem": { - "count": { - "name": "count", - "type": "TypeInt", - "description": "Instance GPU Count", - "computed": true - }, - "manufacturer": { - "name": "manufacturer", - "type": "TypeString", - "description": "Instance GPU Manufacturer", - "computed": true - }, - "memory": { - "name": "memory", - "type": "TypeInt", - "description": "Instance GPU Memory", - "computed": true - }, - "model": { - "name": "model", - "type": "TypeString", - "description": "Instance GPU Model", - "computed": true - } + "type": "TypeString" } }, { - "name": "status", + "name": "resource_group_name", "type": "TypeString", - "description": "instance status", + "description": "The resource group name in which resource is provisioned", "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Instance name", - "required": true - }, + } + ], + "ibm_is_instance_disk": [ { - "name": "password", + "name": "resource_type", "type": "TypeString", - "description": "password for Windows Instance", - "secure": true, + "description": "The resource type.", "computed": true }, { - "name": "total_volume_bandwidth", + "name": "size", "type": "TypeInt", - "description": "The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes", + "description": "The size of the disk in GB (gigabytes).", "computed": true - } - ], - "ibm_is_instance_disk": [ + }, { "name": "instance", "type": "TypeString", @@ -43208,27 +43464,9 @@ "type": "TypeString", "description": "The user-defined name for this disk.", "computed": true - }, - { - "name": "resource_type", - "type": "TypeString", - "description": "The resource type.", - "computed": true - }, - { - "name": "size", - "type": "TypeInt", - "description": "The size of the disk in GB (gigabytes).", - "computed": true } ], "ibm_is_instance_disks": [ - { - "name": "instance", - "type": "TypeString", - "description": "The instance identifier.", - "required": true - }, { "name": "disks", "type": "TypeList", @@ -43278,48 +43516,34 @@ "computed": true } } - } - ], - "ibm_is_instance_group": [ - { - "name": "instance_template", - "type": "TypeString", - "description": "instance template ID", - "computed": true }, { - "name": "resource_group", + "name": "instance", "type": "TypeString", - "description": "Resource group ID", - "cloud_data_type": "resource_group", - "computed": true - }, + "description": "The instance identifier.", + "required": true + } + ], + "ibm_is_instance_group": [ { - "name": "crn", + "name": "load_balancer_pool", "type": "TypeString", - "description": "The CRN for this instance group", - "cloud_data_type": "crn", + "description": "load balancer pool ID", "computed": true }, { - "name": "subnets", + "name": "managers", "type": "TypeList", - "description": "list of subnet IDs", + "description": "list of Managers associated with instancegroup", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "application_port", - "type": "TypeInt", - "description": "Used by the instance group when scaling up instances to supply the port for the load balancer pool member.", - "computed": true - }, - { - "name": "load_balancer_pool", + "name": "status", "type": "TypeString", - "description": "load balancer pool ID", + "description": "Instance group status - deleting, healthy, scaling, unhealthy", "computed": true }, { @@ -43337,6 +43561,26 @@ "description": "The user-defined name for this instance group", "required": true }, + { + "name": "instance_template", + "type": "TypeString", + "description": "instance template ID", + "computed": true + }, + { + "name": "resource_group", + "type": "TypeString", + "description": "Resource group ID", + "cloud_data_type": "resource_group", + "computed": true + }, + { + "name": "crn", + "type": "TypeString", + "description": "The CRN for this instance group", + "cloud_data_type": "crn", + "computed": true + }, { "name": "membership_count", "type": "TypeInt", @@ -43344,50 +43588,44 @@ "computed": true }, { - "name": "managers", + "name": "subnets", "type": "TypeList", - "description": "list of Managers associated with instancegroup", + "description": "list of subnet IDs", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "vpc", - "type": "TypeString", - "description": "vpc instance", + "name": "application_port", + "type": "TypeInt", + "description": "Used by the instance group when scaling up instances to supply the port for the load balancer pool member.", "computed": true }, { - "name": "status", + "name": "vpc", "type": "TypeString", - "description": "Instance group status - deleting, healthy, scaling, unhealthy", + "description": "vpc instance", "computed": true } ], "ibm_is_instance_group_manager": [ { - "name": "instance_group", - "type": "TypeString", - "description": "instance group ID", - "required": true - }, - { - "name": "name", + "name": "manager_type", "type": "TypeString", - "description": "Name of the instance group manager.", - "required": true + "description": "The type of instance group manager.", + "computed": true }, { - "name": "cooldown", + "name": "aggregation_window", "type": "TypeInt", - "description": "The duration of time in seconds to pause further scale actions after scaling has taken place", + "description": "The time window in seconds to aggregate metrics prior to evaluation", "computed": true }, { - "name": "min_membership_count", + "name": "max_membership_count", "type": "TypeInt", - "description": "The minimum number of members in a managed instance group", + "description": "The maximum number of members in a managed instance group", "computed": true }, { @@ -43396,6 +43634,15 @@ "description": "The ID of instance group manager.", "computed": true }, + { + "name": "policies", + "type": "TypeList", + "description": "list of Policies associated with instancegroup manager", + "computed": true, + "elem": { + "type": "TypeString" + } + }, { "name": "actions", "type": "TypeList", @@ -43419,103 +43666,95 @@ } }, { - "name": "manager_type", + "name": "instance_group", "type": "TypeString", - "description": "The type of instance group manager.", - "computed": true + "description": "instance group ID", + "required": true }, { - "name": "aggregation_window", - "type": "TypeInt", - "description": "The time window in seconds to aggregate metrics prior to evaluation", - "computed": true + "name": "name", + "type": "TypeString", + "description": "Name of the instance group manager.", + "required": true }, { - "name": "max_membership_count", + "name": "cooldown", "type": "TypeInt", - "description": "The maximum number of members in a managed instance group", + "description": "The duration of time in seconds to pause further scale actions after scaling has taken place", "computed": true }, { - "name": "policies", - "type": "TypeList", - "description": "list of Policies associated with instancegroup manager", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "min_membership_count", + "type": "TypeInt", + "description": "The minimum number of members in a managed instance group", + "computed": true } ], "ibm_is_instance_group_manager_action": [ { - "name": "updated_at", + "name": "last_applied_at", "type": "TypeString", - "description": "The date and time that the instance group manager action was modified.", + "description": "The date and time the scheduled action was last applied. If empty the action has never been applied.", "computed": true }, { - "name": "auto_delete_timeout", - "type": "TypeInt", + "name": "auto_delete", + "type": "TypeBool", "computed": true }, { - "name": "instance_group", - "type": "TypeString", - "description": "instance group ID", - "required": true - }, - { - "name": "instance_group_manager", + "name": "created_at", "type": "TypeString", - "description": "Instance group manager ID of type scheduled", - "required": true + "description": "The date and time that the instance group manager action was modified.", + "computed": true }, { - "name": "run_at", + "name": "cron_spec", "type": "TypeString", - "description": "The date and time the scheduled action will run.", + "description": "The cron specification for a recurring scheduled action. Actions can be applied a maximum of one time within a 5 min period.", "computed": true }, { - "name": "target_manager", + "name": "status", "type": "TypeString", - "description": "The unique identifier for this instance group manager of type autoscale.", + "description": "The status of the instance group action- `active`: Action is ready to be run- `completed`: Action was completed successfully- `failed`: Action could not be completed successfully- `incompatible`: Action parameters are not compatible with the group or manager- `omitted`: Action was not applied because this action's manager was disabled.", "computed": true }, { - "name": "target_manager_name", + "name": "updated_at", "type": "TypeString", - "description": "Instance group manager name of type autoscale.", + "description": "The date and time that the instance group manager action was modified.", "computed": true }, { - "name": "cron_spec", + "name": "action_type", "type": "TypeString", - "description": "The cron specification for a recurring scheduled action. Actions can be applied a maximum of one time within a 5 min period.", + "description": "The type of action for the instance group.", "computed": true }, { - "name": "status", + "name": "instance_group", "type": "TypeString", - "description": "The status of the instance group action- `active`: Action is ready to be run- `completed`: Action was completed successfully- `failed`: Action could not be completed successfully- `incompatible`: Action parameters are not compatible with the group or manager- `omitted`: Action was not applied because this action's manager was disabled.", - "computed": true + "description": "instance group ID", + "required": true }, { - "name": "auto_delete", - "type": "TypeBool", + "name": "run_at", + "type": "TypeString", + "description": "The date and time the scheduled action will run.", "computed": true }, { - "name": "created_at", + "name": "resource_type", "type": "TypeString", - "description": "The date and time that the instance group manager action was modified.", + "description": "The resource type.", "computed": true }, { - "name": "action_id", + "name": "name", "type": "TypeString", - "description": "Instance group manager action ID", - "computed": true + "description": "instance group manager action name", + "required": true }, { "name": "membership_count", @@ -43524,45 +43763,50 @@ "computed": true }, { - "name": "resource_type", + "name": "target_manager_name", "type": "TypeString", - "description": "The resource type.", + "description": "Instance group manager name of type autoscale.", "computed": true }, { - "name": "action_type", - "type": "TypeString", - "description": "The type of action for the instance group.", + "name": "min_membership_count", + "type": "TypeInt", + "description": "The minimum number of members in a managed instance group", "computed": true }, { - "name": "last_applied_at", + "name": "target_manager", "type": "TypeString", - "description": "The date and time the scheduled action was last applied. If empty the action has never been applied.", + "description": "The unique identifier for this instance group manager of type autoscale.", "computed": true }, { - "name": "name", + "name": "next_run_at", "type": "TypeString", - "description": "instance group manager action name", - "required": true + "description": "The date and time the scheduled action will next run. If empty the system is currently calculating the next run time.", + "computed": true }, { - "name": "max_membership_count", + "name": "auto_delete_timeout", "type": "TypeInt", - "description": "The maximum number of members in a managed instance group", "computed": true }, { - "name": "min_membership_count", - "type": "TypeInt", - "description": "The minimum number of members in a managed instance group", + "name": "action_id", + "type": "TypeString", + "description": "Instance group manager action ID", "computed": true }, { - "name": "next_run_at", + "name": "instance_group_manager", "type": "TypeString", - "description": "The date and time the scheduled action will next run. If empty the system is currently calculating the next run time.", + "description": "Instance group manager ID of type scheduled", + "required": true + }, + { + "name": "max_membership_count", + "type": "TypeInt", + "description": "The maximum number of members in a managed instance group", "computed": true } ], @@ -43759,6 +44003,24 @@ } ], "ibm_is_instance_group_manager_policy": [ + { + "name": "metric_type", + "type": "TypeString", + "description": "The type of metric to be evaluated", + "computed": true + }, + { + "name": "metric_value", + "type": "TypeInt", + "description": "The metric value to be evaluated", + "computed": true + }, + { + "name": "policy_type", + "type": "TypeString", + "description": "The type of Policy for the Instance Group", + "computed": true + }, { "name": "policy_id", "type": "TypeString", @@ -43782,24 +44044,6 @@ "type": "TypeString", "description": "The name of the instance group manager policy", "required": true - }, - { - "name": "metric_type", - "type": "TypeString", - "description": "The type of metric to be evaluated", - "computed": true - }, - { - "name": "metric_value", - "type": "TypeInt", - "description": "The metric value to be evaluated", - "computed": true - }, - { - "name": "policy_type", - "type": "TypeString", - "description": "The type of Policy for the Instance Group", - "computed": true } ], "ibm_is_instance_group_managers": [ @@ -43898,6 +44142,31 @@ } ], "ibm_is_instance_group_membership": [ + { + "name": "instance", + "type": "TypeList", + "computed": true, + "elem": { + "crn": { + "name": "crn", + "type": "TypeString", + "description": "The CRN for this virtual server instance.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The user-defined name for this virtual server instance (and default system hostname).", + "computed": true + }, + "virtual_server_instance": { + "name": "virtual_server_instance", + "type": "TypeString", + "description": "The unique identifier for this virtual server instance.", + "computed": true + } + } + }, { "name": "instance_template", "type": "TypeList", @@ -43958,40 +44227,9 @@ "type": "TypeString", "description": "The unique identifier for this instance group membership.", "computed": true - }, - { - "name": "instance", - "type": "TypeList", - "computed": true, - "elem": { - "crn": { - "name": "crn", - "type": "TypeString", - "description": "The CRN for this virtual server instance.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "The user-defined name for this virtual server instance (and default system hostname).", - "computed": true - }, - "virtual_server_instance": { - "name": "virtual_server_instance", - "type": "TypeString", - "description": "The unique identifier for this virtual server instance.", - "computed": true - } - } } ], "ibm_is_instance_group_memberships": [ - { - "name": "instance_group", - "type": "TypeString", - "description": "The instance group identifier.", - "required": true - }, { "name": "memberships", "type": "TypeList", @@ -44079,6 +44317,12 @@ "computed": true } } + }, + { + "name": "instance_group", + "type": "TypeString", + "description": "The instance group identifier.", + "required": true } ], "ibm_is_instance_groups": [ @@ -44411,10 +44655,10 @@ ], "ibm_is_instance_network_interface": [ { - "name": "network_interface_name", + "name": "name", "type": "TypeString", - "description": "The network interface name.", - "required": true + "description": "The user-defined name for this network interface.", + "computed": true }, { "name": "port_speed", @@ -44423,55 +44667,11 @@ "computed": true }, { - "name": "status", - "type": "TypeString", - "description": "The status of the network interface.", - "computed": true - }, - { - "name": "type", + "name": "primary_ipv4_address", "type": "TypeString", - "description": "The type of this network interface as it relates to an instance.", + "description": "The primary IPv4 address.", "computed": true }, - { - "name": "primary_ip", - "type": "TypeList", - "description": "The primary IP address to bind to the network interface. This can be specified using an existing reserved IP, or a prototype object for a new reserved IP.", - "computed": true, - "elem": { - "address": { - "name": "address", - "type": "TypeString", - "description": "The IP address to reserve, which must not already be reserved on the subnet.", - "computed": true - }, - "href": { - "name": "href", - "type": "TypeString", - "description": "The URL for this reserved IP", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "The user-defined name for this reserved IP. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the subnet the reserved IP resides in.", - "computed": true - }, - "reserved_ip": { - "name": "reserved_ip", - "type": "TypeString", - "description": "Identifies a reserved IP by a unique property.", - "computed": true - }, - "resource_type": { - "name": "resource_type", - "type": "TypeString", - "description": "The resource type", - "computed": true - } - } - }, { "name": "instance_name", "type": "TypeString", @@ -44479,33 +44679,33 @@ "required": true }, { - "name": "allow_ip_spoofing", - "type": "TypeBool", - "description": "Indicates whether source IP spoofing is allowed on this interface. If false, source IP spoofing is prevented on this interface. If true, source IP spoofing is allowed on this interface.", - "computed": true - }, - { - "name": "href", + "name": "network_interface_name", "type": "TypeString", - "description": "The URL for this network interface.", - "computed": true + "description": "The network interface name.", + "required": true }, { - "name": "name", + "name": "created_at", "type": "TypeString", - "description": "The user-defined name for this network interface.", + "description": "The date and time that the network interface was created.", "computed": true }, { - "name": "security_groups", + "name": "floating_ips", "type": "TypeList", - "description": "Collection of security groups.", + "description": "The floating IPs associated with this network interface.", "computed": true, "elem": { + "address": { + "name": "address", + "type": "TypeString", + "description": "The globally unique IP address.", + "computed": true + }, "crn": { "name": "crn", "type": "TypeString", - "description": "The security group's CRN.", + "description": "The CRN for this floating IP.", "computed": true }, "deleted": { @@ -44525,23 +44725,35 @@ "href": { "name": "href", "type": "TypeString", - "description": "The security group's canonical URL.", + "description": "The URL for this floating IP.", "computed": true }, "id": { "name": "id", "type": "TypeString", - "description": "The unique identifier for this security group.", + "description": "The unique identifier for this floating IP.", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "The user-defined name for this security group. Names must be unique within the VPC the security group resides in.", + "description": "The unique user-defined name for this floating IP.", "computed": true } } }, + { + "name": "href", + "type": "TypeString", + "description": "The URL for this network interface.", + "computed": true + }, + { + "name": "status", + "type": "TypeString", + "description": "The status of the network interface.", + "computed": true + }, { "name": "subnet", "type": "TypeList", @@ -44589,27 +44801,71 @@ } }, { - "name": "created_at", + "name": "type", "type": "TypeString", - "description": "The date and time that the network interface was created.", + "description": "The type of this network interface as it relates to an instance.", "computed": true }, { - "name": "floating_ips", + "name": "primary_ip", "type": "TypeList", - "description": "The floating IPs associated with this network interface.", + "description": "The primary IP address to bind to the network interface. This can be specified using an existing reserved IP, or a prototype object for a new reserved IP.", "computed": true, "elem": { "address": { "name": "address", "type": "TypeString", - "description": "The globally unique IP address.", + "description": "The IP address to reserve, which must not already be reserved on the subnet.", "computed": true }, + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this reserved IP", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The user-defined name for this reserved IP. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the subnet the reserved IP resides in.", + "computed": true + }, + "reserved_ip": { + "name": "reserved_ip", + "type": "TypeString", + "description": "Identifies a reserved IP by a unique property.", + "computed": true + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type", + "computed": true + } + } + }, + { + "name": "allow_ip_spoofing", + "type": "TypeBool", + "description": "Indicates whether source IP spoofing is allowed on this interface. If false, source IP spoofing is prevented on this interface. If true, source IP spoofing is allowed on this interface.", + "computed": true + }, + { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true + }, + { + "name": "security_groups", + "type": "TypeList", + "description": "Collection of security groups.", + "computed": true, + "elem": { "crn": { "name": "crn", "type": "TypeString", - "description": "The CRN for this floating IP.", + "description": "The security group's CRN.", "computed": true }, "deleted": { @@ -44629,43 +44885,25 @@ "href": { "name": "href", "type": "TypeString", - "description": "The URL for this floating IP.", + "description": "The security group's canonical URL.", "computed": true }, "id": { "name": "id", "type": "TypeString", - "description": "The unique identifier for this floating IP.", + "description": "The unique identifier for this security group.", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "The unique user-defined name for this floating IP.", + "description": "The user-defined name for this security group. Names must be unique within the VPC the security group resides in.", "computed": true } } - }, - { - "name": "primary_ipv4_address", - "type": "TypeString", - "description": "The primary IPv4 address.", - "computed": true - }, - { - "name": "resource_type", - "type": "TypeString", - "description": "The resource type.", - "computed": true } ], "ibm_is_instance_network_interface_reserved_ip": [ - { - "name": "target", - "type": "TypeString", - "description": "Reserved IP target id.", - "computed": true - }, { "name": "network_interface", "type": "TypeString", @@ -44679,11 +44917,17 @@ "required": true }, { - "name": "address", + "name": "target", "type": "TypeString", - "description": "The IP address", + "description": "Reserved IP target id.", "computed": true }, + { + "name": "instance", + "type": "TypeString", + "description": "The instance identifier.", + "required": true + }, { "name": "auto_delete", "type": "TypeBool", @@ -44697,43 +44941,37 @@ "computed": true }, { - "name": "owner", + "name": "href", "type": "TypeString", - "description": "The owner of a reserved IP, defining whether it is managed by the user or the provider.", + "description": "The URL for this reserved IP.", "computed": true }, { - "name": "resource_type", + "name": "name", "type": "TypeString", - "description": "The resource type.", + "description": "The user-defined or system-provided name for this reserved IP.", "computed": true }, { - "name": "instance", + "name": "owner", "type": "TypeString", - "description": "The instance identifier.", - "required": true + "description": "The owner of a reserved IP, defining whether it is managed by the user or the provider.", + "computed": true }, { - "name": "href", + "name": "resource_type", "type": "TypeString", - "description": "The URL for this reserved IP.", + "description": "The resource type.", "computed": true }, { - "name": "name", + "name": "address", "type": "TypeString", - "description": "The user-defined or system-provided name for this reserved IP.", + "description": "The IP address", "computed": true } ], "ibm_is_instance_network_interface_reserved_ips": [ - { - "name": "total_count", - "type": "TypeInt", - "description": "The total number of resources across all pages", - "computed": true - }, { "name": "instance", "type": "TypeString", @@ -44807,15 +45045,15 @@ "computed": true } } - } - ], - "ibm_is_instance_network_interfaces": [ + }, { "name": "total_count", "type": "TypeInt", - "description": "The total number of resources across all pages.", + "description": "The total number of resources across all pages", "computed": true - }, + } + ], + "ibm_is_instance_network_interfaces": [ { "name": "instance_name", "type": "TypeString", @@ -45071,9 +45309,51 @@ "computed": true } } + }, + { + "name": "total_count", + "type": "TypeInt", + "description": "The total number of resources across all pages.", + "computed": true } ], "ibm_is_instance_profile": [ + { + "name": "name", + "type": "TypeString", + "required": true + }, + { + "name": "href", + "type": "TypeString", + "description": "The URL for this virtual server instance profile.", + "computed": true + }, + { + "name": "vcpu_manufacturer", + "type": "TypeList", + "computed": true, + "elem": { + "default": { + "name": "default", + "type": "TypeString", + "description": "The default VCPU manufacturer for an instance with this profile.", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "The type for this profile field.", + "computed": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "The VCPU manufacturer for an instance with this profile.", + "computed": true + } + } + }, { "name": "bandwidth", "type": "TypeList", @@ -45127,177 +45407,66 @@ } }, { - "name": "gpu_manufacturer", + "name": "memory", "type": "TypeList", - "description": "GPU manufacturer of this profile", "computed": true, "elem": { + "default": { + "name": "default", + "type": "TypeInt", + "description": "The default value for this profile field.", + "computed": true + }, + "max": { + "name": "max", + "type": "TypeInt", + "description": "The maximum value for this profile field.", + "computed": true + }, + "min": { + "name": "min", + "type": "TypeInt", + "description": "The minimum value for this profile field.", + "computed": true + }, + "step": { + "name": "step", + "type": "TypeInt", + "description": "The increment step value for this profile field.", + "computed": true + }, "type": { "name": "type", "type": "TypeString", "description": "The type for this profile field.", "computed": true }, + "value": { + "name": "value", + "type": "TypeInt", + "description": "The value for this profile field.", + "computed": true + }, "values": { "name": "values", "type": "TypeList", - "description": "The possible GPU manufacturer(s) for an instance with this profile", - "computed": true, - "elem": { - "type": "TypeString" - } - } - } - }, - { - "name": "disks", - "type": "TypeList", - "description": "Collection of the instance profile's disks.", - "computed": true, - "elem": { - "quantity": { - "name": "quantity", - "type": "TypeList", - "computed": true, - "elem": { - "default": { - "name": "default", - "type": "TypeInt", - "description": "The default value for this profile field.", - "computed": true - }, - "max": { - "name": "max", - "type": "TypeInt", - "description": "The maximum value for this profile field.", - "computed": true - }, - "min": { - "name": "min", - "type": "TypeInt", - "description": "The minimum value for this profile field.", - "computed": true - }, - "step": { - "name": "step", - "type": "TypeInt", - "description": "The increment step value for this profile field.", - "computed": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "The type for this profile field.", - "computed": true - }, - "value": { - "name": "value", - "type": "TypeInt", - "description": "The value for this profile field.", - "computed": true - }, - "values": { - "name": "values", - "type": "TypeList", - "description": "The permitted values for this profile field.", - "computed": true, - "elem": { - "type": "TypeInt" - } - } - } - }, - "size": { - "name": "size", - "type": "TypeList", - "computed": true, - "elem": { - "default": { - "name": "default", - "type": "TypeInt", - "description": "The default value for this profile field.", - "computed": true - }, - "max": { - "name": "max", - "type": "TypeInt", - "description": "The maximum value for this profile field.", - "computed": true - }, - "min": { - "name": "min", - "type": "TypeInt", - "description": "The minimum value for this profile field.", - "computed": true - }, - "step": { - "name": "step", - "type": "TypeInt", - "description": "The increment step value for this profile field.", - "computed": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "The type for this profile field.", - "computed": true - }, - "value": { - "name": "value", - "type": "TypeInt", - "description": "The value for this profile field.", - "computed": true - }, - "values": { - "name": "values", - "type": "TypeList", - "description": "The permitted values for this profile field.", - "computed": true, - "elem": { - "type": "TypeInt" - } - } - } - }, - "supported_interface_types": { - "name": "supported_interface_types", - "type": "TypeList", + "description": "The permitted values for this profile field.", "computed": true, "elem": { - "default": { - "name": "default", - "type": "TypeString", - "description": "The disk interface used for attaching the disk.The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected property value was encountered.", - "computed": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "The type for this profile field.", - "computed": true - }, - "values": { - "name": "values", - "type": "TypeList", - "description": "The supported disk interfaces used for attaching the disk.", - "computed": true, - "elem": { - "type": "TypeString" - } - } + "type": "TypeInt" } } } }, { - "name": "vcpu_manufacturer", + "name": "vcpu_architecture", "type": "TypeList", "computed": true, "elem": { "default": { "name": "default", "type": "TypeString", - "description": "The default VCPU manufacturer for an instance with this profile.", + "description": "The default VCPU architecture for an instance with this profile.", "computed": true }, "type": { @@ -45309,32 +45478,7 @@ "value": { "name": "value", "type": "TypeString", - "description": "The VCPU manufacturer for an instance with this profile.", - "computed": true - } - } - }, - { - "name": "network_interface_count", - "type": "TypeSet", - "computed": true, - "elem": { - "max": { - "name": "max", - "type": "TypeInt", - "description": "The maximum value for this profile field", - "computed": true - }, - "min": { - "name": "min", - "type": "TypeInt", - "description": "The minimum value for this profile field", - "computed": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "The type for this profile field.", + "description": "The VCPU architecture for an instance with this profile.", "computed": true } } @@ -45346,15 +45490,24 @@ "computed": true }, { - "name": "architecture_type", + "name": "architecture", "type": "TypeString", - "description": "The type for the OS architecture.", + "description": "The default OS architecture for an instance with this profile.", "computed": true }, { - "name": "gpu_memory", + "name": "architecture_values", "type": "TypeList", - "description": "GPU memory of this profile", + "description": "The supported OS architecture(s) for an instance with this profile.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "gpu_count", + "type": "TypeList", + "description": "GPU count of this profile", "computed": true, "elem": { "default": { @@ -45405,14 +45558,9 @@ } }, { - "name": "href", - "type": "TypeString", - "description": "The URL for this virtual server instance profile.", - "computed": true - }, - { - "name": "memory", + "name": "total_volume_bandwidth", "type": "TypeList", + "description": "The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes. An increase in this value will result in a corresponding decrease to total_network_bandwidth.", "computed": true, "elem": { "default": { @@ -45463,14 +45611,8 @@ } }, { - "name": "name", - "type": "TypeString", - "required": true - }, - { - "name": "gpu_model", + "name": "port_speed", "type": "TypeList", - "description": "GPU model of this profile", "computed": true, "elem": { "type": { @@ -45479,21 +45621,17 @@ "description": "The type for this profile field.", "computed": true }, - "values": { - "name": "values", - "type": "TypeList", - "description": "The possible GPU model(s) for an instance with this profile", - "computed": true, - "elem": { - "type": "TypeString" - } + "value": { + "name": "value", + "type": "TypeInt", + "description": "The value for this profile field.", + "computed": true } } }, { - "name": "total_volume_bandwidth", + "name": "vcpu_count", "type": "TypeList", - "description": "The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes. An increase in this value will result in a corresponding decrease to total_network_bandwidth.", "computed": true, "elem": { "default": { @@ -45544,8 +45682,15 @@ } }, { - "name": "port_speed", + "name": "architecture_type", + "type": "TypeString", + "description": "The type for the OS architecture.", + "computed": true + }, + { + "name": "gpu_manufacturer", "type": "TypeList", + "description": "GPU manufacturer of this profile", "computed": true, "elem": { "type": { @@ -45554,17 +45699,21 @@ "description": "The type for this profile field.", "computed": true }, - "value": { - "name": "value", - "type": "TypeInt", - "description": "The value for this profile field.", - "computed": true + "values": { + "name": "values", + "type": "TypeList", + "description": "The possible GPU manufacturer(s) for an instance with this profile", + "computed": true, + "elem": { + "type": "TypeString" + } } } }, { - "name": "vcpu_count", + "name": "gpu_memory", "type": "TypeList", + "description": "GPU memory of this profile", "computed": true, "elem": { "default": { @@ -45615,82 +45764,183 @@ } }, { - "name": "architecture", - "type": "TypeString", - "description": "The default OS architecture for an instance with this profile.", - "computed": true - }, - { - "name": "architecture_values", - "type": "TypeList", - "description": "The supported OS architecture(s) for an instance with this profile.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "gpu_count", + "name": "gpu_model", "type": "TypeList", - "description": "GPU count of this profile", + "description": "GPU model of this profile", "computed": true, "elem": { - "default": { - "name": "default", - "type": "TypeInt", - "description": "The default value for this profile field.", - "computed": true - }, - "max": { - "name": "max", - "type": "TypeInt", - "description": "The maximum value for this profile field.", - "computed": true - }, - "min": { - "name": "min", - "type": "TypeInt", - "description": "The minimum value for this profile field.", - "computed": true - }, - "step": { - "name": "step", - "type": "TypeInt", - "description": "The increment step value for this profile field.", - "computed": true - }, "type": { "name": "type", "type": "TypeString", "description": "The type for this profile field.", "computed": true }, - "value": { - "name": "value", - "type": "TypeInt", - "description": "The value for this profile field.", - "computed": true - }, "values": { "name": "values", "type": "TypeList", - "description": "The permitted values for this profile field.", + "description": "The possible GPU model(s) for an instance with this profile", "computed": true, "elem": { - "type": "TypeInt" + "type": "TypeString" } } } }, { - "name": "vcpu_architecture", + "name": "disks", "type": "TypeList", + "description": "Collection of the instance profile's disks.", "computed": true, "elem": { - "default": { - "name": "default", - "type": "TypeString", - "description": "The default VCPU architecture for an instance with this profile.", + "quantity": { + "name": "quantity", + "type": "TypeList", + "computed": true, + "elem": { + "default": { + "name": "default", + "type": "TypeInt", + "description": "The default value for this profile field.", + "computed": true + }, + "max": { + "name": "max", + "type": "TypeInt", + "description": "The maximum value for this profile field.", + "computed": true + }, + "min": { + "name": "min", + "type": "TypeInt", + "description": "The minimum value for this profile field.", + "computed": true + }, + "step": { + "name": "step", + "type": "TypeInt", + "description": "The increment step value for this profile field.", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "The type for this profile field.", + "computed": true + }, + "value": { + "name": "value", + "type": "TypeInt", + "description": "The value for this profile field.", + "computed": true + }, + "values": { + "name": "values", + "type": "TypeList", + "description": "The permitted values for this profile field.", + "computed": true, + "elem": { + "type": "TypeInt" + } + } + } + }, + "size": { + "name": "size", + "type": "TypeList", + "computed": true, + "elem": { + "default": { + "name": "default", + "type": "TypeInt", + "description": "The default value for this profile field.", + "computed": true + }, + "max": { + "name": "max", + "type": "TypeInt", + "description": "The maximum value for this profile field.", + "computed": true + }, + "min": { + "name": "min", + "type": "TypeInt", + "description": "The minimum value for this profile field.", + "computed": true + }, + "step": { + "name": "step", + "type": "TypeInt", + "description": "The increment step value for this profile field.", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "The type for this profile field.", + "computed": true + }, + "value": { + "name": "value", + "type": "TypeInt", + "description": "The value for this profile field.", + "computed": true + }, + "values": { + "name": "values", + "type": "TypeList", + "description": "The permitted values for this profile field.", + "computed": true, + "elem": { + "type": "TypeInt" + } + } + } + }, + "supported_interface_types": { + "name": "supported_interface_types", + "type": "TypeList", + "computed": true, + "elem": { + "default": { + "name": "default", + "type": "TypeString", + "description": "The disk interface used for attaching the disk.The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected property value was encountered.", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "The type for this profile field.", + "computed": true + }, + "values": { + "name": "values", + "type": "TypeList", + "description": "The supported disk interfaces used for attaching the disk.", + "computed": true, + "elem": { + "type": "TypeString" + } + } + } + } + } + }, + { + "name": "network_interface_count", + "type": "TypeSet", + "computed": true, + "elem": { + "max": { + "name": "max", + "type": "TypeInt", + "description": "The maximum value for this profile field", + "computed": true + }, + "min": { + "name": "min", + "type": "TypeInt", + "description": "The minimum value for this profile field", "computed": true }, "type": { @@ -45698,12 +45948,6 @@ "type": "TypeString", "description": "The type for this profile field.", "computed": true - }, - "value": { - "name": "value", - "type": "TypeString", - "description": "The VCPU architecture for an instance with this profile.", - "computed": true } } } @@ -46353,124 +46597,19 @@ ], "ibm_is_instance_template": [ { - "name": "boot_volume_attachment", + "name": "keys", "type": "TypeList", "computed": true, "elem": { - "delete_volume_on_instance_delete": { - "name": "delete_volume_on_instance_delete", - "type": "TypeBool", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "computed": true - }, - "profile": { - "name": "profile", - "type": "TypeString", - "computed": true - }, - "size": { - "name": "size", - "type": "TypeInt", - "computed": true - }, - "tags": { - "name": "tags", - "type": "TypeSet", - "description": "The user tags associated with this volume.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "volume": { - "name": "volume", - "type": "TypeString", - "computed": true - } + "type": "TypeString" } }, { - "name": "identifier", - "type": "TypeString", - "optional": true, - "computed": true - }, - { - "name": "vpc", - "type": "TypeString", - "computed": true - }, - { - "name": "zone", - "type": "TypeString", + "name": "total_volume_bandwidth", + "type": "TypeInt", + "description": "The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes", "computed": true }, - { - "name": "volume_attachments", - "type": "TypeList", - "computed": true, - "elem": { - "delete_volume_on_instance_delete": { - "name": "delete_volume_on_instance_delete", - "type": "TypeBool", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "computed": true - }, - "volume": { - "name": "volume", - "type": "TypeString", - "computed": true - }, - "volume_prototype": { - "name": "volume_prototype", - "type": "TypeList", - "computed": true, - "elem": { - "capacity": { - "name": "capacity", - "type": "TypeInt", - "description": "The capacity of the volume in gigabytes. The specified minimum and maximum capacity values for creating or updating volumes may expand in the future.", - "computed": true - }, - "encryption_key": { - "name": "encryption_key", - "type": "TypeString", - "description": "The CRN of the [Key Protect Root Key](https://cloud.ibm.com/docs/key-protect?topic=key-protect-getting-started-tutorial) or [Hyper Protect Crypto Service Root Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started) for this resource.", - "computed": true - }, - "iops": { - "name": "iops", - "type": "TypeInt", - "description": "The maximum I/O operations per second (IOPS) for the volume.", - "computed": true - }, - "profile": { - "name": "profile", - "type": "TypeString", - "description": "The globally unique name for the volume profile to use for this volume.", - "computed": true - }, - "tags": { - "name": "tags", - "type": "TypeSet", - "description": "The user tags associated with this volume.", - "computed": true, - "elem": { - "type": "TypeString" - } - } - } - } - } - }, { "name": "catalog_offering", "type": "TypeList", @@ -46548,15 +46687,71 @@ } }, { - "name": "default_trusted_profile_auto_link", - "type": "TypeBool", - "description": "If set to `true`, the system will create a link to the specified `target` trusted profile during instance creation. Regardless of whether a link is created by the system or manually using the IAM Identity service, it will be automatically deleted when the instance is deleted.", + "name": "user_data", + "type": "TypeString", "computed": true }, { - "name": "metadata_service_enabled", - "type": "TypeBool", - "description": "Indicates whether the metadata service endpoint is available to the virtual server instance", + "name": "image", + "type": "TypeString", + "computed": true + }, + { + "name": "boot_volume_attachment", + "type": "TypeList", + "computed": true, + "elem": { + "delete_volume_on_instance_delete": { + "name": "delete_volume_on_instance_delete", + "type": "TypeBool", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "computed": true + }, + "profile": { + "name": "profile", + "type": "TypeString", + "computed": true + }, + "size": { + "name": "size", + "type": "TypeInt", + "computed": true + }, + "tags": { + "name": "tags", + "type": "TypeSet", + "description": "The user tags associated with this volume.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "volume": { + "name": "volume", + "type": "TypeString", + "computed": true + } + } + }, + { + "name": "resource_group", + "type": "TypeString", + "cloud_data_type": "resource_group", + "computed": true + }, + { + "name": "crn", + "type": "TypeString", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "vpc", + "type": "TypeString", "computed": true }, { @@ -46616,120 +46811,169 @@ } }, { - "name": "user_data", + "name": "default_trusted_profile_auto_link", + "type": "TypeBool", + "description": "If set to `true`, the system will create a link to the specified `target` trusted profile during instance creation. Regardless of whether a link is created by the system or manually using the IAM Identity service, it will be automatically deleted when the instance is deleted.", + "computed": true + }, + { + "name": "default_trusted_profile_target", "type": "TypeString", + "description": "The unique identifier or CRN of the default IAM trusted profile to use for this virtual server instance.", "computed": true }, { - "name": "placement_target", + "name": "metadata_service", "type": "TypeList", - "description": "The placement restrictions to use for the virtual server instance.", + "description": "The metadata service configuration", "computed": true, "elem": { - "crn": { - "name": "crn", - "type": "TypeString", - "description": "The CRN for this dedicated host.", + "enabled": { + "name": "enabled", + "type": "TypeBool", + "description": "Indicates whether the metadata service endpoint will be available to the virtual server instance", "computed": true }, - "href": { - "name": "href", + "protocol": { + "name": "protocol", "type": "TypeString", - "description": "The URL for this dedicated host.", + "description": "The communication protocol to use for the metadata service endpoint. Applies only when the metadata service is enabled.", "computed": true }, - "id": { - "name": "id", - "type": "TypeString", - "description": "The unique identifier for this dedicated host.", + "response_hop_limit": { + "name": "response_hop_limit", + "type": "TypeInt", + "description": "The hop limit (IP time to live) for IP response packets from the metadata service", "computed": true } } }, { - "name": "name", - "type": "TypeString", - "optional": true, - "computed": true - }, - { - "name": "href", - "type": "TypeString", - "computed": true - }, - { - "name": "profile", - "type": "TypeString", - "computed": true - }, - { - "name": "keys", + "name": "volume_attachments", "type": "TypeList", "computed": true, "elem": { - "type": "TypeString" + "delete_volume_on_instance_delete": { + "name": "delete_volume_on_instance_delete", + "type": "TypeBool", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "computed": true + }, + "volume": { + "name": "volume", + "type": "TypeString", + "computed": true + }, + "volume_prototype": { + "name": "volume_prototype", + "type": "TypeList", + "computed": true, + "elem": { + "capacity": { + "name": "capacity", + "type": "TypeInt", + "description": "The capacity of the volume in gigabytes. The specified minimum and maximum capacity values for creating or updating volumes may expand in the future.", + "computed": true + }, + "encryption_key": { + "name": "encryption_key", + "type": "TypeString", + "description": "The CRN of the [Key Protect Root Key](https://cloud.ibm.com/docs/key-protect?topic=key-protect-getting-started-tutorial) or [Hyper Protect Crypto Service Root Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started) for this resource.", + "computed": true + }, + "iops": { + "name": "iops", + "type": "TypeInt", + "description": "The maximum I/O operations per second (IOPS) for the volume.", + "computed": true + }, + "profile": { + "name": "profile", + "type": "TypeString", + "description": "The globally unique name for the volume profile to use for this volume.", + "computed": true + }, + "tags": { + "name": "tags", + "type": "TypeSet", + "description": "The user tags associated with this volume.", + "computed": true, + "elem": { + "type": "TypeString" + } + } + } + } } }, { - "name": "metadata_service", + "name": "placement_target", "type": "TypeList", - "description": "The metadata service configuration", + "description": "The placement restrictions to use for the virtual server instance.", "computed": true, "elem": { - "enabled": { - "name": "enabled", - "type": "TypeBool", - "description": "Indicates whether the metadata service endpoint will be available to the virtual server instance", + "crn": { + "name": "crn", + "type": "TypeString", + "description": "The CRN for this dedicated host.", "computed": true }, - "protocol": { - "name": "protocol", + "href": { + "name": "href", "type": "TypeString", - "description": "The communication protocol to use for the metadata service endpoint. Applies only when the metadata service is enabled.", + "description": "The URL for this dedicated host.", "computed": true }, - "response_hop_limit": { - "name": "response_hop_limit", - "type": "TypeInt", - "description": "The hop limit (IP time to live) for IP response packets from the metadata service", + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this dedicated host.", "computed": true } } }, { - "name": "resource_group", + "name": "identifier", "type": "TypeString", - "cloud_data_type": "resource_group", + "optional": true, "computed": true }, { - "name": "crn", + "name": "zone", "type": "TypeString", - "cloud_data_type": "crn", "computed": true }, { - "name": "total_volume_bandwidth", - "type": "TypeInt", - "description": "The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes", + "name": "profile", + "type": "TypeString", "computed": true }, { - "name": "default_trusted_profile_target", + "name": "availability_policy_host_failure", "type": "TypeString", - "description": "The unique identifier or CRN of the default IAM trusted profile to use for this virtual server instance.", + "description": "The availability policy to use for this virtual server instance. The action to perform if the compute host experiences a failure.", "computed": true }, { - "name": "availability_policy_host_failure", + "name": "name", "type": "TypeString", - "description": "The availability policy to use for this virtual server instance. The action to perform if the compute host experiences a failure.", + "optional": true, "computed": true }, { - "name": "image", + "name": "href", "type": "TypeString", "computed": true + }, + { + "name": "metadata_service_enabled", + "type": "TypeBool", + "description": "Indicates whether the metadata service endpoint is available to the virtual server instance", + "computed": true } ], "ibm_is_instance_templates": [ @@ -47118,6 +47362,54 @@ } ], "ibm_is_instance_volume_attachment": [ + { + "name": "instance", + "type": "TypeString", + "description": "Instance id", + "required": true + }, + { + "name": "name", + "type": "TypeString", + "description": "The user-defined name for this volume attachment.", + "required": true + }, + { + "name": "delete_volume_on_instance_delete", + "type": "TypeBool", + "description": "If set to true, when deleting the instance the volume will also be deleted.", + "computed": true + }, + { + "name": "device", + "type": "TypeString", + "description": "A unique identifier for the device which is exposed to the instance operating system", + "computed": true + }, + { + "name": "href", + "type": "TypeString", + "description": "The URL for this volume attachment", + "computed": true + }, + { + "name": "volume_attachment_id", + "type": "TypeString", + "description": "The unique identifier for this volume attachment", + "computed": true + }, + { + "name": "status", + "type": "TypeString", + "description": "The status of this volume attachment, one of [ attached, attaching, deleting, detaching ]", + "computed": true + }, + { + "name": "type", + "type": "TypeString", + "description": "The type of volume attachment one of [ boot, data ]", + "computed": true + }, { "name": "volume_reference", "type": "TypeList", @@ -47155,54 +47447,6 @@ "computed": true } } - }, - { - "name": "instance", - "type": "TypeString", - "description": "Instance id", - "required": true - }, - { - "name": "delete_volume_on_instance_delete", - "type": "TypeBool", - "description": "If set to true, when deleting the instance the volume will also be deleted.", - "computed": true - }, - { - "name": "device", - "type": "TypeString", - "description": "A unique identifier for the device which is exposed to the instance operating system", - "computed": true - }, - { - "name": "href", - "type": "TypeString", - "description": "The URL for this volume attachment", - "computed": true - }, - { - "name": "type", - "type": "TypeString", - "description": "The type of volume attachment one of [ boot, data ]", - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "The user-defined name for this volume attachment.", - "required": true - }, - { - "name": "volume_attachment_id", - "type": "TypeString", - "description": "The unique identifier for this volume attachment", - "computed": true - }, - { - "name": "status", - "type": "TypeString", - "description": "The status of this volume attachment, one of [ attached, attaching, deleting, detaching ]", - "computed": true } ], "ibm_is_instance_volume_attachments": [ @@ -47301,6 +47545,18 @@ } ], "ibm_is_instances": [ + { + "name": "instance_group", + "type": "TypeString", + "description": "Instance group ID to filter the instances attached to it", + "optional": true + }, + { + "name": "instance_group_name", + "type": "TypeString", + "description": "Instance group name to filter the instances attached to it", + "optional": true + }, { "name": "vpc_name", "type": "TypeString", @@ -47313,6 +47569,19 @@ "description": "VPC ID to filter the instances attached to it", "optional": true }, + { + "name": "resource_group", + "type": "TypeString", + "description": "Instance resource group", + "cloud_data_type": "resource_group", + "optional": true + }, + { + "name": "placement_group_name", + "type": "TypeString", + "description": "Name of the placement group to filter the instances attached to it", + "optional": true + }, { "name": "vpc_crn", "type": "TypeString", @@ -47326,9 +47595,15 @@ "optional": true }, { - "name": "placement_group_name", + "name": "dedicated_host", "type": "TypeString", - "description": "Name of the placement group to filter the instances attached to it", + "description": "ID of the dedicated host to filter the instances attached to it", + "optional": true + }, + { + "name": "placement_group", + "type": "TypeString", + "description": "ID of the placement group to filter the instances attached to it", "optional": true }, { @@ -47945,37 +48220,6 @@ "computed": true } } - }, - { - "name": "instance_group", - "type": "TypeString", - "description": "Instance group ID to filter the instances attached to it", - "optional": true - }, - { - "name": "resource_group", - "type": "TypeString", - "description": "Instance resource group", - "cloud_data_type": "resource_group", - "optional": true - }, - { - "name": "dedicated_host", - "type": "TypeString", - "description": "ID of the dedicated host to filter the instances attached to it", - "optional": true - }, - { - "name": "placement_group", - "type": "TypeString", - "description": "ID of the placement group to filter the instances attached to it", - "optional": true - }, - { - "name": "instance_group_name", - "type": "TypeString", - "description": "Instance group name to filter the instances attached to it", - "optional": true } ], "ibm_is_ipsec_policies": [ @@ -48133,112 +48377,6 @@ "description": "Perfect Forward Secrecy.", "computed": true }, - { - "name": "name", - "type": "TypeString", - "description": "The IPsec policy name.", - "optional": true - }, - { - "name": "authentication_algorithm", - "type": "TypeString", - "description": "The authentication algorithm.", - "computed": true - }, - { - "name": "connections", - "type": "TypeList", - "description": "The VPN gateway connections that use this IPsec policy.", - "computed": true, - "elem": { - "deleted": { - "name": "deleted", - "type": "TypeList", - "description": "If present, this property indicates the referenced resource has been deleted and providessome supplementary information.", - "computed": true, - "elem": { - "more_info": { - "name": "more_info", - "type": "TypeString", - "description": "Link to documentation about deleted resources.", - "computed": true - } - } - }, - "href": { - "name": "href", - "type": "TypeString", - "description": "The VPN connection's canonical URL.", - "computed": true - }, - "id": { - "name": "id", - "type": "TypeString", - "description": "The unique identifier for this VPN gateway connection.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "The user-defined name for this VPN connection.", - "computed": true - }, - "resource_type": { - "name": "resource_type", - "type": "TypeString", - "description": "The resource type.", - "computed": true - } - } - }, - { - "name": "encapsulation_mode", - "type": "TypeString", - "description": "The encapsulation mode used. Only `tunnel` is supported.", - "computed": true - }, - { - "name": "encryption_algorithm", - "type": "TypeString", - "description": "The encryption algorithm.", - "computed": true - }, - { - "name": "resource_type", - "type": "TypeString", - "description": "The resource type.", - "computed": true - }, - { - "name": "transform_protocol", - "type": "TypeString", - "description": "The transform protocol used. Only `esp` is supported.", - "computed": true - }, - { - "name": "ipsec_policy", - "type": "TypeString", - "description": "The IPsec policy identifier.", - "optional": true - }, - { - "name": "created_at", - "type": "TypeString", - "description": "The date and time that this IPsec policy was created.", - "computed": true - }, - { - "name": "href", - "type": "TypeString", - "description": "The IPsec policy's canonical URL.", - "computed": true - }, - { - "name": "key_lifetime", - "type": "TypeInt", - "description": "The key lifetime in seconds.", - "computed": true - }, { "name": "resource_group", "type": "TypeList", @@ -48265,28 +48403,248 @@ "computed": true } } + }, + { + "name": "ipsec_policy", + "type": "TypeString", + "description": "The IPsec policy identifier.", + "optional": true + }, + { + "name": "connections", + "type": "TypeList", + "description": "The VPN gateway connections that use this IPsec policy.", + "computed": true, + "elem": { + "deleted": { + "name": "deleted", + "type": "TypeList", + "description": "If present, this property indicates the referenced resource has been deleted and providessome supplementary information.", + "computed": true, + "elem": { + "more_info": { + "name": "more_info", + "type": "TypeString", + "description": "Link to documentation about deleted resources.", + "computed": true + } + } + }, + "href": { + "name": "href", + "type": "TypeString", + "description": "The VPN connection's canonical URL.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this VPN gateway connection.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The user-defined name for this VPN connection.", + "computed": true + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true + } + } + }, + { + "name": "encapsulation_mode", + "type": "TypeString", + "description": "The encapsulation mode used. Only `tunnel` is supported.", + "computed": true + }, + { + "name": "encryption_algorithm", + "type": "TypeString", + "description": "The encryption algorithm.", + "computed": true + }, + { + "name": "href", + "type": "TypeString", + "description": "The IPsec policy's canonical URL.", + "computed": true + }, + { + "name": "key_lifetime", + "type": "TypeInt", + "description": "The key lifetime in seconds.", + "computed": true + }, + { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true + }, + { + "name": "transform_protocol", + "type": "TypeString", + "description": "The transform protocol used. Only `esp` is supported.", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "The IPsec policy name.", + "optional": true + }, + { + "name": "authentication_algorithm", + "type": "TypeString", + "description": "The authentication algorithm.", + "computed": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "The date and time that this IPsec policy was created.", + "computed": true } ], "ibm_is_lb": [ { - "name": "private_ips", + "name": "crn", + "type": "TypeString", + "description": "The CRN for this Load Balancer", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "operating_status", + "type": "TypeString", + "description": "Load Balancer operating status", + "computed": true + }, + { + "name": "listeners", + "type": "TypeSet", + "description": "Load Balancer Listeners list", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "resource_name", + "type": "TypeString", + "description": "The name of the resource", + "computed": true + }, + { + "name": "resource_group_name", + "type": "TypeString", + "description": "The resource group name in which resource is provisioned", + "computed": true + }, + { + "name": "type", + "type": "TypeString", + "description": "Load Balancer type", + "computed": true + }, + { + "name": "udp_supported", + "type": "TypeBool", + "description": "Indicates whether this load balancer supports UDP.", + "computed": true + }, + { + "name": "private_ip", "type": "TypeList", - "description": "Load Balancer private IPs", + "description": "The private IP addresses assigned to this load balancer.", + "computed": true, + "elem": { + "address": { + "name": "address", + "type": "TypeString", + "description": "The IP address to reserve, which must not already be reserved on the subnet.", + "computed": true + }, + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this reserved IP", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The user-defined name for this reserved IP. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the subnet the reserved IP resides in.", + "computed": true + }, + "reserved_ip": { + "name": "reserved_ip", + "type": "TypeString", + "description": "Identifies a reserved IP by a unique property.", + "computed": true + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type", + "computed": true + } + } + }, + { + "name": "security_groups", + "type": "TypeSet", + "description": "Load Balancer securitygroups list", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "tags", + "name": "resource_group", + "type": "TypeString", + "description": "Load Balancer Resource group", + "cloud_data_type": "resource_group", + "computed": true + }, + { + "name": "public_ips", + "type": "TypeList", + "description": "Load Balancer Public IPs", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "subnets", "type": "TypeSet", - "description": "Tags associated to Load Balancer", - "cloud_data_type": "tags", + "description": "Load Balancer subnets list", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "access_tags", + "type": "TypeSet", + "description": "List of access tags", "computed": true, "elem": { "type": "TypeString" } }, + { + "name": "logging", + "type": "TypeBool", + "description": "Logging of Load Balancer", + "computed": true + }, { "name": "pools", "type": "TypeList", @@ -48382,128 +48740,26 @@ "computed": true }, { - "name": "resource_group_name", - "type": "TypeString", - "description": "The resource group name in which resource is provisioned", - "computed": true - }, - { - "name": "type", + "name": "name", "type": "TypeString", - "description": "Load Balancer type", - "computed": true - }, - { - "name": "security_groups", - "type": "TypeSet", - "description": "Load Balancer securitygroups list", - "computed": true, - "elem": { - "type": "TypeString" - } + "description": "Load Balancer name", + "required": true }, { - "name": "operating_status", - "type": "TypeString", - "description": "Load Balancer operating status", + "name": "route_mode", + "type": "TypeBool", + "description": "Indicates whether route mode is enabled for this load balancer", "computed": true }, { - "name": "public_ips", + "name": "private_ips", "type": "TypeList", - "description": "Load Balancer Public IPs", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "subnets", - "type": "TypeSet", - "description": "Load Balancer subnets list", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "hostname", - "type": "TypeString", - "description": "Load Balancer Host Name", - "computed": true - }, - { - "name": "listeners", - "type": "TypeSet", - "description": "Load Balancer Listeners list", + "description": "Load Balancer private IPs", "computed": true, "elem": { "type": "TypeString" } }, - { - "name": "private_ip", - "type": "TypeList", - "description": "The private IP addresses assigned to this load balancer.", - "computed": true, - "elem": { - "address": { - "name": "address", - "type": "TypeString", - "description": "The IP address to reserve, which must not already be reserved on the subnet.", - "computed": true - }, - "href": { - "name": "href", - "type": "TypeString", - "description": "The URL for this reserved IP", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "The user-defined name for this reserved IP. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the subnet the reserved IP resides in.", - "computed": true - }, - "reserved_ip": { - "name": "reserved_ip", - "type": "TypeString", - "description": "Identifies a reserved IP by a unique property.", - "computed": true - }, - "resource_type": { - "name": "resource_type", - "type": "TypeString", - "description": "The resource type", - "computed": true - } - } - }, - { - "name": "name", - "type": "TypeString", - "description": "Load Balancer name", - "required": true - }, - { - "name": "crn", - "type": "TypeString", - "description": "The CRN for this Load Balancer", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "status", - "type": "TypeString", - "description": "Load Balancer status", - "computed": true - }, - { - "name": "route_mode", - "type": "TypeBool", - "description": "Indicates whether route mode is enabled for this load balancer", - "computed": true - }, { "name": "security_group_supported", "type": "TypeBool", @@ -48511,25 +48767,19 @@ "computed": true }, { - "name": "access_tags", + "name": "tags", "type": "TypeSet", - "description": "List of access tags", + "description": "Tags associated to Load Balancer", + "cloud_data_type": "tags", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "resource_group", + "name": "hostname", "type": "TypeString", - "description": "Load Balancer Resource group", - "cloud_data_type": "resource_group", - "computed": true - }, - { - "name": "logging", - "type": "TypeBool", - "description": "Logging of Load Balancer", + "description": "Load Balancer Host Name", "computed": true }, { @@ -48553,25 +48803,13 @@ } }, { - "name": "udp_supported", - "type": "TypeBool", - "description": "Indicates whether this load balancer supports UDP.", - "computed": true - }, - { - "name": "resource_name", + "name": "status", "type": "TypeString", - "description": "The name of the resource", + "description": "Load Balancer status", "computed": true } ], "ibm_is_lb_listener": [ - { - "name": "lb", - "type": "TypeString", - "description": "The load balancer identifier.", - "required": true - }, { "name": "certificate_instance", "type": "TypeList", @@ -48587,39 +48825,9 @@ } }, { - "name": "href", - "type": "TypeString", - "description": "The listener's canonical URL.", - "computed": true - }, - { - "name": "port", - "type": "TypeInt", - "description": "The listener port number, or the inclusive lower bound of the port range. Each listener in the load balancer must have a unique `port` and `protocol` combination.", - "computed": true - }, - { - "name": "port_max", - "type": "TypeInt", - "description": "The inclusive upper bound of the range of ports used by this listener.Only load balancers in the `network` family support more than one port per listener.", - "computed": true - }, - { - "name": "protocol", - "type": "TypeString", - "description": "The listener protocol. Load balancers in the `network` family support `tcp`. Load balancers in the `application` family support `tcp`, `http`, and `https`. Each listener in the load balancer must have a unique `port` and `protocol` combination.", - "computed": true - }, - { - "name": "provisioning_status", - "type": "TypeString", - "description": "The provisioning status of this listener.", - "computed": true - }, - { - "name": "connection_limit", - "type": "TypeInt", - "description": "The connection limit of the listener.", + "name": "accept_proxy_protocol", + "type": "TypeBool", + "description": "If set to `true`, this listener will accept and forward PROXY protocol information. Supported by load balancers in the `application` family (otherwise always `false`). Additional restrictions:- If this listener has `https_redirect` specified, its `accept_proxy_protocol` value must match the `accept_proxy_protocol` value of the `https_redirect` listener.- If this listener is the target of another listener's `https_redirect`, its `accept_proxy_protocol` value must match that listener's `accept_proxy_protocol` value.", "computed": true }, { @@ -48628,18 +48836,6 @@ "description": "The date and time that this listener was created.", "computed": true }, - { - "name": "port_min", - "type": "TypeInt", - "description": "The inclusive lower bound of the range of ports used by this listener.Only load balancers in the `network` family support more than one port per listener.", - "computed": true - }, - { - "name": "idle_connection_timeout", - "type": "TypeInt", - "description": "idle connection timeout of listener", - "computed": true - }, { "name": "default_pool", "type": "TypeList", @@ -48681,38 +48877,40 @@ } }, { - "name": "policies", - "type": "TypeList", - "description": "The policies for this listener.", - "computed": true, - "elem": { - "deleted": { - "name": "deleted", - "type": "TypeList", - "description": "If present, this property indicates the referenced resource has been deleted and providessome supplementary information.", - "computed": true, - "elem": { - "more_info": { - "name": "more_info", - "type": "TypeString", - "description": "Link to documentation about deleted resources.", - "computed": true - } - } - }, - "href": { - "name": "href", - "type": "TypeString", - "description": "The listener policy's canonical URL.", - "computed": true - }, - "id": { - "name": "id", - "type": "TypeString", - "description": "The policy's unique identifier.", - "computed": true - } - } + "name": "port_max", + "type": "TypeInt", + "description": "The inclusive upper bound of the range of ports used by this listener.Only load balancers in the `network` family support more than one port per listener.", + "computed": true + }, + { + "name": "protocol", + "type": "TypeString", + "description": "The listener protocol. Load balancers in the `network` family support `tcp`. Load balancers in the `application` family support `tcp`, `http`, and `https`. Each listener in the load balancer must have a unique `port` and `protocol` combination.", + "computed": true + }, + { + "name": "provisioning_status", + "type": "TypeString", + "description": "The provisioning status of this listener.", + "computed": true + }, + { + "name": "listener_id", + "type": "TypeString", + "description": "The listener identifier.", + "required": true + }, + { + "name": "connection_limit", + "type": "TypeInt", + "description": "The connection limit of the listener.", + "computed": true + }, + { + "name": "href", + "type": "TypeString", + "description": "The listener's canonical URL.", + "computed": true }, { "name": "https_redirect", @@ -48768,16 +48966,62 @@ } }, { - "name": "listener_id", - "type": "TypeString", - "description": "The listener identifier.", - "required": true + "name": "policies", + "type": "TypeList", + "description": "The policies for this listener.", + "computed": true, + "elem": { + "deleted": { + "name": "deleted", + "type": "TypeList", + "description": "If present, this property indicates the referenced resource has been deleted and providessome supplementary information.", + "computed": true, + "elem": { + "more_info": { + "name": "more_info", + "type": "TypeString", + "description": "Link to documentation about deleted resources.", + "computed": true + } + } + }, + "href": { + "name": "href", + "type": "TypeString", + "description": "The listener policy's canonical URL.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The policy's unique identifier.", + "computed": true + } + } }, { - "name": "accept_proxy_protocol", - "type": "TypeBool", - "description": "If set to `true`, this listener will accept and forward PROXY protocol information. Supported by load balancers in the `application` family (otherwise always `false`). Additional restrictions:- If this listener has `https_redirect` specified, its `accept_proxy_protocol` value must match the `accept_proxy_protocol` value of the `https_redirect` listener.- If this listener is the target of another listener's `https_redirect`, its `accept_proxy_protocol` value must match that listener's `accept_proxy_protocol` value.", + "name": "port", + "type": "TypeInt", + "description": "The listener port number, or the inclusive lower bound of the port range. Each listener in the load balancer must have a unique `port` and `protocol` combination.", + "computed": true + }, + { + "name": "port_min", + "type": "TypeInt", + "description": "The inclusive lower bound of the range of ports used by this listener.Only load balancers in the `network` family support more than one port per listener.", "computed": true + }, + { + "name": "idle_connection_timeout", + "type": "TypeInt", + "description": "idle connection timeout of listener", + "computed": true + }, + { + "name": "lb", + "type": "TypeString", + "description": "The load balancer identifier.", + "required": true } ], "ibm_is_lb_listener_policies": [ @@ -48970,6 +49214,76 @@ } ], "ibm_is_lb_listener_policy": [ + { + "name": "name", + "type": "TypeString", + "description": "The user-defined name for this policy.", + "computed": true + }, + { + "name": "priority", + "type": "TypeInt", + "description": "Priority of the policy. Lower value indicates higher priority.", + "computed": true + }, + { + "name": "provisioning_status", + "type": "TypeString", + "description": "The provisioning status of this policy.", + "computed": true + }, + { + "name": "lb", + "type": "TypeString", + "description": "The load balancer identifier.", + "required": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "The date and time that this policy was created.", + "computed": true + }, + { + "name": "href", + "type": "TypeString", + "description": "The listener policy's canonical URL.", + "computed": true + }, + { + "name": "rules", + "type": "TypeList", + "description": "The rules for this policy.", + "computed": true, + "elem": { + "deleted": { + "name": "deleted", + "type": "TypeList", + "description": "If present, this property indicates the referenced resource has been deleted and providessome supplementary information.", + "computed": true, + "elem": { + "more_info": { + "name": "more_info", + "type": "TypeString", + "description": "Link to documentation about deleted resources.", + "computed": true + } + } + }, + "href": { + "name": "href", + "type": "TypeString", + "description": "The rule's canonical URL.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The rule's unique identifier.", + "computed": true + } + } + }, { "name": "target", "type": "TypeList", @@ -49061,76 +49375,6 @@ } } }, - { - "name": "action", - "type": "TypeString", - "description": "The policy action.The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the policy on which the unexpected property value was encountered.", - "computed": true - }, - { - "name": "created_at", - "type": "TypeString", - "description": "The date and time that this policy was created.", - "computed": true - }, - { - "name": "href", - "type": "TypeString", - "description": "The listener policy's canonical URL.", - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "The user-defined name for this policy.", - "computed": true - }, - { - "name": "provisioning_status", - "type": "TypeString", - "description": "The provisioning status of this policy.", - "computed": true - }, - { - "name": "rules", - "type": "TypeList", - "description": "The rules for this policy.", - "computed": true, - "elem": { - "deleted": { - "name": "deleted", - "type": "TypeList", - "description": "If present, this property indicates the referenced resource has been deleted and providessome supplementary information.", - "computed": true, - "elem": { - "more_info": { - "name": "more_info", - "type": "TypeString", - "description": "Link to documentation about deleted resources.", - "computed": true - } - } - }, - "href": { - "name": "href", - "type": "TypeString", - "description": "The rule's canonical URL.", - "computed": true - }, - "id": { - "name": "id", - "type": "TypeString", - "description": "The rule's unique identifier.", - "computed": true - } - } - }, - { - "name": "lb", - "type": "TypeString", - "description": "The load balancer identifier.", - "required": true - }, { "name": "listener", "type": "TypeString", @@ -49144,13 +49388,19 @@ "required": true }, { - "name": "priority", - "type": "TypeInt", - "description": "Priority of the policy. Lower value indicates higher priority.", + "name": "action", + "type": "TypeString", + "description": "The policy action.The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the policy on which the unexpected property value was encountered.", "computed": true } ], "ibm_is_lb_listener_policy_rule": [ + { + "name": "rule", + "type": "TypeString", + "description": "The rule identifier.", + "required": true + }, { "name": "created_at", "type": "TypeString", @@ -49199,12 +49449,6 @@ "description": "The policy identifier.", "required": true }, - { - "name": "rule", - "type": "TypeString", - "description": "The rule identifier.", - "required": true - }, { "name": "condition", "type": "TypeString", @@ -49219,6 +49463,24 @@ } ], "ibm_is_lb_listener_policy_rules": [ + { + "name": "lb", + "type": "TypeString", + "description": "The load balancer identifier.", + "required": true + }, + { + "name": "listener", + "type": "TypeString", + "description": "The listener identifier.", + "required": true + }, + { + "name": "policy", + "type": "TypeString", + "description": "The policy identifier.", + "required": true + }, { "name": "rules", "type": "TypeList", @@ -49274,24 +49536,6 @@ "computed": true } } - }, - { - "name": "lb", - "type": "TypeString", - "description": "The load balancer identifier.", - "required": true - }, - { - "name": "listener", - "type": "TypeString", - "description": "The listener identifier.", - "required": true - }, - { - "name": "policy", - "type": "TypeString", - "description": "The policy identifier.", - "required": true } ], "ibm_is_lb_listeners": [ @@ -49520,16 +49764,80 @@ ], "ibm_is_lb_pool": [ { - "name": "algorithm", + "name": "provisioning_status", "type": "TypeString", - "description": "The load balancing algorithm.", + "description": "The provisioning status of this pool.", "computed": true }, { - "name": "created_at", + "name": "session_persistence", + "type": "TypeList", + "description": "The session persistence of this pool.The enumerated values for this property are expected to expand in the future. Whenprocessing this property, check for and log unknown values. Optionally haltprocessing and surface the error, or bypass the pool on which the unexpectedproperty value was encountered.", + "computed": true, + "elem": { + "cookie_name": { + "name": "cookie_name", + "type": "TypeString", + "description": "The session persistence cookie name. Applicable only for type `app_cookie`. Names starting with `IBM` are not allowed.", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "The session persistence type. The `http_cookie` and `app_cookie` types are applicable only to the `http` and `https` protocols.", + "computed": true + } + } + }, + { + "name": "identifier", "type": "TypeString", - "description": "The date and time that this pool was created.", - "computed": true + "description": "The pool identifier.", + "optional": true + }, + { + "name": "health_monitor", + "type": "TypeList", + "description": "The health monitor of this pool.", + "computed": true, + "elem": { + "delay": { + "name": "delay", + "type": "TypeInt", + "description": "The health check interval in seconds. Interval must be greater than timeout value.", + "computed": true + }, + "max_retries": { + "name": "max_retries", + "type": "TypeInt", + "description": "The health check max retries.", + "computed": true + }, + "port": { + "name": "port", + "type": "TypeInt", + "description": "The health check port number. If specified, this overrides the ports specified in the server member resources.", + "computed": true + }, + "timeout": { + "name": "timeout", + "type": "TypeInt", + "description": "The health check timeout in seconds.", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "The protocol type of this load balancer pool health monitor.The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the health monitor on which the unexpected property value was encountered.", + "computed": true + }, + "url_path": { + "name": "url_path", + "type": "TypeString", + "description": "The health check URL path. Applicable only if the health monitor `type` is `http` or`https`. This value must be in the format of an [origin-form request target](https://tools.ietf.org/html/rfc7230#section-5.3.1).", + "computed": true + } + } }, { "name": "instance_group", @@ -49577,6 +49885,18 @@ } } }, + { + "name": "protocol", + "type": "TypeString", + "description": "The protocol used for this load balancer pool.The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the pool on which the unexpected property value was encountered.", + "computed": true + }, + { + "name": "href", + "type": "TypeString", + "description": "The pool's canonical URL.", + "computed": true + }, { "name": "members", "type": "TypeList", @@ -49612,24 +49932,10 @@ } }, { - "name": "session_persistence", - "type": "TypeList", - "description": "The session persistence of this pool.The enumerated values for this property are expected to expand in the future. Whenprocessing this property, check for and log unknown values. Optionally haltprocessing and surface the error, or bypass the pool on which the unexpectedproperty value was encountered.", - "computed": true, - "elem": { - "cookie_name": { - "name": "cookie_name", - "type": "TypeString", - "description": "The session persistence cookie name. Applicable only for type `app_cookie`. Names starting with `IBM` are not allowed.", - "computed": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "The session persistence type. The `http_cookie` and `app_cookie` types are applicable only to the `http` and `https` protocols.", - "computed": true - } - } + "name": "proxy_protocol", + "type": "TypeString", + "description": "The PROXY protocol setting for this pool:- `v1`: Enabled with version 1 (human-readable header format)- `v2`: Enabled with version 2 (binary header format)- `disabled`: DisabledSupported by load balancers in the `application` family (otherwise always `disabled`).", + "computed": true }, { "name": "lb", @@ -49638,85 +49944,23 @@ "required": true }, { - "name": "identifier", - "type": "TypeString", - "description": "The pool identifier.", - "optional": true - }, - { - "name": "href", - "type": "TypeString", - "description": "The pool's canonical URL.", - "computed": true - }, - { - "name": "protocol", - "type": "TypeString", - "description": "The protocol used for this load balancer pool.The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the pool on which the unexpected property value was encountered.", - "computed": true - }, - { - "name": "provisioning_status", + "name": "name", "type": "TypeString", - "description": "The provisioning status of this pool.", + "description": "The user-defined name for this load balancer pool.", + "optional": true, "computed": true }, { - "name": "proxy_protocol", + "name": "algorithm", "type": "TypeString", - "description": "The PROXY protocol setting for this pool:- `v1`: Enabled with version 1 (human-readable header format)- `v2`: Enabled with version 2 (binary header format)- `disabled`: DisabledSupported by load balancers in the `application` family (otherwise always `disabled`).", + "description": "The load balancing algorithm.", "computed": true }, { - "name": "name", + "name": "created_at", "type": "TypeString", - "description": "The user-defined name for this load balancer pool.", - "optional": true, + "description": "The date and time that this pool was created.", "computed": true - }, - { - "name": "health_monitor", - "type": "TypeList", - "description": "The health monitor of this pool.", - "computed": true, - "elem": { - "delay": { - "name": "delay", - "type": "TypeInt", - "description": "The health check interval in seconds. Interval must be greater than timeout value.", - "computed": true - }, - "max_retries": { - "name": "max_retries", - "type": "TypeInt", - "description": "The health check max retries.", - "computed": true - }, - "port": { - "name": "port", - "type": "TypeInt", - "description": "The health check port number. If specified, this overrides the ports specified in the server member resources.", - "computed": true - }, - "timeout": { - "name": "timeout", - "type": "TypeInt", - "description": "The health check timeout in seconds.", - "computed": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "The protocol type of this load balancer pool health monitor.The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the health monitor on which the unexpected property value was encountered.", - "computed": true - }, - "url_path": { - "name": "url_path", - "type": "TypeString", - "description": "The health check URL path. Applicable only if the health monitor `type` is `http` or`https`. This value must be in the format of an [origin-form request target](https://tools.ietf.org/html/rfc7230#section-5.3.1).", - "computed": true - } - } } ], "ibm_is_lb_pool_member": [ @@ -49732,6 +49976,12 @@ "description": "The date and time that this member was created.", "computed": true }, + { + "name": "health", + "type": "TypeString", + "description": "Health of the server member in the pool.", + "computed": true + }, { "name": "port", "type": "TypeInt", @@ -49790,12 +50040,6 @@ } } }, - { - "name": "weight", - "type": "TypeInt", - "description": "Weight of the server member. Applicable only if the pool algorithm is`weighted_round_robin`.", - "computed": true - }, { "name": "pool", "type": "TypeString", @@ -49808,12 +50052,6 @@ "description": "The member identifier.", "required": true }, - { - "name": "health", - "type": "TypeString", - "description": "Health of the server member in the pool.", - "computed": true - }, { "name": "href", "type": "TypeString", @@ -49825,21 +50063,15 @@ "type": "TypeString", "description": "The provisioning status of this member.", "computed": true + }, + { + "name": "weight", + "type": "TypeInt", + "description": "Weight of the server member. Applicable only if the pool algorithm is`weighted_round_robin`.", + "computed": true } ], "ibm_is_lb_pool_members": [ - { - "name": "lb", - "type": "TypeString", - "description": "The load balancer identifier.", - "required": true - }, - { - "name": "pool", - "type": "TypeString", - "description": "The pool identifier.", - "required": true - }, { "name": "members", "type": "TypeList", @@ -49941,6 +50173,18 @@ "computed": true } } + }, + { + "name": "lb", + "type": "TypeString", + "description": "The load balancer identifier.", + "required": true + }, + { + "name": "pool", + "type": "TypeString", + "description": "The pool identifier.", + "required": true } ], "ibm_is_lb_pools": [ @@ -50152,18 +50396,6 @@ } ], "ibm_is_lb_profile": [ - { - "name": "href", - "type": "TypeString", - "description": "The URL for this load balancer profile", - "computed": true - }, - { - "name": "family", - "type": "TypeString", - "description": "The product family this load balancer profile belongs to", - "computed": true - }, { "name": "route_mode_supported", "type": "TypeBool", @@ -50193,6 +50425,18 @@ "type": "TypeString", "description": "The name for this load balancer profile", "required": true + }, + { + "name": "href", + "type": "TypeString", + "description": "The URL for this load balancer profile", + "computed": true + }, + { + "name": "family", + "type": "TypeString", + "description": "The product family this load balancer profile belongs to", + "computed": true } ], "ibm_is_lb_profiles": [ @@ -50531,71 +50775,6 @@ } ], "ibm_is_network_acl": [ - { - "name": "name", - "type": "TypeString", - "description": "The network acl name.", - "optional": true - }, - { - "name": "created_at", - "type": "TypeString", - "description": "The date and time that the network ACL was created.", - "computed": true - }, - { - "name": "crn", - "type": "TypeString", - "description": "The CRN for this network ACL.", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "subnets", - "type": "TypeList", - "description": "The subnets to which this network ACL is attached.", - "computed": true, - "elem": { - "crn": { - "name": "crn", - "type": "TypeString", - "description": "The CRN for this subnet.", - "computed": true - }, - "deleted": { - "name": "deleted", - "type": "TypeList", - "description": "If present, this property indicates the referenced resource has been deleted and providessome supplementary information.", - "computed": true, - "elem": { - "more_info": { - "name": "more_info", - "type": "TypeString", - "description": "Link to documentation about deleted resources.", - "computed": true - } - } - }, - "href": { - "name": "href", - "type": "TypeString", - "description": "The URL for this subnet.", - "computed": true - }, - "id": { - "name": "id", - "type": "TypeString", - "description": "The unique identifier for this subnet.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "The user-defined name for this subnet.", - "computed": true - } - } - }, { "name": "vpc_name", "type": "TypeString", @@ -50609,38 +50788,12 @@ "optional": true }, { - "name": "href", + "name": "crn", "type": "TypeString", - "description": "The URL for this network ACL.", + "description": "The CRN for this network ACL.", + "cloud_data_type": "crn", "computed": true }, - { - "name": "resource_group", - "type": "TypeList", - "description": "The resource group for this network ACL.", - "cloud_data_type": "resource_group", - "computed": true, - "elem": { - "href": { - "name": "href", - "type": "TypeString", - "description": "The URL for this resource group.", - "computed": true - }, - "id": { - "name": "id", - "type": "TypeString", - "description": "The unique identifier for this resource group.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "The user-defined name for this resource group.", - "computed": true - } - } - }, { "name": "rules", "type": "TypeList", @@ -50887,13 +51040,104 @@ "elem": { "type": "TypeString" } + }, + { + "name": "name", + "type": "TypeString", + "description": "The network acl name.", + "optional": true + }, + { + "name": "href", + "type": "TypeString", + "description": "The URL for this network ACL.", + "computed": true + }, + { + "name": "resource_group", + "type": "TypeList", + "description": "The resource group for this network ACL.", + "cloud_data_type": "resource_group", + "computed": true, + "elem": { + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this resource group.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this resource group.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The user-defined name for this resource group.", + "computed": true + } + } + }, + { + "name": "subnets", + "type": "TypeList", + "description": "The subnets to which this network ACL is attached.", + "computed": true, + "elem": { + "crn": { + "name": "crn", + "type": "TypeString", + "description": "The CRN for this subnet.", + "computed": true + }, + "deleted": { + "name": "deleted", + "type": "TypeList", + "description": "If present, this property indicates the referenced resource has been deleted and providessome supplementary information.", + "computed": true, + "elem": { + "more_info": { + "name": "more_info", + "type": "TypeString", + "description": "Link to documentation about deleted resources.", + "computed": true + } + } + }, + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this subnet.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this subnet.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The user-defined name for this subnet.", + "computed": true + } + } + }, + { + "name": "created_at", + "type": "TypeString", + "description": "The date and time that the network ACL was created.", + "computed": true } ], "ibm_is_network_acl_rule": [ { - "name": "before", + "name": "href", "type": "TypeString", - "description": "The rule that this rule is immediately before. If absent, this is the last rule.", + "description": "The URL for this network ACL rule", "computed": true }, { @@ -50981,33 +51225,27 @@ } }, { - "name": "name", - "type": "TypeString", - "description": "The user-defined name for this rule", - "required": true - }, - { - "name": "href", + "name": "source", "type": "TypeString", - "description": "The URL for this network ACL rule", + "description": "The source IP address or CIDR block.", "computed": true }, { - "name": "ip_version", + "name": "destination", "type": "TypeString", - "description": "The IP version for this rule.", + "description": "The destination IP address or CIDR block.", "computed": true }, { - "name": "source", + "name": "name", "type": "TypeString", - "description": "The source IP address or CIDR block.", - "computed": true + "description": "The user-defined name for this rule", + "required": true }, { - "name": "direction", + "name": "protocol", "type": "TypeString", - "description": "Whether the traffic to be matched is inbound or outbound.", + "description": "The protocol to enforce.", "computed": true }, { @@ -51023,37 +51261,31 @@ "computed": true }, { - "name": "protocol", + "name": "ip_version", "type": "TypeString", - "description": "The protocol to enforce.", + "description": "The IP version for this rule.", "computed": true }, { - "name": "action", + "name": "direction", "type": "TypeString", - "description": "Whether to allow or deny matching traffic.", + "description": "Whether the traffic to be matched is inbound or outbound.", "computed": true }, { - "name": "destination", + "name": "before", "type": "TypeString", - "description": "The destination IP address or CIDR block.", + "description": "The rule that this rule is immediately before. If absent, this is the last rule.", "computed": true - } - ], - "ibm_is_network_acl_rules": [ - { - "name": "direction", - "type": "TypeString", - "description": "The direction of the rules to filter", - "optional": true }, { - "name": "network_acl", + "name": "action", "type": "TypeString", - "description": "Network ACL id", - "required": true - }, + "description": "Whether to allow or deny matching traffic.", + "computed": true + } + ], + "ibm_is_network_acl_rules": [ { "name": "rules", "type": "TypeList", @@ -51205,9 +51437,28 @@ } } } + }, + { + "name": "direction", + "type": "TypeString", + "description": "The direction of the rules to filter", + "optional": true + }, + { + "name": "network_acl", + "type": "TypeString", + "description": "Network ACL id", + "required": true } ], "ibm_is_network_acls": [ + { + "name": "resource_group", + "type": "TypeString", + "description": "Resource group identifier.", + "cloud_data_type": "resource_group", + "optional": true + }, { "name": "network_acls", "type": "TypeList", @@ -51564,28 +51815,9 @@ } } } - }, - { - "name": "resource_group", - "type": "TypeString", - "description": "Resource group identifier.", - "cloud_data_type": "resource_group", - "optional": true } ], "ibm_is_operating_system": [ - { - "name": "href", - "type": "TypeString", - "description": "The URL for this operating system", - "computed": true - }, - { - "name": "vendor", - "type": "TypeString", - "description": "The vendor of the operating system", - "computed": true - }, { "name": "name", "type": "TypeString", @@ -51621,6 +51853,18 @@ "type": "TypeString", "description": "The name of the software family this operating system belongs to", "computed": true + }, + { + "name": "href", + "type": "TypeString", + "description": "The URL for this operating system", + "computed": true + }, + { + "name": "vendor", + "type": "TypeString", + "description": "The vendor of the operating system", + "computed": true } ], "ibm_is_operating_systems": [ @@ -51682,12 +51926,6 @@ } ], "ibm_is_placement_group": [ - { - "name": "lifecycle_state", - "type": "TypeString", - "description": "The lifecycle state of the placement group.", - "computed": true - }, { "name": "resource_group", "type": "TypeList", @@ -51715,12 +51953,6 @@ } } }, - { - "name": "resource_type", - "type": "TypeString", - "description": "The resource type.", - "computed": true - }, { "name": "strategy", "type": "TypeString", @@ -51728,16 +51960,25 @@ "computed": true }, { - "name": "created_at", + "name": "tags", + "type": "TypeSet", + "description": "List of tags", + "cloud_data_type": "tags", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "name", "type": "TypeString", - "description": "The date and time that the placement group was created.", - "computed": true + "description": "The placement group name.", + "required": true }, { - "name": "crn", + "name": "created_at", "type": "TypeString", - "description": "The CRN for this placement group.", - "cloud_data_type": "crn", + "description": "The date and time that the placement group was created.", "computed": true }, { @@ -51746,22 +51987,6 @@ "description": "The URL for this placement group.", "computed": true }, - { - "name": "name", - "type": "TypeString", - "description": "The placement group name.", - "required": true - }, - { - "name": "tags", - "type": "TypeSet", - "description": "List of tags", - "cloud_data_type": "tags", - "computed": true, - "elem": { - "type": "TypeString" - } - }, { "name": "access_tags", "type": "TypeSet", @@ -51770,6 +51995,25 @@ "elem": { "type": "TypeString" } + }, + { + "name": "crn", + "type": "TypeString", + "description": "The CRN for this placement group.", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "lifecycle_state", + "type": "TypeString", + "description": "The lifecycle state of the placement group.", + "computed": true + }, + { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true } ], "ibm_is_placement_groups": [ @@ -51882,21 +52126,27 @@ ], "ibm_is_public_gateway": [ { - "name": "vpc", + "name": "resource_status", "type": "TypeString", - "description": "Public gateway VPC info", + "description": "The status of the resource", "computed": true }, { - "name": "resource_controller_url", + "name": "resource_crn", "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", + "description": "The crn of the resource", "computed": true }, { - "name": "status", + "name": "floating_ip", + "type": "TypeMap", + "description": "Public gateway floating IP", + "computed": true + }, + { + "name": "zone", "type": "TypeString", - "description": "Public gateway instance status", + "description": "Public gateway zone info", "computed": true }, { @@ -51909,16 +52159,9 @@ } }, { - "name": "crn", - "type": "TypeString", - "description": "The crn of the resource", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "resource_status", + "name": "resource_controller_url", "type": "TypeString", - "description": "The status of the resource", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", "computed": true }, { @@ -51928,31 +52171,16 @@ "required": true }, { - "name": "floating_ip", - "type": "TypeMap", - "description": "Public gateway floating IP", - "computed": true - }, - { - "name": "zone", + "name": "resource_name", "type": "TypeString", - "description": "Public gateway zone info", + "description": "The name of the resource", "computed": true }, { - "name": "tags", - "type": "TypeSet", - "description": "Service tags for the public gateway instance", - "cloud_data_type": "tags", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "resource_crn", + "name": "crn", "type": "TypeString", "description": "The crn of the resource", + "cloud_data_type": "crn", "computed": true }, { @@ -51970,9 +52198,25 @@ "computed": true }, { - "name": "resource_name", + "name": "vpc", "type": "TypeString", - "description": "The name of the resource", + "description": "Public gateway VPC info", + "computed": true + }, + { + "name": "tags", + "type": "TypeSet", + "description": "Service tags for the public gateway instance", + "cloud_data_type": "tags", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "status", + "type": "TypeString", + "description": "Public gateway instance status", "computed": true } ], @@ -52092,19 +52336,19 @@ ], "ibm_is_region": [ { - "name": "endpoint", + "name": "status", "type": "TypeString", "computed": true }, { - "name": "name", + "name": "endpoint", "type": "TypeString", - "optional": true + "computed": true }, { - "name": "status", + "name": "name", "type": "TypeString", - "computed": true + "optional": true } ], "ibm_is_regions": [ @@ -52138,40 +52382,6 @@ } ], "ibm_is_security_group": [ - { - "name": "resource_controller_url", - "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", - "computed": true - }, - { - "name": "resource_name", - "type": "TypeString", - "description": "The name of the resource", - "computed": true - }, - { - "name": "resource_group_name", - "type": "TypeString", - "description": "The resource group name in which resource is provisioned", - "computed": true - }, - { - "name": "access_tags", - "type": "TypeSet", - "description": "List of access management tags", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "crn", - "type": "TypeString", - "description": "The crn of the resource", - "cloud_data_type": "crn", - "computed": true - }, { "name": "name", "type": "TypeString", @@ -52243,39 +52453,61 @@ } }, { - "name": "resource_crn", + "name": "resource_controller_url", "type": "TypeString", - "description": "The crn of the resource", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", "computed": true }, { - "name": "tags", + "name": "resource_group_name", + "type": "TypeString", + "description": "The resource group name in which resource is provisioned", + "computed": true + }, + { + "name": "access_tags", "type": "TypeSet", - "description": "List of tags", - "cloud_data_type": "tags", + "description": "List of access management tags", "computed": true, "elem": { "type": "TypeString" } - } - ], - "ibm_is_security_group_rule": [ + }, { - "name": "direction", + "name": "crn", "type": "TypeString", - "description": "The direction of traffic to enforce, either `inbound` or `outbound`.", + "description": "The crn of the resource", + "cloud_data_type": "crn", "computed": true }, { - "name": "ip_version", + "name": "resource_name", "type": "TypeString", - "description": "The IP version to enforce. The format of `remote.address` or `remote.cidr_block` must match this property, if they are used. Alternatively, if `remote` references a security group, then this rule only applies to IP addresses (network interfaces) in that group matching this IP version.", + "description": "The name of the resource", "computed": true }, { - "name": "type", + "name": "resource_crn", + "type": "TypeString", + "description": "The crn of the resource", + "computed": true + }, + { + "name": "tags", + "type": "TypeSet", + "description": "List of tags", + "cloud_data_type": "tags", + "computed": true, + "elem": { + "type": "TypeString" + } + } + ], + "ibm_is_security_group_rule": [ + { + "name": "code", "type": "TypeInt", - "description": "The ICMP traffic type to allow.", + "description": "The ICMP traffic code to allow.", "computed": true }, { @@ -52291,9 +52523,9 @@ "computed": true }, { - "name": "protocol", + "name": "ip_version", "type": "TypeString", - "description": "The protocol to enforce.", + "description": "The IP version to enforce. The format of `remote.address` or `remote.cidr_block` must match this property, if they are used. Alternatively, if `remote` references a security group, then this rule only applies to IP addresses (network interfaces) in that group matching this IP version.", "computed": true }, { @@ -52354,12 +52586,6 @@ } } }, - { - "name": "code", - "type": "TypeInt", - "description": "The ICMP traffic code to allow.", - "computed": true - }, { "name": "port_max", "type": "TypeInt", @@ -52377,6 +52603,24 @@ "type": "TypeString", "description": "The rule identifier.", "required": true + }, + { + "name": "direction", + "type": "TypeString", + "description": "The direction of traffic to enforce, either `inbound` or `outbound`.", + "computed": true + }, + { + "name": "protocol", + "type": "TypeString", + "description": "The protocol to enforce.", + "computed": true + }, + { + "name": "type", + "type": "TypeInt", + "description": "The ICMP traffic type to allow.", + "computed": true } ], "ibm_is_security_group_rules": [ @@ -52508,18 +52752,6 @@ } ], "ibm_is_security_group_target": [ - { - "name": "security_group", - "type": "TypeString", - "description": "Security group id", - "required": true - }, - { - "name": "target", - "type": "TypeString", - "description": "security group target identifier", - "computed": true - }, { "name": "name", "type": "TypeString", @@ -52544,6 +52776,18 @@ "type": "TypeString", "description": "Link to documentation about deleted resources", "computed": true + }, + { + "name": "security_group", + "type": "TypeString", + "description": "Security group id", + "required": true + }, + { + "name": "target", + "type": "TypeString", + "description": "security group target identifier", + "computed": true } ], "ibm_is_security_group_targets": [ @@ -52593,13 +52837,6 @@ } ], "ibm_is_security_groups": [ - { - "name": "resource_group", - "type": "TypeString", - "description": "resource group identifier.", - "cloud_data_type": "resource_group", - "optional": true - }, { "name": "vpc_id", "type": "TypeString", @@ -52908,20 +53145,21 @@ } } } + }, + { + "name": "resource_group", + "type": "TypeString", + "description": "resource group identifier.", + "cloud_data_type": "resource_group", + "optional": true } ], "ibm_is_share": [ { - "name": "encryption", - "type": "TypeString", - "description": "The type of encryption used for this file share.", - "computed": true - }, - { - "name": "href", + "name": "share", "type": "TypeString", - "description": "The URL for this share.", - "computed": true + "description": "The file share identifier.", + "optional": true }, { "name": "iops", @@ -52936,17 +53174,36 @@ "computed": true }, { - "name": "resource_type", + "name": "resource_group", "type": "TypeString", - "description": "The type of resource referenced.", + "description": "The unique identifier of the resource group for this file share.", + "cloud_data_type": "resource_group", "computed": true }, { - "name": "share_targets", + "name": "size", + "type": "TypeInt", + "description": "The size of the file share rounded up to the next gigabyte.", + "computed": true + }, + { + "name": "access_control_mode", + "type": "TypeString", + "description": "The access control mode for the share", + "computed": true + }, + { + "name": "source_share", "type": "TypeList", - "description": "Mount targets for the file share.", + "description": "The source file share for this replica file share.This property will be present when the `replication_role` is `replica`.", "computed": true, "elem": { + "crn": { + "name": "crn", + "type": "TypeString", + "description": "The CRN for this file share.", + "computed": true + }, "deleted": { "name": "deleted", "type": "TypeList", @@ -52964,29 +53221,35 @@ "href": { "name": "href", "type": "TypeString", - "description": "The URL for this share target.", + "description": "The URL for this file share.", "computed": true }, "id": { "name": "id", "type": "TypeString", - "description": "The unique identifier for this share target.", + "description": "The unique identifier for this file share.", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "The user-defined name for this share target.", + "description": "The unique user-defined name for this file share.", "computed": true }, "resource_type": { "name": "resource_type", "type": "TypeString", - "description": "The type of resource referenced.", + "description": "The resource type.", "computed": true } } }, + { + "name": "zone", + "type": "TypeString", + "description": "The globally unique name of the zone this file share will reside in.", + "computed": true + }, { "name": "crn", "type": "TypeString", @@ -52994,12 +53257,162 @@ "cloud_data_type": "crn", "computed": true }, + { + "name": "encryption", + "type": "TypeString", + "description": "The type of encryption used for this file share.", + "computed": true + }, { "name": "lifecycle_state", "type": "TypeString", "description": "The lifecycle state of the file share.", "computed": true }, + { + "name": "profile", + "type": "TypeString", + "description": "The globally unique name of the profile this file share uses.", + "computed": true + }, + { + "name": "replica_share", + "type": "TypeList", + "description": "The replica file share for this source file share.This property will be present when the `replication_role` is `source`.", + "computed": true, + "elem": { + "crn": { + "name": "crn", + "type": "TypeString", + "description": "The CRN for this file share.", + "computed": true + }, + "deleted": { + "name": "deleted", + "type": "TypeList", + "description": "If present, this property indicates the referenced resource has been deleted and providessome supplementary information.", + "computed": true, + "elem": { + "more_info": { + "name": "more_info", + "type": "TypeString", + "description": "Link to documentation about deleted resources.", + "computed": true + } + } + }, + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this file share.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this file share.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The unique user-defined name for this file share.", + "computed": true + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true + } + } + }, + { + "name": "resource_type", + "type": "TypeString", + "description": "The type of resource referenced.", + "computed": true + }, + { + "name": "access_tags", + "type": "TypeSet", + "description": "List of access management tags", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "name", + "type": "TypeString", + "description": "Name of the share.", + "optional": true, + "computed": true + }, + { + "name": "encryption_key", + "type": "TypeString", + "description": "The key used to encrypt this file share. The CRN of the [Key Protect Root Key](https://cloud.ibm.com/docs/key-protect?topic=key-protect-getting-started-tutorial) or [Hyper Protect Crypto Service Root Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started) for this resource.", + "computed": true + }, + { + "name": "href", + "type": "TypeString", + "description": "The URL for this share.", + "computed": true + }, + { + "name": "latest_job", + "type": "TypeList", + "description": "The latest job associated with this file share.This property will be absent if no jobs have been created for this file share.", + "computed": true, + "elem": { + "status": { + "name": "status", + "type": "TypeString", + "description": "The status of the file share job.The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the file share job on which the unexpected property value was encountered.* `cancelled`: This job has been cancelled.* `failed`: This job has failed.* `queued`: This job is queued.* `running`: This job is running.* `succeeded`: This job completed successfully.", + "computed": true + }, + "status_reasons": { + "name": "status_reasons", + "type": "TypeList", + "description": "The reasons for the file share job status (if any).The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered.", + "computed": true, + "elem": { + "code": { + "name": "code", + "type": "TypeString", + "description": "A snake case string succinctly identifying the status reason.", + "computed": true + }, + "message": { + "name": "message", + "type": "TypeString", + "description": "An explanation of the status reason.", + "computed": true + }, + "more_info": { + "name": "more_info", + "type": "TypeString", + "description": "Link to documentation about this status reason.", + "computed": true + } + } + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "The type of the file share job.The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the file share job on which the unexpected property value was encountered.* `replication_failover`: This is a share replication failover job.* `replication_init`: This is a share replication is initialization job.* `replication_split`: This is a share replication split job.", + "computed": true + } + } + }, + { + "name": "replication_cron_spec", + "type": "TypeString", + "description": "The cron specification for the file share replication schedule.This property will be present when the `replication_role` is `replica`.", + "computed": true + }, { "name": "replication_status_reasons", "type": "TypeList", @@ -53027,87 +53440,23 @@ } }, { - "name": "size", - "type": "TypeInt", - "description": "The size of the file share rounded up to the next gigabyte.", - "computed": true - }, - { - "name": "source_share", - "type": "TypeList", - "description": "The source file share for this replica file share.This property will be present when the `replication_role` is `replica`.", - "computed": true, - "elem": { - "crn": { - "name": "crn", - "type": "TypeString", - "description": "The CRN for this file share.", - "computed": true - }, - "deleted": { - "name": "deleted", - "type": "TypeList", - "description": "If present, this property indicates the referenced resource has been deleted and providessome supplementary information.", - "computed": true, - "elem": { - "more_info": { - "name": "more_info", - "type": "TypeString", - "description": "Link to documentation about deleted resources.", - "computed": true - } - } - }, - "href": { - "name": "href", - "type": "TypeString", - "description": "The URL for this file share.", - "computed": true - }, - "id": { - "name": "id", - "type": "TypeString", - "description": "The unique identifier for this file share.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "The unique user-defined name for this file share.", - "computed": true - }, - "resource_type": { - "name": "resource_type", - "type": "TypeString", - "description": "The resource type.", - "computed": true - } - } - }, - { - "name": "encryption_key", + "name": "created_at", "type": "TypeString", - "description": "The key used to encrypt this file share. The CRN of the [Key Protect Root Key](https://cloud.ibm.com/docs/key-protect?topic=key-protect-getting-started-tutorial) or [Hyper Protect Crypto Service Root Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started) for this resource.", + "description": "The date and time that the file share is created.", "computed": true }, { - "name": "profile", + "name": "replication_status", "type": "TypeString", - "description": "The globally unique name of the profile this file share uses.", + "description": "The replication status of the file share.* `active`: This share is actively participating in replication, and the replica's data is up-to-date with the replication schedule.* `failover_pending`: This share is performing a replication failover.* `initializing`: This share is initializing replication.* `none`: This share is not participating in replication.* `split_pending`: This share is performing a replication split.", "computed": true }, { - "name": "replica_share", + "name": "share_targets", "type": "TypeList", - "description": "The replica file share for this source file share.This property will be present when the `replication_role` is `source`.", + "description": "Mount targets for the file share.", "computed": true, "elem": { - "crn": { - "name": "crn", - "type": "TypeString", - "description": "The CRN for this file share.", - "computed": true - }, "deleted": { "name": "deleted", "type": "TypeList", @@ -53125,128 +53474,29 @@ "href": { "name": "href", "type": "TypeString", - "description": "The URL for this file share.", + "description": "The URL for this share target.", "computed": true }, "id": { "name": "id", "type": "TypeString", - "description": "The unique identifier for this file share.", + "description": "The unique identifier for this share target.", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "The unique user-defined name for this file share.", + "description": "The user-defined name for this share target.", "computed": true }, "resource_type": { "name": "resource_type", "type": "TypeString", - "description": "The resource type.", - "computed": true - } - } - }, - { - "name": "zone", - "type": "TypeString", - "description": "The globally unique name of the zone this file share will reside in.", - "computed": true - }, - { - "name": "access_tags", - "type": "TypeSet", - "description": "List of access management tags", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "name", - "type": "TypeString", - "description": "Name of the share.", - "optional": true, - "computed": true - }, - { - "name": "created_at", - "type": "TypeString", - "description": "The date and time that the file share is created.", - "computed": true - }, - { - "name": "latest_job", - "type": "TypeList", - "description": "The latest job associated with this file share.This property will be absent if no jobs have been created for this file share.", - "computed": true, - "elem": { - "status": { - "name": "status", - "type": "TypeString", - "description": "The status of the file share job.The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the file share job on which the unexpected property value was encountered.* `cancelled`: This job has been cancelled.* `failed`: This job has failed.* `queued`: This job is queued.* `running`: This job is running.* `succeeded`: This job completed successfully.", - "computed": true - }, - "status_reasons": { - "name": "status_reasons", - "type": "TypeList", - "description": "The reasons for the file share job status (if any).The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered.", - "computed": true, - "elem": { - "code": { - "name": "code", - "type": "TypeString", - "description": "A snake case string succinctly identifying the status reason.", - "computed": true - }, - "message": { - "name": "message", - "type": "TypeString", - "description": "An explanation of the status reason.", - "computed": true - }, - "more_info": { - "name": "more_info", - "type": "TypeString", - "description": "Link to documentation about this status reason.", - "computed": true - } - } - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "The type of the file share job.The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the file share job on which the unexpected property value was encountered.* `replication_failover`: This is a share replication failover job.* `replication_init`: This is a share replication is initialization job.* `replication_split`: This is a share replication split job.", + "description": "The type of resource referenced.", "computed": true } } }, - { - "name": "replication_cron_spec", - "type": "TypeString", - "description": "The cron specification for the file share replication schedule.This property will be present when the `replication_role` is `replica`.", - "computed": true - }, - { - "name": "replication_status", - "type": "TypeString", - "description": "The replication status of the file share.* `active`: This share is actively participating in replication, and the replica's data is up-to-date with the replication schedule.* `failover_pending`: This share is performing a replication failover.* `initializing`: This share is initializing replication.* `none`: This share is not participating in replication.* `split_pending`: This share is performing a replication split.", - "computed": true - }, - { - "name": "resource_group", - "type": "TypeString", - "description": "The unique identifier of the resource group for this file share.", - "cloud_data_type": "resource_group", - "computed": true - }, - { - "name": "access_control_mode", - "type": "TypeString", - "description": "The access control mode for the share", - "computed": true - }, { "name": "tags", "type": "TypeSet", @@ -53256,25 +53506,24 @@ "elem": { "type": "TypeString" } - }, - { - "name": "share", - "type": "TypeString", - "description": "The file share identifier.", - "optional": true } ], "ibm_is_share_mount_target": [ { - "name": "access_control_mode", + "name": "mount_target", "type": "TypeString", - "description": "The access control mode for the share", - "computed": true + "description": "The share target identifier.", + "optional": true }, { - "name": "href", + "name": "share_name", + "type": "TypeString", + "description": "The file share name.", + "optional": true + }, + { + "name": "transit_encryption", "type": "TypeString", - "description": "The URL for this share target.", "computed": true }, { @@ -53336,33 +53585,27 @@ } }, { - "name": "share", - "type": "TypeString", - "description": "The file share identifier.", - "optional": true - }, - { - "name": "mount_target_name", + "name": "access_control_mode", "type": "TypeString", - "description": "The share target name.", - "optional": true + "description": "The access control mode for the share", + "computed": true }, { - "name": "created_at", + "name": "href", "type": "TypeString", - "description": "The date and time that the share target was created.", + "description": "The URL for this share target.", "computed": true }, { - "name": "mount_target", + "name": "mount_path", "type": "TypeString", - "description": "The share target identifier.", - "optional": true + "description": "The mount path for the share.The IP addresses used in the mount path are currently within the IBM services IP range, but are expected to change to be within one of the VPC's subnets in the future.", + "computed": true }, { - "name": "lifecycle_state", + "name": "resource_type", "type": "TypeString", - "description": "The lifecycle state of the mount target.", + "description": "The type of resource referenced.", "computed": true }, { @@ -53418,20 +53661,27 @@ } }, { - "name": "transit_encryption", + "name": "share", "type": "TypeString", - "computed": true + "description": "The file share identifier.", + "optional": true }, { - "name": "mount_path", + "name": "mount_target_name", "type": "TypeString", - "description": "The mount path for the share.The IP addresses used in the mount path are currently within the IBM services IP range, but are expected to change to be within one of the VPC's subnets in the future.", + "description": "The share target name.", + "optional": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "The date and time that the share target was created.", "computed": true }, { - "name": "resource_type", + "name": "lifecycle_state", "type": "TypeString", - "description": "The type of resource referenced.", + "description": "The lifecycle state of the mount target.", "computed": true }, { @@ -53485,12 +53735,6 @@ "computed": true } } - }, - { - "name": "share_name", - "type": "TypeString", - "description": "The file share name.", - "optional": true } ], "ibm_is_share_mount_targets": [ @@ -53726,24 +53970,6 @@ } ], "ibm_is_share_profile": [ - { - "name": "family", - "type": "TypeString", - "description": "The product family this share profile belongs to.", - "computed": true - }, - { - "name": "href", - "type": "TypeString", - "description": "The URL for this share profile.", - "computed": true - }, - { - "name": "resource_type", - "type": "TypeString", - "description": "The resource type.", - "computed": true - }, { "name": "name", "type": "TypeString", @@ -53852,6 +54078,24 @@ "computed": true } } + }, + { + "name": "family", + "type": "TypeString", + "description": "The product family this share profile belongs to.", + "computed": true + }, + { + "name": "href", + "type": "TypeString", + "description": "The URL for this share profile.", + "computed": true + }, + { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true } ], "ibm_is_share_profiles": [ @@ -54001,6 +54245,12 @@ } ], "ibm_is_shares": [ + { + "name": "name", + "type": "TypeString", + "description": "Name of the share.", + "optional": true + }, { "name": "resource_group", "type": "TypeString", @@ -54369,45 +54619,27 @@ "type": "TypeInt", "description": "The total number of resources across all pages.", "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Name of the share.", - "optional": true } ], "ibm_is_snapshot": [ { - "name": "crn", - "type": "TypeString", - "description": "The crn of the resource", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "minimum_capacity", - "type": "TypeInt", - "description": "Minimum capacity of the snapshot", - "computed": true - }, - { - "name": "size", - "type": "TypeInt", - "description": "The size of the snapshot", - "computed": true - }, - { - "name": "identifier", - "type": "TypeString", - "description": "Snapshot identifier", - "optional": true + "name": "clones", + "type": "TypeSet", + "description": "Zones for creating the snapshot clone", + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "name", - "type": "TypeString", - "description": "Snapshot name", - "optional": true + "name": "tags", + "type": "TypeSet", + "description": "User Tags for the snapshot", + "cloud_data_type": "tags", + "computed": true, + "elem": { + "type": "TypeString" + } }, { "name": "source_snapshot", @@ -54484,85 +54716,45 @@ } }, { - "name": "access_tags", - "type": "TypeSet", - "description": "List of access tags", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "href", - "type": "TypeString", - "description": "URL for the snapshot", - "computed": true - }, - { - "name": "resource_type", - "type": "TypeString", - "description": "The resource type of the snapshot", - "computed": true - }, - { - "name": "clones", - "type": "TypeSet", - "description": "Zones for creating the snapshot clone", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "captured_at", - "type": "TypeString", - "description": "The date and time that this snapshot was created", - "computed": true - }, - { - "name": "source_volume", + "name": "encryption", "type": "TypeString", - "description": "Snapshot source volume id", + "description": "Encryption type of the snapshot", "computed": true }, { - "name": "operating_system", + "name": "encryption_key", "type": "TypeString", - "description": "The globally unique name for the operating system included in this image", + "description": "A reference to the root key used to wrap the data encryption key for the source volume.", "computed": true }, { - "name": "lifecycle_state", + "name": "href", "type": "TypeString", - "description": "Snapshot lifecycle state", + "description": "URL for the snapshot", "computed": true }, { - "name": "encryption", - "type": "TypeString", - "description": "Encryption type of the snapshot", + "name": "minimum_capacity", + "type": "TypeInt", + "description": "Minimum capacity of the snapshot", "computed": true }, { - "name": "tags", - "type": "TypeSet", - "description": "User Tags for the snapshot", - "cloud_data_type": "tags", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "backup_policy_plan", + "name": "copies", "type": "TypeList", - "description": "If present, the backup policy plan which created this snapshot.", + "description": "The copies of this snapshot in other regions.", "computed": true, "elem": { + "crn": { + "name": "crn", + "type": "TypeString", + "description": "The CRN for the copied snapshot.", + "computed": true + }, "deleted": { "name": "deleted", "type": "TypeList", - "description": "If present, this property indicates the referenced resource has been deleted and provides some supplementary information.", + "description": "If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.", "computed": true, "elem": { "more_info": { @@ -54576,51 +54768,111 @@ "href": { "name": "href", "type": "TypeString", - "description": "The URL for this backup policy plan.", + "description": "The URL for the copied snapshot.", "computed": true }, "id": { "name": "id", "type": "TypeString", - "description": "The unique identifier for this backup policy plan.", + "description": "The unique identifier for the copied snapshot.", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "The unique user-defined name for this backup policy plan.", + "description": "The name for the copied snapshot. The name is unique across all snapshots in the copied snapshot's native region.", "computed": true }, + "remote": { + "name": "remote", + "type": "TypeList", + "description": "If present, this property indicates the referenced resource is remote to this region,and identifies the native region.", + "computed": true, + "elem": { + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this region.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The globally unique name for this region.", + "computed": true + } + } + }, "resource_type": { "name": "resource_type", "type": "TypeString", - "description": "The type of resource referenced", + "description": "The resource type.", "computed": true } } }, { - "name": "encryption_key", + "name": "resource_type", "type": "TypeString", - "description": "A reference to the root key used to wrap the data encryption key for the source volume.", + "description": "The resource type of the snapshot", "computed": true }, { - "name": "copies", + "name": "size", + "type": "TypeInt", + "description": "The size of the snapshot", + "computed": true + }, + { + "name": "operating_system", + "type": "TypeString", + "description": "The globally unique name for the operating system included in this image", + "computed": true + }, + { + "name": "bootable", + "type": "TypeBool", + "description": "Indicates if a boot volume attachment can be created with a volume created from this snapshot", + "computed": true + }, + { + "name": "lifecycle_state", + "type": "TypeString", + "description": "Snapshot lifecycle state", + "computed": true + }, + { + "name": "captured_at", + "type": "TypeString", + "description": "The date and time that this snapshot was created", + "computed": true + }, + { + "name": "access_tags", + "type": "TypeSet", + "description": "List of access tags", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "crn", + "type": "TypeString", + "description": "The crn of the resource", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "backup_policy_plan", "type": "TypeList", - "description": "The copies of this snapshot in other regions.", + "description": "If present, the backup policy plan which created this snapshot.", "computed": true, "elem": { - "crn": { - "name": "crn", - "type": "TypeString", - "description": "The CRN for the copied snapshot.", - "computed": true - }, "deleted": { "name": "deleted", "type": "TypeList", - "description": "If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.", + "description": "If present, this property indicates the referenced resource has been deleted and provides some supplementary information.", "computed": true, "elem": { "more_info": { @@ -54634,49 +54886,41 @@ "href": { "name": "href", "type": "TypeString", - "description": "The URL for the copied snapshot.", + "description": "The URL for this backup policy plan.", "computed": true }, "id": { "name": "id", "type": "TypeString", - "description": "The unique identifier for the copied snapshot.", + "description": "The unique identifier for this backup policy plan.", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "The name for the copied snapshot. The name is unique across all snapshots in the copied snapshot's native region.", + "description": "The unique user-defined name for this backup policy plan.", "computed": true }, - "remote": { - "name": "remote", - "type": "TypeList", - "description": "If present, this property indicates the referenced resource is remote to this region,and identifies the native region.", - "computed": true, - "elem": { - "href": { - "name": "href", - "type": "TypeString", - "description": "The URL for this region.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "The globally unique name for this region.", - "computed": true - } - } - }, "resource_type": { "name": "resource_type", "type": "TypeString", - "description": "The resource type.", + "description": "The type of resource referenced", "computed": true } } }, + { + "name": "identifier", + "type": "TypeString", + "description": "Snapshot identifier", + "optional": true + }, + { + "name": "name", + "type": "TypeString", + "description": "Snapshot name", + "optional": true + }, { "name": "resource_group", "type": "TypeString", @@ -54685,15 +54929,15 @@ "computed": true }, { - "name": "source_image", + "name": "source_volume", "type": "TypeString", - "description": "If present, the image id from which the data on this volume was most directly provisioned.", + "description": "Snapshot source volume id", "computed": true }, { - "name": "bootable", - "type": "TypeBool", - "description": "Indicates if a boot volume attachment can be created with a volume created from this snapshot", + "name": "source_image", + "type": "TypeString", + "description": "If present, the image id from which the data on this volume was most directly provisioned.", "computed": true } ], @@ -54756,36 +55000,6 @@ } ], "ibm_is_snapshots": [ - { - "name": "name", - "type": "TypeString", - "description": "Filters the snapshot collection by snapshot name", - "optional": true - }, - { - "name": "tag", - "type": "TypeString", - "description": "Filters the collection to resources with the exact tag value", - "optional": true - }, - { - "name": "snapshot_copies_id", - "type": "TypeString", - "description": "Filters the collection to snapshots with copies with the specified identifier.", - "optional": true - }, - { - "name": "source_snapshot_remote_region_name", - "type": "TypeString", - "description": "Filters the collection to snapshots with a source snapshot with the exact remote region name.", - "optional": true - }, - { - "name": "snapshot_source_volume_remote_region_name", - "type": "TypeString", - "description": "Filters the collection to snapshots with a source snapshot with the exact remote region name.", - "optional": true - }, { "name": "resource_group", "type": "TypeString", @@ -54794,15 +55008,15 @@ "optional": true }, { - "name": "source_image", + "name": "name", "type": "TypeString", - "description": "Filters the snapshot collection by source image id", + "description": "Filters the snapshot collection by snapshot name", "optional": true }, { - "name": "backup_policy_plan_id", + "name": "snapshot_copies_id", "type": "TypeString", - "description": "Filters the collection to backup policy jobs with the backup plan with the specified identifier", + "description": "Filters the collection to snapshots with copies with the specified identifier.", "optional": true }, { @@ -54812,27 +55026,21 @@ "optional": true }, { - "name": "source_volume", - "type": "TypeString", - "description": "Filters the snapshot collection by source volume id", - "optional": true - }, - { - "name": "source_snapshot_id", + "name": "source_snapshot_remote_region_name", "type": "TypeString", - "description": "Filters the collection to resources with the source snapshot with the specified identifier.", + "description": "Filters the collection to snapshots with a source snapshot with the exact remote region name.", "optional": true }, { - "name": "snapshot_copies_name", + "name": "source_image", "type": "TypeString", - "description": "Filters the collection to snapshots with copies with the exact specified name.", + "description": "Filters the snapshot collection by source image id", "optional": true }, { - "name": "snapshot_copies_remote_region_name", + "name": "snapshot_source_volume_remote_region_name", "type": "TypeString", - "description": "Filters the collection to snapshots with copies with the exact remote region name.", + "description": "Filters the collection to snapshots with a source snapshot with the exact remote region name.", "optional": true }, { @@ -55156,6 +55364,42 @@ } } } + }, + { + "name": "backup_policy_plan_id", + "type": "TypeString", + "description": "Filters the collection to backup policy jobs with the backup plan with the specified identifier", + "optional": true + }, + { + "name": "source_snapshot_id", + "type": "TypeString", + "description": "Filters the collection to resources with the source snapshot with the specified identifier.", + "optional": true + }, + { + "name": "source_volume", + "type": "TypeString", + "description": "Filters the snapshot collection by source volume id", + "optional": true + }, + { + "name": "tag", + "type": "TypeString", + "description": "Filters the collection to resources with the exact tag value", + "optional": true + }, + { + "name": "snapshot_copies_name", + "type": "TypeString", + "description": "Filters the collection to snapshots with copies with the exact specified name.", + "optional": true + }, + { + "name": "snapshot_copies_remote_region_name", + "type": "TypeString", + "description": "Filters the collection to snapshots with copies with the exact remote region name.", + "optional": true } ], "ibm_is_source_share": [ @@ -55193,34 +55437,34 @@ ], "ibm_is_ssh_key": [ { - "name": "resource_crn", + "name": "resource_name", "type": "TypeString", - "description": "The crn of the resource", + "description": "The name of the resource", "computed": true }, { - "name": "resource_group_name", + "name": "crn", "type": "TypeString", - "description": "The resource group name in which resource is provisioned", + "description": "The crn of the resource", + "cloud_data_type": "crn", "computed": true }, { - "name": "resource_group", + "name": "name", "type": "TypeString", - "description": "Resource group ID", - "cloud_data_type": "resource_group", - "optional": true + "description": "The name of the ssh key", + "required": true }, { - "name": "length", - "type": "TypeInt", - "description": "The ssh key length", + "name": "type", + "type": "TypeString", + "description": "The ssh key type", "computed": true }, { - "name": "resource_name", + "name": "fingerprint", "type": "TypeString", - "description": "The name of the resource", + "description": "The ssh key Fingerprint", "computed": true }, { @@ -55229,6 +55473,19 @@ "description": "SSH Public key data", "computed": true }, + { + "name": "length", + "type": "TypeInt", + "description": "The ssh key length", + "computed": true + }, + { + "name": "resource_group", + "type": "TypeString", + "description": "Resource group ID", + "cloud_data_type": "resource_group", + "optional": true + }, { "name": "resource_controller_url", "type": "TypeString", @@ -55236,10 +55493,15 @@ "computed": true }, { - "name": "crn", + "name": "resource_crn", "type": "TypeString", "description": "The crn of the resource", - "cloud_data_type": "crn", + "computed": true + }, + { + "name": "resource_group_name", + "type": "TypeString", + "description": "The resource group name in which resource is provisioned", "computed": true }, { @@ -55250,24 +55512,6 @@ "elem": { "type": "TypeString" } - }, - { - "name": "name", - "type": "TypeString", - "description": "The name of the ssh key", - "required": true - }, - { - "name": "type", - "type": "TypeString", - "description": "The ssh key type", - "computed": true - }, - { - "name": "fingerprint", - "type": "TypeString", - "description": "The ssh key Fingerprint", - "computed": true } ], "ibm_is_ssh_keys": [ @@ -55371,85 +55615,44 @@ ], "ibm_is_subnet": [ { - "name": "ipv4_cidr_block", - "type": "TypeString", + "name": "total_ipv4_address_count", + "type": "TypeInt", "computed": true }, { - "name": "network_acl", + "name": "resource_name", "type": "TypeString", + "description": "The name of the resource", "computed": true }, { - "name": "public_gateway", + "name": "crn", "type": "TypeString", + "description": "The crn of the resource", + "cloud_data_type": "crn", "computed": true }, { - "name": "status", + "name": "zone", "type": "TypeString", "computed": true }, { - "name": "vpc", + "name": "resource_controller_url", "type": "TypeString", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", "computed": true }, { - "name": "zone", + "name": "resource_group_name", "type": "TypeString", + "description": "The resource group name in which resource is provisioned", "computed": true }, { - "name": "routing_table", - "type": "TypeList", - "description": "The routing table for this subnet", - "computed": true, - "elem": { - "deleted": { - "name": "deleted", - "type": "TypeList", - "description": "If present, this property indicates the referenced resource has been deleted and providessome supplementary information.", - "computed": true, - "elem": { - "more_info": { - "name": "more_info", - "type": "TypeString", - "description": "Link to documentation about deleted resources.", - "computed": true - } - } - }, - "href": { - "name": "href", - "type": "TypeString", - "description": "The URL for this routing table.", - "computed": true - }, - "id": { - "name": "id", - "type": "TypeString", - "description": "The unique identifier for this routing table.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "The user-defined name for this routing table.", - "computed": true - }, - "resource_type": { - "name": "resource_type", - "type": "TypeString", - "description": "The resource type.", - "computed": true - } - } - }, - { - "name": "identifier", - "type": "TypeString", - "optional": true + "name": "available_ipv4_address_count", + "type": "TypeInt", + "computed": true }, { "name": "name", @@ -55458,19 +55661,30 @@ "computed": true }, { - "name": "access_tags", + "name": "tags", "type": "TypeSet", - "description": "List of access tags", + "description": "List of tags", + "cloud_data_type": "tags", "computed": true, "elem": { "type": "TypeString" } }, + { + "name": "status", + "type": "TypeString", + "computed": true + }, { "name": "vpc_name", "type": "TypeString", "computed": true }, + { + "name": "vpc", + "type": "TypeString", + "computed": true + }, { "name": "resource_group", "type": "TypeString", @@ -55478,54 +55692,38 @@ "computed": true }, { - "name": "resource_controller_url", + "name": "resource_crn", "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", + "description": "The crn of the resource", "computed": true }, { - "name": "resource_name", + "name": "identifier", "type": "TypeString", - "description": "The name of the resource", - "computed": true + "optional": true }, { - "name": "available_ipv4_address_count", - "type": "TypeInt", + "name": "ipv4_cidr_block", + "type": "TypeString", "computed": true }, { - "name": "tags", + "name": "access_tags", "type": "TypeSet", - "description": "List of tags", - "cloud_data_type": "tags", + "description": "List of access tags", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "crn", - "type": "TypeString", - "description": "The crn of the resource", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "resource_group_name", + "name": "network_acl", "type": "TypeString", - "description": "The resource group name in which resource is provisioned", - "computed": true - }, - { - "name": "total_ipv4_address_count", - "type": "TypeInt", "computed": true }, { - "name": "resource_crn", + "name": "public_gateway", "type": "TypeString", - "description": "The crn of the resource", "computed": true }, { @@ -55533,31 +55731,83 @@ "type": "TypeString", "description": "The status of the resource", "computed": true + }, + { + "name": "routing_table", + "type": "TypeList", + "description": "The routing table for this subnet", + "computed": true, + "elem": { + "deleted": { + "name": "deleted", + "type": "TypeList", + "description": "If present, this property indicates the referenced resource has been deleted and providessome supplementary information.", + "computed": true, + "elem": { + "more_info": { + "name": "more_info", + "type": "TypeString", + "description": "Link to documentation about deleted resources.", + "computed": true + } + } + }, + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this routing table.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this routing table.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The user-defined name for this routing table.", + "computed": true + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true + } + } } ], "ibm_is_subnet_reserved_ip": [ { - "name": "target_crn", + "name": "reserved_ip", "type": "TypeString", - "description": "The crn for target.", + "description": "The reserved IP identifier.", + "required": true + }, + { + "name": "address", + "type": "TypeString", + "description": "The IP address", "computed": true }, { - "name": "subnet", + "name": "created_at", "type": "TypeString", - "description": "The subnet identifier.", - "required": true + "description": "The date and time that the reserved IP was created.", + "computed": true }, { - "name": "address", + "name": "target_crn", "type": "TypeString", - "description": "The IP address", + "description": "The crn for target.", "computed": true }, { - "name": "lifecycle_state", + "name": "name", "type": "TypeString", - "description": "The lifecycle state of the reserved IP", + "description": "The user-defined or system-provided name for this reserved IP.", "computed": true }, { @@ -55579,21 +55829,21 @@ "computed": true }, { - "name": "reserved_ip", + "name": "subnet", "type": "TypeString", - "description": "The reserved IP identifier.", + "description": "The subnet identifier.", "required": true }, { - "name": "auto_delete", - "type": "TypeBool", - "description": "If set to true, this reserved IP will be automatically deleted", + "name": "lifecycle_state", + "type": "TypeString", + "description": "The lifecycle state of the reserved IP", "computed": true }, { - "name": "created_at", - "type": "TypeString", - "description": "The date and time that the reserved IP was created.", + "name": "auto_delete", + "type": "TypeBool", + "description": "If set to true, this reserved IP will be automatically deleted", "computed": true }, { @@ -55601,12 +55851,6 @@ "type": "TypeString", "description": "The URL for this reserved IP.", "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "The user-defined or system-provided name for this reserved IP.", - "computed": true } ], "ibm_is_subnet_reserved_ips": [ @@ -55834,15 +56078,43 @@ ], "ibm_is_virtual_endpoint_gateway": [ { - "name": "lifecycle_state", + "name": "resource_group", "type": "TypeString", - "description": "Endpoint gateway lifecycle state", + "description": "The resource group id", + "cloud_data_type": "resource_group", "computed": true }, { - "name": "security_groups", + "name": "created_at", + "type": "TypeString", + "description": "Endpoint gateway created date and time", + "computed": true + }, + { + "name": "target", + "type": "TypeList", + "description": "Endpoint gateway target", + "computed": true, + "elem": { + "name": { + "name": "name", + "type": "TypeString", + "description": "The target name", + "computed": true + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The target resource type", + "computed": true + } + } + }, + { + "name": "tags", "type": "TypeSet", - "description": "Endpoint gateway securitygroups list", + "description": "List of tags for VPE", + "cloud_data_type": "tags", "computed": true, "elem": { "type": "TypeString" @@ -55858,27 +56130,60 @@ } }, { - "name": "tags", + "name": "allow_dns_resolution_binding", + "type": "TypeBool", + "description": "Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true.", + "computed": true + }, + { + "name": "access_tags", "type": "TypeSet", - "description": "List of tags for VPE", - "cloud_data_type": "tags", + "description": "List of access management tags", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "name", + "name": "resource_type", "type": "TypeString", - "description": "Endpoint gateway name", - "required": true + "description": "Endpoint gateway resource type", + "computed": true }, { - "name": "created_at", + "name": "crn", "type": "TypeString", - "description": "Endpoint gateway created date and time", + "description": "The CRN for this Endpoint gateway", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "lifecycle_state", + "type": "TypeString", + "description": "Endpoint gateway lifecycle state", + "computed": true + }, + { + "name": "security_groups", + "type": "TypeSet", + "description": "Endpoint gateway securitygroups list", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "vpc", + "type": "TypeString", + "description": "The VPC id", "computed": true }, + { + "name": "name", + "type": "TypeString", + "description": "Endpoint gateway name", + "required": true + }, { "name": "health_state", "type": "TypeString", @@ -55916,61 +56221,6 @@ "computed": true } } - }, - { - "name": "crn", - "type": "TypeString", - "description": "The CRN for this Endpoint gateway", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "resource_group", - "type": "TypeString", - "description": "The resource group id", - "cloud_data_type": "resource_group", - "computed": true - }, - { - "name": "vpc", - "type": "TypeString", - "description": "The VPC id", - "computed": true - }, - { - "name": "access_tags", - "type": "TypeSet", - "description": "List of access management tags", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "resource_type", - "type": "TypeString", - "description": "Endpoint gateway resource type", - "computed": true - }, - { - "name": "target", - "type": "TypeList", - "description": "Endpoint gateway target", - "computed": true, - "elem": { - "name": { - "name": "name", - "type": "TypeString", - "description": "The target name", - "computed": true - }, - "resource_type": { - "name": "resource_type", - "type": "TypeString", - "description": "The target resource type", - "computed": true - } - } } ], "ibm_is_virtual_endpoint_gateway_ips": [ @@ -56050,13 +56300,6 @@ } ], "ibm_is_virtual_endpoint_gateways": [ - { - "name": "resource_group", - "type": "TypeString", - "description": "The unique identifier of the resource group this endpoint gateway belongs to", - "cloud_data_type": "resource_group", - "optional": true - }, { "name": "name", "type": "TypeString", @@ -56077,6 +56320,12 @@ "type": "TypeString" } }, + "allow_dns_resolution_binding": { + "name": "allow_dns_resolution_binding", + "type": "TypeBool", + "description": "Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true.", + "computed": true + }, "created_at": { "name": "created_at", "type": "TypeString", @@ -56211,105 +56460,16 @@ "computed": true } } - } - ], - "ibm_is_virtual_network_interface": [ - { - "name": "auto_delete", - "type": "TypeBool", - "description": "Indicates whether this virtual network interface will be automatically deleted when`target` is deleted.", - "computed": true - }, - { - "name": "href", - "type": "TypeString", - "description": "The URL for this virtual network interface.", - "computed": true - }, - { - "name": "primary_ip", - "type": "TypeList", - "description": "The reserved IP for this virtual network interface.May be absent when `lifecycle_state` is `pending`.", - "computed": true, - "elem": { - "address": { - "name": "address", - "type": "TypeString", - "description": "The IP address.If the address has not yet been selected, the value will be `0.0.0.0`.This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.", - "computed": true - }, - "deleted": { - "name": "deleted", - "type": "TypeList", - "description": "If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.", - "computed": true, - "elem": { - "more_info": { - "name": "more_info", - "type": "TypeString", - "description": "Link to documentation about deleted resources.", - "computed": true - } - } - }, - "href": { - "name": "href", - "type": "TypeString", - "description": "The URL for this reserved IP.", - "computed": true - }, - "id": { - "name": "id", - "type": "TypeString", - "description": "The unique identifier for this reserved IP.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "The name for this reserved IP. The name is unique across all reserved IPs in a subnet.", - "computed": true - }, - "resource_type": { - "name": "resource_type", - "type": "TypeString", - "description": "The resource type.", - "computed": true - } - } - }, - { - "name": "resource_type", - "type": "TypeString", - "description": "The resource type.", - "computed": true - }, - { - "name": "zone", - "type": "TypeList", - "description": "The zone this virtual network interface resides in.", - "computed": true, - "elem": { - "href": { - "name": "href", - "type": "TypeString", - "description": "The URL for this zone.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "The globally unique name for this zone.", - "computed": true - } - } }, { - "name": "virtual_network_interface", + "name": "resource_group", "type": "TypeString", - "description": "The network interface identifier.", - "required": true - }, + "description": "The unique identifier of the resource group this endpoint gateway belongs to", + "cloud_data_type": "resource_group", + "optional": true + } + ], + "ibm_is_virtual_network_interface": [ { "name": "resource_group", "type": "TypeList", @@ -56338,15 +56498,15 @@ } }, { - "name": "vpc", + "name": "primary_ip", "type": "TypeList", - "description": "The VPC this virtual network interface resides in.", + "description": "The reserved IP for this virtual network interface.May be absent when `lifecycle_state` is `pending`.", "computed": true, "elem": { - "crn": { - "name": "crn", + "address": { + "name": "address", "type": "TypeString", - "description": "The CRN for this VPC.", + "description": "The IP address.If the address has not yet been selected, the value will be `0.0.0.0`.This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.", "computed": true }, "deleted": { @@ -56366,19 +56526,19 @@ "href": { "name": "href", "type": "TypeString", - "description": "The URL for this VPC.", + "description": "The URL for this reserved IP.", "computed": true }, "id": { "name": "id", "type": "TypeString", - "description": "The unique identifier for this VPC.", + "description": "The unique identifier for this reserved IP.", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "The name for this VPC. The name is unique across all VPCs in the region.", + "description": "The name for this reserved IP. The name is unique across all reserved IPs in a subnet.", "computed": true }, "resource_type": { @@ -56390,27 +56550,21 @@ } }, { - "name": "lifecycle_state", - "type": "TypeString", - "description": "The lifecycle state of the virtual network interface.", - "computed": true - }, - { - "name": "name", + "name": "resource_type", "type": "TypeString", - "description": "The name for this virtual network interface. The name is unique across all virtual network interfaces in the VPC.", + "description": "The resource type.", "computed": true }, { - "name": "subnet", + "name": "security_groups", "type": "TypeList", - "description": "The associated subnet.", + "description": "The security groups for this virtual network interface.", "computed": true, "elem": { "crn": { "name": "crn", "type": "TypeString", - "description": "The CRN for this subnet.", + "description": "The security group's CRN.", "computed": true }, "deleted": { @@ -56430,25 +56584,19 @@ "href": { "name": "href", "type": "TypeString", - "description": "The URL for this subnet.", + "description": "The security group's canonical URL.", "computed": true }, "id": { "name": "id", "type": "TypeString", - "description": "The unique identifier for this subnet.", + "description": "The unique identifier for this security group.", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "The name for this subnet. The name is unique across all subnets in the VPC.", - "computed": true - }, - "resource_type": { - "name": "resource_type", - "type": "TypeString", - "description": "The resource type.", + "description": "The name for this security group. The name is unique across all security groups for the VPC.", "computed": true } } @@ -56500,28 +56648,33 @@ } }, { - "name": "created_at", + "name": "auto_delete", + "type": "TypeBool", + "description": "Indicates whether this virtual network interface will be automatically deleted when`target` is deleted.", + "computed": true + }, + { + "name": "href", "type": "TypeString", - "description": "The date and time that the virtual network interface was created.", + "description": "The URL for this virtual network interface.", "computed": true }, { - "name": "crn", + "name": "lifecycle_state", "type": "TypeString", - "description": "The CRN for this virtual network interface.", - "cloud_data_type": "crn", + "description": "The lifecycle state of the virtual network interface.", "computed": true }, { - "name": "security_groups", + "name": "subnet", "type": "TypeList", - "description": "The security groups for this virtual network interface.", + "description": "The associated subnet.", "computed": true, "elem": { "crn": { "name": "crn", "type": "TypeString", - "description": "The security group's CRN.", + "description": "The CRN for this subnet.", "computed": true }, "deleted": { @@ -56541,19 +56694,122 @@ "href": { "name": "href", "type": "TypeString", - "description": "The security group's canonical URL.", + "description": "The URL for this subnet.", "computed": true }, "id": { "name": "id", "type": "TypeString", - "description": "The unique identifier for this security group.", + "description": "The unique identifier for this subnet.", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "The name for this security group. The name is unique across all security groups for the VPC.", + "description": "The name for this subnet. The name is unique across all subnets in the VPC.", + "computed": true + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true + } + } + }, + { + "name": "vpc", + "type": "TypeList", + "description": "The VPC this virtual network interface resides in.", + "computed": true, + "elem": { + "crn": { + "name": "crn", + "type": "TypeString", + "description": "The CRN for this VPC.", + "computed": true + }, + "deleted": { + "name": "deleted", + "type": "TypeList", + "description": "If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.", + "computed": true, + "elem": { + "more_info": { + "name": "more_info", + "type": "TypeString", + "description": "Link to documentation about deleted resources.", + "computed": true + } + } + }, + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this VPC.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this VPC.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The name for this VPC. The name is unique across all VPCs in the region.", + "computed": true + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true + } + } + }, + { + "name": "virtual_network_interface", + "type": "TypeString", + "description": "The network interface identifier.", + "required": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "The date and time that the virtual network interface was created.", + "computed": true + }, + { + "name": "crn", + "type": "TypeString", + "description": "The CRN for this virtual network interface.", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "The name for this virtual network interface. The name is unique across all virtual network interfaces in the VPC.", + "computed": true + }, + { + "name": "zone", + "type": "TypeList", + "description": "The zone this virtual network interface resides in.", + "computed": true, + "elem": { + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this zone.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The globally unique name for this zone.", "computed": true } } @@ -56912,6 +57168,24 @@ } ], "ibm_is_volume": [ + { + "name": "source_snapshot", + "type": "TypeString", + "description": "Identifier of the snapshot from which this volume was cloned", + "computed": true + }, + { + "name": "bandwidth", + "type": "TypeInt", + "description": "The maximum bandwidth (in megabits per second) for the volume", + "computed": true + }, + { + "name": "iops", + "type": "TypeInt", + "description": "IOPS value for the Volume", + "computed": true + }, { "name": "access_tags", "type": "TypeSet", @@ -56922,95 +57196,81 @@ } }, { - "name": "resource_group_name", + "name": "resource_name", "type": "TypeString", - "description": "The resource group name in which resource is provisioned", + "description": "The name of the resource", "computed": true }, { - "name": "zone", + "name": "encryption_type", "type": "TypeString", - "description": "Zone name", - "optional": true, + "description": "Volume encryption type info", "computed": true }, { - "name": "capacity", - "type": "TypeInt", - "description": "Vloume capacity value", + "name": "resource_crn", + "type": "TypeString", + "description": "The crn of the resource", "computed": true }, { - "name": "crn", + "name": "tags", + "type": "TypeSet", + "description": "Tags for the volume instance", + "cloud_data_type": "tags", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "zone", "type": "TypeString", - "description": "CRN value for the volume instance", - "cloud_data_type": "crn", + "description": "Zone name", + "optional": true, "computed": true }, { - "name": "bandwidth", - "type": "TypeInt", - "description": "The maximum bandwidth (in megabits per second) for the volume", + "name": "active", + "type": "TypeBool", + "description": "Indicates whether a running virtual server instance has an attachment to this volume.", "computed": true }, { - "name": "encryption_key", + "name": "created_at", "type": "TypeString", - "description": "Volume encryption key info", + "description": "The date and time that the volume was created.", "computed": true }, { - "name": "status", + "name": "profile", "type": "TypeString", - "description": "Volume status", + "description": "Volume profile name", "computed": true }, { - "name": "tags", - "type": "TypeSet", - "description": "Tags for the volume instance", - "cloud_data_type": "tags", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "status", + "type": "TypeString", + "description": "Volume status", + "computed": true }, { - "name": "attachment_state", + "name": "resource_controller_url", "type": "TypeString", - "description": "The attachment state of the volume.", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", "computed": true }, { - "name": "iops", - "type": "TypeInt", - "description": "IOPS value for the Volume", + "name": "resource_group_name", + "type": "TypeString", + "description": "The resource group name in which resource is provisioned", "computed": true }, { - "name": "health_reasons", - "type": "TypeList", - "computed": true, - "elem": { - "code": { - "name": "code", - "type": "TypeString", - "description": "A snake case string succinctly identifying the reason for this health state.", - "computed": true - }, - "message": { - "name": "message", - "type": "TypeString", - "description": "An explanation of the reason for this health state.", - "computed": true - }, - "more_info": { - "name": "more_info", - "type": "TypeString", - "description": "Link to documentation about the reason for this health state.", - "computed": true - } - } + "name": "name", + "type": "TypeString", + "description": "Volume name", + "required": true }, { "name": "operating_system", @@ -57069,60 +57329,48 @@ } }, { - "name": "source_snapshot", + "name": "encryption_key", "type": "TypeString", - "description": "Identifier of the snapshot from which this volume was cloned", + "description": "Volume encryption key info", "computed": true }, { - "name": "profile", + "name": "health_state", "type": "TypeString", - "description": "Volume profile name", + "description": "The health of this resource.", "computed": true }, { - "name": "status_reasons", + "name": "attachment_state", + "type": "TypeString", + "description": "The attachment state of the volume.", + "computed": true + }, + { + "name": "health_reasons", "type": "TypeList", "computed": true, "elem": { "code": { "name": "code", "type": "TypeString", - "description": "A snake case string succinctly identifying the status reason", + "description": "A snake case string succinctly identifying the reason for this health state.", "computed": true }, "message": { "name": "message", "type": "TypeString", - "description": "An explanation of the status reason", + "description": "An explanation of the reason for this health state.", "computed": true }, "more_info": { "name": "more_info", "type": "TypeString", - "description": "Link to documentation about this status reason", + "description": "Link to documentation about the reason for this health state.", "computed": true } } }, - { - "name": "resource_status", - "type": "TypeString", - "description": "The status of the resource", - "computed": true - }, - { - "name": "active", - "type": "TypeBool", - "description": "Indicates whether a running virtual server instance has an attachment to this volume.", - "computed": true - }, - { - "name": "busy", - "type": "TypeBool", - "description": "Indicates whether this volume is performing an operation that must be serialized. If an operation specifies that it requires serialization, the operation will fail unless this property is `false`.", - "computed": true - }, { "name": "resource_group", "type": "TypeString", @@ -57131,45 +57379,53 @@ "computed": true }, { - "name": "resource_controller_url", - "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", - "computed": true - }, - { - "name": "resource_name", + "name": "resource_status", "type": "TypeString", - "description": "The name of the resource", + "description": "The status of the resource", "computed": true }, { - "name": "name", - "type": "TypeString", - "description": "Volume name", - "required": true - }, - { - "name": "created_at", + "name": "crn", "type": "TypeString", - "description": "The date and time that the volume was created.", + "description": "CRN value for the volume instance", + "cloud_data_type": "crn", "computed": true }, { - "name": "health_state", - "type": "TypeString", - "description": "The health of this resource.", + "name": "capacity", + "type": "TypeInt", + "description": "Vloume capacity value", "computed": true }, { - "name": "encryption_type", - "type": "TypeString", - "description": "Volume encryption type info", - "computed": true + "name": "status_reasons", + "type": "TypeList", + "computed": true, + "elem": { + "code": { + "name": "code", + "type": "TypeString", + "description": "A snake case string succinctly identifying the status reason", + "computed": true + }, + "message": { + "name": "message", + "type": "TypeString", + "description": "An explanation of the status reason", + "computed": true + }, + "more_info": { + "name": "more_info", + "type": "TypeString", + "description": "Link to documentation about this status reason", + "computed": true + } + } }, { - "name": "resource_crn", - "type": "TypeString", - "description": "The crn of the resource", + "name": "busy", + "type": "TypeBool", + "description": "Indicates whether this volume is performing an operation that must be serialized. If an operation specifies that it requires serialization, the operation will fail unless this property is `false`.", "computed": true } ], @@ -57208,36 +57464,6 @@ } ], "ibm_is_volumes": [ - { - "name": "attachment_state", - "type": "TypeString", - "description": "Attachment state of the Volume.", - "optional": true - }, - { - "name": "encryption", - "type": "TypeString", - "description": "Encryption type of Volume.", - "optional": true - }, - { - "name": "operating_system_family", - "type": "TypeString", - "description": "Operating system family of the Volume.", - "optional": true - }, - { - "name": "operating_system_architecture", - "type": "TypeString", - "description": "Operating system architecture of the Volume.", - "optional": true - }, - { - "name": "volume_name", - "type": "TypeString", - "description": "Volume name identifier.", - "optional": true - }, { "name": "zone_name", "type": "TypeString", @@ -57750,6 +57976,36 @@ } } } + }, + { + "name": "attachment_state", + "type": "TypeString", + "description": "Attachment state of the Volume.", + "optional": true + }, + { + "name": "encryption", + "type": "TypeString", + "description": "Encryption type of Volume.", + "optional": true + }, + { + "name": "operating_system_family", + "type": "TypeString", + "description": "Operating system family of the Volume.", + "optional": true + }, + { + "name": "operating_system_architecture", + "type": "TypeString", + "description": "Operating system architecture of the Volume.", + "optional": true + }, + { + "name": "volume_name", + "type": "TypeString", + "description": "Volume name identifier.", + "optional": true } ], "ibm_is_vpc": [ @@ -57765,130 +58021,237 @@ ] }, { - "name": "resource_group", - "type": "TypeString", - "cloud_data_type": "resource_group", + "name": "classic_access", + "type": "TypeBool", "computed": true }, { - "name": "status", + "name": "default_network_acl_name", "type": "TypeString", + "description": "Default Network ACL name", "computed": true }, { - "name": "security_group", + "name": "dns", "type": "TypeList", + "description": "The DNS configuration for this VPC.", "computed": true, "elem": { - "group_id": { - "name": "group_id", - "type": "TypeString", - "description": "Security group id", + "enable_hub": { + "name": "enable_hub", + "type": "TypeBool", + "description": "Indicates whether this VPC is enabled as a DNS name resolution hub.", "computed": true }, - "group_name": { - "name": "group_name", - "type": "TypeString", - "description": "Security group name", + "resolution_binding_count": { + "name": "resolution_binding_count", + "type": "TypeInt", + "description": "The number of DNS resolution bindings for this VPC.", "computed": true }, - "rules": { - "name": "rules", + "resolver": { + "name": "resolver", "type": "TypeList", - "description": "Security Rules", + "description": "The DNS resolver configuration for the VPC.", "computed": true, "elem": { - "code": { - "name": "code", - "type": "TypeInt", - "computed": true - }, - "direction": { - "name": "direction", - "type": "TypeString", - "description": "Direction of traffic to enforce, either inbound or outbound", - "computed": true - }, - "ip_version": { - "name": "ip_version", - "type": "TypeString", - "description": "IP version: ipv4", - "computed": true - }, - "port_max": { - "name": "port_max", - "type": "TypeInt", - "computed": true - }, - "port_min": { - "name": "port_min", - "type": "TypeInt", - "computed": true - }, - "protocol": { - "name": "protocol", + "configuration": { + "name": "configuration", "type": "TypeString", + "description": "The configuration of the system DNS resolver for this VPC.- `custom_resolver`: A custom DNS resolver is configured for this VPC.- `private_resolver`: A private DNS resolver is configured for this VPC. Applicable when the VPC has either or both of the following: - at least one endpoint gateway residing in it - a [DNS Services](https://cloud.ibm.com/docs/dns-svcs) private zone configured for it- `default`: The provider default DNS resolvers are configured for this VPC. This system DNS resolver configuration is used when the VPC has: - no custom DNS resolver configured for it, and - no endpoint gateways residing in it, and - no [DNS Services](https://cloud.ibm.com/docs/dns-svcs) private zone configured for it.", "computed": true }, - "remote": { - "name": "remote", - "type": "TypeString", - "description": "Security group id: an IP address, a CIDR block, or a single security group identifier", - "computed": true + "manual_servers": { + "name": "manual_servers", + "type": "TypeList", + "description": "The manually specified DNS servers for this VPC.", + "computed": true, + "elem": { + "address": { + "name": "address", + "type": "TypeString", + "description": "The IP address.This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.", + "computed": true + }, + "zone_affinity": { + "name": "zone_affinity", + "type": "TypeString", + "description": "The name of the zone. If present, DHCP configuration for this zone will have this DNS server listed first.", + "computed": true + } + } }, - "rule_id": { - "name": "rule_id", - "type": "TypeString", - "description": "Rule ID", - "computed": true + "servers": { + "name": "servers", + "type": "TypeList", + "description": "The DNS servers for this VPC. The servers are populated:- by the system when `dns.resolver.type` is `system`- using the DNS servers in `dns.resolver.vpc` when `dns.resolver.type` is `delegated`- using `dns.resolver.manual_servers` when the `dns.resolver.type` is `manual`.", + "computed": true, + "elem": { + "address": { + "name": "address", + "type": "TypeString", + "description": "The IP address.This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.", + "computed": true + }, + "zone_affinity": { + "name": "zone_affinity", + "type": "TypeString", + "description": "Zone name, if present, DHCP configuration for this zone will have this DNS server listed first.", + "computed": true + } + } }, "type": { "name": "type", - "type": "TypeInt", + "type": "TypeString", + "description": "The type of the DNS resolver used for the VPC.- `delegated`: DNS server addresses are provided by the DNS resolver of the VPC specified in `dns.resolver.vpc`.- `manual`: DNS server addresses are specified in `dns.resolver.manual_servers`.- `system`: DNS server addresses are provided by the system.", "computed": true + }, + "vpc": { + "name": "vpc", + "type": "TypeList", + "description": "The VPC whose DNS resolver provides the DNS server addresses for this VPC.The VPC may be remote and therefore may not be directly retrievable.", + "computed": true, + "elem": { + "crn": { + "name": "crn", + "type": "TypeString", + "description": "The CRN for this VPC.", + "computed": true + }, + "deleted": { + "name": "deleted", + "type": "TypeList", + "description": "If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.", + "computed": true, + "elem": { + "more_info": { + "name": "more_info", + "type": "TypeString", + "description": "Link to documentation about deleted resources.", + "computed": true + } + } + }, + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this VPC.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this VPC.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The name for this VPC. The name is unique across all VPCs in the region.", + "computed": true + }, + "remote": { + "name": "remote", + "type": "TypeList", + "description": "If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable.", + "computed": true, + "elem": { + "account": { + "name": "account", + "type": "TypeList", + "description": "If present, this property indicates that the referenced resource is remote to thisaccount, and identifies the owning account.", + "computed": true, + "elem": { + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this account.", + "computed": true + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true + } + } + }, + "region": { + "name": "region", + "type": "TypeString", + "description": "Region name. If present, this property indicates that the referenced resource is remote to this region, and identifies the native region.", + "computed": true + } + } + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true + } + } } } } } }, { - "name": "default_network_acl", + "name": "health_state", "type": "TypeString", + "description": "The health of this resource.- `ok`: No abnormal behavior detected- `degraded`: Experiencing compromised performance, capacity, or connectivity- `faulted`: Completely unreachable, inoperative, or otherwise entirely incapacitated- `inapplicable`: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of `failed` or `deleting` will have a health state of `inapplicable`. A `pending` resource may also have this state.", "computed": true }, { - "name": "default_security_group_crn", + "name": "default_security_group_name", "type": "TypeString", - "description": "Default security group CRN", + "description": "Default security group name", "computed": true }, { - "name": "default_network_acl_crn", + "name": "default_security_group_crn", "type": "TypeString", - "description": "Default Network ACL CRN", + "description": "Default security group CRN", "computed": true }, { - "name": "resource_group_name", + "name": "access_tags", + "type": "TypeSet", + "description": "List of access tags", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "resource_status", "type": "TypeString", - "description": "The resource group name in which resource is provisioned", + "description": "The status of the resource", "computed": true }, { - "name": "cse_source_addresses", + "name": "health_reasons", "type": "TypeList", + "description": "The reasons for the current `health_state` (if any).The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered.", "computed": true, "elem": { - "address": { - "name": "address", + "code": { + "name": "code", "type": "TypeString", - "description": "Cloud service endpoint IP Address", + "description": "A snake case string succinctly identifying the reason for this health state.", "computed": true }, - "zone_name": { - "name": "zone_name", + "message": { + "name": "message", "type": "TypeString", - "description": "Location info of CSE Address", + "description": "An explanation of the reason for this health state.", + "computed": true + }, + "more_info": { + "name": "more_info", + "type": "TypeString", + "description": "Link to documentation about the reason for this health state.", "computed": true } } @@ -57937,39 +58300,53 @@ } }, { - "name": "classic_access", - "type": "TypeBool", + "name": "status", + "type": "TypeString", "computed": true }, { - "name": "crn", + "name": "default_security_group", "type": "TypeString", - "description": "The crn of the resource", - "cloud_data_type": "crn", + "description": "Security group associated with VPC", "computed": true }, { - "name": "resource_status", + "name": "tags", + "type": "TypeSet", + "cloud_data_type": "tags", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "name", "type": "TypeString", - "description": "The status of the resource", + "optional": true + }, + { + "name": "default_network_acl_crn", + "type": "TypeString", + "description": "Default Network ACL CRN", "computed": true }, { - "name": "default_security_group_name", + "name": "resource_controller_url", "type": "TypeString", - "description": "Default security group name", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", "computed": true }, { - "name": "default_routing_table_name", + "name": "resource_group", "type": "TypeString", - "description": "Default routing table name", + "cloud_data_type": "resource_group", "computed": true }, { - "name": "default_security_group", + "name": "crn", "type": "TypeString", - "description": "Security group associated with VPC", + "description": "The crn of the resource", + "cloud_data_type": "crn", "computed": true }, { @@ -57985,58 +58362,135 @@ "computed": true }, { - "name": "default_routing_table", + "name": "cse_source_addresses", + "type": "TypeList", + "computed": true, + "elem": { + "address": { + "name": "address", + "type": "TypeString", + "description": "Cloud service endpoint IP Address", + "computed": true + }, + "zone_name": { + "name": "zone_name", + "type": "TypeString", + "description": "Location info of CSE Address", + "computed": true + } + } + }, + { + "name": "default_network_acl", "type": "TypeString", - "description": "Default routing table associated with VPC", "computed": true }, { - "name": "name", + "name": "identifier", "type": "TypeString", "optional": true }, { - "name": "default_network_acl_name", + "name": "default_routing_table_name", "type": "TypeString", - "description": "Default Network ACL name", + "description": "Default routing table name", "computed": true }, { - "name": "resource_controller_url", + "name": "default_routing_table", "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", + "description": "Default routing table associated with VPC", "computed": true }, { - "name": "identifier", + "name": "resource_group_name", "type": "TypeString", - "optional": true - }, - { - "name": "tags", - "type": "TypeSet", - "cloud_data_type": "tags", - "computed": true, - "elem": { - "type": "TypeString" - } + "description": "The resource group name in which resource is provisioned", + "computed": true }, { - "name": "access_tags", - "type": "TypeSet", - "description": "List of access tags", + "name": "security_group", + "type": "TypeList", "computed": true, "elem": { - "type": "TypeString" + "group_id": { + "name": "group_id", + "type": "TypeString", + "description": "Security group id", + "computed": true + }, + "group_name": { + "name": "group_name", + "type": "TypeString", + "description": "Security group name", + "computed": true + }, + "rules": { + "name": "rules", + "type": "TypeList", + "description": "Security Rules", + "computed": true, + "elem": { + "code": { + "name": "code", + "type": "TypeInt", + "computed": true + }, + "direction": { + "name": "direction", + "type": "TypeString", + "description": "Direction of traffic to enforce, either inbound or outbound", + "computed": true + }, + "ip_version": { + "name": "ip_version", + "type": "TypeString", + "description": "IP version: ipv4", + "computed": true + }, + "port_max": { + "name": "port_max", + "type": "TypeInt", + "computed": true + }, + "port_min": { + "name": "port_min", + "type": "TypeInt", + "computed": true + }, + "protocol": { + "name": "protocol", + "type": "TypeString", + "computed": true + }, + "remote": { + "name": "remote", + "type": "TypeString", + "description": "Security group id: an IP address, a CIDR block, or a single security group identifier", + "computed": true + }, + "rule_id": { + "name": "rule_id", + "type": "TypeString", + "description": "Rule ID", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeInt", + "computed": true + } + } + } } } ], "ibm_is_vpc_address_prefix": [ { - "name": "vpc_name", + "name": "cidr", "type": "TypeString", - "description": "The VPC name.", - "optional": true + "description": "The CIDR block for this prefix.", + "computed": true }, { "name": "created_at", @@ -58044,18 +58498,6 @@ "description": "The date and time that the prefix was created.", "computed": true }, - { - "name": "href", - "type": "TypeString", - "description": "The URL for this address prefix.", - "computed": true - }, - { - "name": "is_default", - "type": "TypeBool", - "description": "Indicates whether this is the default prefix for this zone in this VPC. If a default prefix was automatically created when the VPC was created, the prefix is automatically named using a hyphenated list of randomly-selected words, but may be updated with a user-specified name.", - "computed": true - }, { "name": "name", "type": "TypeString", @@ -58088,6 +58530,12 @@ "description": "The VPC identifier.", "optional": true }, + { + "name": "vpc_name", + "type": "TypeString", + "description": "The VPC name.", + "optional": true + }, { "name": "address_prefix", "type": "TypeString", @@ -58101,15 +58549,21 @@ "optional": true }, { - "name": "cidr", + "name": "has_subnets", + "type": "TypeBool", + "description": "Indicates whether subnets exist with addresses from this prefix.", + "computed": true + }, + { + "name": "href", "type": "TypeString", - "description": "The CIDR block for this prefix.", + "description": "The URL for this address prefix.", "computed": true }, { - "name": "has_subnets", + "name": "is_default", "type": "TypeBool", - "description": "Indicates whether subnets exist with addresses from this prefix.", + "description": "Indicates whether this is the default prefix for this zone in this VPC. If a default prefix was automatically created when the VPC was created, the prefix is automatically named using a hyphenated list of randomly-selected words, but may be updated with a user-specified name.", "computed": true } ], @@ -58198,12 +58652,48 @@ } ], "ibm_is_vpc_default_routing_table": [ + { + "name": "vpc", + "type": "TypeString", + "description": "VPC identifier", + "required": true + }, + { + "name": "lifecycle_state", + "type": "TypeString", + "description": "Default Routing table Lifecycle State", + "computed": true + }, + { + "name": "route_direct_link_ingress", + "type": "TypeBool", + "description": "If set to true, this routing table will be used to route traffic that originates from Direct Link to this VPC.", + "computed": true + }, + { + "name": "route_vpc_zone_ingress", + "type": "TypeBool", + "description": "If set to true, this routing table will be used to route traffic that originates from subnets in other zones in this VPC.", + "computed": true + }, { "name": "created_at", "type": "TypeString", "description": "Default Routing table Created At", "computed": true }, + { + "name": "href", + "type": "TypeString", + "description": "Default Routing table Href", + "computed": true + }, + { + "name": "resource_type", + "type": "TypeString", + "description": "Default Routing table Resource Type", + "computed": true + }, { "name": "route_internet_ingress", "type": "TypeBool", @@ -58230,16 +58720,23 @@ } }, { - "name": "route_transit_gateway_ingress", - "type": "TypeBool", - "description": "If set to true, this routing table will be used to route traffic that originates from Transit Gateway to this VPC.", - "computed": true - }, - { - "name": "vpc", - "type": "TypeString", - "description": "VPC identifier", - "required": true + "name": "subnets", + "type": "TypeList", + "computed": true, + "elem": { + "id": { + "name": "id", + "type": "TypeString", + "description": "Subnet ID", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Subnet name", + "computed": true + } + } }, { "name": "default_routing_table", @@ -58254,9 +58751,9 @@ "computed": true }, { - "name": "route_direct_link_ingress", + "name": "route_transit_gateway_ingress", "type": "TypeBool", - "description": "If set to true, this routing table will be used to route traffic that originates from Direct Link to this VPC.", + "description": "If set to true, this routing table will be used to route traffic that originates from Transit Gateway to this VPC.", "computed": true }, { @@ -58264,98 +58761,319 @@ "type": "TypeBool", "description": "Indicates whether this is the default routing table for this VPC", "computed": true + } + ], + "ibm_is_vpc_dns_resolution_binding": [ + { + "name": "created_at", + "type": "TypeString", + "description": "The date and time that the DNS resolution binding was created.", + "computed": true }, { - "name": "subnets", + "name": "href", + "type": "TypeString", + "description": "The URL for this DNS resolution binding.", + "computed": true + }, + { + "name": "lifecycle_state", + "type": "TypeString", + "description": "The lifecycle state of the DNS resolution binding.", + "computed": true + }, + { + "name": "vpc", "type": "TypeList", + "description": "The VPC bound to for DNS resolution.The VPC may be remote and therefore may not be directly retrievable.", "computed": true, "elem": { + "crn": { + "name": "crn", + "type": "TypeString", + "description": "The CRN for this VPC.", + "computed": true + }, + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this VPC.", + "computed": true + }, "id": { "name": "id", "type": "TypeString", - "description": "Subnet ID", + "description": "The unique identifier for this VPC.", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "Subnet name", + "description": "The name for this VPC. The name is unique across all VPCs in the region.", + "computed": true + }, + "remote": { + "name": "remote", + "type": "TypeList", + "description": "If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable.", + "computed": true, + "elem": { + "account": { + "name": "account", + "type": "TypeList", + "description": "If present, this property indicates that the referenced resource is remote to thisaccount, and identifies the owning account.", + "computed": true, + "elem": { + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this account.", + "computed": true + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true + } + } + }, + "region": { + "name": "region", + "type": "TypeList", + "description": "If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region.", + "computed": true, + "elem": { + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this region.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The globally unique name for this region.", + "computed": true + } + } + } + } + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", "computed": true } } }, { - "name": "href", + "name": "vpc_id", "type": "TypeString", - "description": "Default Routing table Href", - "computed": true + "description": "The VPC identifier.", + "required": true }, { - "name": "resource_type", - "type": "TypeString", - "description": "Default Routing table Resource Type", - "computed": true + "name": "endpoint_gateways", + "type": "TypeList", + "description": "The endpoint gateways in the bound to VPC that are allowed to participate in this DNS resolution binding.The endpoint gateways may be remote and therefore may not be directly retrievable.", + "computed": true, + "elem": { + "crn": { + "name": "crn", + "type": "TypeString", + "description": "The CRN for this endpoint gateway.", + "computed": true + }, + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this endpoint gateway.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this endpoint gateway.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The name for this endpoint gateway. The name is unique across all endpoint gateways in the VPC.", + "computed": true + }, + "remote": { + "name": "remote", + "type": "TypeList", + "description": "If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable.", + "computed": true, + "elem": { + "account": { + "name": "account", + "type": "TypeList", + "description": "If present, this property indicates that the referenced resource is remote to thisaccount, and identifies the owning account.", + "computed": true, + "elem": { + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this account.", + "computed": true + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true + } + } + }, + "region": { + "name": "region", + "type": "TypeList", + "description": "If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region.", + "computed": true, + "elem": { + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this region.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The globally unique name for this region.", + "computed": true + } + } + } + } + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true + } + } }, { - "name": "lifecycle_state", + "name": "name", "type": "TypeString", - "description": "Default Routing table Lifecycle State", + "description": "The name for this DNS resolution binding. The name is unique across all DNS resolution bindings for the VPC.", "computed": true }, { - "name": "route_vpc_zone_ingress", - "type": "TypeBool", - "description": "If set to true, this routing table will be used to route traffic that originates from subnets in other zones in this VPC.", - "computed": true - } - ], - "ibm_is_vpc_routing_table": [ - { - "name": "href", + "name": "resource_type", "type": "TypeString", - "description": "The URL for this routing table.", - "computed": true - }, - { - "name": "is_default", - "type": "TypeBool", - "description": "Indicates whether this is the default routing table for this VPC.", + "description": "The resource type.", "computed": true }, { - "name": "name", - "type": "TypeString", - "description": "The user-defined name for this routing table.", - "optional": true - }, - { - "name": "created_at", + "name": "identifier", "type": "TypeString", - "description": "The date and time that this routing table was created.", - "computed": true - }, + "description": "The DNS resolution binding identifier.", + "required": true + } + ], + "ibm_is_vpc_dns_resolution_bindings": [ { - "name": "subnets", + "name": "dns_resolution_bindings", "type": "TypeList", - "description": "The subnets to which this routing table is attached.", + "description": "Collection of VPC Dns Resolution Bindings.", "computed": true, "elem": { - "crn": { - "name": "crn", + "created_at": { + "name": "created_at", "type": "TypeString", - "description": "The CRN for this subnet.", + "description": "The date and time that the DNS resolution binding was created.", "computed": true }, - "deleted": { - "name": "deleted", + "endpoint_gateways": { + "name": "endpoint_gateways", "type": "TypeList", - "description": "If present, this property indicates the referenced resource has been deleted and providessome supplementary information.", + "description": "The endpoint gateways in the bound to VPC that are allowed to participate in this DNS resolution binding.The endpoint gateways may be remote and therefore may not be directly retrievable.", "computed": true, "elem": { - "more_info": { - "name": "more_info", + "crn": { + "name": "crn", "type": "TypeString", - "description": "Link to documentation about deleted resources.", + "description": "The CRN for this endpoint gateway.", + "computed": true + }, + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this endpoint gateway.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this endpoint gateway.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The name for this endpoint gateway. The name is unique across all endpoint gateways in the VPC.", + "computed": true + }, + "remote": { + "name": "remote", + "type": "TypeList", + "description": "If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable.", + "computed": true, + "elem": { + "account": { + "name": "account", + "type": "TypeList", + "description": "If present, this property indicates that the referenced resource is remote to thisaccount, and identifies the owning account.", + "computed": true, + "elem": { + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this account.", + "computed": true + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true + } + } + }, + "region": { + "name": "region", + "type": "TypeList", + "description": "If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region.", + "computed": true, + "elem": { + "id": { + "name": "id", + "type": "TypeString", + "description": "The URL for this region.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The globally unique name for this region.", + "computed": true + } + } + } + } + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", "computed": true } } @@ -58363,23 +59081,135 @@ "href": { "name": "href", "type": "TypeString", - "description": "The URL for this subnet.", + "description": "The URL for this DNS resolution binding.", "computed": true }, "id": { "name": "id", "type": "TypeString", - "description": "The unique identifier for this subnet.", + "description": "The DNS resolution binding identifier.", + "computed": true + }, + "lifecycle_state": { + "name": "lifecycle_state", + "type": "TypeString", + "description": "The lifecycle state of the DNS resolution binding.", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "The user-defined name for this subnet.", + "description": "The name for this DNS resolution binding. The name is unique across all DNS resolution bindings for the VPC.", + "computed": true + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", "computed": true + }, + "vpc": { + "name": "vpc", + "type": "TypeList", + "description": "The VPC bound to for DNS resolution.The VPC may be remote and therefore may not be directly retrievable.", + "computed": true, + "elem": { + "crn": { + "name": "crn", + "type": "TypeString", + "description": "The CRN for this VPC.", + "computed": true + }, + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this VPC.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this VPC.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The name for this VPC. The name is unique across all VPCs in the region.", + "computed": true + }, + "remote": { + "name": "remote", + "type": "TypeList", + "description": "If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable.", + "computed": true, + "elem": { + "account": { + "name": "account", + "type": "TypeList", + "description": "If present, this property indicates that the referenced resource is remote to thisaccount, and identifies the owning account.", + "computed": true, + "elem": { + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this account.", + "computed": true + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true + } + } + }, + "region": { + "name": "region", + "type": "TypeList", + "description": "If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region.", + "computed": true, + "elem": { + "id": { + "name": "id", + "type": "TypeString", + "description": "The URL for this region.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The globally unique name for this region.", + "computed": true + } + } + } + } + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true + } + } } } }, + { + "name": "vpc_id", + "type": "TypeString", + "description": "The VPC identifier.", + "required": true + } + ], + "ibm_is_vpc_routing_table": [ + { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true + }, { "name": "accept_routes_from", "type": "TypeList", @@ -58394,42 +59224,6 @@ } } }, - { - "name": "resource_type", - "type": "TypeString", - "description": "The resource type.", - "computed": true - }, - { - "name": "route_direct_link_ingress", - "type": "TypeBool", - "description": "Indicates whether this routing table is used to route traffic that originates from[Direct Link](https://cloud.ibm.com/docs/dl/) to this VPC.Incoming traffic will be routed according to the routing table with one exception: routes with an `action` of `deliver` are treated as `drop` unless the `next_hop` is an IP address within the VPC's address prefix ranges. Therefore, if an incoming packet matches a route with a `next_hop` of an internet-bound IP address or a VPN gateway connection, the packet will be dropped.", - "computed": true - }, - { - "name": "route_internet_ingress", - "type": "TypeBool", - "description": "Indicates whether this routing table is used to route traffic that originates from the internet.Incoming traffic will be routed according to the routing table with two exceptions:- Traffic destined for IP addresses associated with public gateways will not be subject to routes in this routing table.- Routes with an action of deliver are treated as drop unless the `next_hop` is an IP address bound to a network interface on a subnet in the route's `zone`. Therefore, if an incoming packet matches a route with a `next_hop` of an internet-bound IP address or a VPN gateway connection, the packet will be dropped.", - "computed": true - }, - { - "name": "route_transit_gateway_ingress", - "type": "TypeBool", - "description": "Indicates whether this routing table is used to route traffic that originates from from [Transit Gateway](https://cloud.ibm.com/cloud/transit-gateway/) to this VPC.Incoming traffic will be routed according to the routing table with one exception: routes with an `action` of `deliver` are treated as `drop` unless the `next_hop` is an IP address within the VPC's address prefix ranges. Therefore, if an incoming packet matches a route with a `next_hop` of an internet-bound IP address or a VPN gateway connection, the packet will be dropped.", - "computed": true - }, - { - "name": "routing_table", - "type": "TypeString", - "description": "The routing table identifier.", - "optional": true - }, - { - "name": "lifecycle_state", - "type": "TypeString", - "description": "The lifecycle state of the routing table.", - "computed": true - }, { "name": "routes", "type": "TypeList", @@ -58470,68 +59264,130 @@ } } }, + { + "name": "subnets", + "type": "TypeList", + "description": "The subnets to which this routing table is attached.", + "computed": true, + "elem": { + "crn": { + "name": "crn", + "type": "TypeString", + "description": "The CRN for this subnet.", + "computed": true + }, + "deleted": { + "name": "deleted", + "type": "TypeList", + "description": "If present, this property indicates the referenced resource has been deleted and providessome supplementary information.", + "computed": true, + "elem": { + "more_info": { + "name": "more_info", + "type": "TypeString", + "description": "Link to documentation about deleted resources.", + "computed": true + } + } + }, + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this subnet.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this subnet.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The user-defined name for this subnet.", + "computed": true + } + } + }, { "name": "vpc", "type": "TypeString", "description": "The VPC identifier.", "required": true }, + { + "name": "href", + "type": "TypeString", + "description": "The URL for this routing table.", + "computed": true + }, + { + "name": "route_direct_link_ingress", + "type": "TypeBool", + "description": "Indicates whether this routing table is used to route traffic that originates from[Direct Link](https://cloud.ibm.com/docs/dl/) to this VPC.Incoming traffic will be routed according to the routing table with one exception: routes with an `action` of `deliver` are treated as `drop` unless the `next_hop` is an IP address within the VPC's address prefix ranges. Therefore, if an incoming packet matches a route with a `next_hop` of an internet-bound IP address or a VPN gateway connection, the packet will be dropped.", + "computed": true + }, + { + "name": "route_internet_ingress", + "type": "TypeBool", + "description": "Indicates whether this routing table is used to route traffic that originates from the internet.Incoming traffic will be routed according to the routing table with two exceptions:- Traffic destined for IP addresses associated with public gateways will not be subject to routes in this routing table.- Routes with an action of deliver are treated as drop unless the `next_hop` is an IP address bound to a network interface on a subnet in the route's `zone`. Therefore, if an incoming packet matches a route with a `next_hop` of an internet-bound IP address or a VPN gateway connection, the packet will be dropped.", + "computed": true + }, + { + "name": "route_transit_gateway_ingress", + "type": "TypeBool", + "description": "Indicates whether this routing table is used to route traffic that originates from from [Transit Gateway](https://cloud.ibm.com/cloud/transit-gateway/) to this VPC.Incoming traffic will be routed according to the routing table with one exception: routes with an `action` of `deliver` are treated as `drop` unless the `next_hop` is an IP address within the VPC's address prefix ranges. Therefore, if an incoming packet matches a route with a `next_hop` of an internet-bound IP address or a VPN gateway connection, the packet will be dropped.", + "computed": true + }, { "name": "route_vpc_zone_ingress", "type": "TypeBool", "description": "Indicates whether this routing table is used to route traffic that originates from subnets in other zones in this VPC.Incoming traffic will be routed according to the routing table with one exception: routes with an `action` of `deliver` are treated as `drop` unless the `next_hop` is an IP address within the VPC's address prefix ranges. Therefore, if an incoming packet matches a route with a `next_hop` of an internet-bound IP address or a VPN gateway connection, the packet will be dropped.", "computed": true - } - ], - "ibm_is_vpc_routing_table_route": [ + }, { - "name": "vpc", + "name": "name", "type": "TypeString", - "description": "The VPC identifier.", - "required": true + "description": "The user-defined name for this routing table.", + "optional": true }, { - "name": "name", + "name": "routing_table", "type": "TypeString", - "description": "The user-defined name for this route.", + "description": "The routing table identifier.", "optional": true }, { - "name": "action", + "name": "created_at", "type": "TypeString", - "description": "The action to perform with a packet matching the route:- `delegate`: delegate to the system's built-in routes- `delegate_vpc`: delegate to the system's built-in routes, ignoring Internet-bound routes- `deliver`: deliver the packet to the specified `next_hop`- `drop`: drop the packet.", + "description": "The date and time that this routing table was created.", "computed": true }, { - "name": "zone", - "type": "TypeList", - "description": "The zone the route applies to. (Traffic from subnets in this zone will besubject to this route.).", - "computed": true, - "elem": { - "href": { - "name": "href", - "type": "TypeString", - "description": "The URL for this zone.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "The globally unique name for this zone.", - "computed": true - } - } + "name": "is_default", + "type": "TypeBool", + "description": "Indicates whether this is the default routing table for this VPC.", + "computed": true }, { - "name": "route_id", + "name": "lifecycle_state", "type": "TypeString", - "description": "The VPC routing table route identifier.", + "description": "The lifecycle state of the routing table.", + "computed": true + } + ], + "ibm_is_vpc_routing_table_route": [ + { + "name": "name", + "type": "TypeString", + "description": "The user-defined name for this route.", "optional": true }, { - "name": "destination", + "name": "lifecycle_state", "type": "TypeString", - "description": "The destination of the route.", + "description": "The lifecycle state of the route.", "computed": true }, { @@ -58541,15 +59397,9 @@ "required": true }, { - "name": "origin", + "name": "action", "type": "TypeString", - "description": "The origin of this route:- `service`: route was directly created by a service- `user`: route was directly created by a userThe enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the route on which the unexpected property value was encountered.", - "computed": true - }, - { - "name": "priority", - "type": "TypeInt", - "description": "The route's priority. Smaller values have higher priority. If a routing table contains routes with the same destination, the route with the highest priority (smallest value) is selected.", + "description": "The action to perform with a packet matching the route:- `delegate`: delegate to the system's built-in routes- `delegate_vpc`: delegate to the system's built-in routes, ignoring Internet-bound routes- `deliver`: deliver the packet to the specified `next_hop`- `drop`: drop the packet.", "computed": true }, { @@ -58559,15 +59409,15 @@ "computed": true }, { - "name": "creator", + "name": "next_hop", "type": "TypeList", - "description": "If present, the resource that created the route. Routes with this property present cannot bedirectly deleted. All routes with an `origin` of `learned` or `service` will have thisproperty set, and future `origin` values may also have this property set.", + "description": "If `action` is `deliver`, the next hop that packets will be delivered to. Forother `action` values, its `address` will be `0.0.0.0`.", "computed": true, "elem": { - "crn": { - "name": "crn", + "address": { + "name": "address", "type": "TypeString", - "description": "The VPN gateway's CRN.", + "description": "The IP address.This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.", "computed": true }, "deleted": { @@ -58587,19 +59437,19 @@ "href": { "name": "href", "type": "TypeString", - "description": "The VPN gateway's canonical URL.", + "description": "The VPN connection's canonical URL.", "computed": true }, "id": { "name": "id", "type": "TypeString", - "description": "The unique identifier for this VPN gateway.", + "description": "The unique identifier for this VPN gateway connection.", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "The user-defined name for this VPN gateway.", + "description": "The user-defined name for this VPN connection.", "computed": true }, "resource_type": { @@ -58611,27 +59461,59 @@ } }, { - "name": "href", + "name": "origin", "type": "TypeString", - "description": "The URL for this route.", + "description": "The origin of this route:- `service`: route was directly created by a service- `user`: route was directly created by a userThe enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the route on which the unexpected property value was encountered.", "computed": true }, { - "name": "lifecycle_state", - "type": "TypeString", - "description": "The lifecycle state of the route.", + "name": "zone", + "type": "TypeList", + "description": "The zone the route applies to. (Traffic from subnets in this zone will besubject to this route.).", + "computed": true, + "elem": { + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this zone.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The globally unique name for this zone.", + "computed": true + } + } + }, + { + "name": "priority", + "type": "TypeInt", + "description": "The route's priority. Smaller values have higher priority. If a routing table contains routes with the same destination, the route with the highest priority (smallest value) is selected.", "computed": true }, { - "name": "next_hop", + "name": "vpc", + "type": "TypeString", + "description": "The VPC identifier.", + "required": true + }, + { + "name": "route_id", + "type": "TypeString", + "description": "The VPC routing table route identifier.", + "optional": true + }, + { + "name": "creator", "type": "TypeList", - "description": "If `action` is `deliver`, the next hop that packets will be delivered to. Forother `action` values, its `address` will be `0.0.0.0`.", + "description": "If present, the resource that created the route. Routes with this property present cannot bedirectly deleted. All routes with an `origin` of `learned` or `service` will have thisproperty set, and future `origin` values may also have this property set.", "computed": true, "elem": { - "address": { - "name": "address", + "crn": { + "name": "crn", "type": "TypeString", - "description": "The IP address.This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.", + "description": "The VPN gateway's CRN.", "computed": true }, "deleted": { @@ -58651,19 +59533,19 @@ "href": { "name": "href", "type": "TypeString", - "description": "The VPN connection's canonical URL.", + "description": "The VPN gateway's canonical URL.", "computed": true }, "id": { "name": "id", "type": "TypeString", - "description": "The unique identifier for this VPN gateway connection.", + "description": "The unique identifier for this VPN gateway.", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "The user-defined name for this VPN connection.", + "description": "The user-defined name for this VPN gateway.", "computed": true }, "resource_type": { @@ -58673,6 +59555,18 @@ "computed": true } } + }, + { + "name": "destination", + "type": "TypeString", + "description": "The destination of the route.", + "computed": true + }, + { + "name": "href", + "type": "TypeString", + "description": "The URL for this route.", + "computed": true } ], "ibm_is_vpc_routing_table_routes": [ @@ -58816,18 +59710,6 @@ } ], "ibm_is_vpc_routing_tables": [ - { - "name": "vpc", - "type": "TypeString", - "description": "VPC identifier", - "required": true - }, - { - "name": "is_default", - "type": "TypeBool", - "description": "Filters the collection to routing tables with the specified is_default value", - "optional": true - }, { "name": "routing_tables", "type": "TypeList", @@ -58953,16 +59835,21 @@ } } } - } - ], - "ibm_is_vpcs": [ + }, { - "name": "resource_group", + "name": "vpc", "type": "TypeString", - "description": "The unique identifier of the resource group this vpc belongs to", - "cloud_data_type": "resource_group", - "optional": true + "description": "VPC identifier", + "required": true }, + { + "name": "is_default", + "type": "TypeBool", + "description": "Filters the collection to routing tables with the specified is_default value", + "optional": true + } + ], + "ibm_is_vpcs": [ { "name": "classic_access", "type": "TypeBool", @@ -59061,95 +59948,293 @@ "description": "Default security group name", "computed": true }, - "id": { - "name": "id", - "type": "TypeString", - "description": "VPC id", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "VPC name", - "computed": true - }, - "resource_controller_url": { - "name": "resource_controller_url", - "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", - "computed": true - }, - "resource_crn": { - "name": "resource_crn", - "type": "TypeString", - "description": "The crn of the resource", - "computed": true - }, - "resource_group": { - "name": "resource_group", - "type": "TypeString", - "computed": true - }, - "resource_group_name": { - "name": "resource_group_name", - "type": "TypeString", - "description": "The resource group name in which resource is provisioned", - "computed": true - }, - "resource_name": { - "name": "resource_name", - "type": "TypeString", - "description": "The name of the resource", - "computed": true - }, - "resource_status": { - "name": "resource_status", - "type": "TypeString", - "description": "The status of the resource", - "computed": true - }, - "security_group": { - "name": "security_group", + "dns": { + "name": "dns", "type": "TypeList", + "description": "The DNS configuration for this VPC.", "computed": true, "elem": { - "group_id": { - "name": "group_id", - "type": "TypeString", - "description": "Security group id", - "immutable": true, + "enable_hub": { + "name": "enable_hub", + "type": "TypeBool", + "description": "Indicates whether this VPC is enabled as a DNS name resolution hub.", "computed": true }, - "group_name": { - "name": "group_name", - "type": "TypeString", - "description": "Security group name", + "resolution_binding_count": { + "name": "resolution_binding_count", + "type": "TypeInt", + "description": "The number of DNS resolution bindings for this VPC.", "computed": true }, - "rules": { - "name": "rules", + "resolver": { + "name": "resolver", "type": "TypeList", - "description": "Security Rules", + "description": "The DNS resolver configuration for the VPC.", "computed": true, "elem": { - "code": { - "name": "code", - "type": "TypeInt", - "computed": true - }, - "direction": { - "name": "direction", + "configuration": { + "name": "configuration", "type": "TypeString", - "description": "Direction of traffic to enforce, either inbound or outbound", + "description": "The configuration of the system DNS resolver for this VPC.- `custom_resolver`: A custom DNS resolver is configured for this VPC.- `private_resolver`: A private DNS resolver is configured for this VPC. Applicable when the VPC has either or both of the following: - at least one endpoint gateway residing in it - a [DNS Services](https://cloud.ibm.com/docs/dns-svcs) private zone configured for it- `default`: The provider default DNS resolvers are configured for this VPC. This system DNS resolver configuration is used when the VPC has: - no custom DNS resolver configured for it, and - no endpoint gateways residing in it, and - no [DNS Services](https://cloud.ibm.com/docs/dns-svcs) private zone configured for it.", "computed": true }, - "ip_version": { - "name": "ip_version", - "type": "TypeString", - "description": "IP version: ipv4 or ipv6", - "computed": true + "manual_servers": { + "name": "manual_servers", + "type": "TypeList", + "description": "The manually specified DNS servers for this VPC.", + "computed": true, + "elem": { + "address": { + "name": "address", + "type": "TypeString", + "description": "The IP address.This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.", + "computed": true + }, + "zone_affinity": { + "name": "zone_affinity", + "type": "TypeString", + "description": "The name of the zone. If present, DHCP configuration for this zone will have this DNS server listed first.", + "computed": true + } + } }, - "port_max": { + "servers": { + "name": "servers", + "type": "TypeList", + "description": "The DNS servers for this VPC. The servers are populated:- by the system when `dns.resolver.type` is `system`- using the DNS servers in `dns.resolver.vpc` when `dns.resolver.type` is `delegated`- using `dns.resolver.manual_servers` when the `dns.resolver.type` is `manual`.", + "computed": true, + "elem": { + "address": { + "name": "address", + "type": "TypeString", + "description": "The IP address.This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.", + "computed": true + }, + "zone_affinity": { + "name": "zone_affinity", + "type": "TypeString", + "description": "Zone name, if present, DHCP configuration for this zone will have this DNS server listed first.", + "computed": true + } + } + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "The type of the DNS resolver used for the VPC.- `delegated`: DNS server addresses are provided by the DNS resolver of the VPC specified in `dns.resolver.vpc`.- `manual`: DNS server addresses are specified in `dns.resolver.manual_servers`.- `system`: DNS server addresses are provided by the system.", + "computed": true + }, + "vpc": { + "name": "vpc", + "type": "TypeList", + "description": "The VPC whose DNS resolver provides the DNS server addresses for this VPC.The VPC may be remote and therefore may not be directly retrievable.", + "computed": true, + "elem": { + "crn": { + "name": "crn", + "type": "TypeString", + "description": "The CRN for this VPC.", + "computed": true + }, + "deleted": { + "name": "deleted", + "type": "TypeList", + "description": "If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.", + "computed": true, + "elem": { + "more_info": { + "name": "more_info", + "type": "TypeString", + "description": "Link to documentation about deleted resources.", + "computed": true + } + } + }, + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this VPC.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this VPC.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The name for this VPC. The name is unique across all VPCs in the region.", + "computed": true + }, + "remote": { + "name": "remote", + "type": "TypeList", + "description": "If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable.", + "computed": true, + "elem": { + "account": { + "name": "account", + "type": "TypeList", + "description": "If present, this property indicates that the referenced resource is remote to thisaccount, and identifies the owning account.", + "computed": true, + "elem": { + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this account.", + "computed": true + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true + } + } + }, + "region": { + "name": "region", + "type": "TypeString", + "description": "Region name. If present, this property indicates that the referenced resource is remote to this region, and identifies the native region.", + "computed": true + } + } + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true + } + } + } + } + } + } + }, + "health_reasons": { + "name": "health_reasons", + "type": "TypeList", + "description": "The reasons for the current `health_state` (if any).The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered.", + "computed": true, + "elem": { + "code": { + "name": "code", + "type": "TypeString", + "description": "A snake case string succinctly identifying the reason for this health state.", + "computed": true + }, + "message": { + "name": "message", + "type": "TypeString", + "description": "An explanation of the reason for this health state.", + "computed": true + }, + "more_info": { + "name": "more_info", + "type": "TypeString", + "description": "Link to documentation about the reason for this health state.", + "computed": true + } + } + }, + "health_state": { + "name": "health_state", + "type": "TypeString", + "description": "The health of this resource.- `ok`: No abnormal behavior detected- `degraded`: Experiencing compromised performance, capacity, or connectivity- `faulted`: Completely unreachable, inoperative, or otherwise entirely incapacitated- `inapplicable`: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of `failed` or `deleting` will have a health state of `inapplicable`. A `pending` resource may also have this state.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "VPC id", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "VPC name", + "computed": true + }, + "resource_controller_url": { + "name": "resource_controller_url", + "type": "TypeString", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", + "computed": true + }, + "resource_crn": { + "name": "resource_crn", + "type": "TypeString", + "description": "The crn of the resource", + "computed": true + }, + "resource_group": { + "name": "resource_group", + "type": "TypeString", + "computed": true + }, + "resource_group_name": { + "name": "resource_group_name", + "type": "TypeString", + "description": "The resource group name in which resource is provisioned", + "computed": true + }, + "resource_name": { + "name": "resource_name", + "type": "TypeString", + "description": "The name of the resource", + "computed": true + }, + "resource_status": { + "name": "resource_status", + "type": "TypeString", + "description": "The status of the resource", + "computed": true + }, + "security_group": { + "name": "security_group", + "type": "TypeList", + "computed": true, + "elem": { + "group_id": { + "name": "group_id", + "type": "TypeString", + "description": "Security group id", + "immutable": true, + "computed": true + }, + "group_name": { + "name": "group_name", + "type": "TypeString", + "description": "Security group name", + "computed": true + }, + "rules": { + "name": "rules", + "type": "TypeList", + "description": "Security Rules", + "computed": true, + "elem": { + "code": { + "name": "code", + "type": "TypeInt", + "computed": true + }, + "direction": { + "name": "direction", + "type": "TypeString", + "description": "Direction of traffic to enforce, either inbound or outbound", + "computed": true + }, + "ip_version": { + "name": "ip_version", + "type": "TypeString", + "description": "IP version: ipv4 or ipv6", + "computed": true + }, + "port_max": { "name": "port_max", "type": "TypeInt", "computed": true @@ -59242,30 +60327,38 @@ } } } + }, + { + "name": "resource_group", + "type": "TypeString", + "description": "The unique identifier of the resource group this vpc belongs to", + "cloud_data_type": "resource_group", + "optional": true } ], "ibm_is_vpn_gateway": [ { - "name": "vpn_gateway_name", + "name": "resource_type", "type": "TypeString", - "description": "The VPN gateway name.", - "optional": true + "description": "The resource type.", + "computed": true }, { - "name": "subnet", + "name": "vpc", "type": "TypeList", + "description": "VPC for the VPN Gateway", "computed": true, "elem": { "crn": { "name": "crn", "type": "TypeString", - "description": "The CRN for this subnet.", + "description": "The CRN for this VPC.", "computed": true }, "deleted": { "name": "deleted", "type": "TypeList", - "description": "If present, this property indicates the referenced resource has been deleted and provides some supplementary information.", + "description": "If present, this property indicates the referenced resource has been deleted and providessome supplementary information.", "computed": true, "elem": { "more_info": { @@ -59279,102 +60372,96 @@ "href": { "name": "href", "type": "TypeString", - "description": "The URL for this subnet.", + "description": "The URL for this VPC.", "computed": true }, "id": { "name": "id", "type": "TypeString", - "description": "The unique identifier for this subnet.", + "description": "The unique identifier for this VPC.", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "The user-defined name for this subnet.", + "description": "The unique user-defined name for this VPC.", "computed": true } } }, { - "name": "mode", + "name": "created_at", "type": "TypeString", - "description": "Route mode VPN gateway.", + "description": "The date and time that this VPN gateway was created.", "computed": true }, { - "name": "access_tags", - "type": "TypeSet", - "description": "List of access management tags", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "crn", + "type": "TypeString", + "description": "The VPN gateway's CRN.", + "cloud_data_type": "crn", + "computed": true }, { - "name": "connections", + "name": "name", + "type": "TypeString", + "description": "The user-defined name for this VPN gateway.", + "computed": true + }, + { + "name": "vpn_gateway", + "type": "TypeString", + "description": "The VPN gateway identifier.", + "optional": true + }, + { + "name": "vpn_gateway_name", + "type": "TypeString", + "description": "The VPN gateway name.", + "optional": true + }, + { + "name": "resource_group", "type": "TypeList", - "description": "Connections for this VPN gateway.", + "description": "The resource group for this VPN gateway.", + "cloud_data_type": "resource_group", "computed": true, "elem": { - "deleted": { - "name": "deleted", - "type": "TypeList", - "description": "If present, this property indicates the referenced resource has been deleted and provides some supplementary information.", - "computed": true, - "elem": { - "more_info": { - "name": "more_info", - "type": "TypeString", - "description": "Link to documentation about deleted resources.", - "computed": true - } - } - }, "href": { "name": "href", "type": "TypeString", - "description": "The VPN connection's canonical URL.", + "description": "The URL for this resource group.", "computed": true }, "id": { "name": "id", "type": "TypeString", - "description": "The unique identifier for this VPN gateway connection.", + "description": "The unique identifier for this resource group.", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "The user-defined name for this VPN connection.", - "computed": true - }, - "resource_type": { - "name": "resource_type", - "type": "TypeString", - "description": "The resource type.", + "description": "The user-defined name for this resource group.", "computed": true } } }, { - "name": "created_at", - "type": "TypeString", - "description": "The date and time that this VPN gateway was created.", - "computed": true - }, - { - "name": "crn", + "name": "mode", "type": "TypeString", - "description": "The VPN gateway's CRN.", - "cloud_data_type": "crn", + "description": "Route mode VPN gateway.", "computed": true }, { - "name": "href", - "type": "TypeString", - "description": "The VPN gateway's canonical URL.", - "computed": true + "name": "tags", + "type": "TypeSet", + "description": "VPN Gateway tags list", + "cloud_data_type": "tags", + "computed": true, + "elem": { + "type": "TypeString" + } }, { "name": "members", @@ -59409,21 +60496,26 @@ } }, { - "name": "vpc", + "name": "status", + "type": "TypeString", + "description": "The status of the VPN gateway.", + "computed": true + }, + { + "name": "subnet", "type": "TypeList", - "description": "VPC for the VPN Gateway", "computed": true, "elem": { "crn": { "name": "crn", "type": "TypeString", - "description": "The CRN for this VPC.", + "description": "The CRN for this subnet.", "computed": true }, "deleted": { "name": "deleted", "type": "TypeList", - "description": "If present, this property indicates the referenced resource has been deleted and providessome supplementary information.", + "description": "If present, this property indicates the referenced resource has been deleted and provides some supplementary information.", "computed": true, "elem": { "more_info": { @@ -59437,91 +60529,91 @@ "href": { "name": "href", "type": "TypeString", - "description": "The URL for this VPC.", + "description": "The URL for this subnet.", "computed": true }, "id": { "name": "id", "type": "TypeString", - "description": "The unique identifier for this VPC.", + "description": "The unique identifier for this subnet.", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "The unique user-defined name for this VPC.", + "description": "The user-defined name for this subnet.", "computed": true } } }, { - "name": "tags", - "type": "TypeSet", - "description": "VPN Gateway tags list", - "cloud_data_type": "tags", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "vpn_gateway", - "type": "TypeString", - "description": "The VPN gateway identifier.", - "optional": true - }, - { - "name": "name", - "type": "TypeString", - "description": "The user-defined name for this VPN gateway.", - "computed": true - }, - { - "name": "resource_group", + "name": "connections", "type": "TypeList", - "description": "The resource group for this VPN gateway.", - "cloud_data_type": "resource_group", + "description": "Connections for this VPN gateway.", "computed": true, "elem": { + "deleted": { + "name": "deleted", + "type": "TypeList", + "description": "If present, this property indicates the referenced resource has been deleted and provides some supplementary information.", + "computed": true, + "elem": { + "more_info": { + "name": "more_info", + "type": "TypeString", + "description": "Link to documentation about deleted resources.", + "computed": true + } + } + }, "href": { "name": "href", "type": "TypeString", - "description": "The URL for this resource group.", + "description": "The VPN connection's canonical URL.", "computed": true }, "id": { "name": "id", "type": "TypeString", - "description": "The unique identifier for this resource group.", + "description": "The unique identifier for this VPN gateway connection.", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "The user-defined name for this resource group.", + "description": "The user-defined name for this VPN connection.", + "computed": true + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", "computed": true } } }, { - "name": "resource_type", + "name": "href", "type": "TypeString", - "description": "The resource type.", + "description": "The VPN gateway's canonical URL.", "computed": true }, { - "name": "status", - "type": "TypeString", - "description": "The status of the VPN gateway.", - "computed": true + "name": "access_tags", + "type": "TypeSet", + "description": "List of access management tags", + "computed": true, + "elem": { + "type": "TypeString" + } } ], "ibm_is_vpn_gateway_connection": [ { - "name": "authentication_mode", + "name": "vpn_gateway_connection_name", "type": "TypeString", - "description": "The authentication mode. Only `psk` is currently supported.", - "computed": true + "description": "The VPN gateway connection name.", + "optional": true }, { "name": "created_at", @@ -59530,9 +60622,21 @@ "computed": true }, { - "name": "ipsec_policy", + "name": "routing_protocol", + "type": "TypeString", + "description": "Routing protocols are disabled for this VPN gateway connection.", + "computed": true + }, + { + "name": "vpn_gateway", + "type": "TypeString", + "description": "The VPN gateway identifier.", + "optional": true + }, + { + "name": "ike_policy", "type": "TypeList", - "description": "The IPsec policy. If absent, [auto-negotiation isused](https://cloud.ibm.com/docs/vpc?topic=vpc-using-vpn\u0026interface=ui#ipsec-auto-negotiation-phase-2).", + "description": "The IKE policy. If absent, [auto-negotiation isused](https://cloud.ibm.com/docs/vpc?topic=vpc-using-vpn\u0026interface=ui#ike-auto-negotiation-phase-1).", "computed": true, "elem": { "deleted": { @@ -59552,19 +60656,19 @@ "href": { "name": "href", "type": "TypeString", - "description": "The IPsec policy's canonical URL.", + "description": "The IKE policy's canonical URL.", "computed": true }, "id": { "name": "id", "type": "TypeString", - "description": "The unique identifier for this IPsec policy.", + "description": "The unique identifier for this IKE policy.", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "The user-defined name for this IPsec policy.", + "description": "The user-defined name for this IKE policy.", "computed": true }, "resource_type": { @@ -59575,12 +60679,6 @@ } } }, - { - "name": "status", - "type": "TypeString", - "description": "The status of a VPN gateway connection.", - "computed": true - }, { "name": "peer_cidrs", "type": "TypeList", @@ -59590,12 +60688,6 @@ "type": "TypeString" } }, - { - "name": "vpn_gateway", - "type": "TypeString", - "description": "The VPN gateway identifier.", - "optional": true - }, { "name": "admin_state_up", "type": "TypeBool", @@ -59603,61 +60695,106 @@ "computed": true }, { - "name": "href", - "type": "TypeString", - "description": "The VPN connection's canonical URL.", - "computed": true - }, - { - "name": "name", + "name": "authentication_mode", "type": "TypeString", - "description": "The user-defined name for this VPN gateway connection.", + "description": "The authentication mode. Only `psk` is currently supported.", "computed": true }, { - "name": "local_cidrs", + "name": "tunnels", "type": "TypeList", - "description": "The local CIDRs for this resource.", + "description": "The VPN tunnel configuration for this VPN gateway connection (in static route mode).", "computed": true, "elem": { - "type": "TypeString" + "public_ip_address": { + "name": "public_ip_address", + "type": "TypeString", + "description": "The IP address of the VPN gateway member in which the tunnel resides.", + "computed": true + }, + "status": { + "name": "status", + "type": "TypeString", + "description": "The status of the VPN Tunnel.", + "computed": true + } } }, { - "name": "routing_protocol", + "name": "href", "type": "TypeString", - "description": "Routing protocols are disabled for this VPN gateway connection.", + "description": "The VPN connection's canonical URL.", "computed": true }, { - "name": "vpn_gateway_name", - "type": "TypeString", - "description": "The VPN gateway name.", - "optional": true + "name": "ipsec_policy", + "type": "TypeList", + "description": "The IPsec policy. If absent, [auto-negotiation isused](https://cloud.ibm.com/docs/vpc?topic=vpc-using-vpn\u0026interface=ui#ipsec-auto-negotiation-phase-2).", + "computed": true, + "elem": { + "deleted": { + "name": "deleted", + "type": "TypeList", + "description": "If present, this property indicates the referenced resource has been deleted and provides some supplementary information.", + "computed": true, + "elem": { + "more_info": { + "name": "more_info", + "type": "TypeString", + "description": "Link to documentation about deleted resources.", + "computed": true + } + } + }, + "href": { + "name": "href", + "type": "TypeString", + "description": "The IPsec policy's canonical URL.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this IPsec policy.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The user-defined name for this IPsec policy.", + "computed": true + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true + } + } }, { - "name": "vpn_gateway_connection_name", + "name": "mode", "type": "TypeString", - "description": "The VPN gateway connection name.", - "optional": true + "description": "The mode of the VPN gateway.", + "computed": true }, { - "name": "peer_address", + "name": "name", "type": "TypeString", - "description": "The IP address of the peer VPN gateway.", + "description": "The user-defined name for this VPN gateway connection.", "computed": true }, { - "name": "psk", + "name": "peer_address", "type": "TypeString", - "description": "The preshared key.", + "description": "The IP address of the peer VPN gateway.", "computed": true }, { - "name": "resource_type", + "name": "vpn_gateway_name", "type": "TypeString", - "description": "The resource type.", - "computed": true + "description": "The VPN gateway name.", + "optional": true }, { "name": "vpn_gateway_connection", @@ -59692,76 +60829,31 @@ } }, { - "name": "ike_policy", + "name": "local_cidrs", "type": "TypeList", - "description": "The IKE policy. If absent, [auto-negotiation isused](https://cloud.ibm.com/docs/vpc?topic=vpc-using-vpn\u0026interface=ui#ike-auto-negotiation-phase-1).", + "description": "The local CIDRs for this resource.", "computed": true, "elem": { - "deleted": { - "name": "deleted", - "type": "TypeList", - "description": "If present, this property indicates the referenced resource has been deleted and provides some supplementary information.", - "computed": true, - "elem": { - "more_info": { - "name": "more_info", - "type": "TypeString", - "description": "Link to documentation about deleted resources.", - "computed": true - } - } - }, - "href": { - "name": "href", - "type": "TypeString", - "description": "The IKE policy's canonical URL.", - "computed": true - }, - "id": { - "name": "id", - "type": "TypeString", - "description": "The unique identifier for this IKE policy.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "The user-defined name for this IKE policy.", - "computed": true - }, - "resource_type": { - "name": "resource_type", - "type": "TypeString", - "description": "The resource type.", - "computed": true - } + "type": "TypeString" } }, { - "name": "mode", + "name": "psk", "type": "TypeString", - "description": "The mode of the VPN gateway.", + "description": "The preshared key.", "computed": true }, { - "name": "tunnels", - "type": "TypeList", - "description": "The VPN tunnel configuration for this VPN gateway connection (in static route mode).", - "computed": true, - "elem": { - "public_ip_address": { - "name": "public_ip_address", - "type": "TypeString", - "description": "The IP address of the VPN gateway member in which the tunnel resides.", - "computed": true - }, - "status": { - "name": "status", - "type": "TypeString", - "description": "The status of the VPN Tunnel.", - "computed": true - } - } + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true + }, + { + "name": "status", + "type": "TypeString", + "description": "The status of a VPN gateway connection.", + "computed": true } ], "ibm_is_vpn_gateway_connections": [ @@ -60078,59 +61170,41 @@ ], "ibm_is_vpn_server": [ { - "name": "health_state", - "type": "TypeString", - "description": "The health of this resource.- `ok`: Healthy- `degraded`: Suffering from compromised performance, capacity, or connectivity- `faulted`: Completely unreachable, inoperative, or otherwise entirely incapacitated- `inapplicable`: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of `failed` or `deleting` will have a health state of `inapplicable`. A `pending` resource may also have this state.", - "computed": true - }, - { - "name": "lifecycle_state", - "type": "TypeString", - "description": "The lifecycle state of the VPN server.", - "computed": true - }, - { - "name": "vpc", + "name": "certificate", "type": "TypeList", - "description": "The VPC this VPN server resides in.", + "description": "The certificate instance for this VPN server.", "computed": true, "elem": { "crn": { "name": "crn", "type": "TypeString", - "description": "The CRN for this VPC.", + "description": "The CRN for this certificate instance.", "computed": true - }, - "deleted": { - "name": "deleted", - "type": "TypeList", - "description": "If present, this property indicates the referenced resource has been deleted and providessome supplementary information.", - "computed": true, - "elem": { - "more_info": { - "name": "more_info", - "type": "TypeString", - "description": "Link to documentation about deleted resources.", - "computed": true - } - } - }, - "href": { - "name": "href", + } + } + }, + { + "name": "client_authentication", + "type": "TypeList", + "description": "The methods used to authenticate VPN clients to this VPN server. VPN clients must authenticate against all provided methods.", + "computed": true, + "elem": { + "client_ca": { + "name": "client_ca", "type": "TypeString", - "description": "The URL for this VPC.", + "description": "The CRN for this certificate instance,The certificate instance used for the VPN client certificate authority (CA).", "computed": true }, - "id": { - "name": "id", + "identity_provider": { + "name": "identity_provider", "type": "TypeString", - "description": "The unique identifier for this VPC.", + "description": "The type of identity provider to be used by the VPN client.- `iam`: IBM identity and access managementThe enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the route on which the unexpected property value was encountered,The type of identity provider to be used by VPN client.", "computed": true }, - "name": { - "name": "name", + "method": { + "name": "method", "type": "TypeString", - "description": "The unique user-defined name for this VPC.", + "description": "The type of authentication.", "computed": true } } @@ -60142,10 +61216,18 @@ "computed": true }, { - "name": "client_auto_delete_timeout", - "type": "TypeInt", - "description": "Hours after which disconnected VPN clients will be automatically deleted. If `0`, disconnected VPN clients will be deleted immediately.", - "computed": true + "name": "client_dns_server_ips", + "type": "TypeList", + "description": "The DNS server addresses that will be provided to VPN clients that are connected to this VPN server.", + "computed": true, + "elem": { + "address": { + "name": "address", + "type": "TypeString", + "description": "The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.", + "computed": true + } + } }, { "name": "client_idle_timeout", @@ -60154,63 +61236,50 @@ "computed": true }, { - "name": "private_ips", + "name": "client_ip_pool", + "type": "TypeString", + "description": "The VPN client IPv4 address pool, expressed in CIDR format.", + "computed": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "The date and time that the VPN server was created.", + "computed": true + }, + { + "name": "hostname", + "type": "TypeString", + "description": "Fully qualified domain name assigned to this VPN server.", + "computed": true + }, + { + "name": "resource_group", "type": "TypeList", - "description": "The reserved IPs bound to this VPN server.", + "description": "The resource group for this VPN server.", + "cloud_data_type": "resource_group", "computed": true, "elem": { - "address": { - "name": "address", - "type": "TypeString", - "description": "The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.", - "computed": true - }, - "deleted": { - "name": "deleted", - "type": "TypeList", - "description": "If present, this property indicates the referenced resource has been deleted and providessome supplementary information.", - "computed": true, - "elem": { - "more_info": { - "name": "more_info", - "type": "TypeString", - "description": "Link to documentation about deleted resources.", - "computed": true - } - } - }, "href": { "name": "href", "type": "TypeString", - "description": "The URL for this reserved IP.", + "description": "The URL for this resource group.", "computed": true }, "id": { "name": "id", "type": "TypeString", - "description": "The unique identifier for this reserved IP.", + "description": "The unique identifier for this resource group.", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "The user-defined or system-provided name for this reserved IP.", - "computed": true - }, - "resource_type": { - "name": "resource_type", - "type": "TypeString", - "description": "The resource type.", + "description": "The user-defined name for this resource group.", "computed": true } } }, - { - "name": "protocol", - "type": "TypeString", - "description": "The transport protocol used by this VPN server.", - "computed": true - }, { "name": "resource_type", "type": "TypeString", @@ -60270,21 +61339,29 @@ } }, { - "name": "identifier", + "name": "name", "type": "TypeString", - "description": "The unique identifier for this VPN server", - "optional": true + "description": "The unique user-defined name for this VPN server", + "optional": true, + "computed": true }, { - "name": "client_ip_pool", + "name": "client_auto_delete_timeout", + "type": "TypeInt", + "description": "Hours after which disconnected VPN clients will be automatically deleted. If `0`, disconnected VPN clients will be deleted immediately.", + "computed": true + }, + { + "name": "crn", "type": "TypeString", - "description": "The VPN client IPv4 address pool, expressed in CIDR format.", + "description": "The CRN for this VPN server.", + "cloud_data_type": "crn", "computed": true }, { - "name": "enable_split_tunneling", - "type": "TypeBool", - "description": "Indicates whether the split tunneling is enabled on this VPN server.", + "name": "lifecycle_state", + "type": "TypeString", + "description": "The lifecycle state of the VPN server.", "computed": true }, { @@ -60340,46 +61417,61 @@ } }, { - "name": "access_tags", - "type": "TypeSet", - "description": "List of access tags", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "name", - "type": "TypeString", - "description": "The unique user-defined name for this VPN server", - "optional": true, - "computed": true - }, - { - "name": "client_dns_server_ips", + "name": "vpc", "type": "TypeList", - "description": "The DNS server addresses that will be provided to VPN clients that are connected to this VPN server.", + "description": "The VPC this VPN server resides in.", "computed": true, "elem": { - "address": { - "name": "address", + "crn": { + "name": "crn", "type": "TypeString", - "description": "The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.", + "description": "The CRN for this VPC.", + "computed": true + }, + "deleted": { + "name": "deleted", + "type": "TypeList", + "description": "If present, this property indicates the referenced resource has been deleted and providessome supplementary information.", + "computed": true, + "elem": { + "more_info": { + "name": "more_info", + "type": "TypeString", + "description": "Link to documentation about deleted resources.", + "computed": true + } + } + }, + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this VPC.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this VPC.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The unique user-defined name for this VPC.", "computed": true } } }, { - "name": "hostname", + "name": "identifier", "type": "TypeString", - "description": "Fully qualified domain name assigned to this VPN server.", - "computed": true + "description": "The unique identifier for this VPN server", + "optional": true }, { - "name": "crn", - "type": "TypeString", - "description": "The CRN for this VPN server.", - "cloud_data_type": "crn", + "name": "enable_split_tunneling", + "type": "TypeBool", + "description": "Indicates whether the split tunneling is enabled on this VPN server.", "computed": true }, { @@ -60389,126 +61481,90 @@ "computed": true }, { - "name": "resource_group", + "name": "private_ips", "type": "TypeList", - "description": "The resource group for this VPN server.", - "cloud_data_type": "resource_group", + "description": "The reserved IPs bound to this VPN server.", "computed": true, "elem": { + "address": { + "name": "address", + "type": "TypeString", + "description": "The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.", + "computed": true + }, + "deleted": { + "name": "deleted", + "type": "TypeList", + "description": "If present, this property indicates the referenced resource has been deleted and providessome supplementary information.", + "computed": true, + "elem": { + "more_info": { + "name": "more_info", + "type": "TypeString", + "description": "Link to documentation about deleted resources.", + "computed": true + } + } + }, "href": { "name": "href", "type": "TypeString", - "description": "The URL for this resource group.", + "description": "The URL for this reserved IP.", "computed": true }, "id": { "name": "id", "type": "TypeString", - "description": "The unique identifier for this resource group.", + "description": "The unique identifier for this reserved IP.", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "The user-defined name for this resource group.", - "computed": true - } - } - }, - { - "name": "certificate", - "type": "TypeList", - "description": "The certificate instance for this VPN server.", - "computed": true, - "elem": { - "crn": { - "name": "crn", - "type": "TypeString", - "description": "The CRN for this certificate instance.", - "computed": true - } - } - }, - { - "name": "client_authentication", - "type": "TypeList", - "description": "The methods used to authenticate VPN clients to this VPN server. VPN clients must authenticate against all provided methods.", - "computed": true, - "elem": { - "client_ca": { - "name": "client_ca", - "type": "TypeString", - "description": "The CRN for this certificate instance,The certificate instance used for the VPN client certificate authority (CA).", - "computed": true - }, - "identity_provider": { - "name": "identity_provider", - "type": "TypeString", - "description": "The type of identity provider to be used by the VPN client.- `iam`: IBM identity and access managementThe enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the route on which the unexpected property value was encountered,The type of identity provider to be used by VPN client.", + "description": "The user-defined or system-provided name for this reserved IP.", "computed": true }, - "method": { - "name": "method", + "resource_type": { + "name": "resource_type", "type": "TypeString", - "description": "The type of authentication.", + "description": "The resource type.", "computed": true } } }, { - "name": "created_at", - "type": "TypeString", - "description": "The date and time that the VPN server was created.", - "computed": true - } - ], - "ibm_is_vpn_server_client": [ - { - "name": "href", - "type": "TypeString", - "description": "The URL for this VPN client.", - "computed": true - }, - { - "name": "status", - "type": "TypeString", - "description": "The status of the VPN client:- `connected`: the VPN client is `connected` to this VPN server.- `disconnected`: the VPN client is `disconnected` from this VPN server.The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the VPN client on which the unexpected property value was encountered.", - "computed": true - }, - { - "name": "username", + "name": "health_state", "type": "TypeString", - "description": "The username that this VPN client provided when connecting to the VPN server.This property will be present only when the`username` client authentication method is enabled on the VPN server.", + "description": "The health of this resource.- `ok`: Healthy- `degraded`: Suffering from compromised performance, capacity, or connectivity- `faulted`: Completely unreachable, inoperative, or otherwise entirely incapacitated- `inapplicable`: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of `failed` or `deleting` will have a health state of `inapplicable`. A `pending` resource may also have this state.", "computed": true }, { - "name": "vpn_server", - "type": "TypeString", - "description": "The VPN server identifier.", - "required": true - }, - { - "name": "common_name", + "name": "protocol", "type": "TypeString", - "description": "The common name of client certificate that the VPN client provided when connecting to the server.This property will be present only when the `certificate` client authentication method is enabled on the VPN server.", + "description": "The transport protocol used by this VPN server.", "computed": true }, { - "name": "created_at", - "type": "TypeString", - "description": "The date and time that the VPN client was created.", - "computed": true - }, + "name": "access_tags", + "type": "TypeSet", + "description": "List of access tags", + "computed": true, + "elem": { + "type": "TypeString" + } + } + ], + "ibm_is_vpn_server_client": [ { - "name": "disconnected_at", + "name": "resource_type", "type": "TypeString", - "description": "The date and time that the VPN client was disconnected.", + "description": "The resource type.", "computed": true }, { - "name": "resource_type", + "name": "username", "type": "TypeString", - "description": "The resource type.", + "description": "The username that this VPN client provided when connecting to the VPN server.This property will be present only when the`username` client authentication method is enabled on the VPN server.", "computed": true }, { @@ -60531,6 +61587,18 @@ } } }, + { + "name": "created_at", + "type": "TypeString", + "description": "The date and time that the VPN client was created.", + "computed": true + }, + { + "name": "href", + "type": "TypeString", + "description": "The URL for this VPN client.", + "computed": true + }, { "name": "remote_ip", "type": "TypeList", @@ -60545,11 +61613,35 @@ } } }, + { + "name": "vpn_server", + "type": "TypeString", + "description": "The VPN server identifier.", + "required": true + }, + { + "name": "common_name", + "type": "TypeString", + "description": "The common name of client certificate that the VPN client provided when connecting to the server.This property will be present only when the `certificate` client authentication method is enabled on the VPN server.", + "computed": true + }, + { + "name": "disconnected_at", + "type": "TypeString", + "description": "The date and time that the VPN client was disconnected.", + "computed": true + }, { "name": "remote_port", "type": "TypeInt", "description": "The remote port of this VPN client.", "computed": true + }, + { + "name": "status", + "type": "TypeString", + "description": "The status of the VPN client:- `connected`: the VPN client is `connected` to this VPN server.- `disconnected`: the VPN client is `disconnected` from this VPN server.The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the VPN client on which the unexpected property value was encountered.", + "computed": true } ], "ibm_is_vpn_server_client_configuration": [ @@ -60673,43 +61765,37 @@ } ], "ibm_is_vpn_server_route": [ + { + "name": "vpn_server", + "type": "TypeString", + "description": "The VPN server identifier.", + "required": true + }, { "name": "identifier", "type": "TypeString", "description": "The unique identifier for this VPN server route", "optional": true }, + { + "name": "name", + "type": "TypeString", + "description": "The unique user-defined name for this VPN server route", + "optional": true, + "computed": true + }, { "name": "action", "type": "TypeString", "description": "The action to perform with a packet matching the VPN route:- `translate`: translate the source IP address to one of the private IP addresses of the VPN server.- `deliver`: deliver the packet into the VPC.- `drop`: drop the packetThe enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the VPN route on which the unexpected property value was encountered.", "computed": true }, - { - "name": "href", - "type": "TypeString", - "description": "The URL for this VPN route.", - "computed": true - }, { "name": "resource_type", "type": "TypeString", "description": "The resource type.", "computed": true }, - { - "name": "vpn_server", - "type": "TypeString", - "description": "The VPN server identifier.", - "required": true - }, - { - "name": "name", - "type": "TypeString", - "description": "The unique user-defined name for this VPN server route", - "optional": true, - "computed": true - }, { "name": "created_at", "type": "TypeString", @@ -60722,6 +61808,12 @@ "description": "The destination for this VPN route in the VPN server. If an incoming packet does not match any destination, it will be dropped.", "computed": true }, + { + "name": "href", + "type": "TypeString", + "description": "The URL for this VPN route.", + "computed": true + }, { "name": "lifecycle_state", "type": "TypeString", @@ -60794,13 +61886,6 @@ } ], "ibm_is_vpn_servers": [ - { - "name": "resource_group_id", - "type": "TypeString", - "description": "resource group identifier.", - "cloud_data_type": "resource_group", - "optional": true - }, { "name": "vpn_servers", "type": "TypeList", @@ -61189,6 +62274,13 @@ } } } + }, + { + "name": "resource_group_id", + "type": "TypeString", + "description": "resource group identifier.", + "cloud_data_type": "resource_group", + "optional": true } ], "ibm_is_zone": [ @@ -61210,6 +62302,12 @@ } ], "ibm_is_zones": [ + { + "name": "region", + "type": "TypeString", + "cloud_data_type": "region", + "required": true + }, { "name": "status", "type": "TypeString", @@ -61222,27 +62320,27 @@ "elem": { "type": "TypeString" } - }, - { - "name": "region", - "type": "TypeString", - "cloud_data_type": "region", - "required": true } ], "ibm_kms_instance_policies": [ { - "name": "policy_type", - "type": "TypeString", - "description": "Type of Policy to be Retrieved", - "optional": true - }, - { - "name": "dual_auth_delete", + "name": "key_create_import_access", "type": "TypeList", - "description": "Data associated with the dual auth delete policy for instance", + "description": "Data associated with the key create import access policy for the instance", "computed": true, "elem": { + "create_root_key": { + "name": "create_root_key", + "type": "TypeBool", + "description": "If set to true, Key Protect allows you or any authorized users to create root keys in the instance.", + "computed": true + }, + "create_standard_key": { + "name": "create_standard_key", + "type": "TypeBool", + "description": "If set to true, Key Protect allows you or any authorized users to create standard keys in the instance.", + "computed": true + }, "created_by": { "name": "created_by", "type": "TypeString", @@ -61258,7 +62356,25 @@ "enabled": { "name": "enabled", "type": "TypeBool", - "description": "Data associated with enable/disable dual authorization policy for the instance.", + "description": "Data associated with enable/disable KCIA policy for the instance.", + "computed": true + }, + "enforce_token": { + "name": "enforce_token", + "type": "TypeBool", + "description": "If set to true, the service prevents you or any authorized users from importing key material into the specified service instance without using an import token.", + "computed": true + }, + "import_root_key": { + "name": "import_root_key", + "type": "TypeBool", + "description": "If set to true, Key Protect allows you or any authorized users to import root keys into the instance.", + "computed": true + }, + "import_standard_key": { + "name": "import_standard_key", + "type": "TypeBool", + "description": "If set to true, Key Protect allows you or any authorized users to import standard keys into the instance.", "computed": true }, "last_updated": { @@ -61276,9 +62392,9 @@ } }, { - "name": "rotation", + "name": "metrics", "type": "TypeList", - "description": "Data associated with the rotation policy for instance", + "description": "Data associated with the metric policy for the instance", "computed": true, "elem": { "created_by": { @@ -61296,13 +62412,7 @@ "enabled": { "name": "enabled", "type": "TypeBool", - "description": "Data associated with enable/disable of rotation policy for the instance", - "computed": true - }, - "interval_month": { - "name": "interval_month", - "type": "TypeInt", - "description": "Specifies the rotation time interval in months for the instance", + "description": "Data associated with enable/disable metrics policy on the instance.", "computed": true }, "last_updated": { @@ -61320,23 +62430,28 @@ } }, { - "name": "key_create_import_access", + "name": "instance_id", + "type": "TypeString", + "description": "Key protect or hpcs instance GUID or CRN", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true, + "cloud_data_range": [ + "service:kms|hs-crypto" + ] + }, + { + "name": "policy_type", + "type": "TypeString", + "description": "Type of Policy to be Retrieved", + "optional": true + }, + { + "name": "dual_auth_delete", "type": "TypeList", - "description": "Data associated with the key create import access policy for the instance", + "description": "Data associated with the dual auth delete policy for instance", "computed": true, "elem": { - "create_root_key": { - "name": "create_root_key", - "type": "TypeBool", - "description": "If set to true, Key Protect allows you or any authorized users to create root keys in the instance.", - "computed": true - }, - "create_standard_key": { - "name": "create_standard_key", - "type": "TypeBool", - "description": "If set to true, Key Protect allows you or any authorized users to create standard keys in the instance.", - "computed": true - }, "created_by": { "name": "created_by", "type": "TypeString", @@ -61352,25 +62467,7 @@ "enabled": { "name": "enabled", "type": "TypeBool", - "description": "Data associated with enable/disable KCIA policy for the instance.", - "computed": true - }, - "enforce_token": { - "name": "enforce_token", - "type": "TypeBool", - "description": "If set to true, the service prevents you or any authorized users from importing key material into the specified service instance without using an import token.", - "computed": true - }, - "import_root_key": { - "name": "import_root_key", - "type": "TypeBool", - "description": "If set to true, Key Protect allows you or any authorized users to import root keys into the instance.", - "computed": true - }, - "import_standard_key": { - "name": "import_standard_key", - "type": "TypeBool", - "description": "If set to true, Key Protect allows you or any authorized users to import standard keys into the instance.", + "description": "Data associated with enable/disable dual authorization policy for the instance.", "computed": true }, "last_updated": { @@ -61388,9 +62485,9 @@ } }, { - "name": "metrics", + "name": "rotation", "type": "TypeList", - "description": "Data associated with the metric policy for the instance", + "description": "Data associated with the rotation policy for instance", "computed": true, "elem": { "created_by": { @@ -61408,7 +62505,13 @@ "enabled": { "name": "enabled", "type": "TypeBool", - "description": "Data associated with enable/disable metrics policy on the instance.", + "description": "Data associated with enable/disable of rotation policy for the instance", + "computed": true + }, + "interval_month": { + "name": "interval_month", + "type": "TypeInt", + "description": "Specifies the rotation time interval in months for the instance", "computed": true }, "last_updated": { @@ -61424,20 +62527,42 @@ "computed": true } } - }, + } + ], + "ibm_kms_key": [ { "name": "instance_id", "type": "TypeString", - "description": "Key protect or hpcs instance GUID or CRN", + "description": "Key protect or hpcs instance GUID", "cloud_data_type": "resource_instance", - "immutable": true, "required": true, "cloud_data_range": [ "service:kms|hs-crypto" ] - } - ], - "ibm_kms_key": [ + }, + { + "name": "limit", + "type": "TypeInt", + "description": "Limit till the keys to be fetched", + "optional": true + }, + { + "name": "key_id", + "type": "TypeString", + "optional": true + }, + { + "name": "key_name", + "type": "TypeString", + "description": "The name of the key to be fetched", + "optional": true + }, + { + "name": "alias", + "type": "TypeString", + "description": "The alias associated with the key", + "optional": true + }, { "name": "endpoint_type", "type": "TypeString", @@ -61463,6 +62588,11 @@ "type": "TypeString", "computed": true }, + "description": { + "name": "description", + "type": "TypeString", + "computed": true + }, "id": { "name": "id", "type": "TypeString", @@ -61583,39 +62713,6 @@ "computed": true } } - }, - { - "name": "instance_id", - "type": "TypeString", - "description": "Key protect or hpcs instance GUID", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:kms|hs-crypto" - ] - }, - { - "name": "limit", - "type": "TypeInt", - "description": "Limit till the keys to be fetched", - "optional": true - }, - { - "name": "key_id", - "type": "TypeString", - "optional": true - }, - { - "name": "key_name", - "type": "TypeString", - "description": "The name of the key to be fetched", - "optional": true - }, - { - "name": "alias", - "type": "TypeString", - "description": "The alias associated with the key", - "optional": true } ], "ibm_kms_key_policies": [ @@ -61764,6 +62861,23 @@ } ], "ibm_kms_key_rings": [ + { + "name": "instance_id", + "type": "TypeString", + "description": "Key protect or hpcs instance GUID", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:kms|hs-crypto" + ] + }, + { + "name": "endpoint_type", + "type": "TypeString", + "description": "public or private", + "default_value": "public", + "optional": true + }, { "name": "key_rings", "type": "TypeList", @@ -61786,23 +62900,6 @@ "computed": true } } - }, - { - "name": "instance_id", - "type": "TypeString", - "description": "Key protect or hpcs instance GUID", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:kms|hs-crypto" - ] - }, - { - "name": "endpoint_type", - "type": "TypeString", - "description": "public or private", - "default_value": "public", - "optional": true } ], "ibm_kms_keys": [ @@ -61843,6 +62940,11 @@ "type": "TypeString", "computed": true }, + "description": { + "name": "description", + "type": "TypeString", + "computed": true + }, "id": { "name": "id", "type": "TypeString", @@ -61988,1570 +63090,4349 @@ } ], "ibm_kp_key": [ + { + "name": "key_protect_id", + "type": "TypeString", + "required": true + }, { "name": "key_name", "type": "TypeString", - "optional": true + "optional": true + }, + { + "name": "keys", + "type": "TypeList", + "computed": true, + "elem": { + "crn": { + "name": "crn", + "type": "TypeString", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "computed": true + }, + "standard_key": { + "name": "standard_key", + "type": "TypeBool", + "computed": true + } + } + } + ], + "ibm_lbaas": [ + { + "name": "ssl_ciphers", + "type": "TypeSet", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "protocols", + "type": "TypeList", + "computed": true, + "elem": { + "backend_port": { + "name": "backend_port", + "type": "TypeInt", + "computed": true + }, + "backend_protocol": { + "name": "backend_protocol", + "type": "TypeString", + "computed": true + }, + "frontend_port": { + "name": "frontend_port", + "type": "TypeInt", + "computed": true + }, + "frontend_protocol": { + "name": "frontend_protocol", + "type": "TypeString", + "computed": true + }, + "load_balancing_method": { + "name": "load_balancing_method", + "type": "TypeString", + "computed": true + }, + "max_conn": { + "name": "max_conn", + "type": "TypeInt", + "computed": true + }, + "protocol_id": { + "name": "protocol_id", + "type": "TypeString", + "computed": true + }, + "session_stickiness": { + "name": "session_stickiness", + "type": "TypeString", + "computed": true + }, + "tls_certificate_id": { + "name": "tls_certificate_id", + "type": "TypeInt", + "computed": true + } + } + }, + { + "name": "name", + "type": "TypeString", + "required": true + }, + { + "name": "description", + "type": "TypeString", + "computed": true + }, + { + "name": "server_instances_up", + "type": "TypeInt", + "computed": true + }, + { + "name": "server_instances", + "type": "TypeList", + "computed": true, + "elem": { + "member_id": { + "name": "member_id", + "type": "TypeString", + "computed": true + }, + "private_ip_address": { + "name": "private_ip_address", + "type": "TypeString", + "computed": true + }, + "status": { + "name": "status", + "type": "TypeString", + "computed": true + }, + "weight": { + "name": "weight", + "type": "TypeInt", + "computed": true + } + } + }, + { + "name": "datacenter", + "type": "TypeString", + "computed": true + }, + { + "name": "status", + "type": "TypeString", + "computed": true + }, + { + "name": "use_system_public_ip_pool", + "type": "TypeBool", + "computed": true + }, + { + "name": "server_instances_down", + "type": "TypeInt", + "computed": true + }, + { + "name": "health_monitors", + "type": "TypeList", + "computed": true, + "elem": { + "interval": { + "name": "interval", + "type": "TypeInt", + "computed": true + }, + "max_retries": { + "name": "max_retries", + "type": "TypeInt", + "computed": true + }, + "monitor_id": { + "name": "monitor_id", + "type": "TypeString", + "computed": true + }, + "port": { + "name": "port", + "type": "TypeInt", + "computed": true + }, + "protocol": { + "name": "protocol", + "type": "TypeString", + "computed": true + }, + "timeout": { + "name": "timeout", + "type": "TypeInt", + "computed": true + }, + "url_path": { + "name": "url_path", + "type": "TypeString", + "computed": true + } + } + }, + { + "name": "type", + "type": "TypeString", + "computed": true + }, + { + "name": "vip", + "type": "TypeString", + "computed": true + }, + { + "name": "active_connections", + "type": "TypeInt", + "computed": true + } + ], + "ibm_metrics_router_routes": [ + { + "name": "name", + "type": "TypeString", + "description": "The name of the route.", + "optional": true + }, + { + "name": "routes", + "type": "TypeList", + "description": "A list of route resources.", + "computed": true, + "elem": { + "created_at": { + "name": "created_at", + "type": "TypeString", + "description": "The timestamp of the route creation time.", + "computed": true + }, + "crn": { + "name": "crn", + "type": "TypeString", + "description": "The crn of the route resource.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The UUID of the route resource.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The name of the route.", + "computed": true + }, + "rules": { + "name": "rules", + "type": "TypeList", + "description": "The routing rules that will be evaluated in their order of the array. Once a rule is matched, the remaining rules in the route definition will be skipped.", + "computed": true, + "elem": { + "action": { + "name": "action", + "type": "TypeString", + "description": "The action if the inclusion_filters matches, default is `send` action.", + "computed": true + }, + "inclusion_filters": { + "name": "inclusion_filters", + "type": "TypeList", + "description": "A list of conditions to be satisfied for routing metrics to pre-defined target.", + "computed": true, + "elem": { + "operand": { + "name": "operand", + "type": "TypeString", + "description": "Part of CRN that can be compared with values.", + "computed": true + }, + "operator": { + "name": "operator", + "type": "TypeString", + "description": "The operation to be performed between operand and the provided values. 'is' to be used with one value and 'in' can support upto 20 values in the array.", + "computed": true + }, + "values": { + "name": "values", + "type": "TypeList", + "description": "The provided string values of the operand to be compared with.", + "computed": true, + "elem": { + "type": "TypeString" + } + } + } + }, + "targets": { + "name": "targets", + "type": "TypeList", + "description": "The target ID List. All the metrics will be sent to all targets listed in the rule. You can include targets from other regions.", + "computed": true, + "elem": { + "crn": { + "name": "crn", + "type": "TypeString", + "description": "The CRN of a pre-defined metrics-router target.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The target uuid for a pre-defined metrics router target.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The name of a pre-defined metrics-router target.", + "computed": true + }, + "target_type": { + "name": "target_type", + "type": "TypeString", + "description": "The type of the target.", + "computed": true + } + } + } + } + }, + "updated_at": { + "name": "updated_at", + "type": "TypeString", + "description": "The timestamp of the route last updated time.", + "computed": true + } + } + } + ], + "ibm_metrics_router_targets": [ + { + "name": "name", + "type": "TypeString", + "description": "The name of the target resource.", + "optional": true + }, + { + "name": "targets", + "type": "TypeList", + "description": "A list of target resources.", + "computed": true, + "elem": { + "created_at": { + "name": "created_at", + "type": "TypeString", + "description": "The timestamp of the target creation time.", + "computed": true + }, + "crn": { + "name": "crn", + "type": "TypeString", + "description": "The crn of the target resource.", + "computed": true + }, + "destination_crn": { + "name": "destination_crn", + "type": "TypeString", + "description": "The CRN of the destination service instance or resource.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The UUID of the target resource.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The name of the target resource.", + "computed": true + }, + "region": { + "name": "region", + "type": "TypeString", + "description": "Include this optional field if you used it to create a target in a different region other than the one you are connected.", + "computed": true + }, + "target_type": { + "name": "target_type", + "type": "TypeString", + "description": "The type of the target.", + "computed": true + }, + "updated_at": { + "name": "updated_at", + "type": "TypeString", + "description": "The timestamp of the target last updated time.", + "computed": true + } + } + } + ], + "ibm_network_vlan": [ + { + "name": "subnets", + "type": "TypeList", + "computed": true, + "elem": { + "cidr": { + "name": "cidr", + "type": "TypeInt", + "computed": true + }, + "gateway": { + "name": "gateway", + "type": "TypeString", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeInt", + "computed": true + }, + "subnet": { + "name": "subnet", + "type": "TypeString", + "computed": true + }, + "subnet_size": { + "name": "subnet_size", + "type": "TypeInt", + "computed": true + }, + "subnet_type": { + "name": "subnet_type", + "type": "TypeString", + "computed": true + } + } + }, + { + "name": "id", + "type": "TypeInt", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "optional": true, + "computed": true + }, + { + "name": "number", + "type": "TypeInt", + "optional": true, + "computed": true + }, + { + "name": "router_hostname", + "type": "TypeString", + "optional": true, + "computed": true + }, + { + "name": "virtual_guests", + "type": "TypeList", + "computed": true, + "elem": { + "domain": { + "name": "domain", + "type": "TypeString", + "computed": true + }, + "hostname": { + "name": "hostname", + "type": "TypeString", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeInt", + "computed": true + } + } + } + ], + "ibm_org": [ + { + "name": "org", + "type": "TypeString", + "description": "Org name, for example myorg@domain", + "optional": true, + "deprecated": "use name instead" + }, + { + "name": "name", + "type": "TypeString", + "description": "Org name, for example myorg@domain", + "optional": true + } + ], + "ibm_org_quota": [ + { + "name": "trial_db_allowed", + "type": "TypeBool", + "description": "Defines trial db are allowed for organization.", + "computed": true + }, + { + "name": "app_instance_limit", + "type": "TypeInt", + "description": "Defines the total app instance limit for organization.", + "computed": true + }, + { + "name": "app_tasks_limit", + "type": "TypeInt", + "description": "Defines the total app task limit for organization.", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "Org quota name, for example qIBM", + "required": true + }, + { + "name": "total_routes", + "type": "TypeInt", + "description": "Defines the total route for organization.", + "computed": true + }, + { + "name": "instance_memory_limit", + "type": "TypeInt", + "description": "Defines the total instance memory limit for organization.", + "computed": true + }, + { + "name": "total_private_domains", + "type": "TypeInt", + "description": "Defines the total private domain limit for organization.v", + "computed": true + }, + { + "name": "total_service_keys", + "type": "TypeInt", + "description": "Defines the total service keys for organization.", + "computed": true + }, + { + "name": "total_reserved_route_ports", + "type": "TypeInt", + "description": "Defines the number of reserved route ports for organization.", + "computed": true + }, + { + "name": "non_basic_services_allowed", + "type": "TypeBool", + "description": "Define non basic services are allowed for organization.", + "computed": true + }, + { + "name": "total_services", + "type": "TypeInt", + "description": "Defines the total services for organization.", + "computed": true + }, + { + "name": "memory_limit", + "type": "TypeInt", + "description": "Defines the total memory limit for organization.", + "computed": true + } + ], + "ibm_pi_catalog_images": [ + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "sap", + "type": "TypeBool", + "optional": true + }, + { + "name": "vtl", + "type": "TypeBool", + "optional": true + }, + { + "name": "images", + "type": "TypeList", + "computed": true, + "elem": { + "architecture": { + "name": "architecture", + "type": "TypeString", + "computed": true + }, + "container_format": { + "name": "container_format", + "type": "TypeString", + "computed": true + }, + "creation_date": { + "name": "creation_date", + "type": "TypeString", + "computed": true + }, + "description": { + "name": "description", + "type": "TypeString", + "computed": true + }, + "disk_format": { + "name": "disk_format", + "type": "TypeString", + "computed": true + }, + "endianness": { + "name": "endianness", + "type": "TypeString", + "computed": true + }, + "href": { + "name": "href", + "type": "TypeString", + "computed": true + }, + "hypervisor_type": { + "name": "hypervisor_type", + "type": "TypeString", + "computed": true + }, + "image_id": { + "name": "image_id", + "type": "TypeString", + "computed": true + }, + "image_type": { + "name": "image_type", + "type": "TypeString", + "computed": true + }, + "last_update_date": { + "name": "last_update_date", + "type": "TypeString", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "computed": true + }, + "operating_system": { + "name": "operating_system", + "type": "TypeString", + "computed": true + }, + "state": { + "name": "state", + "type": "TypeString", + "computed": true + }, + "storage_pool": { + "name": "storage_pool", + "type": "TypeString", + "computed": true + }, + "storage_type": { + "name": "storage_type", + "type": "TypeString", + "computed": true + } + } + } + ], + "ibm_pi_cloud_connection": [ + { + "name": "pi_cloud_connection_name", + "type": "TypeString", + "description": "Cloud Connection Name to be used", + "required": true + }, + { + "name": "metered", + "type": "TypeBool", + "computed": true + }, + { + "name": "ibm_ip_address", + "type": "TypeString", + "computed": true + }, + { + "name": "user_ip_address", + "type": "TypeString", + "computed": true + }, + { + "name": "port", + "type": "TypeString", + "computed": true + }, + { + "name": "networks", + "type": "TypeSet", + "description": "Set of Networks attached to this cloud connection", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "gre_source_address", + "type": "TypeString", + "description": "GRE auto-assigned source IP address", + "computed": true + }, + { + "name": "vpc_enabled", + "type": "TypeBool", + "description": "Enable VPC for this cloud connection", + "computed": true + }, + { + "name": "status", + "type": "TypeString", + "computed": true + }, + { + "name": "gre_destination_address", + "type": "TypeString", + "description": "GRE destination IP address", + "computed": true + }, + { + "name": "vpc_crns", + "type": "TypeSet", + "description": "Set of VPCs attached to this cloud connection", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "speed", + "type": "TypeInt", + "computed": true + }, + { + "name": "global_routing", + "type": "TypeBool", + "computed": true + }, + { + "name": "classic_enabled", + "type": "TypeBool", + "description": "Enable classic endpoint destination", + "computed": true + }, + { + "name": "connection_mode", + "type": "TypeString", + "description": "Type of service the gateway is attached to", + "computed": true + } + ], + "ibm_pi_cloud_connections": [ + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "connections", + "type": "TypeList", + "computed": true, + "elem": { + "classic_enabled": { + "name": "classic_enabled", + "type": "TypeBool", + "description": "Enable classic endpoint destination", + "computed": true + }, + "cloud_connection_id": { + "name": "cloud_connection_id", + "type": "TypeString", + "computed": true + }, + "connection_mode": { + "name": "connection_mode", + "type": "TypeString", + "description": "Type of service the gateway is attached to", + "computed": true + }, + "global_routing": { + "name": "global_routing", + "type": "TypeBool", + "computed": true + }, + "gre_destination_address": { + "name": "gre_destination_address", + "type": "TypeString", + "description": "GRE destination IP address", + "computed": true + }, + "gre_source_address": { + "name": "gre_source_address", + "type": "TypeString", + "description": "GRE auto-assigned source IP address", + "computed": true + }, + "ibm_ip_address": { + "name": "ibm_ip_address", + "type": "TypeString", + "computed": true + }, + "metered": { + "name": "metered", + "type": "TypeBool", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "computed": true + }, + "networks": { + "name": "networks", + "type": "TypeSet", + "description": "Set of Networks attached to this cloud connection", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "port": { + "name": "port", + "type": "TypeString", + "computed": true + }, + "speed": { + "name": "speed", + "type": "TypeInt", + "computed": true + }, + "status": { + "name": "status", + "type": "TypeString", + "computed": true + }, + "user_ip_address": { + "name": "user_ip_address", + "type": "TypeString", + "computed": true + }, + "vpc_crns": { + "name": "vpc_crns", + "type": "TypeSet", + "description": "Set of VPCs attached to this cloud connection", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "vpc_enabled": { + "name": "vpc_enabled", + "type": "TypeBool", + "description": "Enable VPC for this cloud connection", + "computed": true + } + } + } + ], + "ibm_pi_cloud_instance": [ + { + "name": "total_standard_storage_consumed", + "type": "TypeFloat", + "computed": true + }, + { + "name": "enabled", + "type": "TypeBool", + "computed": true + }, + { + "name": "tenant_id", + "type": "TypeString", + "computed": true + }, + { + "name": "region", + "type": "TypeString", + "cloud_data_type": "region", + "computed": true + }, + { + "name": "total_processors_consumed", + "type": "TypeFloat", + "computed": true + }, + { + "name": "total_memory_consumed", + "type": "TypeFloat", + "computed": true + }, + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "capabilities", + "type": "TypeList", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "total_instances", + "type": "TypeFloat", + "computed": true + }, + { + "name": "total_ssd_storage_consumed", + "type": "TypeFloat", + "computed": true + }, + { + "name": "pvm_instances", + "type": "TypeList", + "computed": true, + "elem": { + "creation_date": { + "name": "creation_date", + "type": "TypeString", + "computed": true + }, + "href": { + "name": "href", + "type": "TypeString", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "computed": true + }, + "status": { + "name": "status", + "type": "TypeString", + "computed": true + }, + "systype": { + "name": "systype", + "type": "TypeString", + "computed": true + } + } + } + ], + "ibm_pi_console_languages": [ + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "pi_instance_name", + "type": "TypeString", + "description": "The unique identifier or name of the instance", + "required": true + }, + { + "name": "console_languages", + "type": "TypeList", + "computed": true, + "elem": { + "code": { + "name": "code", + "type": "TypeString", + "description": "language code", + "computed": true + }, + "language": { + "name": "language", + "type": "TypeString", + "description": "language description", + "computed": true + } + } + } + ], + "ibm_pi_dhcp": [ + { + "name": "dhcp_id", + "type": "TypeString", + "description": "The ID of the DHCP Server", + "computed": true + }, + { + "name": "leases", + "type": "TypeList", + "description": "The list of DHCP Server PVM Instance leases", + "computed": true, + "elem": { + "instance_ip": { + "name": "instance_ip", + "type": "TypeString", + "description": "The IP of the PVM Instance", + "computed": true + }, + "instance_mac": { + "name": "instance_mac", + "type": "TypeString", + "description": "The MAC Address of the PVM Instance", + "computed": true + } + } + }, + { + "name": "network", + "type": "TypeString", + "description": "The ID of the DHCP Server private network (deprecated - replaced by network_id)", + "computed": true + }, + { + "name": "network_id", + "type": "TypeString", + "description": "The ID of the DHCP Server private network", + "computed": true + }, + { + "name": "network_name", + "type": "TypeString", + "description": "The name of the DHCP Server private network", + "computed": true + }, + { + "name": "status", + "type": "TypeString", + "description": "The status of the DHCP Server", + "computed": true + }, + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "pi_dhcp_id", + "type": "TypeString", + "description": "The ID of the DHCP Server", + "required": true + } + ], + "ibm_pi_dhcps": [ + { + "name": "servers", + "type": "TypeList", + "description": "The list of all the DHCP Servers", + "computed": true, + "elem": { + "dhcp_id": { + "name": "dhcp_id", + "type": "TypeString", + "description": "The ID of the DHCP Server", + "computed": true + }, + "network": { + "name": "network", + "type": "TypeString", + "description": "The ID of the DHCP Server private network (deprecated - replaced by network_id)", + "computed": true + }, + "network_id": { + "name": "network_id", + "type": "TypeString", + "description": "The ID of the DHCP Server private network", + "computed": true + }, + "network_name": { + "name": "network_name", + "type": "TypeString", + "description": "The name of the DHCP Server private network", + "computed": true + }, + "status": { + "name": "status", + "type": "TypeString", + "description": "The status of the DHCP Server", + "computed": true + } + } + }, + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + } + ], + "ibm_pi_disaster_recovery_location": [ + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "location", + "type": "TypeString", + "description": "RegionZone of a site", + "cloud_data_type": "region", + "computed": true + }, + { + "name": "replication_sites", + "type": "TypeList", + "computed": true, + "elem": { + "is_active": { + "name": "is_active", + "type": "TypeBool", + "computed": true + }, + "location": { + "name": "location", + "type": "TypeString", + "computed": true + } + } + } + ], + "ibm_pi_disaster_recovery_locations": [ + { + "name": "disaster_recovery_locations", + "type": "TypeList", + "computed": true, + "elem": { + "location": { + "name": "location", + "type": "TypeString", + "description": "RegionZone of a site", + "computed": true + }, + "replication_sites": { + "name": "replication_sites", + "type": "TypeList", + "computed": true, + "elem": { + "is_active": { + "name": "is_active", + "type": "TypeBool", + "computed": true + }, + "location": { + "name": "location", + "type": "TypeString", + "computed": true + } + } + } + } + } + ], + "ibm_pi_image": [ + { + "name": "hypervisor", + "type": "TypeString", + "computed": true + }, + { + "name": "storage_type", + "type": "TypeString", + "computed": true + }, + { + "name": "storage_pool", + "type": "TypeString", + "computed": true + }, + { + "name": "image_type", + "type": "TypeString", + "computed": true + }, + { + "name": "pi_image_name", + "type": "TypeString", + "description": "Imagename Name to be used for pvminstances", + "required": true + }, + { + "name": "state", + "type": "TypeString", + "computed": true + }, + { + "name": "architecture", + "type": "TypeString", + "computed": true + }, + { + "name": "operatingsystem", + "type": "TypeString", + "computed": true + }, + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "size", + "type": "TypeInt", + "computed": true + } + ], + "ibm_pi_images": [ + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "image_info", + "type": "TypeList", + "computed": true, + "elem": { + "href": { + "name": "href", + "type": "TypeString", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "computed": true + }, + "image_type": { + "name": "image_type", + "type": "TypeString", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "computed": true + }, + "state": { + "name": "state", + "type": "TypeString", + "computed": true + }, + "storage_pool": { + "name": "storage_pool", + "type": "TypeString", + "computed": true + }, + "storage_type": { + "name": "storage_type", + "type": "TypeString", + "computed": true + } + } + } + ], + "ibm_pi_instance": [ + { + "name": "license_repository_capacity", + "type": "TypeInt", + "computed": true + }, + { + "name": "deployment_type", + "type": "TypeString", + "computed": true + }, + { + "name": "health_status", + "type": "TypeString", + "computed": true + }, + { + "name": "networks", + "type": "TypeList", + "computed": true, + "elem": { + "external_ip": { + "name": "external_ip", + "type": "TypeString", + "computed": true + }, + "ip": { + "name": "ip", + "type": "TypeString", + "computed": true + }, + "macaddress": { + "name": "macaddress", + "type": "TypeString", + "computed": true + }, + "network_id": { + "name": "network_id", + "type": "TypeString", + "computed": true + }, + "network_name": { + "name": "network_name", + "type": "TypeString", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "computed": true + } + } + }, + { + "name": "status", + "type": "TypeString", + "computed": true + }, + { + "name": "maxproc", + "type": "TypeFloat", + "computed": true + }, + { + "name": "maxmem", + "type": "TypeFloat", + "computed": true + }, + { + "name": "shared_processor_pool", + "type": "TypeString", + "computed": true + }, + { + "name": "memory", + "type": "TypeFloat", + "computed": true + }, + { + "name": "minproc", + "type": "TypeFloat", + "computed": true + }, + { + "name": "minmem", + "type": "TypeFloat", + "computed": true + }, + { + "name": "storage_pool", + "type": "TypeString", + "computed": true + }, + { + "name": "storage_pool_affinity", + "type": "TypeBool", + "computed": true + }, + { + "name": "min_virtual_cores", + "type": "TypeInt", + "computed": true + }, + { + "name": "placement_group_id", + "type": "TypeString", + "computed": true + }, + { + "name": "shared_processor_pool_id", + "type": "TypeString", + "computed": true + }, + { + "name": "volumes", + "type": "TypeList", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "processors", + "type": "TypeFloat", + "computed": true + }, + { + "name": "addresses", + "type": "TypeList", + "computed": true, + "elem": { + "external_ip": { + "name": "external_ip", + "type": "TypeString", + "computed": true + }, + "ip": { + "name": "ip", + "type": "TypeString", + "computed": true + }, + "macaddress": { + "name": "macaddress", + "type": "TypeString", + "computed": true + }, + "network_id": { + "name": "network_id", + "type": "TypeString", + "computed": true + }, + "network_name": { + "name": "network_name", + "type": "TypeString", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "computed": true + } + }, + "deprecated": "This field is deprecated, use networks instead" + }, + { + "name": "proctype", + "type": "TypeString", + "computed": true + }, + { + "name": "pin_policy", + "type": "TypeString", + "computed": true + }, + { + "name": "pi_instance_name", + "type": "TypeString", + "description": "Server Name to be used for pvminstances", + "required": true + }, + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "virtual_cores_assigned", + "type": "TypeInt", + "computed": true + }, + { + "name": "max_virtual_cores", + "type": "TypeInt", + "computed": true + }, + { + "name": "storage_type", + "type": "TypeString", + "computed": true + } + ], + "ibm_pi_instance_ip": [ + { + "name": "pi_instance_name", + "type": "TypeString", + "description": "Server Name to be used for pvminstances", + "required": true + }, + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "pi_network_name", + "type": "TypeString", + "required": true + }, + { + "name": "network_id", + "type": "TypeString", + "computed": true + }, + { + "name": "external_ip", + "type": "TypeString", + "computed": true + }, + { + "name": "ip", + "type": "TypeString", + "computed": true + }, + { + "name": "ipoctet", + "type": "TypeString", + "computed": true + }, + { + "name": "macaddress", + "type": "TypeString", + "computed": true + }, + { + "name": "type", + "type": "TypeString", + "computed": true + } + ], + "ibm_pi_instance_snapshots": [ + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "instance_snapshots", + "type": "TypeList", + "computed": true, + "elem": { + "action": { + "name": "action", + "type": "TypeString", + "computed": true + }, + "creation_date": { + "name": "creation_date", + "type": "TypeString", + "computed": true + }, + "description": { + "name": "description", + "type": "TypeString", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "computed": true + }, + "last_updated_date": { + "name": "last_updated_date", + "type": "TypeString", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "computed": true + }, + "percent_complete": { + "name": "percent_complete", + "type": "TypeInt", + "computed": true + }, + "status": { + "name": "status", + "type": "TypeString", + "computed": true + }, + "volume_snapshots": { + "name": "volume_snapshots", + "type": "TypeMap", + "computed": true + } + } + } + ], + "ibm_pi_instance_volumes": [ + { + "name": "pi_instance_name", + "type": "TypeString", + "description": "Instance Name to be used for pvminstances", + "required": true + }, + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "boot_volume_id", + "type": "TypeString", + "computed": true + }, + { + "name": "instance_volumes", + "type": "TypeList", + "computed": true, + "elem": { + "bootable": { + "name": "bootable", + "type": "TypeBool", + "computed": true + }, + "href": { + "name": "href", + "type": "TypeString", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "computed": true + }, + "pool": { + "name": "pool", + "type": "TypeString", + "computed": true + }, + "shareable": { + "name": "shareable", + "type": "TypeBool", + "computed": true + }, + "size": { + "name": "size", + "type": "TypeFloat", + "computed": true + }, + "state": { + "name": "state", + "type": "TypeString", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "computed": true + } + } + } + ], + "ibm_pi_instances": [ + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "pvm_instances", + "type": "TypeList", + "computed": true, + "elem": { + "health_status": { + "name": "health_status", + "type": "TypeString", + "computed": true + }, + "license_repository_capacity": { + "name": "license_repository_capacity", + "type": "TypeInt", + "computed": true + }, + "max_virtual_cores": { + "name": "max_virtual_cores", + "type": "TypeInt", + "computed": true + }, + "maxmem": { + "name": "maxmem", + "type": "TypeFloat", + "computed": true + }, + "maxproc": { + "name": "maxproc", + "type": "TypeFloat", + "computed": true + }, + "memory": { + "name": "memory", + "type": "TypeFloat", + "computed": true + }, + "min_virtual_cores": { + "name": "min_virtual_cores", + "type": "TypeInt", + "computed": true + }, + "minmem": { + "name": "minmem", + "type": "TypeFloat", + "computed": true + }, + "minproc": { + "name": "minproc", + "type": "TypeFloat", + "computed": true + }, + "networks": { + "name": "networks", + "type": "TypeList", + "computed": true, + "elem": { + "external_ip": { + "name": "external_ip", + "type": "TypeString", + "computed": true + }, + "ip": { + "name": "ip", + "type": "TypeString", + "computed": true + }, + "macaddress": { + "name": "macaddress", + "type": "TypeString", + "computed": true + }, + "network_id": { + "name": "network_id", + "type": "TypeString", + "computed": true + }, + "network_name": { + "name": "network_name", + "type": "TypeString", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "computed": true + } + } + }, + "pin_policy": { + "name": "pin_policy", + "type": "TypeString", + "computed": true + }, + "placement_group_id": { + "name": "placement_group_id", + "type": "TypeString", + "computed": true + }, + "processors": { + "name": "processors", + "type": "TypeFloat", + "computed": true + }, + "proctype": { + "name": "proctype", + "type": "TypeString", + "computed": true + }, + "pvm_instance_id": { + "name": "pvm_instance_id", + "type": "TypeString", + "computed": true + }, + "status": { + "name": "status", + "type": "TypeString", + "computed": true + }, + "storage_pool": { + "name": "storage_pool", + "type": "TypeString", + "computed": true + }, + "storage_pool_affinity": { + "name": "storage_pool_affinity", + "type": "TypeBool", + "computed": true + }, + "storage_type": { + "name": "storage_type", + "type": "TypeString", + "computed": true + }, + "virtual_cores_assigned": { + "name": "virtual_cores_assigned", + "type": "TypeInt", + "computed": true + } + } + } + ], + "ibm_pi_key": [ + { + "name": "sshkey", + "type": "TypeString", + "secure": true, + "computed": true, + "deprecated": "This field is deprecated, use ssh_key instead" + }, + { + "name": "pi_key_name", + "type": "TypeString", + "description": "SSH key name for a pcloud tenant", + "required": true + }, + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "creation_date", + "type": "TypeString", + "description": "Date of sshkey creation", + "computed": true + }, + { + "name": "ssh_key", + "type": "TypeString", + "description": "SSH RSA key", + "secure": true, + "computed": true + } + ], + "ibm_pi_keys": [ + { + "name": "keys", + "type": "TypeList", + "description": "SSH Keys", + "computed": true, + "elem": { + "creation_date": { + "name": "creation_date", + "type": "TypeString", + "description": "Date of SSH key creation", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "User defined name for the SSH key", + "computed": true + }, + "ssh_key": { + "name": "ssh_key", + "type": "TypeString", + "description": "SSH RSA key", + "computed": true + } + } + }, + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "description": "PI cloud instance ID", + "required": true + } + ], + "ibm_pi_network": [ + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "cidr", + "type": "TypeString", + "computed": true + }, + { + "name": "gateway", + "type": "TypeString", + "computed": true + }, + { + "name": "used_ip_percent", + "type": "TypeFloat", + "computed": true + }, + { + "name": "dns", + "type": "TypeSet", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "jumbo", + "type": "TypeBool", + "computed": true + }, + { + "name": "pi_network_name", + "type": "TypeString", + "description": "Network Name to be used for pvminstances", + "required": true + }, + { + "name": "type", + "type": "TypeString", + "computed": true + }, + { + "name": "vlan_id", + "type": "TypeInt", + "computed": true + }, + { + "name": "available_ip_count", + "type": "TypeFloat", + "computed": true + }, + { + "name": "used_ip_count", + "type": "TypeFloat", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "computed": true, + "deprecated": "This value is deprecated in favor ofpi_network_name" + } + ], + "ibm_pi_network_port": [ + { + "name": "pi_network_name", + "type": "TypeString", + "description": "Network Name to be used for pvminstances", + "required": true + }, + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "network_ports", + "type": "TypeList", + "computed": true, + "elem": { + "description": { + "name": "description", + "type": "TypeString", + "required": true + }, + "href": { + "name": "href", + "type": "TypeString", + "computed": true + }, + "ipaddress": { + "name": "ipaddress", + "type": "TypeString", + "optional": true, + "computed": true + }, + "macaddress": { + "name": "macaddress", + "type": "TypeString", + "computed": true + }, + "portid": { + "name": "portid", + "type": "TypeString", + "computed": true + }, + "public_ip": { + "name": "public_ip", + "type": "TypeString", + "computed": true + }, + "status": { + "name": "status", + "type": "TypeString", + "computed": true + } + } + } + ], + "ibm_pi_placement_group": [ + { + "name": "policy", + "type": "TypeString", + "computed": true + }, + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "members", + "type": "TypeList", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "pi_placement_group_name", + "type": "TypeString", + "required": true + } + ], + "ibm_pi_placement_groups": [ + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "description": "PI cloud instance ID", + "required": true + }, + { + "name": "placement_groups", + "type": "TypeList", + "computed": true, + "elem": { + "id": { + "name": "id", + "type": "TypeString", + "computed": true + }, + "members": { + "name": "members", + "type": "TypeList", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "name": { + "name": "name", + "type": "TypeString", + "computed": true + }, + "policy": { + "name": "policy", + "type": "TypeString", + "computed": true + } + } + } + ], + "ibm_pi_public_network": [ + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "name", + "type": "TypeString", + "computed": true + }, + { + "name": "type", + "type": "TypeString", + "computed": true + }, + { + "name": "vlan_id", + "type": "TypeInt", + "computed": true + } + ], + "ibm_pi_pvm_snapshots": [ + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "pi_instance_name", + "type": "TypeString", + "required": true + }, + { + "name": "pvm_snapshots", + "type": "TypeList", + "computed": true, + "elem": { + "action": { + "name": "action", + "type": "TypeString", + "computed": true + }, + "creation_date": { + "name": "creation_date", + "type": "TypeString", + "computed": true + }, + "description": { + "name": "description", + "type": "TypeString", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "computed": true + }, + "last_updated_date": { + "name": "last_updated_date", + "type": "TypeString", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "computed": true + }, + "percent_complete": { + "name": "percent_complete", + "type": "TypeInt", + "computed": true + }, + "status": { + "name": "status", + "type": "TypeString", + "computed": true + }, + "volume_snapshots": { + "name": "volume_snapshots", + "type": "TypeMap", + "computed": true + } + } + } + ], + "ibm_pi_sap_profile": [ + { + "name": "memory", + "type": "TypeInt", + "description": "Amount of memory (in GB)", + "computed": true + }, + { + "name": "type", + "type": "TypeString", + "description": "Type of profile", + "computed": true + }, + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "pi_sap_profile_id", + "type": "TypeString", + "description": "SAP Profile ID", + "required": true + }, + { + "name": "certified", + "type": "TypeBool", + "description": "Has certification been performed on profile", + "computed": true + }, + { + "name": "cores", + "type": "TypeInt", + "description": "Amount of cores", + "computed": true + } + ], + "ibm_pi_sap_profiles": [ + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "profiles", + "type": "TypeList", + "computed": true, + "elem": { + "certified": { + "name": "certified", + "type": "TypeBool", + "description": "Has certification been performed on profile", + "computed": true + }, + "cores": { + "name": "cores", + "type": "TypeInt", + "description": "Amount of cores", + "computed": true + }, + "memory": { + "name": "memory", + "type": "TypeInt", + "description": "Amount of memory (in GB)", + "computed": true + }, + "profile_id": { + "name": "profile_id", + "type": "TypeString", + "description": "SAP Profile ID", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "Type of profile", + "computed": true + } + } + } + ], + "ibm_pi_shared_processor_pool": [ + { + "name": "status", + "type": "TypeString", + "description": "The status of the shared processor pool", + "computed": true + }, + { + "name": "status_detail", + "type": "TypeString", + "description": "The status details of the shared processor pool", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "Name of the shared processor pool", + "computed": true + }, + { + "name": "host_id", + "type": "TypeInt", + "description": "The host ID where the shared processor pool resides", + "computed": true + }, + { + "name": "reserved_cores", + "type": "TypeInt", + "description": "The amount of reserved cores for the shared processor pool", + "computed": true + }, + { + "name": "allocated_cores", + "type": "TypeFloat", + "description": "Shared processor pool allocated cores", + "computed": true + }, + { + "name": "pi_shared_processor_pool_id", + "type": "TypeString", + "required": true + }, + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "description": "PI cloud instance ID", + "required": true + }, + { + "name": "available_cores", + "type": "TypeFloat", + "description": "Shared processor pool available cores", + "computed": true + }, + { + "name": "instances", + "type": "TypeList", + "description": "List of server instances deployed in the shared processor pool", + "computed": true, + "elem": { + "availability_zone": { + "name": "availability_zone", + "type": "TypeString", + "description": "Availability zone for the server instances", + "optional": true, + "computed": true + }, + "cpus": { + "name": "cpus", + "type": "TypeInt", + "description": "The amount of cpus for the server instance", + "optional": true, + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The server instance ID", + "optional": true, + "computed": true + }, + "memory": { + "name": "memory", + "type": "TypeInt", + "description": "The amount of memory for the server instance", + "optional": true, + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The server instance name", + "optional": true, + "computed": true + }, + "status": { + "name": "status", + "type": "TypeString", + "description": "Status of the server", + "optional": true, + "computed": true + }, + "uncapped": { + "name": "uncapped", + "type": "TypeBool", + "description": "Identifies if uncapped or not", + "optional": true, + "computed": true + }, + "vcpus": { + "name": "vcpus", + "type": "TypeFloat", + "description": "The amout of vcpus for the server instance", + "optional": true, + "computed": true + } + } + } + ], + "ibm_pi_shared_processor_pools": [ + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "description": "PI cloud instance ID", + "required": true + }, + { + "name": "shared_processor_pools", + "type": "TypeList", + "computed": true, + "elem": { + "allocated_cores": { + "name": "allocated_cores", + "type": "TypeFloat", + "computed": true + }, + "available_cores": { + "name": "available_cores", + "type": "TypeInt", + "computed": true + }, + "host_id": { + "name": "host_id", + "type": "TypeInt", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "computed": true + }, + "reserved_cores": { + "name": "reserved_cores", + "type": "TypeInt", + "computed": true + }, + "shared_processor_pool_id": { + "name": "shared_processor_pool_id", + "type": "TypeString", + "computed": true + }, + "status": { + "name": "status", + "type": "TypeString", + "computed": true + }, + "status_detail": { + "name": "status_detail", + "type": "TypeString", + "computed": true + } + } + } + ], + "ibm_pi_spp_placement_group": [ + { + "name": "pi_spp_placement_group_id", + "type": "TypeString", + "required": true + }, + { + "name": "name", + "type": "TypeString", + "computed": true + }, + { + "name": "policy", + "type": "TypeString", + "computed": true + }, + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "members", + "type": "TypeList", + "computed": true, + "elem": { + "type": "TypeString" + } + } + ], + "ibm_pi_spp_placement_groups": [ + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "description": "PI cloud instance ID", + "required": true + }, + { + "name": "spp_placement_groups", + "type": "TypeList", + "computed": true, + "elem": { + "members": { + "name": "members", + "type": "TypeList", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "name": { + "name": "name", + "type": "TypeString", + "computed": true + }, + "policy": { + "name": "policy", + "type": "TypeString", + "computed": true + }, + "spp_placement_group_id": { + "name": "spp_placement_group_id", + "type": "TypeString", + "computed": true + } + } + } + ], + "ibm_pi_storage_pool_capacity": [ + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "pi_storage_pool", + "type": "TypeString", + "description": "Storage pool name", + "required": true + }, + { + "name": "max_allocation_size", + "type": "TypeInt", + "description": "Maximum allocation storage size (GB)", + "computed": true + }, + { + "name": "storage_type", + "type": "TypeString", + "description": "Storage type of the storage pool", + "computed": true + }, + { + "name": "total_capacity", + "type": "TypeInt", + "description": "Total pool capacity (GB)", + "computed": true + } + ], + "ibm_pi_storage_pools_capacity": [ + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "maximum_storage_allocation", + "type": "TypeMap", + "description": "Maximum storage allocation", + "computed": true + }, + { + "name": "storage_pools_capacity", + "type": "TypeList", + "description": "Storage pools capacity", + "computed": true, + "elem": { + "max_allocation_size": { + "name": "max_allocation_size", + "type": "TypeInt", + "description": "Maximum allocation storage size (GB)", + "computed": true + }, + "pool_name": { + "name": "pool_name", + "type": "TypeString", + "description": "Pool name", + "computed": true + }, + "storage_type": { + "name": "storage_type", + "type": "TypeString", + "description": "Storage type of the storage pool", + "computed": true + }, + "total_capacity": { + "name": "total_capacity", + "type": "TypeInt", + "description": "Total pool capacity (GB)", + "computed": true + } + } + } + ], + "ibm_pi_storage_type_capacity": [ + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "pi_storage_type", + "type": "TypeString", + "description": "Storage type name", + "required": true + }, + { + "name": "maximum_storage_allocation", + "type": "TypeMap", + "description": "Maximum storage allocation", + "computed": true + }, + { + "name": "storage_pools_capacity", + "type": "TypeList", + "description": "Storage pools capacity", + "computed": true, + "elem": { + "max_allocation_size": { + "name": "max_allocation_size", + "type": "TypeInt", + "description": "Maximum allocation storage size (GB)", + "computed": true + }, + "pool_name": { + "name": "pool_name", + "type": "TypeString", + "description": "Pool name", + "computed": true + }, + "storage_type": { + "name": "storage_type", + "type": "TypeString", + "description": "Storage type of the storage pool", + "computed": true + }, + "total_capacity": { + "name": "total_capacity", + "type": "TypeInt", + "description": "Total pool capacity (GB)", + "computed": true + } + } + } + ], + "ibm_pi_storage_types_capacity": [ + { + "name": "storage_types_capacity", + "type": "TypeList", + "description": "Storage types capacity", + "computed": true, + "elem": { + "maximum_storage_allocation": { + "name": "maximum_storage_allocation", + "type": "TypeMap", + "description": "Maximum storage allocation", + "computed": true + }, + "storage_pools_capacity": { + "name": "storage_pools_capacity", + "type": "TypeList", + "description": "Storage pools capacity", + "computed": true, + "elem": { + "max_allocation_size": { + "name": "max_allocation_size", + "type": "TypeInt", + "description": "Maximum allocation storage size (GB)", + "computed": true + }, + "pool_name": { + "name": "pool_name", + "type": "TypeString", + "description": "Pool name", + "computed": true + }, + "storage_type": { + "name": "storage_type", + "type": "TypeString", + "description": "Storage type of the storage pool", + "computed": true + }, + "total_capacity": { + "name": "total_capacity", + "type": "TypeInt", + "description": "Total pool capacity (GB)", + "computed": true + } + } + }, + "storage_type": { + "name": "storage_type", + "type": "TypeString", + "description": "The storage type", + "computed": true + } + } + }, + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "maximum_storage_allocation", + "type": "TypeMap", + "description": "Maximum storage allocation", + "computed": true + } + ], + "ibm_pi_system_pools": [ + { + "name": "system_pools", + "type": "TypeList", + "description": "List of available system pools within a particular DataCenter", + "computed": true, + "elem": { + "capacity": { + "name": "capacity", + "type": "TypeMap", + "description": "Advertised capacity cores and memory (GB)", + "computed": true + }, + "core_memory_ratio": { + "name": "core_memory_ratio", + "type": "TypeFloat", + "description": "Processor to Memory (GB) Ratio", + "computed": true + }, + "max_available": { + "name": "max_available", + "type": "TypeMap", + "description": "Maximum configurable cores and memory (GB) (aggregated from all hosts)", + "computed": true + }, + "max_cores_available": { + "name": "max_cores_available", + "type": "TypeMap", + "description": "Maximum configurable cores available combined with available memory of that host", + "computed": true + }, + "max_memory_available": { + "name": "max_memory_available", + "type": "TypeMap", + "description": "Maximum configurable memory available combined with available cores of that host", + "computed": true + }, + "shared_core_ratio": { + "name": "shared_core_ratio", + "type": "TypeMap", + "description": "The min-max-default allocation percentage of shared core per vCPU", + "computed": true + }, + "system_pool_name": { + "name": "system_pool_name", + "type": "TypeString", + "description": "The system pool name", + "computed": true + }, + "systems": { + "name": "systems", + "type": "TypeList", + "description": "The DataCenter list of servers and their available resources", + "computed": true, + "elem": { + "cores": { + "name": "cores", + "type": "TypeString", + "description": "The host available Processor units", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The host identifier", + "computed": true + }, + "memory": { + "name": "memory", + "type": "TypeString", + "description": "The host available RAM memory in GiB", + "computed": true + } + } + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "Type of system hardware", + "computed": true + } + } + }, + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + } + ], + "ibm_pi_tenant": [ + { + "name": "cloud_instances", + "type": "TypeSet", + "computed": true, + "elem": { + "cloud_instance_id": { + "name": "cloud_instance_id", + "type": "TypeString", + "computed": true + }, + "region": { + "name": "region", + "type": "TypeString", + "computed": true + } + } + }, + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "creation_date", + "type": "TypeString", + "computed": true + }, + { + "name": "enabled", + "type": "TypeBool", + "computed": true + }, + { + "name": "tenant_name", + "type": "TypeString", + "computed": true + } + ], + "ibm_pi_volume": [ + { + "name": "auxiliary", + "type": "TypeBool", + "description": "true if volume is auxiliary otherwise false", + "computed": true + }, + { + "name": "auxiliary_volume_name", + "type": "TypeString", + "description": "Indicates auxiliary volume name", + "computed": true + }, + { + "name": "size", + "type": "TypeInt", + "computed": true + }, + { + "name": "bootable", + "type": "TypeBool", + "computed": true + }, + { + "name": "replication_type", + "type": "TypeString", + "description": "Replication type(metro,global)", + "computed": true + }, + { + "name": "replication_status", + "type": "TypeString", + "description": "Replication status of a volume", + "computed": true + }, + { + "name": "consistency_group_name", + "type": "TypeString", + "description": "Consistency Group Name if volume is a part of volume group", + "computed": true + }, + { + "name": "primary_role", + "type": "TypeString", + "description": "Indicates whether master/aux volume is playing the primary role", + "computed": true + }, + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "state", + "type": "TypeString", + "computed": true + }, + { + "name": "shareable", + "type": "TypeBool", + "computed": true + }, + { + "name": "mirroring_state", + "type": "TypeString", + "description": "Mirroring state for replication enabled volume", + "computed": true + }, + { + "name": "volume_pool", + "type": "TypeString", + "computed": true + }, + { + "name": "wwn", + "type": "TypeString", + "computed": true + }, + { + "name": "replication_enabled", + "type": "TypeBool", + "description": "Indicates if the volume should be replication enabled or not", + "computed": true + }, + { + "name": "master_volume_name", + "type": "TypeString", + "description": "Indicates master volume name", + "computed": true + }, + { + "name": "pi_volume_name", + "type": "TypeString", + "description": "Volume Name to be used for pvminstances", + "required": true + }, + { + "name": "disk_type", + "type": "TypeString", + "computed": true + }, + { + "name": "group_id", + "type": "TypeString", + "description": "Volume Group ID", + "computed": true + } + ], + "ibm_pi_volume_flash_copy_mappings": [ + { + "name": "flash_copy_mappings", + "type": "TypeList", + "computed": true, + "elem": { + "copy_rate": { + "name": "copy_rate", + "type": "TypeInt", + "description": "Indicates the rate of flash copy operation of a volume", + "computed": true + }, + "flash_copy_name": { + "name": "flash_copy_name", + "type": "TypeString", + "description": "Indicates flash copy name of the volume", + "computed": true + }, + "progress": { + "name": "progress", + "type": "TypeInt", + "description": "Indicates the progress of flash copy operation", + "computed": true + }, + "source_volume_name": { + "name": "source_volume_name", + "type": "TypeString", + "description": "Indicates name of the source volume", + "computed": true + }, + "start_time": { + "name": "start_time", + "type": "TypeString", + "description": "Indicates the start time of flash copy operation", + "computed": true + }, + "status": { + "name": "status", + "type": "TypeString", + "description": "Copy status of a volume", + "computed": true + }, + "target_volume_name": { + "name": "target_volume_name", + "type": "TypeString", + "description": "Indicates name of the target volume", + "computed": true + } + } + }, + { + "name": "pi_volume_id", + "type": "TypeString", + "description": "Volume ID", + "required": true + }, + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + } + ], + "ibm_pi_volume_group": [ + { + "name": "status_description_errors", + "type": "TypeSet", + "computed": true, + "elem": { + "key": { + "name": "key", + "type": "TypeString", + "computed": true + }, + "message": { + "name": "message", + "type": "TypeString", + "computed": true + }, + "volume_ids": { + "name": "volume_ids", + "type": "TypeList", + "computed": true, + "elem": { + "type": "TypeString" + } + } + } + }, + { + "name": "pi_volume_group_id", + "type": "TypeString", + "description": "ID or Name of the volume group", + "required": true + }, + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "volume_group_name", + "type": "TypeString", + "description": "Volume group name", + "computed": true + }, + { + "name": "status", + "type": "TypeString", + "computed": true + }, + { + "name": "replication_status", + "type": "TypeString", + "computed": true + }, + { + "name": "consistency_group_name", + "type": "TypeString", + "computed": true + } + ], + "ibm_pi_volume_group_details": [ + { + "name": "consistency_group_name", + "type": "TypeString", + "computed": true }, { - "name": "keys", - "type": "TypeList", + "name": "status_description_errors", + "type": "TypeSet", "computed": true, "elem": { - "crn": { - "name": "crn", - "type": "TypeString", - "computed": true - }, - "id": { - "name": "id", + "key": { + "name": "key", "type": "TypeString", "computed": true }, - "name": { - "name": "name", + "message": { + "name": "message", "type": "TypeString", "computed": true }, - "standard_key": { - "name": "standard_key", - "type": "TypeBool", - "computed": true + "volume_ids": { + "name": "volume_ids", + "type": "TypeList", + "computed": true, + "elem": { + "type": "TypeString" + } } } }, { - "name": "key_protect_id", - "type": "TypeString", - "required": true - } - ], - "ibm_lbaas": [ - { - "name": "server_instances", + "name": "volume_ids", "type": "TypeList", "computed": true, "elem": { - "member_id": { - "name": "member_id", - "type": "TypeString", - "computed": true - }, - "private_ip_address": { - "name": "private_ip_address", - "type": "TypeString", - "computed": true - }, - "status": { - "name": "status", - "type": "TypeString", - "computed": true - }, - "weight": { - "name": "weight", - "type": "TypeInt", - "computed": true - } + "type": "TypeString" } }, { - "name": "vip", + "name": "pi_volume_group_id", "type": "TypeString", - "computed": true + "description": "Name of the volume group", + "required": true }, { - "name": "server_instances_up", - "type": "TypeInt", + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "volume_group_name", + "type": "TypeString", + "description": "Volume group name", "computed": true }, { - "name": "server_instances_down", - "type": "TypeInt", + "name": "status", + "type": "TypeString", "computed": true }, { - "name": "active_connections", - "type": "TypeInt", + "name": "replication_status", + "type": "TypeString", "computed": true + } + ], + "ibm_pi_volume_group_remote_copy_relationships": [ + { + "name": "pi_volume_group_id", + "type": "TypeString", + "description": "Volume group ID", + "required": true }, { - "name": "protocols", + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true + }, + { + "name": "remote_copy_relationships", "type": "TypeList", + "description": "List of remote copy relationships", "computed": true, "elem": { - "backend_port": { - "name": "backend_port", - "type": "TypeInt", - "computed": true - }, - "backend_protocol": { - "name": "backend_protocol", + "auxiliary_changed_volume_name": { + "name": "auxiliary_changed_volume_name", "type": "TypeString", + "description": "Name of the volume that is acting as the auxiliary change volume for the relationship", "computed": true }, - "frontend_port": { - "name": "frontend_port", - "type": "TypeInt", + "auxiliary_volume_name": { + "name": "auxiliary_volume_name", + "type": "TypeString", + "description": "Auxiliary volume name at storage host level", "computed": true }, - "frontend_protocol": { - "name": "frontend_protocol", + "consistency_group_name": { + "name": "consistency_group_name", "type": "TypeString", + "description": "Consistency Group Name if volume is a part of volume group", "computed": true }, - "load_balancing_method": { - "name": "load_balancing_method", + "copy_type": { + "name": "copy_type", "type": "TypeString", + "description": "Indicates the copy type.", "computed": true }, - "max_conn": { - "name": "max_conn", - "type": "TypeInt", + "cycling_mode": { + "name": "cycling_mode", + "type": "TypeString", + "description": "Indicates the type of cycling mode used.", "computed": true }, - "protocol_id": { - "name": "protocol_id", + "freeze_time": { + "name": "freeze_time", "type": "TypeString", + "description": "Freeze time of remote copy relationship", "computed": true }, - "session_stickiness": { - "name": "session_stickiness", + "master_changed_volume_name": { + "name": "master_changed_volume_name", "type": "TypeString", + "description": "Name of the volume that is acting as the master change volume for the relationship", "computed": true }, - "tls_certificate_id": { - "name": "tls_certificate_id", - "type": "TypeInt", - "computed": true - } - } - }, - { - "name": "health_monitors", - "type": "TypeList", - "computed": true, - "elem": { - "interval": { - "name": "interval", - "type": "TypeInt", + "master_volume_name": { + "name": "master_volume_name", + "type": "TypeString", + "description": "Master volume name at storage host level", "computed": true }, - "max_retries": { - "name": "max_retries", - "type": "TypeInt", + "name": { + "name": "name", + "type": "TypeString", + "description": "Remote copy relationship name", "computed": true }, - "monitor_id": { - "name": "monitor_id", + "primary_role": { + "name": "primary_role", "type": "TypeString", + "description": "Indicates whether master/aux volume is playing the primary role", "computed": true }, - "port": { - "name": "port", + "progress": { + "name": "progress", "type": "TypeInt", + "description": "Indicates the relationship progress", "computed": true }, - "protocol": { - "name": "protocol", + "remote_copy_id": { + "name": "remote_copy_id", "type": "TypeString", + "description": "Remote copy relationship ID", "computed": true }, - "timeout": { - "name": "timeout", - "type": "TypeInt", + "state": { + "name": "state", + "type": "TypeString", + "description": "Indicates the relationship state", "computed": true }, - "url_path": { - "name": "url_path", + "synchronized": { + "name": "synchronized", "type": "TypeString", + "description": "Indicates whether the relationship is synchronized", "computed": true } } - }, + } + ], + "ibm_pi_volume_group_storage_details": [ { - "name": "name", + "name": "pi_cloud_instance_id", "type": "TypeString", "required": true }, { - "name": "status", + "name": "cycle_period_seconds", + "type": "TypeInt", + "description": "Indicates the minimum period in seconds between multiple cycles", + "computed": true + }, + { + "name": "primary_role", "type": "TypeString", + "description": "Indicates whether master/aux volume is playing the primary role", "computed": true }, { - "name": "datacenter", + "name": "replication_type", "type": "TypeString", + "description": "Type of replication(metro,global)", "computed": true }, { - "name": "ssl_ciphers", - "type": "TypeSet", + "name": "state", + "type": "TypeString", + "description": "Indicates the relationship state", + "computed": true + }, + { + "name": "pi_volume_group_id", + "type": "TypeString", + "description": "Volume group ID", + "required": true + }, + { + "name": "cycling_mode", + "type": "TypeString", + "description": "Indicates the type of cycling mode used", + "computed": true + }, + { + "name": "number_of_volumes", + "type": "TypeInt", + "description": "Number of volumes in volume group", + "computed": true + }, + { + "name": "remote_copy_relationship_names", + "type": "TypeList", + "description": "List of remote-copy relationship names in a volume group", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "description", + "name": "synchronized", "type": "TypeString", + "description": "Indicates whether the relationship is synchronized", "computed": true }, { - "name": "type", + "name": "consistency_group_name", "type": "TypeString", - "computed": true - }, - { - "name": "use_system_public_ip_pool", - "type": "TypeBool", + "description": "The name of consistency group at storage controller level", "computed": true } ], - "ibm_metrics_router_routes": [ + "ibm_pi_volume_groups": [ { - "name": "name", + "name": "pi_cloud_instance_id", "type": "TypeString", - "description": "The name of the route.", - "optional": true + "required": true }, { - "name": "routes", + "name": "volume_groups", "type": "TypeList", - "description": "A list of route resources.", "computed": true, "elem": { - "created_at": { - "name": "created_at", + "consistency_group_name": { + "name": "consistency_group_name", "type": "TypeString", - "description": "The timestamp of the route creation time.", "computed": true }, - "crn": { - "name": "crn", + "id": { + "name": "id", "type": "TypeString", - "description": "The crn of the route resource.", "computed": true }, - "id": { - "name": "id", + "replication_status": { + "name": "replication_status", "type": "TypeString", - "description": "The UUID of the route resource.", "computed": true }, - "name": { - "name": "name", + "status": { + "name": "status", "type": "TypeString", - "description": "The name of the route.", "computed": true }, - "rules": { - "name": "rules", - "type": "TypeList", - "description": "The routing rules that will be evaluated in their order of the array. Once a rule is matched, the remaining rules in the route definition will be skipped.", + "status_description_errors": { + "name": "status_description_errors", + "type": "TypeSet", "computed": true, "elem": { - "action": { - "name": "action", + "key": { + "name": "key", "type": "TypeString", - "description": "The action if the inclusion_filters matches, default is `send` action.", "computed": true }, - "inclusion_filters": { - "name": "inclusion_filters", - "type": "TypeList", - "description": "A list of conditions to be satisfied for routing metrics to pre-defined target.", - "computed": true, - "elem": { - "operand": { - "name": "operand", - "type": "TypeString", - "description": "Part of CRN that can be compared with values.", - "computed": true - }, - "operator": { - "name": "operator", - "type": "TypeString", - "description": "The operation to be performed between operand and the provided values. 'is' to be used with one value and 'in' can support upto 20 values in the array.", - "computed": true - }, - "values": { - "name": "values", - "type": "TypeList", - "description": "The provided string values of the operand to be compared with.", - "computed": true, - "elem": { - "type": "TypeString" - } - } - } + "message": { + "name": "message", + "type": "TypeString", + "computed": true }, - "targets": { - "name": "targets", + "volume_ids": { + "name": "volume_ids", "type": "TypeList", - "description": "The target ID List. All the metrics will be sent to all targets listed in the rule. You can include targets from other regions.", "computed": true, "elem": { - "crn": { - "name": "crn", - "type": "TypeString", - "description": "The CRN of a pre-defined metrics-router target.", - "computed": true - }, - "id": { - "name": "id", - "type": "TypeString", - "description": "The target uuid for a pre-defined metrics router target.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "The name of a pre-defined metrics-router target.", - "computed": true - }, - "target_type": { - "name": "target_type", - "type": "TypeString", - "description": "The type of the target.", - "computed": true - } + "type": "TypeString" } } } }, - "updated_at": { - "name": "updated_at", + "volume_group_name": { + "name": "volume_group_name", "type": "TypeString", - "description": "The timestamp of the route last updated time.", "computed": true } } } ], - "ibm_metrics_router_targets": [ + "ibm_pi_volume_groups_details": [ { - "name": "name", + "name": "pi_cloud_instance_id", "type": "TypeString", - "description": "The name of the target resource.", - "optional": true + "required": true }, { - "name": "targets", + "name": "volume_groups", "type": "TypeList", - "description": "A list of target resources.", "computed": true, "elem": { - "created_at": { - "name": "created_at", - "type": "TypeString", - "description": "The timestamp of the target creation time.", - "computed": true - }, - "crn": { - "name": "crn", - "type": "TypeString", - "description": "The crn of the target resource.", - "computed": true - }, - "destination_crn": { - "name": "destination_crn", + "consistency_group_name": { + "name": "consistency_group_name", "type": "TypeString", - "description": "The CRN of the destination service instance or resource.", "computed": true }, "id": { "name": "id", "type": "TypeString", - "description": "The UUID of the target resource.", "computed": true }, - "name": { - "name": "name", + "replication_status": { + "name": "replication_status", "type": "TypeString", - "description": "The name of the target resource.", "computed": true }, - "region": { - "name": "region", + "status": { + "name": "status", "type": "TypeString", - "description": "Include this optional field if you used it to create a target in a different region other than the one you are connected.", "computed": true }, - "target_type": { - "name": "target_type", - "type": "TypeString", - "description": "The type of the target.", - "computed": true + "status_description_errors": { + "name": "status_description_errors", + "type": "TypeSet", + "computed": true, + "elem": { + "key": { + "name": "key", + "type": "TypeString", + "computed": true + }, + "message": { + "name": "message", + "type": "TypeString", + "computed": true + }, + "volume_ids": { + "name": "volume_ids", + "type": "TypeList", + "computed": true, + "elem": { + "type": "TypeString" + } + } + } }, - "updated_at": { - "name": "updated_at", + "volume_group_name": { + "name": "volume_group_name", "type": "TypeString", - "description": "The timestamp of the target last updated time.", "computed": true + }, + "volume_ids": { + "name": "volume_ids", + "type": "TypeList", + "computed": true, + "elem": { + "type": "TypeString" + } } } } ], - "ibm_network_vlan": [ + "ibm_pi_volume_onboarding": [ { - "name": "id", + "name": "description", + "type": "TypeString", + "description": "Description of the volume onboarding operation", + "computed": true + }, + { + "name": "input_volumes", + "type": "TypeList", + "description": "List of volumes requested to be onboarded", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "progress", "type": "TypeInt", + "description": "Indicates the progress of volume onboarding operation", "computed": true }, { - "name": "name", + "name": "results_onboarded_volumes", + "type": "TypeList", + "description": "List of volumes which are onboarded successfully", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "status", "type": "TypeString", - "optional": true, + "description": "Indicates the status of volume onboarding operation", "computed": true }, { - "name": "number", - "type": "TypeInt", - "optional": true, - "computed": true + "name": "pi_volume_onboarding_id", + "type": "TypeString", + "description": "Volume onboarding ID", + "required": true }, { - "name": "router_hostname", + "name": "pi_cloud_instance_id", "type": "TypeString", - "optional": true, + "required": true + }, + { + "name": "create_time", + "type": "TypeString", + "description": "Indicates the create time of volume onboarding operation", "computed": true }, { - "name": "virtual_guests", + "name": "results_volume_onboarding_failures", "type": "TypeList", "computed": true, "elem": { - "domain": { - "name": "domain", - "type": "TypeString", - "computed": true - }, - "hostname": { - "name": "hostname", + "failure_message": { + "name": "failure_message", "type": "TypeString", + "description": "The failure reason for the volumes which have failed to be onboarded", "computed": true }, - "id": { - "name": "id", - "type": "TypeInt", - "computed": true + "volumes": { + "name": "volumes", + "type": "TypeList", + "description": "List of volumes which have failed to be onboarded", + "computed": true, + "elem": { + "type": "TypeString" + } } } + } + ], + "ibm_pi_volume_onboardings": [ + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true }, { - "name": "subnets", + "name": "onboardings", "type": "TypeList", + "description": "The list of volume onboardings", "computed": true, "elem": { - "cidr": { - "name": "cidr", - "type": "TypeInt", - "computed": true - }, - "gateway": { - "name": "gateway", + "description": { + "name": "description", "type": "TypeString", + "description": "Description of the volume onboarding operation", "computed": true }, "id": { "name": "id", - "type": "TypeInt", - "computed": true - }, - "subnet": { - "name": "subnet", "type": "TypeString", + "description": "Indicates the volume onboarding operation id", "computed": true }, - "subnet_size": { - "name": "subnet_size", - "type": "TypeInt", - "computed": true + "input_volumes": { + "name": "input_volumes", + "type": "TypeList", + "description": "List of volumes requested to be onboarded", + "computed": true, + "elem": { + "type": "TypeString" + } }, - "subnet_type": { - "name": "subnet_type", + "status": { + "name": "status", "type": "TypeString", + "description": "Indicates the status of volume onboarding operation", "computed": true } } } ], - "ibm_org": [ - { - "name": "name", - "type": "TypeString", - "description": "Org name, for example myorg@domain", - "optional": true - }, + "ibm_pi_volume_remote_copy_relationship": [ { - "name": "org", + "name": "auxiliary_volume_name", "type": "TypeString", - "description": "Org name, for example myorg@domain", - "optional": true, - "deprecated": "use name instead" - } - ], - "ibm_org_quota": [ - { - "name": "total_service_keys", - "type": "TypeInt", - "description": "Defines the total service keys for organization.", + "description": "Auxiliary volume name at storage host level", "computed": true }, { - "name": "total_reserved_route_ports", - "type": "TypeInt", - "description": "Defines the number of reserved route ports for organization.", + "name": "copy_type", + "type": "TypeString", + "description": "Indicates the copy type.", "computed": true }, { "name": "name", "type": "TypeString", - "description": "Org quota name, for example qIBM", - "required": true - }, - { - "name": "total_routes", - "type": "TypeInt", - "description": "Defines the total route for organization.", - "computed": true - }, - { - "name": "trial_db_allowed", - "type": "TypeBool", - "description": "Defines trial db are allowed for organization.", - "computed": true - }, - { - "name": "app_tasks_limit", - "type": "TypeInt", - "description": "Defines the total app task limit for organization.", + "description": "Remote copy relationship name", "computed": true }, { - "name": "app_instance_limit", - "type": "TypeInt", - "description": "Defines the total app instance limit for organization.", + "name": "primary_role", + "type": "TypeString", + "description": "Indicates whether master/aux volume is playing the primary role", "computed": true }, { - "name": "total_private_domains", - "type": "TypeInt", - "description": "Defines the total private domain limit for organization.v", - "computed": true + "name": "pi_cloud_instance_id", + "type": "TypeString", + "required": true }, { - "name": "non_basic_services_allowed", - "type": "TypeBool", - "description": "Define non basic services are allowed for organization.", + "name": "cycling_mode", + "type": "TypeString", + "description": "Indicates the type of cycling mode used.", "computed": true }, { - "name": "total_services", - "type": "TypeInt", - "description": "Defines the total services for organization.", + "name": "freeze_time", + "type": "TypeString", + "description": "Freeze time of remote copy relationship", "computed": true }, { - "name": "memory_limit", - "type": "TypeInt", - "description": "Defines the total memory limit for organization.", + "name": "auxiliary_changed_volume_name", + "type": "TypeString", + "description": "Name of the volume that is acting as the auxiliary change volume for the relationship", "computed": true }, { - "name": "instance_memory_limit", - "type": "TypeInt", - "description": "Defines the total instance memory limit for organization.", - "computed": true - } - ], - "ibm_pi_catalog_images": [ - { - "name": "pi_cloud_instance_id", + "name": "master_volume_name", "type": "TypeString", - "required": true - }, - { - "name": "sap", - "type": "TypeBool", - "optional": true - }, - { - "name": "vtl", - "type": "TypeBool", - "optional": true + "description": "Master volume name at storage host level", + "computed": true }, { - "name": "images", - "type": "TypeList", - "computed": true, - "elem": { - "architecture": { - "name": "architecture", - "type": "TypeString", - "computed": true - }, - "container_format": { - "name": "container_format", - "type": "TypeString", - "computed": true - }, - "creation_date": { - "name": "creation_date", - "type": "TypeString", - "computed": true - }, - "description": { - "name": "description", - "type": "TypeString", - "computed": true - }, - "disk_format": { - "name": "disk_format", - "type": "TypeString", - "computed": true - }, - "endianness": { - "name": "endianness", - "type": "TypeString", - "computed": true - }, - "href": { - "name": "href", - "type": "TypeString", - "computed": true - }, - "hypervisor_type": { - "name": "hypervisor_type", - "type": "TypeString", - "computed": true - }, - "image_id": { - "name": "image_id", - "type": "TypeString", - "computed": true - }, - "image_type": { - "name": "image_type", - "type": "TypeString", - "computed": true - }, - "last_update_date": { - "name": "last_update_date", - "type": "TypeString", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "computed": true - }, - "operating_system": { - "name": "operating_system", - "type": "TypeString", - "computed": true - }, - "state": { - "name": "state", - "type": "TypeString", - "computed": true - }, - "storage_pool": { - "name": "storage_pool", - "type": "TypeString", - "computed": true - }, - "storage_type": { - "name": "storage_type", - "type": "TypeString", - "computed": true - } - } - } - ], - "ibm_pi_cloud_connection": [ - { - "name": "gre_destination_address", + "name": "state", "type": "TypeString", - "description": "GRE destination IP address", + "description": "Indicates the relationship state", "computed": true }, { - "name": "gre_source_address", + "name": "synchronized", "type": "TypeString", - "description": "GRE auto-assigned source IP address", + "description": "Indicates whether the relationship is synchronized", "computed": true }, { - "name": "pi_cloud_connection_name", + "name": "pi_volume_id", "type": "TypeString", - "description": "Cloud Connection Name to be used", + "description": "Volume name", "required": true }, { - "name": "global_routing", - "type": "TypeBool", + "name": "consistency_group_name", + "type": "TypeString", + "description": "Consistency Group Name if volume is a part of volume group", "computed": true }, { - "name": "vpc_crns", - "type": "TypeSet", - "description": "Set of VPCs attached to this cloud connection", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "cycle_period_seconds", + "type": "TypeInt", + "description": "Indicates the minimum period in seconds between multiple cycles", + "computed": true }, { - "name": "ibm_ip_address", + "name": "master_changed_volume_name", "type": "TypeString", + "description": "Name of the volume that is acting as the master change volume for the relationship", "computed": true }, { - "name": "user_ip_address", - "type": "TypeString", + "name": "progress", + "type": "TypeInt", + "description": "Indicates the relationship progress", "computed": true }, { - "name": "port", + "name": "remote_copy_id", "type": "TypeString", + "description": "Remote copy relationship ID", "computed": true - }, + } + ], + "ibm_pn_application_chrome": [ { - "name": "networks", - "type": "TypeSet", - "description": "Set of Networks attached to this cloud connection", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "guid", + "type": "TypeString", + "description": "Unique guid of the application using the push service.", + "required": true }, { - "name": "vpc_enabled", - "type": "TypeBool", - "description": "Enable VPC for this cloud connection", + "name": "server_key", + "type": "TypeString", + "description": "A server key that gives the push service an authorized access to Google services that is used for Chrome Web Push.", "computed": true }, { - "name": "connection_mode", + "name": "web_site_url", "type": "TypeString", - "description": "Type of service the gateway is attached to", + "description": "The URL of the WebSite / WebApp that should be permitted to subscribe to WebPush.", "computed": true - }, + } + ], + "ibm_project_event_notification": [ { - "name": "speed", - "type": "TypeInt", - "computed": true + "name": "project_id", + "type": "TypeString", + "description": "The unique project ID.", + "required": true }, { - "name": "status", + "name": "name", "type": "TypeString", + "description": "The project name.", "computed": true }, { - "name": "classic_enabled", - "type": "TypeBool", - "description": "Enable classic endpoint destination", + "name": "description", + "type": "TypeString", + "description": "A project descriptive text.", "computed": true }, { - "name": "pi_cloud_instance_id", + "name": "crn", "type": "TypeString", - "required": true - }, - { - "name": "metered", - "type": "TypeBool", + "description": "An IBM Cloud resource name, which uniquely identifies a resource.", + "cloud_data_type": "crn", "computed": true - } - ], - "ibm_pi_cloud_connections": [ - { - "name": "pi_cloud_instance_id", - "type": "TypeString", - "required": true }, { - "name": "connections", + "name": "configs", "type": "TypeList", + "description": "The project configurations.", "computed": true, "elem": { - "classic_enabled": { - "name": "classic_enabled", - "type": "TypeBool", - "description": "Enable classic endpoint destination", - "computed": true - }, - "cloud_connection_id": { - "name": "cloud_connection_id", + "description": { + "name": "description", "type": "TypeString", + "description": "The project configuration description.", "computed": true }, - "connection_mode": { - "name": "connection_mode", + "id": { + "name": "id", "type": "TypeString", - "description": "Type of service the gateway is attached to", - "computed": true - }, - "global_routing": { - "name": "global_routing", - "type": "TypeBool", + "description": "The ID of the configuration. If this parameter is empty, an ID is automatically created for the configuration.", "computed": true }, - "gre_destination_address": { - "name": "gre_destination_address", - "type": "TypeString", - "description": "GRE destination IP address", - "computed": true + "input": { + "name": "input", + "type": "TypeList", + "description": "The outputs of a Schematics template property.", + "computed": true, + "elem": { + "name": { + "name": "name", + "type": "TypeString", + "description": "The variable name.", + "computed": true + }, + "required": { + "name": "required", + "type": "TypeBool", + "description": "Whether the variable is required or not.", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "The variable type.", + "computed": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "Can be any value - a string, number, boolean, array, or object.", + "computed": true + } + } }, - "gre_source_address": { - "name": "gre_source_address", - "type": "TypeString", - "description": "GRE auto-assigned source IP address", - "computed": true + "labels": { + "name": "labels", + "type": "TypeList", + "description": "A collection of configuration labels.", + "computed": true, + "elem": { + "type": "TypeString" + } }, - "ibm_ip_address": { - "name": "ibm_ip_address", + "locator_id": { + "name": "locator_id", "type": "TypeString", - "computed": true - }, - "metered": { - "name": "metered", - "type": "TypeBool", + "description": "A dotted value of catalogID.versionID.", "computed": true }, "name": { "name": "name", "type": "TypeString", + "description": "The configuration name.", "computed": true }, - "networks": { - "name": "networks", - "type": "TypeSet", - "description": "Set of Networks attached to this cloud connection", + "output": { + "name": "output", + "type": "TypeList", + "description": "The outputs of a Schematics template property.", "computed": true, "elem": { - "type": "TypeString" + "description": { + "name": "description", + "type": "TypeString", + "description": "A short explanation of the output value.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The variable name.", + "computed": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "Can be any value - a string, number, boolean, array, or object.", + "computed": true + } } }, - "port": { - "name": "port", - "type": "TypeString", - "computed": true - }, - "speed": { - "name": "speed", - "type": "TypeInt", - "computed": true - }, - "status": { - "name": "status", - "type": "TypeString", - "computed": true - }, - "user_ip_address": { - "name": "user_ip_address", - "type": "TypeString", - "computed": true - }, - "vpc_crns": { - "name": "vpc_crns", - "type": "TypeSet", - "description": "Set of VPCs attached to this cloud connection", + "setting": { + "name": "setting", + "type": "TypeList", + "description": "Schematics environment variables to use to deploy the configuration.", "computed": true, "elem": { - "type": "TypeString" + "name": { + "name": "name", + "type": "TypeString", + "description": "The name of the configuration setting.", + "computed": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "The value of the configuration setting.", + "computed": true + } } - }, - "vpc_enabled": { - "name": "vpc_enabled", - "type": "TypeBool", - "description": "Enable VPC for this cloud connection", - "computed": true - } - } - } - ], - "ibm_pi_cloud_instance": [ - { - "name": "total_memory_consumed", - "type": "TypeFloat", - "computed": true - }, - { - "name": "total_ssd_storage_consumed", - "type": "TypeFloat", - "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "The type of a project configuration manual property.", + "computed": true + } + } }, { - "name": "pvm_instances", + "name": "metadata", "type": "TypeList", + "description": "The metadata of the project.", "computed": true, "elem": { - "creation_date": { - "name": "creation_date", + "created_at": { + "name": "created_at", "type": "TypeString", + "description": "A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ, matching the date and time format as specified by RFC 3339.", "computed": true }, - "href": { - "name": "href", + "crn": { + "name": "crn", "type": "TypeString", + "description": "An IBM Cloud resource name, which uniquely identifies a resource.", "computed": true }, - "id": { - "name": "id", + "cumulative_needs_attention_view": { + "name": "cumulative_needs_attention_view", + "type": "TypeList", + "description": "The cumulative list of needs attention items for a project.", + "computed": true, + "elem": { + "config_id": { + "name": "config_id", + "type": "TypeString", + "description": "The unique ID of a project.", + "computed": true + }, + "config_version": { + "name": "config_version", + "type": "TypeInt", + "description": "The version number of the configuration.", + "computed": true + }, + "event": { + "name": "event", + "type": "TypeString", + "description": "The event name.", + "computed": true + }, + "event_id": { + "name": "event_id", + "type": "TypeString", + "description": "The unique ID of a project.", + "computed": true + } + } + }, + "cumulative_needs_attention_view_err": { + "name": "cumulative_needs_attention_view_err", "type": "TypeString", + "description": "True indicates that the fetch of the needs attention items failed.", "computed": true }, - "name": { - "name": "name", + "event_notifications_crn": { + "name": "event_notifications_crn", "type": "TypeString", + "description": "The CRN of the event notifications instance if one is connected to this project.", "computed": true }, - "status": { - "name": "status", + "location": { + "name": "location", "type": "TypeString", + "description": "The IBM Cloud location where a resource is deployed.", "computed": true }, - "systype": { - "name": "systype", + "resource_group": { + "name": "resource_group", "type": "TypeString", + "description": "The resource group where the project's data and tools are created.", + "computed": true + }, + "state": { + "name": "state", + "type": "TypeString", + "description": "The project status value.", "computed": true } } - }, + } + ], + "ibm_resource_group": [ { - "name": "capabilities", - "type": "TypeList", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "crn", + "type": "TypeString", + "description": "The full CRN associated with the resource group", + "cloud_data_type": "crn", + "computed": true }, { - "name": "total_processors_consumed", - "type": "TypeFloat", + "name": "teams_url", + "type": "TypeString", + "description": "The URL to access the team details that associated with the resource group.", "computed": true }, { - "name": "tenant_id", + "name": "account_id", "type": "TypeString", + "description": "Account ID", "computed": true }, { - "name": "region", + "name": "name", "type": "TypeString", - "cloud_data_type": "region", + "description": "Resource group name", + "cloud_data_type": "resource_group", + "optional": true, + "computed": true, + "cloud_data_range": [ + "resolved_to:name" + ] + }, + { + "name": "is_default", + "type": "TypeBool", + "description": "Default Resource group", + "optional": true, "computed": true }, { - "name": "total_instances", - "type": "TypeFloat", + "name": "state", + "type": "TypeString", + "description": "State of the resource group", "computed": true }, { - "name": "total_standard_storage_consumed", - "type": "TypeFloat", + "name": "created_at", + "type": "TypeString", + "description": "The date when the resource group was initially created.", "computed": true }, { - "name": "pi_cloud_instance_id", + "name": "updated_at", "type": "TypeString", - "required": true + "description": "The date when the resource group was last updated.", + "computed": true }, { - "name": "enabled", - "type": "TypeBool", + "name": "payment_methods_url", + "type": "TypeString", + "description": "The URL to access the payment methods details that associated with the resource group.", "computed": true - } - ], - "ibm_pi_console_languages": [ + }, { - "name": "pi_cloud_instance_id", + "name": "quota_url", "type": "TypeString", - "required": true + "description": "The URL to access the quota details that associated with the resource group.", + "computed": true }, { - "name": "pi_instance_name", + "name": "quota_id", "type": "TypeString", - "description": "The unique identifier or name of the instance", - "required": true + "description": "An alpha-numeric value identifying the quota ID associated with the resource group.", + "computed": true }, { - "name": "console_languages", - "type": "TypeList", + "name": "resource_linkages", + "type": "TypeSet", + "description": "An array of the resources that linked to the resource group", "computed": true, "elem": { - "code": { - "name": "code", - "type": "TypeString", - "description": "language code", - "computed": true - }, - "language": { - "name": "language", - "type": "TypeString", - "description": "language description", - "computed": true - } + "type": "TypeString" } } ], - "ibm_pi_dhcp": [ - { - "name": "pi_cloud_instance_id", - "type": "TypeString", - "required": true - }, + "ibm_resource_instance": [ { - "name": "pi_dhcp_id", + "name": "resource_group_id", "type": "TypeString", - "description": "The ID of the DHCP Server", - "required": true + "description": "The id of the resource group in which the instance is present", + "cloud_data_type": "resource_group", + "optional": true, + "computed": true, + "cloud_data_range": [ + "resolved_to:id" + ] }, { - "name": "dhcp_id", + "name": "service", "type": "TypeString", - "description": "The ID of the DHCP Server", + "description": "The service type of the instance", + "optional": true, "computed": true }, { - "name": "leases", - "type": "TypeList", - "description": "The list of DHCP Server PVM Instance leases", + "name": "tags", + "type": "TypeSet", + "description": "Tags of Resource Instance", + "cloud_data_type": "tags", "computed": true, "elem": { - "instance_ip": { - "name": "instance_ip", - "type": "TypeString", - "description": "The IP of the PVM Instance", - "computed": true - }, - "instance_mac": { - "name": "instance_mac", - "type": "TypeString", - "description": "The MAC Address of the PVM Instance", - "computed": true - } + "type": "TypeString" } }, { - "name": "network", + "name": "resource_name", "type": "TypeString", - "description": "The ID of the DHCP Server private network (deprecated - replaced by network_id)", + "description": "The name of the resource", "computed": true }, { - "name": "network_id", + "name": "resource_controller_url", "type": "TypeString", - "description": "The ID of the DHCP Server private network", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource", "computed": true }, { - "name": "network_name", + "name": "plan", "type": "TypeString", - "description": "The name of the DHCP Server private network", + "description": "The plan type of the instance", "computed": true }, { "name": "status", "type": "TypeString", - "description": "The status of the DHCP Server", + "description": "The resource instance status", "computed": true - } - ], - "ibm_pi_dhcps": [ + }, { - "name": "pi_cloud_instance_id", + "name": "resource_crn", "type": "TypeString", - "required": true + "description": "The crn of the resource", + "computed": true }, { - "name": "servers", - "type": "TypeList", - "description": "The list of all the DHCP Servers", - "computed": true, - "elem": { - "dhcp_id": { - "name": "dhcp_id", - "type": "TypeString", - "description": "The ID of the DHCP Server", - "computed": true - }, - "network": { - "name": "network", - "type": "TypeString", - "description": "The ID of the DHCP Server private network (deprecated - replaced by network_id)", - "computed": true - }, - "network_id": { - "name": "network_id", - "type": "TypeString", - "description": "The ID of the DHCP Server private network", - "computed": true - }, - "network_name": { - "name": "network_name", - "type": "TypeString", - "description": "The name of the DHCP Server private network", - "computed": true - }, - "status": { - "name": "status", - "type": "TypeString", - "description": "The status of the DHCP Server", - "computed": true - } - } - } - ], - "ibm_pi_disaster_recovery_location": [ + "name": "extensions", + "type": "TypeMap", + "description": "The extended metadata as a map associated with the resource instance.", + "computed": true + }, { - "name": "pi_cloud_instance_id", + "name": "name", "type": "TypeString", + "description": "Resource instance name for example, myobjectstorage", "required": true }, + { + "name": "guid", + "type": "TypeString", + "description": "Guid of resource instance", + "computed": true + }, { "name": "location", "type": "TypeString", - "description": "RegionZone of a site", + "description": "The location or the environment in which instance exists", "cloud_data_type": "region", + "optional": true, "computed": true }, { - "name": "replication_sites", - "type": "TypeList", - "computed": true, - "elem": { - "is_active": { - "name": "is_active", - "type": "TypeBool", - "computed": true - }, - "location": { - "name": "location", - "type": "TypeString", - "computed": true - } - } - } - ], - "ibm_pi_disaster_recovery_locations": [ - { - "name": "disaster_recovery_locations", - "type": "TypeList", - "computed": true, - "elem": { - "location": { - "name": "location", - "type": "TypeString", - "description": "RegionZone of a site", - "computed": true - }, - "replication_sites": { - "name": "replication_sites", - "type": "TypeList", - "computed": true, - "elem": { - "is_active": { - "name": "is_active", - "type": "TypeBool", - "computed": true - }, - "location": { - "name": "location", - "type": "TypeString", - "computed": true - } - } - } - } - } - ], - "ibm_pi_image": [ - { - "name": "size", - "type": "TypeInt", + "name": "crn", + "type": "TypeString", + "description": "CRN of resource instance", + "cloud_data_type": "crn", "computed": true }, { - "name": "storage_type", + "name": "resource_status", "type": "TypeString", + "description": "The status of the resource", "computed": true }, { - "name": "storage_pool", + "name": "resource_group_name", "type": "TypeString", + "description": "The resource group name in which resource is provisioned", "computed": true - }, + } + ], + "ibm_resource_key": [ { - "name": "hypervisor", + "name": "crn", "type": "TypeString", + "description": "crn of resource key", + "cloud_data_type": "crn", "computed": true }, { - "name": "image_type", + "name": "resource_instance_id", "type": "TypeString", - "computed": true + "description": "The id of the resource instance", + "cloud_data_type": "resource_instance", + "optional": true, + "cloud_data_range": [ + "service:%s" + ] }, { - "name": "pi_image_name", + "name": "role", "type": "TypeString", - "description": "Imagename Name to be used for pvminstances", - "required": true + "description": "User role", + "computed": true }, { - "name": "pi_cloud_instance_id", + "name": "credentials", + "type": "TypeMap", + "description": "Credentials asociated with the key", + "secure": true, + "computed": true + }, + { + "name": "most_recent", + "type": "TypeBool", + "description": "If true and multiple entries are found, the most recently created resource key is used. If false, an error is returned", + "default_value": false, + "optional": true + }, + { + "name": "name", "type": "TypeString", + "description": "The name of the resource key", "required": true }, { - "name": "state", + "name": "resource_alias_id", "type": "TypeString", - "computed": true + "description": "The id of the resource alias", + "optional": true }, { - "name": "architecture", + "name": "status", "type": "TypeString", + "description": "Status of resource key", "computed": true }, { - "name": "operatingsystem", + "name": "credentials_json", "type": "TypeString", + "description": "Credentials asociated with the key in json string", + "secure": true, "computed": true } ], - "ibm_pi_images": [ + "ibm_resource_quota": [ { - "name": "pi_cloud_instance_id", + "name": "vsi_limit", + "type": "TypeInt", + "description": "Defines the VSI limit.", + "computed": true + }, + { + "name": "name", "type": "TypeString", + "description": "Resource quota name, for example Trial Quota", "required": true }, { - "name": "image_info", - "type": "TypeList", - "computed": true, - "elem": { - "href": { - "name": "href", - "type": "TypeString", - "computed": true - }, - "id": { - "name": "id", - "type": "TypeString", - "computed": true - }, - "image_type": { - "name": "image_type", - "type": "TypeString", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "computed": true - }, - "state": { - "name": "state", - "type": "TypeString", - "computed": true - }, - "storage_pool": { - "name": "storage_pool", - "type": "TypeString", - "computed": true - }, - "storage_type": { - "name": "storage_type", - "type": "TypeString", - "computed": true - } - } - } - ], - "ibm_pi_instance": [ - { - "name": "processors", - "type": "TypeFloat", + "name": "type", + "type": "TypeString", + "description": "Type of the quota.", "computed": true }, { - "name": "virtual_cores_assigned", + "name": "max_apps", "type": "TypeInt", + "description": "Defines the total app limit.", "computed": true }, { - "name": "storage_type", - "type": "TypeString", + "name": "max_instances_per_app", + "type": "TypeInt", + "description": "Defines the total instances limit per app.", "computed": true }, { - "name": "storage_pool_affinity", - "type": "TypeBool", + "name": "max_app_instance_memory", + "type": "TypeString", + "description": "Defines the total memory of app instance.", "computed": true }, { - "name": "minmem", - "type": "TypeFloat", + "name": "total_app_memory", + "type": "TypeString", + "description": "Defines the total memory for app.", "computed": true }, { - "name": "max_virtual_cores", + "name": "max_service_instances", "type": "TypeInt", + "description": "Defines the total service instances limit.", "computed": true - }, + } + ], + "ibm_resource_tag": [ { - "name": "min_virtual_cores", - "type": "TypeInt", - "computed": true + "name": "resource_type", + "type": "TypeString", + "description": "Resource type on which the tags should be fetched", + "optional": true }, { - "name": "pi_instance_name", + "name": "tag_type", "type": "TypeString", - "description": "Server Name to be used for pvminstances", - "required": true + "description": "Tag type on which the tags should be fetched", + "default_value": "user", + "optional": true }, { - "name": "pi_cloud_instance_id", + "name": "resource_id", "type": "TypeString", - "required": true + "description": "CRN of the resource on which the tags should be attached", + "optional": true }, { - "name": "volumes", - "type": "TypeList", + "name": "tags", + "type": "TypeSet", + "description": "List of tags associated with resource instance", + "cloud_data_type": "tags", "computed": true, "elem": { "type": "TypeString" } - }, - { - "name": "addresses", - "type": "TypeList", - "computed": true, - "elem": { - "external_ip": { - "name": "external_ip", - "type": "TypeString", - "computed": true - }, - "ip": { - "name": "ip", - "type": "TypeString", - "computed": true - }, - "macaddress": { - "name": "macaddress", - "type": "TypeString", - "computed": true - }, - "network_id": { - "name": "network_id", - "type": "TypeString", - "computed": true - }, - "network_name": { - "name": "network_name", - "type": "TypeString", - "computed": true - }, - "type": { - "name": "type", - "type": "TypeString", - "computed": true - } - }, - "deprecated": "This field is deprecated, use networks instead" - }, - { - "name": "networks", - "type": "TypeList", - "computed": true, - "elem": { - "external_ip": { - "name": "external_ip", - "type": "TypeString", - "computed": true - }, - "ip": { - "name": "ip", - "type": "TypeString", - "computed": true - }, - "macaddress": { - "name": "macaddress", - "type": "TypeString", - "computed": true - }, - "network_id": { - "name": "network_id", - "type": "TypeString", - "computed": true - }, - "network_name": { - "name": "network_name", - "type": "TypeString", - "computed": true - }, - "type": { - "name": "type", - "type": "TypeString", - "computed": true - } - } - }, - { - "name": "license_repository_capacity", - "type": "TypeInt", - "computed": true - }, + } + ], + "ibm_satellite_attach_host_script": [ { - "name": "deployment_type", + "name": "location", "type": "TypeString", - "computed": true + "description": "A unique name for the new Satellite location", + "cloud_data_type": "region", + "required": true }, { - "name": "shared_processor_pool", + "name": "host_provider", "type": "TypeString", - "computed": true + "optional": true }, { - "name": "shared_processor_pool_id", + "name": "script_dir", "type": "TypeString", + "description": "The directory where the satellite attach host script to be downloaded. Default is home directory", + "optional": true, "computed": true }, { - "name": "placement_group_id", + "name": "host_script", "type": "TypeString", + "description": "Attach host script content", "computed": true }, { - "name": "memory", - "type": "TypeFloat", - "computed": true - }, - { - "name": "health_status", + "name": "description", "type": "TypeString", + "description": "A unique name for the new Satellite location", "computed": true }, { - "name": "maxproc", - "type": "TypeFloat", - "computed": true - }, - { - "name": "pin_policy", - "type": "TypeString", - "computed": true + "name": "coreos_host", + "type": "TypeBool", + "description": "If true, returns a CoreOS ignition file for the host. Otherwise, returns a RHEL attach script", + "optional": true }, { - "name": "storage_pool", - "type": "TypeString", - "computed": true + "name": "labels", + "type": "TypeSet", + "description": "List of labels for the attach host", + "optional": true, + "elem": { + "type": "TypeString" + } }, { - "name": "proctype", + "name": "script_path", "type": "TypeString", + "description": "The absolute path to the generated host script file", "computed": true }, { - "name": "status", + "name": "custom_script", "type": "TypeString", - "computed": true - }, - { - "name": "minproc", - "type": "TypeFloat", - "computed": true - }, - { - "name": "maxmem", - "type": "TypeFloat", - "computed": true + "description": "The custom script that has to be appended to generated host script file", + "optional": true } ], - "ibm_pi_instance_ip": [ - { - "name": "macaddress", - "type": "TypeString", - "computed": true - }, + "ibm_satellite_cluster": [ { - "name": "external_ip", + "name": "private_service_endpoint_url", "type": "TypeString", "computed": true }, { - "name": "pi_network_name", + "name": "name", "type": "TypeString", + "description": "Name or id of the cluster", "required": true }, { - "name": "ip", + "name": "state", "type": "TypeString", + "description": "The lifecycle state of the cluster", "computed": true }, { - "name": "ipoctet", + "name": "status", "type": "TypeString", + "description": "The status of the cluster", "computed": true }, { - "name": "type", + "name": "ingress_secret", "type": "TypeString", + "secure": true, "computed": true }, { - "name": "pi_instance_name", + "name": "crn", "type": "TypeString", - "description": "Server Name to be used for pvminstances", - "required": true + "description": "CRN of resource instance", + "cloud_data_type": "crn", + "computed": true }, { - "name": "pi_cloud_instance_id", + "name": "health", "type": "TypeString", - "required": true + "computed": true }, { - "name": "network_id", - "type": "TypeString", + "name": "worker_count", + "type": "TypeInt", + "description": "Number of workers", "computed": true - } - ], - "ibm_pi_instance_snapshots": [ - { - "name": "pi_cloud_instance_id", - "type": "TypeString", - "required": true }, { - "name": "instance_snapshots", + "name": "worker_pools", "type": "TypeList", "computed": true, "elem": { - "action": { - "name": "action", - "type": "TypeString", + "default_worker_pool_labels": { + "name": "default_worker_pool_labels", + "type": "TypeMap", "computed": true }, - "creation_date": { - "name": "creation_date", + "flavour": { + "name": "flavour", "type": "TypeString", "computed": true }, - "description": { - "name": "description", - "type": "TypeString", - "computed": true + "host_labels": { + "name": "host_labels", + "type": "TypeMap", + "computed": true, + "elem": { + "type": "TypeString" + } }, "id": { "name": "id", "type": "TypeString", "computed": true }, - "last_updated_date": { - "name": "last_updated_date", + "isolation": { + "name": "isolation", "type": "TypeString", "computed": true }, @@ -63560,3866 +67441,4547 @@ "type": "TypeString", "computed": true }, - "percent_complete": { - "name": "percent_complete", + "size_per_zone": { + "name": "size_per_zone", "type": "TypeInt", "computed": true }, - "status": { - "name": "status", - "type": "TypeString", - "computed": true - }, - "volume_snapshots": { - "name": "volume_snapshots", - "type": "TypeMap", - "computed": true - } - } - } - ], - "ibm_pi_instance_volumes": [ - { - "name": "pi_instance_name", - "type": "TypeString", - "description": "Instance Name to be used for pvminstances", - "required": true - }, - { - "name": "pi_cloud_instance_id", - "type": "TypeString", - "required": true - }, - { - "name": "boot_volume_id", - "type": "TypeString", - "computed": true - }, - { - "name": "instance_volumes", - "type": "TypeList", - "computed": true, - "elem": { - "bootable": { - "name": "bootable", - "type": "TypeBool", - "computed": true - }, - "href": { - "name": "href", - "type": "TypeString", - "computed": true - }, - "id": { - "name": "id", - "type": "TypeString", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "computed": true - }, - "pool": { - "name": "pool", - "type": "TypeString", - "computed": true - }, - "shareable": { - "name": "shareable", - "type": "TypeBool", - "computed": true - }, - "size": { - "name": "size", - "type": "TypeFloat", - "computed": true - }, "state": { "name": "state", "type": "TypeString", "computed": true }, - "type": { - "name": "type", - "type": "TypeString", - "computed": true - } - } - } - ], - "ibm_pi_instances": [ - { - "name": "pi_cloud_instance_id", - "type": "TypeString", - "required": true - }, - { - "name": "pvm_instances", - "type": "TypeList", - "computed": true, - "elem": { - "health_status": { - "name": "health_status", - "type": "TypeString", - "computed": true - }, - "license_repository_capacity": { - "name": "license_repository_capacity", - "type": "TypeInt", - "computed": true - }, - "max_virtual_cores": { - "name": "max_virtual_cores", - "type": "TypeInt", - "computed": true - }, - "maxmem": { - "name": "maxmem", - "type": "TypeFloat", - "computed": true - }, - "maxproc": { - "name": "maxproc", - "type": "TypeFloat", - "computed": true - }, - "memory": { - "name": "memory", - "type": "TypeFloat", - "computed": true - }, - "min_virtual_cores": { - "name": "min_virtual_cores", - "type": "TypeInt", - "computed": true - }, - "minmem": { - "name": "minmem", - "type": "TypeFloat", - "computed": true - }, - "minproc": { - "name": "minproc", - "type": "TypeFloat", - "computed": true - }, - "networks": { - "name": "networks", + "zones": { + "name": "zones", "type": "TypeList", "computed": true, "elem": { - "external_ip": { - "name": "external_ip", - "type": "TypeString", - "computed": true - }, - "ip": { - "name": "ip", - "type": "TypeString", - "computed": true - }, - "macaddress": { - "name": "macaddress", - "type": "TypeString", - "computed": true - }, - "network_id": { - "name": "network_id", - "type": "TypeString", - "computed": true - }, - "network_name": { - "name": "network_name", - "type": "TypeString", + "worker_count": { + "name": "worker_count", + "type": "TypeInt", "computed": true }, - "type": { - "name": "type", + "zone": { + "name": "zone", "type": "TypeString", "computed": true } } - }, - "pin_policy": { - "name": "pin_policy", - "type": "TypeString", - "computed": true - }, - "placement_group_id": { - "name": "placement_group_id", - "type": "TypeString", - "computed": true - }, - "processors": { - "name": "processors", - "type": "TypeFloat", - "computed": true - }, - "proctype": { - "name": "proctype", - "type": "TypeString", - "computed": true - }, - "pvm_instance_id": { - "name": "pvm_instance_id", - "type": "TypeString", - "computed": true - }, - "status": { - "name": "status", - "type": "TypeString", - "computed": true - }, - "storage_pool": { - "name": "storage_pool", - "type": "TypeString", - "computed": true - }, - "storage_pool_affinity": { - "name": "storage_pool_affinity", - "type": "TypeBool", - "computed": true - }, - "storage_type": { - "name": "storage_type", - "type": "TypeString", - "computed": true - }, - "virtual_cores_assigned": { - "name": "virtual_cores_assigned", - "type": "TypeInt", - "computed": true } } - } - ], - "ibm_pi_key": [ + }, { - "name": "pi_key_name", + "name": "server_url", "type": "TypeString", - "description": "SSH key name for a pcloud tenant", - "required": true + "description": "The server URL", + "computed": true }, { - "name": "pi_cloud_instance_id", + "name": "resource_group_name", "type": "TypeString", - "required": true + "description": "The resource group name in which resource is provisioned", + "computed": true }, { - "name": "creation_date", + "name": "location", "type": "TypeString", - "description": "Date of sshkey creation", + "description": "Name or id of the location", + "cloud_data_type": "region", "computed": true }, { - "name": "ssh_key", + "name": "kube_version", "type": "TypeString", - "description": "SSH RSA key", - "secure": true, + "description": "Kubernetes version", "computed": true }, { - "name": "sshkey", + "name": "resource_group_id", "type": "TypeString", - "secure": true, + "description": "ID of the resource group.", + "cloud_data_type": "resource_group", + "optional": true, + "computed": true + }, + { + "name": "ingress_hostname", + "type": "TypeString", + "computed": true + }, + { + "name": "infrastructure_topology", + "type": "TypeString", + "description": "String value for single node cluster option.", + "computed": true + }, + { + "name": "workers", + "type": "TypeList", "computed": true, - "deprecated": "This field is deprecated, use ssh_key instead" - } - ], - "ibm_pi_keys": [ + "elem": { + "type": "TypeString" + } + }, + { + "name": "public_service_endpoint", + "type": "TypeBool", + "computed": true + }, + { + "name": "private_service_endpoint", + "type": "TypeBool", + "computed": true + }, { - "name": "pi_cloud_instance_id", + "name": "public_service_endpoint_url", "type": "TypeString", - "description": "PI cloud instance ID", - "required": true + "computed": true }, { - "name": "keys", - "type": "TypeList", - "description": "SSH Keys", + "name": "tags", + "type": "TypeSet", + "cloud_data_type": "tags", "computed": true, "elem": { - "creation_date": { - "name": "creation_date", - "type": "TypeString", - "description": "Date of SSH key creation", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "User defined name for the SSH key", - "computed": true - }, - "ssh_key": { - "name": "ssh_key", - "type": "TypeString", - "description": "SSH RSA key", - "computed": true - } + "type": "TypeString" } } ], - "ibm_pi_network": [ + "ibm_satellite_cluster_worker_pool": [ { - "name": "pi_network_name", - "type": "TypeString", - "description": "Network Name to be used for pvminstances", - "required": true + "name": "host_labels", + "type": "TypeMap", + "description": "Host labels on the workers", + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "cidr", + "name": "region", "type": "TypeString", + "description": "Name of the region", + "cloud_data_type": "region", + "optional": true, "computed": true }, { - "name": "type", - "type": "TypeString", + "name": "worker_count", + "type": "TypeInt", + "description": "The number of workers that are attached", "computed": true }, { - "name": "used_ip_count", - "type": "TypeFloat", + "name": "isolation", + "type": "TypeString", + "description": "Isolation of the worker node", "computed": true }, { - "name": "used_ip_percent", - "type": "TypeFloat", + "name": "name", + "type": "TypeString", + "description": "worker pool name", + "required": true + }, + { + "name": "flavor", + "type": "TypeString", + "description": "The flavor of the satellite worker node", "computed": true }, { - "name": "dns", + "name": "zones", "type": "TypeSet", "computed": true, "elem": { - "type": "TypeString" + "worker_count": { + "name": "worker_count", + "type": "TypeInt", + "computed": true + }, + "zone": { + "name": "zone", + "type": "TypeString", + "computed": true + } } }, { - "name": "pi_cloud_instance_id", - "type": "TypeString", - "required": true + "name": "worker_pool_labels", + "type": "TypeMap", + "description": "Labels on all the workers in the worker pool", + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "vlan_id", - "type": "TypeInt", + "name": "operating_system", + "type": "TypeString", + "description": "The operating system of the hosts in the worker pool", "computed": true }, { - "name": "gateway", + "name": "resource_group_id", "type": "TypeString", + "description": "ID of the resource group", + "cloud_data_type": "resource_group", + "optional": true, "computed": true }, { - "name": "available_ip_count", - "type": "TypeFloat", + "name": "auto_scale_enabled", + "type": "TypeBool", + "description": "Enable auto scalling for worker pool", "computed": true }, { - "name": "name", + "name": "cluster", "type": "TypeString", - "computed": true, - "deprecated": "This value is deprecated in favor ofpi_network_name" + "description": "Cluster name", + "required": true }, { - "name": "jumbo", - "type": "TypeBool", + "name": "state", + "type": "TypeString", + "description": "The state of the worker pool", "computed": true } ], - "ibm_pi_network_port": [ + "ibm_satellite_cluster_worker_pool_zone_attachment": [ { - "name": "pi_network_name", + "name": "resource_group_id", "type": "TypeString", - "description": "Network Name to be used for pvminstances", - "required": true + "description": "The ID of the resource group that the Satellite location is in. To list the resource group ID of the location, use the `GET /v2/satellite/getController` API method.", + "cloud_data_type": "resource_group", + "optional": true }, { - "name": "pi_cloud_instance_id", - "type": "TypeString", - "required": true + "name": "worker_count", + "type": "TypeInt", + "description": "Number of workers", + "computed": true }, { - "name": "network_ports", + "name": "autobalance_enabled", + "type": "TypeBool", + "description": "Auto enabled status", + "computed": true + }, + { + "name": "messages", "type": "TypeList", + "description": "Filter features by a list of comma separated collections.", "computed": true, "elem": { - "description": { - "name": "description", - "type": "TypeString", - "required": true - }, - "href": { - "name": "href", - "type": "TypeString", - "computed": true - }, - "ipaddress": { - "name": "ipaddress", - "type": "TypeString", - "optional": true, - "computed": true - }, - "macaddress": { - "name": "macaddress", - "type": "TypeString", - "computed": true - }, - "portid": { - "name": "portid", - "type": "TypeString", - "computed": true - }, - "public_ip": { - "name": "public_ip", - "type": "TypeString", - "computed": true - }, - "status": { - "name": "status", - "type": "TypeString", - "computed": true - } + "type": "TypeString" } - } - ], - "ibm_pi_placement_group": [ + }, { - "name": "pi_placement_group_name", + "name": "cluster", "type": "TypeString", + "description": "Name or id of the cluster", "required": true }, { - "name": "policy", + "name": "worker_pool", "type": "TypeString", - "computed": true + "description": "worker pool name", + "required": true }, { - "name": "pi_cloud_instance_id", + "name": "zone", "type": "TypeString", + "description": "worker pool zone name", "required": true - }, - { - "name": "members", - "type": "TypeList", - "computed": true, - "elem": { - "type": "TypeString" - } } ], - "ibm_pi_placement_groups": [ + "ibm_satellite_endpoint": [ { - "name": "pi_cloud_instance_id", + "name": "client_protocol", "type": "TypeString", - "description": "PI cloud instance ID", - "required": true + "description": "The protocol in the client application side.", + "computed": true }, { - "name": "placement_groups", + "name": "client_mutual_auth", + "type": "TypeBool", + "description": "Whether enable mutual auth in the client application side, when client_protocol is 'tls' or 'https', this field is required.", + "computed": true + }, + { + "name": "certs", "type": "TypeList", + "description": "The certs. Once it is generated, this field will always be defined even it is unused until the cert/key is deleted.", "computed": true, "elem": { - "id": { - "name": "id", - "type": "TypeString", - "computed": true - }, - "members": { - "name": "members", + "client": { + "name": "client", "type": "TypeList", + "description": "The CA which Satellite Link trust when receiving the connection from the client application.", "computed": true, "elem": { - "type": "TypeString" + "cert": { + "name": "cert", + "type": "TypeList", + "description": "The root cert or the self-signed cert of the client application.", + "computed": true, + "elem": { + "filename": { + "name": "filename", + "type": "TypeString", + "description": "The filename of the cert.", + "computed": true + } + } + } } }, - "name": { - "name": "name", - "type": "TypeString", - "computed": true + "connector": { + "name": "connector", + "type": "TypeList", + "description": "The cert which Satellite Link connector provide to identify itself for connecting to the client/server application.", + "computed": true, + "elem": { + "cert": { + "name": "cert", + "type": "TypeList", + "description": "The end-entity cert of the connector.", + "computed": true, + "elem": { + "filename": { + "name": "filename", + "type": "TypeString", + "description": "The filename of the cert.", + "computed": true + } + } + }, + "key": { + "name": "key", + "type": "TypeList", + "description": "The private key of the connector.", + "computed": true, + "elem": { + "filename": { + "name": "filename", + "type": "TypeString", + "description": "The name of the key.", + "computed": true + } + } + } + } }, - "policy": { - "name": "policy", - "type": "TypeString", - "computed": true + "server": { + "name": "server", + "type": "TypeList", + "description": "The CA which Satellite Link trust when sending the connection to server application.", + "computed": true, + "elem": { + "cert": { + "name": "cert", + "type": "TypeList", + "description": "The root cert or the self-signed cert of the server application.", + "computed": true, + "elem": { + "filename": { + "name": "filename", + "type": "TypeString", + "description": "The filename of the cert.", + "computed": true + } + } + } + } } } - } - ], - "ibm_pi_public_network": [ + }, { - "name": "vlan_id", - "type": "TypeInt", + "name": "created_by", + "type": "TypeString", + "description": "The service or person who created the endpoint. Must be 1000 characters or fewer.", "computed": true }, { - "name": "pi_cloud_instance_id", + "name": "crn", "type": "TypeString", - "required": true + "description": "Service instance associated with this location.", + "cloud_data_type": "crn", + "computed": true }, { - "name": "name", + "name": "last_change", "type": "TypeString", + "description": "The last time modify the Endpoint configurations.", "computed": true }, { - "name": "type", + "name": "server_host", "type": "TypeString", + "description": "The host name or IP address of the server endpoint. For 'http-tunnel' protocol, server_host can start with '*.' , which means a wildcard to it's sub domains. Such as '*.example.com' can accept request to 'api.example.com' and 'www.example.com'.", "computed": true - } - ], - "ibm_pi_pvm_snapshots": [ - { - "name": "pvm_snapshots", - "type": "TypeList", - "computed": true, - "elem": { - "action": { - "name": "action", - "type": "TypeString", - "computed": true - }, - "creation_date": { - "name": "creation_date", - "type": "TypeString", - "computed": true - }, - "description": { - "name": "description", - "type": "TypeString", - "computed": true - }, - "id": { - "name": "id", - "type": "TypeString", - "computed": true - }, - "last_updated_date": { - "name": "last_updated_date", - "type": "TypeString", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "computed": true - }, - "percent_complete": { - "name": "percent_complete", - "type": "TypeInt", - "computed": true - }, - "status": { - "name": "status", - "type": "TypeString", - "computed": true - }, - "volume_snapshots": { - "name": "volume_snapshots", - "type": "TypeMap", - "computed": true - } - } }, { - "name": "pi_cloud_instance_id", + "name": "sni", "type": "TypeString", - "required": true + "description": "The server name indicator (SNI) which used to connect to the server endpoint. Only useful if server side requires SNI.", + "computed": true }, { - "name": "pi_instance_name", + "name": "server_protocol", "type": "TypeString", - "required": true - } - ], - "ibm_pi_sap_profile": [ + "description": "The protocol in the server application side. This parameter will change to default value if it is omitted even when using PATCH API. If client_protocol is 'udp', server_protocol must be 'udp'. If client_protocol is 'tcp'/'http', server_protocol could be 'tcp'/'tls' and default to 'tcp'. If client_protocol is 'tls'/'https', server_protocol could be 'tcp'/'tls' and default to 'tls'. If client_protocol is 'http-tunnel', server_protocol must be 'tcp'.", + "computed": true + }, { - "name": "cores", + "name": "timeout", "type": "TypeInt", - "description": "Amount of cores", + "description": "The inactivity timeout in the Endpoint side.", "computed": true }, { - "name": "memory", - "type": "TypeInt", - "description": "Amount of memory (in GB)", + "name": "service_name", + "type": "TypeString", + "description": "The service name of the endpoint.", "computed": true }, { - "name": "type", + "name": "status", "type": "TypeString", - "description": "Type of profile", + "description": "Whether the Endpoint is active or not.", "computed": true }, { - "name": "pi_cloud_instance_id", + "name": "created_at", "type": "TypeString", - "required": true + "description": "The time when the Endpoint is created.", + "computed": true }, { - "name": "pi_sap_profile_id", + "name": "endpoint_id", "type": "TypeString", - "description": "SAP Profile ID", + "description": "The Endpoint ID.", "required": true }, { - "name": "certified", + "name": "server_mutual_auth", "type": "TypeBool", - "description": "Has certification been performed on profile", + "description": "Whether enable mutual auth in the server application side, when client_protocol is 'tls', this field is required.", "computed": true - } - ], - "ibm_pi_sap_profiles": [ - { - "name": "pi_cloud_instance_id", - "type": "TypeString", - "required": true }, { - "name": "profiles", + "name": "sources", "type": "TypeList", "computed": true, "elem": { - "certified": { - "name": "certified", + "enabled": { + "name": "enabled", "type": "TypeBool", - "description": "Has certification been performed on profile", - "computed": true - }, - "cores": { - "name": "cores", - "type": "TypeInt", - "description": "Amount of cores", + "description": "Whether the source is enabled for the endpoint.", "computed": true }, - "memory": { - "name": "memory", - "type": "TypeInt", - "description": "Amount of memory (in GB)", + "last_change": { + "name": "last_change", + "type": "TypeString", + "description": "The last time modify the Endpoint configurations.", "computed": true }, - "profile_id": { - "name": "profile_id", - "type": "TypeString", - "description": "SAP Profile ID", + "pending": { + "name": "pending", + "type": "TypeBool", + "description": "Whether the source has been enabled on this endpoint.", "computed": true }, - "type": { - "name": "type", + "source_id": { + "name": "source_id", "type": "TypeString", - "description": "Type of profile", + "description": "The Source ID.", "computed": true } } - } - ], - "ibm_pi_shared_processor_pool": [ + }, { - "name": "instances", + "name": "connector_port", + "type": "TypeInt", + "description": "The connector port.", + "computed": true + }, + { + "name": "reject_unauth", + "type": "TypeBool", + "description": "Whether reject any connection to the server application which is not authorized with the list of supplied CAs in the fields certs.server_cert.", + "computed": true + }, + { + "name": "client_host", + "type": "TypeString", + "description": "The hostname which Satellite Link server listen on for the on-location endpoint, or the hostname which the connector server listen on for the on-cloud endpoint destiantion.", + "computed": true + }, + { + "name": "client_port", + "type": "TypeInt", + "description": "The port which Satellite Link server listen on for the on-location, or the port which the connector server listen on for the on-cloud endpoint destiantion.", + "computed": true + }, + { + "name": "performance", "type": "TypeList", - "description": "List of server instances deployed in the shared processor pool", + "description": "The last performance data of the endpoint.", "computed": true, "elem": { - "availability_zone": { - "name": "availability_zone", - "type": "TypeString", - "description": "Availability zone for the server instances", - "optional": true, - "computed": true - }, - "cpus": { - "name": "cpus", + "bandwidth": { + "name": "bandwidth", "type": "TypeInt", - "description": "The amount of cpus for the server instance", - "optional": true, - "computed": true - }, - "id": { - "name": "id", - "type": "TypeString", - "description": "The server instance ID", - "optional": true, + "description": "Average Tatal Bandwidth of last two minutes, unit is Byte/s.", "computed": true }, - "memory": { - "name": "memory", + "connection": { + "name": "connection", "type": "TypeInt", - "description": "The amount of memory for the server instance", - "optional": true, - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "The server instance name", - "optional": true, + "description": "Concurrent connections number of moment when probe read the data.", "computed": true }, - "status": { - "name": "status", - "type": "TypeString", - "description": "Status of the server", - "optional": true, - "computed": true + "connectors": { + "name": "connectors", + "type": "TypeList", + "description": "The last performance data of the endpoint from each Connector.", + "computed": true, + "elem": { + "connections": { + "name": "connections", + "type": "TypeInt", + "description": "Concurrent connections number of moment when probe read the data from the Connector.", + "computed": true + }, + "connector": { + "name": "connector", + "type": "TypeString", + "description": "The name of the connector reported the performance data.", + "computed": true + }, + "rx_bw": { + "name": "rx_bw", + "type": "TypeInt", + "description": "Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.", + "computed": true + }, + "tx_bw": { + "name": "tx_bw", + "type": "TypeInt", + "description": "Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.", + "computed": true + } + } }, - "uncapped": { - "name": "uncapped", - "type": "TypeBool", - "description": "Identifies if uncapped or not", - "optional": true, + "rx_bandwidth": { + "name": "rx_bandwidth", + "type": "TypeInt", + "description": "Average Receive (to Cloud) Bandwidth of last two minutes, unit is Byte/s.", "computed": true }, - "vcpus": { - "name": "vcpus", - "type": "TypeFloat", - "description": "The amout of vcpus for the server instance", - "optional": true, + "tx_bandwidth": { + "name": "tx_bandwidth", + "type": "TypeInt", + "description": "Average Transmitted (to Location) Bandwidth of last two minutes, unit is Byte/s.", "computed": true } } }, { - "name": "pi_shared_processor_pool_id", + "name": "location", "type": "TypeString", + "description": "The Location ID.", + "cloud_data_type": "region", "required": true }, { - "name": "allocated_cores", - "type": "TypeFloat", - "description": "Shared processor pool allocated cores", + "name": "connection_type", + "type": "TypeString", + "description": "The type of the endpoint.", "computed": true }, { - "name": "status", + "name": "display_name", "type": "TypeString", - "description": "The status of the shared processor pool", + "description": "The display name of the endpoint. Endpoint names must start with a letter and end with an alphanumeric character, can contain letters, numbers, and hyphen (-), and must be 63 characters or fewer.", "computed": true }, { - "name": "reserved_cores", + "name": "server_port", "type": "TypeInt", - "description": "The amount of reserved cores for the shared processor pool", + "description": "The port number of the server endpoint. For 'http-tunnel' protocol, server_port can be 0, which means any port. Such as 0 is good for 80 (http) and 443 (https).", "computed": true - }, + } + ], + "ibm_satellite_link": [ { - "name": "available_cores", - "type": "TypeFloat", - "description": "Shared processor pool available cores", + "name": "crn", + "type": "TypeString", + "description": "Service instance associated with this location.", + "cloud_data_type": "crn", "computed": true }, { - "name": "status_detail", + "name": "description", "type": "TypeString", - "description": "The status details of the shared processor pool", + "description": "Description of the location.", "computed": true }, { - "name": "pi_cloud_instance_id", + "name": "status", "type": "TypeString", - "description": "PI cloud instance ID", - "required": true + "description": "Enabled/Disabled.", + "computed": true }, { - "name": "name", + "name": "created_at", "type": "TypeString", - "description": "Name of the shared processor pool", + "description": "Timestamp of creation of location.", "computed": true }, { - "name": "host_id", - "type": "TypeInt", - "description": "The host ID where the shared processor pool resides", - "computed": true - } - ], - "ibm_pi_shared_processor_pools": [ - { - "name": "pi_cloud_instance_id", + "name": "location", "type": "TypeString", - "description": "PI cloud instance ID", + "description": "The Location ID.", + "cloud_data_type": "region", "required": true }, { - "name": "shared_processor_pools", + "name": "ws_endpoint", + "type": "TypeString", + "description": "The ws endpoint of the location.", + "computed": true + }, + { + "name": "performance", "type": "TypeList", + "description": "The last performance data of the Location.", "computed": true, "elem": { - "allocated_cores": { - "name": "allocated_cores", - "type": "TypeFloat", - "computed": true - }, - "available_cores": { - "name": "available_cores", + "avg_latency": { + "name": "avg_latency", "type": "TypeInt", + "description": "Average latency calculated form latency of each Connector between Tunnel Server, unit is ms. -1 means no Connector established Tunnel.", "computed": true }, - "host_id": { - "name": "host_id", + "bandwidth": { + "name": "bandwidth", "type": "TypeInt", + "description": "Average Tatal Bandwidth of last two minutes, unit is Byte/s.", "computed": true }, - "name": { - "name": "name", + "connectors": { + "name": "connectors", + "type": "TypeList", + "description": "The last performance data of the Location read from each Connector.", + "computed": true, + "elem": { + "connector": { + "name": "connector", + "type": "TypeString", + "description": "The name of the connector reported the performance data.", + "computed": true + }, + "latency": { + "name": "latency", + "type": "TypeInt", + "description": "Latency between Connector and the Tunnel Server it connected.", + "computed": true + }, + "rx_bw": { + "name": "rx_bw", + "type": "TypeInt", + "description": "Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.", + "computed": true + }, + "tx_bw": { + "name": "tx_bw", + "type": "TypeInt", + "description": "Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.", + "computed": true + } + } + }, + "health_status": { + "name": "health_status", "type": "TypeString", + "description": "Tunnels health status based on the Tunnels number established. Down(0)/Critical(1)/Up(\u003e=2).", "computed": true }, - "reserved_cores": { - "name": "reserved_cores", + "rx_bandwidth": { + "name": "rx_bandwidth", "type": "TypeInt", + "description": "Average Receive (to Cloud) Bandwidth of last two minutes, unit is Byte/s.", "computed": true }, - "shared_processor_pool_id": { - "name": "shared_processor_pool_id", - "type": "TypeString", - "computed": true - }, - "status": { - "name": "status", - "type": "TypeString", + "tunnels": { + "name": "tunnels", + "type": "TypeInt", + "description": "Tunnels number estbalished from the Location.", "computed": true }, - "status_detail": { - "name": "status_detail", - "type": "TypeString", + "tx_bandwidth": { + "name": "tx_bandwidth", + "type": "TypeInt", + "description": "Average Transmitted (to Location) Bandwidth of last two minutes, unit is Byte/s.", "computed": true } } - } - ], - "ibm_pi_spp_placement_group": [ - { - "name": "pi_cloud_instance_id", - "type": "TypeString", - "required": true - }, - { - "name": "members", - "type": "TypeList", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "pi_spp_placement_group_id", - "type": "TypeString", - "required": true }, { - "name": "name", + "name": "satellite_link_host", "type": "TypeString", + "description": "Satellite Link hostname of the location.", "computed": true }, { - "name": "policy", + "name": "last_change", "type": "TypeString", + "description": "Timestamp of latest modification of location.", "computed": true } ], - "ibm_pi_spp_placement_groups": [ + "ibm_satellite_location": [ { - "name": "pi_cloud_instance_id", + "name": "crn", "type": "TypeString", - "description": "PI cloud instance ID", - "required": true + "description": "Location CRN", + "cloud_data_type": "crn", + "computed": true }, { - "name": "spp_placement_groups", - "type": "TypeList", + "name": "resource_group_id", + "type": "TypeString", + "description": "ID of the resource group", + "cloud_data_type": "resource_group", + "computed": true + }, + { + "name": "host_attached_count", + "type": "TypeInt", + "description": "The total number of hosts that are attached to the Satellite location.", "computed": true, "elem": { - "members": { - "name": "members", - "type": "TypeList", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "name": { - "name": "name", - "type": "TypeString", - "computed": true - }, - "policy": { - "name": "policy", - "type": "TypeString", - "computed": true - }, - "spp_placement_group_id": { - "name": "spp_placement_group_id", - "type": "TypeString", - "computed": true - } + "type": "TypeString" } - } - ], - "ibm_pi_storage_pool_capacity": [ + }, { - "name": "total_capacity", + "name": "host_available_count", "type": "TypeInt", - "description": "Total pool capacity (GB)", - "computed": true + "description": "The available number of hosts that can be assigned to a cluster resource in the Satellite location.", + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "pi_cloud_instance_id", + "name": "created_on", "type": "TypeString", - "required": true + "description": "Created Date", + "computed": true }, { - "name": "pi_storage_pool", + "name": "location", "type": "TypeString", - "description": "Storage pool name", + "description": "A unique name for the new Satellite location", + "cloud_data_type": "region", "required": true }, { - "name": "max_allocation_size", - "type": "TypeInt", - "description": "Maximum allocation storage size (GB)", + "name": "description", + "type": "TypeString", + "description": "A description of the new Satellite location", "computed": true }, { - "name": "storage_type", + "name": "logging_account_id", "type": "TypeString", - "description": "Storage type of the storage pool", + "description": "The account ID for IBM Log Analysis with LogDNA log forwarding", "computed": true - } - ], - "ibm_pi_storage_pools_capacity": [ + }, { - "name": "maximum_storage_allocation", - "type": "TypeMap", - "description": "Maximum storage allocation", + "name": "ingress_secret", + "type": "TypeString", + "secure": true, "computed": true }, { - "name": "storage_pools_capacity", - "type": "TypeList", - "description": "Storage pools capacity", + "name": "zones", + "type": "TypeSet", + "description": "The names of at least three high availability zones to use for the location", "computed": true, "elem": { - "max_allocation_size": { - "name": "max_allocation_size", - "type": "TypeInt", - "description": "Maximum allocation storage size (GB)", - "computed": true - }, - "pool_name": { - "name": "pool_name", - "type": "TypeString", - "description": "Pool name", - "computed": true - }, - "storage_type": { - "name": "storage_type", - "type": "TypeString", - "description": "Storage type of the storage pool", - "computed": true - }, - "total_capacity": { - "name": "total_capacity", - "type": "TypeInt", - "description": "Total pool capacity (GB)", - "computed": true - } + "type": "TypeString" } }, { - "name": "pi_cloud_instance_id", - "type": "TypeString", - "required": true - } - ], - "ibm_pi_storage_type_capacity": [ - { - "name": "pi_cloud_instance_id", + "name": "resource_group_name", "type": "TypeString", - "required": true + "description": "Name of the resource group", + "computed": true }, { - "name": "pi_storage_type", + "name": "ingress_hostname", "type": "TypeString", - "description": "Storage type name", - "required": true - }, - { - "name": "maximum_storage_allocation", - "type": "TypeMap", - "description": "Maximum storage allocation", "computed": true }, { - "name": "storage_pools_capacity", + "name": "hosts", "type": "TypeList", - "description": "Storage pools capacity", "computed": true, "elem": { - "max_allocation_size": { - "name": "max_allocation_size", - "type": "TypeInt", - "description": "Maximum allocation storage size (GB)", + "cluster_name": { + "name": "cluster_name", + "type": "TypeString", "computed": true }, - "pool_name": { - "name": "pool_name", + "host_id": { + "name": "host_id", "type": "TypeString", - "description": "Pool name", "computed": true }, - "storage_type": { - "name": "storage_type", + "host_labels": { + "name": "host_labels", + "type": "TypeMap", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "host_name": { + "name": "host_name", "type": "TypeString", - "description": "Storage type of the storage pool", "computed": true }, - "total_capacity": { - "name": "total_capacity", - "type": "TypeInt", - "description": "Total pool capacity (GB)", + "ip_address": { + "name": "ip_address", + "type": "TypeString", + "computed": true + }, + "status": { + "name": "status", + "type": "TypeString", + "computed": true + }, + "zone": { + "name": "zone", + "type": "TypeString", "computed": true } } - } - ], - "ibm_pi_storage_types_capacity": [ + }, { - "name": "pi_cloud_instance_id", + "name": "managed_from", "type": "TypeString", - "required": true + "description": "The IBM Cloud metro from which the Satellite location is managed", + "computed": true }, { - "name": "maximum_storage_allocation", - "type": "TypeMap", - "description": "Maximum storage allocation", + "name": "coreos_enabled", + "type": "TypeBool", + "description": "If Red Hat CoreOS features are enabled within the Satellite location", "computed": true }, { - "name": "storage_types_capacity", - "type": "TypeList", - "description": "Storage types capacity", + "name": "tags", + "type": "TypeSet", + "cloud_data_type": "tags", "computed": true, "elem": { - "maximum_storage_allocation": { - "name": "maximum_storage_allocation", - "type": "TypeMap", - "description": "Maximum storage allocation", - "computed": true - }, - "storage_pools_capacity": { - "name": "storage_pools_capacity", - "type": "TypeList", - "description": "Storage pools capacity", - "computed": true, - "elem": { - "max_allocation_size": { - "name": "max_allocation_size", - "type": "TypeInt", - "description": "Maximum allocation storage size (GB)", - "computed": true - }, - "pool_name": { - "name": "pool_name", - "type": "TypeString", - "description": "Pool name", - "computed": true - }, - "storage_type": { - "name": "storage_type", - "type": "TypeString", - "description": "Storage type of the storage pool", - "computed": true - }, - "total_capacity": { - "name": "total_capacity", - "type": "TypeInt", - "description": "Total pool capacity (GB)", - "computed": true - } - } - }, - "storage_type": { - "name": "storage_type", - "type": "TypeString", - "description": "The storage type", - "computed": true - } + "type": "TypeString" } } ], - "ibm_pi_system_pools": [ + "ibm_satellite_location_nlb_dns": [ { - "name": "pi_cloud_instance_id", + "name": "location", "type": "TypeString", + "description": "A unique name of the Location", + "cloud_data_type": "region", "required": true }, { - "name": "system_pools", + "name": "nlb_config", "type": "TypeList", - "description": "List of available system pools within a particular DataCenter", + "description": "List of nlb config of Location", "computed": true, - "elem": { - "capacity": { - "name": "capacity", - "type": "TypeMap", - "description": "Advertised capacity cores and memory (GB)", + "elem": { + "cluster": { + "name": "cluster", + "type": "TypeString", + "description": "Cluster Id.", "computed": true }, - "core_memory_ratio": { - "name": "core_memory_ratio", - "type": "TypeFloat", - "description": "Processor to Memory (GB) Ratio", + "dns_type": { + "name": "dns_type", + "type": "TypeString", + "description": "Type of DNS.", "computed": true }, - "max_available": { - "name": "max_available", - "type": "TypeMap", - "description": "Maximum configurable cores and memory (GB) (aggregated from all hosts)", + "lb_hostname": { + "name": "lb_hostname", + "type": "TypeString", + "description": "Host Name of load Balancer.", "computed": true }, - "max_cores_available": { - "name": "max_cores_available", - "type": "TypeMap", - "description": "Maximum configurable cores available combined with available memory of that host", - "computed": true + "nlb_ips": { + "name": "nlb_ips", + "type": "TypeList", + "description": "NLB IPs.", + "computed": true, + "elem": { + "type": "TypeString" + } }, - "max_memory_available": { - "name": "max_memory_available", - "type": "TypeMap", - "description": "Maximum configurable memory available combined with available cores of that host", + "nlb_sub_domain": { + "name": "nlb_sub_domain", + "type": "TypeString", + "description": "NLB Sub-Domain.", "computed": true }, - "shared_core_ratio": { - "name": "shared_core_ratio", - "type": "TypeMap", - "description": "The min-max-default allocation percentage of shared core per vCPU", + "secret_name": { + "name": "secret_name", + "type": "TypeString", + "description": "Name of the secret.", "computed": true }, - "system_pool_name": { - "name": "system_pool_name", + "secret_namespace": { + "name": "secret_namespace", "type": "TypeString", - "description": "The system pool name", + "description": "Namespace of Secret.", "computed": true }, - "systems": { - "name": "systems", - "type": "TypeList", - "description": "The DataCenter list of servers and their available resources", - "computed": true, - "elem": { - "cores": { - "name": "cores", - "type": "TypeString", - "description": "The host available Processor units", - "computed": true - }, - "id": { - "name": "id", - "type": "TypeString", - "description": "The host identifier", - "computed": true - }, - "memory": { - "name": "memory", - "type": "TypeString", - "description": "The host available RAM memory in GiB", - "computed": true - } - } + "secret_status": { + "name": "secret_status", + "type": "TypeString", + "description": "Status of Secret.", + "computed": true }, "type": { "name": "type", "type": "TypeString", - "description": "Type of system hardware", + "description": "Nlb Type.", "computed": true } } } ], - "ibm_pi_tenant": [ - { - "name": "tenant_name", - "type": "TypeString", - "computed": true - }, - { - "name": "cloud_instances", - "type": "TypeSet", - "computed": true, - "elem": { - "cloud_instance_id": { - "name": "cloud_instance_id", - "type": "TypeString", - "computed": true - }, - "region": { - "name": "region", - "type": "TypeString", - "computed": true - } - } - }, + "ibm_satellite_storage_assignment": [ { - "name": "pi_cloud_instance_id", + "name": "uuid", "type": "TypeString", + "description": "The Universally Unique IDentifier (UUID) of the Assignment.", "required": true }, { - "name": "creation_date", + "name": "config", "type": "TypeString", + "description": "Storage Configuration Name or ID.", "computed": true }, { - "name": "enabled", - "type": "TypeBool", + "name": "config_uuid", + "type": "TypeString", + "description": "The Universally Unique IDentifier (UUID) of the Storage Configuration.", "computed": true - } - ], - "ibm_pi_volume": [ + }, { - "name": "volume_pool", + "name": "assignment_type", "type": "TypeString", + "description": "The Type of Assignment.", "computed": true }, { - "name": "replication_type", - "type": "TypeString", - "description": "Replication type(metro,global)", + "name": "rollout_error_count", + "type": "TypeInt", + "description": "The Rollout Error Count of the Assignment.", "computed": true }, { - "name": "replication_status", + "name": "assignment_name", "type": "TypeString", - "description": "Replication status of a volume", + "description": "Name of the Assignment.", "computed": true }, { - "name": "primary_role", + "name": "config_version", "type": "TypeString", - "description": "Indicates whether master/aux volume is playing the primary role", + "description": "The Storage Configuration Version.", "computed": true }, { - "name": "pi_cloud_instance_id", + "name": "created", "type": "TypeString", - "required": true + "description": "The Time of Creation of the Assignment.", + "computed": true }, { - "name": "size", + "name": "rollout_success_count", "type": "TypeInt", + "description": "The Rollout Success Count of the Assignment.", "computed": true }, { - "name": "disk_type", + "name": "groups", + "type": "TypeList", + "description": "One or more cluster groups on which you want to apply the configuration. Note that at least one cluster group is required.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "cluster", "type": "TypeString", + "description": "ID of the Satellite cluster or Service Cluster that you want to apply the configuration to.", "computed": true }, { - "name": "master_volume_name", + "name": "svc_cluster", "type": "TypeString", - "description": "Indicates master volume name", + "description": "ID of the Service Cluster that you applied the configuration to.", "computed": true }, { - "name": "pi_volume_name", + "name": "config_version_uuid", "type": "TypeString", - "description": "Volume Name to be used for pvminstances", - "required": true + "description": "The Universally Unique IDentifier (UUID) of the Storage Configuration Version.", + "computed": true }, { - "name": "shareable", - "type": "TypeBool", + "name": "owner", + "type": "TypeString", + "description": "The Owner of the Assignment.", "computed": true }, { - "name": "bootable", + "name": "is_assignment_upgrade_available", "type": "TypeBool", + "description": "Whether an Upgrade is Available for the Assignment.", "computed": true }, { - "name": "group_id", + "name": "sat_cluster", "type": "TypeString", - "description": "Volume Group ID", + "description": "ID of the Satellite cluster that you applied the configuration to.", "computed": true - }, + } + ], + "ibm_satellite_storage_configuration": [ { - "name": "mirroring_state", - "type": "TypeString", - "description": "Mirroring state for replication enabled volume", + "name": "user_config_parameters", + "type": "TypeMap", + "description": "The storage configuration parameters depending on the storage template.", "computed": true }, { - "name": "state", + "name": "storage_class_parameters", + "type": "TypeList", + "computed": true, + "elem": { + "type": "TypeMap", + "description": "The List of Storage Class Parameters as a list of a Map of string key-value.", + "elem": { + "type": "TypeString" + } + } + }, + { + "name": "uuid", "type": "TypeString", + "description": "The Universally Unique IDentifier (UUID) of the Storage Configuration.", "computed": true }, { - "name": "wwn", + "name": "location", "type": "TypeString", - "computed": true + "description": "The Location Name.", + "cloud_data_type": "region", + "required": true }, { - "name": "replication_enabled", - "type": "TypeBool", - "description": "Indicates if the volume should be replication enabled or not", - "computed": true + "name": "config_name", + "type": "TypeString", + "description": "Name of the Storage Configuration.", + "required": true }, { - "name": "auxiliary", - "type": "TypeBool", - "description": "true if volume is auxiliary otherwise false", + "name": "config_version", + "type": "TypeString", + "description": "Version of the Storage Configuration.", "computed": true }, { - "name": "consistency_group_name", + "name": "storage_template_name", "type": "TypeString", - "description": "Consistency Group Name if volume is a part of volume group", + "description": "The Storage Template Name.", "computed": true }, { - "name": "auxiliary_volume_name", + "name": "storage_template_version", "type": "TypeString", - "description": "Indicates auxiliary volume name", + "description": "The Storage Template Version.", "computed": true } ], - "ibm_pi_volume_flash_copy_mappings": [ - { - "name": "pi_volume_id", - "type": "TypeString", - "description": "Volume ID", - "required": true - }, - { - "name": "pi_cloud_instance_id", - "type": "TypeString", - "required": true - }, + "ibm_scc_account_location": [], + "ibm_scc_account_location_settings": [], + "ibm_scc_account_locations": [], + "ibm_scc_account_notification_settings": [], + "ibm_scc_control_library": [ { - "name": "flash_copy_mappings", + "name": "controls", "type": "TypeList", + "description": "The list of controls in a control library.", "computed": true, "elem": { - "copy_rate": { - "name": "copy_rate", - "type": "TypeInt", - "description": "Indicates the rate of flash copy operation of a volume", + "control_category": { + "name": "control_category", + "type": "TypeString", + "description": "The control category.", "computed": true }, - "flash_copy_name": { - "name": "flash_copy_name", + "control_description": { + "name": "control_description", "type": "TypeString", - "description": "Indicates flash copy name of the volume", + "description": "The control description.", "computed": true }, - "progress": { - "name": "progress", - "type": "TypeInt", - "description": "Indicates the progress of flash copy operation", - "computed": true + "control_docs": { + "name": "control_docs", + "type": "TypeList", + "description": "The control documentation.", + "computed": true, + "elem": { + "control_docs_id": { + "name": "control_docs_id", + "type": "TypeString", + "description": "The ID of the control documentation.", + "computed": true + }, + "control_docs_type": { + "name": "control_docs_type", + "type": "TypeString", + "description": "The type of control documentation.", + "computed": true + } + } }, - "source_volume_name": { - "name": "source_volume_name", + "control_id": { + "name": "control_id", "type": "TypeString", - "description": "Indicates name of the source volume", + "description": "The control name.", "computed": true }, - "start_time": { - "name": "start_time", + "control_name": { + "name": "control_name", "type": "TypeString", - "description": "Indicates the start time of flash copy operation", + "description": "The ID of the control library that contains the profile.", "computed": true }, - "status": { - "name": "status", + "control_parent": { + "name": "control_parent", "type": "TypeString", - "description": "Copy status of a volume", + "description": "The parent control.", "computed": true }, - "target_volume_name": { - "name": "target_volume_name", - "type": "TypeString", - "description": "Indicates name of the target volume", - "computed": true - } - } - } - ], - "ibm_pi_volume_group": [ - { - "name": "status_description_errors", - "type": "TypeSet", - "computed": true, - "elem": { - "key": { - "name": "key", - "type": "TypeString", + "control_requirement": { + "name": "control_requirement", + "type": "TypeBool", + "description": "Is this a control that can be automated or manually evaluated.", "computed": true }, - "message": { - "name": "message", - "type": "TypeString", - "computed": true + "control_specifications": { + "name": "control_specifications", + "type": "TypeList", + "description": "The control specifications.", + "computed": true, + "elem": { + "assessments": { + "name": "assessments", + "type": "TypeList", + "description": "The assessments.", + "computed": true, + "elem": { + "assessment_description": { + "name": "assessment_description", + "type": "TypeString", + "description": "The assessment description.", + "computed": true + }, + "assessment_id": { + "name": "assessment_id", + "type": "TypeString", + "description": "The assessment ID.", + "computed": true + }, + "assessment_method": { + "name": "assessment_method", + "type": "TypeString", + "description": "The assessment method.", + "computed": true + }, + "assessment_type": { + "name": "assessment_type", + "type": "TypeString", + "description": "The assessment type.", + "computed": true + }, + "parameter_count": { + "name": "parameter_count", + "type": "TypeInt", + "description": "The parameter count.", + "computed": true + }, + "parameters": { + "name": "parameters", + "type": "TypeList", + "description": "The parameters.", + "computed": true, + "elem": { + "parameter_display_name": { + "name": "parameter_display_name", + "type": "TypeString", + "description": "The parameter display name.", + "computed": true + }, + "parameter_name": { + "name": "parameter_name", + "type": "TypeString", + "description": "The parameter name.", + "computed": true + }, + "parameter_type": { + "name": "parameter_type", + "type": "TypeString", + "description": "The parameter type.", + "computed": true + } + } + } + } + }, + "assessments_count": { + "name": "assessments_count", + "type": "TypeInt", + "description": "The number of assessments.", + "computed": true + }, + "component_id": { + "name": "component_id", + "type": "TypeString", + "description": "The component ID.", + "computed": true + }, + "component_name": { + "name": "component_name", + "type": "TypeString", + "description": "The component name.", + "computed": true + }, + "control_specification_description": { + "name": "control_specification_description", + "type": "TypeString", + "description": "The control specifications description.", + "computed": true + }, + "control_specification_id": { + "name": "control_specification_id", + "type": "TypeString", + "description": "The control specification ID.", + "computed": true + }, + "environment": { + "name": "environment", + "type": "TypeString", + "description": "The control specifications environment.", + "computed": true + }, + "responsibility": { + "name": "responsibility", + "type": "TypeString", + "description": "The responsibility for managing the control.", + "computed": true + } + } }, - "volume_ids": { - "name": "volume_ids", + "control_tags": { + "name": "control_tags", "type": "TypeList", + "description": "The control tags.", "computed": true, "elem": { "type": "TypeString" } + }, + "status": { + "name": "status", + "type": "TypeString", + "description": "The control status.", + "computed": true } } }, { - "name": "pi_volume_group_id", + "name": "account_id", "type": "TypeString", - "description": "ID or Name of the volume group", + "description": "The account ID.", + "computed": true + }, + { + "name": "control_library_description", + "type": "TypeString", + "description": "The control library description.", + "computed": true + }, + { + "name": "updated_by", + "type": "TypeString", + "description": "The user who updated the control library.", + "computed": true + }, + { + "name": "controls_count", + "type": "TypeInt", + "description": "The number of controls.", + "computed": true + }, + { + "name": "created_by", + "type": "TypeString", + "description": "The user who created the control library.", + "computed": true + }, + { + "name": "instance_id", + "type": "TypeString", + "description": "The ID of the Security and Compliance Center instance.", + "cloud_data_type": "resource_instance", + "immutable": true, "required": true }, { - "name": "pi_cloud_instance_id", + "name": "control_library_id", "type": "TypeString", + "description": "The control library ID.", "required": true }, { - "name": "volume_group_name", + "name": "control_library_name", "type": "TypeString", - "description": "Volume group name", + "description": "The control library name.", "computed": true }, { - "name": "status", + "name": "control_library_version", "type": "TypeString", + "description": "The control library version.", "computed": true }, { - "name": "replication_status", + "name": "created_on", "type": "TypeString", + "description": "The date when the control library was created.", "computed": true }, { - "name": "consistency_group_name", + "name": "latest", + "type": "TypeBool", + "description": "The latest version of the control library.", + "computed": true + }, + { + "name": "control_parents_count", + "type": "TypeInt", + "description": "The number of parent controls in the control library.", + "computed": true + }, + { + "name": "control_library_type", "type": "TypeString", + "description": "The control library type.", "computed": true - } - ], - "ibm_pi_volume_group_details": [ + }, { - "name": "replication_status", + "name": "version_group_label", "type": "TypeString", + "description": "The version group label.", "computed": true }, { - "name": "consistency_group_name", + "name": "updated_on", "type": "TypeString", + "description": "The date when the control library was updated.", "computed": true }, { - "name": "status_description_errors", - "type": "TypeSet", + "name": "hierarchy_enabled", + "type": "TypeBool", + "description": "The indication of whether hierarchy is enabled for the control library.", + "computed": true + } + ], + "ibm_scc_instance_settings": [ + { + "name": "event_notifications", + "type": "TypeList", + "description": "The Event Notifications settings.", "computed": true, "elem": { - "key": { - "name": "key", + "instance_crn": { + "name": "instance_crn", "type": "TypeString", + "description": "The Event Notifications instance CRN.", "computed": true }, - "message": { - "name": "message", + "source_id": { + "name": "source_id", "type": "TypeString", + "description": "The connected Security and Compliance Center instance CRN.", "computed": true }, - "volume_ids": { - "name": "volume_ids", - "type": "TypeList", - "computed": true, - "elem": { - "type": "TypeString" - } + "updated_on": { + "name": "updated_on", + "type": "TypeString", + "description": "The date when the Event Notifications connection was updated.", + "computed": true } } }, { - "name": "volume_ids", + "name": "object_storage", "type": "TypeList", + "description": "The Cloud Object Storage settings.", "computed": true, "elem": { - "type": "TypeString" + "bucket": { + "name": "bucket", + "type": "TypeString", + "description": "The connected Cloud Object Storage bucket name.", + "computed": true + }, + "bucket_endpoint": { + "name": "bucket_endpoint", + "type": "TypeString", + "description": "The connected Cloud Object Storage bucket endpoint.", + "computed": true + }, + "bucket_location": { + "name": "bucket_location", + "type": "TypeString", + "description": "The connected Cloud Object Storage bucket location.", + "computed": true + }, + "instance_crn": { + "name": "instance_crn", + "type": "TypeString", + "description": "The connected Cloud Object Storage instance CRN.", + "computed": true + }, + "updated_on": { + "name": "updated_on", + "type": "TypeString", + "description": "The date when the bucket connection was updated.", + "computed": true + } } }, { - "name": "pi_volume_group_id", + "name": "instance_id", "type": "TypeString", - "description": "Name of the volume group", + "description": "The ID of the Security and Compliance Center instance.", + "cloud_data_type": "resource_instance", + "immutable": true, "required": true - }, + } + ], + "ibm_scc_latest_reports": [ { - "name": "pi_cloud_instance_id", + "name": "sort", "type": "TypeString", - "required": true + "description": "This field sorts results by using a valid sort field. To learn more, see [Sorting](https://cloud.ibm.com/docs/api-handbook?topic=api-handbook-sorting).", + "optional": true }, { - "name": "volume_group_name", + "name": "home_account_id", "type": "TypeString", - "description": "Volume group name", + "description": "The ID of the home account.", "computed": true }, { - "name": "status", - "type": "TypeString", - "computed": true - } - ], - "ibm_pi_volume_group_remote_copy_relationships": [ - { - "name": "pi_cloud_instance_id", - "type": "TypeString", - "required": true + "name": "controls_summary", + "type": "TypeList", + "description": "The compliance stats.", + "computed": true, + "elem": { + "compliant_count": { + "name": "compliant_count", + "type": "TypeInt", + "description": "The number of compliant checks.", + "computed": true + }, + "not_compliant_count": { + "name": "not_compliant_count", + "type": "TypeInt", + "description": "The number of checks that are not compliant.", + "computed": true + }, + "status": { + "name": "status", + "type": "TypeString", + "description": "The allowed values of an aggregated status for controls, specifications, assessments, and resources.", + "computed": true + }, + "total_count": { + "name": "total_count", + "type": "TypeInt", + "description": "The total number of checks.", + "computed": true + }, + "unable_to_perform_count": { + "name": "unable_to_perform_count", + "type": "TypeInt", + "description": "The number of checks that are unable to perform.", + "computed": true + }, + "user_evaluation_required_count": { + "name": "user_evaluation_required_count", + "type": "TypeInt", + "description": "The number of checks that require a user evaluation.", + "computed": true + } + } }, { - "name": "remote_copy_relationships", + "name": "evaluations_summary", "type": "TypeList", - "description": "List of remote copy relationships", + "description": "The evaluation stats.", "computed": true, "elem": { - "auxiliary_changed_volume_name": { - "name": "auxiliary_changed_volume_name", - "type": "TypeString", - "description": "Name of the volume that is acting as the auxiliary change volume for the relationship", + "completed_count": { + "name": "completed_count", + "type": "TypeInt", + "description": "The total number of completed evaluations.", "computed": true }, - "auxiliary_volume_name": { - "name": "auxiliary_volume_name", - "type": "TypeString", - "description": "Auxiliary volume name at storage host level", + "error_count": { + "name": "error_count", + "type": "TypeInt", + "description": "The number of evaluations that started, but did not finish, and ended with errors.", "computed": true }, - "consistency_group_name": { - "name": "consistency_group_name", - "type": "TypeString", - "description": "Consistency Group Name if volume is a part of volume group", + "failure_count": { + "name": "failure_count", + "type": "TypeInt", + "description": "The number of failed evaluations.", "computed": true }, - "copy_type": { - "name": "copy_type", - "type": "TypeString", - "description": "Indicates the copy type.", + "pass_count": { + "name": "pass_count", + "type": "TypeInt", + "description": "The number of passed evaluations.", "computed": true }, - "cycling_mode": { - "name": "cycling_mode", + "status": { + "name": "status", "type": "TypeString", - "description": "Indicates the type of cycling mode used.", + "description": "The allowed values of an aggregated status for controls, specifications, assessments, and resources.", "computed": true }, - "freeze_time": { - "name": "freeze_time", - "type": "TypeString", - "description": "Freeze time of remote copy relationship", + "total_count": { + "name": "total_count", + "type": "TypeInt", + "description": "The total number of evaluations.", + "computed": true + } + } + }, + { + "name": "score", + "type": "TypeList", + "description": "The compliance score.", + "computed": true, + "elem": { + "passed": { + "name": "passed", + "type": "TypeInt", + "description": "The number of successful evaluations.", "computed": true }, - "master_changed_volume_name": { - "name": "master_changed_volume_name", - "type": "TypeString", - "description": "Name of the volume that is acting as the master change volume for the relationship", + "percent": { + "name": "percent", + "type": "TypeInt", + "description": "The percentage of successful evaluations.", "computed": true }, - "master_volume_name": { - "name": "master_volume_name", + "total_count": { + "name": "total_count", + "type": "TypeInt", + "description": "The total number of evaluations.", + "computed": true + } + } + }, + { + "name": "reports", + "type": "TypeList", + "description": "The list of reports.", + "computed": true, + "elem": { + "account": { + "name": "account", + "type": "TypeList", + "description": "The account that is associated with a report.", + "computed": true, + "elem": { + "id": { + "name": "id", + "type": "TypeString", + "description": "The account ID.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The account name.", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "The account type.", + "computed": true + } + } + }, + "attachment": { + "name": "attachment", + "type": "TypeList", + "description": "The attachment that is associated with a report.", + "computed": true, + "elem": { + "description": { + "name": "description", + "type": "TypeString", + "description": "The description of the attachment.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The attachment ID.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The name of the attachment.", + "computed": true + }, + "schedule": { + "name": "schedule", + "type": "TypeString", + "description": "The attachment schedule.", + "computed": true + }, + "scope": { + "name": "scope", + "type": "TypeList", + "description": "The scope of the attachment.", + "computed": true, + "elem": { + "environment": { + "name": "environment", + "type": "TypeString", + "description": "The environment that relates to this scope.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this scope.", + "computed": true + }, + "properties": { + "name": "properties", + "type": "TypeList", + "description": "The properties that are supported for scoping by this environment.", + "computed": true, + "elem": { + "name": { + "name": "name", + "type": "TypeString", + "description": "The property name.", + "computed": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "The property value.", + "computed": true + } + } + } + } + } + } + }, + "cos_object": { + "name": "cos_object", "type": "TypeString", - "description": "Master volume name at storage host level", + "description": "The Cloud Object Storage object that is associated with the report.", "computed": true }, - "name": { - "name": "name", + "created_on": { + "name": "created_on", "type": "TypeString", - "description": "Remote copy relationship name", + "description": "The date when the report was created.", "computed": true }, - "primary_role": { - "name": "primary_role", + "group_id": { + "name": "group_id", "type": "TypeString", - "description": "Indicates whether master/aux volume is playing the primary role", + "description": "The group ID that is associated with the report. The group ID combines profile, scope, and attachment IDs.", "computed": true }, - "progress": { - "name": "progress", - "type": "TypeInt", - "description": "Indicates the relationship progress", + "id": { + "name": "id", + "type": "TypeString", + "description": "The ID of the report.", "computed": true }, - "remote_copy_id": { - "name": "remote_copy_id", + "instance_id": { + "name": "instance_id", "type": "TypeString", - "description": "Remote copy relationship ID", + "description": "Instance ID.", "computed": true }, - "state": { - "name": "state", + "profile": { + "name": "profile", + "type": "TypeList", + "description": "The profile information.", + "computed": true, + "elem": { + "id": { + "name": "id", + "type": "TypeString", + "description": "The profile ID.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The profile name.", + "computed": true + }, + "version": { + "name": "version", + "type": "TypeString", + "description": "The profile version.", + "computed": true + } + } + }, + "scan_time": { + "name": "scan_time", "type": "TypeString", - "description": "Indicates the relationship state", + "description": "The date when the scan was run.", "computed": true }, - "synchronized": { - "name": "synchronized", + "type": { + "name": "type", "type": "TypeString", - "description": "Indicates whether the relationship is synchronized", + "description": "The type of the scan.", "computed": true } } }, { - "name": "pi_volume_group_id", + "name": "instance_id", "type": "TypeString", - "description": "Volume group ID", + "description": "The ID of the Security and Compliance Center instance.", + "cloud_data_type": "resource_instance", + "immutable": true, "required": true } ], - "ibm_pi_volume_group_storage_details": [ + "ibm_scc_profile": [ { - "name": "consistency_group_name", + "name": "created_by", "type": "TypeString", - "description": "The name of consistency group at storage controller level", + "description": "The user who created the profile.", "computed": true }, { - "name": "remote_copy_relationship_names", - "type": "TypeList", - "description": "List of remote-copy relationship names in a volume group", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "attachments_count", + "type": "TypeInt", + "description": "The number of attachments related to this profile.", + "computed": true }, { - "name": "replication_type", + "name": "latest", + "type": "TypeBool", + "description": "The latest version of the profile.", + "computed": true + }, + { + "name": "created_on", "type": "TypeString", - "description": "Type of replication(metro,global)", + "description": "The date when the profile was created.", "computed": true }, { - "name": "pi_cloud_instance_id", + "name": "profile_version", "type": "TypeString", + "description": "The version status of the profile.", + "computed": true + }, + { + "name": "profile_type", + "type": "TypeString", + "description": "The profile type, such as custom or predefined.", + "computed": true + }, + { + "name": "instance_id", + "type": "TypeString", + "description": "The ID of the Security and Compliance Center instance.", + "cloud_data_type": "resource_instance", + "immutable": true, "required": true }, { - "name": "cycle_period_seconds", - "type": "TypeInt", - "description": "Indicates the minimum period in seconds between multiple cycles", + "name": "hierarchy_enabled", + "type": "TypeBool", + "description": "The indication of whether hierarchy is enabled for the profile.", "computed": true }, { - "name": "cycling_mode", + "name": "updated_by", "type": "TypeString", - "description": "Indicates the type of cycling mode used", + "description": "The user who updated the profile.", "computed": true }, { - "name": "number_of_volumes", + "name": "controls_count", "type": "TypeInt", - "description": "Number of volumes in volume group", + "description": "The number of controls for the profile.", "computed": true }, { - "name": "primary_role", + "name": "profile_name", "type": "TypeString", - "description": "Indicates whether master/aux volume is playing the primary role", + "description": "The profile name.", "computed": true }, { - "name": "state", + "name": "profile_description", "type": "TypeString", - "description": "Indicates the relationship state", + "description": "The profile description.", "computed": true }, { - "name": "synchronized", + "name": "version_group_label", "type": "TypeString", - "description": "Indicates whether the relationship is synchronized", + "description": "The version group label of the profile.", "computed": true }, { - "name": "pi_volume_group_id", + "name": "updated_on", "type": "TypeString", - "description": "Volume group ID", - "required": true - } - ], - "ibm_pi_volume_groups": [ + "description": "The date when the profile was updated.", + "computed": true + }, { - "name": "pi_cloud_instance_id", - "type": "TypeString", - "required": true + "name": "control_parents_count", + "type": "TypeInt", + "description": "The number of parent controls for the profile.", + "computed": true }, { - "name": "volume_groups", + "name": "controls", "type": "TypeList", + "description": "The array of controls that are used to create the profile.", "computed": true, "elem": { - "consistency_group_name": { - "name": "consistency_group_name", - "type": "TypeString", - "computed": true - }, - "id": { - "name": "id", + "control_category": { + "name": "control_category", "type": "TypeString", + "description": "The control category.", "computed": true }, - "replication_status": { - "name": "replication_status", - "type": "TypeString", - "computed": true - }, - "status": { - "name": "status", + "control_description": { + "name": "control_description", "type": "TypeString", + "description": "The control description.", "computed": true }, - "status_description_errors": { - "name": "status_description_errors", - "type": "TypeSet", + "control_docs": { + "name": "control_docs", + "type": "TypeList", + "description": "The control documentation.", "computed": true, "elem": { - "key": { - "name": "key", + "control_docs_id": { + "name": "control_docs_id", "type": "TypeString", + "description": "The ID of the control documentation.", "computed": true }, - "message": { - "name": "message", + "control_docs_type": { + "name": "control_docs_type", "type": "TypeString", + "description": "The type of control documentation.", "computed": true - }, - "volume_ids": { - "name": "volume_ids", - "type": "TypeList", - "computed": true, - "elem": { - "type": "TypeString" - } } } }, - "volume_group_name": { - "name": "volume_group_name", + "control_id": { + "name": "control_id", "type": "TypeString", + "description": "The unique ID of the control library that contains the profile.", "computed": true - } - } - } - ], - "ibm_pi_volume_groups_details": [ - { - "name": "volume_groups", - "type": "TypeList", - "computed": true, - "elem": { - "consistency_group_name": { - "name": "consistency_group_name", + }, + "control_library_id": { + "name": "control_library_id", "type": "TypeString", + "description": "The ID of the control library that contains the profile.", "computed": true }, - "id": { - "name": "id", + "control_library_version": { + "name": "control_library_version", "type": "TypeString", + "description": "The most recent version of the control library.", "computed": true }, - "replication_status": { - "name": "replication_status", + "control_name": { + "name": "control_name", "type": "TypeString", + "description": "The control name.", "computed": true }, - "status": { - "name": "status", + "control_parent": { + "name": "control_parent", "type": "TypeString", + "description": "The parent control.", "computed": true }, - "status_description_errors": { - "name": "status_description_errors", - "type": "TypeSet", + "control_requirement": { + "name": "control_requirement", + "type": "TypeBool", + "description": "Is this a control that can be automated or manually evaluated.", + "computed": true + }, + "control_specifications": { + "name": "control_specifications", + "type": "TypeList", + "description": "The control specifications.", "computed": true, "elem": { - "key": { - "name": "key", + "assessments": { + "name": "assessments", + "type": "TypeList", + "description": "The assessments.", + "computed": true, + "elem": { + "assessment_description": { + "name": "assessment_description", + "type": "TypeString", + "description": "The assessment description.", + "computed": true + }, + "assessment_id": { + "name": "assessment_id", + "type": "TypeString", + "description": "The assessment ID.", + "computed": true + }, + "assessment_method": { + "name": "assessment_method", + "type": "TypeString", + "description": "The assessment method.", + "computed": true + }, + "assessment_type": { + "name": "assessment_type", + "type": "TypeString", + "description": "The assessment type.", + "computed": true + }, + "parameter_count": { + "name": "parameter_count", + "type": "TypeInt", + "description": "The parameter count.", + "computed": true + }, + "parameters": { + "name": "parameters", + "type": "TypeList", + "description": "The parameters.", + "computed": true, + "elem": { + "parameter_display_name": { + "name": "parameter_display_name", + "type": "TypeString", + "description": "The parameter display name.", + "computed": true + }, + "parameter_name": { + "name": "parameter_name", + "type": "TypeString", + "description": "The parameter name.", + "computed": true + }, + "parameter_type": { + "name": "parameter_type", + "type": "TypeString", + "description": "The parameter type.", + "computed": true + } + } + } + } + }, + "assessments_count": { + "name": "assessments_count", + "type": "TypeInt", + "description": "The number of assessments.", + "computed": true + }, + "component_id": { + "name": "component_id", "type": "TypeString", + "description": "The component ID.", "computed": true }, - "message": { - "name": "message", + "component_name": { + "name": "component_name", "type": "TypeString", + "description": "The component name.", "computed": true }, - "volume_ids": { - "name": "volume_ids", - "type": "TypeList", - "computed": true, - "elem": { - "type": "TypeString" - } + "control_specification_description": { + "name": "control_specification_description", + "type": "TypeString", + "description": "The control specifications description.", + "computed": true + }, + "control_specification_id": { + "name": "control_specification_id", + "type": "TypeString", + "description": "The control specification ID.", + "computed": true + }, + "environment": { + "name": "environment", + "type": "TypeString", + "description": "The control specifications environment.", + "computed": true + }, + "responsibility": { + "name": "responsibility", + "type": "TypeString", + "description": "The responsibility for managing the control.", + "computed": true } } }, - "volume_group_name": { - "name": "volume_group_name", - "type": "TypeString", + "control_specifications_count": { + "name": "control_specifications_count", + "type": "TypeInt", + "description": "The number of control specifications.", "computed": true - }, - "volume_ids": { - "name": "volume_ids", - "type": "TypeList", - "computed": true, - "elem": { - "type": "TypeString" - } } } }, { - "name": "pi_cloud_instance_id", - "type": "TypeString", - "required": true - } - ], - "ibm_pi_volume_onboarding": [ - { - "name": "results_volume_onboarding_failures", + "name": "default_parameters", "type": "TypeList", + "description": "The default parameters of the profile.", "computed": true, "elem": { - "failure_message": { - "name": "failure_message", + "assessment_id": { + "name": "assessment_id", "type": "TypeString", - "description": "The failure reason for the volumes which have failed to be onboarded", + "description": "The implementation ID of the parameter.", "computed": true }, - "volumes": { - "name": "volumes", - "type": "TypeList", - "description": "List of volumes which have failed to be onboarded", - "computed": true, - "elem": { - "type": "TypeString" - } + "assessment_type": { + "name": "assessment_type", + "type": "TypeString", + "description": "The type of the implementation.", + "computed": true + }, + "parameter_default_value": { + "name": "parameter_default_value", + "type": "TypeString", + "description": "The default value of the parameter.", + "computed": true + }, + "parameter_display_name": { + "name": "parameter_display_name", + "type": "TypeString", + "description": "The parameter display name.", + "computed": true + }, + "parameter_name": { + "name": "parameter_name", + "type": "TypeString", + "description": "The parameter name.", + "computed": true + }, + "parameter_type": { + "name": "parameter_type", + "type": "TypeString", + "description": "The parameter type.", + "computed": true } } }, { - "name": "status", + "name": "profile_id", "type": "TypeString", - "description": "Indicates the status of volume onboarding operation", - "computed": true + "description": "The profile ID.", + "required": true + } + ], + "ibm_scc_profile_attachment": [ + { + "name": "profile_id", + "type": "TypeString", + "description": "The profile ID.", + "required": true }, { - "name": "pi_volume_onboarding_id", + "name": "instance_id", "type": "TypeString", - "description": "Volume onboarding ID", + "description": "The ID of the Security and Compliance Center instance.", + "cloud_data_type": "resource_instance", + "immutable": true, "required": true }, { - "name": "input_volumes", - "type": "TypeList", - "description": "List of volumes requested to be onboarded", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "updated_by", + "type": "TypeString", + "description": "The user who updated the attachment.", + "computed": true }, { - "name": "results_onboarded_volumes", + "name": "attachment_parameters", "type": "TypeList", - "description": "List of volumes which are onboarded successfully", + "description": "The profile parameters for the attachment.", "computed": true, "elem": { - "type": "TypeString" + "assessment_id": { + "name": "assessment_id", + "type": "TypeString", + "description": "The implementation ID of the parameter.", + "computed": true + }, + "assessment_type": { + "name": "assessment_type", + "type": "TypeString", + "description": "The type of the implementation.", + "computed": true + }, + "parameter_display_name": { + "name": "parameter_display_name", + "type": "TypeString", + "description": "The parameter display name.", + "computed": true + }, + "parameter_name": { + "name": "parameter_name", + "type": "TypeString", + "description": "The parameter name.", + "computed": true + }, + "parameter_type": { + "name": "parameter_type", + "type": "TypeString", + "description": "The parameter type.", + "computed": true + }, + "parameter_value": { + "name": "parameter_value", + "type": "TypeString", + "description": "The value of the parameter.", + "computed": true + } } }, { - "name": "progress", - "type": "TypeInt", - "description": "Indicates the progress of volume onboarding operation", + "name": "attachment_item_id", + "type": "TypeString", + "description": "The ID of the attachment.", "computed": true }, { - "name": "pi_cloud_instance_id", + "name": "created_on", "type": "TypeString", - "required": true + "description": "The date when the attachment was created.", + "computed": true }, { - "name": "create_time", + "name": "schedule", "type": "TypeString", - "description": "Indicates the create time of volume onboarding operation", + "description": "The schedule of an attachment evaluation.", "computed": true }, { - "name": "description", + "name": "next_scan_time", "type": "TypeString", - "description": "Description of the volume onboarding operation", + "description": "The start time of the next scan.", "computed": true - } - ], - "ibm_pi_volume_onboardings": [ - { - "name": "pi_cloud_instance_id", - "type": "TypeString", - "required": true }, { - "name": "onboardings", + "name": "scope", "type": "TypeList", - "description": "The list of volume onboardings", + "description": "The scope payload for the multi cloud feature.", "computed": true, "elem": { - "description": { - "name": "description", - "type": "TypeString", - "description": "Description of the volume onboarding operation", - "computed": true - }, - "id": { - "name": "id", + "environment": { + "name": "environment", "type": "TypeString", - "description": "Indicates the volume onboarding operation id", + "description": "The environment that relates to this scope.", "computed": true }, - "input_volumes": { - "name": "input_volumes", + "properties": { + "name": "properties", "type": "TypeList", - "description": "List of volumes requested to be onboarded", + "description": "The properties supported for scoping by this environment.", "computed": true, "elem": { - "type": "TypeString" + "name": { + "name": "name", + "type": "TypeString", + "description": "The name of the property.", + "computed": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "The value of the property.", + "computed": true + } + } + } + } + }, + { + "name": "created_by", + "type": "TypeString", + "description": "The user who created the attachment.", + "computed": true + }, + { + "name": "updated_on", + "type": "TypeString", + "description": "The date when the attachment was updated.", + "computed": true + }, + { + "name": "notifications", + "type": "TypeList", + "description": "The request payload of the attachment notifications.", + "computed": true, + "elem": { + "controls": { + "name": "controls", + "type": "TypeList", + "description": "The failed controls.", + "computed": true, + "elem": { + "failed_control_ids": { + "name": "failed_control_ids", + "type": "TypeList", + "description": "The failed control IDs.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "threshold_limit": { + "name": "threshold_limit", + "type": "TypeInt", + "description": "The threshold limit.", + "computed": true + } } }, - "status": { - "name": "status", - "type": "TypeString", - "description": "Indicates the status of volume onboarding operation", + "enabled": { + "name": "enabled", + "type": "TypeBool", + "description": "enabled notifications.", "computed": true } } - } - ], - "ibm_pi_volume_remote_copy_relationship": [ - { - "name": "state", - "type": "TypeString", - "description": "Indicates the relationship state", - "computed": true - }, - { - "name": "pi_cloud_instance_id", - "type": "TypeString", - "required": true }, { - "name": "consistency_group_name", + "name": "description", "type": "TypeString", - "description": "Consistency Group Name if volume is a part of volume group", + "description": "The description for the attachment.", "computed": true }, { - "name": "freeze_time", + "name": "attachment_id", "type": "TypeString", - "description": "Freeze time of remote copy relationship", - "computed": true + "description": "The attachment ID.", + "required": true }, { - "name": "master_changed_volume_name", + "name": "account_id", "type": "TypeString", - "description": "Name of the volume that is acting as the master change volume for the relationship", + "description": "The account ID that is associated to the attachment.", "computed": true }, { - "name": "auxiliary_volume_name", + "name": "status", "type": "TypeString", - "description": "Auxiliary volume name at storage host level", - "computed": true - }, - { - "name": "cycle_period_seconds", - "type": "TypeInt", - "description": "Indicates the minimum period in seconds between multiple cycles", + "description": "The status of an attachment evaluation.", "computed": true }, { - "name": "remote_copy_id", - "type": "TypeString", - "description": "Remote copy relationship ID", - "computed": true + "name": "last_scan", + "type": "TypeList", + "description": "The details of the last scan of an attachment.", + "computed": true, + "elem": { + "id": { + "name": "id", + "type": "TypeString", + "description": "The ID of the last scan of an attachment.", + "computed": true + }, + "status": { + "name": "status", + "type": "TypeString", + "description": "The status of the last scan of an attachment.", + "computed": true + }, + "time": { + "name": "time", + "type": "TypeString", + "description": "The time when the last scan started.", + "computed": true + } + } }, { - "name": "synchronized", + "name": "name", "type": "TypeString", - "description": "Indicates whether the relationship is synchronized", + "description": "The name of the attachment.", "computed": true - }, + } + ], + "ibm_scc_provider_type": [ { - "name": "primary_role", + "name": "icon", "type": "TypeString", - "description": "Indicates whether master/aux volume is playing the primary role", + "description": "The icon of a provider in .svg format that is encoded as a base64 string.", "computed": true }, { - "name": "progress", - "type": "TypeInt", - "description": "Indicates the relationship progress", - "computed": true + "name": "attributes", + "type": "TypeMap", + "description": "The attributes that are required when you're creating an instance of a provider type. The attributes field can have multiple keys in its value. Each of those keys has a value object that includes the type, and display name as keys. For example, `{type:\"\", display_name:\"\"}`. **NOTE;** If the provider type is s2s-enabled, which means that if the `s2s_enabled` field is set to `true`, then a CRN field of type text is required in the attributes value object.", + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "master_volume_name", + "name": "updated_at", "type": "TypeString", - "description": "Master volume name at storage host level", + "description": "Time at which resource was updated.", "computed": true }, { "name": "name", "type": "TypeString", - "description": "Remote copy relationship name", + "description": "The name of the provider type.", "computed": true }, { - "name": "pi_volume_id", - "type": "TypeString", - "description": "Volume name", - "required": true + "name": "label", + "type": "TypeList", + "description": "The label that is associated with the provider type.", + "computed": true, + "elem": { + "text": { + "name": "text", + "type": "TypeString", + "description": "The text of the label.", + "computed": true + }, + "tip": { + "name": "tip", + "type": "TypeString", + "description": "The text to be shown when user hover overs the label.", + "computed": true + } + } }, { - "name": "auxiliary_changed_volume_name", + "name": "id", "type": "TypeString", - "description": "Name of the volume that is acting as the auxiliary change volume for the relationship", + "description": "The unique identifier of the provider type.", "computed": true }, { - "name": "copy_type", + "name": "type", "type": "TypeString", - "description": "Indicates the copy type.", + "description": "The type of the provider type.", "computed": true }, { - "name": "cycling_mode", - "type": "TypeString", - "description": "Indicates the type of cycling mode used.", + "name": "s2s_enabled", + "type": "TypeBool", + "description": "A boolean that indicates whether the provider type is s2s-enabled.", "computed": true - } - ], - "ibm_pn_application_chrome": [ - { - "name": "guid", - "type": "TypeString", - "description": "Unique guid of the application using the push service.", - "required": true }, { - "name": "server_key", + "name": "mode", "type": "TypeString", - "description": "A server key that gives the push service an authorized access to Google services that is used for Chrome Web Push.", + "description": "The mode that is used to get results from provider (`PUSH` or `PULL`).", "computed": true }, { - "name": "web_site_url", + "name": "created_at", "type": "TypeString", - "description": "The URL of the WebSite / WebApp that should be permitted to subscribe to WebPush.", + "description": "Time at which resource was created.", "computed": true - } - ], - "ibm_project_event_notification": [ + }, { - "name": "project_id", + "name": "provider_type_id", "type": "TypeString", - "description": "The unique project ID.", + "description": "The provider type ID.", "required": true }, { - "name": "name", + "name": "description", "type": "TypeString", - "description": "The project name.", + "description": "The provider type description.", "computed": true }, { - "name": "description", - "type": "TypeString", - "description": "A project descriptive text.", + "name": "instance_limit", + "type": "TypeInt", + "description": "The maximum number of instances that can be created for the provider type.", "computed": true }, { - "name": "crn", + "name": "data_type", "type": "TypeString", - "description": "An IBM Cloud resource name, which uniquely identifies a resource.", - "cloud_data_type": "crn", + "description": "The format of the results that a provider supports.", "computed": true - }, + } + ], + "ibm_scc_provider_type_collection": [ { - "name": "configs", + "name": "provider_types", "type": "TypeList", - "description": "The project configurations.", + "description": "The array of provder type.", "computed": true, "elem": { - "description": { - "name": "description", - "type": "TypeString", - "description": "The project configuration description.", - "computed": true - }, - "id": { - "name": "id", - "type": "TypeString", - "description": "The ID of the configuration. If this parameter is empty, an ID is automatically created for the configuration.", - "computed": true - }, - "input": { - "name": "input", - "type": "TypeList", - "description": "The outputs of a Schematics template property.", - "computed": true, - "elem": { - "name": { - "name": "name", - "type": "TypeString", - "description": "The variable name.", - "computed": true - }, - "required": { - "name": "required", - "type": "TypeBool", - "description": "Whether the variable is required or not.", - "computed": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "The variable type.", - "computed": true - }, - "value": { - "name": "value", - "type": "TypeString", - "description": "Can be any value - a string, number, boolean, array, or object.", - "computed": true - } - } - }, - "labels": { - "name": "labels", - "type": "TypeList", - "description": "A collection of configuration labels.", + "attributes": { + "name": "attributes", + "type": "TypeMap", + "description": "The attributes that are required when you're creating an instance of a provider type. The attributes field can have multiple keys in its value. Each of those keys has a value object that includes the type, and display name as keys. For example, `{type:\"\", display_name:\"\"}`. **NOTE;** If the provider type is s2s-enabled, which means that if the `s2s_enabled` field is set to `true`, then a CRN field of type text is required in the attributes value object.", "computed": true, "elem": { "type": "TypeString" } }, - "locator_id": { - "name": "locator_id", + "created_at": { + "name": "created_at", "type": "TypeString", - "description": "A dotted value of catalogID.versionID.", + "description": "Time at which resource was created.", "computed": true }, - "name": { - "name": "name", + "data_type": { + "name": "data_type", "type": "TypeString", - "description": "The configuration name.", + "description": "The format of the results that a provider supports.", "computed": true }, - "output": { - "name": "output", - "type": "TypeList", - "description": "The outputs of a Schematics template property.", - "computed": true, - "elem": { - "description": { - "name": "description", - "type": "TypeString", - "description": "A short explanation of the output value.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "The variable name.", - "computed": true - }, - "value": { - "name": "value", - "type": "TypeString", - "description": "Can be any value - a string, number, boolean, array, or object.", - "computed": true - } - } - }, - "setting": { - "name": "setting", - "type": "TypeList", - "description": "Schematics environment variables to use to deploy the configuration.", - "computed": true, - "elem": { - "name": { - "name": "name", - "type": "TypeString", - "description": "The name of the configuration setting.", - "computed": true - }, - "value": { - "name": "value", - "type": "TypeString", - "description": "The value of the configuration setting.", - "computed": true - } - } - }, - "type": { - "name": "type", + "description": { + "name": "description", "type": "TypeString", - "description": "The type of a project configuration manual property.", + "description": "The provider type description.", "computed": true - } - } - }, - { - "name": "metadata", - "type": "TypeList", - "description": "The metadata of the project.", - "computed": true, - "elem": { - "created_at": { - "name": "created_at", + }, + "icon": { + "name": "icon", "type": "TypeString", - "description": "A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ, matching the date and time format as specified by RFC 3339.", + "description": "The icon of a provider in .svg format that is encoded as a base64 string.", "computed": true }, - "crn": { - "name": "crn", + "id": { + "name": "id", "type": "TypeString", - "description": "An IBM Cloud resource name, which uniquely identifies a resource.", + "description": "The unique identifier of the provider type.", "computed": true }, - "cumulative_needs_attention_view": { - "name": "cumulative_needs_attention_view", + "instance_limit": { + "name": "instance_limit", + "type": "TypeInt", + "description": "The maximum number of instances that can be created for the provider type.", + "computed": true + }, + "label": { + "name": "label", "type": "TypeList", - "description": "The cumulative list of needs attention items for a project.", + "description": "The label that is associated with the provider type.", "computed": true, "elem": { - "config_id": { - "name": "config_id", - "type": "TypeString", - "description": "The unique ID of a project.", - "computed": true - }, - "config_version": { - "name": "config_version", - "type": "TypeInt", - "description": "The version number of the configuration.", - "computed": true - }, - "event": { - "name": "event", + "text": { + "name": "text", "type": "TypeString", - "description": "The event name.", + "description": "The text of the label.", "computed": true }, - "event_id": { - "name": "event_id", + "tip": { + "name": "tip", "type": "TypeString", - "description": "The unique ID of a project.", + "description": "The text to be shown when user hover overs the label.", "computed": true } } }, - "cumulative_needs_attention_view_err": { - "name": "cumulative_needs_attention_view_err", + "mode": { + "name": "mode", "type": "TypeString", - "description": "True indicates that the fetch of the needs attention items failed.", + "description": "The mode that is used to get results from provider (`PUSH` or `PULL`).", "computed": true }, - "event_notifications_crn": { - "name": "event_notifications_crn", + "name": { + "name": "name", "type": "TypeString", - "description": "The CRN of the event notifications instance if one is connected to this project.", + "description": "The name of the provider type.", "computed": true }, - "location": { - "name": "location", - "type": "TypeString", - "description": "The IBM Cloud location where a resource is deployed.", + "s2s_enabled": { + "name": "s2s_enabled", + "type": "TypeBool", + "description": "A boolean that indicates whether the provider type is s2s-enabled.", "computed": true }, - "resource_group": { - "name": "resource_group", + "type": { + "name": "type", "type": "TypeString", - "description": "The resource group where the project's data and tools are created.", + "description": "The type of the provider type.", "computed": true }, - "state": { - "name": "state", + "updated_at": { + "name": "updated_at", "type": "TypeString", - "description": "The project status value.", + "description": "Time at which resource was updated.", "computed": true } } } ], - "ibm_resource_group": [ + "ibm_scc_provider_type_instance": [ { - "name": "is_default", - "type": "TypeBool", - "description": "Default Resource group", - "optional": true, + "name": "attributes", + "type": "TypeMap", "computed": true }, { - "name": "crn", + "name": "updated_at", "type": "TypeString", - "description": "The full CRN associated with the resource group", - "cloud_data_type": "crn", + "description": "Time at which resource was updated.", "computed": true }, { - "name": "teams_url", + "name": "provider_type_id", "type": "TypeString", - "description": "The URL to access the team details that associated with the resource group.", - "computed": true + "description": "The provider type ID.", + "required": true }, { - "name": "payment_methods_url", + "name": "provider_type_instance_id", "type": "TypeString", - "description": "The URL to access the payment methods details that associated with the resource group.", - "computed": true + "description": "The provider type instance ID.", + "required": true }, { - "name": "quota_id", + "name": "provider_type_instance_item_id", "type": "TypeString", - "description": "An alpha-numeric value identifying the quota ID associated with the resource group.", + "description": "The unique identifier of the provider type instance.", "computed": true }, { - "name": "resource_linkages", - "type": "TypeSet", - "description": "An array of the resources that linked to the resource group", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "account_id", + "name": "type", "type": "TypeString", - "description": "Account ID", + "description": "The type of the provider type.", "computed": true }, { "name": "name", "type": "TypeString", - "description": "Resource group name", - "cloud_data_type": "resource_group", - "optional": true, - "computed": true, - "cloud_data_range": [ - "resolved_to:name" - ] - }, - { - "name": "state", - "type": "TypeString", - "description": "State of the resource group", + "description": "The name of the provider type instance.", "computed": true }, { "name": "created_at", "type": "TypeString", - "description": "The date when the resource group was initially created.", - "computed": true - }, - { - "name": "updated_at", - "type": "TypeString", - "description": "The date when the resource group was last updated.", + "description": "Time at which resource was created.", "computed": true }, { - "name": "quota_url", + "name": "instance_id", "type": "TypeString", - "description": "The URL to access the quota details that associated with the resource group.", - "computed": true + "description": "The ID of the Security and Compliance Center instance.", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true } ], - "ibm_resource_instance": [ + "ibm_scc_report": [ { - "name": "resource_group_name", + "name": "cos_object", "type": "TypeString", - "description": "The resource group name in which resource is provisioned", - "computed": true - }, - { - "name": "extensions", - "type": "TypeMap", - "description": "The extended metadata as a map associated with the resource instance.", + "description": "The Cloud Object Storage object that is associated with the report.", "computed": true }, { - "name": "name", + "name": "instance_id", "type": "TypeString", - "description": "Resource instance name for example, myobjectstorage", + "description": "The ID of the Security and Compliance Center instance.", + "cloud_data_type": "resource_instance", + "immutable": true, "required": true }, { - "name": "service", - "type": "TypeString", - "description": "The service type of the instance", - "optional": true, - "computed": true + "name": "account", + "type": "TypeList", + "description": "The account that is associated with a report.", + "computed": true, + "elem": { + "id": { + "name": "id", + "type": "TypeString", + "description": "The account ID.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The account name.", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "The account type.", + "computed": true + } + } }, { - "name": "status", - "type": "TypeString", - "description": "The resource instance status", - "computed": true + "name": "profile", + "type": "TypeList", + "description": "The profile information.", + "computed": true, + "elem": { + "id": { + "name": "id", + "type": "TypeString", + "description": "The profile ID.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The profile name.", + "computed": true + }, + "version": { + "name": "version", + "type": "TypeString", + "description": "The profile version.", + "computed": true + } + } }, { - "name": "crn", - "type": "TypeString", - "description": "CRN of resource instance", - "cloud_data_type": "crn", - "computed": true + "name": "attachment", + "type": "TypeList", + "description": "The attachment that is associated with a report.", + "computed": true, + "elem": { + "description": { + "name": "description", + "type": "TypeString", + "description": "The description of the attachment.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The attachment ID.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The name of the attachment.", + "computed": true + }, + "schedule": { + "name": "schedule", + "type": "TypeString", + "description": "The attachment schedule.", + "computed": true + }, + "scope": { + "name": "scope", + "type": "TypeList", + "description": "The scope of the attachment.", + "computed": true, + "elem": { + "environment": { + "name": "environment", + "type": "TypeString", + "description": "The environment that relates to this scope.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this scope.", + "computed": true + }, + "properties": { + "name": "properties", + "type": "TypeList", + "description": "The properties that are supported for scoping by this environment.", + "computed": true, + "elem": { + "name": { + "name": "name", + "type": "TypeString", + "description": "The property name.", + "computed": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "The property value.", + "computed": true + } + } + } + } + } + } }, { - "name": "guid", + "name": "group_id", "type": "TypeString", - "description": "Guid of resource instance", + "description": "The group ID that is associated with the report. The group ID combines profile, scope, and attachment IDs.", "computed": true }, { - "name": "resource_controller_url", + "name": "created_on", "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource", + "description": "The date when the report was created.", "computed": true }, { - "name": "location", + "name": "scan_time", "type": "TypeString", - "description": "The location or the environment in which instance exists", - "cloud_data_type": "region", - "optional": true, + "description": "The date when the scan was run.", "computed": true }, { - "name": "plan", + "name": "report_id", "type": "TypeString", - "description": "The plan type of the instance", - "computed": true + "description": "The ID of the scan that is associated with a report.", + "required": true }, { - "name": "resource_name", + "name": "id", "type": "TypeString", - "description": "The name of the resource", + "description": "The ID of the report.", "computed": true }, { - "name": "resource_crn", + "name": "type", "type": "TypeString", - "description": "The crn of the resource", + "description": "The type of the scan.", "computed": true - }, + } + ], + "ibm_scc_report_controls": [ { - "name": "resource_status", + "name": "control_category", "type": "TypeString", - "description": "The status of the resource", - "computed": true + "description": "A control category value.", + "optional": true }, { - "name": "resource_group_id", - "type": "TypeString", - "description": "The id of the resource group in which the instance is present", - "cloud_data_type": "resource_group", - "optional": true, - "computed": true, - "cloud_data_range": [ - "resolved_to:id" - ] + "name": "total_count", + "type": "TypeInt", + "description": "The total number of checks.", + "computed": true }, { - "name": "tags", - "type": "TypeSet", - "description": "Tags of Resource Instance", - "cloud_data_type": "tags", + "name": "controls", + "type": "TypeList", + "description": "The list of controls that are in the report.", "computed": true, "elem": { - "type": "TypeString" + "compliant_count": { + "name": "compliant_count", + "type": "TypeInt", + "description": "The number of compliant checks.", + "computed": true + }, + "control_category": { + "name": "control_category", + "type": "TypeString", + "description": "The control category.", + "computed": true + }, + "control_description": { + "name": "control_description", + "type": "TypeString", + "description": "The control description.", + "computed": true + }, + "control_library_id": { + "name": "control_library_id", + "type": "TypeString", + "description": "The control library ID.", + "computed": true + }, + "control_library_version": { + "name": "control_library_version", + "type": "TypeString", + "description": "The control library version.", + "computed": true + }, + "control_name": { + "name": "control_name", + "type": "TypeString", + "description": "The control name.", + "computed": true + }, + "control_path": { + "name": "control_path", + "type": "TypeString", + "description": "The control path.", + "computed": true + }, + "control_specifications": { + "name": "control_specifications", + "type": "TypeList", + "description": "The list of specifications that are on the page.", + "computed": true, + "elem": { + "assessments": { + "name": "assessments", + "type": "TypeList", + "description": "The list of assessments.", + "computed": true, + "elem": { + "assessment_description": { + "name": "assessment_description", + "type": "TypeString", + "description": "The assessment description.", + "computed": true + }, + "assessment_id": { + "name": "assessment_id", + "type": "TypeString", + "description": "The assessment ID.", + "computed": true + }, + "assessment_method": { + "name": "assessment_method", + "type": "TypeString", + "description": "The assessment method.", + "computed": true + }, + "assessment_type": { + "name": "assessment_type", + "type": "TypeString", + "description": "The assessment type.", + "computed": true + }, + "parameter_count": { + "name": "parameter_count", + "type": "TypeInt", + "description": "The number of parameters of this assessment.", + "computed": true + }, + "parameters": { + "name": "parameters", + "type": "TypeList", + "description": "The list of parameters of this assessment.", + "computed": true, + "elem": { + "parameter_display_name": { + "name": "parameter_display_name", + "type": "TypeString", + "description": "The parameter display name.", + "computed": true + }, + "parameter_name": { + "name": "parameter_name", + "type": "TypeString", + "description": "The parameter name.", + "computed": true + }, + "parameter_type": { + "name": "parameter_type", + "type": "TypeString", + "description": "The parameter type.", + "computed": true + }, + "parameter_value": { + "name": "parameter_value", + "type": "TypeString", + "description": "The property value.", + "computed": true + } + } + } + } + }, + "compliant_count": { + "name": "compliant_count", + "type": "TypeInt", + "description": "The number of compliant checks.", + "computed": true + }, + "component_id": { + "name": "component_id", + "type": "TypeString", + "description": "The component ID.", + "computed": true + }, + "control_specification_description": { + "name": "control_specification_description", + "type": "TypeString", + "description": "The component description.", + "computed": true + }, + "control_specification_id": { + "name": "control_specification_id", + "type": "TypeString", + "description": "The control specification ID.", + "computed": true + }, + "environment": { + "name": "environment", + "type": "TypeString", + "description": "The environment.", + "computed": true + }, + "not_compliant_count": { + "name": "not_compliant_count", + "type": "TypeInt", + "description": "The number of checks that are not compliant.", + "computed": true + }, + "responsibility": { + "name": "responsibility", + "type": "TypeString", + "description": "The responsibility for managing control specifications.", + "computed": true + }, + "status": { + "name": "status", + "type": "TypeString", + "description": "The allowed values of an aggregated status for controls, specifications, assessments, and resources.", + "computed": true + }, + "total_count": { + "name": "total_count", + "type": "TypeInt", + "description": "The total number of checks.", + "computed": true + }, + "unable_to_perform_count": { + "name": "unable_to_perform_count", + "type": "TypeInt", + "description": "The number of checks that are unable to perform.", + "computed": true + }, + "user_evaluation_required_count": { + "name": "user_evaluation_required_count", + "type": "TypeInt", + "description": "The number of checks that require a user evaluation.", + "computed": true + } + } + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The control ID.", + "computed": true + }, + "not_compliant_count": { + "name": "not_compliant_count", + "type": "TypeInt", + "description": "The number of checks that are not compliant.", + "computed": true + }, + "status": { + "name": "status", + "type": "TypeString", + "description": "The allowed values of an aggregated status for controls, specifications, assessments, and resources.", + "computed": true + }, + "total_count": { + "name": "total_count", + "type": "TypeInt", + "description": "The total number of checks.", + "computed": true + }, + "unable_to_perform_count": { + "name": "unable_to_perform_count", + "type": "TypeInt", + "description": "The number of checks that are unable to perform.", + "computed": true + }, + "user_evaluation_required_count": { + "name": "user_evaluation_required_count", + "type": "TypeInt", + "description": "The number of checks that require a user evaluation.", + "computed": true + } } - } - ], - "ibm_resource_key": [ - { - "name": "name", - "type": "TypeString", - "description": "The name of the resource key", - "required": true }, { - "name": "resource_instance_id", + "name": "report_id", "type": "TypeString", - "description": "The id of the resource instance", - "cloud_data_type": "resource_instance", - "optional": true, - "cloud_data_range": [ - "service:%s" - ] + "description": "The ID of the scan that is associated with a report.", + "required": true }, { - "name": "resource_alias_id", + "name": "control_name", "type": "TypeString", - "description": "The id of the resource alias", + "description": "The name of the control.", "optional": true }, { - "name": "most_recent", - "type": "TypeBool", - "description": "If true and multiple entries are found, the most recently created resource key is used. If false, an error is returned", - "default_value": false, + "name": "control_description", + "type": "TypeString", + "description": "The description of the control.", "optional": true }, { - "name": "crn", + "name": "control_id", "type": "TypeString", - "description": "crn of resource key", - "cloud_data_type": "crn", - "computed": true + "description": "The ID of the control.", + "optional": true }, { - "name": "role", - "type": "TypeString", - "description": "User role", + "name": "not_compliant_count", + "type": "TypeInt", + "description": "The number of checks that are not compliant.", "computed": true }, { - "name": "status", + "name": "home_account_id", "type": "TypeString", - "description": "Status of resource key", - "computed": true - }, - { - "name": "credentials", - "type": "TypeMap", - "description": "Credentials asociated with the key", - "secure": true, + "description": "The ID of the home account.", "computed": true }, { - "name": "credentials_json", - "type": "TypeString", - "description": "Credentials asociated with the key in json string", - "secure": true, - "computed": true - } - ], - "ibm_resource_quota": [ - { - "name": "max_app_instance_memory", + "name": "instance_id", "type": "TypeString", - "description": "Defines the total memory of app instance.", - "computed": true + "description": "The ID of the Security and Compliance Center instance.", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true }, { - "name": "total_app_memory", + "name": "status", "type": "TypeString", - "description": "Defines the total memory for app.", - "computed": true + "description": "The compliance status value.", + "optional": true }, { - "name": "max_service_instances", + "name": "compliant_count", "type": "TypeInt", - "description": "Defines the total service instances limit.", + "description": "The number of compliant checks.", "computed": true }, { - "name": "vsi_limit", + "name": "unable_to_perform_count", "type": "TypeInt", - "description": "Defines the VSI limit.", - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Resource quota name, for example Trial Quota", - "required": true - }, - { - "name": "type", - "type": "TypeString", - "description": "Type of the quota.", + "description": "The number of checks that are unable to perform.", "computed": true }, { - "name": "max_apps", + "name": "user_evaluation_required_count", "type": "TypeInt", - "description": "Defines the total app limit.", + "description": "The number of checks that require a user evaluation.", "computed": true }, { - "name": "max_instances_per_app", - "type": "TypeInt", - "description": "Defines the total instances limit per app.", - "computed": true + "name": "sort", + "type": "TypeString", + "description": "This field sorts controls by using a valid sort field. To learn more, see [Sorting](https://cloud.ibm.com/docs/api-handbook?topic=api-handbook-sorting).", + "optional": true } ], - "ibm_resource_tag": [ + "ibm_scc_report_evaluations": [ { - "name": "resource_id", + "name": "assessment_id", "type": "TypeString", - "description": "CRN of the resource on which the tags should be attached", + "description": "The ID of the assessment.", "optional": true }, { - "name": "tags", - "type": "TypeSet", - "description": "List of tags associated with resource instance", - "cloud_data_type": "tags", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "resource_type", + "name": "component_id", "type": "TypeString", - "description": "Resource type on which the tags should be fetched", + "description": "The ID of component.", "optional": true }, { - "name": "tag_type", + "name": "target_id", "type": "TypeString", - "description": "Tag type on which the tags should be fetched", - "default_value": "user", + "description": "The ID of the evaluation target.", "optional": true - } - ], - "ibm_satellite_attach_host_script": [ - { - "name": "description", - "type": "TypeString", - "description": "A unique name for the new Satellite location", - "computed": true - }, - { - "name": "labels", - "type": "TypeSet", - "description": "List of labels for the attach host", - "optional": true, - "elem": { - "type": "TypeString" - } }, { - "name": "script_dir", + "name": "status", "type": "TypeString", - "description": "The directory where the satellite attach host script to be downloaded. Default is home directory", - "optional": true, - "computed": true + "description": "The evaluation status value.", + "optional": true }, { - "name": "location", + "name": "instance_id", "type": "TypeString", - "description": "A unique name for the new Satellite location", - "cloud_data_type": "region", + "description": "The ID of the Security and Compliance Center instance.", + "cloud_data_type": "resource_instance", + "immutable": true, "required": true }, { - "name": "coreos_host", - "type": "TypeBool", - "description": "If true, returns a CoreOS ignition file for the host. Otherwise, returns a RHEL attach script", - "optional": true + "name": "report_id", + "type": "TypeString", + "description": "The ID of the scan that is associated with a report.", + "required": true }, { - "name": "host_provider", - "type": "TypeString", - "optional": true + "name": "first", + "type": "TypeList", + "description": "The page reference.", + "computed": true, + "elem": { + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for the first and next page.", + "computed": true + } + } }, { - "name": "script_path", + "name": "home_account_id", "type": "TypeString", - "description": "The absolute path to the generated host script file", + "description": "The ID of the home account.", "computed": true }, { - "name": "host_script", - "type": "TypeString", - "description": "Attach host script content", - "computed": true + "name": "evaluations", + "type": "TypeList", + "description": "The list of evaluations that are on the page.", + "computed": true, + "elem": { + "assessment": { + "name": "assessment", + "type": "TypeList", + "description": "The control specification assessment.", + "computed": true, + "elem": { + "assessment_description": { + "name": "assessment_description", + "type": "TypeString", + "description": "The assessment description.", + "computed": true + }, + "assessment_id": { + "name": "assessment_id", + "type": "TypeString", + "description": "The assessment ID.", + "computed": true + }, + "assessment_method": { + "name": "assessment_method", + "type": "TypeString", + "description": "The assessment method.", + "computed": true + }, + "assessment_type": { + "name": "assessment_type", + "type": "TypeString", + "description": "The assessment type.", + "computed": true + }, + "parameter_count": { + "name": "parameter_count", + "type": "TypeInt", + "description": "The number of parameters of this assessment.", + "computed": true + }, + "parameters": { + "name": "parameters", + "type": "TypeList", + "description": "The list of parameters of this assessment.", + "computed": true, + "elem": { + "parameter_display_name": { + "name": "parameter_display_name", + "type": "TypeString", + "description": "The parameter display name.", + "computed": true + }, + "parameter_name": { + "name": "parameter_name", + "type": "TypeString", + "description": "The parameter name.", + "computed": true + }, + "parameter_type": { + "name": "parameter_type", + "type": "TypeString", + "description": "The parameter type.", + "computed": true + }, + "parameter_value": { + "name": "parameter_value", + "type": "TypeString", + "description": "The property value.", + "computed": true + } + } + } + } + }, + "component_id": { + "name": "component_id", + "type": "TypeString", + "description": "The component ID.", + "computed": true + }, + "control_id": { + "name": "control_id", + "type": "TypeString", + "description": "The control ID.", + "computed": true + }, + "details": { + "name": "details", + "type": "TypeList", + "description": "The evaluation details.", + "computed": true, + "elem": { + "properties": { + "name": "properties", + "type": "TypeList", + "description": "The evaluation properties.", + "computed": true, + "elem": { + "expected_value": { + "name": "expected_value", + "type": "TypeString", + "description": "The property value.", + "computed": true + }, + "found_value": { + "name": "found_value", + "type": "TypeString", + "description": "The property value.", + "computed": true + }, + "operator": { + "name": "operator", + "type": "TypeString", + "description": "The property operator.", + "computed": true + }, + "property": { + "name": "property", + "type": "TypeString", + "description": "The property name.", + "computed": true + }, + "property_description": { + "name": "property_description", + "type": "TypeString", + "description": "The property description.", + "computed": true + } + } + } + } + }, + "evaluate_time": { + "name": "evaluate_time", + "type": "TypeString", + "description": "The time when the evaluation was made.", + "computed": true + }, + "home_account_id": { + "name": "home_account_id", + "type": "TypeString", + "description": "The ID of the home account.", + "computed": true + }, + "reason": { + "name": "reason", + "type": "TypeString", + "description": "The reason for the evaluation failure.", + "computed": true + }, + "report_id": { + "name": "report_id", + "type": "TypeString", + "description": "The ID of the report that is associated to the evaluation.", + "computed": true + }, + "status": { + "name": "status", + "type": "TypeString", + "description": "The allowed values of an evaluation status.", + "computed": true + }, + "target": { + "name": "target", + "type": "TypeList", + "description": "The evaluation target.", + "computed": true, + "elem": { + "account_id": { + "name": "account_id", + "type": "TypeString", + "description": "The target account ID.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The target ID.", + "computed": true + }, + "resource_crn": { + "name": "resource_crn", + "type": "TypeString", + "description": "The target resource CRN.", + "computed": true + }, + "resource_name": { + "name": "resource_name", + "type": "TypeString", + "description": "The target resource name.", + "computed": true + }, + "service_name": { + "name": "service_name", + "type": "TypeString", + "description": "The target service name.", + "computed": true + } + } + } + } }, { - "name": "custom_script", + "name": "target_name", "type": "TypeString", - "description": "The custom script that has to be appended to generated host script file", + "description": "The name of the evaluation target.", "optional": true } ], - "ibm_satellite_cluster": [ + "ibm_scc_report_resources": [ { - "name": "status", - "type": "TypeString", - "description": "The status of the cluster", - "computed": true + "name": "first", + "type": "TypeList", + "description": "The page reference.", + "computed": true, + "elem": { + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for the first and next page.", + "computed": true + } + } }, { - "name": "worker_pools", + "name": "resources", "type": "TypeList", + "description": "The list of resource evaluation summaries that are on the page.", "computed": true, "elem": { - "default_worker_pool_labels": { - "name": "default_worker_pool_labels", - "type": "TypeMap", + "account": { + "name": "account", + "type": "TypeList", + "description": "The account that is associated with a report.", + "computed": true, + "elem": { + "id": { + "name": "id", + "type": "TypeString", + "description": "The account ID.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The account name.", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "The account type.", + "computed": true + } + } + }, + "completed_count": { + "name": "completed_count", + "type": "TypeInt", + "description": "The total number of completed evaluations.", "computed": true }, - "flavour": { - "name": "flavour", + "component_id": { + "name": "component_id", "type": "TypeString", + "description": "The ID of the component.", "computed": true }, - "host_labels": { - "name": "host_labels", - "type": "TypeMap", - "computed": true, - "elem": { - "type": "TypeString" - } + "environment": { + "name": "environment", + "type": "TypeString", + "description": "The environment.", + "computed": true + }, + "error_count": { + "name": "error_count", + "type": "TypeInt", + "description": "The number of evaluations that started, but did not finish, and ended with errors.", + "computed": true + }, + "failure_count": { + "name": "failure_count", + "type": "TypeInt", + "description": "The number of failed evaluations.", + "computed": true }, "id": { "name": "id", "type": "TypeString", + "description": "The resource CRN.", + "computed": true + }, + "pass_count": { + "name": "pass_count", + "type": "TypeInt", + "description": "The number of passed evaluations.", + "computed": true + }, + "report_id": { + "name": "report_id", + "type": "TypeString", + "description": "The ID of the report.", "computed": true }, - "isolation": { - "name": "isolation", + "resource_name": { + "name": "resource_name", "type": "TypeString", + "description": "The resource name.", "computed": true }, - "name": { - "name": "name", + "status": { + "name": "status", "type": "TypeString", + "description": "The allowed values of an aggregated status for controls, specifications, assessments, and resources.", "computed": true }, - "size_per_zone": { - "name": "size_per_zone", + "total_count": { + "name": "total_count", "type": "TypeInt", + "description": "The total number of evaluations.", "computed": true - }, - "state": { - "name": "state", - "type": "TypeString", - "computed": true - }, - "zones": { - "name": "zones", - "type": "TypeList", - "computed": true, - "elem": { - "worker_count": { - "name": "worker_count", - "type": "TypeInt", - "computed": true - }, - "zone": { - "name": "zone", - "type": "TypeString", - "computed": true - } - } } } }, { - "name": "crn", + "name": "resource_name", "type": "TypeString", - "description": "CRN of resource instance", - "cloud_data_type": "crn", - "computed": true + "description": "The name of the resource.", + "optional": true }, { - "name": "kube_version", + "name": "id", "type": "TypeString", - "description": "Kubernetes version", - "computed": true - }, - { - "name": "worker_count", - "type": "TypeInt", - "description": "Number of workers", - "computed": true + "description": "The ID of the resource.", + "optional": true }, { - "name": "resource_group_name", + "name": "account_id", "type": "TypeString", - "description": "The resource group name in which resource is provisioned", - "computed": true + "description": "The ID of the account owning a resource.", + "optional": true }, { - "name": "infrastructure_topology", + "name": "component_id", "type": "TypeString", - "description": "String value for single node cluster option.", - "computed": true - }, - { - "name": "tags", - "type": "TypeSet", - "cloud_data_type": "tags", - "computed": true, - "elem": { - "type": "TypeString" - } + "description": "The ID of component.", + "optional": true }, { - "name": "name", + "name": "status", "type": "TypeString", - "description": "Name or id of the cluster", - "required": true - }, - { - "name": "workers", - "type": "TypeList", - "computed": true, - "elem": { - "type": "TypeString" - } + "description": "The compliance status value.", + "optional": true }, { - "name": "resource_group_id", + "name": "sort", "type": "TypeString", - "description": "ID of the resource group.", - "cloud_data_type": "resource_group", - "optional": true, - "computed": true + "description": "This field sorts resources by using a valid sort field. To learn more, see [Sorting](https://cloud.ibm.com/docs/api-handbook?topic=api-handbook-sorting).", + "optional": true }, { - "name": "ingress_secret", + "name": "home_account_id", "type": "TypeString", - "secure": true, + "description": "The ID of the home account.", "computed": true }, { - "name": "server_url", + "name": "instance_id", "type": "TypeString", - "description": "The server URL", - "computed": true - }, - { - "name": "private_service_endpoint", - "type": "TypeBool", - "computed": true + "description": "The ID of the Security and Compliance Center instance.", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true }, { - "name": "public_service_endpoint_url", + "name": "report_id", "type": "TypeString", - "computed": true - }, + "description": "The ID of the scan that is associated with a report.", + "required": true + } + ], + "ibm_scc_report_rule": [ { - "name": "private_service_endpoint_url", + "name": "updated_by", "type": "TypeString", + "description": "The ID of the user who updated the rule.", "computed": true }, { - "name": "location", + "name": "report_id", "type": "TypeString", - "description": "Name or id of the location", - "cloud_data_type": "region", - "computed": true + "description": "The ID of the scan that is associated with a report.", + "required": true }, { - "name": "state", + "name": "id", "type": "TypeString", - "description": "The lifecycle state of the cluster", + "description": "The rule ID.", "computed": true }, { - "name": "health", + "name": "type", "type": "TypeString", + "description": "The rule type.", "computed": true }, { - "name": "ingress_hostname", + "name": "account_id", "type": "TypeString", + "description": "The rule account ID.", "computed": true }, { - "name": "public_service_endpoint", - "type": "TypeBool", - "computed": true - } - ], - "ibm_satellite_cluster_worker_pool": [ - { - "name": "flavor", + "name": "created_by", "type": "TypeString", - "description": "The flavor of the satellite worker node", + "description": "The ID of the user who created the rule.", "computed": true }, { - "name": "state", + "name": "updated_on", "type": "TypeString", - "description": "The state of the worker pool", + "description": "The date when the rule was updated.", "computed": true }, { - "name": "host_labels", - "type": "TypeMap", - "description": "Host labels on the workers", + "name": "labels", + "type": "TypeList", + "description": "The rule labels.", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "resource_group_id", + "name": "instance_id", "type": "TypeString", - "description": "ID of the resource group", - "cloud_data_type": "resource_group", - "optional": true, - "computed": true + "description": "The ID of the Security and Compliance Center instance.", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true }, { - "name": "region", + "name": "rule_id", "type": "TypeString", - "description": "Name of the region", - "cloud_data_type": "region", - "optional": true, - "computed": true + "description": "The ID of a rule in a report.", + "required": true }, { - "name": "worker_count", - "type": "TypeInt", - "description": "The number of workers that are attached", + "name": "description", + "type": "TypeString", + "description": "The rule description.", "computed": true }, { - "name": "isolation", + "name": "version", "type": "TypeString", - "description": "Isolation of the worker node", + "description": "The rule version.", "computed": true }, { - "name": "cluster", + "name": "created_on", "type": "TypeString", - "description": "Cluster name", + "description": "The date when the rule was created.", + "computed": true + } + ], + "ibm_scc_report_summary": [ + { + "name": "report_id", + "type": "TypeString", + "description": "The ID of the scan that is associated with a report.", "required": true }, { - "name": "zones", - "type": "TypeSet", + "name": "isntance_id", + "type": "TypeString", + "description": "Instance ID.", + "computed": true + }, + { + "name": "account", + "type": "TypeList", + "description": "The account that is associated with a report.", "computed": true, "elem": { - "worker_count": { - "name": "worker_count", - "type": "TypeInt", + "id": { + "name": "id", + "type": "TypeString", + "description": "The account ID.", "computed": true }, - "zone": { - "name": "zone", + "name": { + "name": "name", + "type": "TypeString", + "description": "The account name.", + "computed": true + }, + "type": { + "name": "type", "type": "TypeString", + "description": "The account type.", "computed": true } } }, { - "name": "worker_pool_labels", - "type": "TypeMap", - "description": "Labels on all the workers in the worker pool", + "name": "score", + "type": "TypeList", + "description": "The compliance score.", "computed": true, "elem": { - "type": "TypeString" + "passed": { + "name": "passed", + "type": "TypeInt", + "description": "The number of successful evaluations.", + "computed": true + }, + "percent": { + "name": "percent", + "type": "TypeInt", + "description": "The percentage of successful evaluations.", + "computed": true + }, + "total_count": { + "name": "total_count", + "type": "TypeInt", + "description": "The total number of evaluations.", + "computed": true + } } }, { - "name": "operating_system", - "type": "TypeString", - "description": "The operating system of the hosts in the worker pool", - "computed": true - }, - { - "name": "auto_scale_enabled", - "type": "TypeBool", - "description": "Enable auto scalling for worker pool", - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "worker pool name", - "required": true - } - ], - "ibm_satellite_cluster_worker_pool_zone_attachment": [ - { - "name": "worker_pool", - "type": "TypeString", - "description": "worker pool name", - "required": true - }, - { - "name": "zone", - "type": "TypeString", - "description": "worker pool zone name", - "required": true - }, - { - "name": "resource_group_id", - "type": "TypeString", - "description": "The ID of the resource group that the Satellite location is in. To list the resource group ID of the location, use the `GET /v2/satellite/getController` API method.", - "cloud_data_type": "resource_group", - "optional": true - }, - { - "name": "worker_count", - "type": "TypeInt", - "description": "Number of workers", - "computed": true - }, - { - "name": "autobalance_enabled", - "type": "TypeBool", - "description": "Auto enabled status", - "computed": true - }, - { - "name": "messages", + "name": "controls", "type": "TypeList", - "description": "Filter features by a list of comma separated collections.", + "description": "The compliance stats.", "computed": true, "elem": { - "type": "TypeString" + "compliant_count": { + "name": "compliant_count", + "type": "TypeInt", + "description": "The number of compliant checks.", + "computed": true + }, + "not_compliant_count": { + "name": "not_compliant_count", + "type": "TypeInt", + "description": "The number of checks that are not compliant.", + "computed": true + }, + "status": { + "name": "status", + "type": "TypeString", + "description": "The allowed values of an aggregated status for controls, specifications, assessments, and resources.", + "computed": true + }, + "total_count": { + "name": "total_count", + "type": "TypeInt", + "description": "The total number of checks.", + "computed": true + }, + "unable_to_perform_count": { + "name": "unable_to_perform_count", + "type": "TypeInt", + "description": "The number of checks that are unable to perform.", + "computed": true + }, + "user_evaluation_required_count": { + "name": "user_evaluation_required_count", + "type": "TypeInt", + "description": "The number of checks that require a user evaluation.", + "computed": true + } } }, { - "name": "cluster", - "type": "TypeString", - "description": "Name or id of the cluster", - "required": true - } - ], - "ibm_satellite_endpoint": [ - { - "name": "sni", - "type": "TypeString", - "description": "The server name indicator (SNI) which used to connect to the server endpoint. Only useful if server side requires SNI.", - "computed": true - }, - { - "name": "server_protocol", - "type": "TypeString", - "description": "The protocol in the server application side. This parameter will change to default value if it is omitted even when using PATCH API. If client_protocol is 'udp', server_protocol must be 'udp'. If client_protocol is 'tcp'/'http', server_protocol could be 'tcp'/'tls' and default to 'tcp'. If client_protocol is 'tls'/'https', server_protocol could be 'tcp'/'tls' and default to 'tls'. If client_protocol is 'http-tunnel', server_protocol must be 'tcp'.", - "computed": true - }, - { - "name": "server_mutual_auth", - "type": "TypeBool", - "description": "Whether enable mutual auth in the server application side, when client_protocol is 'tls', this field is required.", - "computed": true - }, - { - "name": "reject_unauth", - "type": "TypeBool", - "description": "Whether reject any connection to the server application which is not authorized with the list of supplied CAs in the fields certs.server_cert.", - "computed": true - }, - { - "name": "display_name", - "type": "TypeString", - "description": "The display name of the endpoint. Endpoint names must start with a letter and end with an alphanumeric character, can contain letters, numbers, and hyphen (-), and must be 63 characters or fewer.", - "computed": true - }, - { - "name": "server_host", - "type": "TypeString", - "description": "The host name or IP address of the server endpoint. For 'http-tunnel' protocol, server_host can start with '*.' , which means a wildcard to it's sub domains. Such as '*.example.com' can accept request to 'api.example.com' and 'www.example.com'.", - "computed": true - }, - { - "name": "server_port", - "type": "TypeInt", - "description": "The port number of the server endpoint. For 'http-tunnel' protocol, server_port can be 0, which means any port. Such as 0 is good for 80 (http) and 443 (https).", - "computed": true - }, - { - "name": "client_protocol", - "type": "TypeString", - "description": "The protocol in the client application side.", - "computed": true - }, - { - "name": "timeout", - "type": "TypeInt", - "description": "The inactivity timeout in the Endpoint side.", - "computed": true - }, - { - "name": "created_by", - "type": "TypeString", - "description": "The service or person who created the endpoint. Must be 1000 characters or fewer.", - "computed": true - }, - { - "name": "sources", + "name": "evaluations", "type": "TypeList", + "description": "The evaluation stats.", "computed": true, "elem": { - "enabled": { - "name": "enabled", - "type": "TypeBool", - "description": "Whether the source is enabled for the endpoint.", + "completed_count": { + "name": "completed_count", + "type": "TypeInt", + "description": "The total number of completed evaluations.", "computed": true }, - "last_change": { - "name": "last_change", - "type": "TypeString", - "description": "The last time modify the Endpoint configurations.", + "error_count": { + "name": "error_count", + "type": "TypeInt", + "description": "The number of evaluations that started, but did not finish, and ended with errors.", "computed": true }, - "pending": { - "name": "pending", - "type": "TypeBool", - "description": "Whether the source has been enabled on this endpoint.", + "failure_count": { + "name": "failure_count", + "type": "TypeInt", + "description": "The number of failed evaluations.", "computed": true }, - "source_id": { - "name": "source_id", + "pass_count": { + "name": "pass_count", + "type": "TypeInt", + "description": "The number of passed evaluations.", + "computed": true + }, + "status": { + "name": "status", "type": "TypeString", - "description": "The Source ID.", + "description": "The allowed values of an aggregated status for controls, specifications, assessments, and resources.", + "computed": true + }, + "total_count": { + "name": "total_count", + "type": "TypeInt", + "description": "The total number of evaluations.", "computed": true } } }, { - "name": "client_port", - "type": "TypeInt", - "description": "The port which Satellite Link server listen on for the on-location, or the port which the connector server listen on for the on-cloud endpoint destiantion.", - "computed": true - }, - { - "name": "connection_type", - "type": "TypeString", - "description": "The type of the endpoint.", - "computed": true - }, - { - "name": "last_change", - "type": "TypeString", - "description": "The last time modify the Endpoint configurations.", - "computed": true - }, - { - "name": "client_mutual_auth", - "type": "TypeBool", - "description": "Whether enable mutual auth in the client application side, when client_protocol is 'tls' or 'https', this field is required.", - "computed": true - }, - { - "name": "connector_port", - "type": "TypeInt", - "description": "The connector port.", - "computed": true - }, - { - "name": "crn", - "type": "TypeString", - "description": "Service instance associated with this location.", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "client_host", - "type": "TypeString", - "description": "The hostname which Satellite Link server listen on for the on-location endpoint, or the hostname which the connector server listen on for the on-cloud endpoint destiantion.", - "computed": true - }, - { - "name": "performance", + "name": "resources", "type": "TypeList", - "description": "The last performance data of the endpoint.", + "description": "The resource summary.", "computed": true, "elem": { - "bandwidth": { - "name": "bandwidth", + "compliant_count": { + "name": "compliant_count", "type": "TypeInt", - "description": "Average Tatal Bandwidth of last two minutes, unit is Byte/s.", + "description": "The number of compliant checks.", "computed": true }, - "connection": { - "name": "connection", + "not_compliant_count": { + "name": "not_compliant_count", "type": "TypeInt", - "description": "Concurrent connections number of moment when probe read the data.", + "description": "The number of checks that are not compliant.", "computed": true }, - "connectors": { - "name": "connectors", + "status": { + "name": "status", + "type": "TypeString", + "description": "The allowed values of an aggregated status for controls, specifications, assessments, and resources.", + "computed": true + }, + "top_failed": { + "name": "top_failed", "type": "TypeList", - "description": "The last performance data of the endpoint from each Connector.", + "description": "The top 10 resources that have the most failures.", "computed": true, "elem": { - "connections": { - "name": "connections", + "account": { + "name": "account", + "type": "TypeString", + "description": "The account that owns the resource.", + "computed": true + }, + "completed_count": { + "name": "completed_count", "type": "TypeInt", - "description": "Concurrent connections number of moment when probe read the data from the Connector.", + "description": "The total number of completed evaluations.", "computed": true }, - "connector": { - "name": "connector", + "error_count": { + "name": "error_count", + "type": "TypeInt", + "description": "The number of evaluations that started, but did not finish, and ended with errors.", + "computed": true + }, + "failure_count": { + "name": "failure_count", + "type": "TypeInt", + "description": "The number of failed evaluations.", + "computed": true + }, + "id": { + "name": "id", "type": "TypeString", - "description": "The name of the connector reported the performance data.", + "description": "The resource ID.", "computed": true }, - "rx_bw": { - "name": "rx_bw", + "name": { + "name": "name", + "type": "TypeString", + "description": "The resource name.", + "computed": true + }, + "pass_count": { + "name": "pass_count", "type": "TypeInt", - "description": "Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.", + "description": "The number of passed evaluations.", "computed": true }, - "tx_bw": { - "name": "tx_bw", + "service": { + "name": "service", + "type": "TypeString", + "description": "The service that is managing the resource.", + "computed": true + }, + "status": { + "name": "status", + "type": "TypeString", + "description": "The allowed values of an aggregated status for controls, specifications, assessments, and resources.", + "computed": true + }, + "tags": { + "name": "tags", + "type": "TypeList", + "description": "The collection of different types of tags.", + "computed": true, + "elem": { + "access": { + "name": "access", + "type": "TypeList", + "description": "The collection of access tags.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "service": { + "name": "service", + "type": "TypeList", + "description": "The collection of service tags.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "user": { + "name": "user", + "type": "TypeList", + "description": "The collection of user tags.", + "computed": true, + "elem": { + "type": "TypeString" + } + } + } + }, + "total_count": { + "name": "total_count", "type": "TypeInt", - "description": "Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.", + "description": "The total number of evaluations.", "computed": true } } }, - "rx_bandwidth": { - "name": "rx_bandwidth", + "total_count": { + "name": "total_count", "type": "TypeInt", - "description": "Average Receive (to Cloud) Bandwidth of last two minutes, unit is Byte/s.", + "description": "The total number of checks.", "computed": true }, - "tx_bandwidth": { - "name": "tx_bandwidth", + "unable_to_perform_count": { + "name": "unable_to_perform_count", "type": "TypeInt", - "description": "Average Transmitted (to Location) Bandwidth of last two minutes, unit is Byte/s.", + "description": "The number of checks that are unable to perform.", + "computed": true + }, + "user_evaluation_required_count": { + "name": "user_evaluation_required_count", + "type": "TypeInt", + "description": "The number of checks that require a user evaluation.", "computed": true } } }, { - "name": "location", + "name": "instance_id", "type": "TypeString", - "description": "The Location ID.", - "cloud_data_type": "region", + "description": "The ID of the Security and Compliance Center instance.", + "cloud_data_type": "resource_instance", + "immutable": true, "required": true - }, + } + ], + "ibm_scc_report_tags": [ { - "name": "service_name", + "name": "report_id", "type": "TypeString", - "description": "The service name of the endpoint.", - "computed": true + "description": "The ID of the scan that is associated with a report.", + "required": true }, { - "name": "certs", + "name": "tags", "type": "TypeList", - "description": "The certs. Once it is generated, this field will always be defined even it is unused until the cert/key is deleted.", + "description": "The collection of different types of tags.", + "cloud_data_type": "tags", "computed": true, "elem": { - "client": { - "name": "client", + "access": { + "name": "access", "type": "TypeList", - "description": "The CA which Satellite Link trust when receiving the connection from the client application.", + "description": "The collection of access tags.", "computed": true, "elem": { - "cert": { - "name": "cert", - "type": "TypeList", - "description": "The root cert or the self-signed cert of the client application.", - "computed": true, - "elem": { - "filename": { - "name": "filename", - "type": "TypeString", - "description": "The filename of the cert.", - "computed": true - } - } - } + "type": "TypeString" } }, - "connector": { - "name": "connector", + "service": { + "name": "service", "type": "TypeList", - "description": "The cert which Satellite Link connector provide to identify itself for connecting to the client/server application.", + "description": "The collection of service tags.", "computed": true, "elem": { - "cert": { - "name": "cert", - "type": "TypeList", - "description": "The end-entity cert of the connector.", - "computed": true, - "elem": { - "filename": { - "name": "filename", - "type": "TypeString", - "description": "The filename of the cert.", - "computed": true - } - } - }, - "key": { - "name": "key", - "type": "TypeList", - "description": "The private key of the connector.", - "computed": true, - "elem": { - "filename": { - "name": "filename", - "type": "TypeString", - "description": "The name of the key.", - "computed": true - } - } - } + "type": "TypeString" } }, - "server": { - "name": "server", + "user": { + "name": "user", "type": "TypeList", - "description": "The CA which Satellite Link trust when sending the connection to server application.", + "description": "The collection of user tags.", "computed": true, "elem": { - "cert": { - "name": "cert", - "type": "TypeList", - "description": "The root cert or the self-signed cert of the server application.", - "computed": true, - "elem": { - "filename": { - "name": "filename", - "type": "TypeString", - "description": "The filename of the cert.", - "computed": true - } - } - } + "type": "TypeString" } } } }, { - "name": "status", - "type": "TypeString", - "description": "Whether the Endpoint is active or not.", - "computed": true - }, - { - "name": "created_at", - "type": "TypeString", - "description": "The time when the Endpoint is created.", - "computed": true - }, - { - "name": "endpoint_id", + "name": "instance_id", "type": "TypeString", - "description": "The Endpoint ID.", + "description": "The ID of the Security and Compliance Center instance.", + "cloud_data_type": "resource_instance", + "immutable": true, "required": true } ], - "ibm_satellite_link": [ - { - "name": "last_change", - "type": "TypeString", - "description": "Timestamp of latest modification of location.", - "computed": true - }, - { - "name": "satellite_link_host", - "type": "TypeString", - "description": "Satellite Link hostname of the location.", - "computed": true - }, - { - "name": "status", - "type": "TypeString", - "description": "Enabled/Disabled.", - "computed": true - }, - { - "name": "crn", - "type": "TypeString", - "description": "Service instance associated with this location.", - "cloud_data_type": "crn", - "computed": true - }, + "ibm_scc_report_violation_drift": [ { - "name": "description", - "type": "TypeString", - "description": "Description of the location.", - "computed": true + "name": "scan_time_duration", + "type": "TypeInt", + "description": "The duration of the `scan_time` timestamp in number of days.", + "default_value": 0, + "optional": true }, { - "name": "created_at", + "name": "home_account_id", "type": "TypeString", - "description": "Timestamp of creation of location.", + "description": "The ID of the home account.", "computed": true }, { - "name": "performance", + "name": "data_points", "type": "TypeList", - "description": "The last performance data of the Location.", + "description": "The list of report violations data points.", "computed": true, "elem": { - "avg_latency": { - "name": "avg_latency", - "type": "TypeInt", - "description": "Average latency calculated form latency of each Connector between Tunnel Server, unit is ms. -1 means no Connector established Tunnel.", - "computed": true - }, - "bandwidth": { - "name": "bandwidth", - "type": "TypeInt", - "description": "Average Tatal Bandwidth of last two minutes, unit is Byte/s.", - "computed": true - }, - "connectors": { - "name": "connectors", + "controls": { + "name": "controls", "type": "TypeList", - "description": "The last performance data of the Location read from each Connector.", + "description": "The compliance stats.", "computed": true, "elem": { - "connector": { - "name": "connector", + "compliant_count": { + "name": "compliant_count", + "type": "TypeInt", + "description": "The number of compliant checks.", + "computed": true + }, + "not_compliant_count": { + "name": "not_compliant_count", + "type": "TypeInt", + "description": "The number of checks that are not compliant.", + "computed": true + }, + "status": { + "name": "status", "type": "TypeString", - "description": "The name of the connector reported the performance data.", + "description": "The allowed values of an aggregated status for controls, specifications, assessments, and resources.", "computed": true }, - "latency": { - "name": "latency", + "total_count": { + "name": "total_count", "type": "TypeInt", - "description": "Latency between Connector and the Tunnel Server it connected.", + "description": "The total number of checks.", "computed": true }, - "rx_bw": { - "name": "rx_bw", + "unable_to_perform_count": { + "name": "unable_to_perform_count", "type": "TypeInt", - "description": "Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.", + "description": "The number of checks that are unable to perform.", "computed": true }, - "tx_bw": { - "name": "tx_bw", + "user_evaluation_required_count": { + "name": "user_evaluation_required_count", "type": "TypeInt", - "description": "Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.", + "description": "The number of checks that require a user evaluation.", "computed": true } } }, - "health_status": { - "name": "health_status", + "report_group_id": { + "name": "report_group_id", "type": "TypeString", - "description": "Tunnels health status based on the Tunnels number established. Down(0)/Critical(1)/Up(\u003e=2).", - "computed": true - }, - "rx_bandwidth": { - "name": "rx_bandwidth", - "type": "TypeInt", - "description": "Average Receive (to Cloud) Bandwidth of last two minutes, unit is Byte/s.", + "description": "The group ID that is associated with the report. The group ID combines profile, scope, and attachment IDs.", "computed": true }, - "tunnels": { - "name": "tunnels", - "type": "TypeInt", - "description": "Tunnels number estbalished from the Location.", + "report_id": { + "name": "report_id", + "type": "TypeString", + "description": "The ID of the report.", "computed": true }, - "tx_bandwidth": { - "name": "tx_bandwidth", - "type": "TypeInt", - "description": "Average Transmitted (to Location) Bandwidth of last two minutes, unit is Byte/s.", + "scan_time": { + "name": "scan_time", + "type": "TypeString", + "description": "The date when the scan was run.", "computed": true } } }, { - "name": "location", + "name": "instance_id", "type": "TypeString", - "description": "The Location ID.", - "cloud_data_type": "region", + "description": "The ID of the Security and Compliance Center instance.", + "cloud_data_type": "resource_instance", + "immutable": true, "required": true }, { - "name": "ws_endpoint", + "name": "report_id", "type": "TypeString", - "description": "The ws endpoint of the location.", - "computed": true + "description": "The ID of the scan that is associated with a report.", + "required": true } ], - "ibm_satellite_location": [ - { - "name": "description", - "type": "TypeString", - "description": "A description of the new Satellite location", - "computed": true - }, - { - "name": "crn", - "type": "TypeString", - "description": "Location CRN", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "resource_group_id", - "type": "TypeString", - "description": "ID of the resource group", - "cloud_data_type": "resource_group", - "computed": true - }, - { - "name": "host_attached_count", - "type": "TypeInt", - "description": "The total number of hosts that are attached to the Satellite location.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "created_on", - "type": "TypeString", - "description": "Created Date", - "computed": true - }, - { - "name": "ingress_hostname", - "type": "TypeString", - "computed": true - }, - { - "name": "location", - "type": "TypeString", - "description": "A unique name for the new Satellite location", - "cloud_data_type": "region", - "required": true - }, - { - "name": "managed_from", - "type": "TypeString", - "description": "The IBM Cloud metro from which the Satellite location is managed", - "computed": true - }, - { - "name": "logging_account_id", - "type": "TypeString", - "description": "The account ID for IBM Log Analysis with LogDNA log forwarding", - "computed": true - }, - { - "name": "ingress_secret", - "type": "TypeString", - "secure": true, - "computed": true - }, + "ibm_scc_rule": [ { - "name": "hosts", + "name": "import", "type": "TypeList", + "description": "The collection of import parameters.", "computed": true, "elem": { - "cluster_name": { - "name": "cluster_name", - "type": "TypeString", - "computed": true - }, - "host_id": { - "name": "host_id", - "type": "TypeString", - "computed": true - }, - "host_labels": { - "name": "host_labels", - "type": "TypeMap", + "parameters": { + "name": "parameters", + "type": "TypeList", + "description": "The list of import parameters.", "computed": true, "elem": { - "type": "TypeString" + "description": { + "name": "description", + "type": "TypeString", + "description": "The propery description.", + "computed": true + }, + "display_name": { + "name": "display_name", + "type": "TypeString", + "description": "The display name of the property.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The import parameter name.", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "The property type.", + "computed": true + } } - }, - "host_name": { - "name": "host_name", - "type": "TypeString", - "computed": true - }, - "ip_address": { - "name": "ip_address", - "type": "TypeString", - "computed": true - }, - "status": { - "name": "status", - "type": "TypeString", - "computed": true - }, - "zone": { - "name": "zone", - "type": "TypeString", - "computed": true } } }, { - "name": "coreos_enabled", - "type": "TypeBool", - "description": "If Red Hat CoreOS features are enabled within the Satellite location", - "computed": true - }, - { - "name": "zones", - "type": "TypeSet", - "description": "The names of at least three high availability zones to use for the location", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "host_available_count", - "type": "TypeInt", - "description": "The available number of hosts that can be assigned to a cluster resource in the Satellite location.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "resource_group_name", - "type": "TypeString", - "description": "Name of the resource group", - "computed": true - }, - { - "name": "tags", - "type": "TypeSet", - "cloud_data_type": "tags", - "computed": true, - "elem": { - "type": "TypeString" - } - } - ], - "ibm_satellite_location_nlb_dns": [ - { - "name": "location", - "type": "TypeString", - "description": "A unique name of the Location", - "cloud_data_type": "region", - "required": true - }, - { - "name": "nlb_config", + "name": "required_config", "type": "TypeList", - "description": "List of nlb config of Location", + "description": "The required configurations.", "computed": true, "elem": { - "cluster": { - "name": "cluster", - "type": "TypeString", - "description": "Cluster Id.", - "computed": true + "and": { + "name": "and", + "type": "TypeList", + "description": "The `AND` required configurations.", + "computed": true, + "elem": { + "and": { + "name": "and", + "type": "TypeList", + "description": "The `AND` required configurations.", + "computed": true, + "elem": { + "description": { + "name": "description", + "type": "TypeString", + "description": "The required config description.", + "computed": true + }, + "operator": { + "name": "operator", + "type": "TypeString", + "description": "The operator.", + "computed": true + }, + "property": { + "name": "property", + "type": "TypeString", + "description": "The property.", + "computed": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "Schema for any JSON type.", + "computed": true + } + } + }, + "description": { + "name": "description", + "type": "TypeString", + "description": "The required config description.", + "computed": true + }, + "operator": { + "name": "operator", + "type": "TypeString", + "description": "The operator.", + "computed": true + }, + "or": { + "name": "or", + "type": "TypeList", + "description": "The `OR` required configurations.", + "computed": true, + "elem": { + "description": { + "name": "description", + "type": "TypeString", + "description": "The required config description.", + "computed": true + }, + "operator": { + "name": "operator", + "type": "TypeString", + "description": "The operator.", + "computed": true + }, + "property": { + "name": "property", + "type": "TypeString", + "description": "The property.", + "computed": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "Schema for any JSON type.", + "computed": true + } + } + }, + "property": { + "name": "property", + "type": "TypeString", + "description": "The property.", + "computed": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "Schema for any JSON type.", + "computed": true + } + } }, - "dns_type": { - "name": "dns_type", + "description": { + "name": "description", "type": "TypeString", - "description": "Type of DNS.", + "description": "The required config description.", "computed": true }, - "lb_hostname": { - "name": "lb_hostname", + "operator": { + "name": "operator", "type": "TypeString", - "description": "Host Name of load Balancer.", + "description": "The operator.", "computed": true }, - "nlb_ips": { - "name": "nlb_ips", + "or": { + "name": "or", "type": "TypeList", - "description": "NLB IPs.", + "description": "The `OR` required configurations.", "computed": true, "elem": { - "type": "TypeString" + "and": { + "name": "and", + "type": "TypeList", + "description": "The `AND` required configurations.", + "computed": true, + "elem": { + "description": { + "name": "description", + "type": "TypeString", + "description": "The required config description.", + "computed": true + }, + "operator": { + "name": "operator", + "type": "TypeString", + "description": "The operator.", + "computed": true + }, + "property": { + "name": "property", + "type": "TypeString", + "description": "The property.", + "computed": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "Schema for any JSON type.", + "computed": true + } + } + }, + "description": { + "name": "description", + "type": "TypeString", + "description": "The required config description.", + "computed": true + }, + "operator": { + "name": "operator", + "type": "TypeString", + "description": "The operator.", + "computed": true + }, + "or": { + "name": "or", + "type": "TypeList", + "description": "The `OR` required configurations.", + "computed": true, + "elem": { + "description": { + "name": "description", + "type": "TypeString", + "description": "The required config description.", + "computed": true + }, + "operator": { + "name": "operator", + "type": "TypeString", + "description": "The operator.", + "computed": true + }, + "property": { + "name": "property", + "type": "TypeString", + "description": "The property.", + "computed": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "Schema for any JSON type.", + "computed": true + } + } + }, + "property": { + "name": "property", + "type": "TypeString", + "description": "The property.", + "computed": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "Schema for any JSON type.", + "computed": true + } } }, - "nlb_sub_domain": { - "name": "nlb_sub_domain", - "type": "TypeString", - "description": "NLB Sub-Domain.", - "computed": true - }, - "secret_name": { - "name": "secret_name", - "type": "TypeString", - "description": "Name of the secret.", - "computed": true - }, - "secret_namespace": { - "name": "secret_namespace", - "type": "TypeString", - "description": "Namespace of Secret.", - "computed": true - }, - "secret_status": { - "name": "secret_status", + "property": { + "name": "property", "type": "TypeString", - "description": "Status of Secret.", + "description": "The property.", "computed": true }, - "type": { - "name": "type", + "value": { + "name": "value", "type": "TypeString", - "description": "Nlb Type.", + "description": "Schema for any JSON type.", "computed": true } } - } - ], - "ibm_scc_account_location": [ + }, { - "name": "results_endpoint_url", + "name": "instance_id", "type": "TypeString", - "description": "The endpoint that is used to get the results for the Configuration Governance component.", - "computed": true + "description": "The ID of the Security and Compliance Center instance.", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true }, { - "name": "compliance_endpoint_url", + "name": "updated_on", "type": "TypeString", - "description": "The endpoint that is used to call the Posture Management APIs.", + "description": "The date when the rule was modified.", "computed": true }, { - "name": "analytics_endpoint_url", + "name": "description", "type": "TypeString", - "description": "The endpoint that is used to generate analytics for the Posture Management component.", + "description": "The details of a rule's response.", "computed": true }, { - "name": "si_endpoint_url", + "name": "type", "type": "TypeString", - "description": "The endpoint that is used to call the Security Insights APIs.", + "description": "The rule type (allowable values are `user_defined` or `system_defined`).", "computed": true }, { - "name": "regions", + "name": "labels", "type": "TypeList", + "description": "The list of labels.", "computed": true, "elem": { - "id": { - "name": "id", - "type": "TypeString", - "description": "The programatic ID of the available regions.", - "computed": true - } + "type": "TypeString" } }, { - "name": "location_id", + "name": "rule_id", "type": "TypeString", - "description": "The programatic ID of the location that you want to work in.", + "description": "The ID of the corresponding rule.", "required": true }, { - "name": "main_endpoint_url", + "name": "updated_by", "type": "TypeString", - "description": "The base URL for the service.", + "description": "The user who modified the rule.", "computed": true }, { - "name": "governance_endpoint_url", + "name": "created_by", "type": "TypeString", - "description": "The endpoint that is used to call the Configuration Governance APIs.", + "description": "The user who created the rule.", "computed": true - } - ], - "ibm_scc_account_location_settings": [ + }, { - "name": "id", + "name": "account_id", "type": "TypeString", - "description": "The programatic ID of the location that you want to work in.", + "description": "The account ID.", "computed": true - } - ], - "ibm_scc_account_locations": [ + }, { - "name": "locations", + "name": "version", + "type": "TypeString", + "description": "The version number of a rule.", + "computed": true + }, + { + "name": "target", "type": "TypeList", + "description": "The rule target.", "computed": true, "elem": { - "analytics_endpoint_url": { - "name": "analytics_endpoint_url", - "type": "TypeString", - "description": "The endpoint that is used to generate analytics for the Posture Management component.", - "computed": true + "additional_target_attributes": { + "name": "additional_target_attributes", + "type": "TypeList", + "description": "The list of targets supported properties.", + "computed": true, + "elem": { + "name": { + "name": "name", + "type": "TypeString", + "description": "The additional target attribute name.", + "computed": true + }, + "operator": { + "name": "operator", + "type": "TypeString", + "description": "The operator.", + "computed": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "The value.", + "computed": true + } + } }, - "compliance_endpoint_url": { - "name": "compliance_endpoint_url", + "resource_kind": { + "name": "resource_kind", "type": "TypeString", - "description": "The endpoint that is used to call the Posture Management APIs.", + "description": "The target resource kind.", "computed": true }, - "governance_endpoint_url": { - "name": "governance_endpoint_url", + "service_display_name": { + "name": "service_display_name", "type": "TypeString", - "description": "The endpoint that is used to call the Configuration Governance APIs.", + "description": "The display name of the target service.", "computed": true }, - "id": { - "name": "id", + "service_name": { + "name": "service_name", "type": "TypeString", - "description": "The programatic ID of the location that you want to work in.", + "description": "The target service name.", "computed": true - }, - "main_endpoint_url": { - "name": "main_endpoint_url", + } + } + }, + { + "name": "created_on", + "type": "TypeString", + "description": "The date when the rule was created.", + "computed": true + }, + { + "name": "id", + "type": "TypeString", + "description": "The rule ID.", + "computed": true + } + ], + "ibm_schematics_action": [ + { + "name": "tags", + "type": "TypeList", + "description": "Action tags.", + "cloud_data_type": "tags", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "user_state", + "type": "TypeList", + "description": "User defined status of the Schematics object.", + "computed": true, + "elem": { + "set_at": { + "name": "set_at", "type": "TypeString", - "description": "The base URL for the service.", + "description": "When the User who set the state of the Object.", "computed": true }, - "regions": { - "name": "regions", - "type": "TypeList", - "computed": true, - "elem": { - "id": { - "name": "id", - "type": "TypeString", - "description": "The programatic ID of the available regions.", - "computed": true - } - } - }, - "results_endpoint_url": { - "name": "results_endpoint_url", + "set_by": { + "name": "set_by", "type": "TypeString", - "description": "The endpoint that is used to get the results for the Configuration Governance component.", + "description": "Name of the User who set the state of the Object.", "computed": true }, - "si_endpoint_url": { - "name": "si_endpoint_url", + "state": { + "name": "state", "type": "TypeString", - "description": "The endpoint that is used to call the Security Insights APIs.", + "description": "User-defined states * `draft` Object can be modified; can be used by Jobs run by the author, during execution * `live` Object can be modified; can be used by Jobs during execution * `locked` Object cannot be modified; can be used by Jobs during execution * `disable` Object can be modified. cannot be used by Jobs during execution.", "computed": true } } - } - ], - "ibm_scc_account_notification_settings": [ + }, { - "name": "instance_crn", + "name": "source_created_at", "type": "TypeString", - "description": "The Cloud Resource Name (CRN) of the Event Notifications instance that you want to connect.", + "description": "Action Playbook Source creation time.", "computed": true - } - ], - "ibm_schematics_action": [ + }, { - "name": "source_type", + "name": "action_id", "type": "TypeString", - "description": "Type of source for the Template.", + "description": "Action Id. Use GET /actions API to look up the Action Ids in your IBM Cloud account.", + "required": true + }, + { + "name": "name", + "type": "TypeString", + "description": "The unique name of your action. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores. **Example** you can use the name to stop action.", "computed": true }, { - "name": "command_parameter", + "name": "source_readme_url", "type": "TypeString", - "description": "Schematics job command parameter (playbook-name).", + "description": "URL of the `README` file, for the source URL.", "computed": true }, { - "name": "bastion_credential", + "name": "settings", "type": "TypeList", - "description": "User editable variable data \u0026 system generated reference to value.", + "description": "Environment variables for the Action.", "computed": true, "elem": { "link": { @@ -67553,9 +72115,45 @@ } }, { - "name": "action_outputs", + "name": "source_created_by", + "type": "TypeString", + "description": "E-mail address of user who created the Action Playbook Source.", + "computed": true + }, + { + "name": "source_type", + "type": "TypeString", + "description": "Type of source for the Template.", + "computed": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "Action creation time.", + "computed": true + }, + { + "name": "updated_by", + "type": "TypeString", + "description": "E-mail address of the user who updated an action.", + "computed": true + }, + { + "name": "description", + "type": "TypeString", + "description": "Action description.", + "computed": true + }, + { + "name": "command_parameter", + "type": "TypeString", + "description": "Schematics job command parameter (playbook-name).", + "computed": true + }, + { + "name": "bastion_credential", "type": "TypeList", - "description": "Output variables for the Action.", + "description": "User editable variable data \u0026 system generated reference to value.", "computed": true, "elem": { "link": { @@ -67689,48 +72287,21 @@ } }, { - "name": "state", - "type": "TypeList", - "description": "Computed state of the Action.", - "computed": true, - "elem": { - "status_code": { - "name": "status_code", - "type": "TypeString", - "description": "Status of automation (workspace or action).", - "computed": true - }, - "status_job_id": { - "name": "status_job_id", - "type": "TypeString", - "description": "Job id reference for this status.", - "computed": true - }, - "status_message": { - "name": "status_message", - "type": "TypeString", - "description": "Automation status message - to be displayed along with the status_code.", - "computed": true - } - } - }, - { - "name": "resource_group", + "name": "account", "type": "TypeString", - "description": "Resource-group name for an action. By default, action is created in default resource group.", - "cloud_data_type": "resource_group", + "description": "Action account ID.", "computed": true }, { - "name": "inventory", + "name": "source_updated_by", "type": "TypeString", - "description": "Target inventory record ID, used by the action or ansible playbook.", + "description": "E-mail address of user who updated the action playbook source.", "computed": true }, { - "name": "source_created_at", + "name": "created_by", "type": "TypeString", - "description": "Action Playbook Source creation time.", + "description": "E-mail address of the user who created an action.", "computed": true }, { @@ -67760,250 +72331,16 @@ } }, { - "name": "name", - "type": "TypeString", - "description": "The unique name of your action. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores. **Example** you can use the name to stop action.", - "computed": true - }, - { - "name": "bastion", - "type": "TypeList", - "description": "Describes a bastion resource.", - "computed": true, - "elem": { - "host": { - "name": "host", - "type": "TypeString", - "description": "Reference to the Inventory resource definition.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Bastion Name(Unique).", - "computed": true - } - } - }, - { - "name": "account", - "type": "TypeString", - "description": "Action account ID.", - "computed": true - }, - { - "name": "source_updated_at", - "type": "TypeString", - "description": "The action playbook updation time.", - "computed": true - }, - { - "name": "created_by", - "type": "TypeString", - "description": "E-mail address of the user who created an action.", - "computed": true - }, - { - "name": "updated_at", - "type": "TypeString", - "description": "Action updation time.", - "computed": true - }, - { - "name": "description", - "type": "TypeString", - "description": "Action description.", - "computed": true - }, - { - "name": "location", - "type": "TypeString", - "description": "List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.", - "cloud_data_type": "region", - "optional": true, - "computed": true - }, - { - "name": "user_state", - "type": "TypeList", - "description": "User defined status of the Schematics object.", - "computed": true, - "elem": { - "set_at": { - "name": "set_at", - "type": "TypeString", - "description": "When the User who set the state of the Object.", - "computed": true - }, - "set_by": { - "name": "set_by", - "type": "TypeString", - "description": "Name of the User who set the state of the Object.", - "computed": true - }, - "state": { - "name": "state", - "type": "TypeString", - "description": "User-defined states * `draft` Object can be modified; can be used by Jobs run by the author, during execution * `live` Object can be modified; can be used by Jobs during execution * `locked` Object cannot be modified; can be used by Jobs during execution * `disable` Object can be modified. cannot be used by Jobs during execution.", - "computed": true - } - } - }, - { - "name": "targets_ini", - "type": "TypeString", - "description": "Inventory of host and host group for the playbook in `INI` file format. For example, `\"targets_ini\": \"[webserverhost] 172.22.192.6 [dbhost] 172.22.192.5\"`. For more information, about an inventory host group syntax, see [Inventory host groups](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-reference#schematics-inventory-host-grps).", - "computed": true - }, - { - "name": "id", - "type": "TypeString", - "description": "Action ID.", - "computed": true - }, - { - "name": "source_created_by", - "type": "TypeString", - "description": "E-mail address of user who created the Action Playbook Source.", - "computed": true - }, - { - "name": "playbook_names", - "type": "TypeList", - "description": "Playbook names retrieved from the respository.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "tags", - "type": "TypeList", - "description": "Action tags.", - "cloud_data_type": "tags", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "source_readme_url", + "name": "resource_group", "type": "TypeString", - "description": "URL of the `README` file, for the source URL.", + "description": "Resource-group name for an action. By default, action is created in default resource group.", + "cloud_data_type": "resource_group", "computed": true }, { - "name": "source", - "type": "TypeList", - "description": "Source of templates, playbooks, or controls.", - "computed": true, - "elem": { - "catalog": { - "name": "catalog", - "type": "TypeList", - "description": "Connection details to IBM Cloud Catalog source.", - "computed": true, - "elem": { - "catalog_name": { - "name": "catalog_name", - "type": "TypeString", - "description": "name of the private catalog.", - "computed": true - }, - "offering_id": { - "name": "offering_id", - "type": "TypeString", - "description": "Id of the offering the IBM Catalog.", - "computed": true - }, - "offering_kind": { - "name": "offering_kind", - "type": "TypeString", - "description": "Type of the offering, in the IBM Catalog.", - "computed": true - }, - "offering_name": { - "name": "offering_name", - "type": "TypeString", - "description": "Name of the offering in the IBM Catalog.", - "computed": true - }, - "offering_repo_url": { - "name": "offering_repo_url", - "type": "TypeString", - "description": "Repo Url of the offering, in the IBM Catalog.", - "computed": true - }, - "offering_version": { - "name": "offering_version", - "type": "TypeString", - "description": "Version string of the offering in the IBM Catalog.", - "computed": true - }, - "offering_version_id": { - "name": "offering_version_id", - "type": "TypeString", - "description": "Id of the offering version the IBM Catalog.", - "computed": true - } - } - }, - "git": { - "name": "git", - "type": "TypeList", - "description": "Connection details to Git source.", - "computed": true, - "elem": { - "computed_git_repo_url": { - "name": "computed_git_repo_url", - "type": "TypeString", - "description": "The Complete URL which is computed by git_repo_url, git_repo_folder and branch.", - "computed": true - }, - "git_branch": { - "name": "git_branch", - "type": "TypeString", - "description": "Name of the branch, used to fetch the Git Repo.", - "computed": true - }, - "git_release": { - "name": "git_release", - "type": "TypeString", - "description": "Name of the release tag, used to fetch the Git Repo.", - "computed": true - }, - "git_repo_folder": { - "name": "git_repo_folder", - "type": "TypeString", - "description": "Name of the folder in the Git Repo, that contains the template.", - "computed": true - }, - "git_repo_url": { - "name": "git_repo_url", - "type": "TypeString", - "description": "URL to the GIT Repo that can be used to clone the template.", - "computed": true - }, - "git_token": { - "name": "git_token", - "type": "TypeString", - "description": "Personal Access Token to connect to Git URLs.", - "computed": true - } - } - }, - "source_type": { - "name": "source_type", - "type": "TypeString", - "description": "Type of source for the Template.", - "computed": true - } - } - }, - { - "name": "action_inputs", + "name": "credentials", "type": "TypeList", - "description": "Input variables for the Action.", + "description": "credentials of the Action.", "computed": true, "elem": { "link": { @@ -68057,57 +72394,12 @@ "description": "Is the variable readonly ?.", "computed": true }, - "matches": { - "name": "matches", - "type": "TypeString", - "description": "Regex for the variable value.", - "computed": true - }, - "max_length": { - "name": "max_length", - "type": "TypeInt", - "description": "Maximum length of the variable value. Applicable for string type.", - "computed": true - }, - "max_value": { - "name": "max_value", - "type": "TypeInt", - "description": "Maximum value of the variable. Applicable for integer type.", - "computed": true - }, - "min_length": { - "name": "min_length", - "type": "TypeInt", - "description": "Minimum length of the variable value. Applicable for string type.", - "computed": true - }, - "min_value": { - "name": "min_value", - "type": "TypeInt", - "description": "Minimum value of the variable. Applicable for integer type.", - "computed": true - }, - "options": { - "name": "options", - "type": "TypeList", - "description": "List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, "position": { "name": "position", "type": "TypeInt", "description": "Relative position of this variable in a list.", "computed": true }, - "secure": { - "name": "secure", - "type": "TypeBool", - "description": "Is the variable secure or sensitive ?.", - "computed": true - }, "source": { "name": "source", "type": "TypeString", @@ -68137,125 +72429,41 @@ } }, { - "name": "crn", - "type": "TypeString", - "description": "Action Cloud Resource Name.", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "created_at", - "type": "TypeString", - "description": "Action creation time.", - "computed": true - }, - { - "name": "updated_by", + "name": "updated_at", "type": "TypeString", - "description": "E-mail address of the user who updated an action.", + "description": "Action updation time.", "computed": true }, { - "name": "action_id", - "type": "TypeString", - "description": "Action Id. Use GET /actions API to look up the Action Ids in your IBM Cloud account.", - "required": true - }, - { - "name": "credentials", + "name": "state", "type": "TypeList", - "description": "credentials of the Action.", + "description": "Computed state of the Action.", "computed": true, "elem": { - "link": { - "name": "link", + "status_code": { + "name": "status_code", "type": "TypeString", - "description": "Reference link to the variable value By default the expression will point to self.value.", + "description": "Status of automation (workspace or action).", "computed": true }, - "metadata": { - "name": "metadata", - "type": "TypeList", - "description": "User editable metadata for the variables.", - "computed": true, - "elem": { - "aliases": { - "name": "aliases", - "type": "TypeList", - "description": "List of aliases for the variable name.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "default_value": { - "name": "default_value", - "type": "TypeString", - "description": "Default value for the variable, if the override value is not specified.", - "computed": true - }, - "description": { - "name": "description", - "type": "TypeString", - "description": "Description of the meta data.", - "computed": true - }, - "group_by": { - "name": "group_by", - "type": "TypeString", - "description": "Display name of the group this variable belongs to.", - "computed": true - }, - "hidden": { - "name": "hidden", - "type": "TypeBool", - "description": "If true, the variable will not be displayed on UI or CLI.", - "computed": true - }, - "immutable": { - "name": "immutable", - "type": "TypeBool", - "description": "Is the variable readonly ?.", - "computed": true - }, - "position": { - "name": "position", - "type": "TypeInt", - "description": "Relative position of this variable in a list.", - "computed": true - }, - "source": { - "name": "source", - "type": "TypeString", - "description": "Source of this meta-data.", - "computed": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "Type of the variable.", - "computed": true - } - } - }, - "name": { - "name": "name", + "status_job_id": { + "name": "status_job_id", "type": "TypeString", - "description": "Name of the variable.", + "description": "Job id reference for this status.", "computed": true }, - "value": { - "name": "value", + "status_message": { + "name": "status_message", "type": "TypeString", - "description": "Value for the variable or reference to the value.", + "description": "Automation status message - to be displayed along with the status_code.", "computed": true } } }, { - "name": "settings", + "name": "action_inputs", "type": "TypeList", - "description": "Environment variables for the Action.", + "description": "Input variables for the Action.", "computed": true, "elem": { "link": { @@ -68389,97 +72597,9 @@ } }, { - "name": "source_updated_by", - "type": "TypeString", - "description": "E-mail address of user who updated the action playbook source.", - "computed": true - } - ], - "ibm_schematics_inventory": [ - { - "name": "created_by", - "type": "TypeString", - "description": "Email address of user who created the Inventory.", - "computed": true - }, - { - "name": "updated_at", - "type": "TypeString", - "description": "Inventory updation time.", - "computed": true - }, - { - "name": "updated_by", - "type": "TypeString", - "description": "Email address of user who updated the Inventory.", - "computed": true - }, - { - "name": "resource_queries", - "type": "TypeList", - "description": "Input resource queries that is used to dynamically generate the inventory of host and host group for the playbook.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "inventory_id", - "type": "TypeString", - "description": "Resource Inventory Id. Use `GET /v2/inventories` API to look up the Resource Inventory definition Ids in your IBM Cloud account.", - "required": true - }, - { - "name": "name", - "type": "TypeString", - "description": "The unique name of your Inventory. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores.", - "computed": true - }, - { - "name": "resource_group", - "type": "TypeString", - "description": "Resource-group name for the Inventory definition. By default, Inventory will be created in Default Resource Group.", - "cloud_data_type": "resource_group", - "computed": true - }, - { - "name": "created_at", - "type": "TypeString", - "description": "Inventory creation time.", - "computed": true - }, - { - "name": "inventories_ini", - "type": "TypeString", - "description": "Input inventory of host and host group for the playbook, in the .ini file format.", - "computed": true - }, - { - "name": "id", - "type": "TypeString", - "description": "Inventory id.", - "computed": true - }, - { - "name": "description", - "type": "TypeString", - "description": "The description of your Inventory. The description can be up to 2048 characters long in size.", - "computed": true - }, - { - "name": "location", - "type": "TypeString", - "description": "List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.", - "cloud_data_type": "region", - "optional": true, - "computed": true - } - ], - "ibm_schematics_job": [ - { - "name": "job_inputs", + "name": "action_outputs", "type": "TypeList", - "description": "Job inputs used by Action or Workspace.", + "description": "Output variables for the Action.", "computed": true, "elem": { "link": { @@ -68612,6 +72732,121 @@ } } }, + { + "name": "crn", + "type": "TypeString", + "description": "Action Cloud Resource Name.", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "source", + "type": "TypeList", + "description": "Source of templates, playbooks, or controls.", + "computed": true, + "elem": { + "catalog": { + "name": "catalog", + "type": "TypeList", + "description": "Connection details to IBM Cloud Catalog source.", + "computed": true, + "elem": { + "catalog_name": { + "name": "catalog_name", + "type": "TypeString", + "description": "name of the private catalog.", + "computed": true + }, + "offering_id": { + "name": "offering_id", + "type": "TypeString", + "description": "Id of the offering the IBM Catalog.", + "computed": true + }, + "offering_kind": { + "name": "offering_kind", + "type": "TypeString", + "description": "Type of the offering, in the IBM Catalog.", + "computed": true + }, + "offering_name": { + "name": "offering_name", + "type": "TypeString", + "description": "Name of the offering in the IBM Catalog.", + "computed": true + }, + "offering_repo_url": { + "name": "offering_repo_url", + "type": "TypeString", + "description": "Repo Url of the offering, in the IBM Catalog.", + "computed": true + }, + "offering_version": { + "name": "offering_version", + "type": "TypeString", + "description": "Version string of the offering in the IBM Catalog.", + "computed": true + }, + "offering_version_id": { + "name": "offering_version_id", + "type": "TypeString", + "description": "Id of the offering version the IBM Catalog.", + "computed": true + } + } + }, + "git": { + "name": "git", + "type": "TypeList", + "description": "Connection details to Git source.", + "computed": true, + "elem": { + "computed_git_repo_url": { + "name": "computed_git_repo_url", + "type": "TypeString", + "description": "The Complete URL which is computed by git_repo_url, git_repo_folder and branch.", + "computed": true + }, + "git_branch": { + "name": "git_branch", + "type": "TypeString", + "description": "Name of the branch, used to fetch the Git Repo.", + "computed": true + }, + "git_release": { + "name": "git_release", + "type": "TypeString", + "description": "Name of the release tag, used to fetch the Git Repo.", + "computed": true + }, + "git_repo_folder": { + "name": "git_repo_folder", + "type": "TypeString", + "description": "Name of the folder in the Git Repo, that contains the template.", + "computed": true + }, + "git_repo_url": { + "name": "git_repo_url", + "type": "TypeString", + "description": "URL to the GIT Repo that can be used to clone the template.", + "computed": true + }, + "git_token": { + "name": "git_token", + "type": "TypeString", + "description": "Personal Access Token to connect to Git URLs.", + "computed": true + } + } + }, + "source_type": { + "name": "source_type", + "type": "TypeString", + "description": "Type of source for the Template.", + "computed": true + } + } + }, { "name": "bastion", "type": "TypeList", @@ -68633,61 +72868,132 @@ } }, { - "name": "job_id", + "name": "targets_ini", "type": "TypeString", - "description": "Job Id. Use `GET /v2/jobs` API to look up the Job Ids in your IBM Cloud account.", - "required": true + "description": "Inventory of host and host group for the playbook in `INI` file format. For example, `\"targets_ini\": \"[webserverhost] 172.22.192.6 [dbhost] 172.22.192.5\"`. For more information, about an inventory host group syntax, see [Inventory host groups](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-reference#schematics-inventory-host-grps).", + "computed": true }, { - "name": "submitted_by", + "name": "source_updated_at", "type": "TypeString", - "description": "Email address of user who submitted the job.", + "description": "The action playbook updation time.", "computed": true }, { - "name": "end_at", + "name": "playbook_names", + "type": "TypeList", + "description": "Playbook names retrieved from the respository.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "location", "type": "TypeString", - "description": "Job end time.", + "description": "List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.", + "cloud_data_type": "region", + "optional": true, "computed": true }, { - "name": "updated_at", + "name": "inventory", "type": "TypeString", - "description": "Job status updation timestamp.", + "description": "Target inventory record ID, used by the action or ansible playbook.", "computed": true }, { - "name": "name", + "name": "id", "type": "TypeString", - "description": "Job name, uniquely derived from the related Workspace or Action.", + "description": "Action ID.", "computed": true - }, + } + ], + "ibm_schematics_inventory": [ { - "name": "submitted_at", + "name": "updated_at", "type": "TypeString", - "description": "Job submission time.", + "description": "Inventory updation time.", "computed": true }, { - "name": "tags", + "name": "resource_queries", "type": "TypeList", - "description": "User defined tags, while running the job.", - "cloud_data_type": "tags", + "description": "Input resource queries that is used to dynamically generate the inventory of host and host group for the playbook.", "computed": true, "elem": { "type": "TypeString" } }, + { + "name": "inventory_id", + "type": "TypeString", + "description": "Resource Inventory Id. Use `GET /v2/inventories` API to look up the Resource Inventory definition Ids in your IBM Cloud account.", + "required": true + }, + { + "name": "description", + "type": "TypeString", + "description": "The description of your Inventory. The description can be up to 2048 characters long in size.", + "computed": true + }, + { + "name": "resource_group", + "type": "TypeString", + "description": "Resource-group name for the Inventory definition. By default, Inventory will be created in Default Resource Group.", + "cloud_data_type": "resource_group", + "computed": true + }, + { + "name": "created_by", + "type": "TypeString", + "description": "Email address of user who created the Inventory.", + "computed": true + }, + { + "name": "updated_by", + "type": "TypeString", + "description": "Email address of user who updated the Inventory.", + "computed": true + }, + { + "name": "inventories_ini", + "type": "TypeString", + "description": "Input inventory of host and host group for the playbook, in the .ini file format.", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "The unique name of your Inventory. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores.", + "computed": true + }, { "name": "id", "type": "TypeString", - "description": "Job ID.", + "description": "Inventory id.", "computed": true }, { - "name": "description", + "name": "location", "type": "TypeString", - "description": "The description of your job is derived from the related action or workspace. The description can be up to 2048 characters long in size.", + "description": "List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.", + "cloud_data_type": "region", + "optional": true, + "computed": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "Inventory creation time.", + "computed": true + } + ], + "ibm_schematics_job": [ + { + "name": "command_object", + "type": "TypeString", + "description": "Name of the Schematics automation resource.", "computed": true }, { @@ -69053,9 +73359,21 @@ } }, { - "name": "results_url", + "name": "command_name", "type": "TypeString", - "description": "Job results store URL.", + "description": "Schematics job command name.", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "Job name, uniquely derived from the related Workspace or Action.", + "computed": true + }, + { + "name": "submitted_by", + "type": "TypeString", + "description": "Email address of user who submitted the job.", "computed": true }, { @@ -69065,13 +73383,16 @@ "computed": true }, { - "name": "command_options", - "type": "TypeList", - "description": "Command line options for the command.", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "id", + "type": "TypeString", + "description": "Job ID.", + "computed": true + }, + { + "name": "description", + "type": "TypeString", + "description": "The description of your job is derived from the related action or workspace. The description can be up to 2048 characters long in size.", + "computed": true }, { "name": "start_at", @@ -69080,11 +73401,10 @@ "computed": true }, { - "name": "location", + "name": "resource_group", "type": "TypeString", - "description": "List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.", - "cloud_data_type": "region", - "optional": true, + "description": "Resource-group name derived from the related Workspace or Action.", + "cloud_data_type": "resource_group", "computed": true }, { @@ -69094,21 +73414,313 @@ "computed": true }, { - "name": "command_object", + "name": "command_object_id", "type": "TypeString", - "description": "Name of the Schematics automation resource.", + "description": "Job command object id (workspace-id, action-id).", "computed": true }, { - "name": "command_object_id", + "name": "job_env_settings", + "type": "TypeList", + "description": "Environment variables used by the Job while performing Action or Workspace.", + "computed": true, + "elem": { + "link": { + "name": "link", + "type": "TypeString", + "description": "Reference link to the variable value By default the expression will point to self.value.", + "computed": true + }, + "metadata": { + "name": "metadata", + "type": "TypeList", + "description": "User editable metadata for the variables.", + "computed": true, + "elem": { + "aliases": { + "name": "aliases", + "type": "TypeList", + "description": "List of aliases for the variable name.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "default_value": { + "name": "default_value", + "type": "TypeString", + "description": "Default value for the variable, if the override value is not specified.", + "computed": true + }, + "description": { + "name": "description", + "type": "TypeString", + "description": "Description of the meta data.", + "computed": true + }, + "group_by": { + "name": "group_by", + "type": "TypeString", + "description": "Display name of the group this variable belongs to.", + "computed": true + }, + "hidden": { + "name": "hidden", + "type": "TypeBool", + "description": "If true, the variable will not be displayed on UI or CLI.", + "computed": true + }, + "immutable": { + "name": "immutable", + "type": "TypeBool", + "description": "Is the variable readonly ?.", + "computed": true + }, + "matches": { + "name": "matches", + "type": "TypeString", + "description": "Regex for the variable value.", + "computed": true + }, + "max_length": { + "name": "max_length", + "type": "TypeInt", + "description": "Maximum length of the variable value. Applicable for string type.", + "computed": true + }, + "max_value": { + "name": "max_value", + "type": "TypeInt", + "description": "Maximum value of the variable. Applicable for integer type.", + "computed": true + }, + "min_length": { + "name": "min_length", + "type": "TypeInt", + "description": "Minimum length of the variable value. Applicable for string type.", + "computed": true + }, + "min_value": { + "name": "min_value", + "type": "TypeInt", + "description": "Minimum value of the variable. Applicable for integer type.", + "computed": true + }, + "options": { + "name": "options", + "type": "TypeList", + "description": "List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "position": { + "name": "position", + "type": "TypeInt", + "description": "Relative position of this variable in a list.", + "computed": true + }, + "secure": { + "name": "secure", + "type": "TypeBool", + "description": "Is the variable secure or sensitive ?.", + "computed": true + }, + "source": { + "name": "source", + "type": "TypeString", + "description": "Source of this meta-data.", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "Type of the variable.", + "computed": true + } + } + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Name of the variable.", + "computed": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "Value for the variable or reference to the value.", + "computed": true + } + } + }, + { + "name": "submitted_at", "type": "TypeString", - "description": "Job command object id (workspace-id, action-id).", + "description": "Job submission time.", "computed": true }, { - "name": "state_store_url", + "name": "log_store_url", "type": "TypeString", - "description": "Job state store URL.", + "description": "Job log store URL.", + "computed": true + }, + { + "name": "results_url", + "type": "TypeString", + "description": "Job results store URL.", + "computed": true + }, + { + "name": "job_id", + "type": "TypeString", + "description": "Job Id. Use `GET /v2/jobs` API to look up the Job Ids in your IBM Cloud account.", + "required": true + }, + { + "name": "job_inputs", + "type": "TypeList", + "description": "Job inputs used by Action or Workspace.", + "computed": true, + "elem": { + "link": { + "name": "link", + "type": "TypeString", + "description": "Reference link to the variable value By default the expression will point to self.value.", + "computed": true + }, + "metadata": { + "name": "metadata", + "type": "TypeList", + "description": "User editable metadata for the variables.", + "computed": true, + "elem": { + "aliases": { + "name": "aliases", + "type": "TypeList", + "description": "List of aliases for the variable name.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "default_value": { + "name": "default_value", + "type": "TypeString", + "description": "Default value for the variable, if the override value is not specified.", + "computed": true + }, + "description": { + "name": "description", + "type": "TypeString", + "description": "Description of the meta data.", + "computed": true + }, + "group_by": { + "name": "group_by", + "type": "TypeString", + "description": "Display name of the group this variable belongs to.", + "computed": true + }, + "hidden": { + "name": "hidden", + "type": "TypeBool", + "description": "If true, the variable will not be displayed on UI or CLI.", + "computed": true + }, + "immutable": { + "name": "immutable", + "type": "TypeBool", + "description": "Is the variable readonly ?.", + "computed": true + }, + "matches": { + "name": "matches", + "type": "TypeString", + "description": "Regex for the variable value.", + "computed": true + }, + "max_length": { + "name": "max_length", + "type": "TypeInt", + "description": "Maximum length of the variable value. Applicable for string type.", + "computed": true + }, + "max_value": { + "name": "max_value", + "type": "TypeInt", + "description": "Maximum value of the variable. Applicable for integer type.", + "computed": true + }, + "min_length": { + "name": "min_length", + "type": "TypeInt", + "description": "Minimum length of the variable value. Applicable for string type.", + "computed": true + }, + "min_value": { + "name": "min_value", + "type": "TypeInt", + "description": "Minimum value of the variable. Applicable for integer type.", + "computed": true + }, + "options": { + "name": "options", + "type": "TypeList", + "description": "List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "position": { + "name": "position", + "type": "TypeInt", + "description": "Relative position of this variable in a list.", + "computed": true + }, + "secure": { + "name": "secure", + "type": "TypeBool", + "description": "Is the variable secure or sensitive ?.", + "computed": true + }, + "source": { + "name": "source", + "type": "TypeString", + "description": "Source of this meta-data.", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "Type of the variable.", + "computed": true + } + } + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Name of the variable.", + "computed": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "Value for the variable or reference to the value.", + "computed": true + } + } + }, + { + "name": "location", + "type": "TypeString", + "description": "List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.", + "cloud_data_type": "region", + "optional": true, "computed": true }, { @@ -71169,19 +75781,6 @@ } } }, - { - "name": "log_store_url", - "type": "TypeString", - "description": "Job log store URL.", - "computed": true - }, - { - "name": "resource_group", - "type": "TypeString", - "description": "Resource-group name derived from the related Workspace or Action.", - "cloud_data_type": "resource_group", - "computed": true - }, { "name": "log_summary", "type": "TypeList", @@ -71479,149 +76078,71 @@ } }, { - "name": "command_name", - "type": "TypeString", - "description": "Schematics job command name.", - "computed": true + "name": "command_options", + "type": "TypeList", + "description": "Command line options for the command.", + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "job_env_settings", + "name": "tags", "type": "TypeList", - "description": "Environment variables used by the Job while performing Action or Workspace.", + "description": "User defined tags, while running the job.", + "cloud_data_type": "tags", "computed": true, "elem": { - "link": { - "name": "link", - "type": "TypeString", - "description": "Reference link to the variable value By default the expression will point to self.value.", - "computed": true - }, - "metadata": { - "name": "metadata", - "type": "TypeList", - "description": "User editable metadata for the variables.", - "computed": true, - "elem": { - "aliases": { - "name": "aliases", - "type": "TypeList", - "description": "List of aliases for the variable name.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "default_value": { - "name": "default_value", - "type": "TypeString", - "description": "Default value for the variable, if the override value is not specified.", - "computed": true - }, - "description": { - "name": "description", - "type": "TypeString", - "description": "Description of the meta data.", - "computed": true - }, - "group_by": { - "name": "group_by", - "type": "TypeString", - "description": "Display name of the group this variable belongs to.", - "computed": true - }, - "hidden": { - "name": "hidden", - "type": "TypeBool", - "description": "If true, the variable will not be displayed on UI or CLI.", - "computed": true - }, - "immutable": { - "name": "immutable", - "type": "TypeBool", - "description": "Is the variable readonly ?.", - "computed": true - }, - "matches": { - "name": "matches", - "type": "TypeString", - "description": "Regex for the variable value.", - "computed": true - }, - "max_length": { - "name": "max_length", - "type": "TypeInt", - "description": "Maximum length of the variable value. Applicable for string type.", - "computed": true - }, - "max_value": { - "name": "max_value", - "type": "TypeInt", - "description": "Maximum value of the variable. Applicable for integer type.", - "computed": true - }, - "min_length": { - "name": "min_length", - "type": "TypeInt", - "description": "Minimum length of the variable value. Applicable for string type.", - "computed": true - }, - "min_value": { - "name": "min_value", - "type": "TypeInt", - "description": "Minimum value of the variable. Applicable for integer type.", - "computed": true - }, - "options": { - "name": "options", - "type": "TypeList", - "description": "List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "position": { - "name": "position", - "type": "TypeInt", - "description": "Relative position of this variable in a list.", - "computed": true - }, - "secure": { - "name": "secure", - "type": "TypeBool", - "description": "Is the variable secure or sensitive ?.", - "computed": true - }, - "source": { - "name": "source", - "type": "TypeString", - "description": "Source of this meta-data.", - "computed": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "Type of the variable.", - "computed": true - } - } - }, - "name": { - "name": "name", + "type": "TypeString" + } + }, + { + "name": "end_at", + "type": "TypeString", + "description": "Job end time.", + "computed": true + }, + { + "name": "bastion", + "type": "TypeList", + "description": "Describes a bastion resource.", + "computed": true, + "elem": { + "host": { + "name": "host", "type": "TypeString", - "description": "Name of the variable.", + "description": "Reference to the Inventory resource definition.", "computed": true }, - "value": { - "name": "value", + "name": { + "name": "name", "type": "TypeString", - "description": "Value for the variable or reference to the value.", + "description": "Bastion Name(Unique).", "computed": true } } + }, + { + "name": "state_store_url", + "type": "TypeString", + "description": "Job state store URL.", + "computed": true + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Job status updation timestamp.", + "computed": true } ], "ibm_schematics_output": [ + { + "name": "location", + "type": "TypeString", + "description": "The Region of the workspace.", + "cloud_data_type": "region", + "optional": true + }, { "name": "template_id", "type": "TypeString", @@ -71650,38 +76171,13 @@ "type": "TypeString", "description": "The ID of the workspace for which you want to retrieve output values. To find the workspace ID, use the `GET /workspaces` API.", "required": true - }, - { - "name": "location", - "type": "TypeString", - "description": "The Region of the workspace.", - "cloud_data_type": "region", - "optional": true } ], "ibm_schematics_resource_query": [ { - "name": "type", - "type": "TypeString", - "description": "Resource type (cluster, vsi, icd, vpc).", - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Resource query name.", - "computed": true - }, - { - "name": "created_at", - "type": "TypeString", - "description": "Resource query creation time.", - "computed": true - }, - { - "name": "updated_at", + "name": "updated_by", "type": "TypeString", - "description": "Resource query updation time.", + "description": "Email address of user who updated the Resource query.", "computed": true }, { @@ -71732,10 +76228,10 @@ } }, { - "name": "query_id", + "name": "updated_at", "type": "TypeString", - "description": "Resource query Id. Use `GET /v2/resource_query` API to look up the Resource query definition Ids in your IBM Cloud account.", - "required": true + "description": "Resource query updation time.", + "computed": true }, { "name": "location", @@ -71744,12 +76240,30 @@ "cloud_data_type": "region", "optional": true }, + { + "name": "type", + "type": "TypeString", + "description": "Resource type (cluster, vsi, icd, vpc).", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "Resource query name.", + "computed": true + }, { "name": "id", "type": "TypeString", "description": "Resource Query id.", "computed": true }, + { + "name": "created_at", + "type": "TypeString", + "description": "Resource query creation time.", + "computed": true + }, { "name": "created_by", "type": "TypeString", @@ -71757,19 +76271,13 @@ "computed": true }, { - "name": "updated_by", + "name": "query_id", "type": "TypeString", - "description": "Email address of user who updated the Resource query.", - "computed": true + "description": "Resource query Id. Use `GET /v2/resource_query` API to look up the Resource query definition Ids in your IBM Cloud account.", + "required": true } ], "ibm_schematics_state": [ - { - "name": "resource_controller_url", - "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this workspace", - "computed": true - }, { "name": "workspace_id", "type": "TypeString", @@ -71798,27 +76306,64 @@ "name": "state_store_json", "type": "TypeString", "computed": true + }, + { + "name": "resource_controller_url", + "type": "TypeString", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this workspace", + "computed": true } ], "ibm_schematics_workspace": [ { - "name": "status", - "type": "TypeString", - "description": "The status of the workspace. **Active**: After you successfully ran your infrastructure code by applying your Terraform execution plan, the state of your workspace changes to `Active`. **Connecting**: Schematics tries to connect to the template in your source repo. If successfully connected, the template is downloaded and metadata, such as input parameters, is extracted. After the template is downloaded, the state of the workspace changes to `Scanning`. **Draft**: The workspace is created without a reference to a GitHub or GitLab repository. **Failed**: If errors occur during the execution of your infrastructure code in IBM Cloud Schematics, your workspace status is set to `Failed`. **Inactive**: The Terraform template was scanned successfully and the workspace creation is complete. You can now start running Schematics plan and apply jobs to provision the IBM Cloud resources that you specified in your template. If you have an `Active` workspace and decide to remove all your resources, your workspace is set to `Inactive` after all your resources are removed. **In progress**: When you instruct IBM Cloud Schematics to run your infrastructure code by applying your Terraform execution plan, the status of our workspace changes to `In progress`. **Scanning**: The download of the Terraform template is complete and vulnerability scanning started. If the scan is successful, the workspace state changes to `Inactive`. If errors in your template are found, the state changes to `Template Error`. **Stopped**: The Schematics plan, apply, or destroy job was cancelled manually. **Template Error**: The Schematics template contains errors and cannot be processed.", - "computed": true + "name": "template_inputs", + "type": "TypeList", + "description": "Information about the input variables that your template uses.", + "computed": true, + "elem": { + "description": { + "name": "description", + "type": "TypeString", + "description": "The description of your input variable.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The name of the variable.", + "computed": true + }, + "secure": { + "name": "secure", + "type": "TypeBool", + "description": "If set to `true`, the value of your input variable is protected and not returned in your API response.", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "`Terraform v0.11` supports `string`, `list`, `map` data type. For more information, about the syntax, see [Configuring input variables](https://www.terraform.io/docs/configuration-0-11/variables.html).\u003cbr\u003e `Terraform v0.12` additionally, supports `bool`, `number` and complex data types such as `list(type)`, `map(type)`,`object({attribute name=type,..})`, `set(type)`, `tuple([type])`. For more information, about the syntax to use the complex data type, see [Configuring variables](https://www.terraform.io/docs/configuration/variables.html#type-constraints).", + "computed": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "Enter the value as a string for the primitive types such as `bool`, `number`, `string`, and `HCL` format for the complex variables, as you provide in a `.tfvars` file. **You need to enter escaped string of `HCL` format for the complex variable value**. For more information, about how to declare variables in a terraform configuration file and provide value to schematics, see [Providing values for the declared variables](https://cloud.ibm.com/docs/schematics?topic=schematics-create-tf-config#declare-variable).", + "computed": true + } + } }, { - "name": "template_git_release", - "type": "TypeString", - "description": "The repository release.", + "name": "frozen", + "type": "TypeBool", + "description": "If set to true, the workspace is frozen and changes to the workspace are disabled.", "computed": true }, { - "name": "is_locked", - "type": "TypeBool", - "description": "If set to true, the workspace is locked and disabled for changes.", - "computed": true, - "deprecated": "Use locked instead" + "name": "frozen_at", + "type": "TypeString", + "description": "The timestamp when the workspace was frozen.", + "computed": true }, { "name": "locked_time", @@ -71827,94 +76372,139 @@ "computed": true }, { - "name": "workspace_id", + "name": "resource_controller_url", "type": "TypeString", - "description": "The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API.", - "required": true + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this workspace", + "computed": true }, { - "name": "created_by", + "name": "created_at", "type": "TypeString", - "description": "The user ID that created the workspace.", + "description": "The timestamp when the workspace was created.", "computed": true }, { - "name": "name", + "name": "last_health_check_at", "type": "TypeString", - "description": "The name of the workspace.", + "description": "The timestamp when the last health check was performed by Schematics.", "computed": true }, { - "name": "runtime_data", + "name": "status", + "type": "TypeString", + "description": "The status of the workspace. **Active**: After you successfully ran your infrastructure code by applying your Terraform execution plan, the state of your workspace changes to `Active`. **Connecting**: Schematics tries to connect to the template in your source repo. If successfully connected, the template is downloaded and metadata, such as input parameters, is extracted. After the template is downloaded, the state of the workspace changes to `Scanning`. **Draft**: The workspace is created without a reference to a GitHub or GitLab repository. **Failed**: If errors occur during the execution of your infrastructure code in IBM Cloud Schematics, your workspace status is set to `Failed`. **Inactive**: The Terraform template was scanned successfully and the workspace creation is complete. You can now start running Schematics plan and apply jobs to provision the IBM Cloud resources that you specified in your template. If you have an `Active` workspace and decide to remove all your resources, your workspace is set to `Inactive` after all your resources are removed. **In progress**: When you instruct IBM Cloud Schematics to run your infrastructure code by applying your Terraform execution plan, the status of our workspace changes to `In progress`. **Scanning**: The download of the Terraform template is complete and vulnerability scanning started. If the scan is successful, the workspace state changes to `Inactive`. If errors in your template are found, the state changes to `Template Error`. **Stopped**: The Schematics plan, apply, or destroy job was cancelled manually. **Template Error**: The Schematics template contains errors and cannot be processed.", + "computed": true + }, + { + "name": "template_env_settings", "type": "TypeList", - "description": "Information about the provisioning engine, state file, and runtime logs.", + "description": "List of environment values.", "computed": true, "elem": { - "engine_cmd": { - "name": "engine_cmd", - "type": "TypeString", - "description": "The command that was used to apply the Terraform template or IBM Cloud catalog software template.", + "hidden": { + "name": "hidden", + "type": "TypeBool", + "description": "If set to `true`, the value of your input variable is protected and not returned in your API response.", "computed": true }, - "engine_name": { - "name": "engine_name", + "name": { + "name": "name", "type": "TypeString", - "description": "The provisioning engine that was used to apply the Terraform template or IBM Cloud catalog software template.", + "description": "The name of the variable.", "computed": true }, - "engine_version": { - "name": "engine_version", - "type": "TypeString", - "description": "The version of the provisioning engine that was used.", + "secure": { + "name": "secure", + "type": "TypeBool", + "description": "If set to `true`, the value of your input variable is protected and not returned in your API response.", "computed": true }, - "id": { - "name": "id", + "value": { + "name": "value", "type": "TypeString", - "description": "The ID that was assigned to your Terraform template or IBM Cloud catalog software template.", + "description": "Enter the value as a string for the primitive types such as `bool`, `number`, `string`, and `HCL` format for the complex variables, as you provide in a `.tfvars` file. **You need to enter escaped string of `HCL` format for the complex variable value**. For more information, about how to declare variables in a terraform configuration file and provide value to schematics, see [Providing values for the declared variables](/docs/schematics?topic=schematics-create-tf-config#declare-variable).", + "computed": true + } + } + }, + { + "name": "template_git_full_url", + "type": "TypeString", + "description": "Full repository URL.", + "computed": true + }, + { + "name": "is_frozen", + "type": "TypeBool", + "computed": true, + "deprecated": "use frozen instead" + }, + { + "name": "location", + "type": "TypeString", + "description": "The IBM Cloud location where your workspace was provisioned.", + "cloud_data_type": "region", + "optional": true, + "computed": true + }, + { + "name": "shared_data", + "type": "TypeList", + "description": "Information about the Target used by the templates originating from IBM Cloud catalog offerings. This information is not relevant when you create a workspace from your own Terraform template.", + "computed": true, + "elem": { + "cluster_id": { + "name": "cluster_id", + "type": "TypeString", + "description": "The ID of the cluster where you want to provision the resources of all IBM Cloud catalog templates that are included in the catalog offering.", "computed": true }, - "log_store_url": { - "name": "log_store_url", + "cluster_name": { + "name": "cluster_name", "type": "TypeString", - "description": "The URL to access the logs that were created during the creation, update, or deletion of your IBM Cloud resources.", + "description": "Target cluster name.", "computed": true }, - "output_values": { - "name": "output_values", + "entitlement_keys": { + "name": "entitlement_keys", "type": "TypeList", - "description": "List of Output values.", + "description": "The entitlement key that you want to use to install IBM Cloud entitled software.", "computed": true, "elem": { "type": "TypeMap" } }, - "resources": { - "name": "resources", - "type": "TypeList", - "description": "List of resources.", - "computed": true, - "elem": { - "type": "TypeMap" - } + "namespace": { + "name": "namespace", + "type": "TypeString", + "description": "The Kubernetes namespace or OpenShift project where the resources of all IBM Cloud catalog templates that are included in the catalog offering are deployed into.", + "computed": true }, - "state_store_url": { - "name": "state_store_url", + "region": { + "name": "region", "type": "TypeString", - "description": "The URL where the Terraform statefile (`terraform.tfstate`) is stored. You can use the statefile to find an overview of IBM Cloud resources that were created by Schematics. Schematics uses the statefile as an inventory list to determine future create, update, or deletion jobs.", + "description": "The IBM Cloud region that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.", + "computed": true + }, + "resource_group_id": { + "name": "resource_group_id", + "type": "TypeString", + "description": "The ID of the resource group that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.", "computed": true } } }, { - "name": "tags", - "type": "TypeList", - "description": "A list of tags that are associated with the workspace.", - "cloud_data_type": "tags", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "template_git_release", + "type": "TypeString", + "description": "The repository release.", + "computed": true + }, + { + "name": "template_git_repo_url", + "type": "TypeString", + "description": "The repository URL.", + "computed": true }, { "name": "frozen_by", @@ -71923,28 +76513,29 @@ "computed": true }, { - "name": "locked", - "type": "TypeBool", - "description": "If set to true, the workspace is locked and disabled for changes.", + "name": "crn", + "type": "TypeString", + "description": "The workspace CRN.", + "cloud_data_type": "crn", "computed": true }, { - "name": "template_git_repo_sha_value", + "name": "description", "type": "TypeString", - "description": "The repository SHA value.", + "description": "The description of the workspace.", "computed": true }, { - "name": "template_git_repo_url", + "name": "status_msg", "type": "TypeString", - "description": "The repository URL.", + "description": "The success or error message that was returned for the last plan, apply, or destroy job that ran against your workspace.", "computed": true }, { - "name": "is_frozen", - "type": "TypeBool", - "computed": true, - "deprecated": "use frozen instead" + "name": "locked_by", + "type": "TypeString", + "description": "The user ID that initiated a resource-related job, such as applying or destroying resources, that locked the workspace.", + "computed": true }, { "name": "catalog_ref", @@ -72009,17 +76600,129 @@ } }, { - "name": "description", + "name": "runtime_data", + "type": "TypeList", + "description": "Information about the provisioning engine, state file, and runtime logs.", + "computed": true, + "elem": { + "engine_cmd": { + "name": "engine_cmd", + "type": "TypeString", + "description": "The command that was used to apply the Terraform template or IBM Cloud catalog software template.", + "computed": true + }, + "engine_name": { + "name": "engine_name", + "type": "TypeString", + "description": "The provisioning engine that was used to apply the Terraform template or IBM Cloud catalog software template.", + "computed": true + }, + "engine_version": { + "name": "engine_version", + "type": "TypeString", + "description": "The version of the provisioning engine that was used.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The ID that was assigned to your Terraform template or IBM Cloud catalog software template.", + "computed": true + }, + "log_store_url": { + "name": "log_store_url", + "type": "TypeString", + "description": "The URL to access the logs that were created during the creation, update, or deletion of your IBM Cloud resources.", + "computed": true + }, + "output_values": { + "name": "output_values", + "type": "TypeList", + "description": "List of Output values.", + "computed": true, + "elem": { + "type": "TypeMap" + } + }, + "resources": { + "name": "resources", + "type": "TypeList", + "description": "List of resources.", + "computed": true, + "elem": { + "type": "TypeMap" + } + }, + "state_store_url": { + "name": "state_store_url", + "type": "TypeString", + "description": "The URL where the Terraform statefile (`terraform.tfstate`) is stored. You can use the statefile to find an overview of IBM Cloud resources that were created by Schematics. Schematics uses the statefile as an inventory list to determine future create, update, or deletion jobs.", + "computed": true + } + } + }, + { + "name": "tags", + "type": "TypeList", + "description": "A list of tags that are associated with the workspace.", + "cloud_data_type": "tags", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "template_git_branch", "type": "TypeString", - "description": "The description of the workspace.", + "description": "The repository branch.", + "computed": true + }, + { + "name": "template_git_url", + "type": "TypeString", + "description": "The source URL.", + "computed": true + }, + { + "name": "is_locked", + "type": "TypeBool", + "description": "If set to true, the workspace is locked and disabled for changes.", + "computed": true, + "deprecated": "Use locked instead" + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "The timestamp when the workspace was last updated.", + "computed": true + }, + { + "name": "locked", + "type": "TypeBool", + "description": "If set to true, the workspace is locked and disabled for changes.", "computed": true }, + { + "name": "applied_shareddata_ids", + "type": "TypeList", + "description": "List of applied shared dataset ID.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, { "name": "template_git_folder", "type": "TypeString", "description": "The subfolder in your GitHub or GitLab repository where your Terraform template is stored. If your template is stored in the root directory, `.` is returned.", "computed": true }, + { + "name": "template_values", + "type": "TypeString", + "description": "A list of variable values that you want to apply during the Helm chart installation. The list must be provided in JSON format, such as `\"\"autoscaling: enabled: true minReplicas: 2\"`. The values that you define here override the default Helm chart values. This field is supported only for IBM Cloud catalog offerings that are provisioned by using the Terraform Helm provider.", + "computed": true + }, { "name": "template_values_metadata", "type": "TypeList", @@ -72149,6 +76852,30 @@ } } }, + { + "name": "template_ref", + "type": "TypeString", + "description": "Workspace template ref.", + "computed": true + }, + { + "name": "template_git_repo_sha_value", + "type": "TypeString", + "description": "The repository SHA value.", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "The name of the workspace.", + "computed": true + }, + { + "name": "template_uninstall_script_name", + "type": "TypeString", + "description": "Uninstall script name.", + "computed": true + }, { "name": "template_git_has_uploadedgitrepotar", "type": "TypeBool", @@ -72157,22 +76884,21 @@ "computed": true }, { - "name": "template_git_url", + "name": "status_code", "type": "TypeString", - "description": "The source URL.", + "description": "The success or error code that was returned for the last plan, apply, or destroy job that ran against your workspace.", "computed": true }, { - "name": "crn", + "name": "workspace_id", "type": "TypeString", - "description": "The workspace CRN.", - "cloud_data_type": "crn", - "computed": true + "description": "The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API.", + "required": true }, { - "name": "last_health_check_at", + "name": "created_by", "type": "TypeString", - "description": "The timestamp when the last health check was performed by Schematics.", + "description": "The user ID that created the workspace.", "computed": true }, { @@ -72188,12 +76914,6 @@ "description": "Init state file.", "computed": true }, - { - "name": "status_code", - "type": "TypeString", - "description": "The success or error code that was returned for the last plan, apply, or destroy job that ran against your workspace.", - "computed": true - }, { "name": "template_type", "type": "TypeString", @@ -72201,223 +76921,113 @@ "computed": true }, { - "name": "template_git_full_url", + "name": "updated_by", "type": "TypeString", - "description": "Full repository URL.", + "description": "The user ID that updated the workspace.", "computed": true - }, + } + ], + "ibm_secrets_manager_secret": [ { - "name": "frozen_at", + "name": "api_key", "type": "TypeString", - "description": "The timestamp when the workspace was frozen.", + "description": "The API key that is generated for this secret.After the secret reaches the end of its lease (see the `ttl` field), the API key is deleted automatically. If you want to continue to use the same API key for future read operations, see the `reuse_api_key` field.", + "secure": true, "computed": true }, { - "name": "locked_by", + "name": "instance_id", "type": "TypeString", - "description": "The user ID that initiated a resource-related job, such as applying or destroying resources, that locked the workspace.", - "computed": true + "description": "Secrets Manager instance GUID", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:secrets-manager" + ] }, { - "name": "resource_controller_url", + "name": "creation_date", "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this workspace", + "description": "The date the secret was created. The date format follows RFC 3339.", "computed": true }, { - "name": "template_env_settings", - "type": "TypeList", - "description": "List of environment values.", - "computed": true, - "elem": { - "hidden": { - "name": "hidden", - "type": "TypeBool", - "description": "If set to `true`, the value of your input variable is protected and not returned in your API response.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "The name of the variable.", - "computed": true - }, - "secure": { - "name": "secure", - "type": "TypeBool", - "description": "If set to `true`, the value of your input variable is protected and not returned in your API response.", - "computed": true - }, - "value": { - "name": "value", - "type": "TypeString", - "description": "Enter the value as a string for the primitive types such as `bool`, `number`, `string`, and `HCL` format for the complex variables, as you provide in a `.tfvars` file. **You need to enter escaped string of `HCL` format for the complex variable value**. For more information, about how to declare variables in a terraform configuration file and provide value to schematics, see [Providing values for the declared variables](/docs/schematics?topic=schematics-create-tf-config#declare-variable).", - "computed": true - } - } - }, - { - "name": "template_uninstall_script_name", - "type": "TypeString", - "description": "Uninstall script name.", + "name": "secret_data", + "type": "TypeMap", + "description": "The secret data object", + "secure": true, "computed": true }, { - "name": "template_values", + "name": "password", "type": "TypeString", - "description": "A list of variable values that you want to apply during the Helm chart installation. The list must be provided in JSON format, such as `\"\"autoscaling: enabled: true minReplicas: 2\"`. The values that you define here override the default Helm chart values. This field is supported only for IBM Cloud catalog offerings that are provisioned by using the Terraform Helm provider.", + "description": "The password to assign to this secret.", + "secure": true, "computed": true }, { - "name": "template_inputs", + "name": "access_groups", "type": "TypeList", - "description": "Information about the input variables that your template uses.", + "description": "The access groups that define the capabilities of the service ID and API key that are generated for an`iam_credentials` secret.**Tip:** To find the ID of an access group, go to **Manage \u003e Access (IAM) \u003e Access groups** in the IBM Cloud console. Select the access group to inspect, and click **Details** to view its ID.", "computed": true, "elem": { - "description": { - "name": "description", - "type": "TypeString", - "description": "The description of your input variable.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "The name of the variable.", - "computed": true - }, - "secure": { - "name": "secure", - "type": "TypeBool", - "description": "If set to `true`, the value of your input variable is protected and not returned in your API response.", - "computed": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "`Terraform v0.11` supports `string`, `list`, `map` data type. For more information, about the syntax, see [Configuring input variables](https://www.terraform.io/docs/configuration-0-11/variables.html).\u003cbr\u003e `Terraform v0.12` additionally, supports `bool`, `number` and complex data types such as `list(type)`, `map(type)`,`object({attribute name=type,..})`, `set(type)`, `tuple([type])`. For more information, about the syntax to use the complex data type, see [Configuring variables](https://www.terraform.io/docs/configuration/variables.html#type-constraints).", - "computed": true - }, - "value": { - "name": "value", - "type": "TypeString", - "description": "Enter the value as a string for the primitive types such as `bool`, `number`, `string`, and `HCL` format for the complex variables, as you provide in a `.tfvars` file. **You need to enter escaped string of `HCL` format for the complex variable value**. For more information, about how to declare variables in a terraform configuration file and provide value to schematics, see [Providing values for the declared variables](https://cloud.ibm.com/docs/schematics?topic=schematics-create-tf-config#declare-variable).", - "computed": true - } + "type": "TypeString" } }, { - "name": "updated_at", + "name": "secret_id", "type": "TypeString", - "description": "The timestamp when the workspace was last updated.", - "computed": true + "description": "The v4 UUID that uniquely identifies the secret.", + "required": true }, { - "name": "updated_by", + "name": "next_rotation_date", "type": "TypeString", - "description": "The user ID that updated the workspace.", + "description": "The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that can be auto-rotated and have an existing rotation policy.", "computed": true }, { - "name": "status_msg", + "name": "name", "type": "TypeString", - "description": "The success or error message that was returned for the last plan, apply, or destroy job that ran against your workspace.", + "description": "A human-readable alias to assign to your secret.To protect your privacy, do not use personal data, such as your name or location, as an alias for your secret.", "computed": true }, { - "name": "applied_shareddata_ids", - "type": "TypeList", - "description": "List of applied shared dataset ID.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "created_at", + "name": "state_description", "type": "TypeString", - "description": "The timestamp when the workspace was created.", + "description": "A text representation of the secret state.", "computed": true }, { - "name": "shared_data", - "type": "TypeList", - "description": "Information about the Target used by the templates originating from IBM Cloud catalog offerings. This information is not relevant when you create a workspace from your own Terraform template.", - "computed": true, - "elem": { - "cluster_id": { - "name": "cluster_id", - "type": "TypeString", - "description": "The ID of the cluster where you want to provision the resources of all IBM Cloud catalog templates that are included in the catalog offering.", - "computed": true - }, - "cluster_name": { - "name": "cluster_name", - "type": "TypeString", - "description": "Target cluster name.", - "computed": true - }, - "entitlement_keys": { - "name": "entitlement_keys", - "type": "TypeList", - "description": "The entitlement key that you want to use to install IBM Cloud entitled software.", - "computed": true, - "elem": { - "type": "TypeMap" - } - }, - "namespace": { - "name": "namespace", - "type": "TypeString", - "description": "The Kubernetes namespace or OpenShift project where the resources of all IBM Cloud catalog templates that are included in the catalog offering are deployed into.", - "computed": true - }, - "region": { - "name": "region", - "type": "TypeString", - "description": "The IBM Cloud region that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.", - "computed": true - }, - "resource_group_id": { - "name": "resource_group_id", - "type": "TypeString", - "description": "The ID of the resource group that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.", - "computed": true - } - } - }, - { - "name": "template_git_branch", + "name": "last_update_date", "type": "TypeString", - "description": "The repository branch.", + "description": "Updates when the actual secret is modified. The date format follows RFC 3339.", "computed": true }, { - "name": "location", + "name": "expiration_date", "type": "TypeString", - "description": "The IBM Cloud location where your workspace was provisioned.", - "cloud_data_type": "region", - "optional": true, + "description": "The date the secret material expires. The date format follows RFC 3339.You can set an expiration date on supported secret types at their creation. If you create a secret without specifying an expiration date, the secret does not expire. The `expiration_date` field is supported for the following secret types:- `arbitrary`- `username_password`.", "computed": true }, { - "name": "template_ref", + "name": "service_id", "type": "TypeString", - "description": "Workspace template ref.", + "description": "The service ID under which the API key (see the `api_key` field) is created. This service ID is added to the access groups that you assign for this secret.", "computed": true }, { - "name": "frozen", - "type": "TypeBool", - "description": "If set to true, the workspace is frozen and changes to the workspace are disabled.", - "computed": true - } - ], - "ibm_secrets_manager_secret": [ + "name": "endpoint_type", + "type": "TypeString", + "description": "Endpoint Type. 'public' or 'private'", + "default_value": "public", + "options": "public, private", + "optional": true + }, { - "name": "name", + "name": "type", "type": "TypeString", - "description": "A human-readable alias to assign to your secret.To protect your privacy, do not use personal data, such as your name or location, as an alias for your secret.", + "description": "The MIME type that represents the secret.", "computed": true }, { @@ -72427,9 +77037,9 @@ "computed": true }, { - "name": "state_description", + "name": "created_by", "type": "TypeString", - "description": "A text representation of the secret state.", + "description": "The unique identifier for the entity that created the secret.", "computed": true }, { @@ -72464,22 +77074,6 @@ } } }, - { - "name": "instance_id", - "type": "TypeString", - "description": "Secrets Manager instance GUID", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:secrets-manager" - ] - }, - { - "name": "secret_id", - "type": "TypeString", - "description": "The v4 UUID that uniquely identifies the secret.", - "required": true - }, { "name": "username", "type": "TypeString", @@ -72488,30 +77082,10 @@ "computed": true }, { - "name": "password", - "type": "TypeString", - "description": "The password to assign to this secret.", - "secure": true, - "computed": true - }, - { - "name": "payload", - "type": "TypeString", - "description": "The new secret data to assign to an `arbitrary` secret.", - "secure": true, - "computed": true - }, - { - "name": "api_key", + "name": "crn", "type": "TypeString", - "description": "The API key that is generated for this secret.After the secret reaches the end of its lease (see the `ttl` field), the API key is deleted automatically. If you want to continue to use the same API key for future read operations, see the `reuse_api_key` field.", - "secure": true, - "computed": true - }, - { - "name": "reuse_api_key", - "type": "TypeBool", - "description": "(IAM credentials) Reuse the service ID and API key for future read operations.", + "description": "The Cloud Resource Name (CRN) that uniquely identifies your Secrets Manager resource.", + "cloud_data_type": "crn", "computed": true }, { @@ -72535,48 +77109,35 @@ } }, { - "name": "description", - "type": "TypeString", - "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret.", - "computed": true - }, - { - "name": "service_id", - "type": "TypeString", - "description": "The service ID under which the API key (see the `api_key` field) is created. This service ID is added to the access groups that you assign for this secret.", + "name": "state", + "type": "TypeInt", + "description": "The secret state based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1, Suspended = 2, Deactivated = 3, and Destroyed = 5 values.", "computed": true }, { - "name": "endpoint_type", - "type": "TypeString", - "description": "Endpoint Type. 'public' or 'private'", - "default_value": "public", - "options": "public, private", - "optional": true - }, - { - "name": "type", + "name": "payload", "type": "TypeString", - "description": "The MIME type that represents the secret.", + "description": "The new secret data to assign to an `arbitrary` secret.", + "secure": true, "computed": true }, { - "name": "crn", - "type": "TypeString", - "description": "The Cloud Resource Name (CRN) that uniquely identifies your Secrets Manager resource.", - "cloud_data_type": "crn", + "name": "reuse_api_key", + "type": "TypeBool", + "description": "(IAM credentials) Reuse the service ID and API key for future read operations.", "computed": true }, { - "name": "created_by", + "name": "secret_type", "type": "TypeString", - "description": "The unique identifier for the entity that created the secret.", - "computed": true + "description": "The secret type. Supported options include: arbitrary, iam_credentials, username_password.", + "required": true, + "options": "arbitrary,iam_credentials,imported_cert,public_cert,private_cert,username_password,kv" }, { - "name": "ttl", + "name": "description", "type": "TypeString", - "description": "The time-to-live (TTL) or lease duration to assign to generated credentials.For `iam_credentials` secrets, the TTL defines for how long each generated API key remains valid. The value can be either an integer that specifies the number of seconds, or the string representation of a duration, such as `120m` or `24h`.", + "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret.", "computed": true }, { @@ -72589,60 +77150,38 @@ } }, { - "name": "state", - "type": "TypeInt", - "description": "The secret state based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1, Suspended = 2, Deactivated = 3, and Destroyed = 5 values.", - "computed": true - }, - { - "name": "creation_date", - "type": "TypeString", - "description": "The date the secret was created. The date format follows RFC 3339.", - "computed": true - }, - { - "name": "last_update_date", + "name": "ttl", "type": "TypeString", - "description": "Updates when the actual secret is modified. The date format follows RFC 3339.", + "description": "The time-to-live (TTL) or lease duration to assign to generated credentials.For `iam_credentials` secrets, the TTL defines for how long each generated API key remains valid. The value can be either an integer that specifies the number of seconds, or the string representation of a duration, such as `120m` or `24h`.", "computed": true - }, - { - "name": "access_groups", - "type": "TypeList", - "description": "The access groups that define the capabilities of the service ID and API key that are generated for an`iam_credentials` secret.**Tip:** To find the ID of an access group, go to **Manage \u003e Access (IAM) \u003e Access groups** in the IBM Cloud console. Select the access group to inspect, and click **Details** to view its ID.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, + } + ], + "ibm_secrets_manager_secrets": [ { - "name": "expiration_date", + "name": "instance_id", "type": "TypeString", - "description": "The date the secret material expires. The date format follows RFC 3339.You can set an expiration date on supported secret types at their creation. If you create a secret without specifying an expiration date, the secret does not expire. The `expiration_date` field is supported for the following secret types:- `arbitrary`- `username_password`.", - "computed": true - }, - { - "name": "secret_data", - "type": "TypeMap", - "description": "The secret data object", - "secure": true, - "computed": true + "description": "Secrets Manager instance GUID", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:secrets-manager" + ] }, { "name": "secret_type", "type": "TypeString", "description": "The secret type. Supported options include: arbitrary, iam_credentials, username_password.", - "required": true, - "options": "arbitrary,iam_credentials,imported_cert,public_cert,private_cert,username_password,kv" + "options": "arbitrary, iam_credentials, username_password", + "optional": true }, { - "name": "next_rotation_date", + "name": "endpoint_type", "type": "TypeString", - "description": "The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that can be auto-rotated and have an existing rotation policy.", - "computed": true - } - ], - "ibm_secrets_manager_secrets": [ + "description": "Endpoint Type. 'public' or 'private'", + "default_value": "public", + "options": "public, private", + "optional": true + }, { "name": "metadata", "type": "TypeList", @@ -72857,31 +77396,6 @@ } } } - }, - { - "name": "instance_id", - "type": "TypeString", - "description": "Secrets Manager instance GUID", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:secrets-manager" - ] - }, - { - "name": "secret_type", - "type": "TypeString", - "description": "The secret type. Supported options include: arbitrary, iam_credentials, username_password.", - "options": "arbitrary, iam_credentials, username_password", - "optional": true - }, - { - "name": "endpoint_type", - "type": "TypeString", - "description": "Endpoint Type. 'public' or 'private'", - "default_value": "public", - "options": "public, private", - "optional": true } ], "ibm_security_group": [ @@ -72955,12 +77469,6 @@ } ], "ibm_service_key": [ - { - "name": "service_instance_name", - "type": "TypeString", - "description": "Service instance name for example, speech_to_text", - "required": true - }, { "name": "space_guid", "type": "TypeString", @@ -72979,73 +77487,33 @@ "type": "TypeString", "description": "The name of the service key", "required": true + }, + { + "name": "service_instance_name", + "type": "TypeString", + "description": "Service instance name for example, speech_to_text", + "required": true } ], "ibm_service_plan": [ { - "name": "service", + "name": "plan", "type": "TypeString", - "description": "Service name for example, cloudantNoSQLDB", + "description": "The plan type ex- shared", "required": true }, { - "name": "plan", + "name": "service", "type": "TypeString", - "description": "The plan type ex- shared", + "description": "Service name for example, cloudantNoSQLDB", "required": true } ], "ibm_sm_arbitrary_secret": [ { - "name": "secret_group_id", - "type": "TypeString", - "description": "A v4 UUID identifier, or `default` secret group.", - "computed": true - }, - { - "name": "state_description", - "type": "TypeString", - "description": "A text representation of the secret state.", - "computed": true - }, - { - "name": "versions_total", - "type": "TypeInt", - "description": "The number of versions of the secret.", - "computed": true - }, - { - "name": "payload", - "type": "TypeString", - "description": "The arbitrary secret's data payload.", - "secure": true, - "computed": true - }, - { - "name": "region", - "type": "TypeString", - "description": "The region of the Secrets Manager instance.", - "cloud_data_type": "region", - "immutable": true, - "optional": true, - "computed": true - }, - { - "name": "description", - "type": "TypeString", - "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", - "computed": true - }, - { - "name": "locks_total", - "type": "TypeInt", - "description": "The number of locks of the secret.", - "computed": true - }, - { - "name": "name", + "name": "expiration_date", "type": "TypeString", - "description": "The human-readable name of your secret.", + "description": "The date a secret is expired. The date format follows RFC 3339.", "computed": true }, { @@ -73055,10 +77523,9 @@ "optional": true }, { - "name": "crn", + "name": "created_at", "type": "TypeString", - "description": "A CRN that uniquely identifies an IBM Cloud resource.", - "cloud_data_type": "crn", + "description": "The date when a resource was created. The date format follows RFC 3339.", "computed": true }, { @@ -73077,19 +77544,11 @@ "computed": true }, { - "name": "expiration_date", + "name": "updated_at", "type": "TypeString", - "description": "The date a secret is expired. The date format follows RFC 3339.", + "description": "The date when a resource was recently modified. The date format follows RFC 3339.", "computed": true }, - { - "name": "instance_id", - "type": "TypeString", - "description": "The ID of the Secrets Manager instance.", - "cloud_data_type": "resource_instance", - "immutable": true, - "required": true - }, { "name": "downloaded", "type": "TypeBool", @@ -73097,51 +77556,25 @@ "computed": true }, { - "name": "labels", - "type": "TypeList", - "description": "Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "state", - "type": "TypeInt", - "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", - "computed": true - }, - { - "name": "updated_at", + "name": "secret_group_id", "type": "TypeString", - "description": "The date when a resource was recently modified. The date format follows RFC 3339.", + "description": "A v4 UUID identifier, or `default` secret group.", "computed": true }, { - "name": "secret_id", - "type": "TypeString", - "description": "The ID of the secret.", - "required": true - }, - { - "name": "created_by", + "name": "payload", "type": "TypeString", - "description": "The unique identifier that is associated with the entity that created the secret.", + "description": "The arbitrary secret's data payload.", + "secure": true, "computed": true }, { - "name": "created_at", + "name": "instance_id", "type": "TypeString", - "description": "The date when a resource was created. The date format follows RFC 3339.", - "computed": true - } - ], - "ibm_sm_arbitrary_secret_metadata": [ - { - "name": "downloaded", - "type": "TypeBool", - "description": "Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", - "computed": true + "description": "The ID of the Secrets Manager instance.", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true }, { "name": "name", @@ -73150,16 +77583,16 @@ "computed": true }, { - "name": "secret_type", - "type": "TypeString", - "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", + "name": "state", + "type": "TypeInt", + "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", "computed": true }, { - "name": "secret_id", - "type": "TypeString", - "description": "The ID of the secret.", - "required": true + "name": "versions_total", + "type": "TypeInt", + "description": "The number of versions of the secret.", + "computed": true }, { "name": "created_by", @@ -73168,30 +77601,43 @@ "computed": true }, { - "name": "created_at", + "name": "crn", "type": "TypeString", - "description": "The date when a resource was created. The date format follows RFC 3339.", + "description": "A CRN that uniquely identifies an IBM Cloud resource.", + "cloud_data_type": "crn", "computed": true }, { - "name": "custom_metadata", - "type": "TypeMap", - "description": "The secret metadata that a user can customize.", + "name": "labels", + "type": "TypeList", + "description": "Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "secret_group_id", + "name": "locks_total", + "type": "TypeInt", + "description": "The number of locks of the secret.", + "computed": true + }, + { + "name": "secret_id", "type": "TypeString", - "description": "A v4 UUID identifier, or `default` secret group.", + "description": "The ID of the secret.", + "required": true + }, + { + "name": "description", + "type": "TypeString", + "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", "computed": true }, { - "name": "expiration_date", + "name": "state_description", "type": "TypeString", - "description": "The date a secret is expired. The date format follows RFC 3339.", + "description": "A text representation of the secret state.", "computed": true }, { @@ -73202,11 +77648,19 @@ "immutable": true, "optional": true, "computed": true + } + ], + "ibm_sm_arbitrary_secret_metadata": [ + { + "name": "name", + "type": "TypeString", + "description": "The human-readable name of your secret.", + "computed": true }, { - "name": "updated_at", + "name": "state_description", "type": "TypeString", - "description": "The date when a resource was recently modified. The date format follows RFC 3339.", + "description": "A text representation of the secret state.", "computed": true }, { @@ -73218,10 +77672,25 @@ "required": true }, { - "name": "endpoint_type", + "name": "region", "type": "TypeString", - "description": "public or private.", - "optional": true + "description": "The region of the Secrets Manager instance.", + "cloud_data_type": "region", + "immutable": true, + "optional": true, + "computed": true + }, + { + "name": "locks_total", + "type": "TypeInt", + "description": "The number of locks of the secret.", + "computed": true + }, + { + "name": "expiration_date", + "type": "TypeString", + "description": "The date a secret is expired. The date format follows RFC 3339.", + "computed": true }, { "name": "crn", @@ -73236,6 +77705,12 @@ "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", "computed": true }, + { + "name": "downloaded", + "type": "TypeBool", + "description": "Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", + "computed": true + }, { "name": "labels", "type": "TypeList", @@ -73246,15 +77721,27 @@ } }, { - "name": "state_description", - "type": "TypeString", - "description": "A text representation of the secret state.", + "name": "versions_total", + "type": "TypeInt", + "description": "The number of versions of the secret.", "computed": true }, { - "name": "locks_total", - "type": "TypeInt", - "description": "The number of locks of the secret.", + "name": "endpoint_type", + "type": "TypeString", + "description": "public or private.", + "optional": true + }, + { + "name": "secret_id", + "type": "TypeString", + "description": "The ID of the secret.", + "required": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "The date when a resource was created. The date format follows RFC 3339.", "computed": true }, { @@ -73264,25 +77751,40 @@ "computed": true }, { - "name": "versions_total", - "type": "TypeInt", - "description": "The number of versions of the secret.", + "name": "updated_at", + "type": "TypeString", + "description": "The date when a resource was recently modified. The date format follows RFC 3339.", "computed": true - } - ], - "ibm_sm_configurations": [ + }, { - "name": "sort", + "name": "created_by", "type": "TypeString", - "description": "Sort a collection of secrets by the specified field in ascending order. To sort in descending order use the `-` character. Available values: id | created_at | updated_at | expiration_date | secret_type | name", - "optional": true + "description": "The unique identifier that is associated with the entity that created the secret.", + "computed": true }, { - "name": "search", + "name": "custom_metadata", + "type": "TypeMap", + "description": "The secret metadata that a user can customize.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "secret_group_id", "type": "TypeString", - "description": "Obtain a collection of secrets that contain the specified string in one or more of the fields: `id`, `name`, `description`,\n `labels`, `secret_type`.", - "optional": true + "description": "A v4 UUID identifier, or `default` secret group.", + "computed": true }, + { + "name": "secret_type", + "type": "TypeString", + "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", + "computed": true + } + ], + "ibm_sm_configurations": [ { "name": "groups", "type": "TypeString", @@ -73427,6 +77929,18 @@ "type": "TypeString", "description": "public or private.", "optional": true + }, + { + "name": "sort", + "type": "TypeString", + "description": "Sort a collection of secrets by the specified field in ascending order. To sort in descending order use the `-` character. Available values: id | created_at | updated_at | expiration_date | secret_type | name", + "optional": true + }, + { + "name": "search", + "type": "TypeString", + "description": "Obtain a collection of secrets that contain the specified string in one or more of the fields: `id`, `name`, `description`,\n `labels`, `secret_type`.", + "optional": true } ], "ibm_sm_en_registration": [ @@ -73474,33 +77988,42 @@ "computed": true }, { - "name": "created_by", + "name": "region", "type": "TypeString", - "description": "The unique identifier that is associated with the entity that created the secret.", + "description": "The region of the Secrets Manager instance.", + "cloud_data_type": "region", + "immutable": true, + "optional": true, "computed": true }, { - "name": "created_at", + "name": "endpoint_type", "type": "TypeString", - "description": "The date when a resource was created. The date format follows RFC 3339.", + "description": "public or private.", + "optional": true + }, + { + "name": "config_type", + "type": "TypeString", + "description": "The configuration type.", "computed": true }, { - "name": "updated_at", + "name": "created_by", "type": "TypeString", - "description": "The date when a resource was recently modified. The date format follows RFC 3339.", + "description": "The unique identifier that is associated with the entity that created the secret.", "computed": true }, { - "name": "endpoint_type", + "name": "created_at", "type": "TypeString", - "description": "public or private.", - "optional": true + "description": "The date when a resource was created. The date format follows RFC 3339.", + "computed": true }, { - "name": "config_type", + "name": "updated_at", "type": "TypeString", - "description": "The configuration type.", + "description": "The date when a resource was recently modified. The date format follows RFC 3339.", "computed": true }, { @@ -73517,55 +78040,64 @@ "cloud_data_type": "resource_instance", "immutable": true, "required": true - }, - { - "name": "region", - "type": "TypeString", - "description": "The region of the Secrets Manager instance.", - "cloud_data_type": "region", - "immutable": true, - "optional": true, - "computed": true } ], "ibm_sm_iam_credentials_secret": [ { - "name": "access_groups", - "type": "TypeList", - "description": "Access Groups that you can use for an `iam_credentials` secret.Up to 10 Access Groups can be used for each secret.", + "name": "secret_id", + "type": "TypeString", + "description": "The ID of the secret.", + "required": true + }, + { + "name": "custom_metadata", + "type": "TypeMap", + "description": "The secret metadata that a user can customize.", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "service_id", + "name": "description", "type": "TypeString", - "description": "The service ID under which the API key (see the `api_key` field) is created.If you omit this parameter, Secrets Manager generates a new service ID for your secret at its creation and adds it to the access groups that you assign.Optionally, you can use this field to provide your own service ID if you prefer to manage its access directly or retain the service ID after your secret expires, is rotated, or deleted. If you provide a service ID, do not include the `access_groups` parameter.", + "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", "computed": true }, { - "name": "secret_type", - "type": "TypeString", - "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", + "name": "locks_total", + "type": "TypeInt", + "description": "The number of locks of the secret.", "computed": true }, { - "name": "ttl", + "name": "state", + "type": "TypeInt", + "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", + "computed": true + }, + { + "name": "name", "type": "TypeString", - "description": "The time-to-live (TTL) or lease duration to assign to generated credentials.For `iam_credentials` secrets, the TTL defines for how long each generated API key remains valid. The value can be either an integer that specifies the number of seconds, or the string representation of a duration, such as `120m` or `24h`.Minimum duration is 1 minute. Maximum is 90 days.", + "description": "The human-readable name of your secret.", "computed": true }, { - "name": "service_id_is_static", + "name": "versions_total", + "type": "TypeInt", + "description": "The number of versions of the secret.", + "computed": true + }, + { + "name": "reuse_api_key", "type": "TypeBool", - "description": "Indicates whether an `iam_credentials` secret was created with a static service ID.If it is set to `true`, the service ID for the secret was provided by the user at secret creation. If it is set to `false`, the service ID was generated by Secrets Manager.", + "description": "Determines whether to use the same service ID and API key for future read operations on an`iam_credentials` secret. The value is always `true` for IAM credentials secrets managed by Terraform.", "computed": true }, { - "name": "description", + "name": "created_at", "type": "TypeString", - "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", + "description": "The date when a resource was created. The date format follows RFC 3339.", "computed": true }, { @@ -73578,81 +78110,48 @@ } }, { - "name": "region", + "name": "api_key_id", "type": "TypeString", - "description": "The region of the Secrets Manager instance.", - "cloud_data_type": "region", - "immutable": true, - "optional": true, + "description": "The ID of the API key that is generated for this secret.", "computed": true }, { - "name": "created_by", - "type": "TypeString", - "description": "The unique identifier that is associated with the entity that created the secret.", + "name": "service_id_is_static", + "type": "TypeBool", + "description": "Indicates whether an `iam_credentials` secret was created with a static service ID.If it is set to `true`, the service ID for the secret was provided by the user at secret creation. If it is set to `false`, the service ID was generated by Secrets Manager.", "computed": true }, { - "name": "created_at", + "name": "region", "type": "TypeString", - "description": "The date when a resource was created. The date format follows RFC 3339.", - "computed": true - }, - { - "name": "locks_total", - "type": "TypeInt", - "description": "The number of locks of the secret.", + "description": "The region of the Secrets Manager instance.", + "cloud_data_type": "region", + "immutable": true, + "optional": true, "computed": true }, { - "name": "updated_at", + "name": "created_by", "type": "TypeString", - "description": "The date when a resource was recently modified. The date format follows RFC 3339.", + "description": "The unique identifier that is associated with the entity that created the secret.", "computed": true }, { - "name": "secret_id", - "type": "TypeString", - "description": "The ID of the secret.", - "required": true - }, - { - "name": "crn", - "type": "TypeString", - "description": "A CRN that uniquely identifies an IBM Cloud resource.", - "cloud_data_type": "crn", + "name": "downloaded", + "type": "TypeBool", + "description": "Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", "computed": true }, { - "name": "next_rotation_date", + "name": "secret_type", "type": "TypeString", - "description": "The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.", + "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", "computed": true }, { - "name": "instance_id", - "type": "TypeString", - "description": "The ID of the Secrets Manager instance.", - "cloud_data_type": "resource_instance", - "immutable": true, - "required": true - }, - { - "name": "endpoint_type", + "name": "state_description", "type": "TypeString", - "description": "public or private.", - "optional": true - }, - { - "name": "versions_total", - "type": "TypeInt", - "description": "The number of versions of the secret.", - "computed": true - }, - { - "name": "reuse_api_key", - "type": "TypeBool", - "description": "Determines whether to use the same service ID and API key for future read operations on an`iam_credentials` secret. The value is always `true` for IAM credentials secrets managed by Terraform.", + "description": "A text representation of the secret state.", "computed": true }, { @@ -73688,48 +78187,63 @@ } }, { - "name": "secret_group_id", + "name": "instance_id", "type": "TypeString", - "description": "A v4 UUID identifier, or `default` secret group.", + "description": "The ID of the Secrets Manager instance.", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true + }, + { + "name": "crn", + "type": "TypeString", + "description": "A CRN that uniquely identifies an IBM Cloud resource.", + "cloud_data_type": "crn", "computed": true }, { - "name": "api_key_id", + "name": "ttl", "type": "TypeString", - "description": "The ID of the API key that is generated for this secret.", + "description": "The time-to-live (TTL) or lease duration to assign to generated credentials.For `iam_credentials` secrets, the TTL defines for how long each generated API key remains valid. The value can be either an integer that specifies the number of seconds, or the string representation of a duration, such as `120m` or `24h`.Minimum duration is 1 minute. Maximum is 90 days.", "computed": true }, { - "name": "custom_metadata", - "type": "TypeMap", - "description": "The secret metadata that a user can customize.", + "name": "access_groups", + "type": "TypeList", + "description": "Access Groups that you can use for an `iam_credentials` secret.Up to 10 Access Groups can be used for each secret.", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "state_description", + "name": "endpoint_type", "type": "TypeString", - "description": "A text representation of the secret state.", + "description": "public or private.", + "optional": true + }, + { + "name": "secret_group_id", + "type": "TypeString", + "description": "A v4 UUID identifier, or `default` secret group.", "computed": true }, { - "name": "downloaded", - "type": "TypeBool", - "description": "Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", + "name": "updated_at", + "type": "TypeString", + "description": "The date when a resource was recently modified. The date format follows RFC 3339.", "computed": true }, { - "name": "name", + "name": "service_id", "type": "TypeString", - "description": "The human-readable name of your secret.", + "description": "The service ID under which the API key (see the `api_key` field) is created.If you omit this parameter, Secrets Manager generates a new service ID for your secret at its creation and adds it to the access groups that you assign.Optionally, you can use this field to provide your own service ID if you prefer to manage its access directly or retain the service ID after your secret expires, is rotated, or deleted. If you provide a service ID, do not include the `access_groups` parameter.", "computed": true }, { - "name": "state", - "type": "TypeInt", - "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", + "name": "next_rotation_date", + "type": "TypeString", + "description": "The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.", "computed": true }, { @@ -73741,6 +78255,24 @@ } ], "ibm_sm_iam_credentials_secret_metadata": [ + { + "name": "locks_total", + "type": "TypeInt", + "description": "The number of locks of the secret.", + "computed": true + }, + { + "name": "state_description", + "type": "TypeString", + "description": "A text representation of the secret state.", + "computed": true + }, + { + "name": "service_id", + "type": "TypeString", + "description": "The service ID under which the API key (see the `api_key` field) is created.If you omit this parameter, Secrets Manager generates a new service ID for your secret at its creation and adds it to the access groups that you assign.Optionally, you can use this field to provide your own service ID if you prefer to manage its access directly or retain the service ID after your secret expires, is rotated, or deleted. If you provide a service ID, do not include the `access_groups` parameter.", + "computed": true + }, { "name": "service_id_is_static", "type": "TypeBool", @@ -73748,18 +78280,15 @@ "computed": true }, { - "name": "labels", - "type": "TypeList", - "description": "Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "next_rotation_date", + "type": "TypeString", + "description": "The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.", + "computed": true }, { - "name": "state_description", - "type": "TypeString", - "description": "A text representation of the secret state.", + "name": "state", + "type": "TypeInt", + "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", "computed": true }, { @@ -73769,17 +78298,14 @@ "computed": true }, { - "name": "service_id", + "name": "region", "type": "TypeString", - "description": "The service ID under which the API key (see the `api_key` field) is created.If you omit this parameter, Secrets Manager generates a new service ID for your secret at its creation and adds it to the access groups that you assign.Optionally, you can use this field to provide your own service ID if you prefer to manage its access directly or retain the service ID after your secret expires, is rotated, or deleted. If you provide a service ID, do not include the `access_groups` parameter.", + "description": "The region of the Secrets Manager instance.", + "cloud_data_type": "region", + "immutable": true, + "optional": true, "computed": true }, - { - "name": "endpoint_type", - "type": "TypeString", - "description": "public or private.", - "optional": true - }, { "name": "custom_metadata", "type": "TypeMap", @@ -73790,15 +78316,34 @@ } }, { - "name": "api_key_id", + "name": "endpoint_type", "type": "TypeString", - "description": "The ID of the API key that is generated for this secret.", + "description": "public or private.", + "optional": true + }, + { + "name": "crn", + "type": "TypeString", + "description": "A CRN that uniquely identifies an IBM Cloud resource.", + "cloud_data_type": "crn", "computed": true }, { - "name": "name", + "name": "downloaded", + "type": "TypeBool", + "description": "Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", + "computed": true + }, + { + "name": "secret_type", "type": "TypeString", - "description": "The human-readable name of your secret.", + "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", + "computed": true + }, + { + "name": "api_key_id", + "type": "TypeString", + "description": "The ID of the API key that is generated for this secret.", "computed": true }, { @@ -73833,48 +78378,18 @@ } } }, - { - "name": "next_rotation_date", - "type": "TypeString", - "description": "The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.", - "computed": true - }, - { - "name": "ttl", - "type": "TypeString", - "description": "The time-to-live (TTL) or lease duration to assign to generated credentials.For `iam_credentials` secrets, the TTL defines for how long each generated API key remains valid. The value can be either an integer that specifies the number of seconds, or the string representation of a duration, such as `120m` or `24h`.Minimum duration is 1 minute. Maximum is 90 days.", - "computed": true - }, { "name": "secret_id", "type": "TypeString", "description": "The ID of the secret.", "required": true }, - { - "name": "created_at", - "type": "TypeString", - "description": "The date when a resource was created. The date format follows RFC 3339.", - "computed": true - }, { "name": "description", "type": "TypeString", "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", "computed": true }, - { - "name": "downloaded", - "type": "TypeBool", - "description": "Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", - "computed": true - }, - { - "name": "locks_total", - "type": "TypeInt", - "description": "The number of locks of the secret.", - "computed": true - }, { "name": "secret_group_id", "type": "TypeString", @@ -73882,9 +78397,9 @@ "computed": true }, { - "name": "secret_type", - "type": "TypeString", - "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", + "name": "reuse_api_key", + "type": "TypeBool", + "description": "Determines whether to use the same service ID and API key for future read operations on an`iam_credentials` secret. The value is always `true` for IAM credentials secrets managed by Terraform.", "computed": true }, { @@ -73893,24 +78408,6 @@ "description": "The number of versions of the secret.", "computed": true }, - { - "name": "access_groups", - "type": "TypeList", - "description": "Access Groups that you can use for an `iam_credentials` secret.Up to 10 Access Groups can be used for each secret.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "region", - "type": "TypeString", - "description": "The region of the Secrets Manager instance.", - "cloud_data_type": "region", - "immutable": true, - "optional": true, - "computed": true - }, { "name": "created_by", "type": "TypeString", @@ -73918,22 +78415,9 @@ "computed": true }, { - "name": "crn", + "name": "created_at", "type": "TypeString", - "description": "A CRN that uniquely identifies an IBM Cloud resource.", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "state", - "type": "TypeInt", - "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", - "computed": true - }, - { - "name": "reuse_api_key", - "type": "TypeBool", - "description": "Determines whether to use the same service ID and API key for future read operations on an`iam_credentials` secret. The value is always `true` for IAM credentials secrets managed by Terraform.", + "description": "The date when a resource was created. The date format follows RFC 3339.", "computed": true }, { @@ -73943,32 +78427,39 @@ "cloud_data_type": "resource_instance", "immutable": true, "required": true - } - ], - "ibm_sm_imported_certificate": [ + }, { - "name": "private_key", + "name": "labels", + "type": "TypeList", + "description": "Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "name", "type": "TypeString", - "description": "(Optional) The PEM-encoded private key to associate with the certificate.", - "secure": true, + "description": "The human-readable name of your secret.", "computed": true }, { - "name": "crn", + "name": "ttl", "type": "TypeString", - "description": "A CRN that uniquely identifies an IBM Cloud resource.", - "cloud_data_type": "crn", + "description": "The time-to-live (TTL) or lease duration to assign to generated credentials.For `iam_credentials` secrets, the TTL defines for how long each generated API key remains valid. The value can be either an integer that specifies the number of seconds, or the string representation of a duration, such as `120m` or `24h`.Minimum duration is 1 minute. Maximum is 90 days.", "computed": true }, { - "name": "custom_metadata", - "type": "TypeMap", - "description": "The secret metadata that a user can customize.", + "name": "access_groups", + "type": "TypeList", + "description": "Access Groups that you can use for an `iam_credentials` secret.Up to 10 Access Groups can be used for each secret.", "computed": true, "elem": { "type": "TypeString" } - }, + } + ], + "ibm_sm_imported_certificate": [ { "name": "secret_group_id", "type": "TypeString", @@ -73976,27 +78467,16 @@ "computed": true }, { - "name": "expiration_date", + "name": "state_description", "type": "TypeString", - "description": "The date a secret is expired. The date format follows RFC 3339.", - "computed": true - }, - { - "name": "intermediate_included", - "type": "TypeBool", - "description": "Indicates whether the certificate was imported with an associated intermediate certificate.", + "description": "A text representation of the secret state.", "computed": true }, { - "name": "endpoint_type", - "type": "TypeString", - "description": "public or private.", - "optional": true - }, - { - "name": "description", + "name": "crn", "type": "TypeString", - "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", + "description": "A CRN that uniquely identifies an IBM Cloud resource.", + "cloud_data_type": "crn", "computed": true }, { @@ -74006,50 +78486,49 @@ "computed": true }, { - "name": "versions_total", - "type": "TypeInt", - "description": "The number of versions of the secret.", + "name": "secret_type", + "type": "TypeString", + "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", "computed": true }, { - "name": "issuer", + "name": "endpoint_type", "type": "TypeString", - "description": "The distinguished name that identifies the entity that signed and issued the certificate.", - "computed": true + "description": "public or private.", + "optional": true }, { - "name": "state_description", + "name": "created_at", "type": "TypeString", - "description": "A text representation of the secret state.", + "description": "The date when a resource was created. The date format follows RFC 3339.", "computed": true }, { - "name": "updated_at", + "name": "expiration_date", "type": "TypeString", - "description": "The date when a resource was recently modified. The date format follows RFC 3339.", + "description": "The date a secret is expired. The date format follows RFC 3339.", "computed": true }, { - "name": "region", + "name": "issuer", "type": "TypeString", - "description": "The region of the Secrets Manager instance.", - "cloud_data_type": "region", - "immutable": true, - "optional": true, + "description": "The distinguished name that identifies the entity that signed and issued the certificate.", "computed": true }, { - "name": "state", - "type": "TypeInt", - "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", + "name": "key_algorithm", + "type": "TypeString", + "description": "The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.", "computed": true }, { - "name": "certificate", - "type": "TypeString", - "description": "The PEM-encoded contents of your certificate.", - "secure": true, - "computed": true + "name": "alt_names", + "type": "TypeList", + "description": "With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.", + "computed": true, + "elem": { + "type": "TypeString" + } }, { "name": "instance_id", @@ -74060,11 +78539,29 @@ "required": true }, { - "name": "created_at", + "name": "region", "type": "TypeString", - "description": "The date when a resource was created. The date format follows RFC 3339.", + "description": "The region of the Secrets Manager instance.", + "cloud_data_type": "region", + "immutable": true, + "optional": true, "computed": true }, + { + "name": "secret_id", + "type": "TypeString", + "description": "The ID of the secret.", + "required": true + }, + { + "name": "custom_metadata", + "type": "TypeMap", + "description": "The secret metadata that a user can customize.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, { "name": "downloaded", "type": "TypeBool", @@ -74072,27 +78569,28 @@ "computed": true }, { - "name": "signing_algorithm", - "type": "TypeString", - "description": "The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.", + "name": "versions_total", + "type": "TypeInt", + "description": "The number of versions of the secret.", "computed": true }, { - "name": "secret_id", + "name": "common_name", "type": "TypeString", - "description": "The ID of the secret.", - "required": true + "description": "The Common Name (AKA CN) represents the server name protected by the SSL certificate.", + "computed": true }, { - "name": "locks_total", - "type": "TypeInt", - "description": "The number of locks of the secret.", + "name": "intermediate_included", + "type": "TypeBool", + "description": "Indicates whether the certificate was imported with an associated intermediate certificate.", "computed": true }, { - "name": "common_name", + "name": "private_key", "type": "TypeString", - "description": "The Common Name (AKA CN) represents the server name protected by the SSL certificate.", + "description": "(Optional) The PEM-encoded private key to associate with the certificate.", + "secure": true, "computed": true }, { @@ -74115,6 +78613,18 @@ } } }, + { + "name": "created_by", + "type": "TypeString", + "description": "The unique identifier that is associated with the entity that created the secret.", + "computed": true + }, + { + "name": "description", + "type": "TypeString", + "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", + "computed": true + }, { "name": "labels", "type": "TypeList", @@ -74125,15 +78635,34 @@ } }, { - "name": "secret_type", + "name": "signing_algorithm", "type": "TypeString", - "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", + "description": "The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.", "computed": true }, { - "name": "key_algorithm", + "name": "locks_total", + "type": "TypeInt", + "description": "The number of locks of the secret.", + "computed": true + }, + { + "name": "updated_at", "type": "TypeString", - "description": "The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.", + "description": "The date when a resource was recently modified. The date format follows RFC 3339.", + "computed": true + }, + { + "name": "intermediate", + "type": "TypeString", + "description": "(Optional) The PEM-encoded intermediate certificate to associate with the root certificate.", + "secure": true, + "computed": true + }, + { + "name": "state", + "type": "TypeInt", + "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", "computed": true }, { @@ -74149,72 +78678,48 @@ "computed": true }, { - "name": "intermediate", + "name": "certificate", "type": "TypeString", - "description": "(Optional) The PEM-encoded intermediate certificate to associate with the root certificate.", + "description": "The PEM-encoded contents of your certificate.", "secure": true, "computed": true - }, - { - "name": "created_by", - "type": "TypeString", - "description": "The unique identifier that is associated with the entity that created the secret.", - "computed": true - }, - { - "name": "alt_names", - "type": "TypeList", - "description": "With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.", - "computed": true, - "elem": { - "type": "TypeString" - } } ], "ibm_sm_imported_certificate_metadata": [ { - "name": "labels", - "type": "TypeList", - "description": "Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "expiration_date", + "name": "created_at", "type": "TypeString", - "description": "The date a secret is expired. The date format follows RFC 3339.", + "description": "The date when a resource was created. The date format follows RFC 3339.", "computed": true }, { - "name": "secret_id", - "type": "TypeString", - "description": "The ID of the secret.", - "required": true + "name": "downloaded", + "type": "TypeBool", + "description": "Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", + "computed": true }, { - "name": "serial_number", + "name": "expiration_date", "type": "TypeString", - "description": "The unique serial number that was assigned to a certificate by the issuing certificate authority.", + "description": "The date a secret is expired. The date format follows RFC 3339.", "computed": true }, { - "name": "locks_total", - "type": "TypeInt", - "description": "The number of locks of the secret.", + "name": "issuer", + "type": "TypeString", + "description": "The distinguished name that identifies the entity that signed and issued the certificate.", "computed": true }, { - "name": "secret_type", + "name": "state_description", "type": "TypeString", - "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", + "description": "A text representation of the secret state.", "computed": true }, { - "name": "private_key_included", - "type": "TypeBool", - "description": "Indicates whether the certificate was imported with an associated private key.", + "name": "key_algorithm", + "type": "TypeString", + "description": "The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.", "computed": true }, { @@ -74238,47 +78743,73 @@ } }, { - "name": "crn", + "name": "created_by", "type": "TypeString", - "description": "A CRN that uniquely identifies an IBM Cloud resource.", - "cloud_data_type": "crn", + "description": "The unique identifier that is associated with the entity that created the secret.", "computed": true }, { - "name": "description", + "name": "crn", "type": "TypeString", - "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", + "description": "A CRN that uniquely identifies an IBM Cloud resource.", + "cloud_data_type": "crn", "computed": true }, { - "name": "created_by", + "name": "secret_group_id", "type": "TypeString", - "description": "The unique identifier that is associated with the entity that created the secret.", + "description": "A v4 UUID identifier, or `default` secret group.", "computed": true }, { - "name": "versions_total", + "name": "state", "type": "TypeInt", - "description": "The number of versions of the secret.", + "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", "computed": true }, { - "name": "state", + "name": "custom_metadata", + "type": "TypeMap", + "description": "The secret metadata that a user can customize.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "locks_total", "type": "TypeInt", - "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", + "description": "The number of locks of the secret.", "computed": true }, { - "name": "updated_at", + "name": "name", "type": "TypeString", - "description": "The date when a resource was recently modified. The date format follows RFC 3339.", + "description": "The human-readable name of your secret.", "computed": true }, { - "name": "signing_algorithm", + "name": "labels", + "type": "TypeList", + "description": "Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "secret_id", "type": "TypeString", - "description": "The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.", - "computed": true + "description": "The ID of the secret.", + "required": true + }, + { + "name": "instance_id", + "type": "TypeString", + "description": "The ID of the Secrets Manager instance.", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true }, { "name": "alt_names", @@ -74296,24 +78827,15 @@ "computed": true }, { - "name": "key_algorithm", - "type": "TypeString", - "description": "The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.", + "name": "private_key_included", + "type": "TypeBool", + "description": "Indicates whether the certificate was imported with an associated private key.", "computed": true }, { - "name": "custom_metadata", - "type": "TypeMap", - "description": "The secret metadata that a user can customize.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "name", + "name": "serial_number", "type": "TypeString", - "description": "The human-readable name of your secret.", + "description": "The unique serial number that was assigned to a certificate by the issuing certificate authority.", "computed": true }, { @@ -74325,6 +78847,24 @@ "optional": true, "computed": true }, + { + "name": "description", + "type": "TypeString", + "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", + "computed": true + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "The date when a resource was recently modified. The date format follows RFC 3339.", + "computed": true + }, + { + "name": "versions_total", + "type": "TypeInt", + "description": "The number of versions of the secret.", + "computed": true + }, { "name": "endpoint_type", "type": "TypeString", @@ -74332,51 +78872,50 @@ "optional": true }, { - "name": "common_name", + "name": "secret_type", "type": "TypeString", - "description": "The Common Name (AKA CN) represents the server name protected by the SSL certificate.", + "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", "computed": true }, { - "name": "issuer", + "name": "signing_algorithm", "type": "TypeString", - "description": "The distinguished name that identifies the entity that signed and issued the certificate.", + "description": "The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.", "computed": true }, { - "name": "secret_group_id", + "name": "common_name", "type": "TypeString", - "description": "A v4 UUID identifier, or `default` secret group.", + "description": "The Common Name (AKA CN) represents the server name protected by the SSL certificate.", "computed": true - }, + } + ], + "ibm_sm_kv_secret": [ { - "name": "state_description", + "name": "name", "type": "TypeString", - "description": "A text representation of the secret state.", + "description": "The human-readable name of your secret.", "computed": true }, { - "name": "instance_id", - "type": "TypeString", - "description": "The ID of the Secrets Manager instance.", - "cloud_data_type": "resource_instance", - "immutable": true, - "required": true + "name": "state", + "type": "TypeInt", + "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", + "computed": true }, { - "name": "created_at", + "name": "state_description", "type": "TypeString", - "description": "The date when a resource was created. The date format follows RFC 3339.", + "description": "A text representation of the secret state.", "computed": true }, { - "name": "downloaded", - "type": "TypeBool", - "description": "Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", + "name": "crn", + "type": "TypeString", + "description": "A CRN that uniquely identifies an IBM Cloud resource.", + "cloud_data_type": "crn", "computed": true - } - ], - "ibm_sm_kv_secret": [ + }, { "name": "downloaded", "type": "TypeBool", @@ -74384,21 +78923,30 @@ "computed": true }, { - "name": "name", + "name": "labels", + "type": "TypeList", + "description": "Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "created_by", "type": "TypeString", - "description": "The human-readable name of your secret.", + "description": "The unique identifier that is associated with the entity that created the secret.", "computed": true }, { - "name": "secret_group_id", + "name": "created_at", "type": "TypeString", - "description": "A v4 UUID identifier, or `default` secret group.", + "description": "The date when a resource was created. The date format follows RFC 3339.", "computed": true }, { - "name": "state_description", + "name": "secret_group_id", "type": "TypeString", - "description": "A text representation of the secret state.", + "description": "A v4 UUID identifier, or `default` secret group.", "computed": true }, { @@ -74421,42 +78969,66 @@ "computed": true }, { - "name": "description", + "name": "secret_id", "type": "TypeString", - "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", + "description": "The ID of the secret.", + "required": true + }, + { + "name": "custom_metadata", + "type": "TypeMap", + "description": "The secret metadata that a user can customize.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "versions_total", + "type": "TypeInt", + "description": "The number of versions of the secret.", "computed": true }, { - "name": "crn", + "name": "updated_at", "type": "TypeString", - "description": "A CRN that uniquely identifies an IBM Cloud resource.", - "cloud_data_type": "crn", + "description": "The date when a resource was recently modified. The date format follows RFC 3339.", "computed": true }, { - "name": "locks_total", - "type": "TypeInt", - "description": "The number of locks of the secret.", - "computed": true + "name": "instance_id", + "type": "TypeString", + "description": "The ID of the Secrets Manager instance.", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true }, { - "name": "secret_type", + "name": "endpoint_type", "type": "TypeString", - "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", + "description": "public or private.", + "optional": true + }, + { + "name": "description", + "type": "TypeString", + "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", "computed": true }, { - "name": "state", + "name": "locks_total", "type": "TypeInt", - "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", + "description": "The number of locks of the secret.", "computed": true }, { - "name": "secret_id", + "name": "secret_type", "type": "TypeString", - "description": "The ID of the secret.", - "required": true - }, + "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", + "computed": true + } + ], + "ibm_sm_kv_secret_metadata": [ { "name": "labels", "type": "TypeList", @@ -74467,18 +79039,16 @@ } }, { - "name": "updated_at", + "name": "secret_group_id", "type": "TypeString", - "description": "The date when a resource was recently modified. The date format follows RFC 3339.", + "description": "A v4 UUID identifier, or `default` secret group.", "computed": true }, { - "name": "instance_id", - "type": "TypeString", - "description": "The ID of the Secrets Manager instance.", - "cloud_data_type": "resource_instance", - "immutable": true, - "required": true + "name": "versions_total", + "type": "TypeInt", + "description": "The number of versions of the secret.", + "computed": true }, { "name": "endpoint_type", @@ -74486,12 +79056,6 @@ "description": "public or private.", "optional": true }, - { - "name": "created_by", - "type": "TypeString", - "description": "The unique identifier that is associated with the entity that created the secret.", - "computed": true - }, { "name": "custom_metadata", "type": "TypeMap", @@ -74502,33 +79066,29 @@ } }, { - "name": "versions_total", - "type": "TypeInt", - "description": "The number of versions of the secret.", + "name": "secret_type", + "type": "TypeString", + "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", "computed": true }, { - "name": "created_at", + "name": "state_description", "type": "TypeString", - "description": "The date when a resource was created. The date format follows RFC 3339.", + "description": "A text representation of the secret state.", "computed": true - } - ], - "ibm_sm_kv_secret_metadata": [ + }, { - "name": "secret_id", + "name": "crn", "type": "TypeString", - "description": "The ID of the secret.", - "required": true + "description": "A CRN that uniquely identifies an IBM Cloud resource.", + "cloud_data_type": "crn", + "computed": true }, { - "name": "custom_metadata", - "type": "TypeMap", - "description": "The secret metadata that a user can customize.", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "description", + "type": "TypeString", + "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", + "computed": true }, { "name": "locks_total", @@ -74537,23 +79097,21 @@ "computed": true }, { - "name": "state", - "type": "TypeInt", - "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", + "name": "name", + "type": "TypeString", + "description": "The human-readable name of your secret.", "computed": true }, { - "name": "state_description", - "type": "TypeString", - "description": "A text representation of the secret state.", + "name": "state", + "type": "TypeInt", + "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", "computed": true }, { - "name": "instance_id", + "name": "secret_id", "type": "TypeString", - "description": "The ID of the Secrets Manager instance.", - "cloud_data_type": "resource_instance", - "immutable": true, + "description": "The ID of the secret.", "required": true }, { @@ -74568,6 +79126,21 @@ "description": "The date when a resource was created. The date format follows RFC 3339.", "computed": true }, + { + "name": "updated_at", + "type": "TypeString", + "description": "The date when a resource was recently modified. The date format follows RFC 3339.", + "computed": true + }, + { + "name": "region", + "type": "TypeString", + "description": "The region of the Secrets Manager instance.", + "cloud_data_type": "region", + "immutable": true, + "optional": true, + "computed": true + }, { "name": "downloaded", "type": "TypeBool", @@ -74575,52 +79148,87 @@ "computed": true }, { - "name": "name", + "name": "instance_id", "type": "TypeString", - "description": "The human-readable name of your secret.", + "description": "The ID of the Secrets Manager instance.", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true + } + ], + "ibm_sm_private_certificate": [ + { + "name": "downloaded", + "type": "TypeBool", + "description": "Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", "computed": true }, { - "name": "secret_group_id", + "name": "certificate_authority", "type": "TypeString", - "description": "A v4 UUID identifier, or `default` secret group.", + "description": "The intermediate certificate authority that signed this certificate.", "computed": true }, { - "name": "region", + "name": "secret_id", "type": "TypeString", - "description": "The region of the Secrets Manager instance.", - "cloud_data_type": "region", - "immutable": true, - "optional": true, - "computed": true + "description": "The ID of the secret.", + "required": true }, { - "name": "crn", + "name": "created_by", "type": "TypeString", - "description": "A CRN that uniquely identifies an IBM Cloud resource.", - "cloud_data_type": "crn", + "description": "The unique identifier that is associated with the entity that created the secret.", "computed": true }, { - "name": "description", + "name": "issuer", "type": "TypeString", - "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", + "description": "The distinguished name that identifies the entity that signed and issued the certificate.", "computed": true }, { - "name": "labels", + "name": "validity", "type": "TypeList", - "description": "Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.", + "description": "The date and time that the certificate validity period begins and ends.", "computed": true, "elem": { - "type": "TypeString" + "not_after": { + "name": "not_after", + "type": "TypeString", + "description": "The date-time format follows RFC 3339.", + "computed": true + }, + "not_before": { + "name": "not_before", + "type": "TypeString", + "description": "The date-time format follows RFC 3339.", + "computed": true + } } }, { - "name": "versions_total", + "name": "revocation_time_rfc3339", + "type": "TypeString", + "description": "The date and time that the certificate was revoked. The date format follows RFC 3339.", + "computed": true + }, + { + "name": "certificate_template", + "type": "TypeString", + "description": "The name of the certificate template.", + "computed": true + }, + { + "name": "expiration_date", + "type": "TypeString", + "description": "The date a secret is expired. The date format follows RFC 3339.", + "computed": true + }, + { + "name": "locks_total", "type": "TypeInt", - "description": "The number of versions of the secret.", + "description": "The number of locks of the secret.", "computed": true }, { @@ -74630,9 +79238,9 @@ "optional": true }, { - "name": "secret_type", + "name": "secret_group_id", "type": "TypeString", - "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", + "description": "A v4 UUID identifier, or `default` secret group.", "computed": true }, { @@ -74640,18 +79248,30 @@ "type": "TypeString", "description": "The date when a resource was recently modified. The date format follows RFC 3339.", "computed": true - } - ], - "ibm_sm_private_certificate": [ + }, { - "name": "region", + "name": "key_algorithm", "type": "TypeString", - "description": "The region of the Secrets Manager instance.", - "cloud_data_type": "region", - "immutable": true, - "optional": true, + "description": "The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.", "computed": true }, + { + "name": "certificate", + "type": "TypeString", + "description": "The PEM-encoded contents of your certificate.", + "secure": true, + "computed": true + }, + { + "name": "ca_chain", + "type": "TypeList", + "description": "The chain of certificate authorities that are associated with the certificate.", + "secure": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, { "name": "crn", "type": "TypeString", @@ -74660,22 +79280,27 @@ "computed": true }, { - "name": "common_name", + "name": "name", "type": "TypeString", - "description": "The Common Name (AKA CN) represents the server name that is protected by the SSL certificate.", + "description": "The human-readable name of your secret.", "computed": true }, { - "name": "issuing_ca", + "name": "secret_type", "type": "TypeString", - "description": "The PEM-encoded certificate of the certificate authority that signed and issued this certificate.", - "secure": true, + "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", "computed": true }, { - "name": "description", + "name": "state_description", "type": "TypeString", - "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", + "description": "A text representation of the secret state.", + "computed": true + }, + { + "name": "signing_algorithm", + "type": "TypeString", + "description": "The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.", "computed": true }, { @@ -74711,82 +79336,73 @@ } }, { - "name": "ca_chain", - "type": "TypeList", - "description": "The chain of certificate authorities that are associated with the certificate.", + "name": "issuing_ca", + "type": "TypeString", + "description": "The PEM-encoded certificate of the certificate authority that signed and issued this certificate.", "secure": true, + "computed": true + }, + { + "name": "custom_metadata", + "type": "TypeMap", + "description": "The secret metadata that a user can customize.", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "versions_total", - "type": "TypeInt", - "description": "The number of versions of the secret.", - "computed": true - }, - { - "name": "issuer", + "name": "description", "type": "TypeString", - "description": "The distinguished name that identifies the entity that signed and issued the certificate.", + "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", "computed": true }, { - "name": "key_algorithm", + "name": "next_rotation_date", "type": "TypeString", - "description": "The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.", + "description": "The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.", "computed": true }, { - "name": "downloaded", - "type": "TypeBool", - "description": "Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", - "computed": true + "name": "instance_id", + "type": "TypeString", + "description": "The ID of the Secrets Manager instance.", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true }, { - "name": "name", + "name": "created_at", "type": "TypeString", - "description": "The human-readable name of your secret.", + "description": "The date when a resource was created. The date format follows RFC 3339.", "computed": true }, { - "name": "secret_group_id", - "type": "TypeString", - "description": "A v4 UUID identifier, or `default` secret group.", + "name": "state", + "type": "TypeInt", + "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", "computed": true }, { - "name": "validity", + "name": "alt_names", "type": "TypeList", - "description": "The date and time that the certificate validity period begins and ends.", + "description": "With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.", "computed": true, "elem": { - "not_after": { - "name": "not_after", - "type": "TypeString", - "description": "The date-time format follows RFC 3339.", - "computed": true - }, - "not_before": { - "name": "not_before", - "type": "TypeString", - "description": "The date-time format follows RFC 3339.", - "computed": true - } + "type": "TypeString" } }, { - "name": "endpoint_type", + "name": "common_name", "type": "TypeString", - "description": "public or private.", - "optional": true + "description": "The Common Name (AKA CN) represents the server name that is protected by the SSL certificate.", + "computed": true }, { - "name": "secret_id", - "type": "TypeString", - "description": "The ID of the secret.", - "required": true + "name": "revocation_time_seconds", + "type": "TypeInt", + "description": "The timestamp of the certificate revocation.", + "computed": true }, { "name": "labels", @@ -74798,147 +79414,183 @@ } }, { - "name": "locks_total", + "name": "versions_total", "type": "TypeInt", - "description": "The number of locks of the secret.", + "description": "The number of versions of the secret.", "computed": true }, { - "name": "instance_id", + "name": "region", "type": "TypeString", - "description": "The ID of the Secrets Manager instance.", - "cloud_data_type": "resource_instance", + "description": "The region of the Secrets Manager instance.", + "cloud_data_type": "region", "immutable": true, - "required": true + "optional": true, + "computed": true }, { - "name": "created_by", + "name": "serial_number", "type": "TypeString", - "description": "The unique identifier that is associated with the entity that created the secret.", + "description": "The unique serial number that was assigned to a certificate by the issuing certificate authority.", "computed": true }, { - "name": "certificate_template", + "name": "private_key", "type": "TypeString", - "description": "The name of the certificate template.", + "description": "(Optional) The PEM-encoded private key to associate with the certificate.", + "secure": true, "computed": true - }, + } + ], + "ibm_sm_private_certificate_configuration_intermediate_ca": [ { - "name": "revocation_time_seconds", - "type": "TypeInt", - "description": "The timestamp of the certificate revocation.", + "name": "crl_distribution_points_encoded", + "type": "TypeBool", + "description": "Determines whether to encode the certificate revocation list (CRL) distribution points in the certificates that are issued by this certificate authority.", "computed": true }, { - "name": "certificate", + "name": "key_type", "type": "TypeString", - "description": "The PEM-encoded contents of your certificate.", - "secure": true, + "description": "The type of private key to generate.", "computed": true }, { - "name": "private_key", - "type": "TypeString", - "description": "(Optional) The PEM-encoded private key to associate with the certificate.", - "secure": true, + "name": "exclude_cn_from_sans", + "type": "TypeBool", + "description": "Controls whether the common name is excluded from Subject Alternative Names (SANs).If the common name set to `true`, it is not included in DNS or Email SANs if they apply. This field can be useful if the common name is a human-readable identifier, instead of a hostname or an email address.", "computed": true }, { - "name": "created_at", - "type": "TypeString", - "description": "The date when a resource was created. The date format follows RFC 3339.", - "computed": true + "name": "ou", + "type": "TypeList", + "description": "The Organizational Unit (OU) values to define in the subject field of the resulting certificate.", + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "expiration_date", + "name": "country", + "type": "TypeList", + "description": "The Country (C) values to define in the subject field of the resulting certificate.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "config_type", "type": "TypeString", - "description": "The date a secret is expired. The date format follows RFC 3339.", + "description": "Th configuration type.", "computed": true }, { - "name": "serial_number", + "name": "issuer", "type": "TypeString", - "description": "The unique serial number that was assigned to a certificate by the issuing certificate authority.", + "description": "The distinguished name that identifies the entity that signed and issued the certificate.", "computed": true }, { - "name": "updated_at", + "name": "private_key_format", "type": "TypeString", - "description": "The date when a resource was recently modified. The date format follows RFC 3339.", + "description": "The format of the generated private key.", "computed": true }, { - "name": "custom_metadata", - "type": "TypeMap", - "description": "The secret metadata that a user can customize.", + "name": "postal_code", + "type": "TypeList", + "description": "The postal code values to define in the subject field of the resulting certificate.", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "secret_type", + "name": "status", "type": "TypeString", - "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", + "description": "The status of the certificate authority. The status of a root certificate authority is either `configured` or `expired`. For intermediate certificate authorities, possible statuses include `signing_required`,`signed_certificate_required`, `certificate_template_required`, `configured`, `expired` or `revoked`.", "computed": true }, { - "name": "state_description", + "name": "expiration_date", "type": "TypeString", - "description": "A text representation of the secret state.", + "description": "The date a secret is expired. The date format follows RFC 3339.", "computed": true }, { - "name": "certificate_authority", + "name": "common_name", "type": "TypeString", - "description": "The intermediate certificate authority that signed this certificate.", + "description": "The Common Name (AKA CN) represents the server name that is protected by the SSL certificate.", "computed": true }, { - "name": "next_rotation_date", - "type": "TypeString", - "description": "The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.", - "computed": true + "name": "alt_names", + "type": "TypeList", + "description": "With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.", + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "revocation_time_rfc3339", - "type": "TypeString", - "description": "The date and time that the certificate was revoked. The date format follows RFC 3339.", - "computed": true + "name": "street_address", + "type": "TypeList", + "description": "The street address values to define in the subject field of the resulting certificate.", + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "state", + "name": "organization", + "type": "TypeList", + "description": "The Organization (O) values to define in the subject field of the resulting certificate.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "province", + "type": "TypeList", + "description": "The Province (ST) values to define in the subject field of the resulting certificate.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "crl_expiry_seconds", "type": "TypeInt", - "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", + "description": "The time until the certificate revocation list (CRL) expires, in seconds.", "computed": true }, { - "name": "signing_algorithm", + "name": "uri_sans", "type": "TypeString", - "description": "The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.", + "description": "The URI Subject Alternative Names to define for the CA certificate, in a comma-delimited list.", "computed": true }, { - "name": "alt_names", + "name": "locality", "type": "TypeList", - "description": "With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.", + "description": "The Locality (L) values to define in the subject field of the resulting certificate.", "computed": true, "elem": { "type": "TypeString" } - } - ], - "ibm_sm_private_certificate_configuration_intermediate_ca": [ + }, { - "name": "exclude_cn_from_sans", - "type": "TypeBool", - "description": "Controls whether the common name is excluded from Subject Alternative Names (SANs).If the common name set to `true`, it is not included in DNS or Email SANs if they apply. This field can be useful if the common name is a human-readable identifier, instead of a hostname or an email address.", + "name": "ip_sans", + "type": "TypeString", + "description": "The IP Subject Alternative Names to define for the CA certificate, in a comma-delimited list.", "computed": true }, { - "name": "issuing_certificates_urls_encoded", - "type": "TypeBool", - "description": "Determines whether to encode the URL of the issuing certificate in the certificates that are issued by this certificate authority.", + "name": "format", + "type": "TypeString", + "description": "The format of the returned data.", "computed": true }, { @@ -74951,21 +79603,54 @@ } }, { - "name": "format", + "name": "serial_number", "type": "TypeString", - "description": "The format of the returned data.", + "description": "The serial number to assign to the generated certificate. To assign a random serial number, you can omit this field.", "computed": true }, { - "name": "key_type", + "name": "secret_type", "type": "TypeString", - "description": "The type of private key to generate.", + "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", "computed": true }, { - "name": "status", + "name": "issuing_certificates_urls_encoded", + "type": "TypeBool", + "description": "Determines whether to encode the URL of the issuing certificate in the certificates that are issued by this certificate authority.", + "computed": true + }, + { + "name": "key_bits", + "type": "TypeInt", + "description": "The number of bits to use to generate the private key.Allowable values for RSA keys are: `2048` and `4096`. Allowable values for EC keys are: `224`, `256`, `384`, and `521`. The default for RSA keys is `2048`. The default for EC keys is `256`.", + "computed": true + }, + { + "name": "region", "type": "TypeString", - "description": "The status of the certificate authority. The status of a root certificate authority is either `configured` or `expired`. For intermediate certificate authorities, possible statuses include `signing_required`,`signed_certificate_required`, `certificate_template_required`, `configured`, `expired` or `revoked`.", + "description": "The region of the Secrets Manager instance.", + "cloud_data_type": "region", + "immutable": true, + "optional": true, + "computed": true + }, + { + "name": "endpoint_type", + "type": "TypeString", + "description": "public or private.", + "optional": true + }, + { + "name": "name", + "type": "TypeString", + "description": "The name of the configuration.", + "required": true + }, + { + "name": "signing_method", + "type": "TypeString", + "description": "The signing method to use with this certificate authority to generate private certificates.You can choose between internal or externally signed options. For more information, see the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-intermediate-certificate-authorities).", "computed": true }, { @@ -75026,63 +79711,37 @@ } }, { - "name": "endpoint_type", - "type": "TypeString", - "description": "public or private.", - "optional": true - }, - { - "name": "name", + "name": "instance_id", "type": "TypeString", - "description": "The name of the configuration.", + "description": "The ID of the Secrets Manager instance.", + "cloud_data_type": "resource_instance", + "immutable": true, "required": true }, { - "name": "signing_method", - "type": "TypeString", - "description": "The signing method to use with this certificate authority to generate private certificates.You can choose between internal or externally signed options. For more information, see the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-intermediate-certificate-authorities).", - "computed": true - }, - { - "name": "crl_expiry_seconds", + "name": "max_ttl_seconds", "type": "TypeInt", - "description": "The time until the certificate revocation list (CRL) expires, in seconds.", - "computed": true - }, - { - "name": "common_name", - "type": "TypeString", - "description": "The Common Name (AKA CN) represents the server name that is protected by the SSL certificate.", + "description": "The maximum time-to-live (TTL) for certificates that are created by this CA in seconds.", "computed": true }, - { - "name": "organization", - "type": "TypeList", - "description": "The Organization (O) values to define in the subject field of the resulting certificate.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, { "name": "crl_disable", "type": "TypeBool", "description": "Disables or enables certificate revocation list (CRL) building.If CRL building is disabled, a signed but zero-length CRL is returned when downloading the CRL. If CRL building is enabled, it will rebuild the CRL.", "computed": true - }, + } + ], + "ibm_sm_private_certificate_configuration_root_ca": [ { - "name": "locality", - "type": "TypeList", - "description": "The Locality (L) values to define in the subject field of the resulting certificate.", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "created_by", + "type": "TypeString", + "description": "The unique identifier that is associated with the entity that created the secret.", + "computed": true }, { - "name": "serial_number", + "name": "updated_at", "type": "TypeString", - "description": "The serial number to assign to the generated certificate. To assign a random serial number, you can omit this field.", + "description": "The date when a resource was recently modified. The date format follows RFC 3339.", "computed": true }, { @@ -75092,151 +79751,63 @@ "computed": true }, { - "name": "ou", - "type": "TypeList", - "description": "The Organizational Unit (OU) values to define in the subject field of the resulting certificate.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "postal_code", - "type": "TypeList", - "description": "The postal code values to define in the subject field of the resulting certificate.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "street_address", - "type": "TypeList", - "description": "The street address values to define in the subject field of the resulting certificate.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "instance_id", - "type": "TypeString", - "description": "The ID of the Secrets Manager instance.", - "cloud_data_type": "resource_instance", - "immutable": true, - "required": true - }, - { - "name": "secret_type", + "name": "common_name", "type": "TypeString", - "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", + "description": "The Common Name (AKA CN) represents the server name that is protected by the SSL certificate.", "computed": true }, { - "name": "crl_distribution_points_encoded", - "type": "TypeBool", - "description": "Determines whether to encode the certificate revocation list (CRL) distribution points in the certificates that are issued by this certificate authority.", + "name": "max_path_length", + "type": "TypeInt", + "description": "The maximum path length to encode in the generated certificate. `-1` means no limit.If the signing certificate has a maximum path length set, the path length is set to one less than that of the signing certificate. A limit of `0` means a literal path length of zero.", "computed": true }, { - "name": "alt_names", + "name": "permitted_dns_domains", "type": "TypeList", - "description": "With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.", + "description": "The allowed DNS domains or subdomains for the certificates that are to be signed and issued by this CA certificate.", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "ip_sans", - "type": "TypeString", - "description": "The IP Subject Alternative Names to define for the CA certificate, in a comma-delimited list.", - "computed": true - }, - { - "name": "province", + "name": "street_address", "type": "TypeList", - "description": "The Province (ST) values to define in the subject field of the resulting certificate.", + "description": "The street address values to define in the subject field of the resulting certificate.", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "config_type", - "type": "TypeString", - "description": "Th configuration type.", - "computed": true - }, - { - "name": "issuer", + "name": "endpoint_type", "type": "TypeString", - "description": "The distinguished name that identifies the entity that signed and issued the certificate.", - "computed": true - }, - { - "name": "key_bits", - "type": "TypeInt", - "description": "The number of bits to use to generate the private key.Allowable values for RSA keys are: `2048` and `4096`. Allowable values for EC keys are: `224`, `256`, `384`, and `521`. The default for RSA keys is `2048`. The default for EC keys is `256`.", - "computed": true + "description": "public or private.", + "optional": true }, { - "name": "expiration_date", + "name": "name", "type": "TypeString", - "description": "The date a secret is expired. The date format follows RFC 3339.", - "computed": true + "description": "The name of the configuration.", + "required": true }, { - "name": "uri_sans", + "name": "secret_type", "type": "TypeString", - "description": "The URI Subject Alternative Names to define for the CA certificate, in a comma-delimited list.", + "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", "computed": true }, { - "name": "private_key_format", - "type": "TypeString", - "description": "The format of the generated private key.", + "name": "issuing_certificates_urls_encoded", + "type": "TypeBool", + "description": "Determines whether to encode the URL of the issuing certificate in the certificates that are issued by this certificate authority.", "computed": true }, { - "name": "country", - "type": "TypeList", - "description": "The Country (C) values to define in the subject field of the resulting certificate.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "region", + "name": "format", "type": "TypeString", - "description": "The region of the Secrets Manager instance.", - "cloud_data_type": "region", - "immutable": true, - "optional": true, - "computed": true - } - ], - "ibm_sm_private_certificate_configuration_root_ca": [ - { - "name": "postal_code", - "type": "TypeList", - "description": "The postal code values to define in the subject field of the resulting certificate.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "max_ttl_seconds", - "type": "TypeInt", - "description": "The maximum time-to-live (TTL) for certificates that are created by this CA in seconds.", - "computed": true - }, - { - "name": "ttl_seconds", - "type": "TypeInt", - "description": "The requested time-to-live (TTL) for certificates that are created by this CA. This field's value cannot be longer than the `max_ttl` limit.The value can be supplied as a string representation of a duration in hours, for example '8760h'. In the API response, this value is returned in seconds (integer).", + "description": "The format of the returned data.", "computed": true }, { @@ -75254,18 +79825,6 @@ "type": "TypeString" } }, - { - "name": "crl_disable", - "type": "TypeBool", - "description": "Disables or enables certificate revocation list (CRL) building.If CRL building is disabled, a signed but zero-length CRL is returned when downloading the CRL. If CRL building is enabled, it will rebuild the CRL.", - "computed": true - }, - { - "name": "issuing_certificates_urls_encoded", - "type": "TypeBool", - "description": "Determines whether to encode the URL of the issuing certificate in the certificates that are issued by this certificate authority.", - "computed": true - }, { "name": "alt_names", "type": "TypeList", @@ -75276,86 +79835,35 @@ } }, { - "name": "street_address", - "type": "TypeList", - "description": "The street address values to define in the subject field of the resulting certificate.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "config_type", - "type": "TypeString", - "description": "The configuration type.", - "computed": true - }, - { - "name": "secret_type", - "type": "TypeString", - "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", - "computed": true - }, - { - "name": "created_by", - "type": "TypeString", - "description": "The unique identifier that is associated with the entity that created the secret.", - "computed": true - }, - { - "name": "created_at", - "type": "TypeString", - "description": "The date when a resource was created. The date format follows RFC 3339.", - "computed": true - }, - { - "name": "expiration_date", - "type": "TypeString", - "description": "The date a secret is expired. The date format follows RFC 3339.", - "computed": true - }, - { - "name": "endpoint_type", - "type": "TypeString", - "description": "public or private.", - "optional": true - }, - { - "name": "updated_at", + "name": "uri_sans", "type": "TypeString", - "description": "The date when a resource was recently modified. The date format follows RFC 3339.", + "description": "The URI Subject Alternative Names to define for the CA certificate, in a comma-delimited list.", "computed": true }, { - "name": "ou", + "name": "postal_code", "type": "TypeList", - "description": "The Organizational Unit (OU) values to define in the subject field of the resulting certificate.", + "description": "The postal code values to define in the subject field of the resulting certificate.", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "status", + "name": "region", "type": "TypeString", - "description": "The status of the certificate authority. The status of a root certificate authority is either `configured` or `expired`. For intermediate certificate authorities, possible statuses include `signing_required`,`signed_certificate_required`, `certificate_template_required`, `configured`, `expired` or `revoked`.", + "description": "The region of the Secrets Manager instance.", + "cloud_data_type": "region", + "immutable": true, + "optional": true, "computed": true }, { - "name": "common_name", + "name": "private_key_format", "type": "TypeString", - "description": "The Common Name (AKA CN) represents the server name that is protected by the SSL certificate.", + "description": "The format of the generated private key.", "computed": true }, - { - "name": "organization", - "type": "TypeList", - "description": "The Organization (O) values to define in the subject field of the resulting certificate.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, { "name": "country", "type": "TypeList", @@ -75365,6 +79873,12 @@ "type": "TypeString" } }, + { + "name": "status", + "type": "TypeString", + "description": "The status of the certificate authority. The status of a root certificate authority is either `configured` or `expired`. For intermediate certificate authorities, possible statuses include `signing_required`,`signed_certificate_required`, `certificate_template_required`, `configured`, `expired` or `revoked`.", + "computed": true + }, { "name": "data", "type": "TypeList", @@ -75424,30 +79938,33 @@ } }, { - "name": "format", - "type": "TypeString", - "description": "The format of the returned data.", - "computed": true + "name": "other_sans", + "type": "TypeList", + "description": "The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the CA certificate.The alternative names must match the values that are specified in the `allowed_other_sans` field in the associated certificate template. The format is the same as OpenSSL: `\u003coid\u003e:\u003ctype\u003e:\u003cvalue\u003e` where the current valid type is `UTF8`.", + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "private_key_format", - "type": "TypeString", - "description": "The format of the generated private key.", - "computed": true + "name": "province", + "type": "TypeList", + "description": "The Province (ST) values to define in the subject field of the resulting certificate.", + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "key_type", + "name": "serial_number", "type": "TypeString", - "description": "The type of private key to generate.", + "description": "The serial number to assign to the generated certificate. To assign a random serial number, you can omit this field.", "computed": true }, { - "name": "region", + "name": "created_at", "type": "TypeString", - "description": "The region of the Secrets Manager instance.", - "cloud_data_type": "region", - "immutable": true, - "optional": true, + "description": "The date when a resource was created. The date format follows RFC 3339.", "computed": true }, { @@ -75463,75 +79980,72 @@ "computed": true }, { - "name": "uri_sans", + "name": "key_type", "type": "TypeString", - "description": "The URI Subject Alternative Names to define for the CA certificate, in a comma-delimited list.", + "description": "The type of private key to generate.", "computed": true }, { - "name": "other_sans", + "name": "exclude_cn_from_sans", + "type": "TypeBool", + "description": "Controls whether the common name is excluded from Subject Alternative Names (SANs).If the common name set to `true`, it is not included in DNS or Email SANs if they apply. This field can be useful if the common name is a human-readable identifier, instead of a hostname or an email address.", + "computed": true + }, + { + "name": "organization", "type": "TypeList", - "description": "The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the CA certificate.The alternative names must match the values that are specified in the `allowed_other_sans` field in the associated certificate template. The format is the same as OpenSSL: `\u003coid\u003e:\u003ctype\u003e:\u003cvalue\u003e` where the current valid type is `UTF8`.", + "description": "The Organization (O) values to define in the subject field of the resulting certificate.", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "serial_number", + "name": "expiration_date", "type": "TypeString", - "description": "The serial number to assign to the generated certificate. To assign a random serial number, you can omit this field.", + "description": "The date a secret is expired. The date format follows RFC 3339.", "computed": true }, { - "name": "name", + "name": "instance_id", "type": "TypeString", - "description": "The name of the configuration.", + "description": "The ID of the Secrets Manager instance.", + "cloud_data_type": "resource_instance", + "immutable": true, "required": true }, { - "name": "max_path_length", + "name": "crl_expiry_seconds", "type": "TypeInt", - "description": "The maximum path length to encode in the generated certificate. `-1` means no limit.If the signing certificate has a maximum path length set, the path length is set to one less than that of the signing certificate. A limit of `0` means a literal path length of zero.", - "computed": true - }, - { - "name": "exclude_cn_from_sans", - "type": "TypeBool", - "description": "Controls whether the common name is excluded from Subject Alternative Names (SANs).If the common name set to `true`, it is not included in DNS or Email SANs if they apply. This field can be useful if the common name is a human-readable identifier, instead of a hostname or an email address.", + "description": "The time until the certificate revocation list (CRL) expires, in seconds.", "computed": true }, { - "name": "province", + "name": "ou", "type": "TypeList", - "description": "The Province (ST) values to define in the subject field of the resulting certificate.", + "description": "The Organizational Unit (OU) values to define in the subject field of the resulting certificate.", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "crl_expiry_seconds", - "type": "TypeInt", - "description": "The time until the certificate revocation list (CRL) expires, in seconds.", + "name": "config_type", + "type": "TypeString", + "description": "The configuration type.", "computed": true }, { - "name": "permitted_dns_domains", - "type": "TypeList", - "description": "The allowed DNS domains or subdomains for the certificates that are to be signed and issued by this CA certificate.", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "crl_disable", + "type": "TypeBool", + "description": "Disables or enables certificate revocation list (CRL) building.If CRL building is disabled, a signed but zero-length CRL is returned when downloading the CRL. If CRL building is enabled, it will rebuild the CRL.", + "computed": true }, { - "name": "instance_id", - "type": "TypeString", - "description": "The ID of the Secrets Manager instance.", - "cloud_data_type": "resource_instance", - "immutable": true, - "required": true + "name": "ttl_seconds", + "type": "TypeInt", + "description": "The requested time-to-live (TTL) for certificates that are created by this CA. This field's value cannot be longer than the `max_ttl` limit.The value can be supplied as a string representation of a duration in hours, for example '8760h'. In the API response, this value is returned in seconds (integer).", + "computed": true } ], "ibm_sm_private_certificate_configuration_template": [ @@ -75541,6 +80055,15 @@ "description": "Determines whether to allow `localhost` to be included as one of the requested common names.", "computed": true }, + { + "name": "allowed_domains", + "type": "TypeList", + "description": "The domains to define for the certificate template. This property is used along with the `allow_bare_domains` and `allow_subdomains` options.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, { "name": "server_flag", "type": "TypeBool", @@ -75548,39 +80071,18 @@ "computed": true }, { - "name": "ext_key_usage", + "name": "key_usage", "type": "TypeList", - "description": "The allowed extended key usage constraint on private certificates.You can find valid values in the [Go x509 package documentation](https://golang.org/pkg/crypto/x509/#ExtKeyUsage). Omit the `ExtKeyUsage` part of the value. Values are not case-sensitive. To specify no key usage constraints, set this field to an empty list.", + "description": "The allowed key usage constraint to define for private certificates.You can find valid values in the [Go x509 package documentation](https://pkg.go.dev/crypto/x509#KeyUsage). Omit the `KeyUsage` part of the value. Values are not case-sensitive. To specify no key usage constraints, set this field to an empty list.", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "region", - "type": "TypeString", - "description": "The region of the Secrets Manager instance.", - "cloud_data_type": "region", - "immutable": true, - "optional": true, - "computed": true - }, - { - "name": "config_type", - "type": "TypeString", - "description": "Th configuration type.", - "computed": true - }, - { - "name": "use_csr_sans", - "type": "TypeBool", - "description": "When used with the `private_cert_configuration_action_sign_csr` action, this field determines whether to use the Subject Alternative Names(SANs) from a certificate signing request (CSR) instead of the SANs that are included in the data of the certificate.Does not include the common name in the CSR. To use the common name, include the `use_csr_common_name` property.", - "computed": true - }, - { - "name": "organization", + "name": "ext_key_usage_oids", "type": "TypeList", - "description": "The Organization (O) values to define in the subject field of the resulting certificate.", + "description": "A list of extended key usage Object Identifiers (OIDs).", "computed": true, "elem": { "type": "TypeString" @@ -75596,21 +80098,33 @@ } }, { - "name": "serial_number", + "name": "created_at", "type": "TypeString", - "description": "The serial number to assign to the generated certificate. To assign a random serial number, you can omit this field.", + "description": "The date when a resource was created. The date format follows RFC 3339.", "computed": true }, { - "name": "max_ttl_seconds", - "type": "TypeInt", - "description": "The maximum time-to-live (TTL) for certificates that are created by this CA in seconds.", + "name": "certificate_authority", + "type": "TypeString", + "description": "The name of the intermediate certificate authority.", "computed": true }, { - "name": "key_bits", + "name": "not_before_duration_seconds", "type": "TypeInt", - "description": "The number of bits to use to generate the private key.Allowable values for RSA keys are: `2048` and `4096`. Allowable values for EC keys are: `224`, `256`, `384`, and `521`. The default for RSA keys is `2048`. The default for EC keys is `256`.", + "description": "The duration in seconds by which to backdate the `not_before` property of an issued private certificate.", + "computed": true + }, + { + "name": "allow_glob_domains", + "type": "TypeBool", + "description": "Determines whether to allow glob patterns, for example, `ftp*.example.com`, in the names that are specified in the `allowed_domains` field.If set to `true`, clients are allowed to request private certificates with names that match the glob patterns.", + "computed": true + }, + { + "name": "allow_ip_sans", + "type": "TypeBool", + "description": "Determines whether to allow clients to request a private certificate with IP Subject Alternative Names.", "computed": true }, { @@ -75623,18 +80137,10 @@ } }, { - "name": "not_before_duration_seconds", - "type": "TypeInt", - "description": "The duration in seconds by which to backdate the `not_before` property of an issued private certificate.", - "computed": true - }, - { - "name": "instance_id", + "name": "serial_number", "type": "TypeString", - "description": "The ID of the Secrets Manager instance.", - "cloud_data_type": "resource_instance", - "immutable": true, - "required": true + "description": "The serial number to assign to the generated certificate. To assign a random serial number, you can omit this field.", + "computed": true }, { "name": "endpoint_type", @@ -75643,27 +80149,9 @@ "optional": true }, { - "name": "client_flag", - "type": "TypeBool", - "description": "Determines whether private certificates are flagged for client use.", - "computed": true - }, - { - "name": "updated_at", - "type": "TypeString", - "description": "The date when a resource was recently modified. The date format follows RFC 3339.", - "computed": true - }, - { - "name": "allowed_secret_groups", + "name": "created_by", "type": "TypeString", - "description": "Scopes the creation of private certificates to only the secret groups that you specify.This field can be supplied as a comma-delimited list of secret group IDs.", - "computed": true - }, - { - "name": "ttl_seconds", - "type": "TypeInt", - "description": "The requested Time To Live, after which the certificate will be expired.", + "description": "The unique identifier that is associated with the entity that created the secret.", "computed": true }, { @@ -75673,138 +80161,137 @@ "computed": true }, { - "name": "allow_glob_domains", - "type": "TypeBool", - "description": "Determines whether to allow glob patterns, for example, `ftp*.example.com`, in the names that are specified in the `allowed_domains` field.If set to `true`, clients are allowed to request private certificates with names that match the glob patterns.", - "computed": true - }, - { - "name": "allow_ip_sans", - "type": "TypeBool", - "description": "Determines whether to allow clients to request a private certificate with IP Subject Alternative Names.", - "computed": true - }, - { - "name": "ext_key_usage_oids", + "name": "allowed_uri_sans", "type": "TypeList", - "description": "A list of extended key usage Object Identifiers (OIDs).", + "description": "The URI Subject Alternative Names to allow for private certificates.Values can contain glob patterns, for example `spiffe://hostname/_*`.", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "created_at", - "type": "TypeString", - "description": "The date when a resource was created. The date format follows RFC 3339.", + "name": "client_flag", + "type": "TypeBool", + "description": "Determines whether private certificates are flagged for client use.", "computed": true }, { - "name": "street_address", - "type": "TypeList", - "description": "The street address values to define in the subject field of the resulting certificate.", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "email_protection_flag", + "type": "TypeBool", + "description": "Determines whether private certificates are flagged for email protection use.", + "computed": true }, { - "name": "certificate_authority", - "type": "TypeString", - "description": "The name of the intermediate certificate authority.", + "name": "use_csr_sans", + "type": "TypeBool", + "description": "When used with the `private_cert_configuration_action_sign_csr` action, this field determines whether to use the Subject Alternative Names(SANs) from a certificate signing request (CSR) instead of the SANs that are included in the data of the certificate.Does not include the common name in the CSR. To use the common name, include the `use_csr_common_name` property.", "computed": true }, { - "name": "allowed_domains_template", - "type": "TypeBool", - "description": "Determines whether to allow the domains that are supplied in the `allowed_domains` field to contain access control list (ACL) templates.", + "name": "secret_type", + "type": "TypeString", + "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", "computed": true }, { - "name": "email_protection_flag", + "name": "allow_subdomains", "type": "TypeBool", - "description": "Determines whether private certificates are flagged for email protection use.", + "description": "Determines whether to allow clients to request private certificates with common names (CN) that are subdomains of the CNs that are allowed by the other certificate template options. This includes wildcard subdomains.For example, if `allowed_domains` has a value of `example.com` and `allow_subdomains`is set to `true`, then the following subdomains are allowed: `foo.example.com`, `bar.example.com`, `*.example.com`.**Note:** This field is redundant if you use the `allow_any_name` option.", "computed": true }, { - "name": "ou", + "name": "street_address", "type": "TypeList", - "description": "The Organizational Unit (OU) values to define in the subject field of the resulting certificate.", + "description": "The street address values to define in the subject field of the resulting certificate.", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "postal_code", + "name": "allowed_other_sans", "type": "TypeList", - "description": "The postal code values to define in the subject field of the resulting certificate.", + "description": "The custom Object Identifier (OID) or UTF8-string Subject Alternative Names (SANs) to allow for private certificates.The format for each element in the list is the same as OpenSSL: `\u003coid\u003e:\u003ctype\u003e:\u003cvalue\u003e` where the current valid type is `UTF8`. To allow any value for an OID, use `*` as its value. Alternatively, specify a single `*` to allow any `other_sans` input.", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "policy_identifiers", - "type": "TypeList", - "description": "A list of policy Object Identifiers (OIDs).", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "key_bits", + "type": "TypeInt", + "description": "The number of bits to use to generate the private key.Allowable values for RSA keys are: `2048` and `4096`. Allowable values for EC keys are: `224`, `256`, `384`, and `521`. The default for RSA keys is `2048`. The default for EC keys is `256`.", + "computed": true }, { - "name": "name", - "type": "TypeString", - "description": "The name of the configuration.", - "required": true + "name": "use_csr_common_name", + "type": "TypeBool", + "description": "When used with the `private_cert_configuration_action_sign_csr` action, this field determines whether to use the common name (CN) from a certificate signing request (CSR) instead of the CN that's included in the data of the certificate.Does not include any requested Subject Alternative Names (SANs) in the CSR. To use the alternative names, include the `use_csr_sans` property.", + "computed": true }, { - "name": "created_by", + "name": "region", "type": "TypeString", - "description": "The unique identifier that is associated with the entity that created the secret.", + "description": "The region of the Secrets Manager instance.", + "cloud_data_type": "region", + "immutable": true, + "optional": true, "computed": true }, { - "name": "allow_subdomains", - "type": "TypeBool", - "description": "Determines whether to allow clients to request private certificates with common names (CN) that are subdomains of the CNs that are allowed by the other certificate template options. This includes wildcard subdomains.For example, if `allowed_domains` has a value of `example.com` and `allow_subdomains`is set to `true`, then the following subdomains are allowed: `foo.example.com`, `bar.example.com`, `*.example.com`.**Note:** This field is redundant if you use the `allow_any_name` option.", + "name": "max_ttl_seconds", + "type": "TypeInt", + "description": "The maximum time-to-live (TTL) for certificates that are created by this CA in seconds.", "computed": true }, { - "name": "enforce_hostnames", + "name": "code_signing_flag", "type": "TypeBool", - "description": "Determines whether to enforce only valid host names for common names, DNS Subject Alternative Names, and the host section of email addresses.", + "description": "Determines whether private certificates are flagged for code signing use.", "computed": true }, { - "name": "allowed_uri_sans", + "name": "organization", "type": "TypeList", - "description": "The URI Subject Alternative Names to allow for private certificates.Values can contain glob patterns, for example `spiffe://hostname/_*`.", + "description": "The Organization (O) values to define in the subject field of the resulting certificate.", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "code_signing_flag", + "name": "policy_identifiers", + "type": "TypeList", + "description": "A list of policy Object Identifiers (OIDs).", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "basic_constraints_valid_for_non_ca", "type": "TypeBool", - "description": "Determines whether private certificates are flagged for code signing use.", + "description": "Determines whether to mark the Basic Constraints extension of an issued private certificate as valid for non-CA certificates.", "computed": true }, { - "name": "key_usage", - "type": "TypeList", - "description": "The allowed key usage constraint to define for private certificates.You can find valid values in the [Go x509 package documentation](https://pkg.go.dev/crypto/x509#KeyUsage). Omit the `KeyUsage` part of the value. Values are not case-sensitive. To specify no key usage constraints, set this field to an empty list.", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "instance_id", + "type": "TypeString", + "description": "The ID of the Secrets Manager instance.", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true + }, + { + "name": "name", + "type": "TypeString", + "description": "The name of the configuration.", + "required": true }, { - "name": "secret_type", + "name": "updated_at", "type": "TypeString", - "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", + "description": "The date when a resource was recently modified. The date format follows RFC 3339.", "computed": true }, { @@ -75814,155 +80301,106 @@ "computed": true }, { - "name": "use_csr_common_name", - "type": "TypeBool", - "description": "When used with the `private_cert_configuration_action_sign_csr` action, this field determines whether to use the common name (CN) from a certificate signing request (CSR) instead of the CN that's included in the data of the certificate.Does not include any requested Subject Alternative Names (SANs) in the CSR. To use the alternative names, include the `use_csr_sans` property.", - "computed": true + "name": "ou", + "type": "TypeList", + "description": "The Organizational Unit (OU) values to define in the subject field of the resulting certificate.", + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "province", + "name": "postal_code", "type": "TypeList", - "description": "The Province (ST) values to define in the subject field of the resulting certificate.", + "description": "The postal code values to define in the subject field of the resulting certificate.", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "basic_constraints_valid_for_non_ca", + "name": "require_cn", "type": "TypeBool", - "description": "Determines whether to mark the Basic Constraints extension of an issued private certificate as valid for non-CA certificates.", + "description": "Determines whether to require a common name to create a private certificate.By default, a common name is required to generate a certificate. To make the `common_name` field optional, set the `require_cn` option to `false`.", "computed": true }, { - "name": "allowed_other_sans", - "type": "TypeList", - "description": "The custom Object Identifier (OID) or UTF8-string Subject Alternative Names (SANs) to allow for private certificates.The format for each element in the list is the same as OpenSSL: `\u003coid\u003e:\u003ctype\u003e:\u003cvalue\u003e` where the current valid type is `UTF8`. To allow any value for an OID, use `*` as its value. Alternatively, specify a single `*` to allow any `other_sans` input.", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "allowed_domains_template", + "type": "TypeBool", + "description": "Determines whether to allow the domains that are supplied in the `allowed_domains` field to contain access control list (ACL) templates.", + "computed": true }, { - "name": "allow_any_name", + "name": "enforce_hostnames", "type": "TypeBool", - "description": "Determines whether to allow clients to request a private certificate that matches any common name.", + "description": "Determines whether to enforce only valid host names for common names, DNS Subject Alternative Names, and the host section of email addresses.", "computed": true }, { - "name": "require_cn", + "name": "ttl_seconds", + "type": "TypeInt", + "description": "The requested Time To Live, after which the certificate will be expired.", + "computed": true + }, + { + "name": "allow_any_name", "type": "TypeBool", - "description": "Determines whether to require a common name to create a private certificate.By default, a common name is required to generate a certificate. To make the `common_name` field optional, set the `require_cn` option to `false`.", + "description": "Determines whether to allow clients to request a private certificate that matches any common name.", "computed": true }, { - "name": "allowed_domains", + "name": "ext_key_usage", "type": "TypeList", - "description": "The domains to define for the certificate template. This property is used along with the `allow_bare_domains` and `allow_subdomains` options.", + "description": "The allowed extended key usage constraint on private certificates.You can find valid values in the [Go x509 package documentation](https://golang.org/pkg/crypto/x509/#ExtKeyUsage). Omit the `ExtKeyUsage` part of the value. Values are not case-sensitive. To specify no key usage constraints, set this field to an empty list.", "computed": true, "elem": { "type": "TypeString" } - } - ], - "ibm_sm_private_certificate_metadata": [ + }, { - "name": "custom_metadata", - "type": "TypeMap", - "description": "The secret metadata that a user can customize.", + "name": "province", + "type": "TypeList", + "description": "The Province (ST) values to define in the subject field of the resulting certificate.", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "name", - "type": "TypeString", - "description": "The human-readable name of your secret.", - "computed": true - }, - { - "name": "serial_number", + "name": "config_type", "type": "TypeString", - "description": "The unique serial number that was assigned to a certificate by the issuing certificate authority.", + "description": "Th configuration type.", "computed": true }, { - "name": "region", + "name": "allowed_secret_groups", "type": "TypeString", - "description": "The region of the Secrets Manager instance.", - "cloud_data_type": "region", - "immutable": true, - "optional": true, + "description": "Scopes the creation of private certificates to only the secret groups that you specify.This field can be supplied as a comma-delimited list of secret group IDs.", "computed": true - }, - { - "name": "instance_id", - "type": "TypeString", - "description": "The ID of the Secrets Manager instance.", - "cloud_data_type": "resource_instance", - "immutable": true, - "required": true - }, - { - "name": "secret_id", - "type": "TypeString", - "description": "The ID of the secret.", - "required": true - }, + } + ], + "ibm_sm_private_certificate_metadata": [ { - "name": "updated_at", + "name": "created_by", "type": "TypeString", - "description": "The date when a resource was recently modified. The date format follows RFC 3339.", + "description": "The unique identifier that is associated with the entity that created the secret.", "computed": true }, { - "name": "alt_names", - "type": "TypeList", - "description": "With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.", + "name": "custom_metadata", + "type": "TypeMap", + "description": "The secret metadata that a user can customize.", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "expiration_date", + "name": "next_rotation_date", "type": "TypeString", - "description": "The date a secret is expired. The date format follows RFC 3339.", + "description": "The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.", "computed": true }, - { - "name": "rotation", - "type": "TypeList", - "description": "Determines whether Secrets Manager rotates your secrets automatically.", - "computed": true, - "elem": { - "auto_rotate": { - "name": "auto_rotate", - "type": "TypeBool", - "description": "Determines whether Secrets Manager rotates your secret automatically.Default is `false`. If `auto_rotate` is set to `true` the service rotates your secret based on the defined interval.", - "computed": true - }, - "interval": { - "name": "interval", - "type": "TypeInt", - "description": "The length of the secret rotation time interval.", - "computed": true - }, - "rotate_keys": { - "name": "rotate_keys", - "type": "TypeBool", - "description": "Determines whether Secrets Manager rotates the private key for your public certificate automatically.Default is `false`. If it is set to `true`, the service generates and stores a new private key for your rotated certificate.", - "computed": true - }, - "unit": { - "name": "unit", - "type": "TypeString", - "description": "The units for the secret rotation time interval.", - "computed": true - } - } - }, { "name": "validity", "type": "TypeList", @@ -75984,39 +80422,17 @@ } }, { - "name": "secret_type", - "type": "TypeString", - "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", - "computed": true - }, - { - "name": "revocation_time_rfc3339", - "type": "TypeString", - "description": "The date and time that the certificate was revoked. The date format follows RFC 3339.", + "name": "downloaded", + "type": "TypeBool", + "description": "Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", "computed": true }, { - "name": "endpoint_type", - "type": "TypeString", - "description": "public or private.", - "optional": true - }, - { - "name": "crn", + "name": "secret_type", "type": "TypeString", - "description": "A CRN that uniquely identifies an IBM Cloud resource.", - "cloud_data_type": "crn", + "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", "computed": true }, - { - "name": "labels", - "type": "TypeList", - "description": "Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, { "name": "state_description", "type": "TypeString", @@ -76030,75 +80446,61 @@ "computed": true }, { - "name": "issuer", + "name": "crn", "type": "TypeString", - "description": "The distinguished name that identifies the entity that signed and issued the certificate.", + "description": "A CRN that uniquely identifies an IBM Cloud resource.", + "cloud_data_type": "crn", "computed": true }, { - "name": "revocation_time_seconds", + "name": "locks_total", "type": "TypeInt", - "description": "The timestamp of the certificate revocation.", + "description": "The number of locks of the secret.", "computed": true }, { - "name": "key_algorithm", + "name": "region", "type": "TypeString", - "description": "The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.", + "description": "The region of the Secrets Manager instance.", + "cloud_data_type": "region", + "immutable": true, + "optional": true, "computed": true }, { - "name": "created_by", + "name": "updated_at", "type": "TypeString", - "description": "The unique identifier that is associated with the entity that created the secret.", + "description": "The date when a resource was recently modified. The date format follows RFC 3339.", "computed": true }, { - "name": "created_at", + "name": "expiration_date", "type": "TypeString", - "description": "The date when a resource was created. The date format follows RFC 3339.", - "computed": true - }, - { - "name": "downloaded", - "type": "TypeBool", - "description": "Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", - "computed": true - }, - { - "name": "locks_total", - "type": "TypeInt", - "description": "The number of locks of the secret.", - "computed": true - }, - { - "name": "state", - "type": "TypeInt", - "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", + "description": "The date a secret is expired. The date format follows RFC 3339.", "computed": true }, { - "name": "signing_algorithm", + "name": "issuer", "type": "TypeString", - "description": "The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.", + "description": "The distinguished name that identifies the entity that signed and issued the certificate.", "computed": true }, { - "name": "certificate_template", + "name": "serial_number", "type": "TypeString", - "description": "The name of the certificate template.", + "description": "The unique serial number that was assigned to a certificate by the issuing certificate authority.", "computed": true }, { - "name": "next_rotation_date", + "name": "endpoint_type", "type": "TypeString", - "description": "The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.", - "computed": true + "description": "public or private.", + "optional": true }, { - "name": "description", + "name": "created_at", "type": "TypeString", - "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", + "description": "The date when a resource was created. The date format follows RFC 3339.", "computed": true }, { @@ -76108,123 +80510,131 @@ "computed": true }, { - "name": "certificate_authority", + "name": "key_algorithm", "type": "TypeString", - "description": "The intermediate certificate authority that signed this certificate.", + "description": "The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.", "computed": true }, { - "name": "common_name", + "name": "instance_id", "type": "TypeString", - "description": "The Common Name (AKA CN) represents the server name that is protected by the SSL certificate.", - "computed": true - } - ], - "ibm_sm_public_certificate": [ + "description": "The ID of the Secrets Manager instance.", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true + }, { - "name": "signing_algorithm", + "name": "common_name", "type": "TypeString", - "description": "The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.", + "description": "The Common Name (AKA CN) represents the server name that is protected by the SSL certificate.", "computed": true }, { - "name": "secret_id", - "type": "TypeString", - "description": "The ID of the secret.", - "required": true + "name": "rotation", + "type": "TypeList", + "description": "Determines whether Secrets Manager rotates your secrets automatically.", + "computed": true, + "elem": { + "auto_rotate": { + "name": "auto_rotate", + "type": "TypeBool", + "description": "Determines whether Secrets Manager rotates your secret automatically.Default is `false`. If `auto_rotate` is set to `true` the service rotates your secret based on the defined interval.", + "computed": true + }, + "interval": { + "name": "interval", + "type": "TypeInt", + "description": "The length of the secret rotation time interval.", + "computed": true + }, + "rotate_keys": { + "name": "rotate_keys", + "type": "TypeBool", + "description": "Determines whether Secrets Manager rotates the private key for your public certificate automatically.Default is `false`. If it is set to `true`, the service generates and stores a new private key for your rotated certificate.", + "computed": true + }, + "unit": { + "name": "unit", + "type": "TypeString", + "description": "The units for the secret rotation time interval.", + "computed": true + } + } }, { - "name": "locks_total", - "type": "TypeInt", - "description": "The number of locks of the secret.", + "name": "revocation_time_rfc3339", + "type": "TypeString", + "description": "The date and time that the certificate was revoked. The date format follows RFC 3339.", "computed": true }, { - "name": "state", - "type": "TypeInt", - "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", + "name": "description", + "type": "TypeString", + "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", "computed": true }, { - "name": "instance_id", + "name": "name", "type": "TypeString", - "description": "The ID of the Secrets Manager instance.", - "cloud_data_type": "resource_instance", - "immutable": true, - "required": true - }, - { - "name": "downloaded", - "type": "TypeBool", - "description": "Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", + "description": "The human-readable name of your secret.", "computed": true }, { - "name": "dns", - "type": "TypeString", - "description": "The name of the DNS provider configuration.", - "computed": true + "name": "alt_names", + "type": "TypeList", + "description": "With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.", + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "intermediate", + "name": "certificate_template", "type": "TypeString", - "description": "(Optional) The PEM-encoded intermediate certificate to associate with the root certificate.", - "secure": true, + "description": "The name of the certificate template.", "computed": true }, { - "name": "endpoint_type", + "name": "secret_id", "type": "TypeString", - "description": "public or private.", - "optional": true + "description": "The ID of the secret.", + "required": true }, { - "name": "secret_type", + "name": "signing_algorithm", "type": "TypeString", - "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", + "description": "The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.", "computed": true }, { - "name": "common_name", + "name": "certificate_authority", "type": "TypeString", - "description": "The Common Name (AKA CN) represents the server name protected by the SSL certificate.", - "computed": true - }, - { - "name": "bundle_certs", - "type": "TypeBool", - "description": "Indicates whether the issued certificate is bundled with intermediate certificates.", + "description": "The intermediate certificate authority that signed this certificate.", "computed": true }, { - "name": "private_key", - "type": "TypeString", - "description": "(Optional) The PEM-encoded private key to associate with the certificate.", - "secure": true, + "name": "revocation_time_seconds", + "type": "TypeInt", + "description": "The timestamp of the certificate revocation.", "computed": true }, { - "name": "alt_names", + "name": "labels", "type": "TypeList", - "description": "With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.", + "description": "Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "issuer", - "type": "TypeString", - "description": "The distinguished name that identifies the entity that signed and issued the certificate.", - "computed": true - }, - { - "name": "certificate", - "type": "TypeString", - "description": "The PEM-encoded contents of your certificate.", - "secure": true, + "name": "state", + "type": "TypeInt", + "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", "computed": true - }, + } + ], + "ibm_sm_public_certificate": [ { "name": "name", "type": "TypeString", @@ -76232,29 +80642,30 @@ "computed": true }, { - "name": "secret_group_id", + "name": "issuer", "type": "TypeString", - "description": "A v4 UUID identifier, or `default` secret group.", + "description": "The distinguished name that identifies the entity that signed and issued the certificate.", "computed": true }, { - "name": "versions_total", - "type": "TypeInt", - "description": "The number of versions of the secret.", + "name": "intermediate", + "type": "TypeString", + "description": "(Optional) The PEM-encoded intermediate certificate to associate with the root certificate.", + "secure": true, "computed": true }, { - "name": "created_by", + "name": "private_key", "type": "TypeString", - "description": "The unique identifier that is associated with the entity that created the secret.", + "description": "(Optional) The PEM-encoded private key to associate with the certificate.", + "secure": true, "computed": true }, { - "name": "crn", + "name": "secret_id", "type": "TypeString", - "description": "A CRN that uniquely identifies an IBM Cloud resource.", - "cloud_data_type": "crn", - "computed": true + "description": "The ID of the secret.", + "required": true }, { "name": "custom_metadata", @@ -76266,30 +80677,24 @@ } }, { - "name": "key_algorithm", + "name": "description", "type": "TypeString", - "description": "The identifier for the cryptographic algorithm to be used to generate the public key that is associated with the certificate.The algorithm that you select determines the encryption algorithm (`RSA` or `ECDSA`) and key size to be used to generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to provide more encryption protection. Allowed values: RSA2048, RSA4096, EC256, EC384.", + "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", "computed": true }, { - "name": "rotation", - "type": "TypeList", - "description": "Determines whether Secrets Manager rotates your secrets automatically.", - "computed": true, - "elem": { - "auto_rotate": { - "name": "auto_rotate", - "type": "TypeBool", - "description": "Determines whether Secrets Manager rotates your secret automatically.Default is `false`. If `auto_rotate` is set to `true` the service rotates your secret based on the defined interval.", - "computed": true - }, - "rotate_keys": { - "name": "rotate_keys", - "type": "TypeBool", - "description": "Determines whether Secrets Manager rotates the private key for your public certificate automatically.Default is `false`. If it is set to `true`, the service generates and stores a new private key for your rotated certificate.", - "computed": true - } - } + "name": "locks_total", + "type": "TypeInt", + "description": "The number of locks of the secret.", + "computed": true + }, + { + "name": "instance_id", + "type": "TypeString", + "description": "The ID of the Secrets Manager instance.", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true }, { "name": "region", @@ -76301,9 +80706,9 @@ "computed": true }, { - "name": "state_description", - "type": "TypeString", - "description": "A text representation of the secret state.", + "name": "bundle_certs", + "type": "TypeBool", + "description": "Indicates whether the issued certificate is bundled with intermediate certificates.", "computed": true }, { @@ -76394,6 +80799,116 @@ } } }, + { + "name": "key_algorithm", + "type": "TypeString", + "description": "The identifier for the cryptographic algorithm to be used to generate the public key that is associated with the certificate.The algorithm that you select determines the encryption algorithm (`RSA` or `ECDSA`) and key size to be used to generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to provide more encryption protection. Allowed values: RSA2048, RSA4096, EC256, EC384.", + "computed": true + }, + { + "name": "state", + "type": "TypeInt", + "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", + "computed": true + }, + { + "name": "state_description", + "type": "TypeString", + "description": "A text representation of the secret state.", + "computed": true + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "The date when a resource was recently modified. The date format follows RFC 3339.", + "computed": true + }, + { + "name": "versions_total", + "type": "TypeInt", + "description": "The number of versions of the secret.", + "computed": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "The date when a resource was created. The date format follows RFC 3339.", + "computed": true + }, + { + "name": "expiration_date", + "type": "TypeString", + "description": "The date a secret is expired. The date format follows RFC 3339.", + "computed": true + }, + { + "name": "serial_number", + "type": "TypeString", + "description": "The unique serial number that was assigned to a certificate by the issuing certificate authority.", + "computed": true + }, + { + "name": "endpoint_type", + "type": "TypeString", + "description": "public or private.", + "optional": true + }, + { + "name": "alt_names", + "type": "TypeList", + "description": "With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "rotation", + "type": "TypeList", + "description": "Determines whether Secrets Manager rotates your secrets automatically.", + "computed": true, + "elem": { + "auto_rotate": { + "name": "auto_rotate", + "type": "TypeBool", + "description": "Determines whether Secrets Manager rotates your secret automatically.Default is `false`. If `auto_rotate` is set to `true` the service rotates your secret based on the defined interval.", + "computed": true + }, + "rotate_keys": { + "name": "rotate_keys", + "type": "TypeBool", + "description": "Determines whether Secrets Manager rotates the private key for your public certificate automatically.Default is `false`. If it is set to `true`, the service generates and stores a new private key for your rotated certificate.", + "computed": true + } + } + }, + { + "name": "labels", + "type": "TypeList", + "description": "Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "secret_group_id", + "type": "TypeString", + "description": "A v4 UUID identifier, or `default` secret group.", + "computed": true + }, + { + "name": "secret_type", + "type": "TypeString", + "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", + "computed": true + }, + { + "name": "signing_algorithm", + "type": "TypeString", + "description": "The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.", + "computed": true + }, { "name": "validity", "type": "TypeList", @@ -76415,48 +80930,47 @@ } }, { - "name": "created_at", + "name": "dns", "type": "TypeString", - "description": "The date when a resource was created. The date format follows RFC 3339.", + "description": "The name of the DNS provider configuration.", "computed": true }, { - "name": "description", + "name": "certificate", "type": "TypeString", - "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", + "description": "The PEM-encoded contents of your certificate.", + "secure": true, "computed": true }, { - "name": "labels", - "type": "TypeList", - "description": "Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "created_by", + "type": "TypeString", + "description": "The unique identifier that is associated with the entity that created the secret.", + "computed": true }, { - "name": "ca", + "name": "crn", "type": "TypeString", - "description": "The name of the certificate authority configuration.", + "description": "A CRN that uniquely identifies an IBM Cloud resource.", + "cloud_data_type": "crn", "computed": true }, { - "name": "updated_at", - "type": "TypeString", - "description": "The date when a resource was recently modified. The date format follows RFC 3339.", + "name": "downloaded", + "type": "TypeBool", + "description": "Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", "computed": true }, { - "name": "expiration_date", + "name": "common_name", "type": "TypeString", - "description": "The date a secret is expired. The date format follows RFC 3339.", + "description": "The Common Name (AKA CN) represents the server name protected by the SSL certificate.", "computed": true }, { - "name": "serial_number", + "name": "ca", "type": "TypeString", - "description": "The unique serial number that was assigned to a certificate by the issuing certificate authority.", + "description": "The name of the certificate authority configuration.", "computed": true } ], @@ -76474,14 +80988,6 @@ "description": "Prefer the chain with an issuer matching this Subject Common Name.", "computed": true }, - { - "name": "instance_id", - "type": "TypeString", - "description": "The ID of the Secrets Manager instance.", - "cloud_data_type": "resource_instance", - "immutable": true, - "required": true - }, { "name": "endpoint_type", "type": "TypeString", @@ -76506,6 +81012,14 @@ "description": "The configuration of the Let's Encrypt CA environment.", "computed": true }, + { + "name": "instance_id", + "type": "TypeString", + "description": "The ID of the Secrets Manager instance.", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true + }, { "name": "region", "type": "TypeString", @@ -76530,15 +81044,15 @@ ], "ibm_sm_public_certificate_configuration_dns_cis": [ { - "name": "name", + "name": "created_by", "type": "TypeString", - "description": "The name of the configuration.", - "required": true + "description": "The unique identifier that is associated with the entity that created the secret.", + "computed": true }, { - "name": "updated_at", + "name": "created_at", "type": "TypeString", - "description": "The date when a resource was recently modified. The date format follows RFC 3339.", + "description": "The date when a resource was created. The date format follows RFC 3339.", "computed": true }, { @@ -76547,14 +81061,6 @@ "description": "An IBM Cloud API key that can to list domains in your Cloud Internet Services instance.To grant Secrets Manager the ability to view the Cloud Internet Services instance and all of its domains, the API key must be assigned the Reader service role on Internet Services (`internet-svcs`).If you need to manage specific domains, you can assign the Manager role. For production environments, it is recommended that you assign the Reader access role, and then use the[IAM Policy Management API](https://cloud.ibm.com/apidocs/iam-policy-management#create-policy) to control specific domains. For more information, see the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-prepare-order-certificates#authorize-specific-domains).", "computed": true }, - { - "name": "instance_id", - "type": "TypeString", - "description": "The ID of the Secrets Manager instance.", - "cloud_data_type": "resource_instance", - "immutable": true, - "required": true - }, { "name": "region", "type": "TypeString", @@ -76570,6 +81076,12 @@ "description": "public or private.", "optional": true }, + { + "name": "name", + "type": "TypeString", + "description": "The name of the configuration.", + "required": true + }, { "name": "config_type", "type": "TypeString", @@ -76583,58 +81095,39 @@ "computed": true }, { - "name": "created_by", + "name": "updated_at", "type": "TypeString", - "description": "The unique identifier that is associated with the entity that created the secret.", + "description": "The date when a resource was recently modified. The date format follows RFC 3339.", "computed": true }, { - "name": "created_at", + "name": "cloud_internet_services_crn", "type": "TypeString", - "description": "The date when a resource was created. The date format follows RFC 3339.", + "description": "A CRN that uniquely identifies an IBM Cloud resource.", "computed": true }, { - "name": "cloud_internet_services_crn", + "name": "instance_id", "type": "TypeString", - "description": "A CRN that uniquely identifies an IBM Cloud resource.", - "computed": true + "description": "The ID of the Secrets Manager instance.", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true } ], "ibm_sm_public_certificate_configuration_dns_classic_infrastructure": [ { - "name": "region", + "name": "created_by", "type": "TypeString", - "description": "The region of the Secrets Manager instance.", - "cloud_data_type": "region", - "immutable": true, - "optional": true, + "description": "The unique identifier that is associated with the entity that created the secret.", "computed": true }, - { - "name": "endpoint_type", - "type": "TypeString", - "description": "public or private.", - "optional": true - }, { "name": "created_at", "type": "TypeString", "description": "The date when a resource was created. The date format follows RFC 3339.", "computed": true }, - { - "name": "updated_at", - "type": "TypeString", - "description": "The date when a resource was recently modified. The date format follows RFC 3339.", - "computed": true - }, - { - "name": "classic_infrastructure_username", - "type": "TypeString", - "description": "The username that is associated with your classic infrastructure account.In most cases, your classic infrastructure username is your `\u003caccount_id\u003e_\u003cemail_address\u003e`. For more information, see the [docs](https://cloud.ibm.com/docs/account?topic=account-classic_keys).", - "computed": true - }, { "name": "classic_infrastructure_password", "type": "TypeString", @@ -76642,10 +81135,10 @@ "computed": true }, { - "name": "name", + "name": "secret_type", "type": "TypeString", - "description": "The name of the configuration.", - "required": true + "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", + "computed": true }, { "name": "config_type", @@ -76654,31 +81147,15 @@ "computed": true }, { - "name": "secret_type", - "type": "TypeString", - "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", - "computed": true - }, - { - "name": "created_by", + "name": "updated_at", "type": "TypeString", - "description": "The unique identifier that is associated with the entity that created the secret.", + "description": "The date when a resource was recently modified. The date format follows RFC 3339.", "computed": true }, { - "name": "instance_id", + "name": "classic_infrastructure_username", "type": "TypeString", - "description": "The ID of the Secrets Manager instance.", - "cloud_data_type": "resource_instance", - "immutable": true, - "required": true - } - ], - "ibm_sm_public_certificate_metadata": [ - { - "name": "state", - "type": "TypeInt", - "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", + "description": "The username that is associated with your classic infrastructure account.In most cases, your classic infrastructure username is your `\u003caccount_id\u003e_\u003cemail_address\u003e`. For more information, see the [docs](https://cloud.ibm.com/docs/account?topic=account-classic_keys).", "computed": true }, { @@ -76689,15 +81166,6 @@ "immutable": true, "required": true }, - { - "name": "custom_metadata", - "type": "TypeMap", - "description": "The secret metadata that a user can customize.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, { "name": "region", "type": "TypeString", @@ -76708,74 +81176,29 @@ "computed": true }, { - "name": "validity", - "type": "TypeList", - "description": "The date and time that the certificate validity period begins and ends.", - "computed": true, - "elem": { - "not_after": { - "name": "not_after", - "type": "TypeString", - "description": "The date-time format follows RFC 3339.", - "computed": true - }, - "not_before": { - "name": "not_before", - "type": "TypeString", - "description": "The date-time format follows RFC 3339.", - "computed": true - } - } - }, - { - "name": "secret_type", - "type": "TypeString", - "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", - "computed": true - }, - { - "name": "dns", + "name": "endpoint_type", "type": "TypeString", - "description": "The name of the DNS provider configuration.", - "computed": true + "description": "public or private.", + "optional": true }, { - "name": "crn", + "name": "name", "type": "TypeString", - "description": "A CRN that uniquely identifies an IBM Cloud resource.", - "cloud_data_type": "crn", - "computed": true - }, + "description": "The name of the configuration.", + "required": true + } + ], + "ibm_sm_public_certificate_metadata": [ { - "name": "name", + "name": "common_name", "type": "TypeString", - "description": "The human-readable name of your secret.", + "description": "The Common Name (AKA CN) represents the server name protected by the SSL certificate.", "computed": true }, { - "name": "rotation", - "type": "TypeList", - "description": "Determines whether Secrets Manager rotates your secrets automatically.", - "computed": true, - "elem": { - "auto_rotate": { - "name": "auto_rotate", - "type": "TypeBool", - "description": "Determines whether Secrets Manager rotates your secret automatically.Default is `false`. If `auto_rotate` is set to `true` the service rotates your secret based on the defined interval.", - "computed": true - }, - "rotate_keys": { - "name": "rotate_keys", - "type": "TypeBool", - "description": "Determines whether Secrets Manager rotates the private key for your public certificate automatically.Default is `false`. If it is set to `true`, the service generates and stores a new private key for your rotated certificate.", - "computed": true - } - } - }, - { - "name": "created_by", + "name": "dns", "type": "TypeString", - "description": "The unique identifier that is associated with the entity that created the secret.", + "description": "The name of the DNS provider configuration.", "computed": true }, { @@ -76785,66 +81208,54 @@ "computed": true }, { - "name": "labels", - "type": "TypeList", - "description": "Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "signing_algorithm", - "type": "TypeString", - "description": "The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.", - "computed": true - }, - { - "name": "key_algorithm", + "name": "secret_type", "type": "TypeString", - "description": "The identifier for the cryptographic algorithm to be used to generate the public key that is associated with the certificate.The algorithm that you select determines the encryption algorithm (`RSA` or `ECDSA`) and key size to be used to generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to provide more encryption protection. Allowed values: RSA2048, RSA4096, EC256, EC384.", - "computed": true - }, - { - "name": "bundle_certs", - "type": "TypeBool", - "description": "Indicates whether the issued certificate is bundled with intermediate certificates.", + "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", "computed": true }, { - "name": "description", + "name": "secret_group_id", "type": "TypeString", - "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", + "description": "A v4 UUID identifier, or `default` secret group.", "computed": true }, { - "name": "expiration_date", + "name": "state_description", "type": "TypeString", - "description": "The date a secret is expired. The date format follows RFC 3339.", + "description": "A text representation of the secret state.", "computed": true }, { - "name": "ca", + "name": "signing_algorithm", "type": "TypeString", - "description": "The name of the certificate authority configuration.", + "description": "The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.", "computed": true }, { - "name": "endpoint_type", - "type": "TypeString", - "description": "public or private.", - "optional": true - }, - { - "name": "common_name", - "type": "TypeString", - "description": "The Common Name (AKA CN) represents the server name protected by the SSL certificate.", - "computed": true + "name": "validity", + "type": "TypeList", + "description": "The date and time that the certificate validity period begins and ends.", + "computed": true, + "elem": { + "not_after": { + "name": "not_after", + "type": "TypeString", + "description": "The date-time format follows RFC 3339.", + "computed": true + }, + "not_before": { + "name": "not_before", + "type": "TypeString", + "description": "The date-time format follows RFC 3339.", + "computed": true + } + } }, { - "name": "created_at", + "name": "crn", "type": "TypeString", - "description": "The date when a resource was created. The date format follows RFC 3339.", + "description": "A CRN that uniquely identifies an IBM Cloud resource.", + "cloud_data_type": "crn", "computed": true }, { @@ -76854,22 +81265,28 @@ "computed": true }, { - "name": "secret_group_id", + "name": "issuer", "type": "TypeString", - "description": "A v4 UUID identifier, or `default` secret group.", + "description": "The distinguished name that identifies the entity that signed and issued the certificate.", "computed": true }, { - "name": "state_description", + "name": "region", "type": "TypeString", - "description": "A text representation of the secret state.", + "description": "The region of the Secrets Manager instance.", + "cloud_data_type": "region", + "immutable": true, + "optional": true, "computed": true }, { - "name": "updated_at", - "type": "TypeString", - "description": "The date when a resource was recently modified. The date format follows RFC 3339.", - "computed": true + "name": "alt_names", + "type": "TypeList", + "description": "With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.", + "computed": true, + "elem": { + "type": "TypeString" + } }, { "name": "issuance_info", @@ -76960,9 +81377,39 @@ } }, { - "name": "serial_number", + "name": "updated_at", "type": "TypeString", - "description": "The unique serial number that was assigned to a certificate by the issuing certificate authority.", + "description": "The date when a resource was recently modified. The date format follows RFC 3339.", + "computed": true + }, + { + "name": "state", + "type": "TypeInt", + "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", + "computed": true + }, + { + "name": "bundle_certs", + "type": "TypeBool", + "description": "Indicates whether the issued certificate is bundled with intermediate certificates.", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "The human-readable name of your secret.", + "computed": true + }, + { + "name": "expiration_date", + "type": "TypeString", + "description": "The date a secret is expired. The date format follows RFC 3339.", + "computed": true + }, + { + "name": "key_algorithm", + "type": "TypeString", + "description": "The identifier for the cryptographic algorithm to be used to generate the public key that is associated with the certificate.The algorithm that you select determines the encryption algorithm (`RSA` or `ECDSA`) and key size to be used to generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to provide more encryption protection. Allowed values: RSA2048, RSA4096, EC256, EC384.", "computed": true }, { @@ -76972,18 +81419,9 @@ "required": true }, { - "name": "alt_names", - "type": "TypeList", - "description": "With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "issuer", + "name": "description", "type": "TypeString", - "description": "The distinguished name that identifies the entity that signed and issued the certificate.", + "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", "computed": true }, { @@ -76991,9 +81429,19 @@ "type": "TypeInt", "description": "The number of versions of the secret.", "computed": true - } - ], - "ibm_sm_secret_group": [ + }, + { + "name": "serial_number", + "type": "TypeString", + "description": "The unique serial number that was assigned to a certificate by the issuing certificate authority.", + "computed": true + }, + { + "name": "ca", + "type": "TypeString", + "description": "The name of the certificate authority configuration.", + "computed": true + }, { "name": "instance_id", "type": "TypeString", @@ -77002,6 +81450,64 @@ "immutable": true, "required": true }, + { + "name": "created_by", + "type": "TypeString", + "description": "The unique identifier that is associated with the entity that created the secret.", + "computed": true + }, + { + "name": "labels", + "type": "TypeList", + "description": "Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "rotation", + "type": "TypeList", + "description": "Determines whether Secrets Manager rotates your secrets automatically.", + "computed": true, + "elem": { + "auto_rotate": { + "name": "auto_rotate", + "type": "TypeBool", + "description": "Determines whether Secrets Manager rotates your secret automatically.Default is `false`. If `auto_rotate` is set to `true` the service rotates your secret based on the defined interval.", + "computed": true + }, + "rotate_keys": { + "name": "rotate_keys", + "type": "TypeBool", + "description": "Determines whether Secrets Manager rotates the private key for your public certificate automatically.Default is `false`. If it is set to `true`, the service generates and stores a new private key for your rotated certificate.", + "computed": true + } + } + }, + { + "name": "endpoint_type", + "type": "TypeString", + "description": "public or private.", + "optional": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "The date when a resource was created. The date format follows RFC 3339.", + "computed": true + }, + { + "name": "custom_metadata", + "type": "TypeMap", + "description": "The secret metadata that a user can customize.", + "computed": true, + "elem": { + "type": "TypeString" + } + } + ], + "ibm_sm_secret_group": [ { "name": "region", "type": "TypeString", @@ -77046,6 +81552,14 @@ "type": "TypeString", "description": "The date that a resource was recently modified. The date format follows RFC 3339.", "computed": true + }, + { + "name": "instance_id", + "type": "TypeString", + "description": "The ID of the Secrets Manager instance.", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true } ], "ibm_sm_secret_groups": [ @@ -77118,6 +81632,15 @@ } ], "ibm_sm_secrets": [ + { + "name": "region", + "type": "TypeString", + "description": "The region of the Secrets Manager instance.", + "cloud_data_type": "region", + "immutable": true, + "optional": true, + "computed": true + }, { "name": "endpoint_type", "type": "TypeString", @@ -77549,37 +82072,25 @@ "cloud_data_type": "resource_instance", "immutable": true, "required": true - }, - { - "name": "region", - "type": "TypeString", - "description": "The region of the Secrets Manager instance.", - "cloud_data_type": "region", - "immutable": true, - "optional": true, - "computed": true } ], "ibm_sm_username_password_secret": [ { - "name": "labels", - "type": "TypeList", - "description": "Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "description", + "type": "TypeString", + "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", + "computed": true }, { - "name": "name", - "type": "TypeString", - "description": "The human-readable name of your secret.", + "name": "locks_total", + "type": "TypeInt", + "description": "The number of locks of the secret.", "computed": true }, { - "name": "state_description", - "type": "TypeString", - "description": "A text representation of the secret state.", + "name": "state", + "type": "TypeInt", + "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", "computed": true }, { @@ -77615,46 +82126,52 @@ } }, { - "name": "instance_id", + "name": "next_rotation_date", "type": "TypeString", - "description": "The ID of the Secrets Manager instance.", - "cloud_data_type": "resource_instance", - "immutable": true, - "required": true + "description": "The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.", + "computed": true }, { - "name": "created_at", + "name": "endpoint_type", "type": "TypeString", - "description": "The date when a resource was created. The date format follows RFC 3339.", - "computed": true + "description": "public or private.", + "optional": true }, { - "name": "secret_group_id", + "name": "crn", "type": "TypeString", - "description": "A v4 UUID identifier, or `default` secret group.", + "description": "A CRN that uniquely identifies an IBM Cloud resource.", + "cloud_data_type": "crn", "computed": true }, { - "name": "versions_total", - "type": "TypeInt", - "description": "The number of versions of the secret.", + "name": "downloaded", + "type": "TypeBool", + "description": "Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", "computed": true }, { - "name": "username", + "name": "secret_type", "type": "TypeString", - "description": "The username that is assigned to the secret.", + "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", "computed": true }, { - "name": "region", + "name": "password", "type": "TypeString", - "description": "The region of the Secrets Manager instance.", - "cloud_data_type": "region", - "immutable": true, - "optional": true, + "description": "The password that is assigned to the secret.", + "secure": true, "computed": true }, + { + "name": "custom_metadata", + "type": "TypeMap", + "description": "The secret metadata that a user can customize.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, { "name": "created_by", "type": "TypeString", @@ -77662,47 +82179,44 @@ "computed": true }, { - "name": "crn", + "name": "created_at", "type": "TypeString", - "description": "A CRN that uniquely identifies an IBM Cloud resource.", - "cloud_data_type": "crn", + "description": "The date when a resource was created. The date format follows RFC 3339.", "computed": true }, { - "name": "description", + "name": "name", "type": "TypeString", - "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", + "description": "The human-readable name of your secret.", "computed": true }, { - "name": "expiration_date", + "name": "state_description", "type": "TypeString", - "description": "The date a secret is expired. The date format follows RFC 3339.", + "description": "A text representation of the secret state.", "computed": true }, { - "name": "password", + "name": "updated_at", "type": "TypeString", - "description": "The password that is assigned to the secret.", - "secure": true, + "description": "The date when a resource was recently modified. The date format follows RFC 3339.", "computed": true }, { - "name": "endpoint_type", - "type": "TypeString", - "description": "public or private.", - "optional": true - }, - { - "name": "updated_at", + "name": "instance_id", "type": "TypeString", - "description": "The date when a resource was recently modified. The date format follows RFC 3339.", - "computed": true + "description": "The ID of the Secrets Manager instance.", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true }, { - "name": "next_rotation_date", + "name": "region", "type": "TypeString", - "description": "The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.", + "description": "The region of the Secrets Manager instance.", + "cloud_data_type": "region", + "immutable": true, + "optional": true, "computed": true }, { @@ -77712,68 +82226,69 @@ "required": true }, { - "name": "custom_metadata", - "type": "TypeMap", - "description": "The secret metadata that a user can customize.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "downloaded", - "type": "TypeBool", - "description": "Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", + "name": "secret_group_id", + "type": "TypeString", + "description": "A v4 UUID identifier, or `default` secret group.", "computed": true }, { - "name": "locks_total", + "name": "versions_total", "type": "TypeInt", - "description": "The number of locks of the secret.", + "description": "The number of versions of the secret.", "computed": true }, { - "name": "secret_type", + "name": "expiration_date", "type": "TypeString", - "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", + "description": "The date a secret is expired. The date format follows RFC 3339.", "computed": true }, { - "name": "state", - "type": "TypeInt", - "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", + "name": "username", + "type": "TypeString", + "description": "The username that is assigned to the secret.", "computed": true + }, + { + "name": "labels", + "type": "TypeList", + "description": "Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.", + "computed": true, + "elem": { + "type": "TypeString" + } } ], "ibm_sm_username_password_secret_metadata": [ { - "name": "created_at", + "name": "crn", "type": "TypeString", - "description": "The date when a resource was created. The date format follows RFC 3339.", + "description": "A CRN that uniquely identifies an IBM Cloud resource.", + "cloud_data_type": "crn", "computed": true }, { - "name": "downloaded", - "type": "TypeBool", - "description": "Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", + "name": "description", + "type": "TypeString", + "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", "computed": true }, { - "name": "locks_total", - "type": "TypeInt", - "description": "The number of locks of the secret.", + "name": "name", + "type": "TypeString", + "description": "The human-readable name of your secret.", "computed": true }, { - "name": "name", + "name": "secret_type", "type": "TypeString", - "description": "The human-readable name of your secret.", + "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", "computed": true }, { - "name": "state", - "type": "TypeInt", - "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", + "name": "state_description", + "type": "TypeString", + "description": "A text representation of the secret state.", "computed": true }, { @@ -77784,6 +82299,45 @@ "immutable": true, "required": true }, + { + "name": "secret_id", + "type": "TypeString", + "description": "The ID of the secret.", + "required": true + }, + { + "name": "labels", + "type": "TypeList", + "description": "Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "The date when a resource was recently modified. The date format follows RFC 3339.", + "computed": true + }, + { + "name": "versions_total", + "type": "TypeInt", + "description": "The number of versions of the secret.", + "computed": true + }, + { + "name": "expiration_date", + "type": "TypeString", + "description": "The date a secret is expired. The date format follows RFC 3339.", + "computed": true + }, + { + "name": "endpoint_type", + "type": "TypeString", + "description": "public or private.", + "optional": true + }, { "name": "created_by", "type": "TypeString", @@ -77791,10 +82345,9 @@ "computed": true }, { - "name": "crn", + "name": "created_at", "type": "TypeString", - "description": "A CRN that uniquely identifies an IBM Cloud resource.", - "cloud_data_type": "crn", + "description": "The date when a resource was created. The date format follows RFC 3339.", "computed": true }, { @@ -77807,9 +82360,36 @@ } }, { - "name": "description", + "name": "downloaded", + "type": "TypeBool", + "description": "Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", + "computed": true + }, + { + "name": "state", + "type": "TypeInt", + "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", + "computed": true + }, + { + "name": "next_rotation_date", "type": "TypeString", - "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", + "description": "The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.", + "computed": true + }, + { + "name": "region", + "type": "TypeString", + "description": "The region of the Secrets Manager instance.", + "cloud_data_type": "region", + "immutable": true, + "optional": true, + "computed": true + }, + { + "name": "locks_total", + "type": "TypeInt", + "description": "The number of locks of the secret.", "computed": true }, { @@ -77849,75 +82429,22 @@ "computed": true } } - }, - { - "name": "expiration_date", - "type": "TypeString", - "description": "The date a secret is expired. The date format follows RFC 3339.", - "computed": true - }, - { - "name": "secret_id", - "type": "TypeString", - "description": "The ID of the secret.", - "required": true - }, - { - "name": "versions_total", - "type": "TypeInt", - "description": "The number of versions of the secret.", - "computed": true - }, - { - "name": "next_rotation_date", - "type": "TypeString", - "description": "The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.", - "computed": true - }, + } + ], + "ibm_space": [ { - "name": "region", + "name": "space", "type": "TypeString", - "description": "The region of the Secrets Manager instance.", - "cloud_data_type": "region", - "immutable": true, + "description": "Space name, for example dev", "optional": true, - "computed": true - }, - { - "name": "secret_type", - "type": "TypeString", - "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", - "computed": true - }, - { - "name": "state_description", - "type": "TypeString", - "description": "A text representation of the secret state.", - "computed": true - }, - { - "name": "updated_at", - "type": "TypeString", - "description": "The date when a resource was recently modified. The date format follows RFC 3339.", - "computed": true + "deprecated": "use name instead" }, { - "name": "endpoint_type", + "name": "name", "type": "TypeString", - "description": "public or private.", + "description": "Space name, for example dev", "optional": true }, - { - "name": "labels", - "type": "TypeList", - "description": "Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.", - "computed": true, - "elem": { - "type": "TypeString" - } - } - ], - "ibm_space": [ { "name": "org", "type": "TypeString", @@ -77950,32 +82477,19 @@ "elem": { "type": "TypeString" } - }, - { - "name": "space", - "type": "TypeString", - "description": "Space name, for example dev", - "optional": true, - "deprecated": "use name instead" - }, - { - "name": "name", - "type": "TypeString", - "description": "Space name, for example dev", - "optional": true } ], "ibm_tg_connection_prefix_filter": [ { - "name": "prefix", - "type": "TypeString", - "description": "IP Prefix", + "name": "le", + "type": "TypeInt", + "description": "IP Prefix LE", "computed": true }, { - "name": "filter_id", + "name": "connection_id", "type": "TypeString", - "description": "The Transit Gateway Connection Prefix Filter identifier", + "description": "The Transit Gateway Connection identifier", "required": true }, { @@ -77991,9 +82505,9 @@ "computed": true }, { - "name": "le", - "type": "TypeInt", - "description": "IP Prefix LE", + "name": "created_at", + "type": "TypeString", + "description": "The date and time that this prefix filter was created", "computed": true }, { @@ -78009,37 +82523,25 @@ "required": true }, { - "name": "connection_id", + "name": "filter_id", "type": "TypeString", - "description": "The Transit Gateway Connection identifier", + "description": "The Transit Gateway Connection Prefix Filter identifier", "required": true }, - { - "name": "created_at", - "type": "TypeString", - "description": "The date and time that this prefix filter was created", - "computed": true - }, { "name": "ge", "type": "TypeInt", "description": "IP Prefix GE", "computed": true - } - ], - "ibm_tg_connection_prefix_filters": [ - { - "name": "gateway", - "type": "TypeString", - "description": "The Transit Gateway identifier", - "required": true }, { - "name": "connection_id", + "name": "prefix", "type": "TypeString", - "description": "The Transit Gateway Connection identifier", - "required": true - }, + "description": "IP Prefix", + "computed": true + } + ], + "ibm_tg_connection_prefix_filters": [ { "name": "prefix_filters", "type": "TypeList", @@ -78094,13 +82596,41 @@ "computed": true } } + }, + { + "name": "gateway", + "type": "TypeString", + "description": "The Transit Gateway identifier", + "required": true + }, + { + "name": "connection_id", + "type": "TypeString", + "description": "The Transit Gateway Connection identifier", + "required": true } ], "ibm_tg_gateway": [ { - "name": "location", + "name": "updated_at", + "type": "TypeString", + "computed": true + }, + { + "name": "resource_group", + "type": "TypeString", + "cloud_data_type": "resource_group", + "computed": true + }, + { + "name": "crn", + "type": "TypeString", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "created_at", "type": "TypeString", - "cloud_data_type": "region", "computed": true }, { @@ -78114,14 +82644,15 @@ "computed": true }, { - "name": "updated_at", + "name": "name", "type": "TypeString", - "computed": true + "description": "The Transit Gateway identifier", + "required": true }, { - "name": "resource_group", + "name": "location", "type": "TypeString", - "cloud_data_type": "resource_group", + "cloud_data_type": "region", "computed": true }, { @@ -78222,23 +82753,6 @@ "computed": true } } - }, - { - "name": "name", - "type": "TypeString", - "description": "The Transit Gateway identifier", - "required": true - }, - { - "name": "crn", - "type": "TypeString", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "created_at", - "type": "TypeString", - "computed": true } ], "ibm_tg_gateways": [ @@ -78297,6 +82811,18 @@ } ], "ibm_tg_location": [ + { + "name": "name", + "type": "TypeString", + "description": "Name of the Location.", + "required": true + }, + { + "name": "type", + "type": "TypeString", + "description": "The type of the location, determining is this a multi-zone region, a single data center, or a point of presence.", + "computed": true + }, { "name": "billing_location", "type": "TypeString", @@ -78328,18 +82854,6 @@ "computed": true } } - }, - { - "name": "name", - "type": "TypeString", - "description": "Name of the Location.", - "required": true - }, - { - "name": "type", - "type": "TypeString", - "description": "The type of the location, determining is this a multi-zone region, a single data center, or a point of presence.", - "computed": true } ], "ibm_tg_locations": [ @@ -78371,6 +82885,12 @@ } ], "ibm_tg_route_report": [ + { + "name": "route_report", + "type": "TypeString", + "description": "The Transit Gateway Route Report identifier", + "required": true + }, { "name": "connections", "type": "TypeList", @@ -78481,12 +83001,6 @@ "type": "TypeString", "description": "The Transit Gateway identifier", "required": true - }, - { - "name": "route_report", - "type": "TypeString", - "description": "The Transit Gateway Route Report identifier", - "required": true } ], "ibm_tg_route_reports": [ @@ -78618,19 +83132,6 @@ }, "Resources": { "ibm_api_gateway_endpoint": [ - { - "name": "service_instance_crn", - "type": "TypeString", - "description": "Api Gateway Service Instance Crn", - "immutable": true, - "required": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Endpoint name", - "required": true - }, { "name": "provider_id", "type": "TypeString", @@ -78644,12 +83145,6 @@ "description": "Endpoint ID", "computed": true }, - { - "name": "base_path", - "type": "TypeString", - "description": "Base path of an endpoint", - "computed": true - }, { "name": "type", "type": "TypeString", @@ -78658,9 +83153,9 @@ "optional": true }, { - "name": "open_api_doc_name", + "name": "name", "type": "TypeString", - "description": "Json File path", + "description": "Endpoint name", "required": true }, { @@ -78672,34 +83167,40 @@ "type": "TypeString" } }, - { - "name": "managed", - "type": "TypeBool", - "description": "Managed indicates if endpoint is online or offline.", - "default_value": false, - "optional": true - }, { "name": "shared", "type": "TypeBool", "description": "The Shared status of an endpoint", "computed": true - } - ], - "ibm_api_gateway_endpoint_subscription": [ + }, { - "name": "client_id", + "name": "base_path", "type": "TypeString", - "description": "Subscription Id, API key that is used to create subscription", - "optional": true, + "description": "Base path of an endpoint", "computed": true }, { - "name": "name", + "name": "service_instance_crn", "type": "TypeString", - "description": "Subscription name", + "description": "Api Gateway Service Instance Crn", + "immutable": true, + "required": true + }, + { + "name": "open_api_doc_name", + "type": "TypeString", + "description": "Json File path", "required": true }, + { + "name": "managed", + "type": "TypeBool", + "description": "Managed indicates if endpoint is online or offline.", + "default_value": false, + "optional": true + } + ], + "ibm_api_gateway_endpoint_subscription": [ { "name": "type", "type": "TypeString", @@ -78731,26 +83232,65 @@ "description": "Endpoint ID", "immutable": true, "required": true + }, + { + "name": "client_id", + "type": "TypeString", + "description": "Subscription Id, API key that is used to create subscription", + "optional": true, + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "Subscription name", + "required": true } ], "ibm_app": [ { - "name": "command", + "name": "memory", + "type": "TypeInt", + "description": "The amount of memory each instance should have. In megabytes.", + "optional": true, + "computed": true + }, + { + "name": "space_guid", "type": "TypeString", - "description": "The initial command for the app", - "optional": true + "description": "Define space guid to which app belongs", + "immutable": true, + "required": true }, { - "name": "wait_time_minutes", - "type": "TypeInt", - "description": "Define timeout to wait for the app instances to start/update/restage etc.", - "default_value": 20, + "name": "environment_json", + "type": "TypeMap", + "description": "Key/value pairs of all the environment variables to run in your app. Does not include any system or service variables.", "optional": true }, { - "name": "health_check_http_endpoint", + "name": "tags", + "type": "TypeSet", + "cloud_data_type": "tags", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "service_instance_guid", + "type": "TypeSet", + "description": "Define the service instance guids that should be bound to this application.", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "health_check_type", "type": "TypeString", - "description": "Endpoint called to determine if the app is healthy.", + "description": "Type of health check to perform.", + "default_value": "port", "optional": true }, { @@ -78759,6 +83299,12 @@ "description": "Timeout in seconds for health checking of an staged app when starting up.", "optional": true }, + { + "name": "name", + "type": "TypeString", + "description": "The name for the app", + "required": true + }, { "name": "instances", "type": "TypeInt", @@ -78767,63 +83313,38 @@ "optional": true }, { - "name": "environment_json", - "type": "TypeMap", - "description": "Key/value pairs of all the environment variables to run in your app. Does not include any system or service variables.", - "optional": true - }, - { - "name": "app_version", + "name": "buildpack", "type": "TypeString", - "description": "Version of the application", + "description": "Buildpack to build the app. 3 options: a) Blank means autodetection; b) A Git Url pointing to a buildpack; c) Name of an installed buildpack.", "optional": true }, { - "name": "name", - "type": "TypeString", - "description": "The name for the app", - "required": true - }, - { - "name": "disk_quota", - "type": "TypeInt", - "description": "The maximum amount of disk available to an instance of an app. In megabytes.", - "optional": true, - "computed": true - }, - { - "name": "tags", + "name": "route_guid", "type": "TypeSet", - "cloud_data_type": "tags", + "description": "Define the route guids which should be bound to the application.", "optional": true, "elem": { "type": "TypeString" } }, { - "name": "memory", - "type": "TypeInt", - "description": "The amount of memory each instance should have. In megabytes.", - "optional": true, - "computed": true + "name": "command", + "type": "TypeString", + "description": "The initial command for the app", + "optional": true }, { - "name": "route_guid", - "type": "TypeSet", - "description": "Define the route guids which should be bound to the application.", - "optional": true, - "elem": { - "type": "TypeString" - } + "name": "health_check_http_endpoint", + "type": "TypeString", + "description": "Endpoint called to determine if the app is healthy.", + "optional": true }, { - "name": "service_instance_guid", - "type": "TypeSet", - "description": "Define the service instance guids that should be bound to this application.", + "name": "disk_quota", + "type": "TypeInt", + "description": "The maximum amount of disk available to an instance of an app. In megabytes.", "optional": true, - "elem": { - "type": "TypeString" - } + "computed": true }, { "name": "app_path", @@ -78832,39 +83353,20 @@ "required": true }, { - "name": "health_check_type", + "name": "app_version", "type": "TypeString", - "description": "Type of health check to perform.", - "default_value": "port", + "description": "Version of the application", "optional": true }, { - "name": "space_guid", - "type": "TypeString", - "description": "Define space guid to which app belongs", - "immutable": true, - "required": true - }, - { - "name": "buildpack", - "type": "TypeString", - "description": "Buildpack to build the app. 3 options: a) Blank means autodetection; b) A Git Url pointing to a buildpack; c) Name of an installed buildpack.", + "name": "wait_time_minutes", + "type": "TypeInt", + "description": "Define timeout to wait for the app instances to start/update/restage etc.", + "default_value": 20, "optional": true } ], "ibm_app_config_collection": [ - { - "name": "features_count", - "type": "TypeString", - "description": "Number of features associated with the collection.", - "computed": true - }, - { - "name": "properties_count", - "type": "TypeString", - "description": "Number of properties associated with the collection.", - "computed": true - }, { "name": "guid", "type": "TypeString", @@ -78891,6 +83393,18 @@ "description": "Creation time of the collection.", "computed": true }, + { + "name": "href", + "type": "TypeString", + "description": "Collection URL.", + "computed": true + }, + { + "name": "properties_count", + "type": "TypeString", + "description": "Number of properties associated with the collection.", + "computed": true + }, { "name": "name", "type": "TypeString", @@ -78910,23 +83424,37 @@ "computed": true }, { - "name": "href", + "name": "features_count", "type": "TypeString", - "description": "Collection URL.", + "description": "Number of features associated with the collection.", "computed": true } ], "ibm_app_config_environment": [ { - "name": "updated_time", + "name": "name", "type": "TypeString", - "description": "Last modified time of the environment data.", - "computed": true + "description": "Environment name.", + "required": true }, { - "name": "name", + "name": "tags", "type": "TypeString", - "description": "Environment name.", + "description": "Tags associated with the environment", + "cloud_data_type": "tags", + "optional": true + }, + { + "name": "color_code", + "type": "TypeString", + "description": "Color code to distinguish the environment.", + "optional": true + }, + { + "name": "guid", + "type": "TypeString", + "description": "GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.", + "immutable": true, "required": true }, { @@ -78948,50 +83476,24 @@ "computed": true }, { - "name": "href", + "name": "updated_time", "type": "TypeString", - "description": "Environment URL.", + "description": "Last modified time of the environment data.", "computed": true }, { - "name": "guid", - "type": "TypeString", - "description": "GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.", - "immutable": true, - "required": true - }, - { - "name": "tags", - "type": "TypeString", - "description": "Tags associated with the environment", - "cloud_data_type": "tags", - "optional": true - }, - { - "name": "color_code", + "name": "href", "type": "TypeString", - "description": "Color code to distinguish the environment.", - "optional": true + "description": "Environment URL.", + "computed": true } ], "ibm_app_config_feature": [ { - "name": "segment_exists", - "type": "TypeBool", - "description": "Denotes if the targeting rules are specified for the feature flag.", - "computed": true - }, - { - "name": "enabled", - "type": "TypeBool", - "description": "The state of the feature flag.", - "computed": true - }, - { - "name": "created_time", + "name": "feature_id", "type": "TypeString", - "description": "Creation time of the feature flag.", - "computed": true + "description": "Feature id.", + "required": true }, { "name": "type", @@ -79000,6 +83502,13 @@ "required": true, "options": "BOOLEAN, NUMERIC, STRING" }, + { + "name": "tags", + "type": "TypeString", + "description": "Tags associated with the feature.", + "cloud_data_type": "tags", + "optional": true + }, { "name": "collections", "type": "TypeList", @@ -79015,16 +83524,39 @@ } }, { - "name": "tags", + "name": "enabled", + "type": "TypeBool", + "description": "The state of the feature flag.", + "computed": true + }, + { + "name": "disabled_value", "type": "TypeString", - "description": "Tags associated with the feature.", - "cloud_data_type": "tags", - "optional": true + "description": "Value of the feature when it is disabled. The value can be BOOLEAN, STRING or a NUMERIC value as per the `type` attribute.", + "required": true }, { - "name": "environment_id", + "name": "updated_time", "type": "TypeString", - "description": "Environment Id.", + "description": "Last modified time of the feature flag data.", + "computed": true + }, + { + "name": "href", + "type": "TypeString", + "description": "Feature flag URL.", + "computed": true + }, + { + "name": "created_time", + "type": "TypeString", + "description": "Creation time of the feature flag.", + "computed": true + }, + { + "name": "guid", + "type": "TypeString", + "description": "GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.", "required": true }, { @@ -79039,12 +83571,6 @@ "description": "Feature description.", "optional": true }, - { - "name": "rollout_percentage", - "type": "TypeInt", - "description": "Rollout percentage of the feature.", - "optional": true - }, { "name": "segment_rules", "type": "TypeList", @@ -79088,6 +83614,18 @@ } } }, + { + "name": "segment_exists", + "type": "TypeBool", + "description": "Denotes if the targeting rules are specified for the feature flag.", + "computed": true + }, + { + "name": "environment_id", + "type": "TypeString", + "description": "Environment Id.", + "required": true + }, { "name": "name", "type": "TypeString", @@ -79095,37 +83633,62 @@ "required": true }, { - "name": "disabled_value", + "name": "rollout_percentage", + "type": "TypeInt", + "description": "Rollout percentage of the feature.", + "optional": true + } + ], + "ibm_app_config_property": [ + { + "name": "href", "type": "TypeString", - "description": "Value of the feature when it is disabled. The value can be BOOLEAN, STRING or a NUMERIC value as per the `type` attribute.", + "description": "Property URL.", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "Property name.", "required": true }, + { + "name": "tags", + "type": "TypeString", + "description": "Tags associated with the property.", + "cloud_data_type": "tags", + "optional": true + }, { "name": "updated_time", "type": "TypeString", - "description": "Last modified time of the feature flag data.", + "description": "Last modified time of the property data.", "computed": true }, { - "name": "href", + "name": "evaluation_time", "type": "TypeString", - "description": "Feature flag URL.", + "description": "The last occurrence of the property value evaluation.", "computed": true }, { - "name": "guid", + "name": "description", "type": "TypeString", - "description": "GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.", - "required": true + "description": "Property description.", + "optional": true }, { - "name": "feature_id", + "name": "value", "type": "TypeString", - "description": "Feature id.", + "description": "Value of the Property. The value can be Boolean, String or a Numeric value as per the `type` attribute.", "required": true - } - ], - "ibm_app_config_property": [ + }, + { + "name": "segment_exists", + "type": "TypeBool", + "description": "Denotes if the targeting rules are specified for the property.", + "computed": true + }, { "name": "environment_id", "type": "TypeString", @@ -79133,11 +83696,23 @@ "required": true }, { - "name": "name", + "name": "property_id", "type": "TypeString", - "description": "Property name.", + "description": "Property id.", "required": true }, + { + "name": "type", + "type": "TypeString", + "description": "Type of the Property (BOOLEAN, STRING, NUMERIC).", + "required": true + }, + { + "name": "format", + "type": "TypeString", + "description": "Format of the feature (TEXT, JSON, YAML).", + "optional": true + }, { "name": "segment_rules", "type": "TypeList", @@ -79189,24 +83764,6 @@ } } }, - { - "name": "type", - "type": "TypeString", - "description": "Type of the Property (BOOLEAN, STRING, NUMERIC).", - "required": true - }, - { - "name": "value", - "type": "TypeString", - "description": "Value of the Property. The value can be Boolean, String or a Numeric value as per the `type` attribute.", - "required": true - }, - { - "name": "format", - "type": "TypeString", - "description": "Format of the feature (TEXT, JSON, YAML).", - "optional": true - }, { "name": "created_time", "type": "TypeString", @@ -79214,56 +83771,38 @@ "computed": true }, { - "name": "updated_time", - "type": "TypeString", - "description": "Last modified time of the property data.", - "computed": true - }, - { - "name": "href", - "type": "TypeString", - "description": "Property URL.", - "computed": true - }, - { - "name": "property_id", + "name": "guid", "type": "TypeString", - "description": "Property id.", + "description": "GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.", "required": true - }, + } + ], + "ibm_app_config_segment": [ { "name": "tags", "type": "TypeString", - "description": "Tags associated with the property.", + "description": "Tags associated with the segments.", "cloud_data_type": "tags", "optional": true }, { - "name": "guid", + "name": "created_time", "type": "TypeString", - "description": "GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.", - "required": true + "description": "Creation time of the segment.", + "computed": true }, { - "name": "description", + "name": "href", "type": "TypeString", - "description": "Property description.", - "optional": true - }, - { - "name": "segment_exists", - "type": "TypeBool", - "description": "Denotes if the targeting rules are specified for the property.", + "description": "Segment URL.", "computed": true }, { - "name": "evaluation_time", + "name": "segment_id", "type": "TypeString", - "description": "The last occurrence of the property value evaluation.", - "computed": true - } - ], - "ibm_app_config_segment": [ + "description": "Segment id.", + "required": true + }, { "name": "name", "type": "TypeString", @@ -79271,10 +83810,10 @@ "required": true }, { - "name": "segment_id", + "name": "description", "type": "TypeString", - "description": "Segment id.", - "required": true + "description": "Segment description.", + "optional": true }, { "name": "updated_time", @@ -79316,34 +83855,40 @@ "type": "TypeString", "description": "GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.", "required": true - }, + } + ], + "ibm_app_config_snapshot": [ { - "name": "description", + "name": "git_branch", "type": "TypeString", - "description": "Segment description.", - "optional": true + "description": "Branch name to which you need to write or update the configuration.", + "required": true }, { - "name": "tags", + "name": "git_token", "type": "TypeString", - "description": "Tags associated with the segments.", - "cloud_data_type": "tags", - "optional": true + "description": "Git token, this needs to be provided with enough permission to write and update the file.", + "secure": true, + "required": true }, { "name": "created_time", "type": "TypeString", - "description": "Creation time of the segment.", + "description": "Creation time of the git config.", "computed": true }, { - "name": "href", + "name": "updated_time", "type": "TypeString", - "description": "Segment URL.", + "description": "Last modified time of the git config data.", "computed": true - } - ], - "ibm_app_config_snapshot": [ + }, + { + "name": "guid", + "type": "TypeString", + "description": "GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.", + "required": true + }, { "name": "git_config_id", "type": "TypeString", @@ -79351,16 +83896,15 @@ "required": true }, { - "name": "git_token", + "name": "action", "type": "TypeString", - "description": "Git token, this needs to be provided with enough permission to write and update the file.", - "secure": true, - "required": true + "description": "action promote", + "optional": true }, { - "name": "updated_time", + "name": "href", "type": "TypeString", - "description": "Last modified time of the git config data.", + "description": "Git config URL.", "computed": true }, { @@ -79383,42 +83927,6 @@ } } }, - { - "name": "git_branch", - "type": "TypeString", - "description": "Branch name to which you need to write or update the configuration.", - "required": true - }, - { - "name": "created_time", - "type": "TypeString", - "description": "Creation time of the git config.", - "computed": true - }, - { - "name": "environment_id", - "type": "TypeString", - "description": "Environment id.", - "required": true - }, - { - "name": "git_file_path", - "type": "TypeString", - "description": "Git file path, this is a path where your configuration file will be written.", - "required": true - }, - { - "name": "collection_id", - "type": "TypeString", - "description": "Collection id.", - "required": true - }, - { - "name": "href", - "type": "TypeString", - "description": "Git config URL.", - "computed": true - }, { "name": "environment", "type": "TypeList", @@ -79446,9 +83954,9 @@ } }, { - "name": "guid", + "name": "collection_id", "type": "TypeString", - "description": "GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.", + "description": "Collection id.", "required": true }, { @@ -79464,13 +83972,28 @@ "required": true }, { - "name": "action", + "name": "git_file_path", "type": "TypeString", - "description": "action promote", - "optional": true + "description": "Git file path, this is a path where your configuration file will be written.", + "required": true + }, + { + "name": "environment_id", + "type": "TypeString", + "description": "Environment id.", + "required": true } ], "ibm_app_domain_private": [ + { + "name": "tags", + "type": "TypeSet", + "cloud_data_type": "tags", + "optional": true, + "elem": { + "type": "TypeString" + } + }, { "name": "name", "type": "TypeString", @@ -79484,15 +84007,6 @@ "description": "The organization that owns the domain.", "immutable": true, "required": true - }, - { - "name": "tags", - "type": "TypeSet", - "cloud_data_type": "tags", - "optional": true, - "elem": { - "type": "TypeString" - } } ], "ibm_app_domain_shared": [ @@ -79586,6 +84100,25 @@ } ], "ibm_appid_apm": [ + { + "name": "tenant_id", + "type": "TypeString", + "description": "The AppID instance GUID", + "immutable": true, + "required": true + }, + { + "name": "enabled", + "type": "TypeBool", + "description": "`true` if APM is enabled", + "required": true + }, + { + "name": "prevent_password_with_username", + "type": "TypeBool", + "default_value": false, + "optional": true + }, { "name": "password_reuse", "type": "TypeList", @@ -79667,28 +84200,36 @@ } }, "max_items": 1 - }, + } + ], + "ibm_appid_application": [ { - "name": "tenant_id", + "name": "client_id", "type": "TypeString", - "description": "The AppID instance GUID", - "immutable": true, - "required": true + "description": "The `client_id` is a public identifier for applications", + "computed": true }, { - "name": "enabled", - "type": "TypeBool", - "description": "`true` if APM is enabled", + "name": "name", + "type": "TypeString", + "description": "The application name to be registered. Application name cannot exceed 50 characters.", "required": true }, { - "name": "prevent_password_with_username", - "type": "TypeBool", - "default_value": false, + "name": "type", + "type": "TypeString", + "description": "The type of application to be registered. Allowed types are `regularwebapp` and `singlepageapp`, default is `regularwebapp`.", + "default_value": "regularwebapp", + "immutable": true, "optional": true - } - ], - "ibm_appid_application": [ + }, + { + "name": "secret", + "type": "TypeString", + "description": "The `secret` is a secret known only to the application and the authorization server", + "secure": true, + "computed": true + }, { "name": "oauth_server_url", "type": "TypeString", @@ -79712,45 +84253,9 @@ "description": "The service `tenantId`", "immutable": true, "required": true - }, - { - "name": "client_id", - "type": "TypeString", - "description": "The `client_id` is a public identifier for applications", - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "The application name to be registered. Application name cannot exceed 50 characters.", - "required": true - }, - { - "name": "type", - "type": "TypeString", - "description": "The type of application to be registered. Allowed types are `regularwebapp` and `singlepageapp`, default is `regularwebapp`.", - "default_value": "regularwebapp", - "immutable": true, - "optional": true - }, - { - "name": "secret", - "type": "TypeString", - "description": "The `secret` is a secret known only to the application and the authorization server", - "secure": true, - "computed": true } ], "ibm_appid_application_roles": [ - { - "name": "roles", - "type": "TypeList", - "description": "A list of role IDs for roles that you want to be assigned to the application (this is different from AppID role access)", - "required": true, - "elem": { - "type": "TypeString" - } - }, { "name": "tenant_id", "type": "TypeString", @@ -79764,9 +84269,27 @@ "description": "The `client_id` is a public identifier for applications", "immutable": true, "required": true + }, + { + "name": "roles", + "type": "TypeList", + "description": "A list of role IDs for roles that you want to be assigned to the application (this is different from AppID role access)", + "required": true, + "elem": { + "type": "TypeString" + } } ], "ibm_appid_application_scopes": [ + { + "name": "scopes", + "type": "TypeList", + "description": "A `scope` is a runtime action in your application that you register with IBM Cloud App ID to create an access permission", + "required": true, + "elem": { + "type": "TypeString" + } + }, { "name": "tenant_id", "type": "TypeString", @@ -79780,15 +84303,6 @@ "description": "The `client_id` is a public identifier for applications", "immutable": true, "required": true - }, - { - "name": "scopes", - "type": "TypeList", - "description": "A `scope` is a runtime action in your application that you register with IBM Cloud App ID to create an access permission", - "required": true, - "elem": { - "type": "TypeString" - } } ], "ibm_appid_audit_status": [ @@ -79807,6 +84321,25 @@ } ], "ibm_appid_cloud_directory_template": [ + { + "name": "base64_encoded_html_body", + "type": "TypeString", + "description": "The HTML body of the email encoded in Base64", + "computed": true + }, + { + "name": "plain_text_body", + "type": "TypeString", + "description": "The text body of the email.", + "optional": true + }, + { + "name": "tenant_id", + "type": "TypeString", + "description": "The AppID instance GUID", + "immutable": true, + "required": true + }, { "name": "template_name", "type": "TypeString", @@ -79833,28 +84366,29 @@ "type": "TypeString", "description": "The HTML body of the email", "optional": true - }, + } + ], + "ibm_appid_cloud_directory_user": [ { - "name": "base64_encoded_html_body", + "name": "display_name", "type": "TypeString", - "description": "The HTML body of the email encoded in Base64", + "description": "Cloud Directory user display name", + "optional": true, "computed": true }, { - "name": "plain_text_body", + "name": "user_name", "type": "TypeString", - "description": "The text body of the email.", + "description": "Optional username", "optional": true }, { - "name": "tenant_id", + "name": "status", "type": "TypeString", - "description": "The AppID instance GUID", - "immutable": true, - "required": true - } - ], - "ibm_appid_cloud_directory_user": [ + "description": "Accepted values `PENDING` or `CONFIRMED`", + "default_value": "PENDING", + "optional": true + }, { "name": "meta", "type": "TypeList", @@ -79875,13 +84409,6 @@ } } }, - { - "name": "tenant_id", - "type": "TypeString", - "description": "The AppID instance GUID", - "immutable": true, - "required": true - }, { "name": "active", "type": "TypeBool", @@ -79890,31 +84417,17 @@ "optional": true }, { - "name": "status", - "type": "TypeString", - "description": "Accepted values `PENDING` or `CONFIRMED`", - "default_value": "PENDING", + "name": "locked_until", + "type": "TypeInt", + "description": "Integer (epoch time in milliseconds), determines till when the user account will be locked", "optional": true }, { - "name": "subject", - "type": "TypeString", - "description": "The user's identifier ('subject' in identity token)", - "computed": true - }, - { - "name": "display_name", + "name": "user_id", "type": "TypeString", - "description": "Cloud Directory user display name", - "optional": true, + "description": "Cloud Directory user ID", "computed": true }, - { - "name": "user_name", - "type": "TypeString", - "description": "Optional username", - "optional": true - }, { "name": "password", "type": "TypeString", @@ -79942,6 +84455,13 @@ } } }, + { + "name": "tenant_id", + "type": "TypeString", + "description": "The AppID instance GUID", + "immutable": true, + "required": true + }, { "name": "create_profile", "type": "TypeBool", @@ -79951,15 +84471,9 @@ "optional": true }, { - "name": "locked_until", - "type": "TypeInt", - "description": "Integer (epoch time in milliseconds), determines till when the user account will be locked", - "optional": true - }, - { - "name": "user_id", + "name": "subject", "type": "TypeString", - "description": "Cloud Directory user ID", + "description": "The user's identifier ('subject' in identity token)", "computed": true } ], @@ -79970,26 +84484,12 @@ "default_value": true, "optional": true }, - { - "name": "reset_password_enabled", - "type": "TypeBool", - "default_value": true, - "optional": true - }, { "name": "reset_password_notification_enabled", "type": "TypeBool", "default_value": true, "optional": true }, - { - "name": "identity_confirm_methods", - "type": "TypeList", - "optional": true, - "elem": { - "type": "TypeString" - } - }, { "name": "tenant_id", "type": "TypeString", @@ -79997,18 +84497,19 @@ "required": true }, { - "name": "is_active", + "name": "signup_enabled", "type": "TypeBool", - "required": true + "default_value": true, + "optional": true }, { - "name": "signup_enabled", + "name": "welcome_enabled", "type": "TypeBool", "default_value": true, "optional": true }, { - "name": "welcome_enabled", + "name": "reset_password_enabled", "type": "TypeBool", "default_value": true, "optional": true @@ -80019,10 +84520,23 @@ "default_value": "FULL", "optional": true }, + { + "name": "identity_confirm_methods", + "type": "TypeList", + "optional": true, + "elem": { + "type": "TypeString" + } + }, { "name": "identity_field", "type": "TypeString", "optional": true + }, + { + "name": "is_active", + "type": "TypeBool", + "required": true } ], "ibm_appid_idp_custom": [ @@ -80132,12 +84646,6 @@ } ], "ibm_appid_idp_saml": [ - { - "name": "is_active", - "type": "TypeBool", - "description": "SAML IDP activation", - "required": true - }, { "name": "config", "type": "TypeList", @@ -80225,16 +84733,15 @@ "description": "The AppID instance GUID", "immutable": true, "required": true + }, + { + "name": "is_active", + "type": "TypeBool", + "description": "SAML IDP activation", + "required": true } ], "ibm_appid_languages": [ - { - "name": "tenant_id", - "type": "TypeString", - "description": "The service `tenantId`", - "immutable": true, - "required": true - }, { "name": "languages", "type": "TypeList", @@ -80243,6 +84750,13 @@ "elem": { "type": "TypeString" } + }, + { + "name": "tenant_id", + "type": "TypeString", + "description": "The service `tenantId`", + "immutable": true, + "required": true } ], "ibm_appid_mfa": [ @@ -80305,6 +84819,18 @@ } ], "ibm_appid_password_regex": [ + { + "name": "error_message", + "type": "TypeString", + "description": "Custom error message", + "optional": true + }, + { + "name": "regex", + "type": "TypeString", + "description": "The escaped regex expression rule for acceptable password", + "required": true + }, { "name": "tenant_id", "type": "TypeString", @@ -80317,18 +84843,6 @@ "type": "TypeString", "description": "The regex expression rule for acceptable password encoded in base64", "computed": true - }, - { - "name": "error_message", - "type": "TypeString", - "description": "Custom error message", - "optional": true - }, - { - "name": "regex", - "type": "TypeString", - "description": "The escaped regex expression rule for acceptable password", - "required": true } ], "ibm_appid_redirect_urls": [ @@ -80350,12 +84864,6 @@ } ], "ibm_appid_role": [ - { - "name": "role_id", - "type": "TypeString", - "description": "Role ID", - "computed": true - }, { "name": "tenant_id", "type": "TypeString", @@ -80395,6 +84903,12 @@ } } } + }, + { + "name": "role_id", + "type": "TypeString", + "description": "Role ID", + "computed": true } ], "ibm_appid_theme_color": [ @@ -80431,6 +84945,13 @@ } ], "ibm_appid_token_config": [ + { + "name": "anonymous_access_enabled", + "type": "TypeBool", + "description": "The length of time for which an anonymous token is valid in seconds", + "optional": true, + "computed": true + }, { "name": "refresh_token_enabled", "type": "TypeBool", @@ -80512,13 +85033,6 @@ "type": "TypeInt", "default_value": 2592000, "optional": true - }, - { - "name": "anonymous_access_enabled", - "type": "TypeBool", - "description": "The length of time for which an anonymous token is valid in seconds", - "optional": true, - "computed": true } ], "ibm_appid_user_roles": [ @@ -80548,11 +85062,18 @@ ], "ibm_atracker_route": [ { - "name": "version", + "name": "api_version", "type": "TypeInt", - "description": "The version of the route.", + "description": "The API version of the route.", "computed": true }, + { + "name": "receive_global_events", + "type": "TypeBool", + "description": "Indicates whether or not all global events should be forwarded to this region.", + "optional": true, + "deprecated": "use rules.locations instead" + }, { "name": "created", "type": "TypeString", @@ -80567,17 +85088,17 @@ "computed": true }, { - "name": "updated", + "name": "updated_at", "type": "TypeString", "description": "The timestamp of the route last updated time.", - "computed": true, - "deprecated": "use updated_at instead" + "computed": true }, { - "name": "updated_at", + "name": "updated", "type": "TypeString", "description": "The timestamp of the route last updated time.", - "computed": true + "computed": true, + "deprecated": "use updated_at instead" }, { "name": "name", @@ -80588,20 +85109,6 @@ "max_length": 1000, "matches": "^[a-zA-Z0-9 -._:]+$" }, - { - "name": "receive_global_events", - "type": "TypeBool", - "description": "Indicates whether or not all global events should be forwarded to this region.", - "optional": true, - "deprecated": "use rules.locations instead" - }, - { - "name": "crn", - "type": "TypeString", - "description": "The crn of the route resource.", - "cloud_data_type": "crn", - "computed": true - }, { "name": "rules", "type": "TypeList", @@ -80629,9 +85136,16 @@ } }, { - "name": "api_version", + "name": "crn", + "type": "TypeString", + "description": "The crn of the route resource.", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "version", "type": "TypeInt", - "description": "The API version of the route.", + "description": "The version of the route.", "computed": true } ], @@ -80685,15 +85199,6 @@ } ], "ibm_atracker_target": [ - { - "name": "name", - "type": "TypeString", - "description": "The name of the target. The name must be 1000 characters or less, and cannot include any special characters other than `(space) - . _ :`.", - "required": true, - "min_length": 1, - "max_length": 1000, - "matches": "^[a-zA-Z0-9 -._:]+$" - }, { "name": "cos_endpoint", "type": "TypeList", @@ -80735,28 +85240,58 @@ "max_items": 1 }, { - "name": "region", + "name": "cos_write_status", + "type": "TypeList", + "description": "The status of the write attempt with the provided cos_endpoint parameters.", + "computed": true, + "elem": { + "last_failure": { + "name": "last_failure", + "type": "TypeString", + "description": "The timestamp of the failure.", + "optional": true + }, + "reason_for_last_failure": { + "name": "reason_for_last_failure", + "type": "TypeString", + "description": "Detailed description of the cause of the failure.", + "optional": true + }, + "status": { + "name": "status", + "type": "TypeString", + "description": "The status such as failed or success.", + "optional": true + } + }, + "deprecated": "use write_status instead" + }, + { + "name": "created", "type": "TypeString", - "description": "Include this optional field if you want to create a target in a different region other than the one you are connected.", + "description": "The timestamp of the target creation time.", + "computed": true, + "deprecated": "use created_at instead" + }, + { + "name": "target_type", + "type": "TypeString", + "description": "The type of the target. It can be cloud_object_storage, logdna or event_streams. Based on this type you must include cos_endpoint, logdna_endpoint or eventstreams_endpoint.", "immutable": true, - "min_length": 3, - "max_length": 1000, - "matches": "^[a-zA-Z0-9 -._:]+$", - "optional": true + "required": true, + "options": "cloud_object_storage, logdna, event_streams" }, { - "name": "encrypt_key", + "name": "encryption_key", "type": "TypeString", "description": "The encryption key that is used to encrypt events before Activity Tracker services buffer them on storage. This credential is masked in the response.", - "computed": true, - "deprecated": "use encryption_key instead" + "computed": true }, { - "name": "updated", + "name": "created_at", "type": "TypeString", - "description": "The timestamp of the target last updated time.", - "computed": true, - "deprecated": "use updated_at instead" + "description": "The timestamp of the target creation time.", + "computed": true }, { "name": "api_version", @@ -80765,12 +85300,13 @@ "computed": true }, { - "name": "target_type", + "name": "name", "type": "TypeString", - "description": "The type of the target. It can be cloud_object_storage, logdna or event_streams. Based on this type you must include cos_endpoint, logdna_endpoint or eventstreams_endpoint.", - "immutable": true, + "description": "The name of the target. The name must be 1000 characters or less, and cannot include any special characters other than `(space) - . _ :`.", "required": true, - "options": "cloud_object_storage, logdna, event_streams" + "min_length": 1, + "max_length": 1000, + "matches": "^[a-zA-Z0-9 -._:]+$" }, { "name": "crn", @@ -80780,10 +85316,11 @@ "computed": true }, { - "name": "encryption_key", + "name": "encrypt_key", "type": "TypeString", "description": "The encryption key that is used to encrypt events before Activity Tracker services buffer them on storage. This credential is masked in the response.", - "computed": true + "computed": true, + "deprecated": "use encryption_key instead" }, { "name": "write_status", @@ -80812,50 +85349,11 @@ } }, { - "name": "created", - "type": "TypeString", - "description": "The timestamp of the target creation time.", - "computed": true, - "deprecated": "use created_at instead" - }, - { - "name": "updated_at", + "name": "updated", "type": "TypeString", "description": "The timestamp of the target last updated time.", - "computed": true - }, - { - "name": "cos_write_status", - "type": "TypeList", - "description": "The status of the write attempt with the provided cos_endpoint parameters.", "computed": true, - "elem": { - "last_failure": { - "name": "last_failure", - "type": "TypeString", - "description": "The timestamp of the failure.", - "optional": true - }, - "reason_for_last_failure": { - "name": "reason_for_last_failure", - "type": "TypeString", - "description": "Detailed description of the cause of the failure.", - "optional": true - }, - "status": { - "name": "status", - "type": "TypeString", - "description": "The status such as failed or success.", - "optional": true - } - }, - "deprecated": "use write_status instead" - }, - { - "name": "created_at", - "type": "TypeString", - "description": "The timestamp of the target creation time.", - "computed": true + "deprecated": "use updated_at instead" }, { "name": "logdna_endpoint", @@ -80915,9 +85413,92 @@ } }, "max_items": 1 + }, + { + "name": "region", + "type": "TypeString", + "description": "Include this optional field if you want to create a target in a different region other than the one you are connected.", + "immutable": true, + "min_length": 3, + "max_length": 1000, + "matches": "^[a-zA-Z0-9 -._:]+$", + "optional": true + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "The timestamp of the target last updated time.", + "computed": true } ], "ibm_cbr_rule": [ + { + "name": "last_modified_by_id", + "type": "TypeString", + "description": "IAM ID of the user or service which modified the resource.", + "computed": true + }, + { + "name": "version", + "type": "TypeString", + "computed": true + }, + { + "name": "contexts", + "type": "TypeList", + "description": "The contexts this rule applies to.", + "required": true, + "elem": { + "attributes": { + "name": "attributes", + "type": "TypeList", + "description": "The attributes.", + "required": true, + "elem": { + "name": { + "name": "name", + "type": "TypeString", + "description": "The attribute name.", + "required": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "The attribute value.", + "required": true + } + } + } + } + }, + { + "name": "crn", + "type": "TypeString", + "description": "The rule CRN.", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "x_correlation_id", + "type": "TypeString", + "description": "The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this headers is not supplied in a request, the service generates a random (version 4) UUID.", + "min_length": 1, + "max_length": 1024, + "matches": "^[a-zA-Z0-9 ,\\-_]+$", + "optional": true + }, + { + "name": "href", + "type": "TypeString", + "description": "The href link to the resource.", + "computed": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "The time the resource was created.", + "computed": true + }, { "name": "operations", "type": "TypeList", @@ -80954,6 +85535,21 @@ "description": "IAM ID of the user or service which created the resource.", "computed": true }, + { + "name": "transaction_id", + "type": "TypeString", + "description": "The `Transaction-Id` header behaves as the `X-Correlation-Id` header. It is supported for backward compatibility with other IBM platform services that support the `Transaction-Id` header only. If both `X-Correlation-Id` and `Transaction-Id` are provided, `X-Correlation-Id` has the precedence over `Transaction-Id`.", + "min_length": 1, + "max_length": 1024, + "matches": "^[a-zA-Z0-9 ,\\-_]+$", + "optional": true + }, + { + "name": "last_modified_at", + "type": "TypeString", + "description": "The last time the resource was modified.", + "computed": true + }, { "name": "description", "type": "TypeString", @@ -80962,34 +85558,6 @@ "matches": "^[\\x20-\\xFE]*$", "optional": true }, - { - "name": "contexts", - "type": "TypeList", - "description": "The contexts this rule applies to.", - "required": true, - "elem": { - "attributes": { - "name": "attributes", - "type": "TypeList", - "description": "The attributes.", - "required": true, - "elem": { - "name": { - "name": "name", - "type": "TypeString", - "description": "The attribute name.", - "required": true - }, - "value": { - "name": "value", - "type": "TypeString", - "description": "The attribute value.", - "required": true - } - } - } - } - }, { "name": "resources", "type": "TypeList", @@ -81049,63 +85617,21 @@ } } } - }, - { - "name": "crn", - "type": "TypeString", - "description": "The rule CRN.", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "last_modified_by_id", - "type": "TypeString", - "description": "IAM ID of the user or service which modified the resource.", - "computed": true - }, - { - "name": "version", - "type": "TypeString", - "computed": true - }, - { - "name": "x_correlation_id", - "type": "TypeString", - "description": "The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this headers is not supplied in a request, the service generates a random (version 4) UUID.", - "min_length": 1, - "max_length": 1024, - "matches": "^[a-zA-Z0-9 ,\\-_]+$", - "optional": true - }, - { - "name": "transaction_id", - "type": "TypeString", - "description": "The `Transaction-Id` header behaves as the `X-Correlation-Id` header. It is supported for backward compatibility with other IBM platform services that support the `Transaction-Id` header only. If both `X-Correlation-Id` and `Transaction-Id` are provided, `X-Correlation-Id` has the precedence over `Transaction-Id`.", - "min_length": 1, - "max_length": 1024, - "matches": "^[a-zA-Z0-9 ,\\-_]+$", - "optional": true - }, + } + ], + "ibm_cbr_zone": [ { - "name": "href", - "type": "TypeString", - "description": "The href link to the resource.", + "name": "address_count", + "type": "TypeInt", + "description": "The number of addresses in the zone.", "computed": true }, { - "name": "last_modified_at", + "name": "created_by_id", "type": "TypeString", - "description": "The last time the resource was modified.", + "description": "IAM ID of the user or service which created the resource.", "computed": true }, - { - "name": "created_at", - "type": "TypeString", - "description": "The time the resource was created.", - "computed": true - } - ], - "ibm_cbr_zone": [ { "name": "account_id", "type": "TypeString", @@ -81115,24 +85641,6 @@ "max_length": 128, "matches": "^[a-zA-Z0-9\\-]+$" }, - { - "name": "crn", - "type": "TypeString", - "description": "The zone CRN.", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "excluded_count", - "type": "TypeInt", - "description": "The number of excluded addresses in the zone.", - "computed": true - }, - { - "name": "version", - "type": "TypeString", - "computed": true - }, { "name": "transaction_id", "type": "TypeString", @@ -81149,40 +85657,27 @@ "computed": true }, { - "name": "last_modified_by_id", + "name": "last_modified_at", "type": "TypeString", - "description": "IAM ID of the user or service which modified the resource.", + "description": "The last time the resource was modified.", "computed": true }, { - "name": "description", + "name": "x_correlation_id", "type": "TypeString", - "description": "The description of the zone.", - "max_length": 300, - "matches": "^[\\x20-\\xFE]*$", + "description": "The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this headers is not supplied in a request, the service generates a random (version 4) UUID.", + "min_length": 1, + "max_length": 1024, + "matches": "^[a-zA-Z0-9 ,\\-_]+$", "optional": true }, { - "name": "address_count", - "type": "TypeInt", - "description": "The number of addresses in the zone.", - "computed": true - }, - { - "name": "last_modified_at", + "name": "crn", "type": "TypeString", - "description": "The last time the resource was modified.", + "description": "The zone CRN.", + "cloud_data_type": "crn", "computed": true }, - { - "name": "name", - "type": "TypeString", - "description": "The name of the zone.", - "required": true, - "min_length": 1, - "max_length": 128, - "matches": "^[a-zA-Z0-9 \\-_]+$" - }, { "name": "addresses", "type": "TypeList", @@ -81263,45 +85758,132 @@ } }, { - "name": "x_correlation_id", + "name": "excluded_count", + "type": "TypeInt", + "description": "The number of excluded addresses in the zone.", + "computed": true + }, + { + "name": "href", "type": "TypeString", - "description": "The supplied or generated value of this header is logged for a request and repeated in a response header for the corresponding response. The same value is used for downstream requests and retries of those requests. If a value of this headers is not supplied in a request, the service generates a random (version 4) UUID.", + "description": "The href link to the resource.", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "The name of the zone.", + "required": true, "min_length": 1, - "max_length": 1024, - "matches": "^[a-zA-Z0-9 ,\\-_]+$", + "max_length": 128, + "matches": "^[a-zA-Z0-9 \\-_]+$" + }, + { + "name": "description", + "type": "TypeString", + "description": "The description of the zone.", + "max_length": 300, + "matches": "^[\\x20-\\xFE]*$", "optional": true }, { - "name": "href", + "name": "last_modified_by_id", "type": "TypeString", - "description": "The href link to the resource.", + "description": "IAM ID of the user or service which modified the resource.", "computed": true }, { - "name": "created_by_id", + "name": "version", "type": "TypeString", - "description": "IAM ID of the user or service which created the resource.", "computed": true } ], "ibm_cd_tekton_pipeline": [ { - "name": "pipeline_id", + "name": "status", "type": "TypeString", - "description": "String.", - "immutable": true, - "required": true + "description": "Pipeline status.", + "computed": true }, { - "name": "name", + "name": "toolchain", + "type": "TypeList", + "description": "Toolchain object containing references to the parent toolchain.", + "computed": true, + "elem": { + "crn": { + "name": "crn", + "type": "TypeString", + "description": "The CRN for the toolchain that contains the Tekton pipeline.", + "required": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "UUID.", + "required": true + } + } + }, + { + "name": "properties", + "type": "TypeList", + "description": "Tekton pipeline's environment properties.", + "computed": true, + "elem": { + "enum": { + "name": "enum", + "type": "TypeList", + "description": "Options for `single_select` property type. Only needed when using `single_select` property type.", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + "href": { + "name": "href", + "type": "TypeString", + "description": "API URL for interacting with the property.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Property name.", + "immutable": true, + "required": true + }, + "path": { + "name": "path", + "type": "TypeString", + "description": "A dot notation path for `integration` type properties only, that selects a value from the tool integration. If left blank the full tool integration data will be used.", + "optional": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "Property type.", + "immutable": true, + "required": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "Property value. Any string value is valid.", + "optional": true + } + } + }, + { + "name": "href", "type": "TypeString", - "description": "String.", + "description": "API URL for interacting with the pipeline.", "computed": true }, { - "name": "created_at", - "type": "TypeString", - "description": "Standard RFC 3339 Date Time String.", + "name": "build_number", + "type": "TypeInt", + "description": "The latest pipeline run build number. If this property is absent, the pipeline hasn't had any pipeline runs.", "computed": true }, { @@ -81311,10 +85893,17 @@ "computed": true }, { - "name": "build_number", + "name": "next_build_number", "type": "TypeInt", - "description": "The latest pipeline run build number. If this property is absent, the pipeline hasn't had any pipeline runs.", - "computed": true + "description": "The build number that will be used for the next pipeline run.", + "optional": true + }, + { + "name": "enable_notifications", + "type": "TypeBool", + "description": "Flag whether to enable notifications for this pipeline. When enabled, pipeline run events will be published on all slack integration specified channels in the parent toolchain. If omitted, this feature is disabled by default.", + "default_value": false, + "optional": true }, { "name": "enable_partial_cloning", @@ -81323,6 +85912,19 @@ "default_value": false, "optional": true }, + { + "name": "pipeline_id", + "type": "TypeString", + "description": "String.", + "immutable": true, + "required": true + }, + { + "name": "name", + "type": "TypeString", + "description": "String.", + "computed": true + }, { "name": "resource_group", "type": "TypeList", @@ -81339,24 +85941,43 @@ } }, { - "name": "toolchain", + "name": "updated_at", + "type": "TypeString", + "description": "Standard RFC 3339 Date Time String.", + "computed": true + }, + { + "name": "enabled", + "type": "TypeBool", + "description": "Flag whether this pipeline is enabled.", + "computed": true + }, + { + "name": "worker", "type": "TypeList", - "description": "Toolchain object containing references to the parent toolchain.", - "computed": true, + "description": "Details of the worker used to run the pipeline.", + "optional": true, "elem": { - "crn": { - "name": "crn", - "type": "TypeString", - "description": "The CRN for the toolchain that contains the Tekton pipeline.", - "required": true - }, "id": { "name": "id", "type": "TypeString", - "description": "UUID.", + "description": "ID of the worker.", "required": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Name of the worker. Computed based on the worker ID.", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "Type of the worker. Computed based on the worker ID.", + "computed": true } - } + }, + "max_items": 1 }, { "name": "definitions", @@ -81444,9 +86065,9 @@ } }, { - "name": "href", + "name": "created_at", "type": "TypeString", - "description": "API URL for interacting with the pipeline.", + "description": "Standard RFC 3339 Date Time String.", "computed": true }, { @@ -81727,116 +86348,15 @@ "max_items": 1 } } - }, - { - "name": "enabled", - "type": "TypeBool", - "description": "Flag whether this pipeline is enabled.", - "computed": true - }, - { - "name": "worker", - "type": "TypeList", - "description": "Details of the worker used to run the pipeline.", - "optional": true, - "elem": { - "id": { - "name": "id", - "type": "TypeString", - "description": "ID of the worker.", - "required": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Name of the worker. Computed based on the worker ID.", - "computed": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "Type of the worker. Computed based on the worker ID.", - "computed": true - } - }, - "max_items": 1 - }, - { - "name": "next_build_number", - "type": "TypeInt", - "description": "The build number that will be used for the next pipeline run.", - "optional": true - }, - { - "name": "enable_notifications", - "type": "TypeBool", - "description": "Flag whether to enable notifications for this pipeline. When enabled, pipeline run events will be published on all slack integration specified channels in the parent toolchain. If omitted, this feature is disabled by default.", - "default_value": false, - "optional": true - }, - { - "name": "status", - "type": "TypeString", - "description": "Pipeline status.", - "computed": true - }, + } + ], + "ibm_cd_tekton_pipeline_definition": [ { - "name": "updated_at", + "name": "definition_id", "type": "TypeString", - "description": "Standard RFC 3339 Date Time String.", + "description": "The aggregated definition ID.", "computed": true }, - { - "name": "properties", - "type": "TypeList", - "description": "Tekton pipeline's environment properties.", - "computed": true, - "elem": { - "enum": { - "name": "enum", - "type": "TypeList", - "description": "Options for `single_select` property type. Only needed when using `single_select` property type.", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - "href": { - "name": "href", - "type": "TypeString", - "description": "API URL for interacting with the property.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Property name.", - "immutable": true, - "required": true - }, - "path": { - "name": "path", - "type": "TypeString", - "description": "A dot notation path for `integration` type properties only, that selects a value from the tool integration. If left blank the full tool integration data will be used.", - "optional": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "Property type.", - "immutable": true, - "required": true - }, - "value": { - "name": "value", - "type": "TypeString", - "description": "Property value. Any string value is valid.", - "optional": true - } - } - } - ], - "ibm_cd_tekton_pipeline_definition": [ { "name": "pipeline_id", "type": "TypeString", @@ -81917,15 +86437,15 @@ "type": "TypeString", "description": "API URL for interacting with the definition.", "computed": true - }, - { - "name": "definition_id", - "type": "TypeString", - "description": "The aggregated definition ID.", - "computed": true } ], "ibm_cd_tekton_pipeline_property": [ + { + "name": "href", + "type": "TypeString", + "description": "API URL for interacting with the property.", + "computed": true + }, { "name": "pipeline_id", "type": "TypeString", @@ -81978,33 +86498,18 @@ "max_length": 4096, "matches": "^[-0-9a-zA-Z_.]*$", "optional": true - }, - { - "name": "href", - "type": "TypeString", - "description": "API URL for interacting with the property.", - "computed": true } ], "ibm_cd_tekton_pipeline_trigger": [ { - "name": "event_listener", + "name": "pipeline_id", "type": "TypeString", - "description": "Event listener name. The name of the event listener to which the trigger is associated. The event listeners are defined in the definition repositories of the Tekton pipeline.", + "description": "The Tekton pipeline ID.", + "immutable": true, "required": true, - "min_length": 1, - "max_length": 253, - "matches": "^[-0-9a-zA-Z_.]{1,253}$" - }, - { - "name": "tags", - "type": "TypeList", - "description": "Optional trigger tags array.", - "cloud_data_type": "tags", - "optional": true, - "elem": { - "type": "TypeString" - } + "min_length": 36, + "max_length": 36, + "matches": "^[-0-9a-z]+$" }, { "name": "source", @@ -82082,6 +86587,29 @@ "description": "The Trigger ID.", "computed": true }, + { + "name": "type", + "type": "TypeString", + "description": "Trigger type.", + "required": true, + "options": "generic, manual, scm, timer" + }, + { + "name": "event_listener", + "type": "TypeString", + "description": "Event listener name. The name of the event listener to which the trigger is associated. The event listeners are defined in the definition repositories of the Tekton pipeline.", + "required": true, + "min_length": 1, + "max_length": 253, + "matches": "^[-0-9a-zA-Z_.]{1,253}$" + }, + { + "name": "enabled", + "type": "TypeBool", + "description": "Flag whether the trigger is enabled.", + "default_value": true, + "optional": true + }, { "name": "events", "type": "TypeList", @@ -82091,6 +86619,19 @@ "type": "TypeString" } }, + { + "name": "webhook_url", + "type": "TypeString", + "description": "Webhook URL that can be used to trigger pipeline runs.", + "computed": true + }, + { + "name": "favorite", + "type": "TypeBool", + "description": "Mark the trigger as a favorite.", + "default_value": false, + "optional": true + }, { "name": "timezone", "type": "TypeString", @@ -82100,6 +86641,51 @@ "matches": "^[-0-9a-zA-Z+_., \\/]{1,253}$", "optional": true }, + { + "name": "href", + "type": "TypeString", + "description": "API URL for interacting with the trigger. Only included when fetching the list of pipeline triggers.", + "computed": true + }, + { + "name": "secret", + "type": "TypeList", + "description": "Only needed for generic webhook trigger type. Secret used to start generic webhook trigger.", + "optional": true, + "elem": { + "algorithm": { + "name": "algorithm", + "type": "TypeString", + "description": "Algorithm used for `digest_matches` secret type. Only needed for `digest_matches` secret type.", + "optional": true + }, + "key_name": { + "name": "key_name", + "type": "TypeString", + "description": "Secret name, not needed if type is `internal_validation`.", + "optional": true + }, + "source": { + "name": "source", + "type": "TypeString", + "description": "Secret location, not needed if secret type is `internal_validation`.", + "optional": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "Secret type.", + "required": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "Secret value, not needed if secret type is `internal_validation`.", + "optional": true + } + }, + "max_items": 1 + }, { "name": "properties", "type": "TypeList", @@ -82150,14 +86736,23 @@ } }, { - "name": "pipeline_id", + "name": "name", "type": "TypeString", - "description": "The Tekton pipeline ID.", - "immutable": true, + "description": "Trigger name.", "required": true, - "min_length": 36, - "max_length": 36, - "matches": "^[-0-9a-z]+$" + "min_length": 1, + "max_length": 253, + "matches": "^([a-zA-Z0-9]{1,2}|[a-zA-Z0-9][0-9a-zA-Z-_.: \\/\\(\\)\\[\\]]{1,251}[a-zA-Z0-9])$" + }, + { + "name": "tags", + "type": "TypeList", + "description": "Optional trigger tags array.", + "cloud_data_type": "tags", + "optional": true, + "elem": { + "type": "TypeString" + } }, { "name": "worker", @@ -82192,87 +86787,6 @@ "description": "Defines the maximum number of concurrent runs for this trigger. If omitted then the concurrency limit is disabled for this trigger.", "optional": true }, - { - "name": "enabled", - "type": "TypeBool", - "description": "Flag whether the trigger is enabled.", - "default_value": true, - "optional": true - }, - { - "name": "href", - "type": "TypeString", - "description": "API URL for interacting with the trigger. Only included when fetching the list of pipeline triggers.", - "computed": true - }, - { - "name": "secret", - "type": "TypeList", - "description": "Only needed for generic webhook trigger type. Secret used to start generic webhook trigger.", - "optional": true, - "elem": { - "algorithm": { - "name": "algorithm", - "type": "TypeString", - "description": "Algorithm used for `digest_matches` secret type. Only needed for `digest_matches` secret type.", - "optional": true - }, - "key_name": { - "name": "key_name", - "type": "TypeString", - "description": "Secret name, not needed if type is `internal_validation`.", - "optional": true - }, - "source": { - "name": "source", - "type": "TypeString", - "description": "Secret location, not needed if secret type is `internal_validation`.", - "optional": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "Secret type.", - "required": true - }, - "value": { - "name": "value", - "type": "TypeString", - "description": "Secret value, not needed if secret type is `internal_validation`.", - "optional": true - } - }, - "max_items": 1 - }, - { - "name": "webhook_url", - "type": "TypeString", - "description": "Webhook URL that can be used to trigger pipeline runs.", - "computed": true - }, - { - "name": "type", - "type": "TypeString", - "description": "Trigger type.", - "required": true, - "options": "generic, manual, scm, timer" - }, - { - "name": "name", - "type": "TypeString", - "description": "Trigger name.", - "required": true, - "min_length": 1, - "max_length": 253, - "matches": "^([a-zA-Z0-9]{1,2}|[a-zA-Z0-9][0-9a-zA-Z-_.: \\/\\(\\)\\[\\]]{1,251}[a-zA-Z0-9])$" - }, - { - "name": "favorite", - "type": "TypeBool", - "description": "Mark the trigger as a favorite.", - "default_value": false, - "optional": true - }, { "name": "cron", "type": "TypeString", @@ -82284,22 +86798,6 @@ } ], "ibm_cd_tekton_pipeline_trigger_property": [ - { - "name": "type", - "type": "TypeString", - "description": "Property type.", - "immutable": true, - "required": true, - "options": "appconfig, integration, secure, single_select, text" - }, - { - "name": "path", - "type": "TypeString", - "description": "A dot notation path for `integration` type properties only, that selects a value from the tool integration. If left blank the full tool integration data will be used.", - "max_length": 4096, - "matches": "^[-0-9a-zA-Z_.]*$", - "optional": true - }, { "name": "href", "type": "TypeString", @@ -82352,17 +86850,25 @@ "elem": { "type": "TypeString" } - } - ], - "ibm_cd_toolchain": [ + }, { - "name": "description", + "name": "type", "type": "TypeString", - "description": "Describes the toolchain.", - "max_length": 500, - "matches": "^(.*?)$", - "optional": true + "description": "Property type.", + "immutable": true, + "required": true, + "options": "appconfig, integration, secure, single_select, text" }, + { + "name": "path", + "type": "TypeString", + "description": "A dot notation path for `integration` type properties only, that selects a value from the tool integration. If left blank the full tool integration data will be used.", + "max_length": 4096, + "matches": "^[-0-9a-zA-Z_.]*$", + "optional": true + } + ], + "ibm_cd_toolchain": [ { "name": "account_id", "type": "TypeString", @@ -82377,9 +86883,9 @@ "computed": true }, { - "name": "created_at", + "name": "href", "type": "TypeString", - "description": "Toolchain creation timestamp.", + "description": "URI that can be used to retrieve toolchain.", "computed": true }, { @@ -82388,6 +86894,36 @@ "description": "Latest toolchain update timestamp.", "computed": true }, + { + "name": "description", + "type": "TypeString", + "description": "Describes the toolchain.", + "max_length": 500, + "matches": "^(.*?)$", + "optional": true + }, + { + "name": "resource_group_id", + "type": "TypeString", + "description": "Resource group where the toolchain is located.", + "immutable": true, + "required": true, + "min_length": 32, + "max_length": 32, + "matches": "^[0-9a-f]{32}$" + }, + { + "name": "ui_href", + "type": "TypeString", + "description": "URL of a user-facing user interface for this toolchain.", + "computed": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "Toolchain creation timestamp.", + "computed": true + }, { "name": "created_by", "type": "TypeString", @@ -82413,61 +86949,38 @@ "max_length": 128, "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$" }, - { - "name": "resource_group_id", - "type": "TypeString", - "description": "Resource group where toolchain will be created.", - "immutable": true, - "required": true, - "min_length": 32, - "max_length": 32, - "matches": "^[0-9a-f]{32}$" - }, { "name": "location", "type": "TypeString", "description": "Toolchain region.", "cloud_data_type": "region", "computed": true - }, + } + ], + "ibm_cd_toolchain_tool_appconfig": [ { - "name": "href", + "name": "toolchain_id", "type": "TypeString", - "description": "URI that can be used to retrieve toolchain.", - "computed": true + "description": "ID of the toolchain to bind the tool to.", + "immutable": true, + "required": true, + "min_length": 36, + "max_length": 36, + "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" }, { - "name": "ui_href", + "name": "name", "type": "TypeString", - "description": "URL of a user-facing user interface for this toolchain.", - "computed": true - } - ], - "ibm_cd_toolchain_tool_appconfig": [ - { - "name": "referent", - "type": "TypeList", - "description": "Information on URIs to access this resource through the UI or API.", - "computed": true, - "elem": { - "api_href": { - "name": "api_href", - "type": "TypeString", - "description": "URI representing this resource through an API.", - "optional": true - }, - "ui_href": { - "name": "ui_href", - "type": "TypeString", - "description": "URI representing this resource through the UI.", - "optional": true - } - } + "description": "Name of the tool.", + "max_length": 128, + "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", + "optional": true }, { - "name": "updated_at", + "name": "crn", "type": "TypeString", - "description": "Latest tool update timestamp.", + "description": "Tool CRN.", + "cloud_data_type": "crn", "computed": true }, { @@ -82528,14 +87041,6 @@ "max_items": 1, "min_items": 1 }, - { - "name": "name", - "type": "TypeString", - "description": "Name of the tool.", - "max_length": 128, - "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", - "optional": true - }, { "name": "resource_group_id", "type": "TypeString", @@ -82544,46 +87049,81 @@ "computed": true }, { - "name": "href", + "name": "toolchain_crn", "type": "TypeString", - "description": "URI representing the tool.", + "description": "CRN of toolchain which the tool is bound to.", "computed": true }, { - "name": "toolchain_id", + "name": "href", "type": "TypeString", - "description": "ID of the toolchain to bind the tool to.", - "immutable": true, - "required": true, - "min_length": 36, - "max_length": 36, - "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" + "description": "URI representing the tool.", + "computed": true }, { - "name": "crn", - "type": "TypeString", - "description": "Tool CRN.", - "cloud_data_type": "crn", - "computed": true + "name": "referent", + "type": "TypeList", + "description": "Information on URIs to access this resource through the UI or API.", + "computed": true, + "elem": { + "api_href": { + "name": "api_href", + "type": "TypeString", + "description": "URI representing this resource through an API.", + "optional": true + }, + "ui_href": { + "name": "ui_href", + "type": "TypeString", + "description": "URI representing this resource through the UI.", + "optional": true + } + } }, { - "name": "toolchain_crn", + "name": "updated_at", "type": "TypeString", - "description": "CRN of toolchain which the tool is bound to.", + "description": "Latest tool update timestamp.", "computed": true } ], "ibm_cd_toolchain_tool_artifactory": [ { - "name": "toolchain_crn", + "name": "href", "type": "TypeString", - "description": "CRN of toolchain which the tool is bound to.", + "description": "URI representing the tool.", "computed": true }, { - "name": "updated_at", + "name": "referent", + "type": "TypeList", + "description": "Information on URIs to access this resource through the UI or API.", + "computed": true, + "elem": { + "api_href": { + "name": "api_href", + "type": "TypeString", + "description": "URI representing this resource through an API.", + "optional": true + }, + "ui_href": { + "name": "ui_href", + "type": "TypeString", + "description": "URI representing this resource through the UI.", + "optional": true + } + } + }, + { + "name": "state", "type": "TypeString", - "description": "Latest tool update timestamp.", + "description": "Current configuration state of the tool.", + "computed": true + }, + { + "name": "tool_id", + "type": "TypeString", + "description": "Tool ID.", "computed": true }, { @@ -82596,6 +87136,14 @@ "max_length": 36, "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" }, + { + "name": "name", + "type": "TypeString", + "description": "Name of the tool.", + "max_length": 128, + "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", + "optional": true + }, { "name": "parameters", "type": "TypeList", @@ -82667,14 +87215,6 @@ "max_items": 1, "min_items": 1 }, - { - "name": "name", - "type": "TypeString", - "description": "Name of the tool.", - "max_length": 128, - "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", - "optional": true - }, { "name": "resource_group_id", "type": "TypeString", @@ -82690,30 +87230,24 @@ "computed": true }, { - "name": "href", + "name": "toolchain_crn", "type": "TypeString", - "description": "URI representing the tool.", + "description": "CRN of toolchain which the tool is bound to.", "computed": true }, { - "name": "referent", - "type": "TypeList", - "description": "Information on URIs to access this resource through the UI or API.", - "computed": true, - "elem": { - "api_href": { - "name": "api_href", - "type": "TypeString", - "description": "URI representing this resource through an API.", - "optional": true - }, - "ui_href": { - "name": "ui_href", - "type": "TypeString", - "description": "URI representing this resource through the UI.", - "optional": true - } - } + "name": "updated_at", + "type": "TypeString", + "description": "Latest tool update timestamp.", + "computed": true + } + ], + "ibm_cd_toolchain_tool_bitbucketgit": [ + { + "name": "href", + "type": "TypeString", + "description": "URI representing the tool.", + "computed": true }, { "name": "state", @@ -82726,34 +87260,16 @@ "type": "TypeString", "description": "Tool ID.", "computed": true - } - ], - "ibm_cd_toolchain_tool_bitbucketgit": [ - { - "name": "referent", - "type": "TypeList", - "description": "Information on URIs to access this resource through the UI or API.", - "computed": true, - "elem": { - "api_href": { - "name": "api_href", - "type": "TypeString", - "description": "URI representing this resource through an API.", - "optional": true - }, - "ui_href": { - "name": "ui_href", - "type": "TypeString", - "description": "URI representing this resource through the UI.", - "optional": true - } - } }, { - "name": "updated_at", + "name": "toolchain_id", "type": "TypeString", - "description": "Latest tool update timestamp.", - "computed": true + "description": "ID of the toolchain to bind the tool to.", + "immutable": true, + "required": true, + "min_length": 36, + "max_length": 36, + "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" }, { "name": "name", @@ -82938,36 +87454,6 @@ "description": "CRN of toolchain which the tool is bound to.", "computed": true }, - { - "name": "href", - "type": "TypeString", - "description": "URI representing the tool.", - "computed": true - }, - { - "name": "state", - "type": "TypeString", - "description": "Current configuration state of the tool.", - "computed": true - }, - { - "name": "toolchain_id", - "type": "TypeString", - "description": "ID of the toolchain to bind the tool to.", - "immutable": true, - "required": true, - "min_length": 36, - "max_length": 36, - "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" - }, - { - "name": "tool_id", - "type": "TypeString", - "description": "Tool ID.", - "computed": true - } - ], - "ibm_cd_toolchain_tool_custom": [ { "name": "referent", "type": "TypeList", @@ -82989,10 +87475,20 @@ } }, { - "name": "tool_id", + "name": "updated_at", "type": "TypeString", - "description": "Tool ID.", + "description": "Latest tool update timestamp.", "computed": true + } + ], + "ibm_cd_toolchain_tool_custom": [ + { + "name": "name", + "type": "TypeString", + "description": "Name of the tool.", + "max_length": 128, + "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", + "optional": true }, { "name": "parameters", @@ -83052,18 +87548,6 @@ "max_items": 1, "min_items": 1 }, - { - "name": "toolchain_crn", - "type": "TypeString", - "description": "CRN of toolchain which the tool is bound to.", - "computed": true - }, - { - "name": "href", - "type": "TypeString", - "description": "URI representing the tool.", - "computed": true - }, { "name": "crn", "type": "TypeString", @@ -83072,9 +87556,9 @@ "computed": true }, { - "name": "updated_at", + "name": "href", "type": "TypeString", - "description": "Latest tool update timestamp.", + "description": "URI representing the tool.", "computed": true }, { @@ -83093,50 +87577,53 @@ "max_length": 36, "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" }, - { - "name": "name", - "type": "TypeString", - "description": "Name of the tool.", - "max_length": 128, - "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", - "optional": true - }, { "name": "resource_group_id", "type": "TypeString", "description": "Resource group where the tool is located.", "cloud_data_type": "resource_group", "computed": true - } - ], - "ibm_cd_toolchain_tool_devopsinsights": [ + }, { - "name": "state", + "name": "toolchain_crn", "type": "TypeString", - "description": "Current configuration state of the tool.", + "description": "CRN of toolchain which the tool is bound to.", "computed": true }, { - "name": "name", - "type": "TypeString", - "description": "Name of the tool.", - "max_length": 128, - "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", - "optional": true + "name": "referent", + "type": "TypeList", + "description": "Information on URIs to access this resource through the UI or API.", + "computed": true, + "elem": { + "api_href": { + "name": "api_href", + "type": "TypeString", + "description": "URI representing this resource through an API.", + "optional": true + }, + "ui_href": { + "name": "ui_href", + "type": "TypeString", + "description": "URI representing this resource through the UI.", + "optional": true + } + } }, { - "name": "crn", + "name": "updated_at", "type": "TypeString", - "description": "Tool CRN.", - "cloud_data_type": "crn", + "description": "Latest tool update timestamp.", "computed": true }, { - "name": "toolchain_crn", + "name": "tool_id", "type": "TypeString", - "description": "CRN of toolchain which the tool is bound to.", + "description": "Tool ID.", "computed": true - }, + } + ], + "ibm_cd_toolchain_tool_devopsinsights": [ { "name": "href", "type": "TypeString", @@ -83144,21 +87631,11 @@ "computed": true }, { - "name": "updated_at", + "name": "state", "type": "TypeString", - "description": "Latest tool update timestamp.", + "description": "Current configuration state of the tool.", "computed": true }, - { - "name": "toolchain_id", - "type": "TypeString", - "description": "ID of the toolchain to bind the tool to.", - "immutable": true, - "required": true, - "min_length": 36, - "max_length": 36, - "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" - }, { "name": "resource_group_id", "type": "TypeString", @@ -83166,6 +87643,19 @@ "cloud_data_type": "resource_group", "computed": true }, + { + "name": "crn", + "type": "TypeString", + "description": "Tool CRN.", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "toolchain_crn", + "type": "TypeString", + "description": "CRN of toolchain which the tool is bound to.", + "computed": true + }, { "name": "referent", "type": "TypeList", @@ -83186,14 +87676,18 @@ } } }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Latest tool update timestamp.", + "computed": true + }, { "name": "tool_id", "type": "TypeString", "description": "Tool ID.", "computed": true - } - ], - "ibm_cd_toolchain_tool_eventnotifications": [ + }, { "name": "toolchain_id", "type": "TypeString", @@ -83205,36 +87699,22 @@ "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" }, { - "name": "href", + "name": "name", "type": "TypeString", - "description": "URI representing the tool.", - "computed": true - }, - { - "name": "referent", - "type": "TypeList", - "description": "Information on URIs to access this resource through the UI or API.", - "computed": true, - "elem": { - "api_href": { - "name": "api_href", - "type": "TypeString", - "description": "URI representing this resource through an API.", - "optional": true - }, - "ui_href": { - "name": "ui_href", - "type": "TypeString", - "description": "URI representing this resource through the UI.", - "optional": true - } - } - }, + "description": "Name of the tool.", + "max_length": 128, + "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", + "optional": true + } + ], + "ibm_cd_toolchain_tool_eventnotifications": [ { - "name": "tool_id", + "name": "name", "type": "TypeString", - "description": "Tool ID.", - "computed": true + "description": "Name of the tool.", + "max_length": 128, + "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", + "optional": true }, { "name": "parameters", @@ -83258,14 +87738,6 @@ "max_items": 1, "min_items": 1 }, - { - "name": "name", - "type": "TypeString", - "description": "Name of the tool.", - "max_length": 128, - "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", - "optional": true - }, { "name": "resource_group_id", "type": "TypeString", @@ -83281,9 +87753,9 @@ "computed": true }, { - "name": "toolchain_crn", + "name": "href", "type": "TypeString", - "description": "CRN of toolchain which the tool is bound to.", + "description": "URI representing the tool.", "computed": true }, { @@ -83292,14 +87764,94 @@ "description": "Latest tool update timestamp.", "computed": true }, + { + "name": "tool_id", + "type": "TypeString", + "description": "Tool ID.", + "computed": true + }, + { + "name": "toolchain_id", + "type": "TypeString", + "description": "ID of the toolchain to bind the tool to.", + "immutable": true, + "required": true, + "min_length": 36, + "max_length": 36, + "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" + }, + { + "name": "referent", + "type": "TypeList", + "description": "Information on URIs to access this resource through the UI or API.", + "computed": true, + "elem": { + "api_href": { + "name": "api_href", + "type": "TypeString", + "description": "URI representing this resource through an API.", + "optional": true + }, + "ui_href": { + "name": "ui_href", + "type": "TypeString", + "description": "URI representing this resource through the UI.", + "optional": true + } + } + }, { "name": "state", "type": "TypeString", "description": "Current configuration state of the tool.", "computed": true + }, + { + "name": "toolchain_crn", + "type": "TypeString", + "description": "CRN of toolchain which the tool is bound to.", + "computed": true } ], "ibm_cd_toolchain_tool_githubconsolidated": [ + { + "name": "referent", + "type": "TypeList", + "description": "Information on URIs to access this resource through the UI or API.", + "computed": true, + "elem": { + "api_href": { + "name": "api_href", + "type": "TypeString", + "description": "URI representing this resource through an API.", + "optional": true + }, + "ui_href": { + "name": "ui_href", + "type": "TypeString", + "description": "URI representing this resource through the UI.", + "optional": true + } + } + }, + { + "name": "toolchain_id", + "type": "TypeString", + "description": "ID of the toolchain to bind the tool to.", + "immutable": true, + "required": true, + "min_length": 36, + "max_length": 36, + "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" + }, + { + "name": "name", + "type": "TypeString", + "description": "Name of the tool.", + "max_length": 128, + "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", + "optional": true + }, { "name": "initialization", "type": "TypeList", @@ -83324,7 +87876,7 @@ "git_id": { "name": "git_id", "type": "TypeString", - "description": "Set this value to 'github' for github.com, the GUID of an existing custom GitHub Enterprise server, or 'githubcustom'.", + "description": "Set this value to 'github' for github.com, or 'githubcustom' for a custom GitHub Enterprise server.", "immutable": true, "optional": true }, @@ -83415,62 +87967,12 @@ "description": "URI representing the tool.", "computed": true }, - { - "name": "referent", - "type": "TypeList", - "description": "Information on URIs to access this resource through the UI or API.", - "computed": true, - "elem": { - "api_href": { - "name": "api_href", - "type": "TypeString", - "description": "URI representing this resource through an API.", - "optional": true - }, - "ui_href": { - "name": "ui_href", - "type": "TypeString", - "description": "URI representing this resource through the UI.", - "optional": true - } - } - }, - { - "name": "updated_at", - "type": "TypeString", - "description": "Latest tool update timestamp.", - "computed": true - }, - { - "name": "toolchain_id", - "type": "TypeString", - "description": "ID of the toolchain to bind the tool to.", - "immutable": true, - "required": true, - "min_length": 36, - "max_length": 36, - "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" - }, - { - "name": "tool_id", - "type": "TypeString", - "description": "Tool ID.", - "computed": true - }, { "name": "state", "type": "TypeString", "description": "Current configuration state of the tool.", "computed": true }, - { - "name": "name", - "type": "TypeString", - "description": "Name of the tool.", - "max_length": 128, - "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", - "optional": true - }, { "name": "parameters", "type": "TypeList", @@ -83524,7 +88026,7 @@ "git_id": { "name": "git_id", "type": "TypeString", - "description": "Set this value to 'github' for github.com, the GUID of an existing custom GitHub Enterprise server, or 'githubcustom'.", + "description": "Set this value to 'github' for github.com, or 'githubcustom' for a custom GitHub Enterprise server.", "computed": true }, "integration_owner": { @@ -83603,19 +88105,32 @@ }, "max_items": 1, "min_items": 1 + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Latest tool update timestamp.", + "computed": true + }, + { + "name": "tool_id", + "type": "TypeString", + "description": "Tool ID.", + "computed": true } ], "ibm_cd_toolchain_tool_gitlab": [ { - "name": "toolchain_crn", + "name": "resource_group_id", "type": "TypeString", - "description": "CRN of toolchain which the tool is bound to.", + "description": "Resource group where the tool is located.", + "cloud_data_type": "resource_group", "computed": true }, { - "name": "href", + "name": "toolchain_crn", "type": "TypeString", - "description": "URI representing the tool.", + "description": "CRN of toolchain which the tool is bound to.", "computed": true }, { @@ -83624,6 +88139,32 @@ "description": "Latest tool update timestamp.", "computed": true }, + { + "name": "tool_id", + "type": "TypeString", + "description": "Tool ID.", + "computed": true + }, + { + "name": "referent", + "type": "TypeList", + "description": "Information on URIs to access this resource through the UI or API.", + "computed": true, + "elem": { + "api_href": { + "name": "api_href", + "type": "TypeString", + "description": "URI representing this resource through an API.", + "optional": true + }, + "ui_href": { + "name": "ui_href", + "type": "TypeString", + "description": "URI representing this resource through the UI.", + "optional": true + } + } + }, { "name": "state", "type": "TypeString", @@ -83640,6 +88181,14 @@ "max_length": 36, "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" }, + { + "name": "name", + "type": "TypeString", + "description": "Name of the tool.", + "max_length": 128, + "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", + "optional": true + }, { "name": "parameters", "type": "TypeList", @@ -83687,7 +88236,7 @@ "git_id": { "name": "git_id", "type": "TypeString", - "description": "Set this value to 'gitlab' for gitlab.com, the GUID of an existing custom GitLab server, or 'gitlabcustom'.", + "description": "Set this value to 'gitlab' for gitlab.com, or 'gitlabcustom' for a custom GitLab server.", "computed": true }, "integration_owner": { @@ -83767,46 +88316,6 @@ "max_items": 1, "min_items": 1 }, - { - "name": "resource_group_id", - "type": "TypeString", - "description": "Resource group where the tool is located.", - "cloud_data_type": "resource_group", - "computed": true - }, - { - "name": "crn", - "type": "TypeString", - "description": "Tool CRN.", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "referent", - "type": "TypeList", - "description": "Information on URIs to access this resource through the UI or API.", - "computed": true, - "elem": { - "api_href": { - "name": "api_href", - "type": "TypeString", - "description": "URI representing this resource through an API.", - "optional": true - }, - "ui_href": { - "name": "ui_href", - "type": "TypeString", - "description": "URI representing this resource through the UI.", - "optional": true - } - } - }, - { - "name": "tool_id", - "type": "TypeString", - "description": "Tool ID.", - "computed": true - }, { "name": "initialization", "type": "TypeList", @@ -83823,7 +88332,7 @@ "git_id": { "name": "git_id", "type": "TypeString", - "description": "Set this value to 'gitlab' for gitlab.com, the GUID of an existing custom GitLab server, or 'gitlabcustom'.", + "description": "Set this value to 'gitlab' for gitlab.com, or 'gitlabcustom' for a custom GitLab server.", "immutable": true, "optional": true }, @@ -83889,25 +88398,43 @@ "min_items": 1 }, { - "name": "name", + "name": "crn", "type": "TypeString", - "description": "Name of the tool.", - "max_length": 128, - "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", - "optional": true + "description": "Tool CRN.", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "href", + "type": "TypeString", + "description": "URI representing the tool.", + "computed": true } ], "ibm_cd_toolchain_tool_hashicorpvault": [ { - "name": "toolchain_crn", + "name": "toolchain_id", "type": "TypeString", - "description": "CRN of toolchain which the tool is bound to.", - "computed": true + "description": "ID of the toolchain to bind the tool to.", + "immutable": true, + "required": true, + "min_length": 36, + "max_length": 36, + "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" }, { - "name": "href", + "name": "name", "type": "TypeString", - "description": "URI representing the tool.", + "description": "Name of the tool.", + "max_length": 128, + "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", + "optional": true + }, + { + "name": "resource_group_id", + "type": "TypeString", + "description": "Resource group where the tool is located.", + "cloud_data_type": "resource_group", "computed": true }, { @@ -83931,20 +88458,16 @@ } }, { - "name": "tool_id", + "name": "state", "type": "TypeString", - "description": "Tool ID.", + "description": "Current configuration state of the tool.", "computed": true }, { - "name": "toolchain_id", + "name": "tool_id", "type": "TypeString", - "description": "ID of the toolchain to bind the tool to.", - "immutable": true, - "required": true, - "min_length": 36, - "max_length": 36, - "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" + "description": "Tool ID.", + "computed": true }, { "name": "parameters", @@ -84032,6 +88555,100 @@ "max_items": 1, "min_items": 1 }, + { + "name": "crn", + "type": "TypeString", + "description": "Tool CRN.", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "toolchain_crn", + "type": "TypeString", + "description": "CRN of toolchain which the tool is bound to.", + "computed": true + }, + { + "name": "href", + "type": "TypeString", + "description": "URI representing the tool.", + "computed": true + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Latest tool update timestamp.", + "computed": true + } + ], + "ibm_cd_toolchain_tool_hostedgit": [ + { + "name": "name", + "type": "TypeString", + "description": "Name of the tool.", + "max_length": 128, + "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", + "optional": true + }, + { + "name": "initialization", + "type": "TypeList", + "required": true, + "elem": { + "git_id": { + "name": "git_id", + "type": "TypeString", + "description": "Set this value to 'hostedgit' to target Git Repos and Issue Tracking.", + "immutable": true, + "optional": true + }, + "owner_id": { + "name": "owner_id", + "type": "TypeString", + "description": "The GitLab user or group that owns the repository. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.", + "immutable": true, + "optional": true + }, + "private_repo": { + "name": "private_repo", + "type": "TypeBool", + "description": "Set this value to 'true' to make the repository private when creating a new repository or when cloning or forking a repository. This parameter is not used when linking to an existing repository.", + "default_value": true, + "immutable": true, + "optional": true + }, + "repo_name": { + "name": "repo_name", + "type": "TypeString", + "description": "The name of the new GitLab repository to create. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.", + "immutable": true, + "optional": true + }, + "repo_url": { + "name": "repo_url", + "type": "TypeString", + "description": "The URL of the GitLab repository for this tool integration. This parameter is required when linking to an existing repository. The value will be computed when creating a new repository, cloning, or forking a repository.", + "immutable": true, + "optional": true + }, + "source_repo_url": { + "name": "source_repo_url", + "type": "TypeString", + "description": "The URL of the repository that you are forking or cloning. This parameter is required when forking or cloning a repository. It is not used when creating a new repository or linking to an existing repository.", + "immutable": true, + "optional": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "The operation that should be performed to initialize the new tool integration. Use 'new' or 'new_if_not_exists' to create a new git repository, 'clone' or 'clone_if_not_exists' to clone an existing repository into a new git repository, 'fork' or 'fork_if_not_exists' to fork an existing git repository, or 'link' to link to an existing git repository. If you attempt to apply a resource with type 'new', 'clone', or 'fork' when the target repo already exists, the attempt will fail. If you apply a resource with type 'new_if_not_exists`, 'clone_if_not_exists', or 'fork_if_not_exists' when the target repo already exists, the existing repo will be used as-is.", + "immutable": true, + "required": true + } + }, + "max_items": 1, + "min_items": 1 + }, { "name": "resource_group_id", "type": "TypeString", @@ -84047,12 +88664,30 @@ "computed": true }, { - "name": "name", + "name": "toolchain_crn", "type": "TypeString", - "description": "Name of the tool.", - "max_length": 128, - "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", - "optional": true + "description": "CRN of toolchain which the tool is bound to.", + "computed": true + }, + { + "name": "referent", + "type": "TypeList", + "description": "Information on URIs to access this resource through the UI or API.", + "computed": true, + "elem": { + "api_href": { + "name": "api_href", + "type": "TypeString", + "description": "URI representing this resource through an API.", + "optional": true + }, + "ui_href": { + "name": "ui_href", + "type": "TypeString", + "description": "URI representing this resource through the UI.", + "optional": true + } + } }, { "name": "updated_at", @@ -84065,9 +88700,23 @@ "type": "TypeString", "description": "Current configuration state of the tool.", "computed": true - } - ], - "ibm_cd_toolchain_tool_hostedgit": [ + }, + { + "name": "tool_id", + "type": "TypeString", + "description": "Tool ID.", + "computed": true + }, + { + "name": "toolchain_id", + "type": "TypeString", + "description": "ID of the toolchain to bind the tool to.", + "immutable": true, + "required": true, + "min_length": 36, + "max_length": 36, + "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" + }, { "name": "parameters", "type": "TypeList", @@ -84178,31 +88827,23 @@ "min_items": 1 }, { - "name": "name", - "type": "TypeString", - "description": "Name of the tool.", - "max_length": 128, - "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", - "optional": true - }, - { - "name": "resource_group_id", + "name": "href", "type": "TypeString", - "description": "Resource group where the tool is located.", - "cloud_data_type": "resource_group", + "description": "URI representing the tool.", "computed": true - }, + } + ], + "ibm_cd_toolchain_tool_jenkins": [ { - "name": "crn", + "name": "toolchain_crn", "type": "TypeString", - "description": "Tool CRN.", - "cloud_data_type": "crn", + "description": "CRN of toolchain which the tool is bound to.", "computed": true }, { - "name": "toolchain_crn", + "name": "href", "type": "TypeString", - "description": "CRN of toolchain which the tool is bound to.", + "description": "URI representing the tool.", "computed": true }, { @@ -84231,6 +88872,12 @@ "description": "Current configuration state of the tool.", "computed": true }, + { + "name": "tool_id", + "type": "TypeString", + "description": "Tool ID.", + "computed": true + }, { "name": "toolchain_id", "type": "TypeString", @@ -84242,84 +88889,26 @@ "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" }, { - "name": "href", + "name": "name", "type": "TypeString", - "description": "URI representing the tool.", - "computed": true + "description": "Name of the tool.", + "max_length": 128, + "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", + "optional": true }, { - "name": "updated_at", + "name": "crn", "type": "TypeString", - "description": "Latest tool update timestamp.", + "description": "Tool CRN.", + "cloud_data_type": "crn", "computed": true }, { - "name": "tool_id", + "name": "updated_at", "type": "TypeString", - "description": "Tool ID.", + "description": "Latest tool update timestamp.", "computed": true }, - { - "name": "initialization", - "type": "TypeList", - "required": true, - "elem": { - "git_id": { - "name": "git_id", - "type": "TypeString", - "description": "Set this value to 'hostedgit' to target Git Repos and Issue Tracking.", - "immutable": true, - "optional": true - }, - "owner_id": { - "name": "owner_id", - "type": "TypeString", - "description": "The GitLab user or group that owns the repository. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.", - "immutable": true, - "optional": true - }, - "private_repo": { - "name": "private_repo", - "type": "TypeBool", - "description": "Set this value to 'true' to make the repository private when creating a new repository or when cloning or forking a repository. This parameter is not used when linking to an existing repository.", - "default_value": true, - "immutable": true, - "optional": true - }, - "repo_name": { - "name": "repo_name", - "type": "TypeString", - "description": "The name of the new GitLab repository to create. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.", - "immutable": true, - "optional": true - }, - "repo_url": { - "name": "repo_url", - "type": "TypeString", - "description": "The URL of the GitLab repository for this tool integration. This parameter is required when linking to an existing repository. The value will be computed when creating a new repository, cloning, or forking a repository.", - "immutable": true, - "optional": true - }, - "source_repo_url": { - "name": "source_repo_url", - "type": "TypeString", - "description": "The URL of the repository that you are forking or cloning. This parameter is required when forking or cloning a repository. It is not used when creating a new repository or linking to an existing repository.", - "immutable": true, - "optional": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "The operation that should be performed to initialize the new tool integration. Use 'new' or 'new_if_not_exists' to create a new git repository, 'clone' or 'clone_if_not_exists' to clone an existing repository into a new git repository, 'fork' or 'fork_if_not_exists' to fork an existing git repository, or 'link' to link to an existing git repository. If you attempt to apply a resource with type 'new', 'clone', or 'fork' when the target repo already exists, the attempt will fail. If you apply a resource with type 'new_if_not_exists`, 'clone_if_not_exists', or 'fork_if_not_exists' when the target repo already exists, the existing repo will be used as-is.", - "immutable": true, - "required": true - } - }, - "max_items": 1, - "min_items": 1 - } - ], - "ibm_cd_toolchain_tool_jenkins": [ { "name": "parameters", "type": "TypeList", @@ -84362,40 +88951,15 @@ "max_items": 1, "min_items": 1 }, - { - "name": "name", - "type": "TypeString", - "description": "Name of the tool.", - "max_length": 128, - "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", - "optional": true - }, { "name": "resource_group_id", "type": "TypeString", "description": "Resource group where the tool is located.", "cloud_data_type": "resource_group", "computed": true - }, - { - "name": "crn", - "type": "TypeString", - "description": "Tool CRN.", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "toolchain_crn", - "type": "TypeString", - "description": "CRN of toolchain which the tool is bound to.", - "computed": true - }, - { - "name": "href", - "type": "TypeString", - "description": "URI representing the tool.", - "computed": true - }, + } + ], + "ibm_cd_toolchain_tool_jira": [ { "name": "toolchain_id", "type": "TypeString", @@ -84406,6 +88970,12 @@ "max_length": 36, "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" }, + { + "name": "href", + "type": "TypeString", + "description": "URI representing the tool.", + "computed": true + }, { "name": "referent", "type": "TypeList", @@ -84426,12 +88996,6 @@ } } }, - { - "name": "updated_at", - "type": "TypeString", - "description": "Latest tool update timestamp.", - "computed": true - }, { "name": "state", "type": "TypeString", @@ -84443,53 +89007,14 @@ "type": "TypeString", "description": "Tool ID.", "computed": true - } - ], - "ibm_cd_toolchain_tool_jira": [ - { - "name": "crn", - "type": "TypeString", - "description": "Tool CRN.", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "href", - "type": "TypeString", - "description": "URI representing the tool.", - "computed": true - }, - { - "name": "referent", - "type": "TypeList", - "description": "Information on URIs to access this resource through the UI or API.", - "computed": true, - "elem": { - "api_href": { - "name": "api_href", - "type": "TypeString", - "description": "URI representing this resource through an API.", - "optional": true - }, - "ui_href": { - "name": "ui_href", - "type": "TypeString", - "description": "URI representing this resource through the UI.", - "optional": true - } - } - }, - { - "name": "updated_at", - "type": "TypeString", - "description": "Latest tool update timestamp.", - "computed": true }, { - "name": "state", + "name": "name", "type": "TypeString", - "description": "Current configuration state of the tool.", - "computed": true + "description": "Name of the tool.", + "max_length": 128, + "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", + "optional": true }, { "name": "parameters", @@ -84527,51 +89052,12 @@ "name": "username", "type": "TypeString", "description": "The user name for your JIRA account. Optional for public projects.", - "optional": true - } - }, - "max_items": 1, - "min_items": 1 - }, - { - "name": "name", - "type": "TypeString", - "description": "Name of the tool.", - "max_length": 128, - "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", - "optional": true - }, - { - "name": "resource_group_id", - "type": "TypeString", - "description": "Resource group where the tool is located.", - "cloud_data_type": "resource_group", - "computed": true - }, - { - "name": "toolchain_crn", - "type": "TypeString", - "description": "CRN of toolchain which the tool is bound to.", - "computed": true - }, - { - "name": "tool_id", - "type": "TypeString", - "description": "Tool ID.", - "computed": true - }, - { - "name": "toolchain_id", - "type": "TypeString", - "description": "ID of the toolchain to bind the tool to.", - "immutable": true, - "required": true, - "min_length": 36, - "max_length": 36, - "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" - } - ], - "ibm_cd_toolchain_tool_keyprotect": [ + "optional": true + } + }, + "max_items": 1, + "min_items": 1 + }, { "name": "resource_group_id", "type": "TypeString", @@ -84579,12 +89065,27 @@ "cloud_data_type": "resource_group", "computed": true }, + { + "name": "crn", + "type": "TypeString", + "description": "Tool CRN.", + "cloud_data_type": "crn", + "computed": true + }, { "name": "toolchain_crn", "type": "TypeString", "description": "CRN of toolchain which the tool is bound to.", "computed": true }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Latest tool update timestamp.", + "computed": true + } + ], + "ibm_cd_toolchain_tool_keyprotect": [ { "name": "state", "type": "TypeString", @@ -84642,18 +89143,10 @@ "min_items": 1 }, { - "name": "name", - "type": "TypeString", - "description": "Name of the tool.", - "max_length": 128, - "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", - "optional": true - }, - { - "name": "crn", + "name": "resource_group_id", "type": "TypeString", - "description": "Tool CRN.", - "cloud_data_type": "crn", + "description": "Resource group where the tool is located.", + "cloud_data_type": "resource_group", "computed": true }, { @@ -84687,22 +89180,30 @@ "type": "TypeString", "description": "Latest tool update timestamp.", "computed": true - } - ], - "ibm_cd_toolchain_tool_nexus": [ + }, { - "name": "resource_group_id", + "name": "name", "type": "TypeString", - "description": "Resource group where the tool is located.", - "cloud_data_type": "resource_group", - "computed": true + "description": "Name of the tool.", + "max_length": 128, + "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", + "optional": true }, { - "name": "updated_at", + "name": "crn", "type": "TypeString", - "description": "Latest tool update timestamp.", + "description": "Tool CRN.", + "cloud_data_type": "crn", "computed": true }, + { + "name": "toolchain_crn", + "type": "TypeString", + "description": "CRN of toolchain which the tool is bound to.", + "computed": true + } + ], + "ibm_cd_toolchain_tool_nexus": [ { "name": "tool_id", "type": "TypeString", @@ -84710,14 +89211,12 @@ "computed": true }, { - "name": "toolchain_id", + "name": "name", "type": "TypeString", - "description": "ID of the toolchain to bind the tool to.", - "immutable": true, - "required": true, - "min_length": 36, - "max_length": 36, - "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" + "description": "Name of the tool.", + "max_length": 128, + "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", + "optional": true }, { "name": "parameters", @@ -84778,21 +89277,6 @@ "max_items": 1, "min_items": 1 }, - { - "name": "name", - "type": "TypeString", - "description": "Name of the tool.", - "max_length": 128, - "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", - "optional": true - }, - { - "name": "crn", - "type": "TypeString", - "description": "Tool CRN.", - "cloud_data_type": "crn", - "computed": true - }, { "name": "toolchain_crn", "type": "TypeString", @@ -84826,38 +89310,14 @@ } }, { - "name": "state", - "type": "TypeString", - "description": "Current configuration state of the tool.", - "computed": true - } - ], - "ibm_cd_toolchain_tool_pagerduty": [ - { - "name": "updated_at", - "type": "TypeString", - "description": "Latest tool update timestamp.", - "computed": true - }, - { - "name": "state", - "type": "TypeString", - "description": "Current configuration state of the tool.", - "computed": true - }, - { - "name": "tool_id", - "type": "TypeString", - "description": "Tool ID.", - "computed": true - }, - { - "name": "name", + "name": "toolchain_id", "type": "TypeString", - "description": "Name of the tool.", - "max_length": 128, - "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", - "optional": true + "description": "ID of the toolchain to bind the tool to.", + "immutable": true, + "required": true, + "min_length": 36, + "max_length": 36, + "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" }, { "name": "resource_group_id", @@ -84867,47 +89327,26 @@ "computed": true }, { - "name": "href", + "name": "crn", "type": "TypeString", - "description": "URI representing the tool.", + "description": "Tool CRN.", + "cloud_data_type": "crn", "computed": true }, { - "name": "toolchain_crn", + "name": "updated_at", "type": "TypeString", - "description": "CRN of toolchain which the tool is bound to.", + "description": "Latest tool update timestamp.", "computed": true }, { - "name": "referent", - "type": "TypeList", - "description": "Information on URIs to access this resource through the UI or API.", - "computed": true, - "elem": { - "api_href": { - "name": "api_href", - "type": "TypeString", - "description": "URI representing this resource through an API.", - "optional": true - }, - "ui_href": { - "name": "ui_href", - "type": "TypeString", - "description": "URI representing this resource through the UI.", - "optional": true - } - } - }, - { - "name": "toolchain_id", + "name": "state", "type": "TypeString", - "description": "ID of the toolchain to bind the tool to.", - "immutable": true, - "required": true, - "min_length": 36, - "max_length": 36, - "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" - }, + "description": "Current configuration state of the tool.", + "computed": true + } + ], + "ibm_cd_toolchain_tool_pagerduty": [ { "name": "parameters", "type": "TypeList", @@ -84938,29 +89377,24 @@ "min_items": 1 }, { - "name": "crn", - "type": "TypeString", - "description": "Tool CRN.", - "cloud_data_type": "crn", - "computed": true - } - ], - "ibm_cd_toolchain_tool_pipeline": [ - { - "name": "parameters", + "name": "referent", "type": "TypeList", - "description": "Unique key-value pairs representing parameters to be used to create the tool. A list of parameters for each tool integration can be found in the \u003ca href=\"https://cloud.ibm.com/docs/ContinuousDelivery?topic=ContinuousDelivery-integrations\"\u003eConfiguring tool integrations page\u003c/a\u003e.", - "required": true, + "description": "Information on URIs to access this resource through the UI or API.", + "computed": true, "elem": { - "name": { - "name": "name", + "api_href": { + "name": "api_href", "type": "TypeString", - "description": "The name used for this tool integration.", + "description": "URI representing this resource through an API.", + "optional": true + }, + "ui_href": { + "name": "ui_href", + "type": "TypeString", + "description": "URI representing this resource through the UI.", "optional": true } - }, - "max_items": 1, - "min_items": 1 + } }, { "name": "name", @@ -84970,6 +89404,26 @@ "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", "optional": true }, + { + "name": "resource_group_id", + "type": "TypeString", + "description": "Resource group where the tool is located.", + "cloud_data_type": "resource_group", + "computed": true + }, + { + "name": "crn", + "type": "TypeString", + "description": "Tool CRN.", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "toolchain_crn", + "type": "TypeString", + "description": "CRN of toolchain which the tool is bound to.", + "computed": true + }, { "name": "href", "type": "TypeString", @@ -84982,6 +89436,12 @@ "description": "Latest tool update timestamp.", "computed": true }, + { + "name": "state", + "type": "TypeString", + "description": "Current configuration state of the tool.", + "computed": true + }, { "name": "tool_id", "type": "TypeString", @@ -84997,6 +89457,16 @@ "min_length": 36, "max_length": 36, "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" + } + ], + "ibm_cd_toolchain_tool_pipeline": [ + { + "name": "name", + "type": "TypeString", + "description": "Name of the tool.", + "max_length": 128, + "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", + "optional": true }, { "name": "resource_group_id", @@ -85005,6 +89475,32 @@ "cloud_data_type": "resource_group", "computed": true }, + { + "name": "toolchain_id", + "type": "TypeString", + "description": "ID of the toolchain to bind the tool to.", + "immutable": true, + "required": true, + "min_length": 36, + "max_length": 36, + "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" + }, + { + "name": "parameters", + "type": "TypeList", + "description": "Unique key-value pairs representing parameters to be used to create the tool. A list of parameters for each tool integration can be found in the \u003ca href=\"https://cloud.ibm.com/docs/ContinuousDelivery?topic=ContinuousDelivery-integrations\"\u003eConfiguring tool integrations page\u003c/a\u003e.", + "required": true, + "elem": { + "name": { + "name": "name", + "type": "TypeString", + "description": "The name used for this tool integration.", + "optional": true + } + }, + "max_items": 1, + "min_items": 1 + }, { "name": "crn", "type": "TypeString", @@ -85018,6 +89514,12 @@ "description": "CRN of toolchain which the tool is bound to.", "computed": true }, + { + "name": "href", + "type": "TypeString", + "description": "URI representing the tool.", + "computed": true + }, { "name": "referent", "type": "TypeList", @@ -85038,14 +89540,44 @@ } } }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Latest tool update timestamp.", + "computed": true + }, { "name": "state", "type": "TypeString", "description": "Current configuration state of the tool.", "computed": true + }, + { + "name": "tool_id", + "type": "TypeString", + "description": "Tool ID.", + "computed": true } ], "ibm_cd_toolchain_tool_privateworker": [ + { + "name": "toolchain_id", + "type": "TypeString", + "description": "ID of the toolchain to bind the tool to.", + "immutable": true, + "required": true, + "min_length": 36, + "max_length": 36, + "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" + }, + { + "name": "name", + "type": "TypeString", + "description": "Name of the tool.", + "max_length": 128, + "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", + "optional": true + }, { "name": "parameters", "type": "TypeList", @@ -85075,21 +89607,6 @@ "max_items": 1, "min_items": 1 }, - { - "name": "name", - "type": "TypeString", - "description": "Name of the tool.", - "max_length": 128, - "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", - "optional": true - }, - { - "name": "resource_group_id", - "type": "TypeString", - "description": "Resource group where the tool is located.", - "cloud_data_type": "resource_group", - "computed": true - }, { "name": "toolchain_crn", "type": "TypeString", @@ -85097,26 +89614,37 @@ "computed": true }, { - "name": "updated_at", - "type": "TypeString", - "description": "Latest tool update timestamp.", - "computed": true + "name": "referent", + "type": "TypeList", + "description": "Information on URIs to access this resource through the UI or API.", + "computed": true, + "elem": { + "api_href": { + "name": "api_href", + "type": "TypeString", + "description": "URI representing this resource through an API.", + "optional": true + }, + "ui_href": { + "name": "ui_href", + "type": "TypeString", + "description": "URI representing this resource through the UI.", + "optional": true + } + } }, { - "name": "tool_id", + "name": "state", "type": "TypeString", - "description": "Tool ID.", + "description": "Current configuration state of the tool.", "computed": true }, { - "name": "toolchain_id", + "name": "resource_group_id", "type": "TypeString", - "description": "ID of the toolchain to bind the tool to.", - "immutable": true, - "required": true, - "min_length": 36, - "max_length": 36, - "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" + "description": "Resource group where the tool is located.", + "cloud_data_type": "resource_group", + "computed": true }, { "name": "crn", @@ -85132,33 +89660,33 @@ "computed": true }, { - "name": "referent", - "type": "TypeList", - "description": "Information on URIs to access this resource through the UI or API.", - "computed": true, - "elem": { - "api_href": { - "name": "api_href", - "type": "TypeString", - "description": "URI representing this resource through an API.", - "optional": true - }, - "ui_href": { - "name": "ui_href", - "type": "TypeString", - "description": "URI representing this resource through the UI.", - "optional": true - } - } + "name": "updated_at", + "type": "TypeString", + "description": "Latest tool update timestamp.", + "computed": true }, { - "name": "state", + "name": "tool_id", "type": "TypeString", - "description": "Current configuration state of the tool.", + "description": "Tool ID.", "computed": true } ], "ibm_cd_toolchain_tool_saucelabs": [ + { + "name": "tool_id", + "type": "TypeString", + "description": "Tool ID.", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "Name of the tool.", + "max_length": 128, + "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", + "optional": true + }, { "name": "parameters", "type": "TypeList", @@ -85190,28 +89718,21 @@ "computed": true }, { - "name": "crn", - "type": "TypeString", - "description": "Tool CRN.", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "state", + "name": "href", "type": "TypeString", - "description": "Current configuration state of the tool.", + "description": "URI representing the tool.", "computed": true }, { - "name": "tool_id", + "name": "updated_at", "type": "TypeString", - "description": "Tool ID.", + "description": "Latest tool update timestamp.", "computed": true }, { - "name": "updated_at", + "name": "state", "type": "TypeString", - "description": "Latest tool update timestamp.", + "description": "Current configuration state of the tool.", "computed": true }, { @@ -85225,12 +89746,11 @@ "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" }, { - "name": "name", + "name": "crn", "type": "TypeString", - "description": "Name of the tool.", - "max_length": 128, - "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", - "optional": true + "description": "Tool CRN.", + "cloud_data_type": "crn", + "computed": true }, { "name": "toolchain_crn", @@ -85238,12 +89758,6 @@ "description": "CRN of toolchain which the tool is bound to.", "computed": true }, - { - "name": "href", - "type": "TypeString", - "description": "URI representing the tool.", - "computed": true - }, { "name": "referent", "type": "TypeList", @@ -85266,6 +89780,28 @@ } ], "ibm_cd_toolchain_tool_secretsmanager": [ + { + "name": "state", + "type": "TypeString", + "description": "Current configuration state of the tool.", + "computed": true + }, + { + "name": "tool_id", + "type": "TypeString", + "description": "Tool ID.", + "computed": true + }, + { + "name": "toolchain_id", + "type": "TypeString", + "description": "ID of the toolchain to bind the tool to.", + "immutable": true, + "required": true, + "min_length": 36, + "max_length": 36, + "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" + }, { "name": "parameters", "type": "TypeList", @@ -85312,55 +89848,6 @@ "max_items": 1, "min_items": 1 }, - { - "name": "name", - "type": "TypeString", - "description": "Name of the tool.", - "max_length": 128, - "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", - "optional": true - }, - { - "name": "toolchain_crn", - "type": "TypeString", - "description": "CRN of toolchain which the tool is bound to.", - "computed": true - }, - { - "name": "updated_at", - "type": "TypeString", - "description": "Latest tool update timestamp.", - "computed": true - }, - { - "name": "state", - "type": "TypeString", - "description": "Current configuration state of the tool.", - "computed": true - }, - { - "name": "tool_id", - "type": "TypeString", - "description": "Tool ID.", - "computed": true - }, - { - "name": "toolchain_id", - "type": "TypeString", - "description": "ID of the toolchain to bind the tool to.", - "immutable": true, - "required": true, - "min_length": 36, - "max_length": 36, - "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" - }, - { - "name": "crn", - "type": "TypeString", - "description": "Tool CRN.", - "cloud_data_type": "crn", - "computed": true - }, { "name": "href", "type": "TypeString", @@ -85387,32 +89874,49 @@ } } }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Latest tool update timestamp.", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "Name of the tool.", + "max_length": 128, + "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", + "optional": true + }, { "name": "resource_group_id", "type": "TypeString", "description": "Resource group where the tool is located.", "cloud_data_type": "resource_group", "computed": true - } - ], - "ibm_cd_toolchain_tool_securitycompliance": [ + }, { - "name": "href", + "name": "crn", "type": "TypeString", - "description": "URI representing the tool.", + "description": "Tool CRN.", + "cloud_data_type": "crn", "computed": true }, { - "name": "updated_at", + "name": "toolchain_crn", "type": "TypeString", - "description": "Latest tool update timestamp.", + "description": "CRN of toolchain which the tool is bound to.", "computed": true - }, + } + ], + "ibm_cd_toolchain_tool_securitycompliance": [ { - "name": "state", + "name": "name", "type": "TypeString", - "description": "Current configuration state of the tool.", - "computed": true + "description": "Name of the tool.", + "max_length": 128, + "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", + "optional": true }, { "name": "parameters", @@ -85426,7 +89930,7 @@ "description": "The IBM Cloud API key used to access the Security and Compliance Center API. This parameter is only relevant when the `trigger_scan` parameter is `enabled`. For information about the deprecation see the `trigger_scan` parameter. You can use a toolchain secret reference for this parameter. For more information, see [Protecting your sensitive data in Continuous Delivery](https://cloud.ibm.com/docs/ContinuousDelivery?topic=ContinuousDelivery-cd_data_security#cd_secure_credentials).", "secure": true, "optional": true, - "deprecated": "This argument is deprecated and will be removed in a future release. Refer to the provider documentation for details." + "deprecated": "This argument is deprecated and may be removed in a future release" }, "attachment_id": { "name": "attachment_id", @@ -85463,7 +89967,7 @@ "type": "TypeString", "description": "The name of a Security and Compliance Center, Hybrid cloud profile. Usually, use the predefined profile \"IBM Cloud Security Best Practices v1.0.0\", which contains the DevSecOps toolchain goals. Or use a user-authored customized profile that has been configured to contain those goals. When the `trigger_scan` parameter is set to `enabled`, then the Validation scan will use the controls and goals in the configured profile. If configured with a profile that does not check the DevSecOps toolchain goals, it might incorrectly indicate that the toolchain status is passed even though some of the DevSecOps scans had actually failed. This parameter is only relevant when the `trigger_scan` parameter is `enabled`. For information about the deprecation see the `trigger_scan` parameter.", "optional": true, - "deprecated": "This argument is deprecated and will be removed in a future release. Refer to the provider documentation for details." + "deprecated": "This argument is deprecated and may be removed in a future release" }, "profile_name": { "name": "profile_name", @@ -85489,14 +89993,14 @@ "type": "TypeString", "description": "The name of a Security and Compliance Center scope, which has previously been created in that service. When the `trigger_scan` parameter is set to `enabled`, then the Validation scan will scan all the resources in that scope. Select a scope that contains this toolchain, so that the scan will find the evidence that has been recently updated by the DevSecOps pipeline-run. This parameter is only relevant when the `trigger_scan` parameter is `enabled`. For information about the deprecation see the `trigger_scan` parameter.", "optional": true, - "deprecated": "This argument is deprecated and will be removed in a future release. Refer to the provider documentation for details." + "deprecated": "This argument is deprecated and may be removed in a future release" }, "trigger_scan": { "name": "trigger_scan", "type": "TypeString", "description": "Set to `enabled` to indicate that a DevSecOps pipeline task should trigger a Security and Compliance Center run of a Hybrid cloud validation scan. Note, each scan may incur charges. When enabled, other parameters become relevant that are needed to trigger that scan; `api_key`, `scope`, `profile`. Hybrid cloud scans are deprecated and are planned to be removed. This option will stop working at that time. For more information see the [Security and Compliance Center Release Notes](https://cloud.ibm.com/docs/security-compliance?topic=security-compliance-release-notes#security-compliance-march312023).", "optional": true, - "deprecated": "This argument is deprecated and will be removed in a future release. Refer to the provider documentation for details." + "deprecated": "This argument is deprecated and may be removed in a future release" }, "use_profile_attachment": { "name": "use_profile_attachment", @@ -85509,31 +90013,21 @@ "min_items": 1 }, { - "name": "name", - "type": "TypeString", - "description": "Name of the tool.", - "max_length": 128, - "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", - "optional": true - }, - { - "name": "resource_group_id", + "name": "toolchain_crn", "type": "TypeString", - "description": "Resource group where the tool is located.", - "cloud_data_type": "resource_group", + "description": "CRN of toolchain which the tool is bound to.", "computed": true }, { - "name": "crn", + "name": "updated_at", "type": "TypeString", - "description": "Tool CRN.", - "cloud_data_type": "crn", + "description": "Latest tool update timestamp.", "computed": true }, { - "name": "toolchain_crn", + "name": "tool_id", "type": "TypeString", - "description": "CRN of toolchain which the tool is bound to.", + "description": "Tool ID.", "computed": true }, { @@ -85546,6 +90040,26 @@ "max_length": 36, "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" }, + { + "name": "resource_group_id", + "type": "TypeString", + "description": "Resource group where the tool is located.", + "cloud_data_type": "resource_group", + "computed": true + }, + { + "name": "crn", + "type": "TypeString", + "description": "Tool CRN.", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "href", + "type": "TypeString", + "description": "URI representing the tool.", + "computed": true + }, { "name": "referent", "type": "TypeList", @@ -85567,42 +90081,13 @@ } }, { - "name": "tool_id", + "name": "state", "type": "TypeString", - "description": "Tool ID.", + "description": "Current configuration state of the tool.", "computed": true } ], "ibm_cd_toolchain_tool_slack": [ - { - "name": "crn", - "type": "TypeString", - "description": "Tool CRN.", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "toolchain_crn", - "type": "TypeString", - "description": "CRN of toolchain which the tool is bound to.", - "computed": true - }, - { - "name": "href", - "type": "TypeString", - "description": "URI representing the tool.", - "computed": true - }, - { - "name": "toolchain_id", - "type": "TypeString", - "description": "ID of the toolchain to bind the tool to.", - "immutable": true, - "required": true, - "min_length": 36, - "max_length": 36, - "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" - }, { "name": "parameters", "type": "TypeList", @@ -85675,9 +90160,16 @@ "computed": true }, { - "name": "state", + "name": "crn", "type": "TypeString", - "description": "Current configuration state of the tool.", + "description": "Tool CRN.", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Latest tool update timestamp.", "computed": true }, { @@ -85686,6 +90178,16 @@ "description": "Tool ID.", "computed": true }, + { + "name": "toolchain_id", + "type": "TypeString", + "description": "ID of the toolchain to bind the tool to.", + "immutable": true, + "required": true, + "min_length": 36, + "max_length": 36, + "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" + }, { "name": "name", "type": "TypeString", @@ -85695,33 +90197,17 @@ "optional": true }, { - "name": "referent", - "type": "TypeList", - "description": "Information on URIs to access this resource through the UI or API.", - "computed": true, - "elem": { - "api_href": { - "name": "api_href", - "type": "TypeString", - "description": "URI representing this resource through an API.", - "optional": true - }, - "ui_href": { - "name": "ui_href", - "type": "TypeString", - "description": "URI representing this resource through the UI.", - "optional": true - } - } + "name": "toolchain_crn", + "type": "TypeString", + "description": "CRN of toolchain which the tool is bound to.", + "computed": true }, { - "name": "updated_at", + "name": "href", "type": "TypeString", - "description": "Latest tool update timestamp.", + "description": "URI representing the tool.", "computed": true - } - ], - "ibm_cd_toolchain_tool_sonarqube": [ + }, { "name": "referent", "type": "TypeList", @@ -85742,18 +90228,14 @@ } } }, - { - "name": "updated_at", - "type": "TypeString", - "description": "Latest tool update timestamp.", - "computed": true - }, { "name": "state", "type": "TypeString", "description": "Current configuration state of the tool.", "computed": true - }, + } + ], + "ibm_cd_toolchain_tool_sonarqube": [ { "name": "toolchain_id", "type": "TypeString", @@ -85765,26 +90247,37 @@ "matches": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" }, { - "name": "name", + "name": "toolchain_crn", "type": "TypeString", - "description": "Name of the tool.", - "max_length": 128, - "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", - "optional": true + "description": "CRN of toolchain which the tool is bound to.", + "computed": true }, { - "name": "crn", + "name": "href", "type": "TypeString", - "description": "Tool CRN.", - "cloud_data_type": "crn", + "description": "URI representing the tool.", "computed": true }, { - "name": "href", + "name": "updated_at", "type": "TypeString", - "description": "URI representing the tool.", + "description": "Latest tool update timestamp.", + "computed": true + }, + { + "name": "state", + "type": "TypeString", + "description": "Current configuration state of the tool.", "computed": true }, + { + "name": "name", + "type": "TypeString", + "description": "Name of the tool.", + "max_length": 128, + "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$", + "optional": true + }, { "name": "parameters", "type": "TypeList", @@ -85835,11 +90328,32 @@ "computed": true }, { - "name": "toolchain_crn", + "name": "crn", "type": "TypeString", - "description": "CRN of toolchain which the tool is bound to.", + "description": "Tool CRN.", + "cloud_data_type": "crn", "computed": true }, + { + "name": "referent", + "type": "TypeList", + "description": "Information on URIs to access this resource through the UI or API.", + "computed": true, + "elem": { + "api_href": { + "name": "api_href", + "type": "TypeString", + "description": "URI representing this resource through an API.", + "optional": true + }, + "ui_href": { + "name": "ui_href", + "type": "TypeString", + "description": "URI representing this resource through the UI.", + "optional": true + } + } + }, { "name": "tool_id", "type": "TypeString", @@ -85849,48 +90363,46 @@ ], "ibm_cdn": [ { - "name": "status", + "name": "origin_type", "type": "TypeString", - "description": "Status info of the CDN instance", - "computed": true + "description": "Origin type info", + "default_value": "HOST_SERVER", + "immutable": true, + "optional": true }, { - "name": "cname", + "name": "origin_address", "type": "TypeString", - "description": "cname info", - "immutable": true, - "optional": true, - "computed": true + "description": "origin address info", + "required": true }, { - "name": "performance_configuration", + "name": "host_name", "type": "TypeString", - "description": "performance configuration info", - "default_value": "General web delivery", + "description": "Host name", "immutable": true, - "optional": true + "required": true }, { - "name": "protocol", + "name": "header", "type": "TypeString", - "description": "Protocol name", - "default_value": "HTTP", - "immutable": true, - "optional": true + "description": "Header info", + "optional": true, + "computed": true }, { - "name": "vendor_name", + "name": "path", "type": "TypeString", - "description": "Vendor name", - "default_value": "akamai", + "description": "Path details", + "default_value": "/*", "immutable": true, "optional": true }, { - "name": "origin_type", + "name": "vendor_name", "type": "TypeString", - "description": "Origin type info", - "default_value": "HOST_SERVER", + "description": "Vendor name", + "default_value": "akamai", "immutable": true, "optional": true }, @@ -85902,30 +90414,23 @@ "optional": true }, { - "name": "file_extension", - "type": "TypeString", - "description": "File extension info", - "optional": true - }, - { - "name": "cache_key_query_rule", + "name": "status", "type": "TypeString", - "description": "query rule info", - "default_value": "include-all", - "optional": true + "description": "Status info of the CDN instance", + "computed": true }, { - "name": "host_name", + "name": "certificate_type", "type": "TypeString", - "description": "Host name", + "description": "Certificate type", "immutable": true, - "required": true + "optional": true }, { - "name": "path", + "name": "performance_configuration", "type": "TypeString", - "description": "Path details", - "default_value": "/*", + "description": "performance configuration info", + "default_value": "General web delivery", "immutable": true, "optional": true }, @@ -85943,9 +90448,10 @@ "optional": true }, { - "name": "header", + "name": "cname", "type": "TypeString", - "description": "Header info", + "description": "cname info", + "immutable": true, "optional": true, "computed": true }, @@ -85957,56 +90463,28 @@ "optional": true }, { - "name": "certificate_type", + "name": "file_extension", "type": "TypeString", - "description": "Certificate type", - "immutable": true, + "description": "File extension info", "optional": true }, { - "name": "origin_address", - "type": "TypeString", - "description": "origin address info", - "required": true - } - ], - "ibm_cis": [ - { - "name": "guid", - "type": "TypeString", - "description": "Unique identifier of resource instance", - "computed": true - }, - { - "name": "location", + "name": "cache_key_query_rule", "type": "TypeString", - "description": "The location where the instance available", - "cloud_data_type": "region", - "immutable": true, - "required": true - }, - { - "name": "parameters", - "type": "TypeMap", - "description": "Arbitrary parameters to pass. Must be a JSON object", - "immutable": true, + "description": "query rule info", + "default_value": "include-all", "optional": true }, { - "name": "status", - "type": "TypeString", - "description": "Status of resource instance", - "computed": true - }, - { - "name": "resource_group_id", + "name": "protocol", "type": "TypeString", - "description": "The resource group id", - "cloud_data_type": "resource_group", + "description": "Protocol name", + "default_value": "HTTP", "immutable": true, - "optional": true, - "computed": true - }, + "optional": true + } + ], + "ibm_cis": [ { "name": "tags", "type": "TypeSet", @@ -86020,9 +90498,9 @@ } }, { - "name": "resource_name", + "name": "status", "type": "TypeString", - "description": "The name of the resource", + "description": "Status of resource instance", "computed": true }, { @@ -86031,12 +90509,6 @@ "description": "The resource group name in which resource is provisioned", "computed": true }, - { - "name": "resource_controller_url", - "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource", - "computed": true - }, { "name": "name", "type": "TypeString", @@ -86049,6 +90521,25 @@ "description": "The name of the Cloud Internet Services offering", "computed": true }, + { + "name": "resource_status", + "type": "TypeString", + "description": "The status of the resource", + "computed": true + }, + { + "name": "parameters", + "type": "TypeMap", + "description": "Arbitrary parameters to pass. Must be a JSON object", + "immutable": true, + "optional": true + }, + { + "name": "resource_crn", + "type": "TypeString", + "description": "The crn of the resource", + "computed": true + }, { "name": "plan", "type": "TypeString", @@ -86056,19 +90547,58 @@ "required": true }, { - "name": "resource_crn", + "name": "location", "type": "TypeString", - "description": "The crn of the resource", + "description": "The location where the instance available", + "cloud_data_type": "region", + "immutable": true, + "required": true + }, + { + "name": "resource_name", + "type": "TypeString", + "description": "The name of the resource", "computed": true }, { - "name": "resource_status", + "name": "resource_controller_url", "type": "TypeString", - "description": "The status of the resource", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource", + "computed": true + }, + { + "name": "guid", + "type": "TypeString", + "description": "Unique identifier of resource instance", + "computed": true + }, + { + "name": "resource_group_id", + "type": "TypeString", + "description": "The resource group id", + "cloud_data_type": "resource_group", + "immutable": true, + "optional": true, "computed": true } ], "ibm_cis_alert": [ + { + "name": "cis_id", + "type": "TypeString", + "description": "CIS instance crn", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:internet-svcs" + ] + }, + { + "name": "policy_id", + "type": "TypeString", + "description": "Identifier of the Alert Policy", + "computed": true + }, { "name": "name", "type": "TypeString", @@ -86076,16 +90606,16 @@ "required": true }, { - "name": "alert_type", + "name": "description", "type": "TypeString", - "description": "Condition for the alert", - "required": true + "description": "Policy Description", + "optional": true }, { - "name": "filters", + "name": "alert_type", "type": "TypeString", - "description": "Filters based on filter type", - "optional": true + "description": "Condition for the alert", + "required": true }, { "name": "enabled", @@ -86117,11 +90647,31 @@ } } }, + { + "name": "filters", + "type": "TypeString", + "description": "Filters based on filter type", + "optional": true + }, { "name": "conditions", "type": "TypeString", "description": "Conditions based on filter type", "optional": true + } + ], + "ibm_cis_bot_management": [ + { + "name": "auth_id_logging", + "type": "TypeString", + "description": "Auth ID Logging", + "computed": true + }, + { + "name": "use_latest_model", + "type": "TypeString", + "description": "Use Latest Model", + "computed": true }, { "name": "cis_id", @@ -86133,20 +90683,6 @@ "service:internet-svcs" ] }, - { - "name": "policy_id", - "type": "TypeString", - "description": "Identifier of the Alert Policy", - "computed": true - }, - { - "name": "description", - "type": "TypeString", - "description": "Policy Description", - "optional": true - } - ], - "ibm_cis_bot_management": [ { "name": "domain_id", "type": "TypeString", @@ -86170,19 +90706,9 @@ "type": "TypeString", "description": "Enable JS", "computed": true - }, - { - "name": "auth_id_logging", - "type": "TypeString", - "description": "Auth ID Logging", - "computed": true - }, - { - "name": "use_latest_model", - "type": "TypeString", - "description": "Use Latest Model", - "computed": true - }, + } + ], + "ibm_cis_cache_settings": [ { "name": "cis_id", "type": "TypeString", @@ -86192,13 +90718,11 @@ "cloud_data_range": [ "service:internet-svcs" ] - } - ], - "ibm_cis_cache_settings": [ + }, { - "name": "query_string_sort", + "name": "development_mode", "type": "TypeString", - "description": "Query String sort setting", + "description": "Development mode setting", "options": "on, off", "optional": true, "computed": true @@ -86209,15 +90733,6 @@ "description": "Purge all setting", "optional": true }, - { - "name": "purge_by_urls", - "type": "TypeList", - "description": "Purge by URLs", - "optional": true, - "elem": { - "type": "TypeString" - } - }, { "name": "purge_by_tags", "type": "TypeList", @@ -86228,13 +90743,18 @@ } }, { - "name": "purge_by_hosts", - "type": "TypeList", - "description": "Purge by hosts", - "optional": true, - "elem": { - "type": "TypeString" - } + "name": "domain_id", + "type": "TypeString", + "description": "Associated CIS domain", + "required": true + }, + { + "name": "caching_level", + "type": "TypeString", + "description": "Cache level setting", + "options": "basic, simplified, aggressive", + "optional": true, + "computed": true }, { "name": "serve_stale_content", @@ -86253,36 +90773,30 @@ "computed": true }, { - "name": "caching_level", - "type": "TypeString", - "description": "Cache level setting", - "options": "basic, simplified, aggressive", - "optional": true, - "computed": true - }, - { - "name": "development_mode", + "name": "query_string_sort", "type": "TypeString", - "description": "Development mode setting", + "description": "Query String sort setting", "options": "on, off", "optional": true, "computed": true }, { - "name": "cis_id", - "type": "TypeString", - "description": "CIS instance crn", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:internet-svcs" - ] + "name": "purge_by_urls", + "type": "TypeList", + "description": "Purge by URLs", + "optional": true, + "elem": { + "type": "TypeString" + } }, { - "name": "domain_id", - "type": "TypeString", - "description": "Associated CIS domain", - "required": true + "name": "purge_by_hosts", + "type": "TypeList", + "description": "Purge by hosts", + "optional": true, + "elem": { + "type": "TypeString" + } } ], "ibm_cis_certificate_order": [ @@ -86333,32 +90847,6 @@ } ], "ibm_cis_certificate_upload": [ - { - "name": "priority", - "type": "TypeInt", - "description": "Certificate priority", - "optional": true, - "computed": true - }, - { - "name": "status", - "type": "TypeString", - "description": "certificate status", - "computed": true - }, - { - "name": "modified_on", - "type": "TypeString", - "description": "certificate modified date", - "computed": true - }, - { - "name": "certificate", - "type": "TypeString", - "description": "Certificate key", - "secure": true, - "required": true - }, { "name": "hosts", "type": "TypeList", @@ -86369,9 +90857,9 @@ } }, { - "name": "issuer", + "name": "signature", "type": "TypeString", - "description": "certificate issuer", + "description": "certificate signature", "computed": true }, { @@ -86387,15 +90875,14 @@ "computed": true }, { - "name": "domain_id", - "type": "TypeString", - "description": "Associated CIS domain", - "required": true - }, - { - "name": "custom_cert_id", + "name": "cis_id", "type": "TypeString", - "computed": true + "description": "CIS instance crn", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:internet-svcs" + ] }, { "name": "bundle_method", @@ -86406,20 +90893,17 @@ "optional": true }, { - "name": "signature", - "type": "TypeString", - "description": "certificate signature", + "name": "priority", + "type": "TypeInt", + "description": "Certificate priority", + "optional": true, "computed": true }, { - "name": "cis_id", + "name": "domain_id", "type": "TypeString", - "description": "CIS instance crn", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:internet-svcs" - ] + "description": "Associated CIS domain", + "required": true }, { "name": "private_key", @@ -86427,36 +90911,39 @@ "description": "Certificate private key", "secure": true, "required": true - } - ], - "ibm_cis_custom_page": [ + }, { - "name": "domain_id", + "name": "certificate", "type": "TypeString", - "description": "Associated CIS domain", + "description": "Certificate key", + "secure": true, "required": true }, { - "name": "state", + "name": "issuer", "type": "TypeString", - "description": "Custom page state", + "description": "certificate issuer", "computed": true }, { - "name": "required_tokens", - "type": "TypeList", - "description": "Custom page state", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "modified_on", + "type": "TypeString", + "description": "certificate modified date", + "computed": true }, { - "name": "modified_on", + "name": "custom_cert_id", "type": "TypeString", - "description": "Custom page modified date", "computed": true }, + { + "name": "status", + "type": "TypeString", + "description": "certificate status", + "computed": true + } + ], + "ibm_cis_custom_page": [ { "name": "cis_id", "type": "TypeString", @@ -86468,12 +90955,10 @@ ] }, { - "name": "page_id", + "name": "domain_id", "type": "TypeString", - "description": "Custom page identifier", - "immutable": true, - "required": true, - "options": "basic_challenge, waf_challenge, waf_block, ratelimit_block,country_challenge, ip_block, under_attack, 500_errors, 1000_errors, always_online" + "description": "Associated CIS domain", + "required": true }, { "name": "url", @@ -86494,33 +90979,54 @@ "computed": true }, { - "name": "created_on", + "name": "modified_on", "type": "TypeString", - "description": "Custom page created date", + "description": "Custom page modified date", "computed": true - } - ], - "ibm_cis_dns_record": [ + }, { - "name": "type", + "name": "page_id", "type": "TypeString", - "description": "Record type", - "required": true + "description": "Custom page identifier", + "immutable": true, + "required": true, + "options": "basic_challenge, waf_challenge, waf_block, ratelimit_block,country_challenge, ip_block, under_attack, 500_errors, 1000_errors, always_online" }, { - "name": "record_id", + "name": "state", "type": "TypeString", + "description": "Custom page state", "computed": true }, { - "name": "cis_id", + "name": "required_tokens", + "type": "TypeList", + "description": "Custom page state", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "created_on", "type": "TypeString", - "description": "CIS object id or CRN", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:internet-svcs" - ] + "description": "Custom page created date", + "computed": true + } + ], + "ibm_cis_dns_record": [ + { + "name": "name", + "type": "TypeString", + "description": "DNS record name", + "optional": true + }, + { + "name": "proxied", + "type": "TypeBool", + "description": "Boolean value true if proxied else flase", + "default_value": false, + "optional": true }, { "name": "domain_id", @@ -86534,22 +91040,12 @@ "description": "zone name", "computed": true }, - { - "name": "proxiable", - "type": "TypeBool", - "computed": true - }, { "name": "content", "type": "TypeString", "description": "DNS record content", "optional": true }, - { - "name": "data", - "type": "TypeMap", - "optional": true - }, { "name": "priority", "type": "TypeInt", @@ -86564,34 +91060,24 @@ "optional": true }, { - "name": "modified_on", + "name": "record_id", "type": "TypeString", "computed": true }, { - "name": "name", + "name": "created_on", "type": "TypeString", - "description": "DNS record name", - "optional": true - }, - { - "name": "proxied", - "type": "TypeBool", - "description": "Boolean value true if proxied else flase", - "default_value": false, - "optional": true + "computed": true }, { - "name": "created_on", + "name": "modified_on", "type": "TypeString", "computed": true - } - ], - "ibm_cis_dns_records_import": [ + }, { "name": "cis_id", "type": "TypeString", - "description": "CIS instance crn", + "description": "CIS object id or CRN", "cloud_data_type": "resource_instance", "required": true, "cloud_data_range": [ @@ -86599,11 +91085,23 @@ ] }, { - "name": "domain_id", + "name": "type", "type": "TypeString", - "description": "Associated CIS domain", + "description": "Record type", "required": true }, + { + "name": "data", + "type": "TypeMap", + "optional": true + }, + { + "name": "proxiable", + "type": "TypeBool", + "computed": true + } + ], + "ibm_cis_dns_records_import": [ { "name": "file", "type": "TypeString", @@ -86622,6 +91120,22 @@ "type": "TypeInt", "description": "added records count", "computed": true + }, + { + "name": "cis_id", + "type": "TypeString", + "description": "CIS instance crn", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:internet-svcs" + ] + }, + { + "name": "domain_id", + "type": "TypeString", + "description": "Associated CIS domain", + "required": true } ], "ibm_cis_domain": [ @@ -86633,22 +91147,37 @@ "type": "TypeString" } }, + { + "name": "domain_id", + "type": "TypeString", + "computed": true + }, { "name": "verification_key", "type": "TypeString", "computed": true }, + { + "name": "cname_suffix", + "type": "TypeString", + "computed": true + }, + { + "name": "cis_id", + "type": "TypeString", + "description": "CIS instance crn", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:internet-svcs" + ] + }, { "name": "domain", "type": "TypeString", "description": "CISzone - Domain", "required": true }, - { - "name": "paused", - "type": "TypeBool", - "computed": true - }, { "name": "status", "type": "TypeString", @@ -86663,51 +91192,93 @@ } }, { - "name": "domain_id", + "name": "type", "type": "TypeString", - "computed": true + "description": "CISzone - Domain Type", + "default_value": "full", + "options": "full, partial", + "optional": true }, { - "name": "cname_suffix", + "name": "paused", + "type": "TypeBool", + "computed": true + } + ], + "ibm_cis_domain_settings": [ + { + "name": "cname_flattening", "type": "TypeString", + "description": "cname_flattening setting", + "optional": true, "computed": true }, { - "name": "cis_id", + "name": "opportunistic_encryption", "type": "TypeString", - "description": "CIS instance crn", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:internet-svcs" - ] + "description": "opportunistic_encryption setting", + "options": "on, off", + "optional": true, + "computed": true }, { - "name": "type", + "name": "ip_geolocation", "type": "TypeString", - "description": "CISzone - Domain Type", - "default_value": "full", - "options": "full, partial", - "optional": true - } - ], - "ibm_cis_domain_settings": [ - { - "name": "challenge_ttl", - "type": "TypeInt", - "description": "Challenge TTL setting", - "options": "300, 900, 1800, 2700, 3600, 7200, 10800, 14400, 28800, 57600, 86400, 604800, 2592000, 31536000", + "description": "ip_geolocation setting", + "options": "on, off", "optional": true, "computed": true }, { - "name": "waf", + "name": "brotli", "type": "TypeString", - "description": "WAF setting", + "description": "brotli setting", "options": "on, off", "optional": true, "computed": true }, + { + "name": "security_header", + "type": "TypeList", + "description": "Security Header Setting", + "optional": true, + "computed": true, + "elem": { + "enabled": { + "name": "enabled", + "type": "TypeBool", + "description": "security header enabled/disabled", + "required": true + }, + "include_subdomains": { + "name": "include_subdomains", + "type": "TypeBool", + "description": "security header subdomain included or not", + "required": true + }, + "max_age": { + "name": "max_age", + "type": "TypeInt", + "description": "security header max age", + "required": true + }, + "nosniff": { + "name": "nosniff", + "type": "TypeBool", + "description": "security header no sniff", + "required": true + }, + "preload": { + "name": "preload", + "type": "TypeBool", + "description": "security header preload", + "default_value": false, + "optional": true + } + }, + "max_items": 1, + "min_items": 1 + }, { "name": "min_tls_version", "type": "TypeString", @@ -86716,79 +91287,77 @@ "optional": true }, { - "name": "image_size_optimization", + "name": "automatic_https_rewrites", "type": "TypeString", - "description": "image_size_optimization setting", + "description": "automatic_https_rewrites setting", + "options": "on, off", "optional": true, "computed": true }, { - "name": "ip_geolocation", + "name": "ipv6", "type": "TypeString", - "description": "ip_geolocation setting", + "description": "ipv6 setting", "options": "on, off", "optional": true, "computed": true }, { - "name": "cipher", - "type": "TypeSet", - "description": "Cipher settings", - "options": "ECDHE-ECDSA-AES128-GCM-SHA256,ECDHE-ECDSA-CHACHA20-POLY1305, ECDHE-RSA-AES128-GCM-SHA256,ECDHE-RSA-CHACHA20-POLY1305, ECDHE-ECDSA-AES128-SHA256, ECDHE-ECDSA-AES128-SHA, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES128-SHA, AES128-GCM-SHA256, AES128-SHA256, AES128-SHA, ECDHE-ECDSA-AES256-GCM-SHA384, ECDHE-ECDSA-AES256-SHA384, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES256-SHA384, ECDHE-RSA-AES256-SHA, AES256-GCM-SHA384, AES256-SHA256, AES256-SHA, DES-CBC3-SHA, AEAD-AES128-GCM-SHA256, AEAD-AES256-GCM-SHA384, AEAD-CHACHA20-POLY1305-SHA256", + "name": "browser_check", + "type": "TypeString", + "description": "browser_check setting", + "options": "on, off", "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "computed": true }, { - "name": "ssl", + "name": "waf", "type": "TypeString", - "description": "SSL/TLS setting", + "description": "WAF setting", + "options": "on, off", "optional": true, "computed": true }, { - "name": "dnssec", + "name": "image_size_optimization", "type": "TypeString", - "description": "DNS Sec setting", - "options": "active, disabled", + "description": "image_size_optimization setting", "optional": true, "computed": true }, { - "name": "response_buffering", + "name": "pseudo_ipv4", "type": "TypeString", - "description": "response_buffering setting", - "options": "on, off", + "description": "pseudo_ipv4 setting", "optional": true, "computed": true }, { - "name": "script_load_optimization", - "type": "TypeString", - "description": "script_load_optimization setting", - "options": "on, off", + "name": "cipher", + "type": "TypeSet", + "description": "Cipher settings", + "options": "ECDHE-ECDSA-AES128-GCM-SHA256,ECDHE-ECDSA-CHACHA20-POLY1305, ECDHE-RSA-AES128-GCM-SHA256,ECDHE-RSA-CHACHA20-POLY1305, ECDHE-ECDSA-AES128-SHA256, ECDHE-ECDSA-AES128-SHA, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES128-SHA, AES128-GCM-SHA256, AES128-SHA256, AES128-SHA, ECDHE-ECDSA-AES256-GCM-SHA384, ECDHE-ECDSA-AES256-SHA384, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES256-SHA384, ECDHE-RSA-AES256-SHA, AES256-GCM-SHA384, AES256-SHA256, AES256-SHA, DES-CBC3-SHA, AEAD-AES128-GCM-SHA256, AEAD-AES256-GCM-SHA384, AEAD-CHACHA20-POLY1305-SHA256", "optional": true, - "computed": true + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "tls_client_auth", + "name": "hotlink_protection", "type": "TypeString", - "description": "tls_client_auth setting", + "description": "hotlink_protection setting", "options": "on, off", "optional": true, "computed": true }, { - "name": "cis_id", + "name": "prefetch_preload", "type": "TypeString", - "description": "CIS instance crn", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:internet-svcs" - ] + "description": "prefetch_preload setting", + "options": "on, off", + "optional": true, + "computed": true }, { "name": "mobile_redirect", @@ -86821,182 +91390,135 @@ "min_items": 1 }, { - "name": "origin_error_page_pass_thru", + "name": "dnssec", "type": "TypeString", - "description": "origin_error_page_pass_thru setting", - "options": "on, off", + "description": "DNS Sec setting", + "options": "active, disabled", "optional": true, "computed": true }, { - "name": "pseudo_ipv4", + "name": "ssl", "type": "TypeString", - "description": "pseudo_ipv4 setting", + "description": "SSL/TLS setting", "optional": true, "computed": true }, { - "name": "prefetch_preload", + "name": "tls_client_auth", "type": "TypeString", - "description": "prefetch_preload setting", + "description": "tls_client_auth setting", "options": "on, off", "optional": true, "computed": true }, { - "name": "websockets", + "name": "server_side_exclude", "type": "TypeString", - "description": "websockets setting", + "description": "server_side_exclude setting", "options": "on, off", "optional": true, "computed": true }, { - "name": "security_header", - "type": "TypeList", - "description": "Security Header Setting", - "optional": true, + "name": "domain_id", + "type": "TypeString", + "description": "Associated CIS domain", + "required": true + }, + { + "name": "certificate_status", + "type": "TypeString", + "description": "Certificate status", "computed": true, - "elem": { - "enabled": { - "name": "enabled", - "type": "TypeBool", - "description": "security header enabled/disabled", - "required": true - }, - "include_subdomains": { - "name": "include_subdomains", - "type": "TypeBool", - "description": "security header subdomain included or not", - "required": true - }, - "max_age": { - "name": "max_age", - "type": "TypeInt", - "description": "security header max age", - "required": true - }, - "nosniff": { - "name": "nosniff", - "type": "TypeBool", - "description": "security header no sniff", - "required": true - }, - "preload": { - "name": "preload", - "type": "TypeBool", - "description": "security header preload", - "default_value": false, - "optional": true - } - }, - "max_items": 1, - "min_items": 1 + "deprecated": "This field is deprecated" }, { - "name": "hotlink_protection", + "name": "always_use_https", "type": "TypeString", - "description": "hotlink_protection setting", + "description": "always_use_https setting", "options": "on, off", "optional": true, "computed": true }, { - "name": "opportunistic_encryption", + "name": "origin_error_page_pass_thru", "type": "TypeString", - "description": "opportunistic_encryption setting", + "description": "origin_error_page_pass_thru setting", "options": "on, off", "optional": true, "computed": true }, { - "name": "browser_check", + "name": "response_buffering", "type": "TypeString", - "description": "browser_check setting", + "description": "response_buffering setting", "options": "on, off", "optional": true, "computed": true }, { - "name": "image_load_optimization", + "name": "true_client_ip_header", "type": "TypeString", - "description": "image_load_optimization setting", + "description": "true_client_ip_header setting", "options": "on, off", "optional": true, "computed": true }, { - "name": "server_side_exclude", + "name": "websockets", "type": "TypeString", - "description": "server_side_exclude setting", + "description": "websockets setting", "options": "on, off", "optional": true, "computed": true }, { - "name": "max_upload", + "name": "challenge_ttl", "type": "TypeInt", - "description": "Maximum upload", - "options": "100, 125, 150, 175, 200, 225, 250, 275, 300, 325, 350, 375, 400, 425, 450, 475, 500", - "optional": true, - "computed": true - }, - { - "name": "certificate_status", - "type": "TypeString", - "description": "Certificate status", - "computed": true, - "deprecated": "This field is deprecated" - }, - { - "name": "cname_flattening", - "type": "TypeString", - "description": "cname_flattening setting", + "description": "Challenge TTL setting", + "options": "300, 900, 1800, 2700, 3600, 7200, 10800, 14400, 28800, 57600, 86400, 604800, 2592000, 31536000", "optional": true, "computed": true }, { - "name": "automatic_https_rewrites", - "type": "TypeString", - "description": "automatic_https_rewrites setting", - "options": "on, off", + "name": "max_upload", + "type": "TypeInt", + "description": "Maximum upload", + "options": "100, 125, 150, 175, 200, 225, 250, 275, 300, 325, 350, 375, 400, 425, 450, 475, 500", "optional": true, "computed": true }, { - "name": "ipv6", + "name": "cis_id", "type": "TypeString", - "description": "ipv6 setting", - "options": "on, off", - "optional": true, - "computed": true + "description": "CIS instance crn", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:internet-svcs" + ] }, { - "name": "true_client_ip_header", + "name": "http2", "type": "TypeString", - "description": "true_client_ip_header setting", + "description": "http2 setting", "options": "on, off", "optional": true, "computed": true }, { - "name": "domain_id", - "type": "TypeString", - "description": "Associated CIS domain", - "required": true - }, - { - "name": "http2", + "name": "image_load_optimization", "type": "TypeString", - "description": "http2 setting", + "description": "image_load_optimization setting", "options": "on, off", "optional": true, "computed": true }, { - "name": "brotli", + "name": "script_load_optimization", "type": "TypeString", - "description": "brotli setting", + "description": "script_load_optimization setting", "options": "on, off", "optional": true, "computed": true @@ -87029,17 +91551,16 @@ }, "max_items": 1, "min_items": 1 - }, - { - "name": "always_use_https", - "type": "TypeString", - "description": "always_use_https setting", - "options": "on, off", - "optional": true, - "computed": true } ], "ibm_cis_edge_functions_action": [ + { + "name": "action_name", + "type": "TypeString", + "description": "Edge function action script name", + "immutable": true, + "required": true + }, { "name": "script", "type": "TypeString", @@ -87061,13 +91582,6 @@ "type": "TypeString", "description": "CIS Domain ID", "required": true - }, - { - "name": "action_name", - "type": "TypeString", - "description": "Edge function action script name", - "immutable": true, - "required": true } ], "ibm_cis_edge_functions_trigger": [ @@ -87156,17 +91670,6 @@ } ], "ibm_cis_firewall": [ - { - "name": "cis_id", - "type": "TypeString", - "description": "CIS object id", - "cloud_data_type": "resource_instance", - "immutable": true, - "required": true, - "cloud_data_range": [ - "service:internet-svcs" - ] - }, { "name": "domain_id", "type": "TypeString", @@ -87347,27 +91850,20 @@ } }, "max_items": 1 - } - ], - "ibm_cis_firewall_rule": [ - { - "name": "paused", - "type": "TypeBool", - "description": "Firewallrules Paused", - "optional": true }, { "name": "cis_id", "type": "TypeString", - "description": "CIS instance crn", - "required": true - }, - { - "name": "domain_id", - "type": "TypeString", - "description": "Associated CIS domain", - "required": true - }, + "description": "CIS object id", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true, + "cloud_data_range": [ + "service:internet-svcs" + ] + } + ], + "ibm_cis_firewall_rule": [ { "name": "filter_id", "type": "TypeString", @@ -87392,15 +91888,27 @@ "type": "TypeString", "description": "Firewallrules Description", "optional": true - } - ], - "ibm_cis_global_load_balancer": [ + }, { - "name": "steering_policy", - "type": "TypeString", - "description": "Steering policy info", + "name": "paused", + "type": "TypeBool", + "description": "Firewallrules Paused", "optional": true }, + { + "name": "cis_id", + "type": "TypeString", + "description": "CIS instance crn", + "required": true + }, + { + "name": "domain_id", + "type": "TypeString", + "description": "Associated CIS domain", + "required": true + } + ], + "ibm_cis_global_load_balancer": [ { "name": "region_pools", "type": "TypeSet", @@ -87422,9 +91930,9 @@ } }, { - "name": "created_on", + "name": "modified_on", "type": "TypeString", - "description": "Load balancer creation date", + "description": "Load balancer modified date", "computed": true }, { @@ -87433,6 +91941,21 @@ "description": "name", "required": true }, + { + "name": "default_pool_ids", + "type": "TypeSet", + "description": "List of default Pool IDs", + "required": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "glb_id", + "type": "TypeString", + "description": "global load balancer id", + "computed": true + }, { "name": "fallback_pool_id", "type": "TypeString", @@ -87447,38 +91970,11 @@ "optional": true }, { - "name": "enabled", - "type": "TypeBool", - "description": "set to true of LB needs to enabled", - "default_value": true, - "optional": true - }, - { - "name": "pop_pools", - "type": "TypeSet", - "optional": true, - "elem": { - "pool_ids": { - "name": "pool_ids", - "type": "TypeList", - "required": true, - "elem": { - "type": "TypeString" - } - }, - "pop": { - "name": "pop", - "type": "TypeString", - "description": "pop pools region", - "required": true - } - } - }, - { - "name": "modified_on", + "name": "session_affinity", "type": "TypeString", - "description": "Load balancer modified date", - "computed": true + "description": "Session affinity info", + "default_value": "none", + "optional": true }, { "name": "cis_id", @@ -87490,6 +91986,12 @@ "service:internet-svcs" ] }, + { + "name": "domain_id", + "type": "TypeString", + "description": "Associated CIS domain", + "required": true + }, { "name": "description", "type": "TypeString", @@ -87497,48 +91999,64 @@ "optional": true }, { - "name": "session_affinity", + "name": "steering_policy", "type": "TypeString", - "description": "Session affinity info", - "default_value": "none", + "description": "Steering policy info", "optional": true }, { - "name": "domain_id", - "type": "TypeString", - "description": "Associated CIS domain", - "required": true + "name": "pop_pools", + "type": "TypeSet", + "optional": true, + "elem": { + "pool_ids": { + "name": "pool_ids", + "type": "TypeList", + "required": true, + "elem": { + "type": "TypeString" + } + }, + "pop": { + "name": "pop", + "type": "TypeString", + "description": "pop pools region", + "required": true + } + } }, { - "name": "glb_id", + "name": "created_on", "type": "TypeString", - "description": "global load balancer id", + "description": "Load balancer creation date", "computed": true }, - { - "name": "default_pool_ids", - "type": "TypeSet", - "description": "List of default Pool IDs", - "required": true, - "elem": { - "type": "TypeString" - } - }, { "name": "proxied", "type": "TypeBool", "description": "set to true if proxy needs to be enabled", "default_value": false, "optional": true + }, + { + "name": "enabled", + "type": "TypeBool", + "description": "set to true of LB needs to enabled", + "default_value": true, + "optional": true } ], "ibm_cis_healthcheck": [ { - "name": "method", + "name": "expected_body", "type": "TypeString", - "description": "method", - "default_value": "GET", - "options": "GET, HEAD", + "description": "expected_body", + "optional": true + }, + { + "name": "expected_codes", + "type": "TypeString", + "description": "expected_codes", "optional": true }, { @@ -87551,40 +92069,17 @@ "optional": true }, { - "name": "allow_insecure", + "name": "follow_redirects", "type": "TypeBool", - "description": "allow_insecure", + "description": "follow_redirects", "default_value": false, "optional": true }, { - "name": "modified_on", - "type": "TypeString", - "computed": true - }, - { - "name": "port", - "type": "TypeInt", - "description": "port number", - "min_value": "1", - "max_value": "65535", - "optional": true, - "computed": true - }, - { - "name": "cis_id", - "type": "TypeString", - "description": "CIS instance crn", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:internet-svcs" - ] - }, - { - "name": "expected_codes", + "name": "path", "type": "TypeString", - "description": "expected_codes", + "description": "path", + "default_value": "/", "optional": true }, { @@ -87595,7 +92090,15 @@ "optional": true }, { - "name": "create_on", + "name": "type", + "type": "TypeString", + "description": "type", + "default_value": "http", + "options": "http, https, tcp", + "optional": true + }, + { + "name": "modified_on", "type": "TypeString", "computed": true }, @@ -87620,10 +92123,34 @@ } }, { - "name": "path", + "name": "monitor_id", "type": "TypeString", - "description": "path", - "default_value": "/", + "description": "GLB Monitor/Health check id", + "computed": true + }, + { + "name": "allow_insecure", + "type": "TypeBool", + "description": "allow_insecure", + "default_value": false, + "optional": true + }, + { + "name": "cis_id", + "type": "TypeString", + "description": "CIS instance crn", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:internet-svcs" + ] + }, + { + "name": "method", + "type": "TypeString", + "description": "method", + "default_value": "GET", + "options": "GET, HEAD", "optional": true }, { @@ -87635,13 +92162,6 @@ "max_value": "3", "optional": true }, - { - "name": "follow_redirects", - "type": "TypeBool", - "description": "follow_redirects", - "default_value": false, - "optional": true - }, { "name": "interval", "type": "TypeInt", @@ -87652,39 +92172,21 @@ "optional": true }, { - "name": "monitor_id", + "name": "create_on", "type": "TypeString", - "description": "GLB Monitor/Health check id", "computed": true }, { - "name": "expected_body", - "type": "TypeString", - "description": "expected_body", - "optional": true - }, - { - "name": "type", - "type": "TypeString", - "description": "type", - "default_value": "http", - "options": "http, https, tcp", - "optional": true + "name": "port", + "type": "TypeInt", + "description": "port number", + "min_value": "1", + "max_value": "65535", + "optional": true, + "computed": true } ], "ibm_cis_logpush_job": [ - { - "name": "dataset", - "type": "TypeString", - "description": "Dataset to be pulled", - "required": true - }, - { - "name": "frequency", - "type": "TypeString", - "description": "The frequency at which CIS sends batches of logs to your destination", - "optional": true - }, { "name": "job_id", "type": "TypeInt", @@ -87692,10 +92194,14 @@ "computed": true }, { - "name": "destination_conf", + "name": "cis_id", "type": "TypeString", - "description": "Uniquely identifies a resource (such as an s3 bucket) where data will be pushed.", - "computed": true + "description": "CIS instance crn", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:internet-svcs" + ] }, { "name": "domain_id", @@ -87704,10 +92210,11 @@ "required": true }, { - "name": "enabled", - "type": "TypeBool", - "description": "Whether the logpush job enabled or not", - "optional": true + "name": "logdna", + "type": "TypeString", + "description": "Information to identify the LogDNA instance the data will be pushed.", + "secure": true, + "required": true }, { "name": "name", @@ -87715,6 +92222,12 @@ "description": "Logpush Job Name", "optional": true }, + { + "name": "enabled", + "type": "TypeBool", + "description": "Whether the logpush job enabled or not", + "optional": true + }, { "name": "logpull_options", "type": "TypeString", @@ -87722,24 +92235,31 @@ "optional": true }, { - "name": "cis_id", + "name": "dataset", "type": "TypeString", - "description": "CIS instance crn", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:internet-svcs" - ] + "description": "Dataset to be pulled", + "required": true }, { - "name": "logdna", + "name": "frequency", "type": "TypeString", - "description": "Information to identify the LogDNA instance the data will be pushed.", - "secure": true, - "required": true + "description": "The frequency at which CIS sends batches of logs to your destination", + "optional": true + }, + { + "name": "destination_conf", + "type": "TypeString", + "description": "Uniquely identifies a resource (such as an s3 bucket) where data will be pushed.", + "computed": true } ], "ibm_cis_mtls": [ + { + "name": "id", + "type": "TypeString", + "description": "Certificate ID", + "computed": true + }, { "name": "mtls_id", "type": "TypeString", @@ -87753,12 +92273,6 @@ "secure": true, "required": true }, - { - "name": "name", - "type": "TypeString", - "description": "Certificate name", - "required": true - }, { "name": "associated_hostnames", "type": "TypeList", @@ -87772,73 +92286,18 @@ "name": "created_at", "type": "TypeString", "description": "Certificate Created At", - "computed": true - }, - { - "name": "cis_id", - "type": "TypeString", - "description": "CIS instance crn", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:internet-svcs" - ] - }, - { - "name": "domain_id", - "type": "TypeString", - "description": "Associated CIS domain", - "required": true - }, - { - "name": "updated_at", - "type": "TypeString", - "description": "Certificate Updated At", - "computed": true - }, - { - "name": "expires_on", - "type": "TypeString", - "description": "Certificate Expires on", - "computed": true - }, - { - "name": "id", - "type": "TypeString", - "description": "Certificate ID", - "computed": true - } - ], - "ibm_cis_mtls_app": [ - { - "name": "session_duration", - "type": "TypeString", - "description": "Duration for app validatidity", - "default_value": "24h", - "optional": true - }, - { - "name": "domain_id", - "type": "TypeString", - "description": "Associated CIS domain", - "required": true - }, - { - "name": "common_rule_val", - "type": "TypeString", - "description": "Policy common rule value", - "optional": true + "computed": true }, { - "name": "app_created_at", + "name": "updated_at", "type": "TypeString", - "description": "Certificate Created At", + "description": "Certificate Updated At", "computed": true }, { - "name": "pol_updated_at", + "name": "expires_on", "type": "TypeString", - "description": "Policy updated At", + "description": "Certificate Expires on", "computed": true }, { @@ -87852,17 +92311,25 @@ ] }, { - "name": "policy_decision", + "name": "domain_id", "type": "TypeString", - "description": "Policy Action", - "default_value": "non_identity", - "optional": true + "description": "Associated CIS domain", + "required": true }, { - "name": "app_updated_at", + "name": "name", "type": "TypeString", - "description": "Certificate Updated At", - "computed": true + "description": "Certificate name", + "required": true + } + ], + "ibm_cis_mtls_app": [ + { + "name": "policy_name", + "type": "TypeString", + "description": "Policy Name", + "default_value": "mtls-policy", + "optional": true }, { "name": "pol_created_at", @@ -87871,22 +92338,40 @@ "computed": true }, { - "name": "policy_id", + "name": "app_id", "type": "TypeString", - "description": "Policy ID", + "description": "APP ID", "computed": true }, { - "name": "name", + "name": "app_created_at", "type": "TypeString", - "description": "App Name", + "description": "Certificate Created At", + "computed": true + }, + { + "name": "pol_updated_at", + "type": "TypeString", + "description": "Policy updated At", + "computed": true + }, + { + "name": "domain_id", + "type": "TypeString", + "description": "Associated CIS domain", "required": true }, { - "name": "policy_name", + "name": "policy_decision", "type": "TypeString", - "description": "Policy Name", - "default_value": "mtls-policy", + "description": "Policy Action", + "default_value": "non_identity", + "optional": true + }, + { + "name": "common_rule_val", + "type": "TypeString", + "description": "Policy common rule value", "optional": true }, { @@ -87897,37 +92382,48 @@ "optional": true }, { - "name": "app_id", + "name": "app_updated_at", "type": "TypeString", - "description": "APP ID", + "description": "Certificate Updated At", + "computed": true + }, + { + "name": "policy_id", + "type": "TypeString", + "description": "Policy ID", "computed": true }, + { + "name": "cis_id", + "type": "TypeString", + "description": "CIS instance crn", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:internet-svcs" + ] + }, { "name": "domain", "type": "TypeString", "description": "Associated host domain value", "required": true - } - ], - "ibm_cis_origin_auth": [ - { - "name": "auth_id", - "type": "TypeString", - "description": "Associated CIS auth pull job id", - "computed": true }, { - "name": "domain_id", + "name": "name", "type": "TypeString", - "description": "Associated CIS domain", + "description": "App Name", "required": true }, { - "name": "hostname", + "name": "session_duration", "type": "TypeString", - "description": "Host name needed for host level authentication", + "description": "Duration for app validatidity", + "default_value": "24h", "optional": true - }, + } + ], + "ibm_cis_origin_auth": [ { "name": "enabled", "type": "TypeBool", @@ -87943,16 +92439,21 @@ "required": true }, { - "name": "private_key", + "name": "status", "type": "TypeString", - "description": "Private key content which needs to be uploaded", - "secure": true, - "required": true + "description": "Authentication status whether active or not", + "computed": true }, { - "name": "expires_on", + "name": "cert_id", "type": "TypeString", - "description": "Certificate expires on", + "description": "Certificate ID which is uploaded", + "computed": true + }, + { + "name": "auth_id", + "type": "TypeString", + "description": "Associated CIS auth pull job id", "computed": true }, { @@ -87965,6 +92466,12 @@ "service:internet-svcs" ] }, + { + "name": "domain_id", + "type": "TypeString", + "description": "Associated CIS domain", + "required": true + }, { "name": "level", "type": "TypeString", @@ -87972,15 +92479,22 @@ "required": true }, { - "name": "status", + "name": "hostname", "type": "TypeString", - "description": "Authentication status whether active or not", - "computed": true + "description": "Host name needed for host level authentication", + "optional": true }, { - "name": "cert_id", + "name": "private_key", "type": "TypeString", - "description": "Certificate ID which is uploaded", + "description": "Private key content which needs to be uploaded", + "secure": true, + "required": true + }, + { + "name": "expires_on", + "type": "TypeString", + "description": "Certificate expires on", "computed": true }, { @@ -87991,6 +92505,21 @@ } ], "ibm_cis_origin_pool": [ + { + "name": "check_regions", + "type": "TypeSet", + "description": "List of regions", + "required": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "description", + "type": "TypeString", + "description": "Description of the CIS Origin Pool", + "optional": true + }, { "name": "monitor", "type": "TypeString", @@ -87998,16 +92527,32 @@ "optional": true }, { - "name": "healthy", - "type": "TypeBool", - "description": "Health status", - "computed": true + "name": "notification_email", + "type": "TypeString", + "description": "Email address configured to recieve the notifications", + "optional": true + }, + { + "name": "cis_id", + "type": "TypeString", + "description": "CIS instance crn", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:internet-svcs" + ] }, { "name": "pool_id", "type": "TypeString", "computed": true }, + { + "name": "name", + "type": "TypeString", + "description": "name", + "required": true + }, { "name": "minimum_origins", "type": "TypeInt", @@ -88015,6 +92560,12 @@ "default_value": 1, "optional": true }, + { + "name": "enabled", + "type": "TypeBool", + "description": "Boolean value set to true if cis origin pool needs to be enabled", + "required": true + }, { "name": "origins", "type": "TypeSet", @@ -88060,65 +92611,28 @@ } }, { - "name": "created_on", - "type": "TypeString", - "description": "Creation date info", - "computed": true - }, - { - "name": "modified_on", + "name": "health", "type": "TypeString", - "description": "Modified date info", + "description": "Health info", "computed": true }, { - "name": "check_regions", - "type": "TypeSet", - "description": "List of regions", - "required": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "name", - "type": "TypeString", - "description": "name", - "required": true - }, - { - "name": "description", - "type": "TypeString", - "description": "Description of the CIS Origin Pool", - "optional": true - }, - { - "name": "enabled", + "name": "healthy", "type": "TypeBool", - "description": "Boolean value set to true if cis origin pool needs to be enabled", - "required": true - }, - { - "name": "notification_email", - "type": "TypeString", - "description": "Email address configured to recieve the notifications", - "optional": true + "description": "Health status", + "computed": true }, { - "name": "health", + "name": "created_on", "type": "TypeString", - "description": "Health info", + "description": "Creation date info", "computed": true }, { - "name": "cis_id", + "name": "modified_on", "type": "TypeString", - "description": "CIS instance crn", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:internet-svcs" - ] + "description": "Modified date info", + "computed": true } ], "ibm_cis_page_rule": [ @@ -88128,6 +92642,18 @@ "description": "Id of the ibm_cis_page_rule", "computed": true }, + { + "name": "rule_id", + "type": "TypeString", + "computed": true + }, + { + "name": "priority", + "type": "TypeInt", + "description": "Page rule priority", + "default_value": 1, + "optional": true + }, { "name": "status", "type": "TypeString", @@ -88236,21 +92762,38 @@ "type": "TypeString", "description": "Associated CIS domain", "required": true + } + ], + "ibm_cis_range_app": [ + { + "name": "proxy_protocol", + "type": "TypeString", + "description": "Allows for the true client IP to be passed to the service.", + "options": "off, v1, v2, simple", + "optional": true }, { - "name": "rule_id", + "name": "edge_ips_type", "type": "TypeString", - "computed": true + "description": "The type of edge IP configuration.", + "default_value": "dynamic", + "options": "dynamic", + "optional": true }, { - "name": "priority", - "type": "TypeInt", - "description": "Page rule priority", - "default_value": 1, + "name": "edge_ips_connectivity", + "type": "TypeString", + "description": "Specifies the IP version.", + "default_value": "all", + "options": "ipv4, ipv6, all", "optional": true - } - ], - "ibm_cis_range_app": [ + }, + { + "name": "dns_type", + "type": "TypeString", + "description": "Type of the DNS record for this application", + "required": true + }, { "name": "ip_firewall", "type": "TypeBool", @@ -88258,10 +92801,16 @@ "optional": true }, { - "name": "protocol", + "name": "created_on", "type": "TypeString", - "description": "Defines the protocol and port for this application", - "required": true + "description": "created on date", + "computed": true + }, + { + "name": "modified_on", + "type": "TypeString", + "description": "modified on date", + "computed": true }, { "name": "domain_id", @@ -88270,16 +92819,24 @@ "required": true }, { - "name": "origin_dns", + "name": "app_id", "type": "TypeString", - "description": "DNS record pointing to the origin for this Range application.", - "optional": true + "description": "Application identifier", + "computed": true }, { - "name": "proxy_protocol", + "name": "origin_direct", + "type": "TypeList", + "description": "IP address and port of the origin for this Range application.", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "origin_dns", "type": "TypeString", - "description": "Allows for the true client IP to be passed to the service.", - "options": "off, v1, v2, simple", + "description": "DNS record pointing to the origin for this Range application.", "optional": true }, { @@ -88298,12 +92855,6 @@ "options": "off, flexible, full, strict", "optional": true }, - { - "name": "modified_on", - "type": "TypeString", - "description": "modified on date", - "computed": true - }, { "name": "cis_id", "type": "TypeString", @@ -88315,90 +92866,25 @@ ] }, { - "name": "origin_direct", - "type": "TypeList", - "description": "IP address and port of the origin for this Range application.", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "origin_port", - "type": "TypeInt", - "description": "Port at the origin that listens to traffic", - "optional": true - }, - { - "name": "edge_ips_connectivity", - "type": "TypeString", - "description": "Specifies the IP version.", - "default_value": "all", - "options": "ipv4, ipv6, all", - "optional": true - }, - { - "name": "app_id", - "type": "TypeString", - "description": "Application identifier", - "computed": true - }, - { - "name": "dns_type", + "name": "protocol", "type": "TypeString", - "description": "Type of the DNS record for this application", + "description": "Defines the protocol and port for this application", "required": true }, - { - "name": "edge_ips_type", - "type": "TypeString", - "description": "The type of edge IP configuration.", - "default_value": "dynamic", - "options": "dynamic", - "optional": true - }, - { - "name": "created_on", - "type": "TypeString", - "description": "created on date", - "computed": true - }, { "name": "dns", "type": "TypeString", "description": "Name of the DNS record for this application", "required": true + }, + { + "name": "origin_port", + "type": "TypeInt", + "description": "Port at the origin that listens to traffic", + "optional": true } ], "ibm_cis_rate_limit": [ - { - "name": "description", - "type": "TypeString", - "description": "A note that you can use to describe the reason for a rate limiting rule.", - "max_length": 1024, - "optional": true - }, - { - "name": "bypass", - "type": "TypeList", - "description": "Bypass URL", - "optional": true, - "elem": { - "name": { - "name": "name", - "type": "TypeString", - "description": "bypass URL name", - "default_value": "url", - "optional": true - }, - "value": { - "name": "value", - "type": "TypeString", - "description": "bypass URL value", - "optional": true - } - } - }, { "name": "action", "type": "TypeList", @@ -88442,6 +92928,95 @@ "max_items": 1, "min_items": 1 }, + { + "name": "domain_id", + "type": "TypeString", + "description": "CIS Domain ID", + "required": true + }, + { + "name": "disabled", + "type": "TypeBool", + "description": "Whether this rate limiting rule is currently disabled.", + "default_value": false, + "optional": true + }, + { + "name": "description", + "type": "TypeString", + "description": "A note that you can use to describe the reason for a rate limiting rule.", + "max_length": 1024, + "optional": true + }, + { + "name": "bypass", + "type": "TypeList", + "description": "Bypass URL", + "optional": true, + "elem": { + "name": { + "name": "name", + "type": "TypeString", + "description": "bypass URL name", + "default_value": "url", + "optional": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "bypass URL value", + "optional": true + } + } + }, + { + "name": "threshold", + "type": "TypeInt", + "description": "Rate Limiting Threshold", + "required": true, + "min_value": "1", + "max_value": "1000000" + }, + { + "name": "period", + "type": "TypeInt", + "description": "Rate Limiting Period", + "required": true, + "min_value": "1", + "max_value": "86400" + }, + { + "name": "correlate", + "type": "TypeList", + "description": "Ratelimiting Correlate", + "optional": true, + "elem": { + "by": { + "name": "by", + "type": "TypeString", + "description": "Whether to enable NAT based rate limiting", + "default_value": "nat", + "optional": true + } + }, + "max_items": 1 + }, + { + "name": "cis_id", + "type": "TypeString", + "description": "CIS Intance CRN", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:internet-svcs" + ] + }, + { + "name": "rule_id", + "type": "TypeString", + "description": "Rate Limit rule Id", + "computed": true + }, { "name": "match", "type": "TypeList", @@ -88539,67 +93114,6 @@ } }, "max_items": 1 - }, - { - "name": "cis_id", - "type": "TypeString", - "description": "CIS Intance CRN", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:internet-svcs" - ] - }, - { - "name": "domain_id", - "type": "TypeString", - "description": "CIS Domain ID", - "required": true - }, - { - "name": "disabled", - "type": "TypeBool", - "description": "Whether this rate limiting rule is currently disabled.", - "default_value": false, - "optional": true - }, - { - "name": "threshold", - "type": "TypeInt", - "description": "Rate Limiting Threshold", - "required": true, - "min_value": "1", - "max_value": "1000000" - }, - { - "name": "period", - "type": "TypeInt", - "description": "Rate Limiting Period", - "required": true, - "min_value": "1", - "max_value": "86400" - }, - { - "name": "correlate", - "type": "TypeList", - "description": "Ratelimiting Correlate", - "optional": true, - "elem": { - "by": { - "name": "by", - "type": "TypeString", - "description": "Whether to enable NAT based rate limiting", - "default_value": "nat", - "optional": true - } - }, - "max_items": 1 - }, - { - "name": "rule_id", - "type": "TypeString", - "description": "Rate Limit rule Id", - "computed": true } ], "ibm_cis_routing": [ @@ -88629,16 +93143,6 @@ } ], "ibm_cis_tls_settings": [ - { - "name": "cis_id", - "type": "TypeString", - "description": "CIS instance crn", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:internet-svcs" - ] - }, { "name": "domain_id", "type": "TypeString", @@ -88667,9 +93171,29 @@ "default_value": "1.1", "options": "1.1, 1.2, 1.3, 1.4", "optional": true + }, + { + "name": "cis_id", + "type": "TypeString", + "description": "CIS instance crn", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:internet-svcs" + ] } ], "ibm_cis_waf_group": [ + { + "name": "cis_id", + "type": "TypeString", + "description": "CIS Intance CRN", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:internet-svcs" + ] + }, { "name": "domain_id", "type": "TypeString", @@ -88677,15 +93201,16 @@ "required": true }, { - "name": "description", + "name": "group_id", "type": "TypeString", - "description": "WAF Rule group description", - "computed": true + "description": "WAF Rule group id", + "immutable": true, + "required": true }, { - "name": "rules_count", - "type": "TypeInt", - "description": "WAF Rule group rules count", + "name": "name", + "type": "TypeString", + "description": "WAF Rule group name", "computed": true }, { @@ -88701,29 +93226,12 @@ "default_value": false, "optional": true }, - { - "name": "cis_id", - "type": "TypeString", - "description": "CIS Intance CRN", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:internet-svcs" - ] - }, { "name": "package_id", "type": "TypeString", "description": "WAF Rule package id", "required": true }, - { - "name": "group_id", - "type": "TypeString", - "description": "WAF Rule group id", - "immutable": true, - "required": true - }, { "name": "mode", "type": "TypeString", @@ -88732,19 +93240,19 @@ "options": "on, off" }, { - "name": "name", + "name": "description", "type": "TypeString", - "description": "WAF Rule group name", + "description": "WAF Rule group description", + "computed": true + }, + { + "name": "rules_count", + "type": "TypeInt", + "description": "WAF Rule group rules count", "computed": true } ], "ibm_cis_waf_package": [ - { - "name": "detection_mode", - "type": "TypeString", - "description": "WAF pakcage detection mode", - "computed": true - }, { "name": "sensitivity", "type": "TypeString", @@ -88793,9 +93301,25 @@ "type": "TypeString", "description": "WAF pakcage name", "computed": true + }, + { + "name": "detection_mode", + "type": "TypeString", + "description": "WAF pakcage detection mode", + "computed": true } ], "ibm_cis_waf_rule": [ + { + "name": "cis_id", + "type": "TypeString", + "description": "CIS Intance CRN", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:internet-svcs" + ] + }, { "name": "domain_id", "type": "TypeString", @@ -88803,18 +93327,17 @@ "required": true }, { - "name": "rule_id", + "name": "package_id", "type": "TypeString", - "description": "CIS WAF Rule id", + "description": "CIS WAF Rule package id", "immutable": true, "required": true }, { - "name": "mode", + "name": "description", "type": "TypeString", - "description": "CIS WAF Rule mode", - "required": true, - "options": "on, off, default, disable, simulate, block, challenge" + "description": "CIS WAF Rule descriptions", + "computed": true }, { "name": "priority", @@ -88843,27 +93366,18 @@ } }, { - "name": "cis_id", - "type": "TypeString", - "description": "CIS Intance CRN", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:internet-svcs" - ] - }, - { - "name": "package_id", + "name": "rule_id", "type": "TypeString", - "description": "CIS WAF Rule package id", + "description": "CIS WAF Rule id", "immutable": true, "required": true }, { - "name": "description", + "name": "mode", "type": "TypeString", - "description": "CIS WAF Rule descriptions", - "computed": true + "description": "CIS WAF Rule mode", + "required": true, + "options": "on, off, default, disable, simulate, block, challenge" }, { "name": "allowed_modes", @@ -88876,6 +93390,16 @@ } ], "ibm_cis_webhook": [ + { + "name": "cis_id", + "type": "TypeString", + "description": "CIS instance crn", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:internet-svcs" + ] + }, { "name": "webhook_id", "type": "TypeString", @@ -88906,57 +93430,31 @@ "description": "API key needed to use the webhook", "secure": true, "optional": true - }, - { - "name": "cis_id", - "type": "TypeString", - "description": "CIS instance crn", - "cloud_data_type": "resource_instance", - "required": true, - "cloud_data_range": [ - "service:internet-svcs" - ] } ], "ibm_cloud_shell_account_settings": [ { - "name": "rev", - "type": "TypeString", - "description": "Unique revision number for the settings object.", - "optional": true, - "computed": true - }, - { - "name": "default_enable_new_features", + "name": "enabled", "type": "TypeBool", - "description": "You can choose which Cloud Shell features are available in the account and whether any new features are enabled as they become available. The feature settings apply only to the enabled Cloud Shell locations.", + "description": "When enabled, Cloud Shell is available to all users in the account.", "optional": true }, { - "name": "regions", - "type": "TypeList", - "description": "List of Cloud Shell region settings.", - "optional": true, - "computed": true, - "elem": { - "enabled": { - "name": "enabled", - "type": "TypeBool", - "description": "State of the region.", - "optional": true - }, - "key": { - "name": "key", - "type": "TypeString", - "description": "Name of the region.", - "optional": true - } - } + "name": "created_at", + "type": "TypeInt", + "description": "Creation timestamp in Unix epoch time.", + "computed": true }, { - "name": "type", + "name": "created_by", "type": "TypeString", - "description": "Type of api response object.", + "description": "IAM ID of creator.", + "computed": true + }, + { + "name": "updated_at", + "type": "TypeInt", + "description": "Timestamp of last update in Unix epoch time.", "computed": true }, { @@ -88973,17 +93471,30 @@ "required": true }, { - "name": "default_enable_new_regions", + "name": "default_enable_new_features", "type": "TypeBool", - "description": "Set whether Cloud Shell is enabled in a specific location for the account. The location determines where user and session data are stored. By default, users are routed to the nearest available location.", + "description": "You can choose which Cloud Shell features are available in the account and whether any new features are enabled as they become available. The feature settings apply only to the enabled Cloud Shell locations.", "optional": true }, { - "name": "enabled", + "name": "default_enable_new_regions", "type": "TypeBool", - "description": "When enabled, Cloud Shell is available to all users in the account.", + "description": "Set whether Cloud Shell is enabled in a specific location for the account. The location determines where user and session data are stored. By default, users are routed to the nearest available location.", "optional": true }, + { + "name": "type", + "type": "TypeString", + "description": "Type of api response object.", + "computed": true + }, + { + "name": "rev", + "type": "TypeString", + "description": "Unique revision number for the settings object.", + "optional": true, + "computed": true + }, { "name": "features", "type": "TypeList", @@ -89006,94 +93517,70 @@ } }, { - "name": "created_at", - "type": "TypeInt", - "description": "Creation timestamp in Unix epoch time.", - "computed": true - }, - { - "name": "created_by", - "type": "TypeString", - "description": "IAM ID of creator.", - "computed": true - }, - { - "name": "updated_at", - "type": "TypeInt", - "description": "Timestamp of last update in Unix epoch time.", - "computed": true + "name": "regions", + "type": "TypeList", + "description": "List of Cloud Shell region settings.", + "optional": true, + "computed": true, + "elem": { + "enabled": { + "name": "enabled", + "type": "TypeBool", + "description": "State of the region.", + "optional": true + }, + "key": { + "name": "key", + "type": "TypeString", + "description": "Name of the region.", + "optional": true + } + } } ], "ibm_cloudant": [ { - "name": "resource_aliases_url", - "type": "TypeString", - "description": "The relative path to the resource aliases for the instance.", - "computed": true - }, - { - "name": "resource_keys_url", - "type": "TypeString", - "description": "The relative path to the resource keys for the instance.", - "computed": true - }, - { - "name": "resource_status", - "type": "TypeString", - "description": "The status of the resource", - "computed": true + "name": "parameters", + "type": "TypeMap", + "description": "Arbitrary parameters to pass. Must be a JSON object", + "optional": true }, { - "name": "plan", - "type": "TypeString", - "description": "The plan type of the service", - "required": true + "name": "plan_history", + "type": "TypeList", + "description": "The plan history of the instance.", + "computed": true, + "elem": { + "resource_plan_id": { + "name": "resource_plan_id", + "type": "TypeString", + "computed": true + }, + "start_date": { + "name": "start_date", + "type": "TypeString", + "computed": true + } + } }, { - "name": "crn", - "type": "TypeString", - "description": "CRN of resource instance", - "cloud_data_type": "crn", + "name": "allow_cleanup", + "type": "TypeBool", + "description": "A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.", "computed": true }, { - "name": "resource_id", + "name": "resource_keys_url", "type": "TypeString", - "description": "The unique ID of the offering", + "description": "The relative path to the resource keys for the instance.", "computed": true }, { - "name": "deleted_at", + "name": "update_by", "type": "TypeString", - "description": "The date when the instance was deleted.", + "description": "The subject who updated the instance.", "computed": true }, - { - "name": "cors_config", - "type": "TypeList", - "description": "Configuration for CORS.", - "optional": true, - "elem": { - "allow_credentials": { - "name": "allow_credentials", - "type": "TypeBool", - "description": "Boolean value to allow authentication credentials. If set to true, browser requests must be done by using withCredentials = true.", - "default_value": true, - "optional": true - }, - "origins": { - "name": "origins", - "type": "TypeList", - "description": "An array of strings that contain allowed origin domains. You have to specify the full URL including the protocol. It is recommended that only the HTTPS protocol is used. Subdomains count as separate domains, so you have to specify all subdomains used.", - "required": true, - "elem": { - "type": "TypeString" - } - } - }, - "max_items": 1, - "min_items": 1 - }, { "name": "tags", "type": "TypeSet", @@ -89105,15 +93592,10 @@ } }, { - "name": "resource_plan_id", - "type": "TypeString", - "description": "The unique ID of the plan associated with the offering", - "computed": true - }, - { - "name": "resource_bindings_url", + "name": "service_endpoints", "type": "TypeString", - "description": "The relative path to the resource bindings for the instance.", + "description": "Types of the service endpoints. Possible values are 'public', 'private', 'public-and-private'.", + "optional": true, "computed": true }, { @@ -89123,58 +93605,62 @@ "computed": true }, { - "name": "created_at", + "name": "target_crn", "type": "TypeString", - "description": "The date when the instance was created.", + "description": "The full deployment CRN as defined in the global catalog", "computed": true }, { - "name": "update_by", + "name": "state", "type": "TypeString", - "description": "The subject who updated the instance.", + "description": "The current state of the instance.", "computed": true }, { - "name": "extensions", - "type": "TypeMap", - "description": "The extended metadata as a map associated with the resource instance.", + "name": "locked", + "type": "TypeBool", + "description": "A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.", "computed": true }, { - "name": "include_data_events", - "type": "TypeBool", - "description": "Include data event types in events sent to IBM Cloud Activity Tracker with LogDNA for the IBM Cloudant instance. By default only emitted events are of \"management\" type.", - "default_value": false, - "optional": true + "name": "created_by", + "type": "TypeString", + "description": "The subject who created the instance.", + "computed": true }, { - "name": "service", + "name": "environment_crn", "type": "TypeString", - "description": "The service type of the instance", - "computed": true + "description": "CRN of the IBM Cloudant Dedicated Hardware plan instance", + "immutable": true, + "optional": true }, { - "name": "parameters", - "type": "TypeMap", - "description": "Arbitrary parameters to pass. Must be a JSON object", + "name": "capacity", + "type": "TypeInt", + "description": "A number of blocks of throughput units. A block consists of 100 reads/sec, 50 writes/sec, and 5 global queries/sec of provisioned throughput capacity.", + "default_value": 1, "optional": true }, { - "name": "status", + "name": "resource_group_id", "type": "TypeString", - "description": "Status of resource instance", + "description": "The resource group id", + "cloud_data_type": "resource_group", + "immutable": true, + "optional": true, "computed": true }, { - "name": "account_id", + "name": "status", "type": "TypeString", - "description": "An alpha-numeric value identifying the account ID.", + "description": "Status of resource instance", "computed": true }, { - "name": "target_crn", + "name": "resource_id", "type": "TypeString", - "description": "The full deployment CRN as defined in the global catalog", + "description": "The unique ID of the offering", "computed": true }, { @@ -89184,87 +93670,101 @@ "computed": true }, { - "name": "parameters_json", + "name": "update_at", "type": "TypeString", - "description": "Arbitrary parameters to pass in Json string format", - "optional": true + "description": "The date when the instance was last updated.", + "computed": true }, { - "name": "service_endpoints", + "name": "scheduled_reclaim_by", "type": "TypeString", - "description": "Types of the service endpoints. Possible values are 'public', 'private', 'public-and-private'.", - "optional": true, + "description": "The subject who initiated the instance reclamation.", "computed": true }, { - "name": "dashboard_url", + "name": "include_data_events", + "type": "TypeBool", + "description": "Include data event types in events sent to IBM Cloud Activity Tracker with LogDNA for the IBM Cloudant instance. By default only emitted events are of \"management\" type.", + "default_value": false, + "optional": true + }, + { + "name": "resource_name", "type": "TypeString", - "description": "Dashboard URL to access resource.", + "description": "The name of the resource", "computed": true }, { - "name": "deleted_by", + "name": "resource_status", "type": "TypeString", - "description": "The subject who deleted the instance.", + "description": "The status of the resource", "computed": true }, { - "name": "resource_controller_url", + "name": "throughput", + "type": "TypeMap", + "description": "Schema for detailed information about throughput capacity with breakdown by specific throughput requests classes.", + "computed": true, + "elem": { + "type": "TypeInt" + } + }, + { + "name": "restored_at", "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource", + "description": "The date when the instance under reclamation was restored.", "computed": true }, { - "name": "resource_group_id", + "name": "location", "type": "TypeString", - "description": "The resource group id", - "cloud_data_type": "resource_group", + "description": "The location where the instance available", + "cloud_data_type": "region", "immutable": true, - "optional": true, - "computed": true + "required": true }, { - "name": "created_by", + "name": "parameters_json", "type": "TypeString", - "description": "The subject who created the instance.", - "computed": true + "description": "Arbitrary parameters to pass in Json string format", + "optional": true }, { - "name": "update_at", + "name": "crn", "type": "TypeString", - "description": "The date when the instance was last updated.", + "description": "CRN of resource instance", + "cloud_data_type": "crn", "computed": true }, { - "name": "allow_cleanup", - "type": "TypeBool", - "description": "A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.", + "name": "account_id", + "type": "TypeString", + "description": "An alpha-numeric value identifying the account ID.", "computed": true }, { - "name": "locked", - "type": "TypeBool", - "description": "A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.", + "name": "last_operation", + "type": "TypeMap", + "description": "The status of the last operation requested on the instance", "computed": true }, { - "name": "restored_at", + "name": "deleted_by", "type": "TypeString", - "description": "The date when the instance under reclamation was restored.", + "description": "The subject who deleted the instance.", "computed": true }, { - "name": "resource_crn", + "name": "scheduled_reclaim_at", "type": "TypeString", - "description": "The crn of the resource", + "description": "The date when the instance was scheduled for reclamation.", "computed": true }, { - "name": "capacity", - "type": "TypeInt", - "description": "A number of blocks of throughput units. A block consists of 100 reads/sec, 50 writes/sec, and 5 global queries/sec of provisioned throughput capacity.", - "default_value": 1, - "optional": true + "name": "extensions", + "type": "TypeMap", + "description": "The extended metadata as a map associated with the resource instance.", + "computed": true }, { "name": "name", @@ -89273,132 +93773,132 @@ "required": true }, { - "name": "plan_history", - "type": "TypeList", - "description": "The plan history of the instance.", - "computed": true, - "elem": { - "resource_plan_id": { - "name": "resource_plan_id", - "type": "TypeString", - "computed": true - }, - "start_date": { - "name": "start_date", - "type": "TypeString", - "computed": true - } - } - }, - { - "name": "type", + "name": "guid", "type": "TypeString", - "description": "The type of the instance, e.g. service_instance.", + "description": "Guid of resource instance", "computed": true }, { - "name": "enable_cors", - "type": "TypeBool", - "description": "Boolean value to turn CORS on and off.", - "default_value": true, - "optional": true + "name": "dashboard_url", + "type": "TypeString", + "description": "Dashboard URL to access resource.", + "computed": true }, { - "name": "environment_crn", + "name": "created_at", "type": "TypeString", - "description": "CRN of the IBM Cloudant Dedicated Hardware plan instance", - "immutable": true, - "optional": true + "description": "The date when the instance was created.", + "computed": true }, { - "name": "throughput", - "type": "TypeMap", - "description": "Schema for detailed information about throughput capacity with breakdown by specific throughput requests classes.", - "computed": true, - "elem": { - "type": "TypeInt" - } + "name": "resource_crn", + "type": "TypeString", + "description": "The crn of the resource", + "computed": true }, { - "name": "state", + "name": "resource_group_name", "type": "TypeString", - "description": "The current state of the instance.", + "description": "The resource group name in which resource is provisioned", "computed": true }, { - "name": "scheduled_reclaim_at", + "name": "service", "type": "TypeString", - "description": "The date when the instance was scheduled for reclamation.", + "description": "The service type of the instance", "computed": true }, { - "name": "resource_group_name", + "name": "plan", "type": "TypeString", - "description": "The resource group name in which resource is provisioned", - "computed": true + "description": "The plan type of the service", + "required": true }, { - "name": "scheduled_reclaim_by", + "name": "type", "type": "TypeString", - "description": "The subject who initiated the instance reclamation.", + "description": "The type of the instance, e.g. service_instance.", "computed": true }, { - "name": "restored_by", + "name": "resource_bindings_url", "type": "TypeString", - "description": "The subject who restored the instance back from reclamation.", + "description": "The relative path to the resource bindings for the instance.", "computed": true }, { - "name": "resource_name", + "name": "restored_by", "type": "TypeString", - "description": "The name of the resource", + "description": "The subject who restored the instance back from reclamation.", "computed": true }, { - "name": "legacy_credentials", + "name": "enable_cors", "type": "TypeBool", - "description": "Use both legacy credentials and IAM for authentication", - "default_value": false, - "immutable": true, + "description": "Boolean value to turn CORS on and off.", + "default_value": true, "optional": true }, { - "name": "location", + "name": "resource_plan_id", "type": "TypeString", - "description": "The location where the instance available", - "cloud_data_type": "region", - "immutable": true, - "required": true + "description": "The unique ID of the plan associated with the offering", + "computed": true }, { - "name": "guid", + "name": "resource_aliases_url", "type": "TypeString", - "description": "Guid of resource instance", + "description": "The relative path to the resource aliases for the instance.", "computed": true }, { - "name": "last_operation", - "type": "TypeMap", - "description": "The status of the last operation requested on the instance", + "name": "deleted_at", + "type": "TypeString", + "description": "The date when the instance was deleted.", "computed": true - } - ], - "ibm_cloudant_database": [ + }, { - "name": "instance_crn", + "name": "resource_controller_url", "type": "TypeString", - "description": "Cloudant Instance CRN.", - "immutable": true, - "required": true + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource", + "computed": true }, { - "name": "db", - "type": "TypeString", - "description": "Path parameter to specify the database name.", + "name": "legacy_credentials", + "type": "TypeBool", + "description": "Use both legacy credentials and IAM for authentication", + "default_value": false, "immutable": true, - "required": true + "optional": true }, + { + "name": "cors_config", + "type": "TypeList", + "description": "Configuration for CORS.", + "optional": true, + "elem": { + "allow_credentials": { + "name": "allow_credentials", + "type": "TypeBool", + "description": "Boolean value to allow authentication credentials. If set to true, browser requests must be done by using withCredentials = true.", + "default_value": true, + "optional": true + }, + "origins": { + "name": "origins", + "type": "TypeList", + "description": "An array of strings that contain allowed origin domains. You have to specify the full URL including the protocol. It is recommended that only the HTTPS protocol is used. Subdomains count as separate domains, so you have to specify all subdomains used.", + "required": true, + "elem": { + "type": "TypeString" + } + } + }, + "max_items": 1, + "min_items": 1 + } + ], + "ibm_cloudant_database": [ { "name": "partitioned", "type": "TypeBool", @@ -89414,192 +93914,31 @@ "immutable": true, "optional": true, "computed": true - } - ], - "ibm_cm_catalog": [ - { - "name": "syndication_settings", - "type": "TypeList", - "description": "Feature information.", - "computed": true, - "elem": { - "authorization": { - "name": "authorization", - "type": "TypeList", - "description": "Feature information.", - "optional": true, - "elem": { - "last_run": { - "name": "last_run", - "type": "TypeString", - "description": "Date and time last updated.", - "optional": true - }, - "token": { - "name": "token", - "type": "TypeString", - "description": "Array of syndicated namespaces.", - "optional": true - } - }, - "max_items": 1 - }, - "clusters": { - "name": "clusters", - "type": "TypeList", - "description": "Syndication clusters.", - "optional": true, - "elem": { - "all_namespaces": { - "name": "all_namespaces", - "type": "TypeBool", - "description": "Syndicated to all namespaces on cluster.", - "optional": true - }, - "id": { - "name": "id", - "type": "TypeString", - "description": "Cluster ID.", - "optional": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Cluster name.", - "optional": true - }, - "namespaces": { - "name": "namespaces", - "type": "TypeList", - "description": "Syndicated namespaces.", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - "region": { - "name": "region", - "type": "TypeString", - "description": "Cluster region.", - "optional": true - }, - "resource_group_name": { - "name": "resource_group_name", - "type": "TypeString", - "description": "Resource group ID.", - "optional": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "Syndication type.", - "optional": true - } - } - }, - "history": { - "name": "history", - "type": "TypeList", - "description": "Feature information.", - "optional": true, - "elem": { - "clusters": { - "name": "clusters", - "type": "TypeList", - "description": "Array of syndicated namespaces.", - "optional": true, - "elem": { - "all_namespaces": { - "name": "all_namespaces", - "type": "TypeBool", - "description": "Syndicated to all namespaces on cluster.", - "optional": true - }, - "id": { - "name": "id", - "type": "TypeString", - "description": "Cluster ID.", - "optional": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Cluster name.", - "optional": true - }, - "namespaces": { - "name": "namespaces", - "type": "TypeList", - "description": "Syndicated namespaces.", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - "region": { - "name": "region", - "type": "TypeString", - "description": "Cluster region.", - "optional": true - }, - "resource_group_name": { - "name": "resource_group_name", - "type": "TypeString", - "description": "Resource group ID.", - "optional": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "Syndication type.", - "optional": true - } - } - }, - "last_run": { - "name": "last_run", - "type": "TypeString", - "description": "Date and time last syndicated.", - "optional": true - }, - "namespaces": { - "name": "namespaces", - "type": "TypeList", - "description": "Array of syndicated namespaces.", - "optional": true, - "elem": { - "type": "TypeString" - } - } - }, - "max_items": 1 - }, - "remove_related_components": { - "name": "remove_related_components", - "type": "TypeBool", - "description": "Remove related components.", - "optional": true - } - } }, { - "name": "crn", + "name": "instance_crn", "type": "TypeString", - "description": "CRN associated with the catalog.", - "cloud_data_type": "crn", - "computed": true + "description": "Cloudant Instance CRN.", + "immutable": true, + "required": true }, { - "name": "offerings_url", + "name": "db", "type": "TypeString", - "description": "URL path to offerings.", - "computed": true - }, + "description": "Path parameter to specify the database name.", + "immutable": true, + "required": true + } + ], + "ibm_cm_catalog": [ { - "name": "label", - "type": "TypeString", - "description": "Display Name in the requested language.", - "optional": true + "name": "label_i18n", + "type": "TypeMap", + "description": "A map of translated strings, by language code.", + "optional": true, + "elem": { + "type": "TypeString" + } }, { "name": "tags", @@ -89612,9 +93951,28 @@ } }, { - "name": "owning_account", + "name": "metadata", + "type": "TypeMap", + "description": "Catalog specific metadata.", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "crn", "type": "TypeString", - "description": "Account that owns catalog.", + "description": "CRN associated with the catalog.", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "resource_group_id", + "type": "TypeString", + "description": "Resource group id the catalog is owned by.", + "cloud_data_type": "resource_group", + "immutable": true, + "optional": true, "computed": true }, { @@ -89685,6 +94043,36 @@ } } }, + { + "name": "url", + "type": "TypeString", + "description": "The url for this specific catalog.", + "computed": true + }, + { + "name": "label", + "type": "TypeString", + "description": "Display Name in the requested language.", + "optional": true + }, + { + "name": "catalog_icon_url", + "type": "TypeString", + "description": "URL for an icon associated with this catalog.", + "optional": true + }, + { + "name": "catalog_banner_url", + "type": "TypeString", + "description": "URL for a banner image for this catalog.", + "optional": true + }, + { + "name": "owning_account", + "type": "TypeString", + "description": "Account that owns catalog.", + "computed": true + }, { "name": "kind", "type": "TypeString", @@ -89692,9 +94080,9 @@ "optional": true }, { - "name": "url", + "name": "created", "type": "TypeString", - "description": "The url for this specific catalog.", + "description": "The date-time this catalog was created.", "computed": true }, { @@ -89764,6 +94152,12 @@ } } }, + { + "name": "short_description", + "type": "TypeString", + "description": "Description in the requested language.", + "optional": true + }, { "name": "short_description_i18n", "type": "TypeMap", @@ -89811,39 +94205,6 @@ } } }, - { - "name": "created", - "type": "TypeString", - "description": "The date-time this catalog was created.", - "computed": true - }, - { - "name": "updated", - "type": "TypeString", - "description": "The date-time this catalog was last updated.", - "computed": true - }, - { - "name": "catalog_banner_url", - "type": "TypeString", - "description": "URL for a banner image for this catalog.", - "optional": true - }, - { - "name": "resource_group_id", - "type": "TypeString", - "description": "Resource group id the catalog is owned by.", - "cloud_data_type": "resource_group", - "immutable": true, - "optional": true, - "computed": true - }, - { - "name": "catalog_icon_url", - "type": "TypeString", - "description": "URL for an icon associated with this catalog.", - "optional": true - }, { "name": "disabled", "type": "TypeBool", @@ -89851,12 +94212,168 @@ "optional": true }, { - "name": "metadata", - "type": "TypeMap", - "description": "Catalog specific metadata.", - "optional": true, + "name": "syndication_settings", + "type": "TypeList", + "description": "Feature information.", + "computed": true, "elem": { - "type": "TypeString" + "authorization": { + "name": "authorization", + "type": "TypeList", + "description": "Feature information.", + "optional": true, + "elem": { + "last_run": { + "name": "last_run", + "type": "TypeString", + "description": "Date and time last updated.", + "optional": true + }, + "token": { + "name": "token", + "type": "TypeString", + "description": "Array of syndicated namespaces.", + "optional": true + } + }, + "max_items": 1 + }, + "clusters": { + "name": "clusters", + "type": "TypeList", + "description": "Syndication clusters.", + "optional": true, + "elem": { + "all_namespaces": { + "name": "all_namespaces", + "type": "TypeBool", + "description": "Syndicated to all namespaces on cluster.", + "optional": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "Cluster ID.", + "optional": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Cluster name.", + "optional": true + }, + "namespaces": { + "name": "namespaces", + "type": "TypeList", + "description": "Syndicated namespaces.", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + "region": { + "name": "region", + "type": "TypeString", + "description": "Cluster region.", + "optional": true + }, + "resource_group_name": { + "name": "resource_group_name", + "type": "TypeString", + "description": "Resource group ID.", + "optional": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "Syndication type.", + "optional": true + } + } + }, + "history": { + "name": "history", + "type": "TypeList", + "description": "Feature information.", + "optional": true, + "elem": { + "clusters": { + "name": "clusters", + "type": "TypeList", + "description": "Array of syndicated namespaces.", + "optional": true, + "elem": { + "all_namespaces": { + "name": "all_namespaces", + "type": "TypeBool", + "description": "Syndicated to all namespaces on cluster.", + "optional": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "Cluster ID.", + "optional": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Cluster name.", + "optional": true + }, + "namespaces": { + "name": "namespaces", + "type": "TypeList", + "description": "Syndicated namespaces.", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + "region": { + "name": "region", + "type": "TypeString", + "description": "Cluster region.", + "optional": true + }, + "resource_group_name": { + "name": "resource_group_name", + "type": "TypeString", + "description": "Resource group ID.", + "optional": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "Syndication type.", + "optional": true + } + } + }, + "last_run": { + "name": "last_run", + "type": "TypeString", + "description": "Date and time last syndicated.", + "optional": true + }, + "namespaces": { + "name": "namespaces", + "type": "TypeList", + "description": "Array of syndicated namespaces.", + "optional": true, + "elem": { + "type": "TypeString" + } + } + }, + "max_items": 1 + }, + "remove_related_components": { + "name": "remove_related_components", + "type": "TypeBool", + "description": "Remove related components.", + "optional": true + } } }, { @@ -89866,27 +94383,30 @@ "computed": true }, { - "name": "label_i18n", - "type": "TypeMap", - "description": "A map of translated strings, by language code.", - "optional": true, - "elem": { - "type": "TypeString" - } + "name": "offerings_url", + "type": "TypeString", + "description": "URL path to offerings.", + "computed": true }, { - "name": "short_description", + "name": "updated", "type": "TypeString", - "description": "Description in the requested language.", - "optional": true + "description": "The date-time this catalog was last updated.", + "computed": true } ], "ibm_cm_object": [ { - "name": "kind", + "name": "url", "type": "TypeString", - "description": "Kind of object. Options are \"vpe\", \"preset_configuration\", or \"proxy_source\".", - "required": true + "description": "The url for this specific object.", + "computed": true + }, + { + "name": "catalog_name", + "type": "TypeString", + "description": "The name of the catalog.", + "computed": true }, { "name": "rev", @@ -89895,23 +94415,23 @@ "computed": true }, { - "name": "catalog_id", + "name": "object_id", "type": "TypeString", - "description": "Catalog identifier.", - "immutable": true, - "required": true + "description": "The ID of the object.", + "computed": true }, { - "name": "label", + "name": "name", "type": "TypeString", - "description": "Display name in the requested language.", - "optional": true + "description": "The programmatic name of this object.", + "required": true }, { - "name": "short_description", + "name": "crn", "type": "TypeString", - "description": "Short description in the requested language.", - "optional": true + "description": "The crn for this specific object.", + "cloud_data_type": "crn", + "computed": true }, { "name": "publish", @@ -89952,42 +94472,18 @@ } }, { - "name": "state", - "type": "TypeList", - "description": "Offering state.", - "computed": true, - "elem": { - "current": { - "name": "current", - "type": "TypeString", - "description": "one of: new, validated, account-published, ibm-published, public-published.", - "computed": true - }, - "current_entered": { - "name": "current_entered", - "type": "TypeString", - "description": "Date and time of current request.", - "computed": true - }, - "pending": { - "name": "pending", - "type": "TypeString", - "description": "one of: new, validated, account-published, ibm-published, public-published.", - "computed": true - }, - "pending_requested": { - "name": "pending_requested", - "type": "TypeString", - "description": "Date and time of pending request.", - "computed": true - }, - "previous": { - "name": "previous", - "type": "TypeString", - "description": "one of: new, validated, account-published, ibm-published, public-published.", - "computed": true - } - } + "name": "data", + "type": "TypeString", + "description": "Stringified map of data values for this object.", + "optional": true, + "computed": true + }, + { + "name": "catalog_id", + "type": "TypeString", + "description": "Catalog identifier.", + "immutable": true, + "required": true }, { "name": "short_description_i18n", @@ -89998,12 +94494,6 @@ "type": "TypeString" } }, - { - "name": "parent_id", - "type": "TypeString", - "description": "The parent for this specific object.", - "optional": true - }, { "name": "label_i18n", "type": "TypeMap", @@ -90030,253 +94520,95 @@ "computed": true }, { - "name": "updated", - "type": "TypeString", - "description": "The date and time this catalog was last updated.", - "computed": true - }, - { - "name": "object_id", - "type": "TypeString", - "description": "The ID of the object.", - "computed": true - }, - { - "name": "name", + "name": "kind", "type": "TypeString", - "description": "The programmatic name of this object.", + "description": "Kind of object. Options are \"vpe\", \"preset_configuration\", or \"proxy_source\".", "required": true }, { - "name": "crn", - "type": "TypeString", - "description": "The crn for this specific object.", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "url", - "type": "TypeString", - "description": "The url for this specific object.", - "computed": true - }, - { - "name": "catalog_name", + "name": "parent_id", "type": "TypeString", - "description": "The name of the catalog.", - "computed": true + "description": "The parent for this specific object.", + "optional": true }, { - "name": "data", - "type": "TypeString", - "description": "Stringified map of data values for this object.", - "optional": true, - "computed": true - } - ], - "ibm_cm_offering": [ - { - "name": "catalog_id", + "name": "short_description", "type": "TypeString", - "description": "Catalog identifier.", - "immutable": true, - "required": true - }, - { - "name": "short_description_i18n", - "type": "TypeMap", - "description": "A map of translated strings, by language code.", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "description": "Short description in the requested language.", + "optional": true }, { - "name": "image_pull_keys", + "name": "state", "type": "TypeList", - "description": "Image pull keys for this offering.", - "optional": true, + "description": "Offering state.", "computed": true, "elem": { - "description": { - "name": "description", + "current": { + "name": "current", "type": "TypeString", - "description": "Key description.", - "optional": true, + "description": "one of: new, validated, account-published, ibm-published, public-published.", "computed": true }, - "name": { - "name": "name", + "current_entered": { + "name": "current_entered", "type": "TypeString", - "description": "Key name.", - "optional": true, + "description": "Date and time of current request.", "computed": true }, - "value": { - "name": "value", + "pending": { + "name": "pending", "type": "TypeString", - "description": "Key value.", - "optional": true, + "description": "one of: new, validated, account-published, ibm-published, public-published.", + "computed": true + }, + "pending_requested": { + "name": "pending_requested", + "type": "TypeString", + "description": "Date and time of pending request.", + "computed": true + }, + "previous": { + "name": "previous", + "type": "TypeString", + "description": "one of: new, validated, account-published, ibm-published, public-published.", "computed": true } } }, { - "name": "portal_ui_url", - "type": "TypeString", - "description": "The portal UI URL.", - "optional": true, - "computed": true - }, - { - "name": "offering_id", + "name": "label", "type": "TypeString", - "description": "Offering identifier. Provide this when an offering already exists and you wish to use it as a terraform resource.", - "immutable": true, + "description": "Display name in the requested language.", "optional": true }, { - "name": "url", + "name": "updated", "type": "TypeString", - "description": "The url for this specific offering.", + "description": "The date and time this catalog was last updated.", "computed": true - }, + } + ], + "ibm_cm_offering": [ { - "name": "crn", + "name": "url", "type": "TypeString", - "description": "The crn for this specific offering.", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "publish_approved", - "type": "TypeBool", - "description": "Offering has been approved to publish to permitted to IBM or Public Catalog.", + "description": "The url for this specific offering.", "computed": true }, { - "name": "public_original_crn", + "name": "name", "type": "TypeString", - "description": "The original offering CRN that this publish entry came from.", + "description": "The programmatic name of this offering.", "optional": true, "computed": true }, { - "name": "portal_approval_record", + "name": "offering_docs_url", "type": "TypeString", - "description": "The portal's approval record ID.", + "description": "URL for an additional docs with this offering.", "optional": true, "computed": true }, - { - "name": "catalog_name", - "type": "TypeString", - "description": "The name of the catalog.", - "computed": true - }, - { - "name": "badges", - "type": "TypeList", - "description": "A list of badges for this offering.", - "computed": true, - "elem": { - "authority": { - "name": "authority", - "type": "TypeString", - "description": "Authority for the current badge.", - "computed": true - }, - "constraints": { - "name": "constraints", - "type": "TypeList", - "description": "An optional set of constraints indicating which versions in an Offering have this particular badge.", - "computed": true, - "elem": { - "rule": { - "name": "rule", - "type": "TypeString", - "description": "Rule for the current constraint.", - "computed": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "Type of the current constraint.", - "computed": true - } - } - }, - "description": { - "name": "description", - "type": "TypeString", - "description": "Description of the current badge.", - "computed": true - }, - "description_i18n": { - "name": "description_i18n", - "type": "TypeMap", - "description": "A map of translated strings, by language code.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "icon": { - "name": "icon", - "type": "TypeString", - "description": "Icon for the current badge.", - "computed": true - }, - "id": { - "name": "id", - "type": "TypeString", - "description": "ID of the current badge.", - "computed": true - }, - "label": { - "name": "label", - "type": "TypeString", - "description": "Display name for the current badge.", - "computed": true - }, - "label_i18n": { - "name": "label_i18n", - "type": "TypeMap", - "description": "A map of translated strings, by language code.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "learn_more_links": { - "name": "learn_more_links", - "type": "TypeList", - "description": "Learn more links for a badge.", - "computed": true, - "elem": { - "first_party": { - "name": "first_party", - "type": "TypeString", - "description": "First party link.", - "computed": true - }, - "third_party": { - "name": "third_party", - "type": "TypeString", - "description": "Third party link.", - "computed": true - } - } - }, - "tag": { - "name": "tag", - "type": "TypeString", - "description": "Tag for the current badge.", - "computed": true - } - } - }, { "name": "offering_support_url", "type": "TypeString", @@ -90285,19 +94617,6 @@ "computed": true, "deprecated": "This argument is deprecated" }, - { - "name": "deprecate", - "type": "TypeBool", - "description": "Deprecate this offering.", - "optional": true - }, - { - "name": "short_description", - "type": "TypeString", - "description": "Short description in the requested language.", - "optional": true, - "computed": true - }, { "name": "long_description_i18n", "type": "TypeMap", @@ -90309,24 +94628,9 @@ } }, { - "name": "share_with_all", - "type": "TypeBool", - "description": "Denotes public availability of an Offering - if share_enabled is true.", - "optional": true, - "computed": true - }, - { - "name": "public_publish_approved", - "type": "TypeBool", - "description": "Indicates if this offering has been approved for use by all IBM Cloud users.", - "optional": true, - "computed": true, - "deprecated": "This argument is deprecated" - }, - { - "name": "product_kind", + "name": "publish_public_crn", "type": "TypeString", - "description": "The product kind. Valid values are module, solution, or empty string.", + "description": "The crn of the public catalog entry of this offering.", "optional": true, "computed": true }, @@ -90337,17 +94641,25 @@ "computed": true }, { - "name": "name", - "type": "TypeString", - "description": "The programmatic name of this offering.", + "name": "label_i18n", + "type": "TypeMap", + "description": "A map of translated strings, by language code.", "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "updated", + "type": "TypeString", + "description": "The date and time this catalog was last updated.", "computed": true }, { - "name": "tags", - "type": "TypeList", - "description": "List of tags associated with this catalog.", - "cloud_data_type": "tags", + "name": "short_description_i18n", + "type": "TypeMap", + "description": "A map of translated strings, by language code.", "optional": true, "computed": true, "elem": { @@ -92438,6 +96750,27 @@ } } }, + { + "name": "portal_approval_record", + "type": "TypeString", + "description": "The portal's approval record ID.", + "optional": true, + "computed": true + }, + { + "name": "hidden", + "type": "TypeBool", + "description": "Determine if this offering should be displayed in the Consumption UI.", + "optional": true, + "computed": true + }, + { + "name": "share_with_all", + "type": "TypeBool", + "description": "Denotes public availability of an Offering - if share_enabled is true.", + "optional": true, + "computed": true + }, { "name": "ibm_publish_approved", "type": "TypeBool", @@ -92447,9 +96780,17 @@ "deprecated": "This argument is deprecated" }, { - "name": "metadata", - "type": "TypeMap", - "description": "Map of metadata values for this offering.", + "name": "label", + "type": "TypeString", + "description": "Display Name in the requested language.", + "optional": true, + "computed": true + }, + { + "name": "tags", + "type": "TypeList", + "description": "List of tags associated with this catalog.", + "cloud_data_type": "tags", "optional": true, "computed": true, "elem": { @@ -92457,68 +96798,332 @@ } }, { - "name": "provider_info", + "name": "keywords", "type": "TypeList", - "description": "Information on the provider for this offering, or omitted if no provider information is given.", + "description": "List of keywords associated with offering, typically used to search for it.", "optional": true, "computed": true, "elem": { - "id": { - "name": "id", + "type": "TypeString" + } + }, + { + "name": "deprecate", + "type": "TypeBool", + "description": "Deprecate this offering.", + "optional": true + }, + { + "name": "short_description", + "type": "TypeString", + "description": "Short description in the requested language.", + "optional": true, + "computed": true + }, + { + "name": "pc_managed", + "type": "TypeBool", + "description": "Offering is managed by Partner Center.", + "computed": true + }, + { + "name": "public_original_crn", + "type": "TypeString", + "description": "The original offering CRN that this publish entry came from.", + "optional": true, + "computed": true + }, + { + "name": "created", + "type": "TypeString", + "description": "The date and time this catalog was created.", + "computed": true + }, + { + "name": "features", + "type": "TypeList", + "description": "list of features associated with this offering.", + "optional": true, + "computed": true, + "elem": { + "description": { + "name": "description", "type": "TypeString", - "description": "The id of this provider.", + "description": "Feature description.", "optional": true, "computed": true }, - "name": { - "name": "name", + "description_i18n": { + "name": "description_i18n", + "type": "TypeMap", + "description": "A map of translated strings, by language code.", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "title": { + "name": "title", "type": "TypeString", - "description": "The name of this provider.", + "description": "Heading.", "optional": true, "computed": true + }, + "title_i18n": { + "name": "title_i18n", + "type": "TypeMap", + "description": "A map of translated strings, by language code.", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } } - }, - "max_items": 1 + } }, { - "name": "offering_identifier", + "name": "portal_ui_url", "type": "TypeString", - "description": "Computed Offering ID.", + "description": "The portal UI URL.", + "optional": true, "computed": true }, { - "name": "created", - "type": "TypeString", - "description": "The date and time this catalog was created.", + "name": "publish_approved", + "type": "TypeBool", + "description": "Offering has been approved to publish to permitted to IBM or Public Catalog.", "computed": true }, { - "name": "updated", - "type": "TypeString", - "description": "The date and time this catalog was last updated.", + "name": "share_enabled", + "type": "TypeBool", + "description": "Denotes sharing including access list availability of an Offering is enabled.", + "optional": true, "computed": true }, { - "name": "pc_managed", + "name": "permit_request_ibm_public_publish", "type": "TypeBool", - "description": "Offering is managed by Partner Center.", + "description": "Is it permitted to request publishing to IBM or Public.", + "optional": true, + "computed": true, + "deprecated": "This argument is deprecated" + }, + { + "name": "catalog_name", + "type": "TypeString", + "description": "The name of the catalog.", "computed": true }, { - "name": "share_with_access_list", + "name": "image_pull_keys", "type": "TypeList", - "description": "A list of account IDs to add to this offering's access list.", + "description": "Image pull keys for this offering.", "optional": true, + "computed": true, "elem": { - "type": "TypeString" + "description": { + "name": "description", + "type": "TypeString", + "description": "Key description.", + "optional": true, + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Key name.", + "optional": true, + "computed": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "Key value.", + "optional": true, + "computed": true + } } }, { - "name": "disclaimer", + "name": "offering_identifier", "type": "TypeString", - "description": "A disclaimer for this offering.", + "description": "Computed Offering ID.", + "computed": true + }, + { + "name": "badges", + "type": "TypeList", + "description": "A list of badges for this offering.", + "computed": true, + "elem": { + "authority": { + "name": "authority", + "type": "TypeString", + "description": "Authority for the current badge.", + "computed": true + }, + "constraints": { + "name": "constraints", + "type": "TypeList", + "description": "An optional set of constraints indicating which versions in an Offering have this particular badge.", + "computed": true, + "elem": { + "rule": { + "name": "rule", + "type": "TypeString", + "description": "Rule for the current constraint.", + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "Type of the current constraint.", + "computed": true + } + } + }, + "description": { + "name": "description", + "type": "TypeString", + "description": "Description of the current badge.", + "computed": true + }, + "description_i18n": { + "name": "description_i18n", + "type": "TypeMap", + "description": "A map of translated strings, by language code.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "icon": { + "name": "icon", + "type": "TypeString", + "description": "Icon for the current badge.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "ID of the current badge.", + "computed": true + }, + "label": { + "name": "label", + "type": "TypeString", + "description": "Display name for the current badge.", + "computed": true + }, + "label_i18n": { + "name": "label_i18n", + "type": "TypeMap", + "description": "A map of translated strings, by language code.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "learn_more_links": { + "name": "learn_more_links", + "type": "TypeList", + "description": "Learn more links for a badge.", + "computed": true, + "elem": { + "first_party": { + "name": "first_party", + "type": "TypeString", + "description": "First party link.", + "computed": true + }, + "third_party": { + "name": "third_party", + "type": "TypeString", + "description": "Third party link.", + "computed": true + } + } + }, + "tag": { + "name": "tag", + "type": "TypeString", + "description": "Tag for the current badge.", + "computed": true + } + } + }, + { + "name": "rating", + "type": "TypeList", + "description": "Repository info for offerings.", + "computed": true, + "elem": { + "four_star_count": { + "name": "four_star_count", + "type": "TypeInt", + "description": "Four start rating.", + "computed": true + }, + "one_star_count": { + "name": "one_star_count", + "type": "TypeInt", + "description": "One start rating.", + "computed": true + }, + "three_star_count": { + "name": "three_star_count", + "type": "TypeInt", + "description": "Three start rating.", + "computed": true + }, + "two_star_count": { + "name": "two_star_count", + "type": "TypeInt", + "description": "Two start rating.", + "computed": true + } + } + }, + { + "name": "share_with_ibm", + "type": "TypeBool", + "description": "Denotes IBM employee availability of an Offering - if share_enabled is true.", + "optional": true, + "computed": true + }, + { + "name": "public_publish_approved", + "type": "TypeBool", + "description": "Indicates if this offering has been approved for use by all IBM Cloud users.", + "optional": true, + "computed": true, + "deprecated": "This argument is deprecated" + }, + { + "name": "provider_info", + "type": "TypeList", + "description": "Information on the provider for this offering, or omitted if no provider information is given.", "optional": true, - "computed": true + "computed": true, + "elem": { + "id": { + "name": "id", + "type": "TypeString", + "description": "The id of this provider.", + "optional": true, + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The name of this provider.", + "optional": true, + "computed": true + } + }, + "max_items": 1 }, { "name": "support", @@ -92705,16 +97310,16 @@ } }, { - "name": "label", + "name": "product_kind", "type": "TypeString", - "description": "Display Name in the requested language.", + "description": "The product kind. Valid values are module, solution, or empty string.", "optional": true, "computed": true }, { - "name": "label_i18n", + "name": "metadata", "type": "TypeMap", - "description": "A map of translated strings, by language code.", + "description": "Map of metadata values for this offering.", "optional": true, "computed": true, "elem": { @@ -92722,42 +97327,54 @@ } }, { - "name": "offering_docs_url", + "name": "disclaimer", "type": "TypeString", - "description": "URL for an additional docs with this offering.", + "description": "A disclaimer for this offering.", "optional": true, "computed": true }, { - "name": "share_with_ibm", - "type": "TypeBool", - "description": "Denotes IBM employee availability of an Offering - if share_enabled is true.", + "name": "catalog_id", + "type": "TypeString", + "description": "Catalog identifier.", + "immutable": true, + "required": true + }, + { + "name": "offering_id", + "type": "TypeString", + "description": "Offering identifier. Provide this when an offering already exists and you wish to use it as a terraform resource.", + "immutable": true, + "optional": true + }, + { + "name": "crn", + "type": "TypeString", + "description": "The crn for this specific offering.", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "offering_icon_url", + "type": "TypeString", + "description": "URL for an icon associated with this offering.", "optional": true, "computed": true }, { - "name": "deprecate_pending", + "name": "long_description", + "type": "TypeString", + "description": "Long description in the requested language.", + "optional": true, + "computed": true + }, + { + "name": "share_with_access_list", "type": "TypeList", - "description": "Deprecation information for an Offering.", - "computed": true, + "description": "A list of account IDs to add to this offering's access list.", + "optional": true, "elem": { - "deprecate_date": { - "name": "deprecate_date", - "type": "TypeString", - "description": "Date of deprecation.", - "computed": true - }, - "deprecate_state": { - "name": "deprecate_state", - "type": "TypeString", - "description": "Deprecation state.", - "computed": true - }, - "description": { - "name": "description", - "type": "TypeString", - "computed": true - } + "type": "TypeString" } }, { @@ -92781,575 +97398,1085 @@ } }, { - "name": "offering_icon_url", - "type": "TypeString", - "description": "URL for an icon associated with this offering.", - "optional": true, - "computed": true - }, - { - "name": "keywords", + "name": "media", "type": "TypeList", - "description": "List of keywords associated with offering, typically used to search for it.", + "description": "A list of media items related to this offering.", "optional": true, "computed": true, "elem": { - "type": "TypeString" + "api_url": { + "name": "api_url", + "type": "TypeString", + "description": "CM API specific URL of the specified media item.", + "optional": true, + "computed": true + }, + "caption": { + "name": "caption", + "type": "TypeString", + "description": "Caption for this media item.", + "optional": true, + "computed": true + }, + "caption_i18n": { + "name": "caption_i18n", + "type": "TypeMap", + "description": "A map of translated strings, by language code.", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "thumbnail_url": { + "name": "thumbnail_url", + "type": "TypeString", + "description": "Thumbnail URL for this media item.", + "optional": true, + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "Type of this media item.", + "optional": true, + "computed": true + }, + "url": { + "name": "url", + "type": "TypeString", + "description": "URL of the specified media item.", + "optional": true, + "computed": true + }, + "url_proxy": { + "name": "url_proxy", + "type": "TypeList", + "description": "Offering URL proxy information.", + "optional": true, + "computed": true, + "elem": { + "sha": { + "name": "sha", + "type": "TypeString", + "description": "SHA256 fingerprint of image.", + "optional": true, + "computed": true + }, + "url": { + "name": "url", + "type": "TypeString", + "description": "URL of the specified media item being proxied.", + "optional": true, + "computed": true + } + }, + "max_items": 1 + } } }, { - "name": "rating", + "name": "deprecate_pending", "type": "TypeList", - "description": "Repository info for offerings.", + "description": "Deprecation information for an Offering.", "computed": true, "elem": { - "four_star_count": { - "name": "four_star_count", - "type": "TypeInt", - "description": "Four start rating.", - "computed": true - }, - "one_star_count": { - "name": "one_star_count", - "type": "TypeInt", - "description": "One start rating.", + "deprecate_date": { + "name": "deprecate_date", + "type": "TypeString", + "description": "Date of deprecation.", "computed": true }, - "three_star_count": { - "name": "three_star_count", - "type": "TypeInt", - "description": "Three start rating.", + "deprecate_state": { + "name": "deprecate_state", + "type": "TypeString", + "description": "Deprecation state.", "computed": true }, - "two_star_count": { - "name": "two_star_count", - "type": "TypeInt", - "description": "Two start rating.", + "description": { + "name": "description", + "type": "TypeString", "computed": true } } + } + ], + "ibm_cm_offering_instance": [ + { + "name": "catalog_id", + "type": "TypeString", + "description": "Catalog ID this instance was created from.", + "required": true }, { - "name": "share_enabled", + "name": "cluster_region", + "type": "TypeString", + "description": "Cluster region (e.g., us-south).", + "required": true + }, + { + "name": "install_plan", + "type": "TypeString", + "description": "install plan for the subscription of the operator- can be either automatic or manual. Required for operator bundles", + "optional": true + }, + { + "name": "channel", + "type": "TypeString", + "description": "channel to target for the operator subscription. Required for operator bundles", + "optional": true + }, + { + "name": "wait_until_successful", "type": "TypeBool", - "description": "Denotes sharing including access list availability of an Offering is enabled.", - "optional": true, + "description": "Whether to wait until the offering instance successfully provisions, or to return when accepted", + "default_value": true, + "optional": true + }, + { + "name": "label", + "type": "TypeString", + "description": "the label for this instance.", + "required": true + }, + { + "name": "cluster_id", + "type": "TypeString", + "description": "Cluster ID.", + "required": true + }, + { + "name": "cluster_namespaces", + "type": "TypeList", + "description": "List of target namespaces to install into.", + "required": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "offering_id", + "type": "TypeString", + "description": "Offering ID this instance was created from.", + "required": true + }, + { + "name": "kind_format", + "type": "TypeString", + "description": "the format this instance has (helm, operator, ova...).", + "required": true + }, + { + "name": "version", + "type": "TypeString", + "description": "The version this instance was installed from (not version id).", + "required": true + }, + { + "name": "cluster_all_namespaces", + "type": "TypeBool", + "description": "designate to install into all namespaces.", + "required": true + }, + { + "name": "schematics_workspace_id", + "type": "TypeString", + "description": "id of the schematics workspace, for offerings installed through schematics", "computed": true }, { - "name": "publish_public_crn", + "name": "resource_group_id", "type": "TypeString", - "description": "The crn of the public catalog entry of this offering.", - "optional": true, + "description": "id of the resource group", + "cloud_data_type": "resource_group", + "optional": true + }, + { + "name": "url", + "type": "TypeString", + "description": "url reference to this object.", "computed": true }, { - "name": "hidden", - "type": "TypeBool", - "description": "Determine if this offering should be displayed in the Consumption UI.", - "optional": true, + "name": "crn", + "type": "TypeString", + "description": "platform CRN for this instance.", + "cloud_data_type": "crn", + "computed": true + } + ], + "ibm_cm_validation": [ + { + "name": "last_operation", + "type": "TypeString", + "description": "Last operation (e.g. submit_deployment, generate_installer, install_offering.", "computed": true }, { - "name": "long_description", + "name": "message", "type": "TypeString", - "description": "Long description in the requested language.", - "optional": true, + "description": "Any message needing to be conveyed as part of the validation job.", "computed": true }, { - "name": "features", + "name": "revalidate_if_validated", + "type": "TypeBool", + "description": "If the version should be revalidated if it is already validated.", + "immutable": true, + "optional": true + }, + { + "name": "version_locator", + "type": "TypeString", + "description": "Version locator - the version that will be validated.", + "immutable": true, + "required": true + }, + { + "name": "region", + "type": "TypeString", + "description": "Validation region.", + "cloud_data_type": "region", + "immutable": true, + "optional": true + }, + { + "name": "override_values", + "type": "TypeMap", + "description": "Override values during validation.", + "immutable": true, + "optional": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "schematics", "type": "TypeList", - "description": "list of features associated with this offering.", + "description": "Other values to pass to the schematics workspace.", + "immutable": true, "optional": true, - "computed": true, "elem": { "description": { "name": "description", "type": "TypeString", - "description": "Feature description.", - "optional": true, - "computed": true + "description": "Description for the schematics workspace.", + "optional": true }, - "description_i18n": { - "name": "description_i18n", - "type": "TypeMap", - "description": "A map of translated strings, by language code.", + "name": { + "name": "name", + "type": "TypeString", + "description": "Name for the schematics workspace.", + "optional": true + }, + "region": { + "name": "region", + "type": "TypeString", + "description": "Region to use for the schematics installation.", + "optional": true + }, + "resource_group_id": { + "name": "resource_group_id", + "type": "TypeString", + "description": "The resource group ID.", + "optional": true + }, + "tags": { + "name": "tags", + "type": "TypeList", + "description": "List of tags for the schematics workspace.", "optional": true, - "computed": true, "elem": { "type": "TypeString" } }, - "title": { - "name": "title", + "terraform_version": { + "name": "terraform_version", "type": "TypeString", - "description": "Heading.", - "optional": true, - "computed": true + "description": "Version of terraform to use in schematics.", + "optional": true + } + }, + "max_items": 1 + }, + { + "name": "state", + "type": "TypeString", + "description": "Current validation state - \u003cempty\u003e, in_progress, valid, invalid, expired.", + "computed": true + }, + { + "name": "mark_version_consumable", + "type": "TypeBool", + "description": "If the version should be marked as consumable or \"ready to share\".", + "optional": true + }, + { + "name": "environment_variables", + "type": "TypeList", + "description": "Environment variables to include in the schematics workspace.", + "immutable": true, + "optional": true, + "elem": { + "name": { + "name": "name", + "type": "TypeString", + "description": "Name of the environment variable.", + "optional": true }, - "title_i18n": { - "name": "title_i18n", - "type": "TypeMap", - "description": "A map of translated strings, by language code.", + "secure": { + "name": "secure", + "type": "TypeBool", + "description": "If the environment variablel should be secure.", + "optional": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "Value of the environment variable.", + "optional": true + } + } + }, + { + "name": "validated", + "type": "TypeString", + "description": "Data and time of last successful validation.", + "computed": true + }, + { + "name": "requested", + "type": "TypeString", + "description": "Data and time of last validation request.", + "computed": true + }, + { + "name": "x_auth_refresh_token", + "type": "TypeString", + "description": "Authentication token used to submit validation job.", + "secure": true, + "optional": true, + "deprecated": "This argument is deprecated because it is now retrieved automatically." + } + ], + "ibm_cm_version": [ + { + "name": "import_sha", + "type": "TypeString", + "description": "SHA256 fingerprint of the image file. Required for virtual server image for VPC.", + "optional": true + }, + { + "name": "created", + "type": "TypeString", + "description": "The date and time this version was created.", + "computed": true + }, + { + "name": "package_version", + "type": "TypeString", + "description": "Version of the package used to create this version.", + "computed": true + }, + { + "name": "solution_info", + "type": "TypeList", + "description": "Version Solution Information. Only supported for Product kind Solution.", + "optional": true, + "computed": true, + "elem": { + "architecture_diagrams": { + "name": "architecture_diagrams", + "type": "TypeList", + "description": "Architecture diagrams for this solution.", "optional": true, + "elem": { + "description": { + "name": "description", + "type": "TypeString", + "description": "Description of this diagram.", + "optional": true + }, + "description_i18n": { + "name": "description_i18n", + "type": "TypeMap", + "description": "A map of translated strings, by language code.", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + "diagram": { + "name": "diagram", + "type": "TypeList", + "description": "Offering Media information.", + "optional": true, + "elem": { + "api_url": { + "name": "api_url", + "type": "TypeString", + "description": "CM API specific URL of the specified media item.", + "optional": true + }, + "caption": { + "name": "caption", + "type": "TypeString", + "description": "Caption for this media item.", + "optional": true + }, + "caption_i18n": { + "name": "caption_i18n", + "type": "TypeMap", + "description": "A map of translated strings, by language code.", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + "thumbnail_url": { + "name": "thumbnail_url", + "type": "TypeString", + "description": "Thumbnail URL for this media item.", + "optional": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "Type of this media item.", + "optional": true + }, + "url": { + "name": "url", + "type": "TypeString", + "description": "URL of the specified media item.", + "optional": true + }, + "url_proxy": { + "name": "url_proxy", + "type": "TypeList", + "description": "Offering URL proxy information.", + "optional": true, + "elem": { + "sha": { + "name": "sha", + "type": "TypeString", + "description": "SHA256 fingerprint of image.", + "optional": true + }, + "url": { + "name": "url", + "type": "TypeString", + "description": "URL of the specified media item being proxied.", + "optional": true + } + }, + "max_items": 1 + } + }, + "max_items": 1 + } + } + }, + "cost_estimate": { + "name": "cost_estimate", + "type": "TypeList", + "description": "Cost estimate definition.", "computed": true, "elem": { - "type": "TypeString" + "currency": { + "name": "currency", + "type": "TypeString", + "description": "Cost estimate currency.", + "computed": true + }, + "diff_total_hourly_cost": { + "name": "diff_total_hourly_cost", + "type": "TypeString", + "description": "Difference in total hourly cost.", + "computed": true + }, + "diff_total_monthly_cost": { + "name": "diff_total_monthly_cost", + "type": "TypeString", + "description": "Difference in total monthly cost.", + "computed": true + }, + "past_total_hourly_cost": { + "name": "past_total_hourly_cost", + "type": "TypeString", + "description": "Past total hourly cost.", + "computed": true + }, + "past_total_monthly_cost": { + "name": "past_total_monthly_cost", + "type": "TypeString", + "description": "Past total monthly cost.", + "computed": true + }, + "projects": { + "name": "projects", + "type": "TypeList", + "description": "Cost estimate projects.", + "computed": true, + "elem": { + "breakdown": { + "name": "breakdown", + "type": "TypeList", + "description": "Cost breakdown definition.", + "computed": true, + "elem": { + "resources": { + "name": "resources", + "type": "TypeList", + "description": "Resources.", + "computed": true, + "elem": { + "cost_components": { + "name": "cost_components", + "type": "TypeList", + "description": "Cost components.", + "computed": true, + "elem": { + "hourly_cost": { + "name": "hourly_cost", + "type": "TypeString", + "description": "Cost component hourly cost.", + "computed": true + }, + "hourly_quantity": { + "name": "hourly_quantity", + "type": "TypeString", + "description": "Cost component hourly quantity.", + "computed": true + }, + "monthly_cost": { + "name": "monthly_cost", + "type": "TypeString", + "description": "Cost component monthly cist.", + "computed": true + }, + "monthly_quantity": { + "name": "monthly_quantity", + "type": "TypeString", + "description": "Cost component monthly quantity.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Cost component name.", + "computed": true + }, + "price": { + "name": "price", + "type": "TypeString", + "description": "Cost component price.", + "computed": true + }, + "unit": { + "name": "unit", + "type": "TypeString", + "description": "Cost component unit.", + "computed": true + } + } + }, + "hourly_cost": { + "name": "hourly_cost", + "type": "TypeString", + "description": "Hourly cost.", + "computed": true + }, + "metadata": { + "name": "metadata", + "type": "TypeMap", + "description": "Resource metadata.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "monthly_cost": { + "name": "monthly_cost", + "type": "TypeString", + "description": "Monthly cost.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Resource name.", + "computed": true + } + } + }, + "total_hourly_cost": { + "name": "total_hourly_cost", + "type": "TypeString", + "description": "Total hourly cost.", + "computed": true + }, + "total_monthly_cost": { + "name": "total_monthly_cost", + "type": "TypeString", + "description": "Total monthly cost.", + "computed": true + } + } + }, + "diff": { + "name": "diff", + "type": "TypeList", + "description": "Cost breakdown definition.", + "computed": true, + "elem": { + "resources": { + "name": "resources", + "type": "TypeList", + "description": "Resources.", + "computed": true, + "elem": { + "cost_components": { + "name": "cost_components", + "type": "TypeList", + "description": "Cost components.", + "computed": true, + "elem": { + "hourly_cost": { + "name": "hourly_cost", + "type": "TypeString", + "description": "Cost component hourly cost.", + "computed": true + }, + "hourly_quantity": { + "name": "hourly_quantity", + "type": "TypeString", + "description": "Cost component hourly quantity.", + "computed": true + }, + "monthly_cost": { + "name": "monthly_cost", + "type": "TypeString", + "description": "Cost component monthly cist.", + "computed": true + }, + "monthly_quantity": { + "name": "monthly_quantity", + "type": "TypeString", + "description": "Cost component monthly quantity.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Cost component name.", + "computed": true + }, + "price": { + "name": "price", + "type": "TypeString", + "description": "Cost component price.", + "computed": true + }, + "unit": { + "name": "unit", + "type": "TypeString", + "description": "Cost component unit.", + "computed": true + } + } + }, + "hourly_cost": { + "name": "hourly_cost", + "type": "TypeString", + "description": "Hourly cost.", + "computed": true + }, + "metadata": { + "name": "metadata", + "type": "TypeMap", + "description": "Resource metadata.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "monthly_cost": { + "name": "monthly_cost", + "type": "TypeString", + "description": "Monthly cost.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Resource name.", + "computed": true + } + } + }, + "total_hourly_cost": { + "name": "total_hourly_cost", + "type": "TypeString", + "description": "Total hourly cost.", + "computed": true + }, + "total_monthly_cost": { + "name": "total_monthly_cost", + "type": "TypeString", + "description": "Total monthly cost.", + "computed": true + } + } + }, + "metadata": { + "name": "metadata", + "type": "TypeMap", + "description": "Project metadata.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Project name.", + "computed": true + }, + "past_breakdown": { + "name": "past_breakdown", + "type": "TypeList", + "description": "Cost breakdown definition.", + "computed": true, + "elem": { + "resources": { + "name": "resources", + "type": "TypeList", + "description": "Resources.", + "computed": true, + "elem": { + "cost_components": { + "name": "cost_components", + "type": "TypeList", + "description": "Cost components.", + "computed": true, + "elem": { + "hourly_cost": { + "name": "hourly_cost", + "type": "TypeString", + "description": "Cost component hourly cost.", + "computed": true + }, + "hourly_quantity": { + "name": "hourly_quantity", + "type": "TypeString", + "description": "Cost component hourly quantity.", + "computed": true + }, + "monthly_cost": { + "name": "monthly_cost", + "type": "TypeString", + "description": "Cost component monthly cist.", + "computed": true + }, + "monthly_quantity": { + "name": "monthly_quantity", + "type": "TypeString", + "description": "Cost component monthly quantity.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Cost component name.", + "computed": true + }, + "price": { + "name": "price", + "type": "TypeString", + "description": "Cost component price.", + "computed": true + }, + "unit": { + "name": "unit", + "type": "TypeString", + "description": "Cost component unit.", + "computed": true + } + } + }, + "hourly_cost": { + "name": "hourly_cost", + "type": "TypeString", + "description": "Hourly cost.", + "computed": true + }, + "metadata": { + "name": "metadata", + "type": "TypeMap", + "description": "Resource metadata.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "monthly_cost": { + "name": "monthly_cost", + "type": "TypeString", + "description": "Monthly cost.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Resource name.", + "computed": true + } + } + }, + "total_hourly_cost": { + "name": "total_hourly_cost", + "type": "TypeString", + "description": "Total hourly cost.", + "computed": true + }, + "total_monthly_cost": { + "name": "total_monthly_cost", + "type": "TypeString", + "description": "Total monthly cost.", + "computed": true + } + } + }, + "summary": { + "name": "summary", + "type": "TypeList", + "description": "Cost summary definition.", + "computed": true, + "elem": { + "no_price_resource_counts": { + "name": "no_price_resource_counts", + "type": "TypeMap", + "description": "No price resource counts.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "total_detected_resources": { + "name": "total_detected_resources", + "type": "TypeInt", + "description": "Total detected resources.", + "computed": true + }, + "total_no_price_resources": { + "name": "total_no_price_resources", + "type": "TypeInt", + "description": "Total no price resources.", + "computed": true + }, + "total_supported_resources": { + "name": "total_supported_resources", + "type": "TypeInt", + "description": "Total supported resources.", + "computed": true + }, + "total_unsupported_resources": { + "name": "total_unsupported_resources", + "type": "TypeInt", + "description": "Total unsupported resources.", + "computed": true + }, + "total_usage_based_resources": { + "name": "total_usage_based_resources", + "type": "TypeInt", + "description": "Total usage based resources.", + "computed": true + }, + "unsupported_resource_counts": { + "name": "unsupported_resource_counts", + "type": "TypeMap", + "description": "Unsupported resource counts.", + "computed": true, + "elem": { + "type": "TypeString" + } + } + } + } + } + }, + "summary": { + "name": "summary", + "type": "TypeList", + "description": "Cost summary definition.", + "computed": true, + "elem": { + "no_price_resource_counts": { + "name": "no_price_resource_counts", + "type": "TypeMap", + "description": "No price resource counts.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "total_detected_resources": { + "name": "total_detected_resources", + "type": "TypeInt", + "description": "Total detected resources.", + "computed": true + }, + "total_no_price_resources": { + "name": "total_no_price_resources", + "type": "TypeInt", + "description": "Total no price resources.", + "computed": true + }, + "total_supported_resources": { + "name": "total_supported_resources", + "type": "TypeInt", + "description": "Total supported resources.", + "computed": true + }, + "total_unsupported_resources": { + "name": "total_unsupported_resources", + "type": "TypeInt", + "description": "Total unsupported resources.", + "computed": true + }, + "total_usage_based_resources": { + "name": "total_usage_based_resources", + "type": "TypeInt", + "description": "Total usage based resources.", + "computed": true + }, + "unsupported_resource_counts": { + "name": "unsupported_resource_counts", + "type": "TypeMap", + "description": "Unsupported resource counts.", + "computed": true, + "elem": { + "type": "TypeString" + } + } + } + }, + "time_generated": { + "name": "time_generated", + "type": "TypeString", + "description": "When this estimate was generated.", + "computed": true + }, + "total_hourly_cost": { + "name": "total_hourly_cost", + "type": "TypeString", + "description": "Total hourly cost.", + "computed": true + }, + "total_monthly_cost": { + "name": "total_monthly_cost", + "type": "TypeString", + "description": "Total monthly cost.", + "computed": true + }, + "version": { + "name": "version", + "type": "TypeString", + "description": "Cost estimate version.", + "computed": true + } } - } - } - }, - { - "name": "permit_request_ibm_public_publish", - "type": "TypeBool", - "description": "Is it permitted to request publishing to IBM or Public.", - "optional": true, - "computed": true, - "deprecated": "This argument is deprecated" - }, - { - "name": "media", - "type": "TypeList", - "description": "A list of media items related to this offering.", - "optional": true, - "computed": true, - "elem": { - "api_url": { - "name": "api_url", - "type": "TypeString", - "description": "CM API specific URL of the specified media item.", - "optional": true, - "computed": true }, - "caption": { - "name": "caption", - "type": "TypeString", - "description": "Caption for this media item.", - "optional": true, - "computed": true - }, - "caption_i18n": { - "name": "caption_i18n", - "type": "TypeMap", - "description": "A map of translated strings, by language code.", + "dependencies": { + "name": "dependencies", + "type": "TypeList", + "description": "Dependencies for this solution.", "optional": true, - "computed": true, "elem": { - "type": "TypeString" + "catalog_id": { + "name": "catalog_id", + "type": "TypeString", + "description": "Optional - If not specified, assumes the Public Catalog.", + "optional": true + }, + "flavors": { + "name": "flavors", + "type": "TypeList", + "description": "Optional - List of dependent flavors in the specified range.", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "Optional - Offering ID - not required if name is set.", + "optional": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Optional - Programmatic Offering name.", + "optional": true + }, + "version": { + "name": "version", + "type": "TypeString", + "description": "Required - Semver value or range.", + "optional": true + } } }, - "thumbnail_url": { - "name": "thumbnail_url", - "type": "TypeString", - "description": "Thumbnail URL for this media item.", - "optional": true, - "computed": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "Type of this media item.", - "optional": true, - "computed": true - }, - "url": { - "name": "url", - "type": "TypeString", - "description": "URL of the specified media item.", - "optional": true, - "computed": true - }, - "url_proxy": { - "name": "url_proxy", + "features": { + "name": "features", "type": "TypeList", - "description": "Offering URL proxy information.", + "description": "Features - titles only.", "optional": true, - "computed": true, "elem": { - "sha": { - "name": "sha", + "description": { + "name": "description", "type": "TypeString", - "description": "SHA256 fingerprint of image.", + "description": "Feature description.", + "optional": true + }, + "description_i18n": { + "name": "description_i18n", + "type": "TypeMap", + "description": "A map of translated strings, by language code.", "optional": true, - "computed": true + "elem": { + "type": "TypeString" + } }, - "url": { - "name": "url", + "title": { + "name": "title", "type": "TypeString", - "description": "URL of the specified media item being proxied.", + "description": "Heading.", + "optional": true + }, + "title_i18n": { + "name": "title_i18n", + "type": "TypeMap", + "description": "A map of translated strings, by language code.", "optional": true, - "computed": true + "elem": { + "type": "TypeString" + } } - }, - "max_items": 1 - } - } - } - ], - "ibm_cm_offering_instance": [ - { - "name": "version", - "type": "TypeString", - "description": "The version this instance was installed from (not version id).", - "required": true - }, - { - "name": "cluster_all_namespaces", - "type": "TypeBool", - "description": "designate to install into all namespaces.", - "required": true - }, - { - "name": "schematics_workspace_id", - "type": "TypeString", - "description": "id of the schematics workspace, for offerings installed through schematics", - "computed": true - }, - { - "name": "channel", - "type": "TypeString", - "description": "channel to target for the operator subscription. Required for operator bundles", - "optional": true - }, - { - "name": "wait_until_successful", - "type": "TypeBool", - "description": "Whether to wait until the offering instance successfully provisions, or to return when accepted", - "default_value": true, - "optional": true - }, - { - "name": "url", - "type": "TypeString", - "description": "url reference to this object.", - "computed": true - }, - { - "name": "crn", - "type": "TypeString", - "description": "platform CRN for this instance.", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "offering_id", - "type": "TypeString", - "description": "Offering ID this instance was created from.", - "required": true - }, - { - "name": "catalog_id", - "type": "TypeString", - "description": "Catalog ID this instance was created from.", - "required": true - }, - { - "name": "kind_format", - "type": "TypeString", - "description": "the format this instance has (helm, operator, ova...).", - "required": true - }, - { - "name": "cluster_id", - "type": "TypeString", - "description": "Cluster ID.", - "required": true - }, - { - "name": "install_plan", - "type": "TypeString", - "description": "install plan for the subscription of the operator- can be either automatic or manual. Required for operator bundles", - "optional": true - }, - { - "name": "label", - "type": "TypeString", - "description": "the label for this instance.", - "required": true - }, - { - "name": "cluster_region", - "type": "TypeString", - "description": "Cluster region (e.g., us-south).", - "required": true - }, - { - "name": "cluster_namespaces", - "type": "TypeList", - "description": "List of target namespaces to install into.", - "required": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "resource_group_id", - "type": "TypeString", - "description": "id of the resource group", - "cloud_data_type": "resource_group", - "optional": true - } - ], - "ibm_cm_validation": [ - { - "name": "version_locator", - "type": "TypeString", - "description": "Version locator - the version that will be validated.", - "immutable": true, - "required": true - }, - { - "name": "region", - "type": "TypeString", - "description": "Validation region.", - "cloud_data_type": "region", - "immutable": true, - "optional": true - }, - { - "name": "override_values", - "type": "TypeMap", - "description": "Override values during validation.", - "immutable": true, - "optional": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "schematics", - "type": "TypeList", - "description": "Other values to pass to the schematics workspace.", - "immutable": true, - "optional": true, - "elem": { - "description": { - "name": "description", - "type": "TypeString", - "description": "Description for the schematics workspace.", - "optional": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Name for the schematics workspace.", - "optional": true - }, - "region": { - "name": "region", - "type": "TypeString", - "description": "Region to use for the schematics installation.", - "optional": true - }, - "resource_group_id": { - "name": "resource_group_id", - "type": "TypeString", - "description": "The resource group ID.", - "optional": true - }, - "tags": { - "name": "tags", - "type": "TypeList", - "description": "List of tags for the schematics workspace.", - "optional": true, - "elem": { - "type": "TypeString" } - }, - "terraform_version": { - "name": "terraform_version", - "type": "TypeString", - "description": "Version of terraform to use in schematics.", - "optional": true } }, "max_items": 1 }, { - "name": "requested", - "type": "TypeString", - "description": "Data and time of last validation request.", - "computed": true - }, - { - "name": "state", - "type": "TypeString", - "description": "Current validation state - \u003cempty\u003e, in_progress, valid, invalid, expired.", - "computed": true - }, - { - "name": "message", - "type": "TypeString", - "description": "Any message needing to be conveyed as part of the validation job.", - "computed": true - }, - { - "name": "revalidate_if_validated", - "type": "TypeBool", - "description": "If the version should be revalidated if it is already validated.", - "immutable": true, - "optional": true - }, - { - "name": "mark_version_consumable", - "type": "TypeBool", - "description": "If the version should be marked as consumable or \"ready to share\".", - "optional": true - }, - { - "name": "environment_variables", - "type": "TypeList", - "description": "Environment variables to include in the schematics workspace.", - "immutable": true, - "optional": true, - "elem": { - "name": { - "name": "name", - "type": "TypeString", - "description": "Name of the environment variable.", - "optional": true - }, - "secure": { - "name": "secure", - "type": "TypeBool", - "description": "If the environment variablel should be secure.", - "optional": true - }, - "value": { - "name": "value", - "type": "TypeString", - "description": "Value of the environment variable.", - "optional": true - } - } - }, - { - "name": "validated", - "type": "TypeString", - "description": "Data and time of last successful validation.", - "computed": true - }, - { - "name": "last_operation", - "type": "TypeString", - "description": "Last operation (e.g. submit_deployment, generate_installer, install_offering.", - "computed": true - }, - { - "name": "x_auth_refresh_token", - "type": "TypeString", - "description": "Authentication token used to submit validation job.", - "secure": true, - "optional": true, - "deprecated": "This argument is deprecated because it is now retrieved automatically." - } - ], - "ibm_cm_version": [ - { - "name": "pre_install", - "type": "TypeList", - "description": "Optional pre-install instructions.", - "optional": true, - "elem": { - "delete_script": { - "name": "delete_script", - "type": "TypeString", - "description": "Optional script that if run will remove the installed version.", - "optional": true - }, - "instructions": { - "name": "instructions", - "type": "TypeString", - "description": "Instruction on step and by whom (role) that are needed to take place to prepare the target for installing this version.", - "optional": true - }, - "instructions_i18n": { - "name": "instructions_i18n", - "type": "TypeMap", - "description": "A map of translated strings, by language code.", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - "scope": { - "name": "scope", - "type": "TypeString", - "description": "Optional value indicating if this script is scoped to a namespace or the entire cluster.", - "optional": true - }, - "script": { - "name": "script", - "type": "TypeString", - "description": "Optional script that needs to be run post any pre-condition script.", - "optional": true - }, - "script_permission": { - "name": "script_permission", - "type": "TypeString", - "description": "Optional iam permissions that are required on the target cluster to run this script.", - "optional": true - } - } - }, - { - "name": "licenses", - "type": "TypeList", - "description": "List of licenses the product was built with.", - "optional": true, - "computed": true, - "elem": { - "description": { - "name": "description", - "type": "TypeString", - "description": "License description.", - "optional": true, - "computed": true - }, - "id": { - "name": "id", - "type": "TypeString", - "description": "License ID.", - "optional": true, - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "license name.", - "optional": true, - "computed": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "type of license e.g., Apache xxx.", - "optional": true, - "computed": true - }, - "url": { - "name": "url", - "type": "TypeString", - "description": "URL for the license text.", - "optional": true, - "computed": true - } - } - }, - { - "name": "image_pull_key_name", + "name": "version", "type": "TypeString", - "description": "ID of the image pull key to use from Offering.ImagePullKeys.", + "description": "Semantic version of the software being onboarded. Required for virtual server image for VPC.", "computed": true }, - { - "name": "product_kind", - "type": "TypeString", - "description": "Optional product kind for the software being onboarded. Valid values are software, module, or solution. Default value is software.", - "immutable": true, - "optional": true - }, { "name": "import_metadata", "type": "TypeList", @@ -93463,6 +98590,181 @@ }, "max_items": 1 }, + { + "name": "x_auth_token", + "type": "TypeString", + "description": "Authentication token used to access the specified zip file.", + "immutable": true, + "optional": true + }, + { + "name": "iam_permissions", + "type": "TypeList", + "description": "List of IAM permissions that are required to consume this version.", + "optional": true, + "elem": { + "resources": { + "name": "resources", + "type": "TypeList", + "description": "Resources for this permission.", + "optional": true, + "elem": { + "description": { + "name": "description", + "type": "TypeString", + "description": "Resource description.", + "optional": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Resource name.", + "optional": true + }, + "role_crns": { + "name": "role_crns", + "type": "TypeList", + "description": "Role CRNs for this permission.", + "optional": true, + "elem": { + "type": "TypeString" + } + } + } + }, + "role_crns": { + "name": "role_crns", + "type": "TypeList", + "description": "Role CRNs for this permission.", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + "service_name": { + "name": "service_name", + "type": "TypeString", + "description": "Service name.", + "optional": true + } + } + }, + { + "name": "validation", + "type": "TypeList", + "description": "Validation response.", + "computed": true, + "elem": { + "last_operation": { + "name": "last_operation", + "type": "TypeString", + "description": "Last operation (e.g. submit_deployment, generate_installer, install_offering.", + "optional": true + }, + "message": { + "name": "message", + "type": "TypeString", + "description": "Any message needing to be conveyed as part of the validation job.", + "optional": true + }, + "requested": { + "name": "requested", + "type": "TypeString", + "description": "Date and time of last validation was requested.", + "optional": true + }, + "state": { + "name": "state", + "type": "TypeString", + "description": "Current validation state - \u003cempty\u003e, in_progress, valid, invalid, expired.", + "optional": true + }, + "target": { + "name": "target", + "type": "TypeMap", + "description": "Validation target information (e.g. cluster_id, region, namespace, etc). Values will vary by Content type.", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + "validated": { + "name": "validated", + "type": "TypeString", + "description": "Date and time of last successful validation.", + "optional": true + } + } + }, + { + "name": "is_vsi", + "type": "TypeBool", + "description": "Indicates that the current terraform template is used to install a virtual server image.", + "immutable": true, + "optional": true + }, + { + "name": "tgz_url", + "type": "TypeString", + "description": "File used to on-board this version.", + "computed": true + }, + { + "name": "offering_identifier", + "type": "TypeString", + "description": "Offering ID, in the format of \u003caccount_id\u003e:o:\u003coffering_id\u003e.", + "computed": true + }, + { + "name": "product_kind", + "type": "TypeString", + "description": "Optional product kind for the software being onboarded. Valid values are software, module, or solution. Default value is software.", + "immutable": true, + "optional": true + }, + { + "name": "usage", + "type": "TypeString", + "description": "The usage text for this version.", + "optional": true + }, + { + "name": "working_directory", + "type": "TypeString", + "description": "Optional - The sub-folder within the specified tgz file that contains the software being onboarded.", + "immutable": true, + "optional": true + }, + { + "name": "include_config", + "type": "TypeBool", + "description": "Add all possible configuration values to this version when importing.", + "immutable": true, + "optional": true + }, + { + "name": "long_description_i18n", + "type": "TypeMap", + "description": "A map of translated strings, by language code.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "install_kind", + "type": "TypeString", + "description": "Install type. Example: instance. Required for virtual server image for VPC.", + "immutable": true, + "optional": true + }, + { + "name": "format_kind", + "type": "TypeString", + "description": "Format of content being onboarded. Example: vsi-image. Required for virtual server image for VPC.", + "immutable": true, + "optional": true + }, { "name": "configuration", "type": "TypeList", @@ -93608,391 +98910,79 @@ "type": "TypeString", "description": "Value type (string, boolean, int).", "optional": true, - "computed": true - }, - "type_metadata": { - "name": "type_metadata", - "type": "TypeString", - "description": "The original type, as found in the source being onboarded.", - "optional": true, - "computed": true - }, - "value_constraint": { - "name": "value_constraint", - "type": "TypeString", - "description": "Constraint associated with value, e.g., for string type - regx:[a-z].", - "optional": true, - "computed": true - } - } - }, - { - "name": "sha", - "type": "TypeString", - "description": "SHA256 fingerprint of the image file. Required for virtual server image for VPC.", - "computed": true - }, - { - "name": "terraform_version", - "type": "TypeString", - "description": "Provide a terraform version for this offering version to use.", - "optional": true - }, - { - "name": "deprecate", - "type": "TypeBool", - "description": "Deprecate this version.", - "optional": true - }, - { - "name": "flavor", - "type": "TypeList", - "description": "Version Flavor Information. Only supported for Product kind Solution.", - "optional": true, - "elem": { - "index": { - "name": "index", - "type": "TypeInt", - "description": "Order that this flavor should appear when listed for a single version.", - "optional": true - }, - "label": { - "name": "label", - "type": "TypeString", - "description": "Label for this flavor.", - "optional": true - }, - "label_i18n": { - "name": "label_i18n", - "type": "TypeMap", - "description": "A map of translated strings, by language code.", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Programmatic name for this flavor.", - "optional": true - } - }, - "max_items": 1 - }, - { - "name": "required_resources", - "type": "TypeList", - "description": "Resource requirments for installation.", - "computed": true, - "elem": { - "type": { - "name": "type", - "type": "TypeString", - "description": "Type of requirement.", - "optional": true - }, - "value": { - "name": "value", - "type": "TypeString", - "description": "mem, disk, cores, and nodes can be parsed as an int. targetVersion will be a semver range value.", - "optional": true - } - } - }, - { - "name": "version_locator", - "type": "TypeString", - "description": "A dotted value of `catalogID`.`versionID`.", - "computed": true - }, - { - "name": "created", - "type": "TypeString", - "description": "The date and time this version was created.", - "computed": true - }, - { - "name": "iam_permissions", - "type": "TypeList", - "description": "List of IAM permissions that are required to consume this version.", - "optional": true, - "elem": { - "resources": { - "name": "resources", - "type": "TypeList", - "description": "Resources for this permission.", - "optional": true, - "elem": { - "description": { - "name": "description", - "type": "TypeString", - "description": "Resource description.", - "optional": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Resource name.", - "optional": true - }, - "role_crns": { - "name": "role_crns", - "type": "TypeList", - "description": "Role CRNs for this permission.", - "optional": true, - "elem": { - "type": "TypeString" - } - } - } - }, - "role_crns": { - "name": "role_crns", - "type": "TypeList", - "description": "Role CRNs for this permission.", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - "service_name": { - "name": "service_name", - "type": "TypeString", - "description": "Service name.", - "optional": true - } - } - }, - { - "name": "offering_identifier", - "type": "TypeString", - "description": "Offering ID, in the format of \u003caccount_id\u003e:o:\u003coffering_id\u003e.", - "computed": true - }, - { - "name": "offering_id", - "type": "TypeString", - "description": "Offering identification.", - "immutable": true, - "required": true - }, - { - "name": "format_kind", - "type": "TypeString", - "description": "Format of content being onboarded. Example: vsi-image. Required for virtual server image for VPC.", - "immutable": true, - "optional": true - }, - { - "name": "version", - "type": "TypeString", - "description": "Semantic version of the software being onboarded. Required for virtual server image for VPC.", - "computed": true - }, - { - "name": "crn", - "type": "TypeString", - "description": "Version's CRN.", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "kind_id", - "type": "TypeString", - "description": "Kind ID.", - "computed": true - }, - { - "name": "catalog_id", - "type": "TypeString", - "description": "Catalog identifier.", - "immutable": true, - "required": true - }, - { - "name": "label", - "type": "TypeString", - "description": "Display name of version. Required for virtual server image for VPC.", - "optional": true - }, - { - "name": "import_sha", - "type": "TypeString", - "description": "SHA256 fingerprint of the image file. Required for virtual server image for VPC.", - "optional": true - }, - { - "name": "validation", - "type": "TypeList", - "description": "Validation response.", - "computed": true, - "elem": { - "last_operation": { - "name": "last_operation", - "type": "TypeString", - "description": "Last operation (e.g. submit_deployment, generate_installer, install_offering.", - "optional": true - }, - "message": { - "name": "message", - "type": "TypeString", - "description": "Any message needing to be conveyed as part of the validation job.", - "optional": true - }, - "requested": { - "name": "requested", - "type": "TypeString", - "description": "Date and time of last validation was requested.", - "optional": true - }, - "state": { - "name": "state", - "type": "TypeString", - "description": "Current validation state - \u003cempty\u003e, in_progress, valid, invalid, expired.", - "optional": true - }, - "target": { - "name": "target", - "type": "TypeMap", - "description": "Validation target information (e.g. cluster_id, region, namespace, etc). Values will vary by Content type.", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - "validated": { - "name": "validated", - "type": "TypeString", - "description": "Date and time of last successful validation.", - "optional": true - } - } - }, - { - "name": "updated", - "type": "TypeString", - "description": "The date and time this version was last updated.", - "computed": true - }, - { - "name": "repo_url", - "type": "TypeString", - "description": "Content's repo URL.", - "computed": true - }, - { - "name": "outputs", - "type": "TypeList", - "description": "List of output values for this version.", - "computed": true, - "elem": { - "description": { - "name": "description", + "computed": true + }, + "type_metadata": { + "name": "type_metadata", "type": "TypeString", - "description": "Output description.", - "optional": true + "description": "The original type, as found in the source being onboarded.", + "optional": true, + "computed": true }, - "key": { - "name": "key", + "value_constraint": { + "name": "value_constraint", "type": "TypeString", - "description": "Output key.", - "optional": true + "description": "Constraint associated with value, e.g., for string type - regx:[a-z].", + "optional": true, + "computed": true } } }, { - "name": "long_description", + "name": "offering_id", "type": "TypeString", - "description": "Long description for version.", - "computed": true - }, - { - "name": "target_kinds", - "type": "TypeList", - "description": "Deployment target of the content being onboarded. Current valid values are iks, roks, vcenter, power-iaas, terraform, and vpc-x86. Required for virtual server image for VPC.", + "description": "Offering identification.", "immutable": true, - "optional": true, - "elem": { - "type": "TypeString" - } + "required": true }, { - "name": "usage", + "name": "zipurl", "type": "TypeString", - "description": "The usage text for this version.", + "description": "URL path to zip location. If not specified, must provide content in the body of this call.", + "immutable": true, "optional": true }, { - "name": "target_version", + "name": "updated", "type": "TypeString", - "description": "The semver value for this new version, if not found in the zip url package content.", - "immutable": true, - "optional": true + "description": "The date and time this version was last updated.", + "computed": true }, { - "name": "x_auth_token", + "name": "deprecated", + "type": "TypeBool", + "description": "read only field, indicating if this version is deprecated.", + "computed": true + }, + { + "name": "long_description", "type": "TypeString", - "description": "Authentication token used to access the specified zip file.", - "immutable": true, - "optional": true + "description": "Long description for version.", + "computed": true }, { - "name": "state", - "type": "TypeList", - "description": "Offering state.", - "computed": true, - "elem": { - "current": { - "name": "current", - "type": "TypeString", - "description": "one of: new, validated, account-published, ibm-published, public-published.", - "computed": true - }, - "current_entered": { - "name": "current_entered", - "type": "TypeString", - "description": "Date and time of current request.", - "computed": true - }, - "pending": { - "name": "pending", - "type": "TypeString", - "description": "one of: new, validated, account-published, ibm-published, public-published.", - "computed": true - }, - "pending_requested": { - "name": "pending_requested", - "type": "TypeString", - "description": "Date and time of pending request.", - "computed": true - }, - "previous": { - "name": "previous", - "type": "TypeString", - "description": "one of: new, validated, account-published, ibm-published, public-published.", - "computed": true - } - } + "name": "is_consumable", + "type": "TypeBool", + "description": "Is the version able to be shared.", + "computed": true }, { - "name": "name", + "name": "label", "type": "TypeString", - "description": "Name of version. Required for virtual server image for VPC.", - "immutable": true, + "description": "Display name of version. Required for virtual server image for VPC.", "optional": true }, { - "name": "include_config", - "type": "TypeBool", - "description": "Add all possible configuration values to this version when importing.", + "name": "name", + "type": "TypeString", + "description": "Name of version. Required for virtual server image for VPC.", "immutable": true, "optional": true }, { - "name": "tgz_url", + "name": "source_url", "type": "TypeString", - "description": "File used to on-board this version.", + "description": "Content's source URL (e.g git repo).", "computed": true }, { @@ -94036,30 +99026,6 @@ } } }, - { - "name": "deprecated", - "type": "TypeBool", - "description": "read only field, indicating if this version is deprecated.", - "computed": true - }, - { - "name": "rev", - "type": "TypeString", - "description": "Cloudant revision.", - "computed": true - }, - { - "name": "source_url", - "type": "TypeString", - "description": "Content's source URL (e.g git repo).", - "computed": true - }, - { - "name": "image_manifest_url", - "type": "TypeString", - "description": "If set, denotes a url to a YAML file with list of container images used by this version.", - "computed": true - }, { "name": "repotype", "type": "TypeString", @@ -94068,34 +99034,23 @@ "optional": true }, { - "name": "package_version", - "type": "TypeString", - "description": "Version of the package used to create this version.", - "computed": true + "name": "tags", + "type": "TypeList", + "description": "Tags array.", + "cloud_data_type": "tags", + "optional": true, + "elem": { + "type": "TypeString" + } }, { - "name": "deprecate_pending", + "name": "target_kinds", "type": "TypeList", - "description": "Deprecation information for a Version.", - "computed": true, + "description": "Deployment target of the content being onboarded. Current valid values are iks, roks, vcenter, power-iaas, terraform, and vpc-x86. Required for virtual server image for VPC.", + "immutable": true, + "optional": true, "elem": { - "deprecate_date": { - "name": "deprecate_date", - "type": "TypeString", - "description": "Date of deprecation.", - "computed": true - }, - "deprecate_state": { - "name": "deprecate_state", - "type": "TypeString", - "description": "Deprecation state.", - "computed": true - }, - "description": { - "name": "description", - "type": "TypeString", - "computed": true - } + "type": "TypeString" } }, { @@ -94362,49 +99317,119 @@ } }, { - "name": "zipurl", + "name": "kind_id", "type": "TypeString", - "description": "URL path to zip location. If not specified, must provide content in the body of this call.", - "immutable": true, - "optional": true + "description": "Kind ID.", + "computed": true }, { - "name": "is_vsi", - "type": "TypeBool", - "description": "Indicates that the current terraform template is used to install a virtual server image.", - "immutable": true, - "optional": true + "name": "crn", + "type": "TypeString", + "description": "Version's CRN.", + "cloud_data_type": "crn", + "computed": true }, { - "name": "long_description_i18n", - "type": "TypeMap", - "description": "A map of translated strings, by language code.", + "name": "outputs", + "type": "TypeList", + "description": "List of output values for this version.", "computed": true, "elem": { - "type": "TypeString" + "description": { + "name": "description", + "type": "TypeString", + "description": "Output description.", + "optional": true + }, + "key": { + "name": "key", + "type": "TypeString", + "description": "Output key.", + "optional": true + } } }, { - "name": "is_consumable", - "type": "TypeBool", - "description": "Is the version able to be shared.", + "name": "required_resources", + "type": "TypeList", + "description": "Resource requirments for installation.", + "computed": true, + "elem": { + "type": { + "name": "type", + "type": "TypeString", + "description": "Type of requirement.", + "optional": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "mem, disk, cores, and nodes can be parsed as an int. targetVersion will be a semver range value.", + "optional": true + } + } + }, + { + "name": "licenses", + "type": "TypeList", + "description": "List of licenses the product was built with.", + "optional": true, + "computed": true, + "elem": { + "description": { + "name": "description", + "type": "TypeString", + "description": "License description.", + "optional": true, + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "License ID.", + "optional": true, + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "license name.", + "optional": true, + "computed": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "type of license e.g., Apache xxx.", + "optional": true, + "computed": true + }, + "url": { + "name": "url", + "type": "TypeString", + "description": "URL for the license text.", + "optional": true, + "computed": true + } + } + }, + { + "name": "image_manifest_url", + "type": "TypeString", + "description": "If set, denotes a url to a YAML file with list of container images used by this version.", "computed": true }, { - "name": "version_id", + "name": "image_pull_key_name", "type": "TypeString", - "description": "Unique ID.", + "description": "ID of the image pull key to use from Offering.ImagePullKeys.", "computed": true }, { - "name": "tags", - "type": "TypeList", - "description": "Tags array.", - "cloud_data_type": "tags", - "optional": true, - "elem": { - "type": "TypeString" - } + "name": "version_id", + "type": "TypeString", + "description": "Unique ID.", + "computed": true }, { "name": "content", @@ -94414,12 +99439,59 @@ "optional": true }, { - "name": "working_directory", + "name": "sha", "type": "TypeString", - "description": "Optional - The sub-folder within the specified tgz file that contains the software being onboarded.", - "immutable": true, + "description": "SHA256 fingerprint of the image file. Required for virtual server image for VPC.", + "computed": true + }, + { + "name": "terraform_version", + "type": "TypeString", + "description": "Provide a terraform version for this offering version to use.", "optional": true }, + { + "name": "flavor", + "type": "TypeList", + "description": "Version Flavor Information. Only supported for Product kind Solution.", + "optional": true, + "elem": { + "index": { + "name": "index", + "type": "TypeInt", + "description": "Order that this flavor should appear when listed for a single version.", + "optional": true + }, + "label": { + "name": "label", + "type": "TypeString", + "description": "Label for this flavor.", + "optional": true + }, + "label_i18n": { + "name": "label_i18n", + "type": "TypeMap", + "description": "A map of translated strings, by language code.", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Programmatic name for this flavor.", + "optional": true + } + }, + "max_items": 1 + }, + { + "name": "rev", + "type": "TypeString", + "description": "Cloudant revision.", + "computed": true + }, { "name": "single_instance", "type": "TypeBool", @@ -94464,758 +99536,167 @@ "optional": true, "computed": true }, - "script": { - "name": "script", - "type": "TypeString", - "description": "Optional script that needs to be run post any pre-condition script.", - "optional": true, - "computed": true - }, - "script_permission": { - "name": "script_permission", - "type": "TypeString", - "description": "Optional iam permissions that are required on the target cluster to run this script.", - "optional": true, - "computed": true - } - }, - "max_items": 1 - }, - { - "name": "install_kind", - "type": "TypeString", - "description": "Install type. Example: instance. Required for virtual server image for VPC.", - "immutable": true, - "optional": true - }, - { - "name": "solution_info", - "type": "TypeList", - "description": "Version Solution Information. Only supported for Product kind Solution.", - "optional": true, - "computed": true, - "elem": { - "architecture_diagrams": { - "name": "architecture_diagrams", - "type": "TypeList", - "description": "Architecture diagrams for this solution.", - "optional": true, - "elem": { - "description": { - "name": "description", - "type": "TypeString", - "description": "Description of this diagram.", - "optional": true - }, - "description_i18n": { - "name": "description_i18n", - "type": "TypeMap", - "description": "A map of translated strings, by language code.", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - "diagram": { - "name": "diagram", - "type": "TypeList", - "description": "Offering Media information.", - "optional": true, - "elem": { - "api_url": { - "name": "api_url", - "type": "TypeString", - "description": "CM API specific URL of the specified media item.", - "optional": true - }, - "caption": { - "name": "caption", - "type": "TypeString", - "description": "Caption for this media item.", - "optional": true - }, - "caption_i18n": { - "name": "caption_i18n", - "type": "TypeMap", - "description": "A map of translated strings, by language code.", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - "thumbnail_url": { - "name": "thumbnail_url", - "type": "TypeString", - "description": "Thumbnail URL for this media item.", - "optional": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "Type of this media item.", - "optional": true - }, - "url": { - "name": "url", - "type": "TypeString", - "description": "URL of the specified media item.", - "optional": true - }, - "url_proxy": { - "name": "url_proxy", - "type": "TypeList", - "description": "Offering URL proxy information.", - "optional": true, - "elem": { - "sha": { - "name": "sha", - "type": "TypeString", - "description": "SHA256 fingerprint of image.", - "optional": true - }, - "url": { - "name": "url", - "type": "TypeString", - "description": "URL of the specified media item being proxied.", - "optional": true - } - }, - "max_items": 1 - } - }, - "max_items": 1 - } - } - }, - "cost_estimate": { - "name": "cost_estimate", - "type": "TypeList", - "description": "Cost estimate definition.", - "computed": true, - "elem": { - "currency": { - "name": "currency", - "type": "TypeString", - "description": "Cost estimate currency.", - "computed": true - }, - "diff_total_hourly_cost": { - "name": "diff_total_hourly_cost", - "type": "TypeString", - "description": "Difference in total hourly cost.", - "computed": true - }, - "diff_total_monthly_cost": { - "name": "diff_total_monthly_cost", - "type": "TypeString", - "description": "Difference in total monthly cost.", - "computed": true - }, - "past_total_hourly_cost": { - "name": "past_total_hourly_cost", - "type": "TypeString", - "description": "Past total hourly cost.", - "computed": true - }, - "past_total_monthly_cost": { - "name": "past_total_monthly_cost", - "type": "TypeString", - "description": "Past total monthly cost.", - "computed": true - }, - "projects": { - "name": "projects", - "type": "TypeList", - "description": "Cost estimate projects.", - "computed": true, - "elem": { - "breakdown": { - "name": "breakdown", - "type": "TypeList", - "description": "Cost breakdown definition.", - "computed": true, - "elem": { - "resources": { - "name": "resources", - "type": "TypeList", - "description": "Resources.", - "computed": true, - "elem": { - "cost_components": { - "name": "cost_components", - "type": "TypeList", - "description": "Cost components.", - "computed": true, - "elem": { - "hourly_cost": { - "name": "hourly_cost", - "type": "TypeString", - "description": "Cost component hourly cost.", - "computed": true - }, - "hourly_quantity": { - "name": "hourly_quantity", - "type": "TypeString", - "description": "Cost component hourly quantity.", - "computed": true - }, - "monthly_cost": { - "name": "monthly_cost", - "type": "TypeString", - "description": "Cost component monthly cist.", - "computed": true - }, - "monthly_quantity": { - "name": "monthly_quantity", - "type": "TypeString", - "description": "Cost component monthly quantity.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Cost component name.", - "computed": true - }, - "price": { - "name": "price", - "type": "TypeString", - "description": "Cost component price.", - "computed": true - }, - "unit": { - "name": "unit", - "type": "TypeString", - "description": "Cost component unit.", - "computed": true - } - } - }, - "hourly_cost": { - "name": "hourly_cost", - "type": "TypeString", - "description": "Hourly cost.", - "computed": true - }, - "metadata": { - "name": "metadata", - "type": "TypeMap", - "description": "Resource metadata.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "monthly_cost": { - "name": "monthly_cost", - "type": "TypeString", - "description": "Monthly cost.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Resource name.", - "computed": true - } - } - }, - "total_hourly_cost": { - "name": "total_hourly_cost", - "type": "TypeString", - "description": "Total hourly cost.", - "computed": true - }, - "total_monthly_cost": { - "name": "total_monthly_cost", - "type": "TypeString", - "description": "Total monthly cost.", - "computed": true - } - } - }, - "diff": { - "name": "diff", - "type": "TypeList", - "description": "Cost breakdown definition.", - "computed": true, - "elem": { - "resources": { - "name": "resources", - "type": "TypeList", - "description": "Resources.", - "computed": true, - "elem": { - "cost_components": { - "name": "cost_components", - "type": "TypeList", - "description": "Cost components.", - "computed": true, - "elem": { - "hourly_cost": { - "name": "hourly_cost", - "type": "TypeString", - "description": "Cost component hourly cost.", - "computed": true - }, - "hourly_quantity": { - "name": "hourly_quantity", - "type": "TypeString", - "description": "Cost component hourly quantity.", - "computed": true - }, - "monthly_cost": { - "name": "monthly_cost", - "type": "TypeString", - "description": "Cost component monthly cist.", - "computed": true - }, - "monthly_quantity": { - "name": "monthly_quantity", - "type": "TypeString", - "description": "Cost component monthly quantity.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Cost component name.", - "computed": true - }, - "price": { - "name": "price", - "type": "TypeString", - "description": "Cost component price.", - "computed": true - }, - "unit": { - "name": "unit", - "type": "TypeString", - "description": "Cost component unit.", - "computed": true - } - } - }, - "hourly_cost": { - "name": "hourly_cost", - "type": "TypeString", - "description": "Hourly cost.", - "computed": true - }, - "metadata": { - "name": "metadata", - "type": "TypeMap", - "description": "Resource metadata.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "monthly_cost": { - "name": "monthly_cost", - "type": "TypeString", - "description": "Monthly cost.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Resource name.", - "computed": true - } - } - }, - "total_hourly_cost": { - "name": "total_hourly_cost", - "type": "TypeString", - "description": "Total hourly cost.", - "computed": true - }, - "total_monthly_cost": { - "name": "total_monthly_cost", - "type": "TypeString", - "description": "Total monthly cost.", - "computed": true - } - } - }, - "metadata": { - "name": "metadata", - "type": "TypeMap", - "description": "Project metadata.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Project name.", - "computed": true - }, - "past_breakdown": { - "name": "past_breakdown", - "type": "TypeList", - "description": "Cost breakdown definition.", - "computed": true, - "elem": { - "resources": { - "name": "resources", - "type": "TypeList", - "description": "Resources.", - "computed": true, - "elem": { - "cost_components": { - "name": "cost_components", - "type": "TypeList", - "description": "Cost components.", - "computed": true, - "elem": { - "hourly_cost": { - "name": "hourly_cost", - "type": "TypeString", - "description": "Cost component hourly cost.", - "computed": true - }, - "hourly_quantity": { - "name": "hourly_quantity", - "type": "TypeString", - "description": "Cost component hourly quantity.", - "computed": true - }, - "monthly_cost": { - "name": "monthly_cost", - "type": "TypeString", - "description": "Cost component monthly cist.", - "computed": true - }, - "monthly_quantity": { - "name": "monthly_quantity", - "type": "TypeString", - "description": "Cost component monthly quantity.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Cost component name.", - "computed": true - }, - "price": { - "name": "price", - "type": "TypeString", - "description": "Cost component price.", - "computed": true - }, - "unit": { - "name": "unit", - "type": "TypeString", - "description": "Cost component unit.", - "computed": true - } - } - }, - "hourly_cost": { - "name": "hourly_cost", - "type": "TypeString", - "description": "Hourly cost.", - "computed": true - }, - "metadata": { - "name": "metadata", - "type": "TypeMap", - "description": "Resource metadata.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "monthly_cost": { - "name": "monthly_cost", - "type": "TypeString", - "description": "Monthly cost.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Resource name.", - "computed": true - } - } - }, - "total_hourly_cost": { - "name": "total_hourly_cost", - "type": "TypeString", - "description": "Total hourly cost.", - "computed": true - }, - "total_monthly_cost": { - "name": "total_monthly_cost", - "type": "TypeString", - "description": "Total monthly cost.", - "computed": true - } - } - }, - "summary": { - "name": "summary", - "type": "TypeList", - "description": "Cost summary definition.", - "computed": true, - "elem": { - "no_price_resource_counts": { - "name": "no_price_resource_counts", - "type": "TypeMap", - "description": "No price resource counts.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "total_detected_resources": { - "name": "total_detected_resources", - "type": "TypeInt", - "description": "Total detected resources.", - "computed": true - }, - "total_no_price_resources": { - "name": "total_no_price_resources", - "type": "TypeInt", - "description": "Total no price resources.", - "computed": true - }, - "total_supported_resources": { - "name": "total_supported_resources", - "type": "TypeInt", - "description": "Total supported resources.", - "computed": true - }, - "total_unsupported_resources": { - "name": "total_unsupported_resources", - "type": "TypeInt", - "description": "Total unsupported resources.", - "computed": true - }, - "total_usage_based_resources": { - "name": "total_usage_based_resources", - "type": "TypeInt", - "description": "Total usage based resources.", - "computed": true - }, - "unsupported_resource_counts": { - "name": "unsupported_resource_counts", - "type": "TypeMap", - "description": "Unsupported resource counts.", - "computed": true, - "elem": { - "type": "TypeString" - } - } - } - } - } - }, - "summary": { - "name": "summary", - "type": "TypeList", - "description": "Cost summary definition.", - "computed": true, - "elem": { - "no_price_resource_counts": { - "name": "no_price_resource_counts", - "type": "TypeMap", - "description": "No price resource counts.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "total_detected_resources": { - "name": "total_detected_resources", - "type": "TypeInt", - "description": "Total detected resources.", - "computed": true - }, - "total_no_price_resources": { - "name": "total_no_price_resources", - "type": "TypeInt", - "description": "Total no price resources.", - "computed": true - }, - "total_supported_resources": { - "name": "total_supported_resources", - "type": "TypeInt", - "description": "Total supported resources.", - "computed": true - }, - "total_unsupported_resources": { - "name": "total_unsupported_resources", - "type": "TypeInt", - "description": "Total unsupported resources.", - "computed": true - }, - "total_usage_based_resources": { - "name": "total_usage_based_resources", - "type": "TypeInt", - "description": "Total usage based resources.", - "computed": true - }, - "unsupported_resource_counts": { - "name": "unsupported_resource_counts", - "type": "TypeMap", - "description": "Unsupported resource counts.", - "computed": true, - "elem": { - "type": "TypeString" - } - } - } - }, - "time_generated": { - "name": "time_generated", - "type": "TypeString", - "description": "When this estimate was generated.", - "computed": true - }, - "total_hourly_cost": { - "name": "total_hourly_cost", - "type": "TypeString", - "description": "Total hourly cost.", - "computed": true - }, - "total_monthly_cost": { - "name": "total_monthly_cost", - "type": "TypeString", - "description": "Total monthly cost.", - "computed": true - }, - "version": { - "name": "version", - "type": "TypeString", - "description": "Cost estimate version.", - "computed": true - } - } - }, - "dependencies": { - "name": "dependencies", - "type": "TypeList", - "description": "Dependencies for this solution.", - "optional": true, - "elem": { - "catalog_id": { - "name": "catalog_id", - "type": "TypeString", - "description": "Optional - If not specified, assumes the Public Catalog.", - "optional": true - }, - "flavors": { - "name": "flavors", - "type": "TypeList", - "description": "Optional - List of dependent flavors in the specified range.", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - "id": { - "name": "id", - "type": "TypeString", - "description": "Optional - Offering ID - not required if name is set.", - "optional": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Optional - Programmatic Offering name.", - "optional": true - }, - "version": { - "name": "version", - "type": "TypeString", - "description": "Required - Semver value or range.", - "optional": true - } - } + "script": { + "name": "script", + "type": "TypeString", + "description": "Optional script that needs to be run post any pre-condition script.", + "optional": true, + "computed": true }, - "features": { - "name": "features", - "type": "TypeList", - "description": "Features - titles only.", + "script_permission": { + "name": "script_permission", + "type": "TypeString", + "description": "Optional iam permissions that are required on the target cluster to run this script.", "optional": true, - "elem": { - "description": { - "name": "description", - "type": "TypeString", - "description": "Feature description.", - "optional": true - }, - "description_i18n": { - "name": "description_i18n", - "type": "TypeMap", - "description": "A map of translated strings, by language code.", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - "title": { - "name": "title", - "type": "TypeString", - "description": "Heading.", - "optional": true - }, - "title_i18n": { - "name": "title_i18n", - "type": "TypeMap", - "description": "A map of translated strings, by language code.", - "optional": true, - "elem": { - "type": "TypeString" - } - } - } + "computed": true } }, "max_items": 1 - } - ], - "ibm_code_engine_app": [ + }, { - "name": "scale_initial_instances", - "type": "TypeInt", - "description": "Optional initial number of instances that are created upon app creation or app update.", - "default_value": 1, + "name": "catalog_id", + "type": "TypeString", + "description": "Catalog identifier.", + "immutable": true, + "required": true + }, + { + "name": "deprecate", + "type": "TypeBool", + "description": "Deprecate this version.", "optional": true }, { - "name": "scale_memory_limit", + "name": "target_version", "type": "TypeString", - "description": "Optional amount of memory set for the instance of the app. For valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo). The units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", - "default_value": "4G", - "max_length": 10, - "matches": "^([0-9.]+)([eEinumkKMGTPB]*)$", + "description": "The semver value for this new version, if not found in the zip url package content.", + "immutable": true, "optional": true }, { - "name": "app_id", + "name": "repo_url", "type": "TypeString", - "description": "The identifier of the resource.", + "description": "Content's repo URL.", "computed": true }, { - "name": "resource_type", - "type": "TypeString", - "description": "The type of the app.", - "computed": true + "name": "pre_install", + "type": "TypeList", + "description": "Optional pre-install instructions.", + "optional": true, + "elem": { + "delete_script": { + "name": "delete_script", + "type": "TypeString", + "description": "Optional script that if run will remove the installed version.", + "optional": true + }, + "instructions": { + "name": "instructions", + "type": "TypeString", + "description": "Instruction on step and by whom (role) that are needed to take place to prepare the target for installing this version.", + "optional": true + }, + "instructions_i18n": { + "name": "instructions_i18n", + "type": "TypeMap", + "description": "A map of translated strings, by language code.", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + "scope": { + "name": "scope", + "type": "TypeString", + "description": "Optional value indicating if this script is scoped to a namespace or the entire cluster.", + "optional": true + }, + "script": { + "name": "script", + "type": "TypeString", + "description": "Optional script that needs to be run post any pre-condition script.", + "optional": true + }, + "script_permission": { + "name": "script_permission", + "type": "TypeString", + "description": "Optional iam permissions that are required on the target cluster to run this script.", + "optional": true + } + } }, { - "name": "etag", + "name": "state", + "type": "TypeList", + "description": "Offering state.", + "computed": true, + "elem": { + "current": { + "name": "current", + "type": "TypeString", + "description": "one of: new, validated, account-published, ibm-published, public-published.", + "computed": true + }, + "current_entered": { + "name": "current_entered", + "type": "TypeString", + "description": "Date and time of current request.", + "computed": true + }, + "pending": { + "name": "pending", + "type": "TypeString", + "description": "one of: new, validated, account-published, ibm-published, public-published.", + "computed": true + }, + "pending_requested": { + "name": "pending_requested", + "type": "TypeString", + "description": "Date and time of pending request.", + "computed": true + }, + "previous": { + "name": "previous", + "type": "TypeString", + "description": "one of: new, validated, account-published, ibm-published, public-published.", + "computed": true + } + } + }, + { + "name": "version_locator", "type": "TypeString", + "description": "A dotted value of `catalogID`.`versionID`.", "computed": true }, + { + "name": "deprecate_pending", + "type": "TypeList", + "description": "Deprecation information for a Version.", + "computed": true, + "elem": { + "deprecate_date": { + "name": "deprecate_date", + "type": "TypeString", + "description": "Date of deprecation.", + "computed": true + }, + "deprecate_state": { + "name": "deprecate_state", + "type": "TypeString", + "description": "Deprecation state.", + "computed": true + }, + "description": { + "name": "description", + "type": "TypeString", + "computed": true + } + } + } + ], + "ibm_code_engine_app": [ { "name": "name", "type": "TypeString", @@ -95227,25 +99708,19 @@ "matches": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, { - "name": "run_as_user", - "type": "TypeInt", - "description": "Optional user ID (UID) to run the app (e.g., `1001`).", - "optional": true - }, - { - "name": "scale_cpu_limit", - "type": "TypeString", - "description": "Optional number of CPU set for the instance of the app. For valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).", - "default_value": "1", - "max_length": 10, - "matches": "^([0-9.]+)([eEinumkKMGTPB]*)$", - "optional": true + "name": "run_commands", + "type": "TypeList", + "description": "Optional commands for the app that are passed to start the container. If not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.", + "optional": true, + "elem": { + "type": "TypeString" + } }, { - "name": "scale_min_instances", + "name": "scale_max_instances", "type": "TypeInt", - "description": "Optional minimum number of instances for this app. If you set this value to `0`, the app will scale down to zero, if not hit by any request for some time.", - "default_value": 0, + "description": "Optional maximum number of instances for this app. If you set this value to `0`, this property does not set a upper scaling limit. However, the app scaling is still limited by the project quota for instances. See [Limits and quotas for Code Engine](https://cloud.ibm.com/docs/codeengine?topic=codeengine-limits).", + "default_value": 10, "optional": true }, { @@ -95269,15 +99744,6 @@ "max_length": 256, "matches": "^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\\/])?[a-z0-9][a-z0-9\\-_.\\/]+[a-z0-9](:[\\w][\\w.\\-]{0,127})?(@sha256:[a-fA-F0-9]{64})?$" }, - { - "name": "run_commands", - "type": "TypeList", - "description": "Optional commands for the app that are passed to start the container. If not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.", - "optional": true, - "elem": { - "type": "TypeString" - } - }, { "name": "run_service_account", "type": "TypeString", @@ -95288,20 +99754,10 @@ "optional": true }, { - "name": "scale_request_timeout", - "type": "TypeInt", - "description": "Optional amount of time in seconds that is allowed for a running app to respond to a request.", - "default_value": 300, - "optional": true - }, - { - "name": "run_arguments", - "type": "TypeList", - "description": "Optional arguments for the app that are passed to start the container. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.", - "optional": true, - "elem": { - "type": "TypeString" - } + "name": "created_at", + "type": "TypeString", + "description": "The timestamp when the resource was created.", + "computed": true }, { "name": "scale_ephemeral_storage_limit", @@ -95313,37 +99769,15 @@ "optional": true }, { - "name": "created_at", - "type": "TypeString", - "description": "The timestamp when the resource was created.", - "computed": true - }, - { - "name": "endpoint", - "type": "TypeString", - "description": "Optional URL to invoke app. Depending on visibility this is accessible publicly or in the private network only. Empty in case 'managed_domain_mappings' is set to 'local'.", - "computed": true - }, - { - "name": "status", + "name": "app_id", "type": "TypeString", - "description": "The current status of the app.", + "description": "The identifier of the resource.", "computed": true }, { - "name": "image_secret", - "type": "TypeString", - "description": "Optional name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image. If the image reference points to a registry that requires authentication, the app will be created but cannot reach the ready status, until this property is provided, too.", - "min_length": 1, - "max_length": 253, - "matches": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", - "optional": true - }, - { - "name": "image_port", + "name": "run_as_user", "type": "TypeInt", - "description": "Optional port the app listens on. While the app will always be exposed via port `443` for end users, this port is used to connect to the port that is exposed by the container image.", - "default_value": 8080, + "description": "Optional user ID (UID) to run the app (e.g., `1001`).", "optional": true }, { @@ -95392,37 +99826,62 @@ } }, { - "name": "run_volume_mounts", + "name": "scale_concurrency", + "type": "TypeInt", + "description": "Optional maximum number of requests that can be processed concurrently per instance.", + "default_value": 100, + "optional": true + }, + { + "name": "run_arguments", "type": "TypeList", - "description": "Optional mounts of config maps or a secrets.", + "description": "Optional arguments for the app that are passed to start the container. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.", "optional": true, "elem": { - "mount_path": { - "name": "mount_path", - "type": "TypeString", - "description": "The path that should be mounted.", - "required": true - }, - "name": { - "name": "name", + "type": "TypeString" + } + }, + { + "name": "scale_memory_limit", + "type": "TypeString", + "description": "Optional amount of memory set for the instance of the app. For valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo). The units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", + "default_value": "4G", + "max_length": 10, + "matches": "^([0-9.]+)([eEinumkKMGTPB]*)$", + "optional": true + }, + { + "name": "status_details", + "type": "TypeList", + "description": "The detailed status of the application.", + "computed": true, + "elem": { + "latest_created_revision": { + "name": "latest_created_revision", "type": "TypeString", - "description": "Optional name of the mount. If not set, it will be generated based on the `ref` and a random ID. In case the `ref` is longer than 58 characters, it will be cut off.", - "optional": true + "description": "Latest app revision that has been created.", + "computed": true }, - "reference": { - "name": "reference", + "latest_ready_revision": { + "name": "latest_ready_revision", "type": "TypeString", - "description": "The name of the referenced secret or config map.", - "required": true + "description": "Latest app revision that reached a ready state.", + "computed": true }, - "type": { - "name": "type", + "reason": { + "name": "reason", "type": "TypeString", - "description": "Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.", - "required": true + "description": "Optional information to provide more context in case of a 'failed' or 'warning' status.", + "computed": true } } }, + { + "name": "resource_type", + "type": "TypeString", + "description": "The type of the app.", + "computed": true + }, { "name": "project_id", "type": "TypeString", @@ -95433,6 +99892,15 @@ "max_length": 36, "matches": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$" }, + { + "name": "scale_cpu_limit", + "type": "TypeString", + "description": "Optional number of CPU set for the instance of the app. For valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).", + "default_value": "1", + "max_length": 10, + "matches": "^([0-9.]+)([eEinumkKMGTPB]*)$", + "optional": true + }, { "name": "entity_tag", "type": "TypeString", @@ -95440,67 +99908,107 @@ "computed": true }, { - "name": "scale_concurrency_target", + "name": "etag", + "type": "TypeString", + "computed": true + }, + { + "name": "managed_domain_mappings", + "type": "TypeString", + "description": "Optional value controlling which of the system managed domain mappings will be setup for the application. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports application private visibility.", + "default_value": "local_public", + "options": "local, local_private, local_public", + "optional": true + }, + { + "name": "scale_min_instances", "type": "TypeInt", - "description": "Optional threshold of concurrent requests per instance at which one or more additional instances are created. Use this value to scale up instances based on concurrent number of requests. This option defaults to the value of the `scale_concurrency` option, if not specified.", + "description": "Optional minimum number of instances for this app. If you set this value to `0`, the app will scale down to zero, if not hit by any request for some time.", + "default_value": 0, "optional": true }, { - "name": "status_details", + "name": "scale_request_timeout", + "type": "TypeInt", + "description": "Optional amount of time in seconds that is allowed for a running app to respond to a request.", + "default_value": 300, + "optional": true + }, + { + "name": "image_secret", + "type": "TypeString", + "description": "Optional name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image. If the image reference points to a registry that requires authentication, the app will be created but cannot reach the ready status, until this property is provided, too.", + "min_length": 1, + "max_length": 253, + "matches": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", + "optional": true + }, + { + "name": "run_volume_mounts", "type": "TypeList", - "description": "The detailed status of the application.", - "computed": true, + "description": "Optional mounts of config maps or a secrets.", + "optional": true, "elem": { - "latest_created_revision": { - "name": "latest_created_revision", + "mount_path": { + "name": "mount_path", "type": "TypeString", - "description": "Latest app revision that has been created.", - "computed": true + "description": "The path that should be mounted.", + "required": true }, - "latest_ready_revision": { - "name": "latest_ready_revision", + "name": { + "name": "name", "type": "TypeString", - "description": "Latest app revision that reached a ready state.", - "computed": true + "description": "Optional name of the mount. If not set, it will be generated based on the `ref` and a random ID. In case the `ref` is longer than 58 characters, it will be cut off.", + "optional": true }, - "reason": { - "name": "reason", + "reference": { + "name": "reference", "type": "TypeString", - "description": "Optional information to provide more context in case of a 'failed' or 'warning' status.", - "computed": true + "description": "The name of the referenced secret or config map.", + "required": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.", + "required": true } } }, { - "name": "managed_domain_mappings", + "name": "endpoint", "type": "TypeString", - "description": "Optional value controlling which of the system managed domain mappings will be setup for the application. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports application private visibility.", - "default_value": "local_public", - "options": "local, local_private, local_public", + "description": "Optional URL to invoke app. Depending on visibility this is accessible publicly or in the private network only. Empty in case 'managed_domain_mappings' is set to 'local'.", + "computed": true + }, + { + "name": "status", + "type": "TypeString", + "description": "The current status of the app.", + "computed": true + }, + { + "name": "image_port", + "type": "TypeInt", + "description": "Optional port the app listens on. While the app will always be exposed via port `443` for end users, this port is used to connect to the port that is exposed by the container image.", + "default_value": 8080, "optional": true }, { - "name": "scale_max_instances", + "name": "scale_concurrency_target", "type": "TypeInt", - "description": "Optional maximum number of instances for this app. If you set this value to `0`, this property does not set a upper scaling limit. However, the app scaling is still limited by the project quota for instances. See [Limits and quotas for Code Engine](https://cloud.ibm.com/docs/codeengine?topic=codeengine-limits).", - "default_value": 10, + "description": "Optional threshold of concurrent requests per instance at which one or more additional instances are created. Use this value to scale up instances based on concurrent number of requests. This option defaults to the value of the `scale_concurrency` option, if not specified.", "optional": true }, { - "name": "scale_concurrency", + "name": "scale_initial_instances", "type": "TypeInt", - "description": "Optional maximum number of requests that can be processed concurrently per instance.", - "default_value": 100, + "description": "Optional initial number of instances that are created upon app creation or app update.", + "default_value": 1, "optional": true } ], "ibm_code_engine_binding": [ - { - "name": "href", - "type": "TypeString", - "description": "When you provision a new binding, a URL is created identifying the location of the instance.", - "computed": true - }, { "name": "resource_type", "type": "TypeString", @@ -95570,84 +100078,77 @@ "min_length": 1, "max_length": 253, "matches": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$" + }, + { + "name": "href", + "type": "TypeString", + "description": "When you provision a new binding, a URL is created identifying the location of the instance.", + "computed": true } ], "ibm_code_engine_build": [ { - "name": "status", + "name": "name", "type": "TypeString", - "description": "The current status of the build.", - "computed": true + "description": "The name of the build. Use a name that is unique within the project.", + "immutable": true, + "required": true, + "min_length": 1, + "max_length": 63, + "matches": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?$" }, { - "name": "resource_type", + "name": "output_image", "type": "TypeString", - "description": "The type of the build.", - "computed": true + "description": "The name of the image.", + "required": true, + "min_length": 1, + "max_length": 256, + "matches": "^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\\/])?[a-z0-9][a-z0-9\\-_.\\/]+[a-z0-9](:[\\w][\\w.\\-]{0,127})?(@sha256:[a-fA-F0-9]{64})?$" }, { - "name": "source_context_dir", - "type": "TypeString", - "description": "Option directory in the repository that contains the buildpacks file or the Dockerfile.", - "max_length": 253, - "matches": "^(.*)+$", + "name": "timeout", + "type": "TypeInt", + "description": "The maximum amount of time, in seconds, that can pass before the build must succeed or fail.", + "default_value": 600, + "min_value": "1", + "max_value": "3600", "optional": true }, { - "name": "source_revision", + "name": "href", "type": "TypeString", - "description": "Commit, tag, or branch in the source repository to pull. This field is optional if the `source_type` is `git` and uses the HEAD of default branch if not specified. If the `source_type` value is `local`, this field must be omitted.", - "max_length": 253, - "matches": "^[\\S]*$", - "optional": true + "description": "When you provision a new build, a URL is created identifying the location of the instance.", + "computed": true }, { - "name": "strategy_spec_file", + "name": "etag", "type": "TypeString", - "description": "Optional path to the specification file that is used for build strategies for building an image.", - "default_value": "Dockerfile", - "min_length": 1, - "max_length": 253, - "matches": "^[\\S]*$", - "optional": true + "computed": true }, { - "name": "created_at", + "name": "entity_tag", "type": "TypeString", - "description": "The timestamp when the resource was created.", + "description": "The version of the build instance, which is used to achieve optimistic locking.", "computed": true }, { - "name": "status_details", - "type": "TypeList", - "description": "The detailed status of the build.", - "computed": true, - "elem": { - "reason": { - "name": "reason", - "type": "TypeString", - "description": "Optional information to provide more context in case of a 'failed' or 'warning' status.", - "computed": true - } - } - }, - { - "name": "output_image", + "name": "project_id", "type": "TypeString", - "description": "The name of the image.", + "description": "The ID of the project.", + "immutable": true, "required": true, - "min_length": 1, - "max_length": 256, - "matches": "^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\\/])?[a-z0-9][a-z0-9\\-_.\\/]+[a-z0-9](:[\\w][\\w.\\-]{0,127})?(@sha256:[a-fA-F0-9]{64})?$" + "min_length": 36, + "max_length": 36, + "matches": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$" }, { - "name": "output_secret", + "name": "source_revision", "type": "TypeString", - "description": "The secret that is required to access the image registry. Make sure that the secret is granted with push permissions towards the specified container registry namespace.", - "required": true, - "min_length": 1, + "description": "Commit, tag, or branch in the source repository to pull. This field is optional if the `source_type` is `git` and uses the HEAD of default branch if not specified. If the `source_type` value is `local`, this field must be omitted.", "max_length": 253, - "matches": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$" + "matches": "^[\\S]*$", + "optional": true }, { "name": "source_secret", @@ -95667,101 +100168,110 @@ "optional": true }, { - "name": "strategy_size", + "name": "source_url", "type": "TypeString", - "description": "Optional size for the build, which determines the amount of resources used. Build sizes are `small`, `medium`, `large`, `xlarge`.", - "default_value": "medium", + "description": "The URL of the code repository. This field is required if the `source_type` is `git`. If the `source_type` value is `local`, this field must be omitted. If the repository is publicly available you can provide a 'https' URL like `https://github.com/IBM/CodeEngine`. If the repository requires authentication, you need to provide a 'ssh' URL like `git@github.com:IBM/CodeEngine.git` along with a `source_secret` that points to a secret of format `ssh_auth`.", "min_length": 1, "max_length": 253, - "matches": "[\\S]*", + "matches": "^((https:\\/\\/[a-z0-9]([\\-.]?[a-z0-9])+(:\\d{1,5})?)|((ssh:\\/\\/)?git@[a-z0-9]([\\-.]{0,1}[a-z0-9])+(:[a-zA-Z0-9\\/][\\w\\-.]*)?))(\\/([\\w\\-.]|%20)+)*$", "optional": true }, { - "name": "entity_tag", + "name": "created_at", "type": "TypeString", - "description": "The version of the build instance, which is used to achieve optimistic locking.", + "description": "The timestamp when the resource was created.", "computed": true }, { - "name": "build_id", + "name": "strategy_type", "type": "TypeString", - "description": "The identifier of the resource.", - "computed": true + "description": "The strategy to use for building the image.", + "required": true, + "min_length": 1, + "max_length": 253, + "matches": "[\\S]*" }, { - "name": "etag", + "name": "source_context_dir", "type": "TypeString", - "computed": true + "description": "Option directory in the repository that contains the buildpacks file or the Dockerfile.", + "max_length": 253, + "matches": "^(.*)+$", + "optional": true }, { - "name": "name", + "name": "strategy_size", "type": "TypeString", - "description": "The name of the build. Use a name that is unique within the project.", - "immutable": true, - "required": true, + "description": "Optional size for the build, which determines the amount of resources used. Build sizes are `small`, `medium`, `large`, `xlarge`.", + "default_value": "medium", "min_length": 1, - "max_length": 63, - "matches": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?$" + "max_length": 253, + "matches": "[\\S]*", + "optional": true }, { - "name": "strategy_type", + "name": "resource_type", "type": "TypeString", - "description": "The strategy to use for building the image.", + "description": "The type of the build.", + "computed": true + }, + { + "name": "output_secret", + "type": "TypeString", + "description": "The secret that is required to access the image registry. Make sure that the secret is granted with push permissions towards the specified container registry namespace.", "required": true, "min_length": 1, "max_length": 253, - "matches": "[\\S]*" + "matches": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$" }, { - "name": "source_url", + "name": "strategy_spec_file", "type": "TypeString", - "description": "The URL of the code repository. This field is required if the `source_type` is `git`. If the `source_type` value is `local`, this field must be omitted. If the repository is publicly available you can provide a 'https' URL like `https://github.com/IBM/CodeEngine`. If the repository requires authentication, you need to provide a 'ssh' URL like `git@github.com:IBM/CodeEngine.git` along with a `source_secret` that points to a secret of format `ssh_auth`.", + "description": "Optional path to the specification file that is used for build strategies for building an image.", + "default_value": "Dockerfile", "min_length": 1, "max_length": 253, - "matches": "^((https:\\/\\/[a-z0-9]([\\-.]?[a-z0-9])+(:\\d{1,5})?)|((ssh:\\/\\/)?git@[a-z0-9]([\\-.]{0,1}[a-z0-9])+(:[a-zA-Z0-9\\/][\\w\\-.]*)?))(\\/([\\w\\-.]|%20)+)*$", + "matches": "^[\\S]*$", "optional": true }, { - "name": "timeout", - "type": "TypeInt", - "description": "The maximum amount of time, in seconds, that can pass before the build must succeed or fail.", - "default_value": 600, - "min_value": "1", - "max_value": "3600", - "optional": true + "name": "build_id", + "type": "TypeString", + "description": "The identifier of the resource.", + "computed": true }, { - "name": "href", + "name": "status", "type": "TypeString", - "description": "When you provision a new build, a URL is created identifying the location of the instance.", + "description": "The current status of the build.", "computed": true }, { - "name": "project_id", - "type": "TypeString", - "description": "The ID of the project.", - "immutable": true, - "required": true, - "min_length": 36, - "max_length": 36, - "matches": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$" + "name": "status_details", + "type": "TypeList", + "description": "The detailed status of the build.", + "computed": true, + "elem": { + "reason": { + "name": "reason", + "type": "TypeString", + "description": "Optional information to provide more context in case of a 'failed' or 'warning' status.", + "computed": true + } + } } ], "ibm_code_engine_config_map": [ { - "name": "name", + "name": "created_at", "type": "TypeString", - "description": "The name of the config map. Use a name that is unique within the project.", - "immutable": true, - "required": true, - "min_length": 1, - "max_length": 253, - "matches": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$" + "description": "The timestamp when the resource was created.", + "computed": true }, { - "name": "created_at", + "name": "entity_tag", "type": "TypeString", - "description": "The timestamp when the resource was created.", + "description": "The version of the config map instance, which is used to achieve optimistic locking.", "computed": true }, { @@ -95770,6 +100280,25 @@ "description": "When you provision a new config map, a URL is created identifying the location of the instance.", "computed": true }, + { + "name": "data", + "type": "TypeMap", + "description": "The key-value pair for the config map. Values must be specified in `KEY=VALUE` format. Each `KEY` field must consist of alphanumeric characters, `-`, `_` or `.` and must not be exceed a max length of 253 characters. Each `VALUE` field can consists of any character and must not be exceed a max length of 1048576 characters.", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "name", + "type": "TypeString", + "description": "The name of the config map. Use a name that is unique within the project.", + "immutable": true, + "required": true, + "min_length": 1, + "max_length": 253, + "matches": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$" + }, { "name": "config_map_id", "type": "TypeString", @@ -95782,6 +100311,11 @@ "description": "The type of the config map.", "computed": true }, + { + "name": "etag", + "type": "TypeString", + "computed": true + }, { "name": "project_id", "type": "TypeString", @@ -95791,92 +100325,20 @@ "min_length": 36, "max_length": 36, "matches": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$" - }, - { - "name": "data", - "type": "TypeMap", - "description": "The key-value pair for the config map. Values must be specified in `KEY=VALUE` format. Each `KEY` field must consist of alphanumeric characters, `-`, `_` or `.` and must not be exceed a max length of 253 characters. Each `VALUE` field can consists of any character and must not be exceed a max length of 1048576 characters.", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "entity_tag", - "type": "TypeString", - "description": "The version of the config map instance, which is used to achieve optimistic locking.", - "computed": true - }, - { - "name": "etag", - "type": "TypeString", - "computed": true } ], "ibm_code_engine_job": [ { - "name": "run_commands", - "type": "TypeList", - "description": "Set commands for the job that are passed to start job run containers. If not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "run_volume_mounts", - "type": "TypeList", - "description": "Optional mounts of config maps or a secrets.", - "optional": true, - "elem": { - "mount_path": { - "name": "mount_path", - "type": "TypeString", - "description": "The path that should be mounted.", - "required": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Optional name of the mount. If not set, it will be generated based on the `ref` and a random ID. In case the `ref` is longer than 58 characters, it will be cut off.", - "optional": true - }, - "reference": { - "name": "reference", - "type": "TypeString", - "description": "The name of the referenced secret or config map.", - "required": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.", - "required": true - } - } - }, - { - "name": "scale_ephemeral_storage_limit", + "name": "created_at", "type": "TypeString", - "description": "Optional amount of ephemeral storage to set for the instance of the job. The amount specified as ephemeral storage, must not exceed the amount of `scale_memory_limit`. The units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", - "default_value": "400M", - "max_length": 10, - "matches": "^([0-9.]+)([eEinumkKMGTPB]*)$", - "optional": true - }, - { - "name": "scale_max_execution_time", - "type": "TypeInt", - "description": "The maximum execution time in seconds for runs of the job. This property can only be specified if `run_mode` is `task`.", - "default_value": 7200, - "optional": true + "description": "The timestamp when the resource was created.", + "computed": true }, { - "name": "scale_retry_limit", - "type": "TypeInt", - "description": "The number of times to rerun an instance of the job before the job is marked as failed. This property can only be specified if `run_mode` is `task`.", - "default_value": 3, - "optional": true + "name": "href", + "type": "TypeString", + "description": "When you provision a new job, a URL is created identifying the location of the instance.", + "computed": true }, { "name": "project_id", @@ -95889,43 +100351,30 @@ "matches": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$" }, { - "name": "image_secret", - "type": "TypeString", - "description": "The name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image. If the image reference points to a registry that requires authentication, the job / job runs will be created but submitted job runs will fail, until this property is provided, too. This property must not be set on a job run, which references a job template.", - "min_length": 1, - "max_length": 253, - "matches": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", - "optional": true + "name": "run_arguments", + "type": "TypeList", + "description": "Set arguments for the job that are passed to start job run containers. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.", + "optional": true, + "elem": { + "type": "TypeString" + } }, { - "name": "run_as_user", + "name": "scale_retry_limit", "type": "TypeInt", - "description": "The user ID (UID) to run the application (e.g., 1001).", - "default_value": 0, + "description": "The number of times to rerun an instance of the job before the job is marked as failed. This property can only be specified if `run_mode` is `task`.", + "default_value": 3, "optional": true }, { - "name": "resource_type", - "type": "TypeString", - "description": "The type of the job.", - "computed": true - }, - { - "name": "created_at", - "type": "TypeString", - "description": "The timestamp when the resource was created.", - "computed": true - }, - { - "name": "href", + "name": "entity_tag", "type": "TypeString", - "description": "When you provision a new job, a URL is created identifying the location of the instance.", + "description": "The version of the job instance, which is used to achieve optimistic locking.", "computed": true }, { - "name": "job_id", + "name": "etag", "type": "TypeString", - "description": "The identifier of the resource.", "computed": true }, { @@ -95937,15 +100386,6 @@ "matches": "^(manager|reader|writer|none|default)$", "optional": true }, - { - "name": "scale_cpu_limit", - "type": "TypeString", - "description": "Optional amount of CPU set for the instance of the job. For valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).", - "default_value": "1", - "max_length": 10, - "matches": "^([0-9.]+)([eEinumkKMGTPB]*)$", - "optional": true - }, { "name": "scale_array_spec", "type": "TypeString", @@ -95957,19 +100397,13 @@ "optional": true }, { - "name": "entity_tag", - "type": "TypeString", - "description": "The version of the job instance, which is used to achieve optimistic locking.", - "computed": true - }, - { - "name": "image_reference", - "type": "TypeString", - "description": "The name of the image that is used for this job. The format is `REGISTRY/NAMESPACE/REPOSITORY:TAG` where `REGISTRY` and `TAG` are optional. If `REGISTRY` is not specified, the default is `docker.io`. If `TAG` is not specified, the default is `latest`. If the image reference points to a registry that requires authentication, make sure to also specify the property `image_secret`.", - "required": true, - "min_length": 1, - "max_length": 256, - "matches": "^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\\/])?[a-z0-9][a-z0-9\\-_.\\/]+[a-z0-9](:[\\w][\\w.\\-]{0,127})?(@sha256:[a-fA-F0-9]{64})?$" + "name": "run_commands", + "type": "TypeList", + "description": "Set commands for the job that are passed to start job run containers. If not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.", + "optional": true, + "elem": { + "type": "TypeString" + } }, { "name": "run_env_variables", @@ -96016,6 +100450,95 @@ } } }, + { + "name": "run_volume_mounts", + "type": "TypeList", + "description": "Optional mounts of config maps or a secrets.", + "optional": true, + "elem": { + "mount_path": { + "name": "mount_path", + "type": "TypeString", + "description": "The path that should be mounted.", + "required": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Optional name of the mount. If not set, it will be generated based on the `ref` and a random ID. In case the `ref` is longer than 58 characters, it will be cut off.", + "optional": true + }, + "reference": { + "name": "reference", + "type": "TypeString", + "description": "The name of the referenced secret or config map.", + "required": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.", + "required": true + } + } + }, + { + "name": "scale_cpu_limit", + "type": "TypeString", + "description": "Optional amount of CPU set for the instance of the job. For valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).", + "default_value": "1", + "max_length": 10, + "matches": "^([0-9.]+)([eEinumkKMGTPB]*)$", + "optional": true + }, + { + "name": "scale_ephemeral_storage_limit", + "type": "TypeString", + "description": "Optional amount of ephemeral storage to set for the instance of the job. The amount specified as ephemeral storage, must not exceed the amount of `scale_memory_limit`. The units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", + "default_value": "400M", + "max_length": 10, + "matches": "^([0-9.]+)([eEinumkKMGTPB]*)$", + "optional": true + }, + { + "name": "scale_memory_limit", + "type": "TypeString", + "description": "Optional amount of memory set for the instance of the job. For valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo). The units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", + "default_value": "4G", + "max_length": 10, + "matches": "^([0-9.]+)([eEinumkKMGTPB]*)$", + "optional": true + }, + { + "name": "image_reference", + "type": "TypeString", + "description": "The name of the image that is used for this job. The format is `REGISTRY/NAMESPACE/REPOSITORY:TAG` where `REGISTRY` and `TAG` are optional. If `REGISTRY` is not specified, the default is `docker.io`. If `TAG` is not specified, the default is `latest`. If the image reference points to a registry that requires authentication, make sure to also specify the property `image_secret`.", + "required": true, + "min_length": 1, + "max_length": 256, + "matches": "^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\\/])?[a-z0-9][a-z0-9\\-_.\\/]+[a-z0-9](:[\\w][\\w.\\-]{0,127})?(@sha256:[a-fA-F0-9]{64})?$" + }, + { + "name": "image_secret", + "type": "TypeString", + "description": "The name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image. If the image reference points to a registry that requires authentication, the job / job runs will be created but submitted job runs will fail, until this property is provided, too. This property must not be set on a job run, which references a job template.", + "min_length": 1, + "max_length": 253, + "matches": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", + "optional": true + }, + { + "name": "job_id", + "type": "TypeString", + "description": "The identifier of the resource.", + "computed": true + }, + { + "name": "resource_type", + "type": "TypeString", + "description": "The type of the job.", + "computed": true + }, { "name": "run_mode", "type": "TypeString", @@ -96026,9 +100549,11 @@ "optional": true }, { - "name": "etag", - "type": "TypeString", - "computed": true + "name": "scale_max_execution_time", + "type": "TypeInt", + "description": "The maximum execution time in seconds for runs of the job. This property can only be specified if `run_mode` is `task`.", + "default_value": 7200, + "optional": true }, { "name": "name", @@ -96041,59 +100566,49 @@ "matches": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?$" }, { - "name": "run_arguments", - "type": "TypeList", - "description": "Set arguments for the job that are passed to start job run containers. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "scale_memory_limit", - "type": "TypeString", - "description": "Optional amount of memory set for the instance of the job. For valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo). The units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", - "default_value": "4G", - "max_length": 10, - "matches": "^([0-9.]+)([eEinumkKMGTPB]*)$", + "name": "run_as_user", + "type": "TypeInt", + "description": "The user ID (UID) to run the application (e.g., 1001).", + "default_value": 0, "optional": true } ], "ibm_code_engine_project": [ { - "name": "resource_group_id", + "name": "href", "type": "TypeString", - "description": "Optional ID of the resource group for your project deployment. If this field is not defined, the default resource group of the account will be used.", - "immutable": true, - "min_length": 32, - "max_length": 32, - "matches": "^[a-z0-9]*$", - "optional": true + "description": "When you provision a new resource, a URL is created identifying the location of the instance.", + "computed": true }, { - "name": "account_id", + "name": "region", "type": "TypeString", - "description": "An alphanumeric value identifying the account ID.", + "description": "The region for your project deployment. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.", + "cloud_data_type": "region", "computed": true }, { - "name": "crn", + "name": "resource_type", "type": "TypeString", - "description": "The CRN of the project.", - "cloud_data_type": "crn", + "description": "The type of the project.", "computed": true }, { - "name": "href", + "name": "project_id", "type": "TypeString", - "description": "When you provision a new resource, a URL is created identifying the location of the instance.", + "description": "The ID of the project.", "computed": true }, { - "name": "region", + "name": "account_id", "type": "TypeString", - "description": "The region for your project deployment. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.", - "cloud_data_type": "region", + "description": "An alphanumeric value identifying the account ID.", + "computed": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "The timestamp when the project was created.", "computed": true }, { @@ -96113,25 +100628,30 @@ "matches": "^([^\\x00-\\x7F]|[a-zA-Z0-9\\-._: ])+$" }, { - "name": "project_id", - "type": "TypeString", - "description": "The ID of the project.", - "computed": true - }, - { - "name": "created_at", + "name": "resource_group_id", "type": "TypeString", - "description": "The timestamp when the project was created.", - "computed": true + "description": "Optional ID of the resource group for your project deployment. If this field is not defined, the default resource group of the account will be used.", + "immutable": true, + "min_length": 32, + "max_length": 32, + "matches": "^[a-z0-9]*$", + "optional": true }, { - "name": "resource_type", + "name": "crn", "type": "TypeString", - "description": "The type of the project.", + "description": "The CRN of the project.", + "cloud_data_type": "crn", "computed": true } ], "ibm_code_engine_secret": [ + { + "name": "created_at", + "type": "TypeString", + "description": "The timestamp when the resource was created.", + "computed": true + }, { "name": "href", "type": "TypeString", @@ -96139,9 +100659,8 @@ "computed": true }, { - "name": "secret_id", + "name": "etag", "type": "TypeString", - "description": "The identifier of the resource.", "computed": true }, { @@ -96154,16 +100673,6 @@ "max_length": 36, "matches": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$" }, - { - "name": "name", - "type": "TypeString", - "description": "The name of the secret.", - "immutable": true, - "required": true, - "min_length": 1, - "max_length": 253, - "matches": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$" - }, { "name": "data", "type": "TypeMap", @@ -96250,20 +100759,21 @@ "max_items": 1 }, { - "name": "created_at", + "name": "id", "type": "TypeString", - "description": "The timestamp when the resource was created.", + "description": "The identifier of the resource.", "computed": true }, { - "name": "entity_tag", + "name": "resource_type", "type": "TypeString", - "description": "The version of the secret instance, which is used to achieve optimistic locking.", + "description": "The type of the secret.", "computed": true }, { - "name": "etag", + "name": "secret_id", "type": "TypeString", + "description": "The identifier of the resource.", "computed": true }, { @@ -96276,19 +100786,69 @@ "matches": "^(generic|ssh_auth|basic_auth|tls|service_access|registry)$" }, { - "name": "id", + "name": "name", "type": "TypeString", - "description": "The identifier of the resource.", - "computed": true + "description": "The name of the secret.", + "immutable": true, + "required": true, + "min_length": 1, + "max_length": 253, + "matches": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$" }, { - "name": "resource_type", + "name": "entity_tag", "type": "TypeString", - "description": "The type of the secret.", + "description": "The version of the secret instance, which is used to achieve optimistic locking.", "computed": true } ], "ibm_compute_autoscale_group": [ + { + "name": "virtual_server_id", + "type": "TypeInt", + "description": "virtual server ID", + "optional": true + }, + { + "name": "port", + "type": "TypeInt", + "description": "Port number", + "optional": true + }, + { + "name": "network_vlan_ids", + "type": "TypeSet", + "description": "List of network VLAN ids", + "optional": true, + "elem": { + "type": "TypeInt" + } + }, + { + "name": "name", + "type": "TypeString", + "description": "Name", + "required": true + }, + { + "name": "regional_group", + "type": "TypeString", + "description": "regional group", + "immutable": true, + "required": true + }, + { + "name": "maximum_member_count", + "type": "TypeInt", + "description": "Maximum member count", + "required": true + }, + { + "name": "cooldown", + "type": "TypeInt", + "description": "Cooldown value", + "required": true + }, { "name": "termination_policy", "type": "TypeString", @@ -96296,9 +100856,14 @@ "required": true }, { - "name": "virtual_server_id", + "name": "minimum_member_count", "type": "TypeInt", - "description": "virtual server ID", + "description": "Minimum member count", + "required": true + }, + { + "name": "health_check", + "type": "TypeMap", "optional": true }, { @@ -96668,43 +101233,17 @@ } }, { - "name": "name", - "type": "TypeString", - "description": "Name", - "required": true - }, - { - "name": "maximum_member_count", - "type": "TypeInt", - "description": "Maximum member count", - "required": true - }, - { - "name": "cooldown", - "type": "TypeInt", - "description": "Cooldown value", - "required": true - }, - { - "name": "port", - "type": "TypeInt", - "description": "Port number", - "optional": true - }, - { - "name": "health_check", - "type": "TypeMap", - "optional": true - }, - { - "name": "network_vlan_ids", + "name": "tags", "type": "TypeSet", - "description": "List of network VLAN ids", + "description": "List of tags", + "cloud_data_type": "tags", "optional": true, "elem": { - "type": "TypeInt" + "type": "TypeString" } - }, + } + ], + "ibm_compute_autoscale_policy": [ { "name": "tags", "type": "TypeSet", @@ -96715,21 +101254,6 @@ "type": "TypeString" } }, - { - "name": "regional_group", - "type": "TypeString", - "description": "regional group", - "immutable": true, - "required": true - }, - { - "name": "minimum_member_count", - "type": "TypeInt", - "description": "Minimum member count", - "required": true - } - ], - "ibm_compute_autoscale_policy": [ { "name": "name", "type": "TypeString", @@ -96819,91 +101343,123 @@ } } } - }, - { - "name": "tags", - "type": "TypeSet", - "description": "List of tags", - "cloud_data_type": "tags", - "optional": true, - "elem": { - "type": "TypeString" - } } ], "ibm_compute_bare_metal": [ { - "name": "post_install_script_uri", - "type": "TypeString", + "name": "network_speed", + "type": "TypeInt", + "description": "Network speed in MBPS", + "default_value": 100, "immutable": true, "optional": true }, { - "name": "process_key_name", - "type": "TypeString", + "name": "hourly_billing", + "type": "TypeBool", + "description": "Enables hourly billing", + "default_value": true, "immutable": true, "optional": true }, { - "name": "disk_key_names", + "name": "tcp_monitoring", + "type": "TypeBool", + "description": "TCP monitoring enabled if set as true", + "default_value": false, + "immutable": true, + "optional": true + }, + { + "name": "memory", + "type": "TypeInt", + "immutable": true, + "optional": true, + "computed": true + }, + { + "name": "storage_groups", "type": "TypeList", "immutable": true, "optional": true, "elem": { - "type": "TypeString" + "array_size": { + "name": "array_size", + "type": "TypeInt", + "description": "Array size of harddrives list", + "optional": true + }, + "array_type_id": { + "name": "array_type_id", + "type": "TypeInt", + "description": "Array type ID", + "required": true + }, + "hard_drives": { + "name": "hard_drives", + "type": "TypeList", + "description": "Hard-drives List", + "required": true, + "elem": { + "type": "TypeInt" + } + }, + "partition_template_id": { + "name": "partition_template_id", + "type": "TypeInt", + "description": "Partition template ID", + "optional": true + } } }, { - "name": "redundant_network", - "type": "TypeBool", - "default_value": false, + "name": "quote_id", + "type": "TypeInt", + "description": "Quote ID for Quote based provisioning", "immutable": true, "optional": true }, { - "name": "unbonded_network", - "type": "TypeBool", - "default_value": false, - "immutable": true, - "optional": true + "name": "global_identifier", + "type": "TypeString", + "description": "The unique global identifier of the bare metal server", + "computed": true }, { - "name": "secondary_ip_count", - "type": "TypeInt", - "description": "Secondary IP addresses count", + "name": "post_install_script_uri", + "type": "TypeString", "immutable": true, "optional": true }, { - "name": "block_storage_ids", - "type": "TypeSet", + "name": "redundant_power_supply", + "type": "TypeBool", + "immutable": true, "optional": true, - "computed": true, - "elem": { - "type": "TypeInt" - } + "computed": true }, { - "name": "network_speed", - "type": "TypeInt", - "description": "Network speed in MBPS", - "default_value": 100, + "name": "package_key_name", + "type": "TypeString", "immutable": true, "optional": true }, { - "name": "hourly_billing", - "type": "TypeBool", - "description": "Enables hourly billing", - "default_value": true, + "name": "process_key_name", + "type": "TypeString", "immutable": true, "optional": true }, { - "name": "redundant_power_supply", + "name": "unbonded_network", "type": "TypeBool", + "default_value": false, "immutable": true, - "optional": true, + "optional": true + }, + { + "name": "private_ipv4_address", + "type": "TypeString", "computed": true }, { @@ -96914,16 +101470,6 @@ "type": "TypeString" } }, - { - "name": "ssh_key_ids", - "type": "TypeList", - "description": "SSH KEY IDS list", - "immutable": true, - "optional": true, - "elem": { - "type": "TypeInt" - } - }, { "name": "tags", "type": "TypeSet", @@ -96934,62 +101480,30 @@ } }, { - "name": "package_key_name", + "name": "fixed_config_preset", "type": "TypeString", + "description": "Fixed config preset value", "immutable": true, "optional": true }, { - "name": "os_key_name", + "name": "gpu_secondary_key_name", "type": "TypeString", "immutable": true, "optional": true }, { - "name": "extended_hardware_testing", + "name": "redundant_network", "type": "TypeBool", - "default_value": false, - "immutable": true, - "optional": true - }, - { - "name": "storage_groups", - "type": "TypeList", - "immutable": true, - "optional": true, - "elem": { - "array_size": { - "name": "array_size", - "type": "TypeInt", - "description": "Array size of harddrives list", - "optional": true - }, - "array_type_id": { - "name": "array_type_id", - "type": "TypeInt", - "description": "Array type ID", - "required": true - }, - "hard_drives": { - "name": "hard_drives", - "type": "TypeList", - "description": "Hard-drives List", - "required": true, - "elem": { - "type": "TypeInt" - } - }, - "partition_template_id": { - "name": "partition_template_id", - "type": "TypeInt", - "description": "Partition template ID", - "optional": true - } - } + "default_value": false, + "immutable": true, + "optional": true }, { - "name": "public_ipv4_address_id", + "name": "public_bandwidth", "type": "TypeInt", + "immutable": true, + "optional": true, "computed": true }, { @@ -97008,36 +101522,62 @@ "computed": true }, { - "name": "public_bandwidth", - "type": "TypeInt", + "name": "software_guard_extensions", + "type": "TypeBool", + "default_value": false, "immutable": true, - "optional": true, - "computed": true + "optional": true }, { - "name": "private_vlan_id", - "type": "TypeInt", + "name": "os_key_name", + "type": "TypeString", + "immutable": true, + "optional": true + }, + { + "name": "extended_hardware_testing", + "type": "TypeBool", + "default_value": false, + "immutable": true, + "optional": true + }, + { + "name": "domain", + "type": "TypeString", + "description": "Domain name", + "immutable": true, + "required": true + }, + { + "name": "ssh_key_ids", + "type": "TypeList", + "description": "SSH KEY IDS list", "immutable": true, "optional": true, - "computed": true + "elem": { + "type": "TypeInt" + } }, { - "name": "ipv6_address_id", - "type": "TypeInt", + "name": "os_reference_code", + "type": "TypeString", + "description": "OS refernece code value", + "immutable": true, + "optional": true, "computed": true }, { - "name": "file_storage_ids", - "type": "TypeSet", + "name": "disk_key_names", + "type": "TypeList", + "immutable": true, "optional": true, - "computed": true, "elem": { - "type": "TypeInt" + "type": "TypeString" } }, { - "name": "memory", - "type": "TypeInt", + "name": "private_subnet", + "type": "TypeString", "immutable": true, "optional": true, "computed": true @@ -97048,39 +101588,30 @@ "computed": true }, { - "name": "domain", + "name": "ipv6_address", "type": "TypeString", - "description": "Domain name", - "immutable": true, - "required": true + "computed": true }, { - "name": "notes", - "type": "TypeString", - "description": "Optional notes info", - "optional": true + "name": "ipv6_address_id", + "type": "TypeInt", + "computed": true }, { - "name": "tcp_monitoring", - "type": "TypeBool", - "description": "TCP monitoring enabled if set as true", - "default_value": false, + "name": "hostname", + "type": "TypeString", + "description": "Host name", "immutable": true, "optional": true }, { - "name": "software_guard_extensions", + "name": "private_network_only", "type": "TypeBool", + "description": "only private network configured if is true", "default_value": false, "immutable": true, "optional": true }, - { - "name": "gpu_secondary_key_name", - "type": "TypeString", - "immutable": true, - "optional": true - }, { "name": "restricted_network", "type": "TypeBool", @@ -97096,113 +101627,90 @@ "computed": true }, { - "name": "public_subnet", + "name": "user_metadata", "type": "TypeString", + "description": "User metadata info", "immutable": true, - "optional": true, - "computed": true + "optional": true }, { - "name": "private_ipv4_address_id", - "type": "TypeInt", - "computed": true + "name": "notes", + "type": "TypeString", + "description": "Optional notes info", + "optional": true }, { - "name": "ipv6_address", - "type": "TypeString", - "computed": true + "name": "file_storage_ids", + "type": "TypeSet", + "optional": true, + "computed": true, + "elem": { + "type": "TypeInt" + } }, { - "name": "ipv6_static_enabled", - "type": "TypeBool", - "description": "boolean value true if ipv6 static is enabled else false", - "default_value": false, - "immutable": true, - "optional": true + "name": "block_storage_ids", + "type": "TypeSet", + "optional": true, + "computed": true, + "elem": { + "type": "TypeInt" + } }, { - "name": "fixed_config_preset", + "name": "gpu_key_name", "type": "TypeString", - "description": "Fixed config preset value", "immutable": true, "optional": true }, { - "name": "image_template_id", + "name": "private_vlan_id", "type": "TypeInt", - "description": "OS image template ID", "immutable": true, - "optional": true + "optional": true, + "computed": true }, { - "name": "private_network_only", - "type": "TypeBool", - "description": "only private network configured if is true", - "default_value": false, + "name": "secondary_ip_count", + "type": "TypeInt", + "description": "Secondary IP addresses count", "immutable": true, "optional": true }, { - "name": "quote_id", + "name": "image_template_id", "type": "TypeInt", - "description": "Quote ID for Quote based provisioning", + "description": "OS image template ID", "immutable": true, "optional": true }, { - "name": "private_subnet", + "name": "public_subnet", "type": "TypeString", "immutable": true, "optional": true, "computed": true }, { - "name": "global_identifier", - "type": "TypeString", - "description": "The unique global identifier of the bare metal server", + "name": "public_ipv4_address_id", + "type": "TypeInt", "computed": true }, { - "name": "hostname", - "type": "TypeString", - "description": "Host name", - "immutable": true, - "optional": true - }, - { - "name": "user_metadata", - "type": "TypeString", - "description": "User metadata info", - "immutable": true, - "optional": true - }, - { - "name": "os_reference_code", - "type": "TypeString", - "description": "OS refernece code value", - "immutable": true, - "optional": true, + "name": "private_ipv4_address_id", + "type": "TypeInt", "computed": true }, { - "name": "gpu_key_name", - "type": "TypeString", + "name": "ipv6_static_enabled", + "type": "TypeBool", + "description": "boolean value true if ipv6 static is enabled else false", + "default_value": false, "immutable": true, "optional": true - }, - { - "name": "private_ipv4_address", - "type": "TypeString", - "computed": true } ], "ibm_compute_dedicated_host": [ - { - "name": "hostname", - "type": "TypeString", - "description": "The host name of dedicatated host.", - "required": true - }, { "name": "flavor", "type": "TypeString", @@ -97212,15 +101720,16 @@ "optional": true }, { - "name": "cpu_count", - "type": "TypeInt", - "description": "The capacity that the dedicated host's CPU allocation is restricted to.", - "computed": true + "name": "router_hostname", + "type": "TypeString", + "description": "The hostname of the primary router that the dedicated host is associated with.", + "immutable": true, + "required": true }, { - "name": "disk_capacity", + "name": "cpu_count", "type": "TypeInt", - "description": "The capacity that the dedicated host's disk allocation is restricted to.", + "description": "The capacity that the dedicated host's CPU allocation is restricted to.", "computed": true }, { @@ -97232,6 +101741,30 @@ "type": "TypeString" } }, + { + "name": "disk_capacity", + "type": "TypeInt", + "description": "The capacity that the dedicated host's disk allocation is restricted to.", + "computed": true + }, + { + "name": "memory_capacity", + "type": "TypeInt", + "description": "The capacity that the dedicated host's memory allocation is restricted to.", + "computed": true + }, + { + "name": "wait_time_minutes", + "type": "TypeInt", + "default_value": 90, + "optional": true + }, + { + "name": "hostname", + "type": "TypeString", + "description": "The host name of dedicatated host.", + "required": true + }, { "name": "domain", "type": "TypeString", @@ -97253,28 +101786,31 @@ "default_value": true, "immutable": true, "optional": true - }, + } + ], + "ibm_compute_monitor": [ { - "name": "router_hostname", - "type": "TypeString", - "description": "The hostname of the primary router that the dedicated host is associated with.", - "immutable": true, + "name": "response_action_id", + "type": "TypeInt", + "description": "Response action ID", "required": true }, { - "name": "memory_capacity", + "name": "wait_cycles", "type": "TypeInt", - "description": "The capacity that the dedicated host's memory allocation is restricted to.", - "computed": true + "description": "wait cycles count", + "optional": true }, { - "name": "wait_time_minutes", - "type": "TypeInt", - "default_value": 90, - "optional": true - } - ], - "ibm_compute_monitor": [ + "name": "notified_users", + "type": "TypeSet", + "description": "List of users notified", + "optional": true, + "computed": true, + "elem": { + "type": "TypeInt" + } + }, { "name": "tags", "type": "TypeSet", @@ -97303,31 +101839,23 @@ "type": "TypeInt", "description": "Query Type ID", "required": true - }, + } + ], + "ibm_compute_placement_group": [ { - "name": "response_action_id", - "type": "TypeInt", - "description": "Response action ID", + "name": "datacenter", + "type": "TypeString", + "description": "Dataceneter name", + "immutable": true, "required": true }, { - "name": "wait_cycles", - "type": "TypeInt", - "description": "wait cycles count", - "optional": true + "name": "pod", + "type": "TypeString", + "description": "Pod name", + "immutable": true, + "required": true }, - { - "name": "notified_users", - "type": "TypeSet", - "description": "List of users notified", - "optional": true, - "computed": true, - "elem": { - "type": "TypeInt" - } - } - ], - "ibm_compute_placement_group": [ { "name": "name", "type": "TypeString", @@ -97351,23 +101879,19 @@ "elem": { "type": "TypeString" } - }, - { - "name": "datacenter", - "type": "TypeString", - "description": "Dataceneter name", - "immutable": true, - "required": true - }, - { - "name": "pod", - "type": "TypeString", - "description": "Pod name", - "immutable": true, - "required": true } ], "ibm_compute_provisioning_hook": [ + { + "name": "tags", + "type": "TypeSet", + "description": "Tags associated with resource", + "cloud_data_type": "tags", + "optional": true, + "elem": { + "type": "TypeString" + } + }, { "name": "name", "type": "TypeString", @@ -97379,26 +101903,9 @@ "type": "TypeString", "description": "URI of the hook", "required": true - }, - { - "name": "tags", - "type": "TypeSet", - "description": "Tags associated with resource", - "cloud_data_type": "tags", - "optional": true, - "elem": { - "type": "TypeString" - } } ], "ibm_compute_reserved_capacity": [ - { - "name": "datacenter", - "type": "TypeString", - "description": "Dataceneter name", - "immutable": true, - "required": true - }, { "name": "pod", "type": "TypeString", @@ -97439,25 +101946,16 @@ "type": "TypeBool", "description": "Force the creation of reserved capacity with same name", "optional": true + }, + { + "name": "datacenter", + "type": "TypeString", + "description": "Dataceneter name", + "immutable": true, + "required": true } ], "ibm_compute_ssh_key": [ - { - "name": "notes", - "type": "TypeString", - "description": "Additional notes", - "optional": true - }, - { - "name": "tags", - "type": "TypeSet", - "description": "List of tags for the resource", - "cloud_data_type": "tags", - "optional": true, - "elem": { - "type": "TypeString" - } - }, { "name": "label", "type": "TypeString", @@ -97476,16 +101974,25 @@ "type": "TypeString", "description": "SSH key fingerprint", "computed": true - } - ], - "ibm_compute_ssl_certificate": [ + }, { - "name": "certificate", + "name": "notes", "type": "TypeString", - "description": "SSL Certifcate", - "immutable": true, - "required": true + "description": "Additional notes", + "optional": true }, + { + "name": "tags", + "type": "TypeSet", + "description": "List of tags for the resource", + "cloud_data_type": "tags", + "optional": true, + "elem": { + "type": "TypeString" + } + } + ], + "ibm_compute_ssl_certificate": [ { "name": "common_name", "type": "TypeString", @@ -97498,12 +102005,6 @@ "description": "Organization name", "computed": true }, - { - "name": "validity_begin", - "type": "TypeString", - "description": "Validity begins from", - "computed": true - }, { "name": "validity_days", "type": "TypeInt", @@ -97511,9 +102012,9 @@ "computed": true }, { - "name": "modify_date", + "name": "validity_end", "type": "TypeString", - "description": "certificate modificatiob date", + "description": "Validity ends before", "computed": true }, { @@ -97526,6 +102027,13 @@ "type": "TypeString" } }, + { + "name": "certificate", + "type": "TypeString", + "description": "SSL Certifcate", + "immutable": true, + "required": true + }, { "name": "intermediate_certificate", "type": "TypeString", @@ -97542,9 +102050,9 @@ "required": true }, { - "name": "validity_end", + "name": "validity_begin", "type": "TypeString", - "description": "Validity ends before", + "description": "Validity begins from", "computed": true }, { @@ -97558,31 +102066,32 @@ "type": "TypeString", "description": "certificate creation date", "computed": true + }, + { + "name": "modify_date", + "type": "TypeString", + "description": "certificate modificatiob date", + "computed": true } ], "ibm_compute_user": [ { - "name": "permissions", - "type": "TypeSet", - "description": "set of persmissions assigned for the user", - "optional": true, - "elem": { - "type": "TypeString" - } + "name": "last_name", + "type": "TypeString", + "description": "Last name of the user", + "required": true }, { - "name": "api_key", + "name": "email", "type": "TypeString", - "description": "API key for the user", - "secure": true, - "optional": true, - "computed": true + "description": "email address of the user", + "required": true }, { - "name": "address1", + "name": "address2", "type": "TypeString", "description": "Address info of the user", - "required": true + "optional": true }, { "name": "country", @@ -97590,6 +102099,12 @@ "description": "Country name", "required": true }, + { + "name": "timezone", + "type": "TypeString", + "description": "time zone info", + "required": true + }, { "name": "user_status", "type": "TypeString", @@ -97598,24 +102113,27 @@ "optional": true }, { - "name": "password", + "name": "company_name", "type": "TypeString", - "description": "password for the user", - "secure": true, - "optional": true + "description": "comapany name", + "required": true }, { - "name": "timezone", - "type": "TypeString", - "description": "time zone info", - "required": true + "name": "permissions", + "type": "TypeSet", + "description": "set of persmissions assigned for the user", + "optional": true, + "elem": { + "type": "TypeString" + } }, { - "name": "has_api_key", - "type": "TypeBool", - "description": "API Key info of the user", - "default_value": false, - "optional": true + "name": "api_key", + "type": "TypeString", + "description": "API key for the user", + "secure": true, + "optional": true, + "computed": true }, { "name": "tags", @@ -97628,93 +102146,111 @@ } }, { - "name": "first_name", + "name": "username", "type": "TypeString", - "description": "First name of the user", - "required": true + "description": "user name", + "optional": true, + "computed": true }, { - "name": "company_name", + "name": "state", "type": "TypeString", - "description": "comapany name", + "description": "Satate name", "required": true }, { - "name": "address2", + "name": "password", "type": "TypeString", - "description": "Address info of the user", + "description": "password for the user", + "secure": true, "optional": true }, { - "name": "city", + "name": "has_api_key", + "type": "TypeBool", + "description": "API Key info of the user", + "default_value": false, + "optional": true + }, + { + "name": "ibm_id", "type": "TypeString", - "description": "City name", - "required": true + "description": "IBM ID of the user", + "computed": true }, { - "name": "last_name", + "name": "first_name", "type": "TypeString", - "description": "Last name of the user", + "description": "First name of the user", "required": true }, { - "name": "email", + "name": "address1", "type": "TypeString", - "description": "email address of the user", + "description": "Address info of the user", "required": true }, { - "name": "ibm_id", + "name": "city", "type": "TypeString", - "description": "IBM ID of the user", + "description": "City name", + "required": true + } + ], + "ibm_compute_vm_instance": [ + { + "name": "private_subnet", + "type": "TypeString", + "immutable": true, + "optional": true, "computed": true }, { - "name": "username", + "name": "resource_name", "type": "TypeString", - "description": "user name", - "optional": true, + "description": "The name of the resource", "computed": true }, { - "name": "state", + "name": "domain", "type": "TypeString", - "description": "Satate name", - "required": true - } - ], - "ibm_compute_vm_instance": [ + "optional": true + }, { - "name": "user_metadata", + "name": "dedicated_host_name", "type": "TypeString", "immutable": true, "optional": true }, { - "name": "tags", - "type": "TypeSet", - "cloud_data_type": "tags", + "name": "public_subnet", + "type": "TypeString", + "immutable": true, "optional": true, - "elem": { - "type": "TypeString" - } + "computed": true }, { - "name": "dedicated_acct_host_only", - "type": "TypeBool", + "name": "reserved_instance_primary_disk", + "type": "TypeInt", + "description": "The primary disk of reserved instance", "immutable": true, "optional": true }, { - "name": "private_vlan_id", + "name": "public_vlan_id", "type": "TypeInt", "immutable": true, "optional": true, "computed": true }, { - "name": "disks", - "type": "TypeList", + "name": "private_interface_id", + "type": "TypeInt", + "computed": true + }, + { + "name": "block_storage_ids", + "type": "TypeSet", "optional": true, "computed": true, "elem": { @@ -97722,33 +102258,52 @@ } }, { - "name": "ip_address_id", - "type": "TypeInt", - "computed": true - }, - { - "name": "secondary_ip_count", - "type": "TypeInt", + "name": "local_disk", + "type": "TypeBool", + "default_value": true, "immutable": true, "optional": true }, { - "name": "hourly_billing", - "type": "TypeBool", - "default_value": true, + "name": "bulk_vms", + "type": "TypeSet", "immutable": true, - "optional": true + "optional": true, + "elem": { + "domain": { + "name": "domain", + "type": "TypeString", + "immutable": true, + "required": true + }, + "hostname": { + "name": "hostname", + "type": "TypeString", + "immutable": true, + "required": true + } + }, + "min_items": 2 }, { - "name": "reserved_capacity_name", - "type": "TypeString", - "description": "The reserved group id", + "name": "datacenter_choice", + "type": "TypeList", + "description": "The user provided datacenter options", + "optional": true, + "elem": { + "type": "TypeMap" + } + }, + { + "name": "placement_group_id", + "type": "TypeInt", + "description": "The placement group id", "immutable": true, "optional": true }, { - "name": "dedicated_host_id", - "type": "TypeInt", + "name": "dedicated_acct_host_only", + "type": "TypeBool", "immutable": true, "optional": true }, @@ -97758,18 +102313,26 @@ "optional": true }, { - "name": "dedicated_host_name", - "type": "TypeString", + "name": "public_bandwidth_unlimited", + "type": "TypeBool", + "default_value": false, "immutable": true, "optional": true }, { - "name": "quote_id", - "type": "TypeInt", - "description": "Quote ID for Quote based provisioning", + "name": "transient", + "type": "TypeBool", "immutable": true, "optional": true }, + { + "name": "ssh_key_ids", + "type": "TypeSet", + "optional": true, + "elem": { + "type": "TypeInt" + } + }, { "name": "private_security_group_ids", "type": "TypeSet", @@ -97782,37 +102345,37 @@ "max_items": 5 }, { - "name": "ipv4_address_private", - "type": "TypeString", + "name": "ip_address_id", + "type": "TypeInt", "computed": true }, { - "name": "ipv6_address_id", + "name": "public_ipv6_subnet_id", "type": "TypeInt", "computed": true }, { - "name": "resource_status", - "type": "TypeString", - "description": "The status of the resource", - "computed": true + "name": "file_storage_ids", + "type": "TypeSet", + "optional": true, + "computed": true, + "elem": { + "type": "TypeInt" + } }, { - "name": "wait_time_minutes", - "type": "TypeInt", - "default_value": 90, + "name": "tags", + "type": "TypeSet", + "cloud_data_type": "tags", "optional": true, - "deprecated": "This field is deprecated. Use timeouts block instead" + "elem": { + "type": "TypeString" + } }, { - "name": "hostname", + "name": "placement_group_name", "type": "TypeString", - "optional": true - }, - { - "name": "reserved_instance_primary_disk", - "type": "TypeInt", - "description": "The primary disk of reserved instance", + "description": "The placement group name", "immutable": true, "optional": true }, @@ -97824,70 +102387,45 @@ "computed": true }, { - "name": "private_interface_id", + "name": "private_subnet_id", "type": "TypeInt", "computed": true }, { - "name": "local_disk", - "type": "TypeBool", - "default_value": true, + "name": "quote_id", + "type": "TypeInt", + "description": "Quote ID for Quote based provisioning", "immutable": true, "optional": true }, { - "name": "memory", - "type": "TypeInt", - "optional": true, - "computed": true - }, - { - "name": "block_storage_ids", - "type": "TypeSet", - "optional": true, - "computed": true, - "elem": { - "type": "TypeInt" - } + "name": "hostname", + "type": "TypeString", + "optional": true }, { - "name": "public_bandwidth_limited", + "name": "network_speed", "type": "TypeInt", - "immutable": true, - "optional": true, - "computed": true + "default_value": 100, + "optional": true }, { - "name": "private_subnet_id", - "type": "TypeInt", + "name": "ipv4_address", + "type": "TypeString", "computed": true }, { - "name": "evault", + "name": "wait_time_minutes", "type": "TypeInt", - "immutable": true, - "optional": true + "default_value": 90, + "optional": true, + "deprecated": "This field is deprecated. Use timeouts block instead" }, { - "name": "bulk_vms", - "type": "TypeSet", + "name": "os_reference_code", + "type": "TypeString", "immutable": true, - "optional": true, - "elem": { - "domain": { - "name": "domain", - "type": "TypeString", - "immutable": true, - "required": true - }, - "hostname": { - "name": "hostname", - "type": "TypeString", - "immutable": true, - "required": true - } - }, - "min_items": 2 + "optional": true }, { "name": "private_network_only", @@ -97897,51 +102435,68 @@ "optional": true }, { - "name": "datacenter_choice", + "name": "secondary_ip_addresses", "type": "TypeList", - "description": "The user provided datacenter options", - "optional": true, + "computed": true, "elem": { - "type": "TypeMap" + "type": "TypeString" } }, { - "name": "public_security_group_ids", - "type": "TypeSet", - "immutable": true, + "name": "memory", + "type": "TypeInt", + "optional": true, + "computed": true + }, + { + "name": "disks", + "type": "TypeList", "optional": true, "computed": true, "elem": { "type": "TypeInt" - }, - "max_items": 5 + } }, { - "name": "resource_controller_url", - "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", - "computed": true + "name": "image_id", + "type": "TypeInt", + "immutable": true, + "optional": true }, { - "name": "placement_group_id", + "name": "evault", "type": "TypeInt", - "description": "The placement group id", "immutable": true, "optional": true }, { - "name": "public_vlan_id", + "name": "public_subnet_id", "type": "TypeInt", + "computed": true + }, + { + "name": "public_security_group_ids", + "type": "TypeSet", "immutable": true, "optional": true, - "computed": true + "computed": true, + "elem": { + "type": "TypeInt" + }, + "max_items": 5 }, { - "name": "resource_name", + "name": "public_ipv6_subnet", "type": "TypeString", - "description": "The name of the resource", "computed": true }, + { + "name": "hourly_billing", + "type": "TypeBool", + "default_value": true, + "immutable": true, + "optional": true + }, { "name": "reserved_capacity_id", "type": "TypeInt", @@ -97950,157 +102505,142 @@ "optional": true }, { - "name": "public_ipv6_subnet", + "name": "ipv4_address_private", "type": "TypeString", "computed": true }, { - "name": "domain", + "name": "resource_controller_url", "type": "TypeString", - "optional": true + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", + "computed": true }, { - "name": "datacenter", - "type": "TypeString", + "name": "ipv6_enabled", + "type": "TypeBool", + "default_value": false, "immutable": true, - "optional": true, + "optional": true + }, + { + "name": "ipv6_address_id", + "type": "TypeInt", "computed": true }, { - "name": "cores", + "name": "public_bandwidth_limited", "type": "TypeInt", + "immutable": true, "optional": true, "computed": true }, { - "name": "public_subnet_id", + "name": "ip_address_id_private", "type": "TypeInt", "computed": true }, { - "name": "post_install_script_uri", - "type": "TypeString", + "name": "secondary_ip_count", + "type": "TypeInt", "immutable": true, "optional": true }, { - "name": "os_reference_code", + "name": "resource_status", "type": "TypeString", - "immutable": true, - "optional": true + "description": "The status of the resource", + "computed": true }, { - "name": "placement_group_name", + "name": "datacenter", "type": "TypeString", - "description": "The placement group name", "immutable": true, - "optional": true - }, - { - "name": "network_speed", - "type": "TypeInt", - "default_value": 100, - "optional": true + "optional": true, + "computed": true }, { - "name": "ipv6_enabled", - "type": "TypeBool", - "default_value": false, + "name": "reserved_capacity_name", + "type": "TypeString", + "description": "The reserved group id", "immutable": true, "optional": true }, { - "name": "ipv6_address", - "type": "TypeString", + "name": "private_vlan_id", + "type": "TypeInt", + "immutable": true, + "optional": true, "computed": true }, { - "name": "ip_address_id_private", + "name": "dedicated_host_id", "type": "TypeInt", - "computed": true + "immutable": true, + "optional": true }, { - "name": "public_ipv6_subnet_id", + "name": "public_interface_id", "type": "TypeInt", "computed": true }, { - "name": "public_bandwidth_unlimited", + "name": "ipv6_static_enabled", "type": "TypeBool", "default_value": false, "immutable": true, "optional": true }, { - "name": "transient", - "type": "TypeBool", - "immutable": true, - "optional": true + "name": "ipv6_address", + "type": "TypeString", + "computed": true }, { - "name": "public_subnet", - "type": "TypeString", - "immutable": true, + "name": "cores", + "type": "TypeInt", "optional": true, "computed": true }, { - "name": "ipv6_static_enabled", - "type": "TypeBool", - "default_value": false, + "name": "user_metadata", + "type": "TypeString", "immutable": true, "optional": true }, { - "name": "ssh_key_ids", - "type": "TypeSet", - "optional": true, - "elem": { - "type": "TypeInt" - } - }, - { - "name": "image_id", - "type": "TypeInt", + "name": "post_install_script_uri", + "type": "TypeString", "immutable": true, "optional": true - }, + } + ], + "ibm_container_addons": [ { - "name": "public_interface_id", - "type": "TypeInt", - "computed": true + "name": "cluster", + "type": "TypeString", + "description": "Cluster Name or ID", + "cloud_data_type": "cluster", + "required": true, + "cloud_data_range": [ + "resolved_to:id" + ] }, { - "name": "private_subnet", + "name": "resource_group_id", "type": "TypeString", + "description": "ID of the resource group.", + "cloud_data_type": "resource_group", "immutable": true, "optional": true, "computed": true }, { - "name": "ipv4_address", - "type": "TypeString", - "computed": true - }, - { - "name": "secondary_ip_addresses", - "type": "TypeList", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "manage_all_addons", + "type": "TypeBool", + "description": "To manage all add-ons installed in the cluster using terraform by importing it into the state file", + "default_value": true, + "optional": true }, - { - "name": "file_storage_ids", - "type": "TypeSet", - "optional": true, - "computed": true, - "elem": { - "type": "TypeInt" - } - } - ], - "ibm_container_addons": [ { "name": "managed_addons", "type": "TypeList", @@ -98199,42 +102739,9 @@ "computed": true } } - }, - { - "name": "cluster", - "type": "TypeString", - "description": "Cluster Name or ID", - "cloud_data_type": "cluster", - "required": true, - "cloud_data_range": [ - "resolved_to:id" - ] - }, - { - "name": "resource_group_id", - "type": "TypeString", - "description": "ID of the resource group.", - "cloud_data_type": "resource_group", - "immutable": true, - "optional": true, - "computed": true - }, - { - "name": "manage_all_addons", - "type": "TypeBool", - "description": "To manage all add-ons installed in the cluster using terraform by importing it into the state file", - "default_value": true, - "optional": true } ], "ibm_container_alb": [ - { - "name": "alb_id", - "type": "TypeString", - "description": "ALB ID", - "immutable": true, - "required": true - }, { "name": "user_ip", "type": "TypeString", @@ -98244,18 +102751,32 @@ "computed": true }, { - "name": "enable", + "name": "disable_deployment", "type": "TypeBool", - "description": "set to true if ALB needs to be enabled", + "description": "Set to true if ALB needs to be disabled", + "immutable": true, "optional": true, "computed": true }, + { + "name": "name", + "type": "TypeString", + "description": "ALB name", + "computed": true + }, { "name": "zone", "type": "TypeString", "description": "ALB zone", "computed": true }, + { + "name": "alb_id", + "type": "TypeString", + "description": "ALB ID", + "immutable": true, + "required": true + }, { "name": "alb_type", "type": "TypeString", @@ -98269,19 +102790,12 @@ "computed": true }, { - "name": "disable_deployment", + "name": "enable", "type": "TypeBool", - "description": "Set to true if ALB needs to be disabled", - "immutable": true, + "description": "set to true if ALB needs to be enabled", "optional": true, "computed": true }, - { - "name": "name", - "type": "TypeString", - "description": "ALB name", - "computed": true - }, { "name": "replicas", "type": "TypeString", @@ -98303,6 +102817,38 @@ } ], "ibm_container_alb_cert": [ + { + "name": "cert_crn", + "type": "TypeString", + "description": "Certificate CRN id", + "required": true + }, + { + "name": "secret_name", + "type": "TypeString", + "description": "Secret name", + "immutable": true, + "required": true + }, + { + "name": "persistence", + "type": "TypeBool", + "description": "Persistence of secret", + "optional": true + }, + { + "name": "expires_on", + "type": "TypeString", + "description": "Certificate expaire on date", + "computed": true + }, + { + "name": "issuer_name", + "type": "TypeString", + "description": "certificate issuer name", + "computed": true, + "deprecated": "This field is depricated and is not available in v2 version of ingress api" + }, { "name": "cluster_id", "type": "TypeString", @@ -98323,11 +102869,10 @@ "optional": true }, { - "name": "issuer_name", + "name": "domain_name", "type": "TypeString", - "description": "certificate issuer name", - "computed": true, - "deprecated": "This field is depricated and is not available in v2 version of ingress api" + "description": "Domain name", + "computed": true }, { "name": "status", @@ -98349,45 +102894,33 @@ "optional": true, "computed": true, "deprecated": "This field is deprecated" - }, + } + ], + "ibm_container_alb_create": [ { - "name": "cert_crn", - "type": "TypeString", - "description": "Certificate CRN id", - "required": true + "name": "resize", + "type": "TypeBool", + "description": "resize", + "computed": true }, { - "name": "secret_name", + "name": "nlb_version", "type": "TypeString", - "description": "Secret name", + "description": "The version of the network load balancer that you want to use for the ALB.", "immutable": true, - "required": true - }, - { - "name": "persistence", - "type": "TypeBool", - "description": "Persistence of secret", "optional": true }, { - "name": "domain_name", + "name": "user_ip", "type": "TypeString", - "description": "Domain name", + "description": "IP assigned by the user", "computed": true }, { - "name": "expires_on", + "name": "replicas", "type": "TypeString", - "description": "Certificate expaire on date", + "description": "number of instances", "computed": true - } - ], - "ibm_container_alb_create": [ - { - "name": "vlan_id", - "type": "TypeString", - "description": "The VLAN ID that you want to use for your ALBs.", - "required": true }, { "name": "disable_deployment", @@ -98396,16 +102929,17 @@ "computed": true }, { - "name": "replicas", + "name": "alb_id", "type": "TypeString", - "description": "number of instances", + "description": "The ID of the application load balancer (ALB).", "computed": true }, { - "name": "resize", + "name": "enable", "type": "TypeBool", - "description": "resize", - "computed": true + "description": "If set to true, the ALB is enabled by default.", + "default_value": true, + "optional": true }, { "name": "ip", @@ -98414,10 +102948,22 @@ "optional": true }, { - "name": "alb_id", + "name": "zone", "type": "TypeString", - "description": "The ID of the application load balancer (ALB).", - "computed": true + "description": "The zone where you want to deploy the ALB.", + "immutable": true, + "required": true + }, + { + "name": "cluster", + "type": "TypeString", + "description": "The ID of the cluster that the ALB belongs to.", + "cloud_data_type": "cluster", + "immutable": true, + "required": true, + "cloud_data_range": [ + "resolved_to:id" + ] }, { "name": "name", @@ -98432,13 +102978,6 @@ "immutable": true, "optional": true }, - { - "name": "nlb_version", - "type": "TypeString", - "description": "The version of the network load balancer that you want to use for the ALB.", - "immutable": true, - "optional": true - }, { "name": "alb_type", "type": "TypeString", @@ -98446,63 +102985,85 @@ "required": true }, { - "name": "zone", + "name": "vlan_id", "type": "TypeString", - "description": "The zone where you want to deploy the ALB.", - "immutable": true, + "description": "The VLAN ID that you want to use for your ALBs.", "required": true - }, + } + ], + "ibm_container_api_key_reset": [ { - "name": "user_ip", + "name": "region", "type": "TypeString", - "description": "IP assigned by the user", - "computed": true - }, - { - "name": "enable", - "type": "TypeBool", - "description": "If set to true, the ALB is enabled by default.", - "default_value": true, - "optional": true + "description": "Region which api key has to be reset", + "cloud_data_type": "region", + "immutable": true, + "required": true }, { - "name": "cluster", + "name": "resource_group_id", "type": "TypeString", - "description": "The ID of the cluster that the ALB belongs to.", - "cloud_data_type": "cluster", + "description": "ID of Resource Group", + "cloud_data_type": "resource_group", "immutable": true, - "required": true, - "cloud_data_range": [ - "resolved_to:id" - ] - } - ], - "ibm_container_api_key_reset": [ + "optional": true + }, { "name": "reset_api_key", "type": "TypeInt", "description": "Determines if apikey has to be reset or not", "default_value": 1, "optional": true + } + ], + "ibm_container_bind_service": [ + { + "name": "org_guid", + "type": "TypeString", + "description": "The bluemix organization guid this cluster belongs to", + "optional": true, + "deprecated": "This field is deprecated" + }, + { + "name": "space_guid", + "type": "TypeString", + "description": "The bluemix space guid this cluster belongs to", + "optional": true, + "deprecated": "This field is deprecated" + }, + { + "name": "key", + "type": "TypeString", + "description": "Key info", + "immutable": true, + "optional": true + }, + { + "name": "tags", + "type": "TypeSet", + "description": "List of tags for the resource", + "cloud_data_type": "tags", + "optional": true, + "elem": { + "type": "TypeString" + } }, { "name": "region", "type": "TypeString", - "description": "Region which api key has to be reset", + "description": "The cluster region", "cloud_data_type": "region", - "immutable": true, - "required": true + "optional": true, + "deprecated": "This field is deprecated" }, { "name": "resource_group_id", "type": "TypeString", - "description": "ID of Resource Group", + "description": "ID of the resource group.", "cloud_data_type": "resource_group", "immutable": true, "optional": true - } - ], - "ibm_container_bind_service": [ + }, { "name": "cluster_name_id", "type": "TypeString", @@ -98530,20 +103091,6 @@ "optional": true, "computed": true }, - { - "name": "space_guid", - "type": "TypeString", - "description": "The bluemix space guid this cluster belongs to", - "optional": true, - "deprecated": "This field is deprecated" - }, - { - "name": "key", - "type": "TypeString", - "description": "Key info", - "immutable": true, - "optional": true - }, { "name": "namespace_id", "type": "TypeString", @@ -98551,13 +103098,6 @@ "immutable": true, "required": true }, - { - "name": "org_guid", - "type": "TypeString", - "description": "The bluemix organization guid this cluster belongs to", - "optional": true, - "deprecated": "This field is deprecated" - }, { "name": "account_guid", "type": "TypeString", @@ -98571,113 +103111,125 @@ "description": "Role info", "immutable": true, "optional": true - }, - { - "name": "region", - "type": "TypeString", - "description": "The cluster region", - "cloud_data_type": "region", - "optional": true, - "deprecated": "This field is deprecated" - }, - { - "name": "resource_group_id", - "type": "TypeString", - "description": "ID of the resource group.", - "cloud_data_type": "resource_group", - "immutable": true, - "optional": true - }, - { - "name": "tags", - "type": "TypeSet", - "description": "List of tags for the resource", - "cloud_data_type": "tags", - "optional": true, - "elem": { - "type": "TypeString" - } } ], "ibm_container_cluster": [ { - "name": "wait_till", + "name": "patch_version", "type": "TypeString", - "description": "wait_till can be configured for Master Ready, One worker Ready, Ingress Ready or Normal", - "default_value": "IngressReady", + "description": "Kubernetes patch version", "optional": true }, { - "name": "private_service_endpoint_url", - "type": "TypeString", - "computed": true - }, - { - "name": "resource_name", + "name": "operating_system", "type": "TypeString", - "description": "The name of the resource", + "description": "The operating system of the workers in the default worker pool.", + "immutable": true, + "optional": true, "computed": true }, { - "name": "labels", - "type": "TypeMap", - "description": "list of labels to the default worker pool", - "optional": true, + "name": "worker_pools", + "type": "TypeList", "computed": true, "elem": { - "type": "TypeString" + "hardware": { + "name": "hardware", + "type": "TypeString", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "computed": true + }, + "labels": { + "name": "labels", + "type": "TypeMap", + "computed": true + }, + "machine_type": { + "name": "machine_type", + "type": "TypeString", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "computed": true + }, + "size_per_zone": { + "name": "size_per_zone", + "type": "TypeInt", + "computed": true + }, + "state": { + "name": "state", + "type": "TypeString", + "computed": true + }, + "zones": { + "name": "zones", + "type": "TypeList", + "computed": true, + "elem": { + "private_vlan": { + "name": "private_vlan", + "type": "TypeString", + "computed": true + }, + "public_vlan": { + "name": "public_vlan", + "type": "TypeString", + "computed": true + }, + "worker_count": { + "name": "worker_count", + "type": "TypeInt", + "computed": true + }, + "zone": { + "name": "zone", + "type": "TypeString", + "computed": true + } + } + } } }, { - "name": "ingress_secret", + "name": "datacenter", "type": "TypeString", - "secure": true, - "computed": true + "description": "The datacenter where this cluster will be deployed", + "immutable": true, + "required": true }, { - "name": "subnet_id", + "name": "taints", "type": "TypeSet", - "description": "List of subnet IDs", + "description": "WorkerPool Taints", "optional": true, "elem": { - "type": "TypeString" + "effect": { + "name": "effect", + "type": "TypeString", + "description": "Effect for taint. Accepted values are NoSchedule, PreferNoSchedule and NoExecute.", + "required": true + }, + "key": { + "name": "key", + "type": "TypeString", + "description": "Key for taint", + "required": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "Value for taint.", + "required": true + } } }, - { - "name": "wait_time_minutes", - "type": "TypeInt", - "optional": true, - "deprecated": "This field is deprecated" - }, - { - "name": "private_service_endpoint", - "type": "TypeBool", - "immutable": true, - "optional": true, - "computed": true - }, - { - "name": "resource_crn", - "type": "TypeString", - "description": "The crn of the resource", - "computed": true - }, - { - "name": "region", - "type": "TypeString", - "description": "The cluster region", - "cloud_data_type": "region", - "optional": true, - "computed": true, - "deprecated": "This field is deprecated" - }, - { - "name": "public_vlan_id", - "type": "TypeString", - "description": "Public VLAN ID", - "immutable": true, - "optional": true - }, { "name": "private_vlan_id", "type": "TypeString", @@ -98686,95 +103238,97 @@ "optional": true }, { - "name": "force_delete_storage", - "type": "TypeBool", - "description": "Force the removal of a cluster and its persistent storage. Deleted data cannot be recovered", - "default_value": false, - "optional": true - }, - { - "name": "resource_group_name", - "type": "TypeString", - "description": "The resource group name in which resource is provisioned", - "computed": true + "name": "albs", + "type": "TypeList", + "computed": true, + "elem": { + "alb_ip": { + "name": "alb_ip", + "type": "TypeString", + "computed": true + }, + "alb_type": { + "name": "alb_type", + "type": "TypeString", + "computed": true + }, + "disable_deployment": { + "name": "disable_deployment", + "type": "TypeBool", + "computed": true + }, + "enable": { + "name": "enable", + "type": "TypeBool", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "computed": true + }, + "num_of_instances": { + "name": "num_of_instances", + "type": "TypeString", + "computed": true + }, + "resize": { + "name": "resize", + "type": "TypeBool", + "computed": true + }, + "state": { + "name": "state", + "type": "TypeString", + "computed": true + } + } }, { - "name": "space_guid", + "name": "service_subnet", "type": "TypeString", - "description": "The bluemix space guid this cluster belongs to", + "description": "Custom subnet CIDR to provide private IP addresses for services", + "immutable": true, "optional": true, - "deprecated": "This field is deprecated" - }, - { - "name": "public_service_endpoint_url", - "type": "TypeString", "computed": true }, { - "name": "name", - "type": "TypeString", - "description": "The cluster name", - "immutable": true, - "required": true - }, - { - "name": "datacenter", - "type": "TypeString", - "description": "The datacenter where this cluster will be deployed", - "immutable": true, - "required": true - }, - { - "name": "hardware", - "type": "TypeString", - "description": "Hardware type", - "immutable": true, - "required": true + "name": "default_pool_size", + "type": "TypeInt", + "description": "The size of the default worker pool", + "default_value": 1, + "optional": true }, { - "name": "pod_subnet", + "name": "kube_version", "type": "TypeString", - "description": "Custom subnet CIDR to provide private IP addresses for pods", - "immutable": true, + "description": "Kubernetes version info", "optional": true, "computed": true }, { - "name": "no_subnet", - "type": "TypeBool", - "description": "Boolean value set to true when subnet creation is not required.", - "default_value": false, - "immutable": true, + "name": "retry_patch_version", + "type": "TypeInt", + "description": "Argument which helps to retry the patch version updates on worker nodes. Increment the value to retry the patch updates if the previous apply fails", "optional": true }, { - "name": "webhook", - "type": "TypeList", - "optional": true, - "elem": { - "level": { - "name": "level", - "type": "TypeString", - "required": true - }, - "type": { - "name": "type", - "type": "TypeString", - "required": true - }, - "url": { - "name": "url", - "type": "TypeString", - "required": true - } - } + "name": "machine_type", + "type": "TypeString", + "description": "Machine type", + "immutable": true, + "optional": true }, { - "name": "public_service_endpoint", - "type": "TypeBool", - "immutable": true, + "name": "wait_time_minutes", + "type": "TypeInt", "optional": true, - "computed": true + "deprecated": "This field is deprecated" }, { "name": "kms_config", @@ -98805,9 +103359,18 @@ "max_items": 1 }, { - "name": "retry_patch_version", - "type": "TypeInt", - "description": "Argument which helps to retry the patch version updates on worker nodes. Increment the value to retry the patch updates if the previous apply fails", + "name": "disk_encryption", + "type": "TypeBool", + "description": "disc encryption done, if set to true.", + "default_value": true, + "immutable": true, + "optional": true + }, + { + "name": "force_delete_storage", + "type": "TypeBool", + "description": "Force the removal of a cluster and its persistent storage. Deleted data cannot be recovered", + "default_value": false, "optional": true }, { @@ -98818,98 +103381,113 @@ "deprecated": "This field is deprecated" }, { - "name": "patch_version", + "name": "private_service_endpoint_url", "type": "TypeString", - "description": "Kubernetes patch version", - "optional": true + "computed": true }, { - "name": "account_guid", + "name": "billing", "type": "TypeString", - "description": "The bluemix account guid this cluster belongs to", "optional": true, "deprecated": "This field is deprecated" }, { - "name": "tags", + "name": "server_url", + "type": "TypeString", + "computed": true + }, + { + "name": "subnet_id", "type": "TypeSet", - "description": "Tags for the resource", - "min_length": 1, - "max_length": 128, - "matches": "^[A-Za-z0-9:_ .-]+$", + "description": "List of subnet IDs", "optional": true, - "computed": true, "elem": { "type": "TypeString" } }, { - "name": "default_pool_size", - "type": "TypeInt", - "description": "The size of the default worker pool", - "default_value": 1, - "optional": true + "name": "public_service_endpoint_url", + "type": "TypeString", + "computed": true }, { - "name": "service_subnet", + "name": "resource_status", "type": "TypeString", - "description": "Custom subnet CIDR to provide private IP addresses for services", - "immutable": true, - "optional": true, + "description": "The status of the resource", "computed": true }, { - "name": "is_trusted", - "type": "TypeBool", - "optional": true, - "deprecated": "This field is deprecated" + "name": "name", + "type": "TypeString", + "description": "The cluster name", + "immutable": true, + "required": true }, { - "name": "gateway_enabled", - "type": "TypeBool", - "description": "Set true for gateway enabled clusters", - "default_value": false, + "name": "entitlement", + "type": "TypeString", + "description": "Entitlement option reduces additional OCP Licence cost in Openshift Clusters", "optional": true }, { - "name": "workers_info", + "name": "webhook", "type": "TypeList", - "description": "The IDs of the worker node", "optional": true, - "computed": true, "elem": { - "id": { - "name": "id", + "level": { + "name": "level", "type": "TypeString", - "optional": true, - "computed": true + "required": true }, - "pool_name": { - "name": "pool_name", + "type": { + "name": "type", "type": "TypeString", - "computed": true + "required": true }, - "version": { - "name": "version", + "url": { + "name": "url", "type": "TypeString", - "optional": true, - "computed": true + "required": true } } }, { - "name": "resource_controller_url", + "name": "tags", + "type": "TypeSet", + "description": "Tags for the resource", + "min_length": 1, + "max_length": 128, + "matches": "^[A-Za-z0-9:_ .-]+$", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "resource_group_id", "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster", + "description": "ID of the resource group.", + "cloud_data_type": "resource_group", + "optional": true, "computed": true }, { - "name": "kube_version", - "type": "TypeString", - "description": "Kubernetes version info", + "name": "public_service_endpoint", + "type": "TypeBool", + "immutable": true, "optional": true, "computed": true }, + { + "name": "region", + "type": "TypeString", + "description": "The cluster region", + "cloud_data_type": "region", + "optional": true, + "computed": true, + "deprecated": "This field is deprecated" + }, { "name": "wait_for_worker_update", "type": "TypeBool", @@ -98917,14 +103495,36 @@ "default_value": true, "optional": true }, + { + "name": "pod_subnet", + "type": "TypeString", + "description": "Custom subnet CIDR to provide private IP addresses for pods", + "immutable": true, + "optional": true, + "computed": true + }, + { + "name": "is_trusted", + "type": "TypeBool", + "optional": true, + "deprecated": "This field is deprecated" + }, { "name": "ingress_hostname", "type": "TypeString", "computed": true }, { - "name": "server_url", + "name": "ingress_secret", "type": "TypeString", + "secure": true, + "computed": true + }, + { + "name": "private_service_endpoint", + "type": "TypeBool", + "immutable": true, + "optional": true, "computed": true }, { @@ -98935,78 +103535,59 @@ "optional": true }, { - "name": "resource_status", + "name": "space_guid", "type": "TypeString", - "description": "The status of the resource", + "description": "The bluemix space guid this cluster belongs to", + "optional": true, + "deprecated": "This field is deprecated" + }, + { + "name": "public_vlan_id", + "type": "TypeString", + "description": "Public VLAN ID", + "immutable": true, + "optional": true + }, + { + "name": "resource_name", + "type": "TypeString", + "description": "The name of the resource", "computed": true }, { - "name": "worker_num", - "type": "TypeInt", - "description": "Number of worker nodes", - "default_value": 0, - "optional": true, - "deprecated": "This field is deprecated" + "name": "wait_till", + "type": "TypeString", + "description": "wait_till can be configured for Master Ready, One worker Ready, Ingress Ready or Normal", + "default_value": "IngressReady", + "optional": true }, { - "name": "disk_encryption", + "name": "no_subnet", "type": "TypeBool", - "description": "disc encryption done, if set to true.", - "default_value": true, + "description": "Boolean value set to true when subnet creation is not required.", + "default_value": false, "immutable": true, "optional": true }, { - "name": "albs", - "type": "TypeList", - "computed": true, - "elem": { - "alb_ip": { - "name": "alb_ip", - "type": "TypeString", - "computed": true - }, - "alb_type": { - "name": "alb_type", - "type": "TypeString", - "computed": true - }, - "disable_deployment": { - "name": "disable_deployment", - "type": "TypeBool", - "computed": true - }, - "enable": { - "name": "enable", - "type": "TypeBool", - "computed": true - }, - "id": { - "name": "id", - "type": "TypeString", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "computed": true - }, - "num_of_instances": { - "name": "num_of_instances", - "type": "TypeString", - "computed": true - }, - "resize": { - "name": "resize", - "type": "TypeBool", - "computed": true - }, - "state": { - "name": "state", - "type": "TypeString", - "computed": true - } - } + "name": "resource_group_name", + "type": "TypeString", + "description": "The resource group name in which resource is provisioned", + "computed": true + }, + { + "name": "hardware", + "type": "TypeString", + "description": "Hardware type", + "immutable": true, + "required": true + }, + { + "name": "gateway_enabled", + "type": "TypeBool", + "description": "Set true for gateway enabled clusters", + "default_value": false, + "optional": true }, { "name": "crn", @@ -99016,151 +103597,77 @@ "computed": true }, { - "name": "taints", - "type": "TypeSet", - "description": "WorkerPool Taints", + "name": "account_guid", + "type": "TypeString", + "description": "The bluemix account guid this cluster belongs to", "optional": true, - "elem": { - "effect": { - "name": "effect", - "type": "TypeString", - "description": "Effect for taint. Accepted values are NoSchedule, PreferNoSchedule and NoExecute.", - "required": true - }, - "key": { - "name": "key", - "type": "TypeString", - "description": "Key for taint", - "required": true - }, - "value": { - "name": "value", - "type": "TypeString", - "description": "Value for taint.", - "required": true - } - } + "deprecated": "This field is deprecated" }, { - "name": "update_all_workers", - "type": "TypeBool", - "description": "Updates all the woker nodes if sets to true", - "default_value": false, - "optional": true + "name": "resource_controller_url", + "type": "TypeString", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster", + "computed": true }, { - "name": "entitlement", + "name": "resource_crn", "type": "TypeString", - "description": "Entitlement option reduces additional OCP Licence cost in Openshift Clusters", - "optional": true + "description": "The crn of the resource", + "computed": true }, { - "name": "operating_system", - "type": "TypeString", - "description": "The operating system of the workers in the default worker pool.", - "immutable": true, + "name": "worker_num", + "type": "TypeInt", + "description": "Number of worker nodes", + "default_value": 0, "optional": true, - "computed": true + "deprecated": "This field is deprecated" }, { - "name": "worker_pools", + "name": "labels", + "type": "TypeMap", + "description": "list of labels to the default worker pool", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "workers_info", "type": "TypeList", + "description": "The IDs of the worker node", + "optional": true, "computed": true, "elem": { - "hardware": { - "name": "hardware", - "type": "TypeString", - "computed": true - }, "id": { "name": "id", "type": "TypeString", + "optional": true, "computed": true }, - "labels": { - "name": "labels", - "type": "TypeMap", - "computed": true - }, - "machine_type": { - "name": "machine_type", - "type": "TypeString", - "computed": true - }, - "name": { - "name": "name", + "pool_name": { + "name": "pool_name", "type": "TypeString", "computed": true }, - "size_per_zone": { - "name": "size_per_zone", - "type": "TypeInt", - "computed": true - }, - "state": { - "name": "state", + "version": { + "name": "version", "type": "TypeString", + "optional": true, "computed": true - }, - "zones": { - "name": "zones", - "type": "TypeList", - "computed": true, - "elem": { - "private_vlan": { - "name": "private_vlan", - "type": "TypeString", - "computed": true - }, - "public_vlan": { - "name": "public_vlan", - "type": "TypeString", - "computed": true - }, - "worker_count": { - "name": "worker_count", - "type": "TypeInt", - "computed": true - }, - "zone": { - "name": "zone", - "type": "TypeString", - "computed": true - } - } } } }, { - "name": "machine_type", - "type": "TypeString", - "description": "Machine type", - "immutable": true, + "name": "update_all_workers", + "type": "TypeBool", + "description": "Updates all the woker nodes if sets to true", + "default_value": false, "optional": true - }, - { - "name": "resource_group_id", - "type": "TypeString", - "description": "ID of the resource group.", - "cloud_data_type": "resource_group", - "optional": true, - "computed": true - }, - { - "name": "billing", - "type": "TypeString", - "optional": true, - "deprecated": "This field is deprecated" } ], "ibm_container_cluster_feature": [ - { - "name": "reload_workers", - "type": "TypeBool", - "description": "Boolean value set true if worker nodes to be reloaded", - "default_value": true, - "optional": true - }, { "name": "private_service_endpoint_url", "type": "TypeString", @@ -99208,9 +103715,36 @@ "description": "Boolean value true of API server to be refreshed in K8S cluster", "default_value": true, "optional": true + }, + { + "name": "reload_workers", + "type": "TypeBool", + "description": "Boolean value set true if worker nodes to be reloaded", + "default_value": true, + "optional": true } ], "ibm_container_dedicated_host": [ + { + "name": "zone", + "type": "TypeString", + "description": "The zone of the dedicated host", + "immutable": true, + "required": true + }, + { + "name": "placement_enabled", + "type": "TypeBool", + "description": "Enables/disables placement on the dedicated host", + "optional": true, + "computed": true + }, + { + "name": "host_id", + "type": "TypeString", + "description": "The id of the dedicated host", + "computed": true + }, { "name": "life_cycle", "type": "TypeList", @@ -99331,29 +103865,36 @@ "description": "The id of the dedicated host pool the dedicated host is associated with", "immutable": true, "required": true - }, + } + ], + "ibm_container_dedicated_host_pool": [ { - "name": "zone", + "name": "flavor_class", "type": "TypeString", - "description": "The zone of the dedicated host", + "description": "The flavor class of the dedicated host pool", "immutable": true, "required": true }, { - "name": "placement_enabled", - "type": "TypeBool", - "description": "Enables/disables placement on the dedicated host", - "optional": true, + "name": "resource_group_id", + "type": "TypeString", + "description": "ID of the resource group.", + "cloud_data_type": "resource_group", + "immutable": true, + "optional": true + }, + { + "name": "host_count", + "type": "TypeInt", + "description": "The count of the hosts under the dedicated host pool", "computed": true }, { - "name": "host_id", + "name": "state", "type": "TypeString", - "description": "The id of the dedicated host", + "description": "The state of the dedicated host pool", "computed": true - } - ], - "ibm_container_dedicated_host_pool": [ + }, { "name": "zones", "type": "TypeList", @@ -99420,42 +103961,22 @@ "description": "The metro to create the dedicated host pool in", "immutable": true, "required": true - }, - { - "name": "flavor_class", - "type": "TypeString", - "description": "The flavor class of the dedicated host pool", - "immutable": true, - "required": true - }, - { - "name": "resource_group_id", - "type": "TypeString", - "description": "ID of the resource group.", - "cloud_data_type": "resource_group", - "immutable": true, - "optional": true - }, - { - "name": "host_count", - "type": "TypeInt", - "description": "The count of the hosts under the dedicated host pool", - "computed": true - }, - { - "name": "state", - "type": "TypeString", - "description": "The state of the dedicated host pool", - "computed": true } ], "ibm_container_ingress_instance": [ { - "name": "secret_group_name", - "type": "TypeString", - "description": "Name of the secret group for the instance", + "name": "user_managed", + "type": "TypeBool", + "description": "If the instance was created by the user", "computed": true }, + { + "name": "is_default", + "type": "TypeBool", + "description": "Designates if the instance is the default for the cluster", + "default_value": false, + "optional": true + }, { "name": "status", "type": "TypeString", @@ -99463,9 +103984,9 @@ "computed": true }, { - "name": "instance_name", + "name": "instance_type", "type": "TypeString", - "description": "Instance registration name", + "description": "Instance type", "computed": true }, { @@ -99476,22 +103997,9 @@ "optional": true }, { - "name": "is_default", - "type": "TypeBool", - "description": "Designates if the instance is the default for the cluster", - "default_value": false, - "optional": true - }, - { - "name": "instance_type", + "name": "secret_group_name", "type": "TypeString", - "description": "Instance type", - "computed": true - }, - { - "name": "user_managed", - "type": "TypeBool", - "description": "If the instance was created by the user", + "description": "Name of the secret group for the instance", "computed": true }, { @@ -99511,6 +104019,12 @@ "cloud_data_range": [ "resolved_to:id" ] + }, + { + "name": "instance_name", + "type": "TypeString", + "description": "Instance registration name", + "computed": true } ], "ibm_container_ingress_secret_opaque": [ @@ -99605,28 +104119,21 @@ ], "ibm_container_ingress_secret_tls": [ { - "name": "secret_namespace", + "name": "cert_crn", "type": "TypeString", - "description": "Secret namespace", - "immutable": true, + "description": "Certificate CRN", "required": true }, { - "name": "type", + "name": "domain_name", "type": "TypeString", - "description": "TLS secret type", + "description": "Domain name", "computed": true }, { - "name": "persistence", - "type": "TypeBool", - "description": "Persistence of secret", - "optional": true - }, - { - "name": "domain_name", + "name": "expires_on", "type": "TypeString", - "description": "Domain name", + "description": "Certificate expires on date", "computed": true }, { @@ -99647,16 +104154,16 @@ ] }, { - "name": "cert_crn", + "name": "type", "type": "TypeString", - "description": "Certificate CRN", - "required": true + "description": "TLS secret type", + "computed": true }, { - "name": "expires_on", - "type": "TypeString", - "description": "Certificate expires on date", - "computed": true + "name": "persistence", + "type": "TypeBool", + "description": "Persistence of secret", + "optional": true }, { "name": "status", @@ -99676,6 +104183,13 @@ "description": "Secret name", "immutable": true, "required": true + }, + { + "name": "secret_namespace", + "type": "TypeString", + "description": "Secret namespace", + "immutable": true, + "required": true } ], "ibm_container_nlb_dns": [ @@ -99694,6 +104208,16 @@ "type": "TypeString", "computed": true }, + { + "name": "secret_namespace", + "type": "TypeString", + "computed": true + }, + { + "name": "nlb_monitor_state", + "type": "TypeString", + "computed": true + }, { "name": "nlb_host", "type": "TypeString", @@ -99709,7 +104233,7 @@ } }, { - "name": "nlb_monitor_state", + "name": "nlb_dns_type", "type": "TypeString", "computed": true }, @@ -99730,45 +104254,9 @@ "cloud_data_range": [ "resolved_to:id" ] - }, - { - "name": "nlb_dns_type", - "type": "TypeString", - "computed": true - }, - { - "name": "secret_namespace", - "type": "TypeString", - "computed": true } ], "ibm_container_storage_attachment": [ - { - "name": "resource_group_id", - "type": "TypeString", - "description": "ID of the resource group.", - "cloud_data_type": "resource_group", - "immutable": true, - "optional": true - }, - { - "name": "status", - "type": "TypeString", - "description": "Volume attachment status", - "computed": true - }, - { - "name": "volume_attachment_id", - "type": "TypeString", - "description": "Volume attachment ID", - "computed": true - }, - { - "name": "volume_type", - "type": "TypeString", - "description": "The type of volume", - "computed": true - }, { "name": "volume", "type": "TypeString", @@ -99799,6 +104287,32 @@ "type": "TypeString", "description": "Volume attachment name", "computed": true + }, + { + "name": "resource_group_id", + "type": "TypeString", + "description": "ID of the resource group.", + "cloud_data_type": "resource_group", + "immutable": true, + "optional": true + }, + { + "name": "status", + "type": "TypeString", + "description": "Volume attachment status", + "computed": true + }, + { + "name": "volume_attachment_id", + "type": "TypeString", + "description": "Volume attachment ID", + "computed": true + }, + { + "name": "volume_type", + "type": "TypeString", + "description": "The type of volume", + "computed": true } ], "ibm_container_vpc_alb": [ @@ -99810,9 +104324,9 @@ "required": true }, { - "name": "cluster", + "name": "alb_type", "type": "TypeString", - "description": "cluster id", + "description": "Type of the ALB", "computed": true }, { @@ -99822,15 +104336,17 @@ "optional": true }, { - "name": "name", - "type": "TypeString", - "description": "ALB name", + "name": "disable_deployment", + "type": "TypeBool", + "description": "Disable the ALB instance in the cluster", + "immutable": true, + "optional": true, "computed": true }, { - "name": "zone", + "name": "load_balancer_hostname", "type": "TypeString", - "description": "Zone info.", + "description": "Load balancer host name", "computed": true }, { @@ -99839,6 +104355,12 @@ "description": "Status of the ALB", "computed": true }, + { + "name": "zone", + "type": "TypeString", + "description": "Zone info.", + "computed": true + }, { "name": "resource_group_id", "type": "TypeString", @@ -99847,23 +104369,15 @@ "optional": true }, { - "name": "alb_type", + "name": "cluster", "type": "TypeString", - "description": "Type of the ALB", - "computed": true - }, - { - "name": "disable_deployment", - "type": "TypeBool", - "description": "Disable the ALB instance in the cluster", - "immutable": true, - "optional": true, + "description": "cluster id", "computed": true }, { - "name": "load_balancer_hostname", + "name": "name", "type": "TypeString", - "description": "Load balancer host name", + "description": "ALB name", "computed": true }, { @@ -99881,29 +104395,29 @@ ], "ibm_container_vpc_alb_create": [ { - "name": "status", + "name": "name", "type": "TypeString", - "description": "Status of the ALB", + "description": "ALB name", "computed": true }, { - "name": "type", + "name": "load_balancer_hostname", "type": "TypeString", - "description": "The type of ALB that you want to create.", - "immutable": true, - "required": true + "description": "Load balancer host name", + "computed": true }, { - "name": "enable", - "type": "TypeBool", - "description": "Enable the ALB instance in the cluster", - "optional": true + "name": "state", + "type": "TypeString", + "description": "ALB state", + "computed": true }, { - "name": "resize", - "type": "TypeBool", - "description": "boolean value to resize the albs", - "computed": true + "name": "type", + "type": "TypeString", + "description": "The type of ALB that you want to create.", + "immutable": true, + "required": true }, { "name": "alb_id", @@ -99925,15 +104439,15 @@ "computed": true }, { - "name": "name", - "type": "TypeString", - "description": "ALB name", + "name": "resize", + "type": "TypeBool", + "description": "boolean value to resize the albs", "computed": true }, { - "name": "load_balancer_hostname", + "name": "status", "type": "TypeString", - "description": "Load balancer host name", + "description": "Status of the ALB", "computed": true }, { @@ -99962,39 +104476,41 @@ "optional": true }, { - "name": "state", - "type": "TypeString", - "description": "ALB state", - "computed": true + "name": "enable", + "type": "TypeBool", + "description": "Enable the ALB instance in the cluster", + "optional": true } ], "ibm_container_vpc_cluster": [ { - "name": "operating_system", + "name": "flavor", "type": "TypeString", - "description": "The operating system of the workers in the default worker pool.", + "description": "Cluster nodes flavour", "immutable": true, - "optional": true, - "computed": true + "required": true }, { - "name": "force_delete_storage", - "type": "TypeBool", - "description": "Force the removal of a cluster and its persistent storage. Deleted data cannot be recovered", - "default_value": false, + "name": "retry_patch_version", + "type": "TypeInt", + "description": "Argument which helps to retry the patch version updates on worker nodes. Increment the value to retry the patch updates if the previous apply fails", "optional": true }, { - "name": "master_status", + "name": "service_subnet", "type": "TypeString", + "description": "Custom subnet CIDR to provide private IP addresses for services", + "immutable": true, + "optional": true, "computed": true }, { - "name": "image_security_enforcement", - "type": "TypeBool", - "description": "Set true to enable image security enforcement policies", - "default_value": false, - "optional": true + "name": "operating_system", + "type": "TypeString", + "description": "The operating system of the workers in the default worker pool.", + "immutable": true, + "optional": true, + "computed": true }, { "name": "tags", @@ -100010,85 +104526,77 @@ } }, { - "name": "entitlement", + "name": "wait_till", "type": "TypeString", - "description": "Entitlement option reduces additional OCP Licence cost in Openshift Clusters", + "description": "wait_till can be configured for Master Ready, One worker Ready or Ingress Ready or Normal", + "default_value": "IngressReady", "optional": true }, { - "name": "albs", - "type": "TypeList", - "computed": true, - "elem": { - "alb_type": { - "name": "alb_type", - "type": "TypeString", - "computed": true - }, - "disable_deployment": { - "name": "disable_deployment", - "type": "TypeBool", - "computed": true - }, - "enable": { - "name": "enable", - "type": "TypeBool", - "computed": true - }, - "id": { - "name": "id", - "type": "TypeString", - "computed": true - }, - "load_balancer_hostname": { - "name": "load_balancer_hostname", - "type": "TypeString", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "computed": true - }, - "resize": { - "name": "resize", - "type": "TypeBool", - "computed": true - }, - "state": { - "name": "state", - "type": "TypeString", - "computed": true - } - } + "name": "cos_instance_crn", + "type": "TypeString", + "description": "A standard cloud object storage instance CRN to back up the internal registry in your OpenShift on VPC Gen 2 cluster", + "optional": true }, { - "name": "kms_config", - "type": "TypeList", - "description": "Enables KMS on a given cluster", + "name": "resource_controller_url", + "type": "TypeString", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster", + "computed": true + }, + { + "name": "resource_group_id", + "type": "TypeString", + "description": "ID of the resource group.", + "cloud_data_type": "resource_group", + "immutable": true, "optional": true, - "elem": { - "crk_id": { - "name": "crk_id", - "type": "TypeString", - "description": "ID of the customer root key.", - "required": true - }, - "instance_id": { - "name": "instance_id", - "type": "TypeString", - "description": "ID of the KMS instance to use to encrypt the cluster.", - "required": true - }, - "private_endpoint": { - "name": "private_endpoint", - "type": "TypeBool", - "description": "Specify this option to use the KMS public service endpoint.", - "default_value": false, - "optional": true - } - }, - "max_items": 1 + "computed": true + }, + { + "name": "resource_crn", + "type": "TypeString", + "description": "The crn of the resource", + "computed": true + }, + { + "name": "worker_count", + "type": "TypeInt", + "description": "Number of worker nodes in the cluster", + "default_value": 1, + "optional": true + }, + { + "name": "force_delete_storage", + "type": "TypeBool", + "description": "Force the removal of a cluster and its persistent storage. Deleted data cannot be recovered", + "default_value": false, + "optional": true + }, + { + "name": "image_security_enforcement", + "type": "TypeBool", + "description": "Set true to enable image security enforcement policies", + "default_value": false, + "optional": true + }, + { + "name": "master_status", + "type": "TypeString", + "computed": true + }, + { + "name": "host_pool_id", + "type": "TypeString", + "description": "The ID of the cluster's associated host pool", + "immutable": true, + "optional": true + }, + { + "name": "resource_group_name", + "type": "TypeString", + "description": "The resource group name in which resource is provisioned", + "computed": true }, { "name": "zones", @@ -100111,63 +104619,79 @@ } }, { - "name": "kube_version", - "type": "TypeString", - "description": "Kubernetes version", - "optional": true, - "computed": true - }, - { - "name": "patch_version", - "type": "TypeString", - "description": "Kubernetes patch version", - "optional": true - }, - { - "name": "worker_count", - "type": "TypeInt", - "description": "Number of worker nodes in the cluster", - "default_value": 1, + "name": "wait_for_worker_update", + "type": "TypeBool", + "description": "Wait for worker node to update during kube version update.", + "default_value": true, "optional": true }, { - "name": "ingress_secret", + "name": "secondary_storage", "type": "TypeString", - "secure": true, + "description": "The secondary storage option for the default worker pool.", + "immutable": true, + "optional": true, "computed": true }, { - "name": "resource_group_name", + "name": "ingress_secret", "type": "TypeString", - "description": "The resource group name in which resource is provisioned", + "secure": true, "computed": true }, { - "name": "resource_name", + "name": "resource_status", "type": "TypeString", - "description": "The name of the resource", + "description": "The status of the resource", "computed": true }, { - "name": "flavor", + "name": "name", "type": "TypeString", - "description": "Cluster nodes flavour", + "description": "The cluster name", "immutable": true, "required": true }, { - "name": "retry_patch_version", - "type": "TypeInt", - "description": "Argument which helps to retry the patch version updates on worker nodes. Increment the value to retry the patch updates if the previous apply fails", + "name": "kms_config", + "type": "TypeList", + "description": "Enables KMS on a given cluster", + "optional": true, + "elem": { + "crk_id": { + "name": "crk_id", + "type": "TypeString", + "description": "ID of the customer root key.", + "required": true + }, + "instance_id": { + "name": "instance_id", + "type": "TypeString", + "description": "ID of the KMS instance to use to encrypt the cluster.", + "required": true + }, + "private_endpoint": { + "name": "private_endpoint", + "type": "TypeBool", + "description": "Specify this option to use the KMS public service endpoint.", + "default_value": false, + "optional": true + } + }, + "max_items": 1 + }, + { + "name": "update_all_workers", + "type": "TypeBool", + "description": "Updates all the woker nodes if sets to true", + "default_value": false, "optional": true }, { - "name": "pod_subnet", + "name": "patch_version", "type": "TypeString", - "description": "Custom subnet CIDR to provide private IP addresses for pods", - "immutable": true, - "optional": true, - "computed": true + "description": "Kubernetes patch version", + "optional": true }, { "name": "taints", @@ -100195,33 +104719,6 @@ } } }, - { - "name": "crn", - "type": "TypeString", - "description": "CRN of resource instance", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "resource_controller_url", - "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster", - "computed": true - }, - { - "name": "kms_account_id", - "type": "TypeString", - "description": "Account ID of kms instance holder - if not provided, defaults to the account in use", - "optional": true - }, - { - "name": "service_subnet", - "type": "TypeString", - "description": "Custom subnet CIDR to provide private IP addresses for services", - "immutable": true, - "optional": true, - "computed": true - }, { "name": "disable_public_service_endpoint", "type": "TypeBool", @@ -100229,13 +104726,6 @@ "default_value": false, "optional": true }, - { - "name": "wait_till", - "type": "TypeString", - "description": "wait_till can be configured for Master Ready, One worker Ready or Ingress Ready or Normal", - "default_value": "IngressReady", - "optional": true - }, { "name": "kms_instance_id", "type": "TypeString", @@ -100243,26 +104733,65 @@ "optional": true }, { - "name": "ingress_hostname", + "name": "state", "type": "TypeString", "computed": true }, { - "name": "private_service_endpoint_url", - "type": "TypeString", - "computed": true + "name": "albs", + "type": "TypeList", + "computed": true, + "elem": { + "alb_type": { + "name": "alb_type", + "type": "TypeString", + "computed": true + }, + "disable_deployment": { + "name": "disable_deployment", + "type": "TypeBool", + "computed": true + }, + "enable": { + "name": "enable", + "type": "TypeBool", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "computed": true + }, + "load_balancer_hostname": { + "name": "load_balancer_hostname", + "type": "TypeString", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "computed": true + }, + "resize": { + "name": "resize", + "type": "TypeBool", + "computed": true + }, + "state": { + "name": "state", + "type": "TypeString", + "computed": true + } + } }, { - "name": "host_pool_id", + "name": "public_service_endpoint_url", "type": "TypeString", - "description": "The ID of the cluster's associated host pool", - "immutable": true, - "optional": true + "computed": true }, { - "name": "resource_status", + "name": "private_service_endpoint_url", "type": "TypeString", - "description": "The status of the resource", "computed": true }, { @@ -100273,76 +104802,95 @@ "required": true }, { - "name": "update_all_workers", - "type": "TypeBool", - "description": "Updates all the woker nodes if sets to true", - "default_value": false, + "name": "worker_labels", + "type": "TypeMap", + "description": "Labels for default worker pool", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "crk", + "type": "TypeString", + "description": "Root Key ID for boot volume encryption", "optional": true }, { - "name": "secondary_storage", + "name": "kube_version", "type": "TypeString", - "description": "The secondary storage option for the default worker pool.", + "description": "Kubernetes version", + "optional": true, + "computed": true + }, + { + "name": "pod_subnet", + "type": "TypeString", + "description": "Custom subnet CIDR to provide private IP addresses for pods", "immutable": true, "optional": true, "computed": true }, { - "name": "cos_instance_crn", + "name": "kms_account_id", "type": "TypeString", - "description": "A standard cloud object storage instance CRN to back up the internal registry in your OpenShift on VPC Gen 2 cluster", + "description": "Account ID of kms instance holder - if not provided, defaults to the account in use", "optional": true }, { - "name": "state", + "name": "master_url", "type": "TypeString", "computed": true }, { - "name": "master_url", + "name": "resource_name", "type": "TypeString", + "description": "The name of the resource", "computed": true }, { - "name": "public_service_endpoint_url", + "name": "entitlement", "type": "TypeString", - "computed": true + "description": "Entitlement option reduces additional OCP Licence cost in Openshift Clusters", + "optional": true }, { - "name": "resource_crn", + "name": "crn", "type": "TypeString", - "description": "The crn of the resource", + "description": "CRN of resource instance", + "cloud_data_type": "crn", "computed": true }, { - "name": "name", + "name": "ingress_hostname", "type": "TypeString", - "description": "The cluster name", - "immutable": true, - "required": true - }, + "computed": true + } + ], + "ibm_container_vpc_worker": [ { - "name": "wait_for_worker_update", + "name": "check_ptx_status", "type": "TypeBool", - "description": "Wait for worker node to update during kube version update.", - "default_value": true, + "description": "Check portworx status after worker replace", + "default_value": false, + "immutable": true, "optional": true }, { - "name": "worker_labels", - "type": "TypeMap", - "description": "Labels for default worker pool", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "ptx_timeout", + "type": "TypeString", + "description": "Timeout for checking ptx pods/status", + "default_value": "15m", + "immutable": true, + "optional": true }, { - "name": "crk", + "name": "replace_worker", "type": "TypeString", - "description": "Root Key ID for boot volume encryption", - "optional": true + "description": "Worker name/id that needs to be replaced", + "immutable": true, + "required": true }, { "name": "resource_group_id", @@ -100350,16 +104898,13 @@ "description": "ID of the resource group.", "cloud_data_type": "resource_group", "immutable": true, - "optional": true, - "computed": true - } - ], - "ibm_container_vpc_worker": [ + "optional": true + }, { - "name": "resource_group_id", + "name": "sds_timeout", "type": "TypeString", - "description": "ID of the resource group.", - "cloud_data_type": "resource_group", + "description": "Timeout for checking sds deployment/status", + "default_value": "15m", "immutable": true, "optional": true }, @@ -100371,12 +104916,10 @@ "optional": true }, { - "name": "check_ptx_status", - "type": "TypeBool", - "description": "Check portworx status after worker replace", - "default_value": false, - "immutable": true, - "optional": true + "name": "ip", + "type": "TypeString", + "description": "IP of the replaced worker", + "computed": true }, { "name": "cluster_name", @@ -100391,38 +104934,29 @@ "description": "Name of Software Defined Storage", "immutable": true, "optional": true - }, + } + ], + "ibm_container_vpc_worker_pool": [ { - "name": "replace_worker", + "name": "host_pool_id", "type": "TypeString", - "description": "Worker name/id that needs to be replaced", + "description": "The ID of the dedicated host pool associated with the worker pool", "immutable": true, - "required": true + "optional": true }, { - "name": "sds_timeout", + "name": "kms_instance_id", "type": "TypeString", - "description": "Timeout for checking sds deployment/status", - "default_value": "15m", - "immutable": true, + "description": "Instance ID for boot volume encryption", "optional": true }, { - "name": "ptx_timeout", + "name": "worker_pool_name", "type": "TypeString", - "description": "Timeout for checking ptx pods/status", - "default_value": "15m", + "description": "worker pool name", "immutable": true, - "optional": true + "required": true }, - { - "name": "ip", - "type": "TypeString", - "description": "IP of the replaced worker", - "computed": true - } - ], - "ibm_container_vpc_worker_pool": [ { "name": "zones", "type": "TypeSet", @@ -100443,80 +104977,6 @@ } } }, - { - "name": "resource_group_id", - "type": "TypeString", - "description": "ID of the resource group.", - "cloud_data_type": "resource_group", - "immutable": true, - "optional": true, - "computed": true - }, - { - "name": "vpc_id", - "type": "TypeString", - "description": "The vpc id where the cluster is", - "immutable": true, - "required": true - }, - { - "name": "worker_count", - "type": "TypeInt", - "description": "The number of workers", - "required": true - }, - { - "name": "kms_instance_id", - "type": "TypeString", - "description": "Instance ID for boot volume encryption", - "optional": true - }, - { - "name": "kms_account_id", - "type": "TypeString", - "description": "Account ID of kms instance holder - if not provided, defaults to the account in use", - "optional": true - }, - { - "name": "flavor", - "type": "TypeString", - "description": "cluster node falvor", - "immutable": true, - "required": true - }, - { - "name": "labels", - "type": "TypeMap", - "description": "Labels", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "operating_system", - "type": "TypeString", - "description": "The operating system of the workers in the worker pool.", - "immutable": true, - "optional": true, - "computed": true - }, - { - "name": "secondary_storage", - "type": "TypeString", - "description": "The secondary storage option for the workers in the worker pool.", - "immutable": true, - "optional": true, - "computed": true - }, - { - "name": "worker_pool_name", - "type": "TypeString", - "description": "worker pool name", - "immutable": true, - "required": true - }, { "name": "taints", "type": "TypeSet", @@ -100544,73 +105004,67 @@ } }, { - "name": "crk", + "name": "operating_system", "type": "TypeString", - "description": "Root Key ID for boot volume encryption", - "optional": true - }, - { - "name": "autoscale_enabled", - "type": "TypeBool", - "description": "Autoscaling is enabled on the workerpool", + "description": "The operating system of the workers in the worker pool.", + "immutable": true, + "optional": true, "computed": true }, { - "name": "cluster", + "name": "secondary_storage", "type": "TypeString", - "description": "Cluster name", - "cloud_data_type": "cluster", + "description": "The secondary storage option for the workers in the worker pool.", "immutable": true, - "required": true, - "cloud_data_range": [ - "resolved_to:id" - ] + "optional": true, + "computed": true }, { - "name": "worker_pool_id", + "name": "kms_account_id", "type": "TypeString", + "description": "Account ID of kms instance holder - if not provided, defaults to the account in use", + "optional": true + }, + { + "name": "autoscale_enabled", + "type": "TypeBool", + "description": "Autoscaling is enabled on the workerpool", "computed": true }, { - "name": "entitlement", + "name": "worker_pool_id", "type": "TypeString", - "description": "Entitlement option reduces additional OCP Licence cost in Openshift Clusters", - "optional": true + "computed": true }, { - "name": "host_pool_id", - "type": "TypeString", - "description": "The ID of the dedicated host pool associated with the worker pool", - "immutable": true, - "optional": true + "name": "worker_count", + "type": "TypeInt", + "description": "The number of workers", + "required": true }, { "name": "resource_controller_url", "type": "TypeString", "description": "Resource Controller URL", "computed": true - } - ], - "ibm_container_worker_pool": [ + }, { - "name": "hardware", + "name": "crk", "type": "TypeString", - "description": "Hardware type", - "default_value": "shared", - "immutable": true, + "description": "Root Key ID for boot volume encryption", "optional": true }, { - "name": "worker_pool_id", + "name": "vpc_id", "type": "TypeString", - "computed": true + "description": "The vpc id where the cluster is", + "immutable": true, + "required": true }, { - "name": "resource_group_id", + "name": "entitlement", "type": "TypeString", - "description": "ID of the resource group.", - "cloud_data_type": "resource_group", - "immutable": true, + "description": "Entitlement option reduces additional OCP Licence cost in Openshift Clusters", "optional": true }, { @@ -100625,30 +105079,45 @@ ] }, { - "name": "size_per_zone", - "type": "TypeInt", - "description": "Number of nodes per zone", + "name": "flavor", + "type": "TypeString", + "description": "cluster node falvor", + "immutable": true, "required": true }, { - "name": "resource_controller_url", - "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster", - "computed": true + "name": "labels", + "type": "TypeMap", + "description": "Labels", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "region", + "name": "resource_group_id", "type": "TypeString", - "description": "The worker pool region", - "cloud_data_type": "region", + "description": "ID of the resource group.", + "cloud_data_type": "resource_group", + "immutable": true, "optional": true, - "computed": true, - "deprecated": "This field is deprecated" + "computed": true + } + ], + "ibm_container_worker_pool": [ + { + "name": "hardware", + "type": "TypeString", + "description": "Hardware type", + "default_value": "shared", + "immutable": true, + "optional": true }, { - "name": "machine_type", + "name": "worker_pool_name", "type": "TypeString", - "description": "worker nodes machine type", + "description": "worker pool name", "immutable": true, "required": true }, @@ -100667,9 +105136,8 @@ "computed": true }, { - "name": "state", + "name": "worker_pool_id", "type": "TypeString", - "description": "worker pool state", "computed": true }, { @@ -100698,6 +105166,58 @@ } } }, + { + "name": "region", + "type": "TypeString", + "description": "The worker pool region", + "cloud_data_type": "region", + "optional": true, + "computed": true, + "deprecated": "This field is deprecated" + }, + { + "name": "resource_group_id", + "type": "TypeString", + "description": "ID of the resource group.", + "cloud_data_type": "resource_group", + "immutable": true, + "optional": true + }, + { + "name": "machine_type", + "type": "TypeString", + "description": "worker nodes machine type", + "immutable": true, + "required": true + }, + { + "name": "size_per_zone", + "type": "TypeInt", + "description": "Number of nodes per zone", + "required": true + }, + { + "name": "state", + "type": "TypeString", + "description": "worker pool state", + "computed": true + }, + { + "name": "labels", + "type": "TypeMap", + "description": "list of labels to worker pool", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "resource_controller_url", + "type": "TypeString", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster", + "computed": true + }, { "name": "autoscale_enabled", "type": "TypeBool", @@ -100705,11 +105225,15 @@ "computed": true }, { - "name": "worker_pool_name", + "name": "cluster", "type": "TypeString", - "description": "worker pool name", + "description": "Cluster name", + "cloud_data_type": "cluster", "immutable": true, - "required": true + "required": true, + "cloud_data_range": [ + "resolved_to:id" + ] }, { "name": "disk_encryption", @@ -100745,26 +105269,9 @@ "computed": true } } - }, - { - "name": "labels", - "type": "TypeMap", - "description": "list of labels to worker pool", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } } ], "ibm_container_worker_pool_zone_attachment": [ - { - "name": "zone", - "type": "TypeString", - "description": "Zone name", - "immutable": true, - "required": true - }, { "name": "cluster", "type": "TypeString", @@ -100782,19 +105289,6 @@ "optional": true, "computed": true }, - { - "name": "worker_pool", - "type": "TypeString", - "description": "Workerpool name", - "immutable": true, - "required": true - }, - { - "name": "private_vlan_id", - "type": "TypeString", - "optional": true, - "computed": true - }, { "name": "resource_group_id", "type": "TypeString", @@ -100812,6 +105306,26 @@ "computed": true, "deprecated": "This field is deprecated" }, + { + "name": "zone", + "type": "TypeString", + "description": "Zone name", + "immutable": true, + "required": true + }, + { + "name": "worker_pool", + "type": "TypeString", + "description": "Workerpool name", + "immutable": true, + "required": true + }, + { + "name": "private_vlan_id", + "type": "TypeString", + "optional": true, + "computed": true + }, { "name": "worker_count", "type": "TypeInt", @@ -100835,73 +105349,38 @@ "optional": true }, { - "name": "storage_class", + "name": "region_location", "type": "TypeString", - "description": "Storage class info", + "description": "Region Location info.", "immutable": true, - "options": "standard,vault,cold,smart,flex,onerate_active", - "optional": true, - "computed": true + "optional": true }, { - "name": "s3_endpoint_private", + "name": "cross_region_location", "type": "TypeString", - "description": "Private endpoint for the COS bucket", - "computed": true - }, - { - "name": "abort_incomplete_multipart_upload_days", - "type": "TypeList", - "description": "Enable abort incomplete multipart upload to COS Bucket after a defined period of time", - "optional": true, - "elem": { - "days_after_initiation": { - "name": "days_after_initiation", - "type": "TypeInt", - "description": "Specifies the number of days when the specific rule action takes effect.", - "optional": true - }, - "enable": { - "name": "enable", - "type": "TypeBool", - "description": "Enable or disable rule for a bucket", - "required": true - }, - "prefix": { - "name": "prefix", - "type": "TypeString", - "description": "The rule applies to any objects with keys that match this prefix", - "optional": true, - "computed": true - }, - "rule_id": { - "name": "rule_id", - "type": "TypeString", - "description": "Unique identifier for the rule. Rules allow you to set a specific time frame after which objects are deleted. Set Rule ID for cos bucket", - "optional": true, - "computed": true - } - }, - "max_items": 1 + "description": "Cros region location info", + "immutable": true, + "options": "us,eu,ap", + "optional": true }, { - "name": "noncurrent_version_expiration", + "name": "abort_incomplete_multipart_upload_days", "type": "TypeList", - "description": "Enable configuration expire_rule to COS Bucket after a defined period of time", + "description": "Enable abort incomplete multipart upload to COS Bucket after a defined period of time", "optional": true, "elem": { + "days_after_initiation": { + "name": "days_after_initiation", + "type": "TypeInt", + "description": "Specifies the number of days when the specific rule action takes effect.", + "optional": true + }, "enable": { "name": "enable", "type": "TypeBool", - "description": "Enable or disable an expire rule for a bucket", + "description": "Enable or disable rule for a bucket", "required": true }, - "noncurrent_days": { - "name": "noncurrent_days", - "type": "TypeInt", - "description": "Specifies the number of days when the specific rule action takes effect.", - "optional": true - }, "prefix": { "name": "prefix", "type": "TypeString", @@ -100912,7 +105391,7 @@ "rule_id": { "name": "rule_id", "type": "TypeString", - "description": "Unique identifier for the rule.Expire rules allow you to set a specific time frame after which objects are deleted. Set Rule ID for cos bucket", + "description": "Unique identifier for the rule. Rules allow you to set a specific time frame after which objects are deleted. Set Rule ID for cos bucket", "optional": true, "computed": true } @@ -100920,31 +105399,40 @@ "max_items": 1 }, { - "name": "resource_instance_id", + "name": "kms_key_crn", "type": "TypeString", - "description": "resource instance ID", - "cloud_data_type": "resource_instance", + "description": "CRN of the key you want to use data at rest encryption", "immutable": true, - "required": true, - "matches": "^crn:.+:.+:.+:.+:.+:a\\/[0-9a-f]{32}:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\\:\\:$", - "cloud_data_range": [ - "service:cloud-object-storage" - ] - }, - { - "name": "s3_endpoint_public", - "type": "TypeString", - "description": "Public endpoint for the COS bucket", - "computed": true + "optional": true }, { - "name": "allowed_ip", + "name": "activity_tracking", "type": "TypeList", - "description": "List of IPv4 or IPv6 addresses", + "description": "Enables sending log data to Activity Tracker and LogDNA to provide visibility into object read and write events", "optional": true, "elem": { - "type": "TypeString" - } + "activity_tracker_crn": { + "name": "activity_tracker_crn", + "type": "TypeString", + "description": "The instance of Activity Tracker that will receive object event data", + "required": true + }, + "read_data_events": { + "name": "read_data_events", + "type": "TypeBool", + "description": "If set to true, all object read events will be sent to Activity Tracker.", + "default_value": false, + "optional": true + }, + "write_data_events": { + "name": "write_data_events", + "type": "TypeBool", + "description": "If set to true, all object write events will be sent to Activity Tracker.", + "default_value": false, + "optional": true + } + }, + "max_items": 1 }, { "name": "archive_rule", @@ -100980,18 +105468,37 @@ }, "max_items": 1 }, - { - "name": "hard_quota", - "type": "TypeInt", - "description": "sets a maximum amount of storage (in bytes) available for a bucket", - "optional": true - }, { "name": "object_lock", "type": "TypeBool", "description": "Enable objectlock for the bucket. When enabled, buckets within the container vault can have Object Lock Configuration applied to the bucket.", "optional": true }, + { + "name": "allowed_ip", + "type": "TypeList", + "description": "List of IPv4 or IPv6 addresses", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "object_versioning", + "type": "TypeList", + "description": "Protect objects from accidental deletion or overwrites. Versioning allows you to keep multiple versions of an object protecting from unintentional data loss.", + "optional": true, + "elem": { + "enable": { + "name": "enable", + "type": "TypeBool", + "description": "Enable or suspend the versioning for objects in the bucket", + "default_value": false, + "optional": true + } + }, + "max_items": 1 + }, { "name": "bucket_name", "type": "TypeString", @@ -101000,37 +105507,77 @@ "required": true }, { - "name": "region_location", + "name": "resource_instance_id", "type": "TypeString", - "description": "Region Location info.", + "description": "resource instance ID", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true, + "matches": "^crn:.+:.+:.+:.+:.+:a\\/[0-9a-f]{32}:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\\:\\:$", + "cloud_data_range": [ + "service:cloud-object-storage" + ] + }, + { + "name": "storage_class", + "type": "TypeString", + "description": "Storage class info", "immutable": true, + "options": "standard,vault,cold,smart,flex,onerate_active", + "optional": true, + "computed": true + }, + { + "name": "endpoint_type", + "type": "TypeString", + "description": "public or private", + "default_value": "public", + "options": "public,private,direct", "optional": true }, { - "name": "metrics_monitoring", + "name": "s3_endpoint_private", + "type": "TypeString", + "description": "Private endpoint for the COS bucket", + "computed": true + }, + { + "name": "s3_endpoint_direct", + "type": "TypeString", + "description": "Direct endpoint for the COS bucket", + "computed": true + }, + { + "name": "noncurrent_version_expiration", "type": "TypeList", - "description": "Enables sending metrics to IBM Cloud Monitoring.", + "description": "Enable configuration expire_rule to COS Bucket after a defined period of time", "optional": true, "elem": { - "metrics_monitoring_crn": { - "name": "metrics_monitoring_crn", - "type": "TypeString", - "description": "Instance of IBM Cloud Monitoring that will receive the bucket metrics.", + "enable": { + "name": "enable", + "type": "TypeBool", + "description": "Enable or disable an expire rule for a bucket", "required": true }, - "request_metrics_enabled": { - "name": "request_metrics_enabled", - "type": "TypeBool", - "description": "Request metrics will be sent to the monitoring service.", - "default_value": false, + "noncurrent_days": { + "name": "noncurrent_days", + "type": "TypeInt", + "description": "Specifies the number of days when the specific rule action takes effect.", "optional": true }, - "usage_metrics_enabled": { - "name": "usage_metrics_enabled", - "type": "TypeBool", - "description": "Usage metrics will be sent to the monitoring service.", - "default_value": false, - "optional": true + "prefix": { + "name": "prefix", + "type": "TypeString", + "description": "The rule applies to any objects with keys that match this prefix", + "optional": true, + "computed": true + }, + "rule_id": { + "name": "rule_id", + "type": "TypeString", + "description": "Unique identifier for the rule.Expire rules allow you to set a specific time frame after which objects are deleted. Set Rule ID for cos bucket", + "optional": true, + "computed": true } }, "max_items": 1 @@ -101071,20 +105618,10 @@ "max_items": 1 }, { - "name": "object_versioning", - "type": "TypeList", - "description": "Protect objects from accidental deletion or overwrites. Versioning allows you to keep multiple versions of an object protecting from unintentional data loss.", - "optional": true, - "elem": { - "enable": { - "name": "enable", - "type": "TypeBool", - "description": "Enable or suspend the versioning for objects in the bucket", - "default_value": false, - "optional": true - } - }, - "max_items": 1 + "name": "hard_quota", + "type": "TypeInt", + "description": "sets a maximum amount of storage (in bytes) available for a bucket", + "optional": true }, { "name": "crn", @@ -101100,13 +105637,6 @@ "immutable": true, "optional": true }, - { - "name": "kms_key_crn", - "type": "TypeString", - "description": "CRN of the key you want to use data at rest encryption", - "immutable": true, - "optional": true - }, { "name": "satellite_location_id", "type": "TypeString", @@ -101115,50 +105645,34 @@ "optional": true }, { - "name": "cross_region_location", - "type": "TypeString", - "description": "Cros region location info", - "immutable": true, - "options": "us,eu,ap", - "optional": true - }, - { - "name": "endpoint_type", - "type": "TypeString", - "description": "public or private", - "default_value": "public", - "options": "public,private,direct", - "optional": true - }, - { - "name": "s3_endpoint_direct", + "name": "s3_endpoint_public", "type": "TypeString", - "description": "Direct endpoint for the COS bucket", + "description": "Public endpoint for the COS bucket", "computed": true }, { - "name": "activity_tracking", + "name": "metrics_monitoring", "type": "TypeList", - "description": "Enables sending log data to Activity Tracker and LogDNA to provide visibility into object read and write events", + "description": "Enables sending metrics to IBM Cloud Monitoring.", "optional": true, "elem": { - "activity_tracker_crn": { - "name": "activity_tracker_crn", + "metrics_monitoring_crn": { + "name": "metrics_monitoring_crn", "type": "TypeString", - "description": "The instance of Activity Tracker that will receive object event data", + "description": "Instance of IBM Cloud Monitoring that will receive the bucket metrics.", "required": true }, - "read_data_events": { - "name": "read_data_events", + "request_metrics_enabled": { + "name": "request_metrics_enabled", "type": "TypeBool", - "description": "If set to true, all object read events will be sent to Activity Tracker.", + "description": "Request metrics will be sent to the monitoring service.", "default_value": false, "optional": true }, - "write_data_events": { - "name": "write_data_events", + "usage_metrics_enabled": { + "name": "usage_metrics_enabled", "type": "TypeBool", - "description": "If set to true, all object write events will be sent to Activity Tracker.", + "description": "Usage metrics will be sent to the monitoring service.", "default_value": false, "optional": true } @@ -101222,15 +105736,11 @@ ], "ibm_cos_bucket_object": [ { - "name": "version_id", - "type": "TypeString", - "computed": true - }, - { - "name": "object_sql_url", - "type": "TypeString", - "description": "Access the object using an SQL Query instance.The reference url is used to perform queries against objects storing structured data.", - "computed": true + "name": "force_delete", + "type": "TypeBool", + "description": "COS buckets need to be empty before they can be deleted. force_delete option empty the bucket and delete it.", + "default_value": true, + "optional": true }, { "name": "object_lock_retain_until_date", @@ -101239,22 +105749,10 @@ "optional": true }, { - "name": "content", - "type": "TypeString", - "description": "COS object content", - "optional": true - }, - { - "name": "content_base64", - "type": "TypeString", - "description": "COS object content in base64 encoding", - "optional": true - }, - { - "name": "content_file", + "name": "last_modified", "type": "TypeString", - "description": "COS object content file path", - "optional": true + "description": "COS object last modified date", + "computed": true }, { "name": "content_length", @@ -101263,47 +105761,52 @@ "computed": true }, { - "name": "etag", + "name": "object_sql_url", "type": "TypeString", - "description": "COS object MD5 hexdigest", - "optional": true, + "description": "Access the object using an SQL Query instance.The reference url is used to perform queries against objects storing structured data.", "computed": true }, { - "name": "endpoint_type", + "name": "object_lock_legal_hold_status", "type": "TypeString", - "description": "COS endpoint type: public, private, direct", - "default_value": "public", + "description": "An object lock configuration on the object, the valid states are ON/OFF. When ON prevents deletion of the object version.", "optional": true }, { - "name": "object_lock_legal_hold_status", + "name": "website_redirect", "type": "TypeString", - "description": "An object lock configuration on the object, the valid states are ON/OFF. When ON prevents deletion of the object version.", + "description": "Redirect a request to another object or an URL", "optional": true }, { - "name": "content_type", + "name": "content", "type": "TypeString", - "description": "COS object content type", - "computed": true + "description": "COS object content", + "optional": true }, { - "name": "last_modified", + "name": "bucket_location", "type": "TypeString", - "description": "COS object last modified date", - "computed": true + "description": "COS bucket location", + "immutable": true, + "required": true }, { - "name": "object_lock_mode", + "name": "content_file", "type": "TypeString", - "description": "Retention modes apply different levels of protection to the objects.", + "description": "COS object content file path", "optional": true }, { - "name": "body", + "name": "etag", + "type": "TypeString", + "description": "COS object MD5 hexdigest", + "optional": true, + "computed": true + }, + { + "name": "version_id", "type": "TypeString", - "description": "COS object body", "computed": true }, { @@ -101314,49 +105817,45 @@ "required": true }, { - "name": "bucket_location", + "name": "content_base64", "type": "TypeString", - "description": "COS bucket location", - "immutable": true, - "required": true + "description": "COS object content in base64 encoding", + "optional": true }, { - "name": "key", + "name": "content_type", "type": "TypeString", - "description": "COS object key", - "immutable": true, - "required": true + "description": "COS object content type", + "computed": true }, { - "name": "force_delete", - "type": "TypeBool", - "description": "COS buckets need to be empty before they can be deleted. force_delete option empty the bucket and delete it.", - "default_value": true, - "optional": true - } - ], - "ibm_cos_bucket_object_lock_configuration": [ - { - "name": "bucket_crn", + "name": "endpoint_type", "type": "TypeString", - "description": "COS bucket CRN", - "immutable": true, - "required": true + "description": "COS endpoint type: public, private, direct", + "default_value": "public", + "optional": true }, { - "name": "bucket_location", + "name": "key", "type": "TypeString", - "description": "COS bucket location", + "description": "COS object key", "immutable": true, "required": true }, { - "name": "endpoint_type", + "name": "object_lock_mode", "type": "TypeString", - "description": "COS endpoint type: public, private, direct", - "default_value": "public", + "description": "Retention modes apply different levels of protection to the objects.", "optional": true }, + { + "name": "body", + "type": "TypeString", + "description": "COS object body", + "computed": true + } + ], + "ibm_cos_bucket_object_lock_configuration": [ { "name": "object_lock_configuration", "type": "TypeList", @@ -101406,6 +105905,27 @@ } }, "max_items": 1 + }, + { + "name": "bucket_crn", + "type": "TypeString", + "description": "COS bucket CRN", + "immutable": true, + "required": true + }, + { + "name": "bucket_location", + "type": "TypeString", + "description": "COS bucket location", + "immutable": true, + "required": true + }, + { + "name": "endpoint_type", + "type": "TypeString", + "description": "COS endpoint type: public, private, direct", + "default_value": "public", + "optional": true } ], "ibm_cos_bucket_replication_rule": [ @@ -101478,21 +105998,190 @@ "max_items": 1000 } ], + "ibm_cos_bucket_website_configuration": [ + { + "name": "bucket_location", + "type": "TypeString", + "description": "COS bucket location", + "immutable": true, + "required": true + }, + { + "name": "endpoint_type", + "type": "TypeString", + "description": "COS endpoint type: public, private, direct", + "default_value": "public", + "optional": true + }, + { + "name": "website_configuration", + "type": "TypeList", + "description": "Configuration for Hosting a static website on COS with public access.", + "required": true, + "elem": { + "error_document": { + "name": "error_document", + "type": "TypeList", + "description": "This is returned when an error occurs.", + "optional": true, + "elem": { + "key": { + "name": "key", + "type": "TypeString", + "required": true + } + }, + "max_items": 1 + }, + "index_document": { + "name": "index_document", + "type": "TypeList", + "description": "Home or the default page of the website.", + "optional": true, + "elem": { + "suffix": { + "name": "suffix", + "type": "TypeString", + "required": true + } + }, + "max_items": 1 + }, + "redirect_all_requests_to": { + "name": "redirect_all_requests_to", + "type": "TypeList", + "description": "Redirect requests can be set to specific page documents, individual routing rules, or redirect all requests globally to one bucket or domain.", + "optional": true, + "elem": { + "host_name": { + "name": "host_name", + "type": "TypeString", + "required": true + }, + "protocol": { + "name": "protocol", + "type": "TypeString", + "optional": true + } + }, + "max_items": 1 + }, + "routing_rule": { + "name": "routing_rule", + "type": "TypeList", + "description": "Rules that define when a redirect is applied and the redirect behavior.", + "optional": true, + "computed": true, + "elem": { + "condition": { + "name": "condition", + "type": "TypeList", + "description": "A condition that must be met for the specified redirect to be applie.", + "optional": true, + "elem": { + "http_error_code_returned_equals": { + "name": "http_error_code_returned_equals", + "type": "TypeString", + "description": "The HTTP error code when the redirect is applied. Valid codes are 4XX or 5XX..", + "optional": true + }, + "key_prefix_equals": { + "name": "key_prefix_equals", + "type": "TypeString", + "description": "The object key name prefix when the redirect is applied..", + "optional": true + } + }, + "max_items": 1 + }, + "redirect": { + "name": "redirect", + "type": "TypeList", + "description": ".", + "required": true, + "elem": { + "host_name": { + "name": "host_name", + "type": "TypeString", + "description": "The host name the request should be redirected to.", + "optional": true + }, + "http_redirect_code": { + "name": "http_redirect_code", + "type": "TypeString", + "description": "The HTTP redirect code to use on the response. Valid codes are 3XX except 300..", + "optional": true + }, + "protocol": { + "name": "protocol", + "type": "TypeString", + "description": "Protocol to be used in the Location header that is returned in the response.", + "optional": true + }, + "replace_key_prefix_with": { + "name": "replace_key_prefix_with", + "type": "TypeString", + "description": "The prefix of the object key name that replaces the value of KeyPrefixEquals in the redirect request.", + "optional": true + }, + "replace_key_with": { + "name": "replace_key_with", + "type": "TypeString", + "description": "The object key to be used in the Location header that is returned in the response.", + "optional": true + } + }, + "max_items": 1 + } + } + }, + "routing_rules": { + "name": "routing_rules", + "type": "TypeString", + "description": "Rules that define when a redirect is applied and the redirect behavior.", + "optional": true, + "computed": true + } + }, + "max_items": 1 + }, + { + "name": "website_endpoint", + "type": "TypeString", + "computed": true + }, + { + "name": "bucket_crn", + "type": "TypeString", + "description": "COS bucket CRN", + "immutable": true, + "required": true + } + ], "ibm_cr_namespace": [ { - "name": "crn", + "name": "resource_created_date", "type": "TypeString", - "description": "If the namespace has been assigned to a resource group, this is the IBM Cloud CRN representing the namespace.", - "cloud_data_type": "crn", + "description": "When the namespace was assigned to a resource group.", "computed": true }, { - "name": "created_on", + "name": "updated_on", "type": "TypeString", - "description": "When the namespace was created.", + "description": "When the namespace was last updated.", "computed": true, "deprecated": "This field is deprecated" }, + { + "name": "name", + "type": "TypeString", + "description": "The name of the namespace.", + "immutable": true, + "required": true, + "min_length": 4, + "max_length": 30, + "matches": "^[a-z0-9]+[a-z0-9_-]+[a-z0-9]+$" + }, { "name": "resource_group_id", "type": "TypeString", @@ -101512,12 +106201,6 @@ "type": "TypeString" } }, - { - "name": "account", - "type": "TypeString", - "description": "The IBM Cloud account that owns the namespace.", - "computed": true - }, { "name": "created_date", "type": "TypeString", @@ -101525,19 +106208,16 @@ "computed": true }, { - "name": "name", + "name": "account", "type": "TypeString", - "description": "The name of the namespace.", - "immutable": true, - "required": true, - "min_length": 4, - "max_length": 30, - "matches": "^[a-z0-9]+[a-z0-9_-]+[a-z0-9]+$" + "description": "The IBM Cloud account that owns the namespace.", + "computed": true }, { - "name": "resource_created_date", + "name": "crn", "type": "TypeString", - "description": "When the namespace was assigned to a resource group.", + "description": "If the namespace has been assigned to a resource group, this is the IBM Cloud CRN representing the namespace.", + "cloud_data_type": "crn", "computed": true }, { @@ -101547,9 +106227,9 @@ "computed": true }, { - "name": "updated_on", + "name": "created_on", "type": "TypeString", - "description": "When the namespace was last updated.", + "description": "When the namespace was created.", "computed": true, "deprecated": "This field is deprecated" } @@ -101577,96 +106257,70 @@ ], "ibm_database": [ { - "name": "adminpassword", + "name": "resource_group_name", "type": "TypeString", - "description": "The admin user password for the instance", - "secure": true, + "description": "The resource group name in which resource is provisioned", + "computed": true + }, + { + "name": "resource_controller_url", + "type": "TypeString", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource", + "computed": true + }, + { + "name": "plan_validation", + "type": "TypeBool", + "description": "For elasticsearch and postgres perform database parameter validation during the plan phase. Otherwise, database parameter validation happens in apply phase.", + "default_value": true, "optional": true }, { - "name": "version", + "name": "remote_leader_id", "type": "TypeString", - "description": "The database version to provision if specified", + "description": "The CRN of leader database", + "optional": true + }, + { + "name": "backup_encryption_key_crn", + "type": "TypeString", + "description": "The Backup Encryption Key CRN", "immutable": true, - "optional": true, - "computed": true + "optional": true }, { - "name": "group", + "name": "users", "type": "TypeSet", "optional": true, "elem": { - "cpu": { - "name": "cpu", - "type": "TypeSet", - "optional": true, - "elem": { - "allocation_count": { - "name": "allocation_count", - "type": "TypeInt", - "required": true - } - }, - "max_items": 1 - }, - "disk": { - "name": "disk", - "type": "TypeSet", - "optional": true, - "elem": { - "allocation_mb": { - "name": "allocation_mb", - "type": "TypeInt", - "required": true - } - }, - "max_items": 1 + "name": { + "name": "name", + "type": "TypeString", + "description": "User name", + "required": true }, - "group_id": { - "name": "group_id", + "password": { + "name": "password", "type": "TypeString", + "description": "User password", + "secure": true, "required": true }, - "members": { - "name": "members", - "type": "TypeSet", - "optional": true, - "elem": { - "allocation_count": { - "name": "allocation_count", - "type": "TypeInt", - "required": true - } - }, - "max_items": 1 + "role": { + "name": "role", + "type": "TypeString", + "description": "User role. Only available for ops_manager user type.", + "optional": true }, - "memory": { - "name": "memory", - "type": "TypeSet", - "optional": true, - "elem": { - "allocation_mb": { - "name": "allocation_mb", - "type": "TypeInt", - "required": true - } - }, - "max_items": 1 + "type": { + "name": "type", + "type": "TypeString", + "description": "User type", + "default_value": "database", + "optional": true } } }, - { - "name": "resource_name", - "type": "TypeString", - "description": "The name of the resource", - "computed": true - }, - { - "name": "resource_controller_url", - "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource", - "computed": true - }, { "name": "connectionstrings", "type": "TypeList", @@ -101761,94 +106415,329 @@ "deprecated": "This field is deprecated, please use ibm_database_connection instead" }, { - "name": "allowlist", - "type": "TypeSet", + "name": "auto_scaling", + "type": "TypeList", + "description": "ICD Auto Scaling", "optional": true, + "computed": true, "elem": { - "address": { - "name": "address", - "type": "TypeString", - "description": "Allowlist IP address in CIDR notation", - "optional": true + "cpu": { + "name": "cpu", + "type": "TypeList", + "description": "CPU Auto Scaling", + "optional": true, + "computed": true, + "elem": { + "rate_increase_percent": { + "name": "rate_increase_percent", + "type": "TypeInt", + "description": "Auto Scaling Rate: Increase Percent", + "optional": true, + "computed": true + }, + "rate_limit_count_per_member": { + "name": "rate_limit_count_per_member", + "type": "TypeInt", + "description": "Auto Scaling Rate: Limit count per number", + "optional": true, + "computed": true + }, + "rate_period_seconds": { + "name": "rate_period_seconds", + "type": "TypeInt", + "description": "Auto Scaling Rate: Period Seconds", + "optional": true, + "computed": true + }, + "rate_units": { + "name": "rate_units", + "type": "TypeString", + "description": "Auto Scaling Rate: Units", + "optional": true, + "computed": true + } + }, + "max_items": 1, + "deprecated": "This field is deprecated, auto scaling cpu is unsupported by IBM Cloud Databases" }, - "description": { - "name": "description", - "type": "TypeString", - "description": "Unique allow list description", - "optional": true + "disk": { + "name": "disk", + "type": "TypeList", + "description": "Disk Auto Scaling", + "optional": true, + "computed": true, + "elem": { + "capacity_enabled": { + "name": "capacity_enabled", + "type": "TypeBool", + "description": "Auto Scaling Scalar: Capacity Enabled", + "optional": true, + "computed": true + }, + "free_space_less_than_percent": { + "name": "free_space_less_than_percent", + "type": "TypeInt", + "description": "Auto Scaling Scalar: Capacity Free Space Less Than Percent", + "optional": true, + "computed": true + }, + "io_above_percent": { + "name": "io_above_percent", + "type": "TypeInt", + "description": "Auto Scaling Scalar: IO Utilization Above Percent", + "optional": true, + "computed": true + }, + "io_enabled": { + "name": "io_enabled", + "type": "TypeBool", + "description": "Auto Scaling Scalar: IO Utilization Enabled", + "optional": true, + "computed": true + }, + "io_over_period": { + "name": "io_over_period", + "type": "TypeString", + "description": "Auto Scaling Scalar: IO Utilization Over Period", + "optional": true, + "computed": true + }, + "rate_increase_percent": { + "name": "rate_increase_percent", + "type": "TypeInt", + "description": "Auto Scaling Rate: Increase Percent", + "optional": true, + "computed": true + }, + "rate_limit_mb_per_member": { + "name": "rate_limit_mb_per_member", + "type": "TypeInt", + "description": "Auto Scaling Rate: Limit mb per member", + "optional": true, + "computed": true + }, + "rate_period_seconds": { + "name": "rate_period_seconds", + "type": "TypeInt", + "description": "Auto Scaling Rate: Period Seconds", + "optional": true, + "computed": true + }, + "rate_units": { + "name": "rate_units", + "type": "TypeString", + "description": "Auto Scaling Rate: Units", + "optional": true, + "computed": true + } + }, + "max_items": 1 + }, + "memory": { + "name": "memory", + "type": "TypeList", + "description": "Memory Auto Scaling", + "optional": true, + "computed": true, + "elem": { + "io_above_percent": { + "name": "io_above_percent", + "type": "TypeInt", + "description": "Auto Scaling Scalar: IO Utilization Above Percent", + "optional": true, + "computed": true + }, + "io_enabled": { + "name": "io_enabled", + "type": "TypeBool", + "description": "Auto Scaling Scalar: IO Utilization Enabled", + "optional": true, + "computed": true + }, + "io_over_period": { + "name": "io_over_period", + "type": "TypeString", + "description": "Auto Scaling Scalar: IO Utilization Over Period", + "optional": true, + "computed": true + }, + "rate_increase_percent": { + "name": "rate_increase_percent", + "type": "TypeInt", + "description": "Auto Scaling Rate: Increase Percent", + "optional": true, + "computed": true + }, + "rate_limit_mb_per_member": { + "name": "rate_limit_mb_per_member", + "type": "TypeInt", + "description": "Auto Scaling Rate: Limit mb per member", + "optional": true, + "computed": true + }, + "rate_period_seconds": { + "name": "rate_period_seconds", + "type": "TypeInt", + "description": "Auto Scaling Rate: Period Seconds", + "optional": true, + "computed": true + }, + "rate_units": { + "name": "rate_units", + "type": "TypeString", + "description": "Auto Scaling Rate: Units", + "optional": true, + "computed": true + } + }, + "max_items": 1 } - } - }, - { - "name": "configuration_schema", - "type": "TypeString", - "description": "The configuration schema in JSON format", - "computed": true + }, + "max_items": 1 }, { - "name": "members_disk_allocation_mb", + "name": "members_memory_allocation_mb", "type": "TypeInt", - "description": "Disk allocation required for cluster", + "description": "Memory allocation required for cluster", "optional": true, "computed": true, "deprecated": "use group instead" }, { - "name": "node_memory_allocation_mb", + "name": "members_cpu_allocation_count", "type": "TypeInt", - "description": "Memory allocation per node", + "description": "CPU allocation required for cluster", "optional": true, "computed": true, "deprecated": "use group instead" }, { - "name": "plan_validation", - "type": "TypeBool", - "description": "For elasticsearch and postgres perform database parameter validation during the plan phase. Otherwise, database parameter validation happens in apply phase.", - "default_value": true, - "optional": true + "name": "tags", + "type": "TypeSet", + "min_length": 1, + "max_length": 128, + "matches": "^[A-Za-z0-9:_ .-]+$", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "service_endpoints", + "name": "point_in_time_recovery_deployment_id", "type": "TypeString", - "description": "Types of the service endpoints. Possible values are 'public', 'private', 'public-and-private'.", - "default_value": "public", - "options": "public, private, public-and-private", + "description": "The CRN of source instance", "optional": true }, { - "name": "users", + "name": "status", + "type": "TypeString", + "description": "The resource instance status", + "computed": true + }, + { + "name": "guid", + "type": "TypeString", + "description": "Unique identifier of resource instance", + "computed": true + }, + { + "name": "resource_crn", + "type": "TypeString", + "description": "The crn of the resource", + "computed": true + }, + { + "name": "location", + "type": "TypeString", + "description": "The location or the region in which Database instance exists", + "cloud_data_type": "region", + "required": true + }, + { + "name": "service", + "type": "TypeString", + "description": "The name of the Cloud Internet database service", + "immutable": true, + "required": true, + "options": "databases-for-etcd, databases-for-postgresql, databases-for-redis, databases-for-elasticsearch, databases-for-mongodb, messages-for-rabbitmq, databases-for-mysql, databases-for-cassandra, databases-for-enterprisedb" + }, + { + "name": "adminuser", + "type": "TypeString", + "description": "The admin user id for the instance", + "computed": true + }, + { + "name": "group", "type": "TypeSet", "optional": true, "elem": { - "name": { - "name": "name", - "type": "TypeString", - "description": "User name", - "required": true + "cpu": { + "name": "cpu", + "type": "TypeSet", + "optional": true, + "elem": { + "allocation_count": { + "name": "allocation_count", + "type": "TypeInt", + "required": true + } + }, + "max_items": 1 }, - "password": { - "name": "password", + "disk": { + "name": "disk", + "type": "TypeSet", + "optional": true, + "elem": { + "allocation_mb": { + "name": "allocation_mb", + "type": "TypeInt", + "required": true + } + }, + "max_items": 1 + }, + "group_id": { + "name": "group_id", "type": "TypeString", - "description": "User password", - "secure": true, "required": true }, - "role": { - "name": "role", - "type": "TypeString", - "description": "User role. Only available for ops_manager user type.", - "optional": true + "members": { + "name": "members", + "type": "TypeSet", + "optional": true, + "elem": { + "allocation_count": { + "name": "allocation_count", + "type": "TypeInt", + "required": true + } + }, + "max_items": 1 }, - "type": { - "name": "type", - "type": "TypeString", - "description": "User type", - "default_value": "database", - "optional": true + "memory": { + "name": "memory", + "type": "TypeSet", + "optional": true, + "elem": { + "allocation_mb": { + "name": "allocation_mb", + "type": "TypeInt", + "required": true + } + }, + "max_items": 1 } } }, + { + "name": "name", + "type": "TypeString", + "description": "Resource instance name for example, my Database instance", + "required": true + }, { "name": "logical_replication_slot", "type": "TypeSet", @@ -101875,11 +106764,37 @@ } }, { - "name": "resource_status", + "name": "version", "type": "TypeString", - "description": "The status of the resource", + "description": "The database version to provision if specified", + "immutable": true, + "optional": true, "computed": true }, + { + "name": "members_disk_allocation_mb", + "type": "TypeInt", + "description": "Disk allocation required for cluster", + "optional": true, + "computed": true, + "deprecated": "use group instead" + }, + { + "name": "node_count", + "type": "TypeInt", + "description": "Total number of nodes in the cluster", + "optional": true, + "computed": true, + "deprecated": "use group instead" + }, + { + "name": "node_memory_allocation_mb", + "type": "TypeInt", + "description": "Memory allocation per node", + "optional": true, + "computed": true, + "deprecated": "use group instead" + }, { "name": "resource_group_id", "type": "TypeString", @@ -101893,34 +106808,51 @@ ] }, { - "name": "members_memory_allocation_mb", - "type": "TypeInt", - "description": "Memory allocation required for cluster", - "optional": true, - "computed": true, - "deprecated": "use group instead" + "name": "plan", + "type": "TypeString", + "description": "The plan type of the Database instance", + "immutable": true, + "required": true, + "options": "standard, enterprise, enterprise-sharding" }, { - "name": "node_cpu_allocation_count", - "type": "TypeInt", - "description": "CPU allocation per node", - "optional": true, - "computed": true, - "deprecated": "use group instead" + "name": "adminpassword", + "type": "TypeString", + "description": "The admin user password for the instance", + "secure": true, + "optional": true }, { - "name": "remote_leader_id", + "name": "configuration_schema", "type": "TypeString", - "description": "The CRN of leader database", - "optional": true + "description": "The configuration schema in JSON format", + "computed": true }, { - "name": "key_protect_instance", + "name": "point_in_time_recovery_time", "type": "TypeString", - "description": "The CRN of Key protect instance", - "immutable": true, + "description": "The point in time recovery time stamp of the deployed instance", "optional": true }, + { + "name": "allowlist", + "type": "TypeSet", + "optional": true, + "elem": { + "address": { + "name": "address", + "type": "TypeString", + "description": "Allowlist IP address in CIDR notation", + "optional": true + }, + "description": { + "name": "description", + "type": "TypeString", + "description": "Unique allow list description", + "optional": true + } + } + }, { "name": "groups", "type": "TypeList", @@ -102070,340 +107002,103 @@ } }, { - "name": "service", - "type": "TypeString", - "description": "The name of the Cloud Internet database service", - "immutable": true, - "required": true, - "options": "databases-for-etcd, databases-for-postgresql, databases-for-redis, databases-for-elasticsearch, databases-for-mongodb, messages-for-rabbitmq, databases-for-mysql, databases-for-cassandra, databases-for-enterprisedb" - }, - { - "name": "configuration", - "type": "TypeString", - "description": "The configuration in JSON format", - "optional": true - }, - { - "name": "backup_id", - "type": "TypeString", - "description": "The CRN of backup source database", - "optional": true - }, - { - "name": "key_protect_key", - "type": "TypeString", - "description": "The CRN of Key protect key", - "immutable": true, - "optional": true - }, - { - "name": "resource_crn", - "type": "TypeString", - "description": "The crn of the resource", - "computed": true - }, - { - "name": "status", + "name": "resource_name", "type": "TypeString", - "description": "The resource instance status", + "description": "The name of the resource", "computed": true }, { - "name": "point_in_time_recovery_deployment_id", - "type": "TypeString", - "description": "The CRN of source instance", - "optional": true - }, - { - "name": "members_cpu_allocation_count", + "name": "node_disk_allocation_mb", "type": "TypeInt", - "description": "CPU allocation required for cluster", + "description": "Disk allocation per node", "optional": true, "computed": true, "deprecated": "use group instead" }, { - "name": "node_count", + "name": "node_cpu_allocation_count", "type": "TypeInt", - "description": "Total number of nodes in the cluster", + "description": "CPU allocation per node", "optional": true, "computed": true, "deprecated": "use group instead" }, { - "name": "node_disk_allocation_mb", - "type": "TypeInt", - "description": "Disk allocation per node", - "optional": true, - "computed": true, - "deprecated": "use group instead" + "name": "backup_id", + "type": "TypeString", + "description": "The CRN of backup source database", + "optional": true }, { - "name": "backup_encryption_key_crn", + "name": "key_protect_key", "type": "TypeString", - "description": "The Backup Encryption Key CRN", + "description": "The CRN of Key protect key", "immutable": true, "optional": true }, { - "name": "tags", - "type": "TypeSet", - "min_length": 1, - "max_length": 128, - "matches": "^[A-Za-z0-9:_ .-]+$", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "configuration", + "type": "TypeString", + "description": "The configuration in JSON format", + "optional": true }, { - "name": "plan", + "name": "service_endpoints", "type": "TypeString", - "description": "The plan type of the Database instance", - "immutable": true, - "required": true, - "options": "standard, enterprise, enterprise-sharding" + "description": "Types of the service endpoints. Possible values are 'public', 'private', 'public-and-private'.", + "default_value": "public", + "options": "public, private, public-and-private", + "optional": true }, { - "name": "guid", + "name": "key_protect_instance", "type": "TypeString", - "description": "Unique identifier of resource instance", - "computed": true + "description": "The CRN of Key protect instance", + "immutable": true, + "optional": true }, { - "name": "adminuser", + "name": "resource_status", "type": "TypeString", - "description": "The admin user id for the instance", + "description": "The status of the resource", "computed": true - }, + } + ], + "ibm_dl_gateway": [ { - "name": "point_in_time_recovery_time", + "name": "bfd_status", "type": "TypeString", - "description": "The point in time recovery time stamp of the deployed instance", - "optional": true - }, - { - "name": "auto_scaling", - "type": "TypeList", - "description": "ICD Auto Scaling", + "description": "Gateway BFD status", "optional": true, - "computed": true, - "elem": { - "cpu": { - "name": "cpu", - "type": "TypeList", - "description": "CPU Auto Scaling", - "optional": true, - "computed": true, - "elem": { - "rate_increase_percent": { - "name": "rate_increase_percent", - "type": "TypeInt", - "description": "Auto Scaling Rate: Increase Percent", - "optional": true, - "computed": true - }, - "rate_limit_count_per_member": { - "name": "rate_limit_count_per_member", - "type": "TypeInt", - "description": "Auto Scaling Rate: Limit count per number", - "optional": true, - "computed": true - }, - "rate_period_seconds": { - "name": "rate_period_seconds", - "type": "TypeInt", - "description": "Auto Scaling Rate: Period Seconds", - "optional": true, - "computed": true - }, - "rate_units": { - "name": "rate_units", - "type": "TypeString", - "description": "Auto Scaling Rate: Units", - "optional": true, - "computed": true - } - }, - "max_items": 1, - "deprecated": "This field is deprecated, auto scaling cpu is unsupported by IBM Cloud Databases" - }, - "disk": { - "name": "disk", - "type": "TypeList", - "description": "Disk Auto Scaling", - "optional": true, - "computed": true, - "elem": { - "capacity_enabled": { - "name": "capacity_enabled", - "type": "TypeBool", - "description": "Auto Scaling Scalar: Capacity Enabled", - "optional": true, - "computed": true - }, - "free_space_less_than_percent": { - "name": "free_space_less_than_percent", - "type": "TypeInt", - "description": "Auto Scaling Scalar: Capacity Free Space Less Than Percent", - "optional": true, - "computed": true - }, - "io_above_percent": { - "name": "io_above_percent", - "type": "TypeInt", - "description": "Auto Scaling Scalar: IO Utilization Above Percent", - "optional": true, - "computed": true - }, - "io_enabled": { - "name": "io_enabled", - "type": "TypeBool", - "description": "Auto Scaling Scalar: IO Utilization Enabled", - "optional": true, - "computed": true - }, - "io_over_period": { - "name": "io_over_period", - "type": "TypeString", - "description": "Auto Scaling Scalar: IO Utilization Over Period", - "optional": true, - "computed": true - }, - "rate_increase_percent": { - "name": "rate_increase_percent", - "type": "TypeInt", - "description": "Auto Scaling Rate: Increase Percent", - "optional": true, - "computed": true - }, - "rate_limit_mb_per_member": { - "name": "rate_limit_mb_per_member", - "type": "TypeInt", - "description": "Auto Scaling Rate: Limit mb per member", - "optional": true, - "computed": true - }, - "rate_period_seconds": { - "name": "rate_period_seconds", - "type": "TypeInt", - "description": "Auto Scaling Rate: Period Seconds", - "optional": true, - "computed": true - }, - "rate_units": { - "name": "rate_units", - "type": "TypeString", - "description": "Auto Scaling Rate: Units", - "optional": true, - "computed": true - } - }, - "max_items": 1 - }, - "memory": { - "name": "memory", - "type": "TypeList", - "description": "Memory Auto Scaling", - "optional": true, - "computed": true, - "elem": { - "io_above_percent": { - "name": "io_above_percent", - "type": "TypeInt", - "description": "Auto Scaling Scalar: IO Utilization Above Percent", - "optional": true, - "computed": true - }, - "io_enabled": { - "name": "io_enabled", - "type": "TypeBool", - "description": "Auto Scaling Scalar: IO Utilization Enabled", - "optional": true, - "computed": true - }, - "io_over_period": { - "name": "io_over_period", - "type": "TypeString", - "description": "Auto Scaling Scalar: IO Utilization Over Period", - "optional": true, - "computed": true - }, - "rate_increase_percent": { - "name": "rate_increase_percent", - "type": "TypeInt", - "description": "Auto Scaling Rate: Increase Percent", - "optional": true, - "computed": true - }, - "rate_limit_mb_per_member": { - "name": "rate_limit_mb_per_member", - "type": "TypeInt", - "description": "Auto Scaling Rate: Limit mb per member", - "optional": true, - "computed": true - }, - "rate_period_seconds": { - "name": "rate_period_seconds", - "type": "TypeInt", - "description": "Auto Scaling Rate: Period Seconds", - "optional": true, - "computed": true - }, - "rate_units": { - "name": "rate_units", - "type": "TypeString", - "description": "Auto Scaling Rate: Units", - "optional": true, - "computed": true - } - }, - "max_items": 1 - } - }, - "max_items": 1 + "computed": true }, { "name": "name", "type": "TypeString", - "description": "Resource instance name for example, my Database instance", - "required": true - }, - { - "name": "location", - "type": "TypeString", - "description": "The location or the region in which Database instance exists", - "cloud_data_type": "region", - "required": true + "description": "The unique user-defined name for this gateway", + "required": true, + "min_length": 1, + "max_length": 63, + "matches": "^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$" }, { - "name": "resource_group_name", - "type": "TypeString", - "description": "The resource group name in which resource is provisioned", - "computed": true - } - ], - "ibm_dl_gateway": [ - { - "name": "resource_group", + "name": "bgp_status_updated_at", "type": "TypeString", - "description": "Gateway resource group", - "cloud_data_type": "resource_group", - "immutable": true, - "optional": true, + "description": "Date and time BGP status was updated", "computed": true }, { - "name": "resource_controller_url", + "name": "link_status_updated_at", "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", + "description": "Date and time Link status was updated", "computed": true }, { - "name": "resource_crn", + "name": "default_import_route_filter", "type": "TypeString", - "description": "The crn of the resource", + "description": "The default directional route filter action that applies to routes that do not match any directional route filters", + "options": "permit, deny", + "optional": true, "computed": true }, { @@ -102415,51 +107110,99 @@ "optional": true }, { - "name": "bfd_status_updated_at", + "name": "operational_status", "type": "TypeString", - "description": "Date and time BFD status was updated", - "optional": true, + "description": "Gateway operational status", "computed": true }, { - "name": "metered", - "type": "TypeBool", - "description": "Metered billing option", - "required": true + "name": "link_status", + "type": "TypeString", + "description": "Gateway link status", + "computed": true }, { - "name": "name", - "type": "TypeString", - "description": "The unique user-defined name for this gateway", - "required": true, - "min_length": 1, - "max_length": 63, - "matches": "^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$" + "name": "import_route_filters", + "type": "TypeList", + "description": "List Import Route Filters for a Direct Link gateway", + "optional": true, + "elem": { + "action": { + "name": "action", + "type": "TypeString", + "description": "Determines whether the routes that match the prefix-set will be permit or deny", + "required": true + }, + "before": { + "name": "before", + "type": "TypeString", + "description": "Identifier of the next route filter to be considered", + "optional": true, + "computed": true + }, + "created_at": { + "name": "created_at", + "type": "TypeString", + "description": "The date and time of the export route filter was created", + "computed": true + }, + "ge": { + "name": "ge", + "type": "TypeInt", + "description": "The minimum matching length of the prefix-set", + "optional": true + }, + "im_filter_id": { + "name": "im_filter_id", + "type": "TypeString", + "description": "Import route Filter identifier", + "computed": true + }, + "le": { + "name": "le", + "type": "TypeInt", + "description": "The maximum matching length of the prefix-set", + "optional": true + }, + "prefix": { + "name": "prefix", + "type": "TypeString", + "description": "IP prefix representing an address and mask length of the prefix-set", + "required": true + }, + "updated_at": { + "name": "updated_at", + "type": "TypeString", + "description": "The date and time of the export route filter was last updated", + "computed": true + } + } }, { - "name": "type", - "type": "TypeString", - "description": "Gateway type", - "immutable": true, - "required": true, - "options": "dedicated, connect" + "name": "bgp_asn", + "type": "TypeInt", + "description": "BGP ASN", + "required": true }, { - "name": "completion_notice_reject_reason", + "name": "connection_mode", "type": "TypeString", - "description": "Reason for completion notice rejection", + "description": "Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway Service and direct means this Gateway will be attached to vpc or classic connection", + "options": "direct, transit", + "optional": true, "computed": true }, { - "name": "link_status_updated_at", + "name": "bgp_ibm_cidr", "type": "TypeString", - "description": "Date and time Link status was updated", + "description": "BGP IBM CIDR", + "optional": true, "computed": true }, { - "name": "resource_name", + "name": "bgp_status", "type": "TypeString", - "description": "The name of the resource", + "description": "Gateway BGP status", "computed": true }, { @@ -102519,6 +107262,93 @@ } } }, + { + "name": "bgp_base_cidr", + "type": "TypeString", + "description": "BGP base CIDR", + "optional": true + }, + { + "name": "type", + "type": "TypeString", + "description": "Gateway type", + "immutable": true, + "required": true, + "options": "dedicated, connect" + }, + { + "name": "bgp_cer_cidr", + "type": "TypeString", + "description": "BGP customer edge router CIDR", + "optional": true, + "computed": true + }, + { + "name": "change_request", + "type": "TypeString", + "description": "Changes pending approval for provider managed Direct Link Connect gateways", + "computed": true + }, + { + "name": "authentication_key", + "type": "TypeString", + "description": "BGP MD5 authentication key", + "optional": true + }, + { + "name": "metered", + "type": "TypeBool", + "description": "Metered billing option", + "required": true + }, + { + "name": "resource_group", + "type": "TypeString", + "description": "Gateway resource group", + "cloud_data_type": "resource_group", + "immutable": true, + "optional": true, + "computed": true + }, + { + "name": "vlan", + "type": "TypeInt", + "description": "VLAN allocated for this gateway", + "computed": true + }, + { + "name": "bgp_ibm_asn", + "type": "TypeInt", + "description": "IBM BGP ASN", + "computed": true + }, + { + "name": "completion_notice_reject_reason", + "type": "TypeString", + "description": "Reason for completion notice rejection", + "computed": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "The date and time resource was created", + "computed": true + }, + { + "name": "crn", + "type": "TypeString", + "description": "The CRN (Cloud Resource Name) of this gateway", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "default_export_route_filter", + "type": "TypeString", + "description": "The default directional route filter action that applies to routes that do not match any directional route filters", + "options": "permit, deny", + "optional": true, + "computed": true + }, { "name": "as_prepends", "type": "TypeList", @@ -102576,12 +107406,6 @@ } } }, - { - "name": "bgp_asn", - "type": "TypeInt", - "description": "BGP ASN", - "required": true - }, { "name": "customer_name", "type": "TypeString", @@ -102590,86 +107414,67 @@ "optional": true }, { - "name": "change_request", - "type": "TypeString", - "description": "Changes pending approval for provider managed Direct Link Connect gateways", - "computed": true - }, - { - "name": "link_status", - "type": "TypeString", - "description": "Gateway link status", + "name": "provider_api_managed", + "type": "TypeBool", + "description": "Indicates whether gateway was created through a provider portal", "computed": true }, { - "name": "location_display_name", - "type": "TypeString", - "description": "Gateway location long name", - "computed": true + "name": "tags", + "type": "TypeSet", + "description": "Tags for the direct link gateway", + "min_length": 1, + "max_length": 128, + "matches": "^[A-Za-z0-9:_ .-]+$", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "resource_status", + "name": "resource_name", "type": "TypeString", - "description": "The status of the resource", + "description": "The name of the resource", "computed": true }, { - "name": "authentication_key", - "type": "TypeString", - "description": "BGP MD5 authentication key", - "optional": true - }, - { - "name": "port", + "name": "bfd_status_updated_at", "type": "TypeString", - "description": "Gateway port", - "immutable": true, + "description": "Date and time BFD status was updated", "optional": true, "computed": true }, { - "name": "vlan", - "type": "TypeInt", - "description": "VLAN allocated for this gateway", - "computed": true + "name": "global", + "type": "TypeBool", + "description": "Gateways with global routing (true) can connect to networks outside their associated region", + "required": true }, { - "name": "bgp_status", + "name": "location_display_name", "type": "TypeString", - "description": "Gateway BGP status", + "description": "Gateway location long name", "computed": true }, { - "name": "speed_mbps", - "type": "TypeInt", - "description": "Gateway speed in megabits per second", - "required": true - }, - { - "name": "operational_status", + "name": "resource_status", "type": "TypeString", - "description": "Gateway operational status", + "description": "The status of the resource", "computed": true }, { - "name": "resource_group_name", + "name": "location_name", "type": "TypeString", - "description": "The resource group name in which resource is provisioned", + "description": "Gateway location", + "immutable": true, + "optional": true, "computed": true }, { - "name": "bfd_interval", - "type": "TypeInt", - "description": "BFD Interval", - "min_value": "300", - "max_value": "255000", - "optional": true - }, - { - "name": "connection_mode", + "name": "loa_reject_reason", "type": "TypeString", - "description": "Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway Service and direct means this Gateway will be attached to vpc or classic connection", - "options": "direct, transit", + "description": "Loa reject reason", "optional": true, "computed": true }, @@ -102680,27 +107485,6 @@ "immutable": true, "optional": true }, - { - "name": "global", - "type": "TypeBool", - "description": "Gateways with global routing (true) can connect to networks outside their associated region", - "required": true - }, - { - "name": "default_export_route_filter", - "type": "TypeString", - "description": "The default directional route filter action that applies to routes that do not match any directional route filters", - "options": "permit, deny", - "optional": true, - "computed": true - }, - { - "name": "bfd_status", - "type": "TypeString", - "description": "Gateway BFD status", - "optional": true, - "computed": true - }, { "name": "carrier_name", "type": "TypeString", @@ -102709,12 +107493,10 @@ "optional": true }, { - "name": "location_name", - "type": "TypeString", - "description": "Gateway location", - "immutable": true, - "optional": true, - "computed": true + "name": "speed_mbps", + "type": "TypeInt", + "description": "Gateway speed in megabits per second", + "required": true }, { "name": "macsec_config", @@ -102799,63 +107581,45 @@ "max_items": 1 }, { - "name": "provider_api_managed", - "type": "TypeBool", - "description": "Indicates whether gateway was created through a provider portal", - "computed": true - }, - { - "name": "created_at", + "name": "resource_controller_url", "type": "TypeString", - "description": "The date and time resource was created", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", "computed": true }, { - "name": "crn", + "name": "resource_crn", "type": "TypeString", - "description": "The CRN (Cloud Resource Name) of this gateway", - "cloud_data_type": "crn", + "description": "The crn of the resource", "computed": true }, { - "name": "tags", - "type": "TypeSet", - "description": "Tags for the direct link gateway", - "min_length": 1, - "max_length": 128, - "matches": "^[A-Za-z0-9:_ .-]+$", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "bfd_interval", + "type": "TypeInt", + "description": "BFD Interval", + "min_value": "300", + "max_value": "255000", + "optional": true }, { - "name": "default_import_route_filter", + "name": "port", "type": "TypeString", - "description": "The default directional route filter action that applies to routes that do not match any directional route filters", - "options": "permit, deny", + "description": "Gateway port", + "immutable": true, "optional": true, "computed": true }, { - "name": "loa_reject_reason", + "name": "resource_group_name", "type": "TypeString", - "description": "Loa reject reason", - "optional": true, + "description": "The resource group name in which resource is provisioned", "computed": true - }, + } + ], + "ibm_dl_gateway_action": [ { - "name": "bgp_ibm_cidr", + "name": "resource_status", "type": "TypeString", - "description": "BGP IBM CIDR", - "optional": true, - "computed": true - }, - { - "name": "bgp_ibm_asn", - "type": "TypeInt", - "description": "IBM BGP ASN", + "description": "The status of the resource", "computed": true }, { @@ -102874,8 +107638,7 @@ "name": "before", "type": "TypeString", "description": "Identifier of the next route filter to be considered", - "optional": true, - "computed": true + "optional": true }, "created_at": { "name": "created_at", @@ -102916,26 +107679,56 @@ } }, { - "name": "bgp_base_cidr", + "name": "bfd_status_updated_at", "type": "TypeString", - "description": "BGP base CIDR", + "description": "Date and time BFD status was updated", + "computed": true + }, + { + "name": "port", + "type": "TypeString", + "description": "Gateway port", + "immutable": true, + "optional": true, + "computed": true + }, + { + "name": "speed_mbps", + "type": "TypeInt", + "description": "Gateway speed in megabits per second", "optional": true }, { - "name": "bgp_cer_cidr", + "name": "bgp_status", "type": "TypeString", - "description": "BGP customer edge router CIDR", + "description": "Gateway BGP status", + "computed": true + }, + { + "name": "tags", + "type": "TypeSet", + "description": "Tags for the direct link gateway", + "min_length": 1, + "max_length": 128, + "matches": "^[A-Za-z0-9:_ .-]+$", "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "resource_controller_url", + "type": "TypeString", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", "computed": true }, { - "name": "bgp_status_updated_at", + "name": "resource_group_name", "type": "TypeString", - "description": "Date and time BGP status was updated", + "description": "The resource group name in which resource is provisioned", "computed": true - } - ], - "ibm_dl_gateway_action": [ + }, { "name": "gateway", "type": "TypeString", @@ -102943,118 +107736,75 @@ "required": true }, { - "name": "as_prepends", - "type": "TypeList", - "description": "List of AS Prepend configuration information", + "name": "name", + "type": "TypeString", + "description": "The unique user-defined name for this gateway", + "min_length": 1, + "max_length": 63, + "matches": "^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$", "optional": true, - "elem": { - "created_at": { - "name": "created_at", - "type": "TypeString", - "description": "The date and time AS Prepend was created", - "computed": true - }, - "id": { - "name": "id", - "type": "TypeString", - "description": "The unique identifier for this AS Prepend", - "optional": true, - "computed": true - }, - "length": { - "name": "length", - "type": "TypeInt", - "description": "Number of times the ASN to appended to the AS Path", - "required": true - }, - "policy": { - "name": "policy", - "type": "TypeString", - "description": "Route type this AS Prepend applies to", - "required": true - }, - "prefix": { - "name": "prefix", - "type": "TypeString", - "description": "Comma separated list of prefixes this AS Prepend applies to. Maximum of 10 prefixes. If not specified, this AS Prepend applies to all prefixes", - "optional": true, - "deprecated": "prefix will be deprecated and support will be removed. Use specific_prefixes instead" - }, - "specific_prefixes": { - "name": "specific_prefixes", - "type": "TypeList", - "description": "Array of prefixes this AS Prepend applies to", - "optional": true, - "elem": { - "type": "TypeString" - }, - "max_items": 10, - "min_items": 1 - }, - "updated_at": { - "name": "updated_at", - "type": "TypeString", - "description": "The date and time AS Prepend was updated", - "computed": true - } - } + "computed": true }, { - "name": "bfd_multiplier", - "type": "TypeInt", - "description": "BFD Multiplier", - "min_value": "1", - "max_value": "255", - "optional": true + "name": "completion_notice_reject_reason", + "type": "TypeString", + "description": "Reason for completion notice rejection", + "computed": true }, { - "name": "vlan", - "type": "TypeInt", - "description": "VLAN allocated for this gateway", + "name": "bfd_status", + "type": "TypeString", + "description": "Gateway BFD status", "computed": true }, { - "name": "change_request", + "name": "type", "type": "TypeString", - "description": "Changes pending approval for provider managed Direct Link Connect gateways", + "description": "Gateway type", + "options": "dedicated, connect", + "optional": true, "computed": true }, { - "name": "link_status", + "name": "bgp_cer_cidr", "type": "TypeString", - "description": "Gateway link status", + "description": "BGP customer edge router CIDR", + "optional": true, "computed": true }, { - "name": "bfd_interval", - "type": "TypeInt", - "description": "BFD Interval", - "min_value": "300", - "max_value": "255000", - "optional": true + "name": "created_at", + "type": "TypeString", + "description": "The date and time resource was created", + "computed": true }, { - "name": "bfd_status", + "name": "bgp_base_cidr", "type": "TypeString", - "description": "Gateway BFD status", - "computed": true + "description": "BGP base CIDR", + "optional": true }, { - "name": "name", + "name": "connection_mode", "type": "TypeString", - "description": "The unique user-defined name for this gateway", - "min_length": 1, - "max_length": 63, - "matches": "^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$", + "description": "Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway Service and direct means this Gateway will be attached to vpc or classic connection", + "options": "direct, transit", "optional": true, "computed": true }, { - "name": "speed_mbps", - "type": "TypeInt", - "description": "Gateway speed in megabits per second", + "name": "cross_connect_router", + "type": "TypeString", + "description": "Cross connect router", + "immutable": true, "optional": true }, + { + "name": "location_display_name", + "type": "TypeString", + "description": "Gateway location long name", + "computed": true + }, { "name": "resource_name", "type": "TypeString", @@ -103062,28 +107812,43 @@ "computed": true }, { - "name": "resource_crn", + "name": "authentication_key", "type": "TypeString", - "description": "The crn of the resource", - "computed": true + "description": "BGP MD5 authentication key", + "secure": true, + "optional": true }, { - "name": "resource_group_name", + "name": "bgp_asn", + "type": "TypeInt", + "description": "BGP ASN", + "optional": true + }, + { + "name": "resource_group", "type": "TypeString", - "description": "The resource group name in which resource is provisioned", + "description": "Gateway resource group", + "cloud_data_type": "resource_group", + "immutable": true, + "optional": true, "computed": true }, { - "name": "global", + "name": "provider_api_managed", "type": "TypeBool", - "description": "Gateways with global routing (true) can connect to networks outside their associated region", - "optional": true + "description": "Indicates whether gateway was created through a provider portal", + "computed": true }, { - "name": "bgp_cer_cidr", + "name": "change_request", "type": "TypeString", - "description": "BGP customer edge router CIDR", - "optional": true, + "description": "Changes pending approval for provider managed Direct Link Connect gateways", + "computed": true + }, + { + "name": "vlan", + "type": "TypeInt", + "description": "VLAN allocated for this gateway", "computed": true }, { @@ -103094,28 +107859,91 @@ "options": "permit, deny" }, { - "name": "bgp_asn", + "name": "default_export_route_filter", + "type": "TypeString", + "description": "The default directional route filter action that applies to routes that do not match any directional route filters", + "options": "permit, deny", + "optional": true + }, + { + "name": "location_name", + "type": "TypeString", + "description": "Gateway location", + "immutable": true, + "optional": true, + "computed": true + }, + { + "name": "carrier_name", + "type": "TypeString", + "description": "Carrier name", + "immutable": true, + "optional": true + }, + { + "name": "customer_name", + "type": "TypeString", + "description": "Customer name", + "immutable": true, + "optional": true + }, + { + "name": "loa_reject_reason", + "type": "TypeString", + "description": "Loa reject reason", + "optional": true, + "computed": true + }, + { + "name": "bgp_ibm_cidr", + "type": "TypeString", + "description": "BGP IBM CIDR", + "optional": true, + "computed": true + }, + { + "name": "bgp_ibm_asn", + "type": "TypeInt", + "description": "IBM BGP ASN", + "computed": true + }, + { + "name": "link_status", + "type": "TypeString", + "description": "Gateway link status", + "computed": true + }, + { + "name": "link_status_updated_at", + "type": "TypeString", + "description": "Date and time Link status was updated", + "computed": true + }, + { + "name": "bfd_interval", "type": "TypeInt", - "description": "BGP ASN", + "description": "BFD Interval", + "min_value": "300", + "max_value": "255000", "optional": true }, { - "name": "bgp_ibm_cidr", + "name": "bgp_status_updated_at", "type": "TypeString", - "description": "BGP IBM CIDR", - "optional": true, + "description": "Date and time BGP status was updated", "computed": true }, { - "name": "bgp_ibm_asn", - "type": "TypeInt", - "description": "IBM BGP ASN", + "name": "crn", + "type": "TypeString", + "description": "The CRN (Cloud Resource Name) of this gateway", + "cloud_data_type": "crn", "computed": true }, { - "name": "resource_controller_url", + "name": "resource_crn", "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", + "description": "The crn of the resource", "computed": true }, { @@ -103175,97 +108003,83 @@ } }, { - "name": "import_route_filters", + "name": "default_import_route_filter", + "type": "TypeString", + "description": "The default directional route filter action that applies to routes that do not match any directional route filters", + "options": "permit, deny", + "optional": true + }, + { + "name": "as_prepends", "type": "TypeList", - "description": "List Import Route Filters for a Direct Link gateway", + "description": "List of AS Prepend configuration information", "optional": true, "elem": { - "action": { - "name": "action", - "type": "TypeString", - "description": "Determines whether the routes that match the prefix-set will be permit or deny", - "required": true - }, - "before": { - "name": "before", - "type": "TypeString", - "description": "Identifier of the next route filter to be considered", - "optional": true - }, "created_at": { "name": "created_at", "type": "TypeString", - "description": "The date and time of the export route filter was created", + "description": "The date and time AS Prepend was created", "computed": true }, - "ge": { - "name": "ge", - "type": "TypeInt", - "description": "The minimum matching length of the prefix-set", - "optional": true - }, - "im_filter_id": { - "name": "im_filter_id", + "id": { + "name": "id", "type": "TypeString", - "description": "Import route Filter identifier", + "description": "The unique identifier for this AS Prepend", + "optional": true, "computed": true }, - "le": { - "name": "le", + "length": { + "name": "length", "type": "TypeInt", - "description": "The maximum matching length of the prefix-set", - "optional": true + "description": "Number of times the ASN to appended to the AS Path", + "required": true + }, + "policy": { + "name": "policy", + "type": "TypeString", + "description": "Route type this AS Prepend applies to", + "required": true }, "prefix": { "name": "prefix", "type": "TypeString", - "description": "IP prefix representing an address and mask length of the prefix-set", - "required": true + "description": "Comma separated list of prefixes this AS Prepend applies to. Maximum of 10 prefixes. If not specified, this AS Prepend applies to all prefixes", + "optional": true, + "deprecated": "prefix will be deprecated and support will be removed. Use specific_prefixes instead" + }, + "specific_prefixes": { + "name": "specific_prefixes", + "type": "TypeList", + "description": "Array of prefixes this AS Prepend applies to", + "optional": true, + "elem": { + "type": "TypeString" + }, + "max_items": 10, + "min_items": 1 }, "updated_at": { "name": "updated_at", "type": "TypeString", - "description": "The date and time of the export route filter was last updated", + "description": "The date and time AS Prepend was updated", "computed": true } } }, { - "name": "bgp_base_cidr", - "type": "TypeString", - "description": "BGP base CIDR", + "name": "bfd_multiplier", + "type": "TypeInt", + "description": "BFD Multiplier", + "min_value": "1", + "max_value": "255", "optional": true }, { - "name": "resource_group", - "type": "TypeString", - "description": "Gateway resource group", - "cloud_data_type": "resource_group", - "immutable": true, - "optional": true, - "computed": true - }, - { - "name": "link_status_updated_at", - "type": "TypeString", - "description": "Date and time Link status was updated", - "computed": true - }, - { - "name": "default_export_route_filter", - "type": "TypeString", - "description": "The default directional route filter action that applies to routes that do not match any directional route filters", - "options": "permit, deny", + "name": "global", + "type": "TypeBool", + "description": "Gateways with global routing (true) can connect to networks outside their associated region", "optional": true }, - { - "name": "connection_mode", - "type": "TypeString", - "description": "Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway Service and direct means this Gateway will be attached to vpc or classic connection", - "options": "direct, transit", - "optional": true, - "computed": true - }, { "name": "metered", "type": "TypeBool", @@ -103273,136 +108087,52 @@ "optional": true }, { - "name": "customer_name", - "type": "TypeString", - "description": "Customer name", - "immutable": true, - "optional": true - }, - { - "name": "bgp_status_updated_at", - "type": "TypeString", - "description": "Date and time BGP status was updated", - "computed": true - }, - { - "name": "completion_notice_reject_reason", - "type": "TypeString", - "description": "Reason for completion notice rejection", - "computed": true - }, - { - "name": "resource_status", + "name": "operational_status", "type": "TypeString", - "description": "The status of the resource", - "computed": true - }, - { - "name": "provider_api_managed", - "type": "TypeBool", - "description": "Indicates whether gateway was created through a provider portal", + "description": "Gateway operational status", "computed": true - }, - { - "name": "authentication_key", - "type": "TypeString", - "description": "BGP MD5 authentication key", - "secure": true, - "optional": true - }, + } + ], + "ibm_dl_provider_gateway": [ { - "name": "bfd_status_updated_at", - "type": "TypeString", - "description": "Date and time BFD status was updated", - "computed": true + "name": "bgp_asn", + "type": "TypeInt", + "description": "BGP ASN", + "required": true }, { - "name": "port", + "name": "bgp_cer_cidr", "type": "TypeString", - "description": "Gateway port", - "immutable": true, + "description": "BGP customer edge router CIDR", "optional": true, "computed": true }, { - "name": "cross_connect_router", - "type": "TypeString", - "description": "Cross connect router", - "immutable": true, - "optional": true - }, - { - "name": "location_name", + "name": "bgp_ibm_cidr", "type": "TypeString", - "description": "Gateway location", - "immutable": true, + "description": "BGP IBM CIDR", "optional": true, "computed": true }, { - "name": "type", + "name": "bgp_status", "type": "TypeString", - "description": "Gateway type", - "options": "dedicated, connect", - "optional": true, + "description": "Gateway BGP status", "computed": true }, { - "name": "carrier_name", - "type": "TypeString", - "description": "Carrier name", - "immutable": true, - "optional": true - }, - { - "name": "location_display_name", + "name": "name", "type": "TypeString", - "description": "Gateway location long name", - "computed": true - }, - { - "name": "tags", - "type": "TypeSet", - "description": "Tags for the direct link gateway", + "description": "The unique user-defined name for this gateway", + "required": true, "min_length": 1, - "max_length": 128, - "matches": "^[A-Za-z0-9:_ .-]+$", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "default_import_route_filter", - "type": "TypeString", - "description": "The default directional route filter action that applies to routes that do not match any directional route filters", - "options": "permit, deny", - "optional": true - }, - { - "name": "loa_reject_reason", - "type": "TypeString", - "description": "Loa reject reason", - "optional": true, - "computed": true - }, - { - "name": "operational_status", - "type": "TypeString", - "description": "Gateway operational status", - "computed": true - }, - { - "name": "bgp_status", - "type": "TypeString", - "description": "Gateway BGP status", - "computed": true + "max_length": 63, + "matches": "^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$" }, { - "name": "created_at", + "name": "type", "type": "TypeString", - "description": "The date and time resource was created", + "description": "Gateway type", "computed": true }, { @@ -103411,28 +108141,28 @@ "description": "The CRN (Cloud Resource Name) of this gateway", "cloud_data_type": "crn", "computed": true - } - ], - "ibm_dl_provider_gateway": [ + }, { - "name": "bgp_ibm_cidr", + "name": "resource_name", "type": "TypeString", - "description": "BGP IBM CIDR", - "optional": true, + "description": "The name of the resource", "computed": true }, { - "name": "port", + "name": "resource_group_name", "type": "TypeString", - "description": "Gateway port", - "immutable": true, - "required": true + "description": "The resource group name in which resource is provisioned", + "computed": true }, { - "name": "type", + "name": "customer_account_id", "type": "TypeString", - "description": "Gateway type", - "computed": true + "description": "Customer IBM Cloud account ID for the new gateway. A gateway object containing the pending create request will become available in the specified account.", + "immutable": true, + "required": true, + "min_length": 1, + "max_length": 32, + "matches": "^[0-9a-f]+$" }, { "name": "vlan", @@ -103442,16 +108172,16 @@ "computed": true }, { - "name": "resource_crn", + "name": "resource_controller_url", "type": "TypeString", - "description": "The crn of the resource", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", "computed": true }, { - "name": "bgp_asn", - "type": "TypeInt", - "description": "BGP ASN", - "required": true + "name": "resource_status", + "type": "TypeString", + "description": "The status of the resource", + "computed": true }, { "name": "bgp_ibm_asn", @@ -103460,22 +108190,16 @@ "computed": true }, { - "name": "bgp_status", + "name": "port", "type": "TypeString", - "description": "Gateway BGP status", - "computed": true - }, - { - "name": "speed_mbps", - "type": "TypeInt", - "description": "Gateway speed in megabits per second", + "description": "Gateway port", + "immutable": true, "required": true }, { - "name": "crn", + "name": "operational_status", "type": "TypeString", - "description": "The CRN (Cloud Resource Name) of this gateway", - "cloud_data_type": "crn", + "description": "Gateway operational status", "computed": true }, { @@ -103491,40 +108215,6 @@ "type": "TypeString" } }, - { - "name": "bgp_cer_cidr", - "type": "TypeString", - "description": "BGP customer edge router CIDR", - "optional": true, - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "The unique user-defined name for this gateway", - "required": true, - "min_length": 1, - "max_length": 63, - "matches": "^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$" - }, - { - "name": "operational_status", - "type": "TypeString", - "description": "Gateway operational status", - "computed": true - }, - { - "name": "resource_controller_url", - "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", - "computed": true - }, - { - "name": "resource_name", - "type": "TypeString", - "description": "The name of the resource", - "computed": true - }, { "name": "created_at", "type": "TypeString", @@ -103532,14 +108222,10 @@ "computed": true }, { - "name": "customer_account_id", - "type": "TypeString", - "description": "Customer IBM Cloud account ID for the new gateway. A gateway object containing the pending create request will become available in the specified account.", - "immutable": true, - "required": true, - "min_length": 1, - "max_length": 32, - "matches": "^[0-9a-f]+$" + "name": "speed_mbps", + "type": "TypeInt", + "description": "Gateway speed in megabits per second", + "required": true }, { "name": "provider_api_managed", @@ -103548,19 +108234,39 @@ "computed": true }, { - "name": "resource_status", - "type": "TypeString", - "description": "The status of the resource", - "computed": true - }, - { - "name": "resource_group_name", + "name": "resource_crn", "type": "TypeString", - "description": "The resource group name in which resource is provisioned", + "description": "The crn of the resource", "computed": true } ], "ibm_dl_route_report": [ + { + "name": "on_prem_routes", + "type": "TypeList", + "description": "List of onprem routes", + "computed": true, + "elem": { + "as_path": { + "name": "as_path", + "type": "TypeString", + "description": "The BGP AS path of the route", + "computed": true + }, + "next_hop": { + "name": "next_hop", + "type": "TypeString", + "description": "Next Hop address", + "computed": true + }, + "prefix": { + "name": "prefix", + "type": "TypeString", + "description": "Prefix for onprem routes", + "computed": true + } + } + }, { "name": "virtual_connection_routes", "type": "TypeList", @@ -103619,12 +108325,25 @@ "description": "Route report status", "computed": true }, + { + "name": "created_at", + "type": "TypeString", + "description": "The date and time report was created", + "computed": true + }, { "name": "updated_at", "type": "TypeString", "description": "The date and time resource was created", "computed": true }, + { + "name": "gateway", + "type": "TypeString", + "description": "The Direct Link gateway identifier", + "immutable": true, + "required": true + }, { "name": "route_report_id", "type": "TypeString", @@ -103666,23 +108385,9 @@ } }, { - "name": "gateway_routes", - "type": "TypeList", - "description": "List of gateway routes", - "computed": true, - "elem": { - "prefix": { - "name": "prefix", - "type": "TypeString", - "description": "Prefix for gateway routes", - "computed": true - } - } - }, - { - "name": "on_prem_routes", + "name": "advertised_routes", "type": "TypeList", - "description": "List of onprem routes", + "description": "List of connection prefixes advertised to the on-prem network", "computed": true, "elem": { "as_path": { @@ -103691,45 +108396,20 @@ "description": "The BGP AS path of the route", "computed": true }, - "next_hop": { - "name": "next_hop", - "type": "TypeString", - "description": "Next Hop address", - "computed": true - }, "prefix": { "name": "prefix", "type": "TypeString", - "description": "Prefix for onprem routes", + "description": "Prefix for gateway routes", "computed": true } } }, { - "name": "created_at", - "type": "TypeString", - "description": "The date and time report was created", - "computed": true - }, - { - "name": "gateway", - "type": "TypeString", - "description": "The Direct Link gateway identifier", - "immutable": true, - "required": true - }, - { - "name": "advertised_routes", + "name": "gateway_routes", "type": "TypeList", - "description": "List of connection prefixes advertised to the on-prem network", + "description": "List of gateway routes", "computed": true, "elem": { - "as_path": { - "name": "as_path", - "type": "TypeString", - "description": "The BGP AS path of the route", - "computed": true - }, "prefix": { "name": "prefix", "type": "TypeString", @@ -103741,11 +108421,18 @@ ], "ibm_dl_virtual_connection": [ { - "name": "gateway", + "name": "network_id", "type": "TypeString", - "description": "The Direct Link gateway identifier", + "description": "Unique identifier of the target network. For type=vpc virtual connections this is the CRN of the target VPC. This field does not apply to type=classic connections.", "immutable": true, - "required": true + "optional": true, + "computed": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "The date and time resource was created", + "computed": true }, { "name": "related_crn", @@ -103753,6 +108440,19 @@ "description": "The crn of the Direct link gateway", "computed": true }, + { + "name": "virtual_connection_id", + "type": "TypeString", + "description": "The Direct Gateway virtual connection identifier", + "computed": true + }, + { + "name": "gateway", + "type": "TypeString", + "description": "The Direct Link gateway identifier", + "immutable": true, + "required": true + }, { "name": "type", "type": "TypeString", @@ -103770,20 +108470,6 @@ "max_length": 63, "matches": "^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$" }, - { - "name": "network_id", - "type": "TypeString", - "description": "Unique identifier of the target network. For type=vpc virtual connections this is the CRN of the target VPC. This field does not apply to type=classic connections.", - "immutable": true, - "optional": true, - "computed": true - }, - { - "name": "created_at", - "type": "TypeString", - "description": "The date and time resource was created", - "computed": true - }, { "name": "status", "type": "TypeString", @@ -103795,27 +108481,27 @@ "type": "TypeString", "description": "For virtual connections across two different IBM Cloud Accounts network_account indicates the account that owns the target network.", "computed": true - }, - { - "name": "virtual_connection_id", - "type": "TypeString", - "description": "The Direct Gateway virtual connection identifier", - "computed": true } ], "ibm_dns_custom_resolver": [ { - "name": "health", + "name": "created_on", "type": "TypeString", - "description": "Healthy state of the custom resolver", + "description": "Time when a custom resolver is created", "computed": true }, { - "name": "modified_on", + "name": "custom_resolver_id", "type": "TypeString", - "description": "The recent time when a custom resolver is modified", + "description": "Identifier of the custom resolver", "computed": true }, + { + "name": "name", + "type": "TypeString", + "description": "Name of the custom resolver", + "required": true + }, { "name": "description", "type": "TypeString", @@ -103916,6 +108602,12 @@ } } }, + { + "name": "modified_on", + "type": "TypeString", + "description": "The recent time when a custom resolver is modified", + "computed": true + }, { "name": "instance_id", "type": "TypeString", @@ -103927,21 +108619,9 @@ ] }, { - "name": "custom_resolver_id", - "type": "TypeString", - "description": "Identifier of the custom resolver", - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Name of the custom resolver", - "required": true - }, - { - "name": "created_on", + "name": "health", "type": "TypeString", - "description": "Time when a custom resolver is created", + "description": "Healthy state of the custom resolver", "computed": true } ], @@ -103999,6 +108679,23 @@ } ], "ibm_dns_custom_resolver_location": [ + { + "name": "instance_id", + "type": "TypeString", + "description": "Instance ID", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true, + "cloud_data_range": [ + "service:dns-svcs" + ] + }, + { + "name": "resolver_id", + "type": "TypeString", + "description": "Custom Resolver ID", + "required": true + }, { "name": "location_id", "type": "TypeString", @@ -104035,68 +108732,41 @@ "type": "TypeBool", "default_value": true, "optional": true - }, - { - "name": "instance_id", - "type": "TypeString", - "description": "Instance ID", - "cloud_data_type": "resource_instance", - "immutable": true, - "required": true, - "cloud_data_range": [ - "service:dns-svcs" - ] - }, - { - "name": "resolver_id", - "type": "TypeString", - "description": "Custom Resolver ID", - "required": true } ], "ibm_dns_custom_resolver_secondary_zone": [ { - "name": "instance_id", - "type": "TypeString", - "description": "The unique identifier of a service instance.", - "cloud_data_type": "resource_instance", + "name": "transfer_from", + "type": "TypeList", + "description": "The addresses of DNS servers where the secondary zone data should be transferred from", "required": true, - "cloud_data_range": [ - "service:dns-svcs" - ] + "elem": { + "type": "TypeString" + } }, { - "name": "resolver_id", + "name": "description", "type": "TypeString", - "description": "The unique identifier of a custom resolver.", - "required": true + "description": "Descriptive text of the secondary zone", + "optional": true }, { - "name": "secondary_zone_id", + "name": "modified_on", "type": "TypeString", - "description": "Secondary Zone ID", + "description": "Secondary Zone Modification date", "computed": true }, { - "name": "zone", + "name": "resolver_id", "type": "TypeString", - "description": "The name of the zone.", + "description": "The unique identifier of a custom resolver.", "required": true }, { - "name": "modified_on", + "name": "zone", "type": "TypeString", - "description": "Secondary Zone Modification date", - "computed": true - }, - { - "name": "transfer_from", - "type": "TypeList", - "description": "The addresses of DNS servers where the secondary zone data should be transferred from", - "required": true, - "elem": { - "type": "TypeString" - } + "description": "The name of the zone.", + "required": true }, { "name": "enabled", @@ -104105,15 +108775,25 @@ "required": true }, { - "name": "description", + "name": "created_on", "type": "TypeString", - "description": "Descriptive text of the secondary zone", - "optional": true + "description": "Secondary Zone Creation date", + "computed": true }, { - "name": "created_on", + "name": "instance_id", "type": "TypeString", - "description": "Secondary Zone Creation date", + "description": "The unique identifier of a service instance.", + "cloud_data_type": "resource_instance", + "required": true, + "cloud_data_range": [ + "service:dns-svcs" + ] + }, + { + "name": "secondary_zone_id", + "type": "TypeString", + "description": "Secondary Zone ID", "computed": true } ], @@ -104181,23 +108861,6 @@ } ], "ibm_dns_glb": [ - { - "name": "glb_id", - "type": "TypeString", - "description": "Load balancer Id", - "computed": true - }, - { - "name": "instance_id", - "type": "TypeString", - "description": "The GUID of the private DNS.", - "cloud_data_type": "resource_instance", - "immutable": true, - "required": true, - "cloud_data_range": [ - "service:dns-svcs" - ] - }, { "name": "enabled", "type": "TypeBool", @@ -104205,6 +108868,13 @@ "optional": true, "computed": true }, + { + "name": "ttl", + "type": "TypeInt", + "description": "Time to live in second", + "default_value": 60, + "optional": true + }, { "name": "health", "type": "TypeString", @@ -104217,6 +108887,21 @@ "description": "The pool ID to use when all other pools are detected as unhealthy", "required": true }, + { + "name": "modified_on", + "type": "TypeString", + "description": "GLB Load Balancer Modification date", + "computed": true + }, + { + "name": "default_pools", + "type": "TypeList", + "description": "A list of pool IDs ordered by their failover priority", + "required": true, + "elem": { + "type": "TypeString" + } + }, { "name": "az_pools", "type": "TypeSet", @@ -104241,11 +108926,28 @@ } }, { - "name": "modified_on", + "name": "created_on", "type": "TypeString", - "description": "GLB Load Balancer Modification date", + "description": "GLB Load Balancer creation date", + "computed": true + }, + { + "name": "glb_id", + "type": "TypeString", + "description": "Load balancer Id", "computed": true }, + { + "name": "instance_id", + "type": "TypeString", + "description": "The GUID of the private DNS.", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true, + "cloud_data_range": [ + "service:dns-svcs" + ] + }, { "name": "zone_id", "type": "TypeString", @@ -104264,31 +108966,34 @@ "type": "TypeString", "description": "Descriptive text of the load balancer", "optional": true + } + ], + "ibm_dns_glb_monitor": [ + { + "name": "name", + "type": "TypeString", + "description": "The unique identifier of a service instance.", + "required": true }, { - "name": "ttl", + "name": "timeout", "type": "TypeInt", - "description": "Time to live in second", - "default_value": 60, + "description": "The timeout (in seconds) before marking the health check as failed", + "default_value": 5, "optional": true }, { - "name": "default_pools", - "type": "TypeList", - "description": "A list of pool IDs ordered by their failover priority", - "required": true, - "elem": { - "type": "TypeString" - } + "name": "created_on", + "type": "TypeString", + "description": "GLB Monitor creation date", + "computed": true }, { - "name": "created_on", + "name": "modified_on", "type": "TypeString", - "description": "GLB Load Balancer creation date", + "description": "GLB Monitor Modification date", "computed": true - } - ], - "ibm_dns_glb_monitor": [ + }, { "name": "monitor_id", "type": "TypeString", @@ -104296,17 +109001,50 @@ "computed": true }, { - "name": "name", + "name": "description", "type": "TypeString", - "description": "The unique identifier of a service instance.", - "required": true + "description": "Descriptive text of the load balancer monitor", + "optional": true }, { - "name": "description", + "name": "port", + "type": "TypeInt", + "description": "Port number to connect to for the health check", + "optional": true, + "computed": true + }, + { + "name": "interval", + "type": "TypeInt", + "description": "The interval between each health check", + "default_value": 60, + "optional": true + }, + { + "name": "expected_body", "type": "TypeString", - "description": "Descriptive text of the load balancer monitor", + "description": "A case-insensitive sub-string to look for in the response body", "optional": true }, + { + "name": "expected_codes", + "type": "TypeString", + "description": "The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS", + "options": "200,201,202,203,204,205,206,207,208,226,2xx", + "optional": true, + "computed": true + }, + { + "name": "instance_id", + "type": "TypeString", + "description": "Instance Id", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true, + "cloud_data_range": [ + "service:dns-svcs" + ] + }, { "name": "type", "type": "TypeString", @@ -104322,13 +109060,6 @@ "default_value": 1, "optional": true }, - { - "name": "timeout", - "type": "TypeInt", - "description": "The timeout (in seconds) before marking the health check as failed", - "default_value": 5, - "optional": true - }, { "name": "method", "type": "TypeString", @@ -104337,6 +109068,13 @@ "optional": true, "computed": true }, + { + "name": "path", + "type": "TypeString", + "description": "The endpoint path to health check against", + "optional": true, + "computed": true + }, { "name": "headers", "type": "TypeSet", @@ -104361,72 +109099,38 @@ } }, { - "name": "expected_body", - "type": "TypeString", - "description": "A case-insensitive sub-string to look for in the response body", - "optional": true - }, - { - "name": "modified_on", - "type": "TypeString", - "description": "GLB Monitor Modification date", + "name": "allow_insecure", + "type": "TypeBool", + "description": "Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTPS monitors.", + "optional": true, "computed": true - }, + } + ], + "ibm_dns_glb_pool": [ { - "name": "instance_id", + "name": "pool_id", "type": "TypeString", - "description": "Instance Id", - "cloud_data_type": "resource_instance", - "immutable": true, - "required": true, - "cloud_data_range": [ - "service:dns-svcs" - ] - }, - { - "name": "port", - "type": "TypeInt", - "description": "Port number to connect to for the health check", - "optional": true, + "description": "Pool Id", "computed": true }, { - "name": "interval", - "type": "TypeInt", - "description": "The interval between each health check", - "default_value": 60, - "optional": true - }, - { - "name": "path", + "name": "description", "type": "TypeString", - "description": "The endpoint path to health check against", - "optional": true, - "computed": true + "description": "Descriptive text of the load balancer pool", + "optional": true }, { - "name": "allow_insecure", + "name": "enabled", "type": "TypeBool", - "description": "Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTPS monitors.", - "optional": true, - "computed": true + "description": "Whether the load balancer pool is enabled", + "optional": true }, { - "name": "expected_codes", - "type": "TypeString", - "description": "The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS", - "options": "200,201,202,203,204,205,206,207,208,226,2xx", - "optional": true, - "computed": true + "name": "healthy_origins_threshold", + "type": "TypeInt", + "description": "The minimum number of origins that must be healthy for this pool to serve traffic", + "optional": true }, - { - "name": "created_on", - "type": "TypeString", - "description": "GLB Monitor creation date", - "computed": true - } - ], - "ibm_dns_glb_pool": [ { "name": "notification_channel", "type": "TypeString", @@ -104434,17 +109138,26 @@ "optional": true }, { - "name": "healthcheck_region", + "name": "created_on", "type": "TypeString", - "description": "Health check region of VSIs", - "optional": true + "description": "The time when a load balancer pool is created.", + "computed": true }, { - "name": "modified_on", + "name": "health", "type": "TypeString", - "description": "The recent time when a load balancer pool is modified.", + "description": "Whether the load balancer pool is enabled", "computed": true }, + { + "name": "healthcheck_subnets", + "type": "TypeList", + "description": "Health check subnet crn of VSIs", + "optional": true, + "elem": { + "type": "TypeString" + } + }, { "name": "origins", "type": "TypeSet", @@ -104490,19 +109203,16 @@ } }, { - "name": "health", + "name": "monitor", "type": "TypeString", - "description": "Whether the load balancer pool is enabled", - "computed": true + "description": "The ID of the load balancer monitor to be associated to this pool", + "optional": true }, { - "name": "healthcheck_subnets", - "type": "TypeList", - "description": "Health check subnet crn of VSIs", - "optional": true, - "elem": { - "type": "TypeString" - } + "name": "modified_on", + "type": "TypeString", + "description": "The recent time when a load balancer pool is modified.", + "computed": true }, { "name": "instance_id", @@ -104515,24 +109225,6 @@ "service:dns-svcs" ] }, - { - "name": "enabled", - "type": "TypeBool", - "description": "Whether the load balancer pool is enabled", - "optional": true - }, - { - "name": "healthy_origins_threshold", - "type": "TypeInt", - "description": "The minimum number of origins that must be healthy for this pool to serve traffic", - "optional": true - }, - { - "name": "created_on", - "type": "TypeString", - "description": "The time when a load balancer pool is created.", - "computed": true - }, { "name": "name", "type": "TypeString", @@ -104540,30 +109232,18 @@ "required": true }, { - "name": "description", - "type": "TypeString", - "description": "Descriptive text of the load balancer pool", - "optional": true - }, - { - "name": "monitor", + "name": "healthcheck_region", "type": "TypeString", - "description": "The ID of the load balancer monitor to be associated to this pool", + "description": "Health check region of VSIs", "optional": true - }, - { - "name": "pool_id", - "type": "TypeString", - "description": "Pool Id", - "computed": true } ], "ibm_dns_linked_zone": [ { - "name": "name", + "name": "created_on", "type": "TypeString", - "description": "The name of the DNS Linked zone.", - "required": true + "description": "DNS Linked Zone Creation date", + "computed": true }, { "name": "description", @@ -104572,9 +109252,9 @@ "optional": true }, { - "name": "owner_zone_id", + "name": "owner_instance_id", "type": "TypeString", - "description": "The unique identifier of the owner DNS zone", + "description": "The unique identifier of the owner DNS instance", "required": true }, { @@ -104583,6 +109263,12 @@ "description": "The zone that is linked to the DNS Linked zone", "optional": true }, + { + "name": "state", + "type": "TypeString", + "description": "The state of the DNS Linked zone", + "computed": true + }, { "name": "approval_required_before", "type": "TypeString", @@ -104600,16 +109286,16 @@ ] }, { - "name": "owner_instance_id", + "name": "name", "type": "TypeString", - "description": "The unique identifier of the owner DNS instance", + "description": "The name of the DNS Linked zone.", "required": true }, { - "name": "state", + "name": "owner_zone_id", "type": "TypeString", - "description": "The state of the DNS Linked zone", - "computed": true + "description": "The unique identifier of the owner DNS zone", + "required": true }, { "name": "label", @@ -104617,20 +109303,33 @@ "description": "The label of the DNS Linked zone", "optional": true }, + { + "name": "modified_on", + "type": "TypeString", + "description": "DNS Linked Zone Modification date", + "computed": true + } + ], + "ibm_dns_permitted_network": [ + { + "name": "vpc_crn", + "type": "TypeString", + "description": "VPC CRN id", + "immutable": true, + "required": true + }, { "name": "created_on", "type": "TypeString", - "description": "DNS Linked Zone Creation date", + "description": "Network creation date", "computed": true }, { "name": "modified_on", "type": "TypeString", - "description": "DNS Linked Zone Modification date", + "description": "Network Modification date", "computed": true - } - ], - "ibm_dns_permitted_network": [ + }, { "name": "state", "type": "TypeString", @@ -104668,41 +109367,9 @@ "default_value": "vpc", "immutable": true, "optional": true - }, - { - "name": "vpc_crn", - "type": "TypeString", - "description": "VPC CRN id", - "immutable": true, - "required": true - }, - { - "name": "created_on", - "type": "TypeString", - "description": "Network creation date", - "computed": true - }, - { - "name": "modified_on", - "type": "TypeString", - "description": "Network Modification date", - "computed": true } ], "ibm_dns_record": [ - { - "name": "port", - "type": "TypeInt", - "description": "port number", - "optional": true - }, - { - "name": "weight", - "type": "TypeInt", - "description": "weight info", - "default_value": 0, - "optional": true - }, { "name": "tags", "type": "TypeSet", @@ -104721,23 +109388,17 @@ "optional": true }, { - "name": "retry", + "name": "refresh", "type": "TypeInt", - "description": "Retry count", + "description": "refresh rate", "optional": true, "computed": true }, { - "name": "protocol", - "type": "TypeString", - "description": "protocol info", - "optional": true - }, - { - "name": "ttl", + "name": "port", "type": "TypeInt", - "description": "TTL configuration", - "required": true + "description": "port number", + "optional": true }, { "name": "priority", @@ -104760,11 +109421,22 @@ "computed": true }, { - "name": "refresh", + "name": "ttl", "type": "TypeInt", - "description": "refresh rate", - "optional": true, - "computed": true + "description": "TTL configuration", + "required": true + }, + { + "name": "protocol", + "type": "TypeString", + "description": "protocol info", + "optional": true + }, + { + "name": "host", + "type": "TypeString", + "description": "Hostname", + "required": true }, { "name": "minimum_ttl", @@ -104781,9 +109453,10 @@ "required": true }, { - "name": "service", - "type": "TypeString", - "description": "service info", + "name": "weight", + "type": "TypeInt", + "description": "weight info", + "default_value": 0, "optional": true }, { @@ -104793,34 +109466,28 @@ "immutable": true, "required": true }, - { - "name": "host", - "type": "TypeString", - "description": "Hostname", - "required": true - }, { "name": "responsible_person", "type": "TypeString", "description": "Responsible person for DNS record", "optional": true, "computed": true - } - ], - "ibm_dns_resource_record": [ + }, { - "name": "zone_id", - "type": "TypeString", - "description": "Zone ID", - "immutable": true, - "required": true + "name": "retry", + "type": "TypeInt", + "description": "Retry count", + "optional": true, + "computed": true }, { - "name": "name", + "name": "service", "type": "TypeString", - "description": "DNS record name", - "required": true - }, + "description": "service info", + "optional": true + } + ], + "ibm_dns_resource_record": [ { "name": "rdata", "type": "TypeString", @@ -104835,16 +109502,23 @@ "optional": true }, { - "name": "protocol", + "name": "preference", + "type": "TypeInt", + "description": "DNS maximum preference", + "default_value": 0, + "optional": true + }, + { + "name": "service", "type": "TypeString", - "description": "Protocol", + "description": "Service info", "optional": true }, { - "name": "created_on", + "name": "protocol", "type": "TypeString", - "description": "Creation Data", - "computed": true + "description": "Protocol", + "optional": true }, { "name": "modified_on", @@ -104853,31 +109527,23 @@ "computed": true }, { - "name": "priority", - "type": "TypeInt", - "description": "DNS server Priority", - "default_value": 0, - "optional": true - }, - { - "name": "preference", - "type": "TypeInt", - "description": "DNS maximum preference", - "default_value": 0, - "optional": true + "name": "zone_id", + "type": "TypeString", + "description": "Zone ID", + "immutable": true, + "required": true }, { - "name": "weight", - "type": "TypeInt", - "description": "DNS server weight", - "default_value": 0, - "optional": true + "name": "name", + "type": "TypeString", + "description": "DNS record name", + "required": true }, { - "name": "service", + "name": "created_on", "type": "TypeString", - "description": "Service info", - "optional": true + "description": "Creation Data", + "computed": true }, { "name": "resource_record_id", @@ -104903,11 +109569,25 @@ "immutable": true, "required": true }, + { + "name": "priority", + "type": "TypeInt", + "description": "DNS server Priority", + "default_value": 0, + "optional": true + }, { "name": "port", "type": "TypeInt", "description": "DNS server Port", "optional": true + }, + { + "name": "weight", + "type": "TypeInt", + "description": "DNS server weight", + "default_value": 0, + "optional": true } ], "ibm_dns_reverse_record": [ @@ -104932,25 +109612,6 @@ } ], "ibm_dns_secondary": [ - { - "name": "master_ip_address", - "type": "TypeString", - "description": "Master IP Address", - "required": true - }, - { - "name": "transfer_frequency", - "type": "TypeInt", - "description": "Transfer frequency value", - "required": true - }, - { - "name": "zone_name", - "type": "TypeString", - "description": "Zone name", - "immutable": true, - "required": true - }, { "name": "status_id", "type": "TypeInt", @@ -104972,9 +109633,34 @@ "elem": { "type": "TypeString" } + }, + { + "name": "master_ip_address", + "type": "TypeString", + "description": "Master IP Address", + "required": true + }, + { + "name": "transfer_frequency", + "type": "TypeInt", + "description": "Transfer frequency value", + "required": true + }, + { + "name": "zone_name", + "type": "TypeString", + "description": "Zone name", + "immutable": true, + "required": true } ], "ibm_dns_zone": [ + { + "name": "zone_id", + "type": "TypeString", + "description": "Zone ID", + "computed": true + }, { "name": "name", "type": "TypeString", @@ -105022,12 +109708,6 @@ "cloud_data_range": [ "service:dns-svcs" ] - }, - { - "name": "zone_id", - "type": "TypeString", - "description": "Zone ID", - "computed": true } ], "ibm_en_destination_android": [ @@ -105038,6 +109718,12 @@ "immutable": true, "required": true }, + { + "name": "name", + "type": "TypeString", + "description": "The Destintion name.", + "required": true + }, { "name": "config", "type": "TypeList", @@ -105080,19 +109766,10 @@ "max_items": 1 }, { - "name": "subscription_names", - "type": "TypeList", - "description": "List of subscriptions.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "name", + "name": "destination_id", "type": "TypeString", - "description": "The Destintion name.", - "required": true + "description": "Destination ID", + "computed": true }, { "name": "type", @@ -105106,12 +109783,6 @@ "description": "The Destination description.", "optional": true }, - { - "name": "destination_id", - "type": "TypeString", - "description": "Destination ID", - "computed": true - }, { "name": "updated_at", "type": "TypeString", @@ -105123,16 +109794,18 @@ "type": "TypeInt", "description": "Number of subscriptions.", "computed": true + }, + { + "name": "subscription_names", + "type": "TypeList", + "description": "List of subscriptions.", + "computed": true, + "elem": { + "type": "TypeString" + } } ], "ibm_en_destination_ce": [ - { - "name": "instance_guid", - "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", - "immutable": true, - "required": true - }, { "name": "type", "type": "TypeString", @@ -105186,30 +109859,12 @@ }, "max_items": 1 }, - { - "name": "destination_id", - "type": "TypeString", - "description": "Destination ID", - "computed": true - }, { "name": "updated_at", "type": "TypeString", "description": "Last updated time.", "computed": true }, - { - "name": "name", - "type": "TypeString", - "description": "The Destintion name.", - "required": true - }, - { - "name": "description", - "type": "TypeString", - "description": "The Destination description.", - "optional": true - }, { "name": "subscription_count", "type": "TypeInt", @@ -105224,9 +109879,7 @@ "elem": { "type": "TypeString" } - } - ], - "ibm_en_destination_cf": [ + }, { "name": "instance_guid", "type": "TypeString", @@ -105247,19 +109900,19 @@ "computed": true }, { - "name": "subscription_count", - "type": "TypeInt", - "description": "Number of subscriptions.", - "computed": true - }, + "name": "name", + "type": "TypeString", + "description": "The Destintion name.", + "required": true + } + ], + "ibm_en_destination_cf": [ { - "name": "subscription_names", - "type": "TypeList", - "description": "List of subscriptions.", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "instance_guid", + "type": "TypeString", + "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "immutable": true, + "required": true }, { "name": "name", @@ -105273,6 +109926,12 @@ "description": "The type of Destination ibmcf.", "required": true }, + { + "name": "description", + "type": "TypeString", + "description": "The Destination description.", + "optional": true + }, { "name": "config", "type": "TypeList", @@ -105302,20 +109961,35 @@ }, "max_items": 1 }, + { + "name": "subscription_count", + "type": "TypeInt", + "description": "Number of subscriptions.", + "computed": true + }, + { + "name": "destination_id", + "type": "TypeString", + "description": "Destination ID", + "computed": true + }, { "name": "updated_at", "type": "TypeString", "description": "Last updated time.", "computed": true + }, + { + "name": "subscription_names", + "type": "TypeList", + "description": "List of subscriptions.", + "computed": true, + "elem": { + "type": "TypeString" + } } ], "ibm_en_destination_chrome": [ - { - "name": "name", - "type": "TypeString", - "description": "The Destintion name.", - "required": true - }, { "name": "type", "type": "TypeString", @@ -105358,12 +110032,6 @@ }, "max_items": 1 }, - { - "name": "destination_id", - "type": "TypeString", - "description": "Destination ID", - "computed": true - }, { "name": "subscription_names", "type": "TypeList", @@ -105380,12 +110048,24 @@ "immutable": true, "required": true }, + { + "name": "name", + "type": "TypeString", + "description": "The Destintion name.", + "required": true + }, { "name": "description", "type": "TypeString", "description": "The Destination description.", "optional": true }, + { + "name": "destination_id", + "type": "TypeString", + "description": "Destination ID", + "computed": true + }, { "name": "updated_at", "type": "TypeString", @@ -105400,27 +110080,6 @@ } ], "ibm_en_destination_cos": [ - { - "name": "destination_id", - "type": "TypeString", - "description": "Destination ID", - "computed": true - }, - { - "name": "updated_at", - "type": "TypeString", - "description": "Last updated time.", - "computed": true - }, - { - "name": "subscription_names", - "type": "TypeList", - "description": "List of subscriptions.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, { "name": "instance_guid", "type": "TypeString", @@ -105428,18 +110087,6 @@ "immutable": true, "required": true }, - { - "name": "type", - "type": "TypeString", - "description": "The type of Destination Webhook.", - "required": true - }, - { - "name": "description", - "type": "TypeString", - "description": "The Destination description.", - "optional": true - }, { "name": "name", "type": "TypeString", @@ -105482,13 +110129,29 @@ "max_items": 1 }, { - "name": "subscription_count", - "type": "TypeInt", - "description": "Number of subscriptions.", + "name": "type", + "type": "TypeString", + "description": "The type of Destination Webhook.", + "required": true + }, + { + "name": "description", + "type": "TypeString", + "description": "The Destination description.", + "optional": true + }, + { + "name": "destination_id", + "type": "TypeString", + "description": "Destination ID", "computed": true - } - ], - "ibm_en_destination_firefox": [ + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Last updated time.", + "computed": true + }, { "name": "subscription_count", "type": "TypeInt", @@ -105496,16 +110159,20 @@ "computed": true }, { - "name": "instance_guid", - "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", - "immutable": true, - "required": true - }, + "name": "subscription_names", + "type": "TypeList", + "description": "List of subscriptions.", + "computed": true, + "elem": { + "type": "TypeString" + } + } + ], + "ibm_en_destination_firefox": [ { - "name": "updated_at", + "name": "destination_id", "type": "TypeString", - "description": "Last updated time.", + "description": "Destination ID", "computed": true }, { @@ -105544,9 +110211,21 @@ "max_items": 1 }, { - "name": "destination_id", + "name": "type", "type": "TypeString", - "description": "Destination ID", + "description": "The type of Destination type push_firefox.", + "required": true + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Last updated time.", + "computed": true + }, + { + "name": "subscription_count", + "type": "TypeInt", + "description": "Number of subscriptions.", "computed": true }, { @@ -105559,15 +110238,16 @@ } }, { - "name": "name", + "name": "instance_guid", "type": "TypeString", - "description": "The Destintion name.", + "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "immutable": true, "required": true }, { - "name": "type", + "name": "name", "type": "TypeString", - "description": "The type of Destination type push_firefox.", + "description": "The Destintion name.", "required": true } ], @@ -105580,11 +110260,23 @@ "required": true }, { - "name": "type", + "name": "name", "type": "TypeString", - "description": "The type of Destination push_huawei.", + "description": "The Destintion name.", "required": true }, + { + "name": "subscription_count", + "type": "TypeInt", + "description": "Number of subscriptions.", + "computed": true + }, + { + "name": "destination_id", + "type": "TypeString", + "description": "Destination ID", + "computed": true + }, { "name": "updated_at", "type": "TypeString", @@ -105601,9 +110293,9 @@ } }, { - "name": "name", + "name": "type", "type": "TypeString", - "description": "The Destintion name.", + "description": "The type of Destination push_huawei.", "required": true }, { @@ -105646,72 +110338,15 @@ } }, "max_items": 1 - }, - { - "name": "destination_id", - "type": "TypeString", - "description": "Destination ID", - "computed": true - }, - { - "name": "subscription_count", - "type": "TypeInt", - "description": "Number of subscriptions.", - "computed": true } ], "ibm_en_destination_ios": [ - { - "name": "destination_id", - "type": "TypeString", - "description": "Destination ID", - "computed": true - }, - { - "name": "updated_at", - "type": "TypeString", - "description": "Last updated time.", - "computed": true - }, - { - "name": "subscription_count", - "type": "TypeInt", - "description": "Number of subscriptions.", - "computed": true - }, - { - "name": "subscription_names", - "type": "TypeList", - "description": "List of subscriptions.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "type", - "type": "TypeString", - "description": "The type of Destination type push_ios.", - "required": true - }, - { - "name": "description", - "type": "TypeString", - "description": "The Destination description.", - "optional": true - }, { "name": "certificate_content_type", "type": "TypeString", "description": "The Certificate Content Type to be set p8/p12.", "required": true }, - { - "name": "certificate", - "type": "TypeString", - "description": "The Certificate File.", - "required": true - }, { "name": "config", "type": "TypeList", @@ -105773,20 +110408,44 @@ "max_items": 1 }, { - "name": "instance_guid", + "name": "subscription_count", + "type": "TypeInt", + "description": "Number of subscriptions.", + "computed": true + }, + { + "name": "subscription_names", + "type": "TypeList", + "description": "List of subscriptions.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "description", "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", - "immutable": true, - "required": true + "description": "The Destination description.", + "optional": true }, { "name": "name", "type": "TypeString", "description": "The Destintion name.", "required": true - } - ], - "ibm_en_destination_msteams": [ + }, + { + "name": "type", + "type": "TypeString", + "description": "The type of Destination type push_ios.", + "required": true + }, + { + "name": "certificate", + "type": "TypeString", + "description": "The Certificate File.", + "required": true + }, { "name": "destination_id", "type": "TypeString", @@ -105794,14 +110453,20 @@ "computed": true }, { - "name": "subscription_names", - "type": "TypeList", - "description": "List of subscriptions.", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "updated_at", + "type": "TypeString", + "description": "Last updated time.", + "computed": true }, + { + "name": "instance_guid", + "type": "TypeString", + "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "immutable": true, + "required": true + } + ], + "ibm_en_destination_msteams": [ { "name": "type", "type": "TypeString", @@ -105838,9 +110503,15 @@ "max_items": 1 }, { - "name": "subscription_count", - "type": "TypeInt", - "description": "Number of subscriptions.", + "name": "destination_id", + "type": "TypeString", + "description": "Destination ID", + "computed": true + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Last updated time.", "computed": true }, { @@ -105857,13 +110528,28 @@ "required": true }, { - "name": "updated_at", - "type": "TypeString", - "description": "Last updated time.", + "name": "subscription_count", + "type": "TypeInt", + "description": "Number of subscriptions.", "computed": true + }, + { + "name": "subscription_names", + "type": "TypeList", + "description": "List of subscriptions.", + "computed": true, + "elem": { + "type": "TypeString" + } } ], "ibm_en_destination_pagerduty": [ + { + "name": "name", + "type": "TypeString", + "description": "The Destintion name.", + "required": true + }, { "name": "description", "type": "TypeString", @@ -105876,18 +110562,21 @@ "description": "Destination ID", "computed": true }, - { - "name": "updated_at", - "type": "TypeString", - "description": "Last updated time.", - "computed": true - }, { "name": "subscription_count", "type": "TypeInt", "description": "Number of subscriptions.", "computed": true }, + { + "name": "subscription_names", + "type": "TypeList", + "description": "List of subscriptions.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, { "name": "instance_guid", "type": "TypeString", @@ -105895,12 +110584,6 @@ "immutable": true, "required": true }, - { - "name": "name", - "type": "TypeString", - "description": "The Destintion name.", - "required": true - }, { "name": "type", "type": "TypeString", @@ -105937,6 +110620,38 @@ }, "max_items": 1 }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Last updated time.", + "computed": true + } + ], + "ibm_en_destination_safari": [ + { + "name": "type", + "type": "TypeString", + "description": "The type of Destination type push_ios.", + "required": true + }, + { + "name": "certificate", + "type": "TypeString", + "description": "The Certificate File.", + "required": true + }, + { + "name": "icon_16x16_2x", + "type": "TypeString", + "description": "The Certificate File.", + "optional": true + }, + { + "name": "icon_128x128_2x", + "type": "TypeString", + "description": "The Certificate File.", + "optional": true + }, { "name": "subscription_names", "type": "TypeList", @@ -105945,15 +110660,38 @@ "elem": { "type": "TypeString" } - } - ], - "ibm_en_destination_safari": [ + }, { - "name": "type", + "name": "instance_guid", "type": "TypeString", - "description": "The type of Destination type push_ios.", + "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "immutable": true, + "required": true + }, + { + "name": "name", + "type": "TypeString", + "description": "The Destintion name.", "required": true }, + { + "name": "icon_32x32_2x", + "type": "TypeString", + "description": "The Certificate File.", + "optional": true + }, + { + "name": "destination_id", + "type": "TypeString", + "description": "Destination ID", + "computed": true + }, + { + "name": "icon_128x128_content_type", + "type": "TypeString", + "description": "The Certificate File.", + "optional": true + }, { "name": "description", "type": "TypeString", @@ -105961,7 +110699,13 @@ "optional": true }, { - "name": "icon_16x16_2x", + "name": "icon_16x16", + "type": "TypeString", + "description": "The Certificate File.", + "optional": true + }, + { + "name": "icon_32x32", "type": "TypeString", "description": "The Certificate File.", "optional": true @@ -105972,18 +110716,48 @@ "description": "The Certificate File.", "optional": true }, + { + "name": "icon_32x32_content_type", + "type": "TypeString", + "description": "The Certificate File.", + "optional": true + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Last updated time.", + "computed": true + }, + { + "name": "subscription_count", + "type": "TypeInt", + "description": "Number of subscriptions.", + "computed": true + }, { "name": "icon_16x16_content_type", "type": "TypeString", "description": "The Certificate File.", "optional": true }, + { + "name": "icon_16x16_2x_content_type", + "type": "TypeString", + "description": "The Certificate File.", + "optional": true + }, { "name": "icon_32x32_2x_content_type", "type": "TypeString", "description": "The Certificate File.", "optional": true }, + { + "name": "icon_128x128_2x_content_type", + "type": "TypeString", + "description": "The Certificate File.", + "optional": true + }, { "name": "config", "type": "TypeList", @@ -106043,24 +110817,31 @@ } }, "max_items": 1 - }, - { - "name": "icon_128x128_2x", - "type": "TypeString", - "description": "The Certificate File.", - "optional": true - }, - { - "name": "icon_16x16_2x_content_type", - "type": "TypeString", - "description": "The Certificate File.", - "optional": true - }, + } + ], + "ibm_en_destination_slack": [ { - "name": "icon_128x128_content_type", - "type": "TypeString", - "description": "The Certificate File.", - "optional": true + "name": "config", + "type": "TypeList", + "description": "Payload describing a destination configuration.", + "optional": true, + "elem": { + "params": { + "name": "params", + "type": "TypeList", + "optional": true, + "elem": { + "url": { + "name": "url", + "type": "TypeString", + "description": "Slack webhook url.", + "required": true + } + }, + "max_items": 1 + } + }, + "max_items": 1 }, { "name": "destination_id", @@ -106068,78 +110849,12 @@ "description": "Destination ID", "computed": true }, - { - "name": "subscription_count", - "type": "TypeInt", - "description": "Number of subscriptions.", - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "The Destintion name.", - "required": true - }, - { - "name": "icon_16x16", - "type": "TypeString", - "description": "The Certificate File.", - "optional": true - }, - { - "name": "icon_32x32_2x", - "type": "TypeString", - "description": "The Certificate File.", - "optional": true - }, - { - "name": "icon_32x32_content_type", - "type": "TypeString", - "description": "The Certificate File.", - "optional": true - }, - { - "name": "subscription_names", - "type": "TypeList", - "description": "List of subscriptions.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "instance_guid", - "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", - "immutable": true, - "required": true - }, - { - "name": "certificate", - "type": "TypeString", - "description": "The Certificate File.", - "required": true - }, - { - "name": "icon_32x32", - "type": "TypeString", - "description": "The Certificate File.", - "optional": true - }, - { - "name": "icon_128x128_2x_content_type", - "type": "TypeString", - "description": "The Certificate File.", - "optional": true - }, { "name": "updated_at", "type": "TypeString", "description": "Last updated time.", "computed": true - } - ], - "ibm_en_destination_slack": [ + }, { "name": "subscription_count", "type": "TypeInt", @@ -106160,16 +110875,16 @@ "required": true }, { - "name": "destination_id", + "name": "type", "type": "TypeString", - "description": "Destination ID", - "computed": true + "description": "The type of Destination Webhook.", + "required": true }, { - "name": "updated_at", + "name": "description", "type": "TypeString", - "description": "Last updated time.", - "computed": true + "description": "The Destination description.", + "optional": true }, { "name": "subscription_names", @@ -106179,11 +110894,19 @@ "elem": { "type": "TypeString" } + } + ], + "ibm_en_destination_sn": [ + { + "name": "name", + "type": "TypeString", + "description": "The Destintion name.", + "required": true }, { "name": "type", "type": "TypeString", - "description": "The type of Destination Webhook.", + "description": "The type of Destination type push_chrome.", "required": true }, { @@ -106192,31 +110915,6 @@ "description": "The Destination description.", "optional": true }, - { - "name": "config", - "type": "TypeList", - "description": "Payload describing a destination configuration.", - "optional": true, - "elem": { - "params": { - "name": "params", - "type": "TypeList", - "optional": true, - "elem": { - "url": { - "name": "url", - "type": "TypeString", - "description": "Slack webhook url.", - "required": true - } - }, - "max_items": 1 - } - }, - "max_items": 1 - } - ], - "ibm_en_destination_sn": [ { "name": "config", "type": "TypeList", @@ -106286,6 +110984,13 @@ "description": "Number of subscriptions.", "computed": true }, + { + "name": "instance_guid", + "type": "TypeString", + "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "immutable": true, + "required": true + }, { "name": "subscription_names", "type": "TypeList", @@ -106294,38 +110999,41 @@ "elem": { "type": "TypeString" } - }, + } + ], + "ibm_en_destination_webhook": [ { - "name": "instance_guid", + "name": "updated_at", "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", - "immutable": true, - "required": true + "description": "Last updated time.", + "computed": true }, { - "name": "name", - "type": "TypeString", - "description": "The Destintion name.", - "required": true + "name": "subscription_count", + "type": "TypeInt", + "description": "Number of subscriptions.", + "computed": true }, { - "name": "type", - "type": "TypeString", - "description": "The type of Destination type push_chrome.", - "required": true + "name": "subscription_names", + "type": "TypeList", + "description": "List of subscriptions.", + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "description", + "name": "instance_guid", "type": "TypeString", - "description": "The Destination description.", - "optional": true - } - ], - "ibm_en_destination_webhook": [ + "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "immutable": true, + "required": true + }, { - "name": "name", + "name": "type", "type": "TypeString", - "description": "The Destintion name.", + "description": "The type of Destination Webhook.", "required": true }, { @@ -106381,34 +111089,6 @@ }, "max_items": 1 }, - { - "name": "subscription_count", - "type": "TypeInt", - "description": "Number of subscriptions.", - "computed": true - }, - { - "name": "subscription_names", - "type": "TypeList", - "description": "List of subscriptions.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "instance_guid", - "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", - "immutable": true, - "required": true - }, - { - "name": "type", - "type": "TypeString", - "description": "The type of Destination Webhook.", - "required": true - }, { "name": "destination_id", "type": "TypeString", @@ -106416,10 +111096,10 @@ "computed": true }, { - "name": "updated_at", + "name": "name", "type": "TypeString", - "description": "Last updated time.", - "computed": true + "description": "The Destintion name.", + "required": true } ], "ibm_en_ibmsource": [ @@ -106450,25 +111130,6 @@ } ], "ibm_en_integration": [ - { - "name": "instance_guid", - "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", - "immutable": true, - "required": true - }, - { - "name": "integration_id", - "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", - "required": true - }, - { - "name": "type", - "type": "TypeString", - "description": "The type of key integration kms/hs-crypto.", - "required": true - }, { "name": "metadata", "type": "TypeList", @@ -106500,9 +111161,7 @@ "type": "TypeString", "description": "Last updated time.", "computed": true - } - ], - "ibm_en_source": [ + }, { "name": "instance_guid", "type": "TypeString", @@ -106510,6 +111169,20 @@ "immutable": true, "required": true }, + { + "name": "integration_id", + "type": "TypeString", + "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "required": true + }, + { + "name": "type", + "type": "TypeString", + "description": "The type of key integration kms/hs-crypto.", + "required": true + } + ], + "ibm_en_source": [ { "name": "name", "type": "TypeString", @@ -106539,33 +111212,22 @@ "type": "TypeString", "description": "Last updated time.", "computed": true - } - ], - "ibm_en_subscription_android": [ + }, { - "name": "name", + "name": "instance_guid", "type": "TypeString", - "description": "Subscription name.", + "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "immutable": true, "required": true - }, + } + ], + "ibm_en_subscription_android": [ { "name": "subscription_id", "type": "TypeString", "description": "Subscription ID.", "computed": true }, - { - "name": "destination_name", - "type": "TypeString", - "description": "The Destintion name.", - "computed": true - }, - { - "name": "topic_name", - "type": "TypeString", - "description": "Name of the topic.", - "computed": true - }, { "name": "destination_type", "type": "TypeString", @@ -106592,21 +111254,45 @@ "optional": true }, { - "name": "destination_id", + "name": "topic_id", "type": "TypeString", - "description": "Destination ID.", + "description": "Topic ID.", "immutable": true, "required": true }, { - "name": "topic_id", + "name": "destination_name", "type": "TypeString", - "description": "Topic ID.", + "description": "The Destintion name.", + "computed": true + }, + { + "name": "topic_name", + "type": "TypeString", + "description": "Name of the topic.", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "Subscription name.", + "required": true + }, + { + "name": "destination_id", + "type": "TypeString", + "description": "Destination ID.", "immutable": true, "required": true } ], "ibm_en_subscription_ce": [ + { + "name": "destination_name", + "type": "TypeString", + "description": "The Destintion name.", + "computed": true + }, { "name": "name", "type": "TypeString", @@ -106614,11 +111300,16 @@ "required": true }, { - "name": "destination_id", + "name": "description", "type": "TypeString", - "description": "Destination ID.", - "immutable": true, - "required": true + "description": "Subscription description.", + "optional": true + }, + { + "name": "subscription_id", + "type": "TypeString", + "description": "Subscription ID.", + "computed": true }, { "name": "destination_type", @@ -106627,9 +111318,9 @@ "computed": true }, { - "name": "destination_name", + "name": "updated_at", "type": "TypeString", - "description": "The Destintion name.", + "description": "Last updated time.", "computed": true }, { @@ -106640,10 +111331,11 @@ "required": true }, { - "name": "description", + "name": "destination_id", "type": "TypeString", - "description": "Subscription description.", - "optional": true + "description": "Destination ID.", + "immutable": true, + "required": true }, { "name": "topic_id", @@ -106653,10 +111345,24 @@ "required": true }, { - "name": "subscription_id", + "name": "topic_name", "type": "TypeString", - "description": "Subscription ID.", + "description": "Name of the topic.", "computed": true + } + ], + "ibm_en_subscription_cf": [ + { + "name": "name", + "type": "TypeString", + "description": "Subscription name.", + "required": true + }, + { + "name": "description", + "type": "TypeString", + "description": "Subscription description.", + "optional": true }, { "name": "topic_name", @@ -106669,9 +111375,7 @@ "type": "TypeString", "description": "Last updated time.", "computed": true - } - ], - "ibm_en_subscription_cf": [ + }, { "name": "instance_guid", "type": "TypeString", @@ -106710,19 +111414,9 @@ "type": "TypeString", "description": "The Destintion name.", "computed": true - }, - { - "name": "topic_name", - "type": "TypeString", - "description": "Name of the topic.", - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Subscription name.", - "required": true - }, + } + ], + "ibm_en_subscription_chrome": [ { "name": "description", "type": "TypeString", @@ -106730,19 +111424,23 @@ "optional": true }, { - "name": "updated_at", + "name": "destination_name", "type": "TypeString", - "description": "Last updated time.", + "description": "The Destintion name.", "computed": true - } - ], - "ibm_en_subscription_chrome": [ + }, { "name": "topic_name", "type": "TypeString", "description": "Name of the topic.", "computed": true }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Last updated time.", + "computed": true + }, { "name": "instance_guid", "type": "TypeString", @@ -106756,12 +111454,6 @@ "description": "Subscription name.", "required": true }, - { - "name": "description", - "type": "TypeString", - "description": "Subscription description.", - "optional": true - }, { "name": "destination_id", "type": "TypeString", @@ -106787,11 +111479,20 @@ "type": "TypeString", "description": "The type of Destination.", "computed": true + } + ], + "ibm_en_subscription_cos": [ + { + "name": "topic_id", + "type": "TypeString", + "description": "Topic ID.", + "immutable": true, + "required": true }, { - "name": "updated_at", + "name": "subscription_id", "type": "TypeString", - "description": "Last updated time.", + "description": "Subscription ID.", "computed": true }, { @@ -106799,21 +111500,26 @@ "type": "TypeString", "description": "The Destintion name.", "computed": true - } - ], - "ibm_en_subscription_cos": [ + }, { - "name": "subscription_id", + "name": "topic_name", "type": "TypeString", - "description": "Subscription ID.", + "description": "Name of the topic.", "computed": true }, { - "name": "topic_name", + "name": "updated_at", "type": "TypeString", - "description": "Name of the topic.", + "description": "Last updated time.", "computed": true }, + { + "name": "instance_guid", + "type": "TypeString", + "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "immutable": true, + "required": true + }, { "name": "name", "type": "TypeString", @@ -106821,11 +111527,10 @@ "required": true }, { - "name": "topic_id", + "name": "description", "type": "TypeString", - "description": "Topic ID.", - "immutable": true, - "required": true + "description": "Subscription description.", + "optional": true }, { "name": "destination_id", @@ -106839,7 +111544,9 @@ "type": "TypeString", "description": "The type of Destination.", "computed": true - }, + } + ], + "ibm_en_subscription_email": [ { "name": "destination_name", "type": "TypeString", @@ -106852,21 +111559,6 @@ "description": "Last updated time.", "computed": true }, - { - "name": "instance_guid", - "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", - "immutable": true, - "required": true - }, - { - "name": "description", - "type": "TypeString", - "description": "Subscription description.", - "optional": true - } - ], - "ibm_en_subscription_email": [ { "name": "name", "type": "TypeString", @@ -106874,15 +111566,9 @@ "required": true }, { - "name": "description", - "type": "TypeString", - "description": "Subscription description.", - "optional": true - }, - { - "name": "topic_id", + "name": "destination_id", "type": "TypeString", - "description": "Topic ID.", + "description": "Destination ID.", "immutable": true, "required": true }, @@ -106946,9 +111632,15 @@ "max_items": 1 }, { - "name": "destination_name", + "name": "subscription_id", "type": "TypeString", - "description": "The Destintion name.", + "description": "Subscription ID.", + "computed": true + }, + { + "name": "destination_type", + "type": "TypeString", + "description": "The type of Destination.", "computed": true }, { @@ -106958,9 +111650,9 @@ "computed": true }, { - "name": "updated_at", + "name": "from", "type": "TypeString", - "description": "Last updated time.", + "description": "From Email ID (it will be displayed only in case of smtp_ibm destination type).", "computed": true }, { @@ -106971,44 +111663,20 @@ "required": true }, { - "name": "destination_id", - "type": "TypeString", - "description": "Destination ID.", - "immutable": true, - "required": true - }, - { - "name": "subscription_id", - "type": "TypeString", - "description": "Subscription ID.", - "computed": true - }, - { - "name": "destination_type", + "name": "description", "type": "TypeString", - "description": "The type of Destination.", - "computed": true + "description": "Subscription description.", + "optional": true }, { - "name": "from", + "name": "topic_id", "type": "TypeString", - "description": "From Email ID (it will be displayed only in case of smtp_ibm destination type).", - "computed": true + "description": "Topic ID.", + "immutable": true, + "required": true } ], "ibm_en_subscription_firefox": [ - { - "name": "updated_at", - "type": "TypeString", - "description": "Last updated time.", - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Subscription name.", - "required": true - }, { "name": "description", "type": "TypeString", @@ -107029,12 +111697,6 @@ "immutable": true, "required": true }, - { - "name": "subscription_id", - "type": "TypeString", - "description": "Subscription ID.", - "computed": true - }, { "name": "destination_type", "type": "TypeString", @@ -107055,18 +111717,9 @@ "required": true }, { - "name": "destination_name", - "type": "TypeString", - "description": "The Destintion name.", - "computed": true - } - ], - "ibm_en_subscription_huawei": [ - { - "name": "destination_id", + "name": "name", "type": "TypeString", - "description": "Destination ID.", - "immutable": true, + "description": "Subscription name.", "required": true }, { @@ -107076,29 +111729,30 @@ "computed": true }, { - "name": "topic_name", + "name": "destination_name", "type": "TypeString", - "description": "Name of the topic.", + "description": "The Destintion name.", "computed": true }, { - "name": "instance_guid", + "name": "updated_at", "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", - "immutable": true, - "required": true - }, + "description": "Last updated time.", + "computed": true + } + ], + "ibm_en_subscription_huawei": [ { - "name": "name", + "name": "destination_type", "type": "TypeString", - "description": "Subscription name.", - "required": true + "description": "The type of Destination.", + "computed": true }, { - "name": "description", + "name": "topic_name", "type": "TypeString", - "description": "Subscription description.", - "optional": true + "description": "Name of the topic.", + "computed": true }, { "name": "topic_id", @@ -107108,9 +111762,9 @@ "required": true }, { - "name": "destination_type", + "name": "subscription_id", "type": "TypeString", - "description": "The type of Destination.", + "description": "Subscription ID.", "computed": true }, { @@ -107124,9 +111778,20 @@ "type": "TypeString", "description": "Last updated time.", "computed": true - } - ], - "ibm_en_subscription_ios": [ + }, + { + "name": "instance_guid", + "type": "TypeString", + "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "immutable": true, + "required": true + }, + { + "name": "name", + "type": "TypeString", + "description": "Subscription name.", + "required": true + }, { "name": "description", "type": "TypeString", @@ -107139,13 +111804,9 @@ "description": "Destination ID.", "immutable": true, "required": true - }, - { - "name": "destination_name", - "type": "TypeString", - "description": "The Destintion name.", - "computed": true - }, + } + ], + "ibm_en_subscription_ios": [ { "name": "topic_name", "type": "TypeString", @@ -107166,10 +111827,16 @@ "required": true }, { - "name": "name", + "name": "description", "type": "TypeString", - "description": "Subscription name.", - "required": true + "description": "Subscription description.", + "optional": true + }, + { + "name": "subscription_id", + "type": "TypeString", + "description": "Subscription ID.", + "computed": true }, { "name": "destination_type", @@ -107178,17 +111845,30 @@ "computed": true }, { - "name": "topic_id", + "name": "destination_name", "type": "TypeString", - "description": "Topic ID.", + "description": "The Destintion name.", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "Subscription name.", + "required": true + }, + { + "name": "destination_id", + "type": "TypeString", + "description": "Destination ID.", "immutable": true, "required": true }, { - "name": "subscription_id", + "name": "topic_id", "type": "TypeString", - "description": "Subscription ID.", - "computed": true + "description": "Topic ID.", + "immutable": true, + "required": true } ], "ibm_en_subscription_msteams": [ @@ -107200,40 +111880,35 @@ "required": true }, { - "name": "topic_name", + "name": "subscription_id", "type": "TypeString", - "description": "Name of the topic.", + "description": "Subscription ID.", "computed": true }, { - "name": "description", - "type": "TypeString", - "description": "Subscription description.", - "optional": true - }, - { - "name": "destination_id", + "name": "instance_guid", "type": "TypeString", - "description": "Destination ID.", + "description": "Unique identifier for IBM Cloud Event Notifications instance.", "immutable": true, "required": true }, { - "name": "subscription_id", + "name": "name", "type": "TypeString", - "description": "Subscription ID.", - "computed": true + "description": "Subscription name.", + "required": true }, { - "name": "destination_type", + "name": "destination_id", "type": "TypeString", - "description": "The type of Destination.", - "computed": true + "description": "Destination ID.", + "immutable": true, + "required": true }, { - "name": "destination_name", + "name": "topic_name", "type": "TypeString", - "description": "The Destintion name.", + "description": "Name of the topic.", "computed": true }, { @@ -107243,24 +111918,15 @@ "computed": true }, { - "name": "instance_guid", + "name": "description", "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", - "immutable": true, - "required": true + "description": "Subscription description.", + "optional": true }, { - "name": "name", - "type": "TypeString", - "description": "Subscription name.", - "required": true - } - ], - "ibm_en_subscription_pagerduty": [ - { - "name": "subscription_id", + "name": "destination_type", "type": "TypeString", - "description": "Subscription ID.", + "description": "The type of Destination.", "computed": true }, { @@ -107268,13 +111934,9 @@ "type": "TypeString", "description": "The Destintion name.", "computed": true - }, - { - "name": "topic_name", - "type": "TypeString", - "description": "Name of the topic.", - "computed": true - }, + } + ], + "ibm_en_subscription_pagerduty": [ { "name": "instance_guid", "type": "TypeString", @@ -107288,12 +111950,6 @@ "description": "Subscription name.", "required": true }, - { - "name": "description", - "type": "TypeString", - "description": "Subscription description.", - "optional": true - }, { "name": "destination_id", "type": "TypeString", @@ -107315,13 +111971,17 @@ "computed": true }, { - "name": "updated_at", + "name": "destination_name", "type": "TypeString", - "description": "Last updated time.", + "description": "The Destintion name.", "computed": true - } - ], - "ibm_en_subscription_safari": [ + }, + { + "name": "topic_name", + "type": "TypeString", + "description": "Name of the topic.", + "computed": true + }, { "name": "description", "type": "TypeString", @@ -107329,22 +111989,30 @@ "optional": true }, { - "name": "destination_id", + "name": "subscription_id", "type": "TypeString", - "description": "Destination ID.", - "immutable": true, - "required": true + "description": "Subscription ID.", + "computed": true }, { - "name": "subscription_id", + "name": "updated_at", "type": "TypeString", - "description": "Subscription ID.", + "description": "Last updated time.", "computed": true + } + ], + "ibm_en_subscription_safari": [ + { + "name": "instance_guid", + "type": "TypeString", + "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "immutable": true, + "required": true }, { - "name": "destination_type", + "name": "subscription_id", "type": "TypeString", - "description": "The type of Destination.", + "description": "Subscription ID.", "computed": true }, { @@ -107354,17 +112022,23 @@ "computed": true }, { - "name": "instance_guid", + "name": "topic_id", "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "description": "Topic ID.", "immutable": true, "required": true }, { - "name": "name", + "name": "destination_type", "type": "TypeString", - "description": "Subscription name.", - "required": true + "description": "The type of Destination.", + "computed": true + }, + { + "name": "topic_name", + "type": "TypeString", + "description": "Name of the topic.", + "computed": true }, { "name": "updated_at", @@ -107373,17 +112047,23 @@ "computed": true }, { - "name": "topic_id", + "name": "name", "type": "TypeString", - "description": "Topic ID.", - "immutable": true, + "description": "Subscription name.", "required": true }, { - "name": "topic_name", + "name": "description", "type": "TypeString", - "description": "Name of the topic.", - "computed": true + "description": "Subscription description.", + "optional": true + }, + { + "name": "destination_id", + "type": "TypeString", + "description": "Destination ID.", + "immutable": true, + "required": true } ], "ibm_en_subscription_slack": [ @@ -107394,9 +112074,9 @@ "optional": true }, { - "name": "destination_id", + "name": "topic_id", "type": "TypeString", - "description": "Destination ID.", + "description": "Topic ID.", "immutable": true, "required": true }, @@ -107415,16 +112095,17 @@ "max_items": 1 }, { - "name": "subscription_id", + "name": "topic_name", "type": "TypeString", - "description": "Subscription ID.", + "description": "Name of the topic.", "computed": true }, { - "name": "updated_at", + "name": "instance_guid", "type": "TypeString", - "description": "Last updated time.", - "computed": true + "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "immutable": true, + "required": true }, { "name": "name", @@ -107432,13 +112113,6 @@ "description": "Subscription name.", "required": true }, - { - "name": "topic_id", - "type": "TypeString", - "description": "Topic ID.", - "immutable": true, - "required": true - }, { "name": "destination_type", "type": "TypeString", @@ -107452,26 +112126,71 @@ "computed": true }, { - "name": "topic_name", + "name": "updated_at", "type": "TypeString", - "description": "Name of the topic.", + "description": "Last updated time.", "computed": true }, { - "name": "instance_guid", + "name": "destination_id", "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "description": "Destination ID.", "immutable": true, "required": true + }, + { + "name": "subscription_id", + "type": "TypeString", + "description": "Subscription ID.", + "computed": true } ], "ibm_en_subscription_sms": [ + { + "name": "instance_guid", + "type": "TypeString", + "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "immutable": true, + "required": true + }, + { + "name": "destination_id", + "type": "TypeString", + "description": "Destination ID.", + "immutable": true, + "required": true + }, + { + "name": "topic_id", + "type": "TypeString", + "description": "Topic ID.", + "immutable": true, + "required": true + }, + { + "name": "subscription_id", + "type": "TypeString", + "description": "Subscription ID.", + "computed": true + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Last updated time.", + "computed": true + }, { "name": "name", "type": "TypeString", "description": "Subscription name.", "required": true }, + { + "name": "description", + "type": "TypeString", + "description": "Subscription description.", + "optional": true + }, { "name": "attributes", "type": "TypeList", @@ -107524,19 +112243,20 @@ "type": "TypeString", "description": "Name of the topic.", "computed": true - }, + } + ], + "ibm_en_subscription_sn": [ { - "name": "instance_guid", + "name": "subscription_id", "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", - "immutable": true, - "required": true + "description": "Subscription ID.", + "computed": true }, { - "name": "description", + "name": "destination_type", "type": "TypeString", - "description": "Subscription description.", - "optional": true + "description": "The type of Destination.", + "computed": true }, { "name": "destination_id", @@ -107553,35 +112273,21 @@ "required": true }, { - "name": "subscription_id", - "type": "TypeString", - "description": "Subscription ID.", - "computed": true - }, - { - "name": "updated_at", - "type": "TypeString", - "description": "Last updated time.", - "computed": true - } - ], - "ibm_en_subscription_sn": [ - { - "name": "subscription_id", + "name": "description", "type": "TypeString", - "description": "Subscription ID.", - "computed": true + "description": "Subscription description.", + "optional": true }, { - "name": "destination_type", + "name": "destination_name", "type": "TypeString", - "description": "The type of Destination.", + "description": "The Destintion name.", "computed": true }, { - "name": "destination_name", + "name": "topic_name", "type": "TypeString", - "description": "The Destintion name.", + "description": "Name of the topic.", "computed": true }, { @@ -107602,12 +112308,21 @@ "type": "TypeString", "description": "Subscription name.", "required": true + } + ], + "ibm_en_subscription_webhook": [ + { + "name": "instance_guid", + "type": "TypeString", + "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "immutable": true, + "required": true }, { - "name": "description", + "name": "name", "type": "TypeString", - "description": "Subscription description.", - "optional": true + "description": "Subscription name.", + "required": true }, { "name": "destination_id", @@ -107624,33 +112339,22 @@ "required": true }, { - "name": "topic_name", + "name": "destination_name", "type": "TypeString", - "description": "Name of the topic.", + "description": "The Destintion name.", "computed": true - } - ], - "ibm_en_subscription_webhook": [ - { - "name": "instance_guid", - "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", - "immutable": true, - "required": true }, { - "name": "destination_id", + "name": "updated_at", "type": "TypeString", - "description": "Destination ID.", - "immutable": true, - "required": true + "description": "Last updated time.", + "computed": true }, { - "name": "topic_id", + "name": "description", "type": "TypeString", - "description": "Topic ID.", - "immutable": true, - "required": true + "description": "Subscription description.", + "optional": true }, { "name": "attributes", @@ -107667,6 +112371,12 @@ }, "max_items": 1 }, + { + "name": "subscription_id", + "type": "TypeString", + "description": "Subscription ID.", + "computed": true + }, { "name": "destination_type", "type": "TypeString", @@ -107678,39 +112388,34 @@ "type": "TypeString", "description": "Name of the topic.", "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Subscription name.", - "required": true - }, + } + ], + "ibm_en_topic": [ { "name": "description", "type": "TypeString", - "description": "Subscription description.", + "description": "Description of the topic.", "optional": true }, { - "name": "subscription_id", + "name": "topic_id", "type": "TypeString", - "description": "Subscription ID.", + "description": "Topic ID.", "computed": true }, { - "name": "destination_name", - "type": "TypeString", - "description": "The Destintion name.", + "name": "source_count", + "type": "TypeInt", + "description": "Number of sources.", "computed": true }, { - "name": "updated_at", + "name": "instance_guid", "type": "TypeString", - "description": "Last updated time.", - "computed": true - } - ], - "ibm_en_topic": [ + "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "immutable": true, + "required": true + }, { "name": "name", "type": "TypeString", @@ -107718,15 +112423,51 @@ "required": true }, { - "name": "description", - "type": "TypeString", - "description": "Description of the topic.", - "optional": true + "name": "sources", + "type": "TypeList", + "description": "List of sources.", + "optional": true, + "elem": { + "id": { + "name": "id", + "type": "TypeString", + "description": "ID of the source.", + "required": true + }, + "rules": { + "name": "rules", + "type": "TypeList", + "description": "List of rules.", + "optional": true, + "elem": { + "enabled": { + "name": "enabled", + "type": "TypeBool", + "description": "Whether the rule is enabled or not.", + "default_value": true, + "optional": true + }, + "event_type_filter": { + "name": "event_type_filter", + "type": "TypeString", + "description": "Event type filter.", + "required": true + }, + "notification_filter": { + "name": "notification_filter", + "type": "TypeString", + "description": "Notification filter.", + "default_value": "", + "optional": true + } + } + } + } }, { - "name": "source_count", - "type": "TypeInt", - "description": "Number of sources.", + "name": "updated_at", + "type": "TypeString", + "description": "Last time the topic was updated.", "computed": true }, { @@ -107784,81 +112525,32 @@ "computed": true } } - }, + } + ], + "ibm_enterprise": [ { - "name": "instance_guid", + "name": "source_account_id", "type": "TypeString", - "description": "Unique identifier for IBM Cloud Event Notifications instance.", + "description": "The ID of the account that is used to create the enterprise.", "immutable": true, "required": true }, { - "name": "sources", - "type": "TypeList", - "description": "List of sources.", - "optional": true, - "elem": { - "id": { - "name": "id", - "type": "TypeString", - "description": "ID of the source.", - "required": true - }, - "rules": { - "name": "rules", - "type": "TypeList", - "description": "List of rules.", - "optional": true, - "elem": { - "enabled": { - "name": "enabled", - "type": "TypeBool", - "description": "Whether the rule is enabled or not.", - "default_value": true, - "optional": true - }, - "event_type_filter": { - "name": "event_type_filter", - "type": "TypeString", - "description": "Event type filter.", - "required": true - }, - "notification_filter": { - "name": "notification_filter", - "type": "TypeString", - "description": "Notification filter.", - "default_value": "", - "optional": true - } - } - } - } - }, - { - "name": "topic_id", + "name": "name", "type": "TypeString", - "description": "Topic ID.", - "computed": true + "description": "The name of the enterprise. This field must have 3 - 60 characters.", + "required": true }, { - "name": "updated_at", - "type": "TypeString", - "description": "Last time the topic was updated.", - "computed": true - } - ], - "ibm_enterprise": [ - { - "name": "domain", + "name": "primary_contact_iam_id", "type": "TypeString", - "description": "A domain or subdomain for the enterprise, such as `example.com` or `my.example.com`.", - "optional": true + "description": "The IAM ID of the enterprise primary contact, such as `IBMid-0123ABC`. The IAM ID must already exist.", + "required": true }, { - "name": "crn", + "name": "url", "type": "TypeString", - "description": "The Cloud Resource Name (CRN) of the enterprise.", - "cloud_data_type": "crn", + "description": "The URL of the enterprise.", "computed": true }, { @@ -107868,28 +112560,22 @@ "computed": true }, { - "name": "created_by", + "name": "primary_contact_email", "type": "TypeString", - "description": "The IAM ID of the user or service that created the enterprise.", + "description": "The email of the primary contact of the enterprise.", "computed": true }, { - "name": "primary_contact_iam_id", - "type": "TypeString", - "description": "The IAM ID of the enterprise primary contact, such as `IBMid-0123ABC`. The IAM ID must already exist.", - "required": true - }, - { - "name": "name", + "name": "updated_by", "type": "TypeString", - "description": "The name of the enterprise. This field must have 3 - 60 characters.", - "required": true + "description": "The IAM ID of the user or service that updated the enterprise.", + "computed": true }, { - "name": "url", + "name": "domain", "type": "TypeString", - "description": "The URL of the enterprise.", - "computed": true + "description": "A domain or subdomain for the enterprise, such as `example.com` or `my.example.com`.", + "optional": true }, { "name": "enterprise_account_id", @@ -107898,9 +112584,10 @@ "computed": true }, { - "name": "primary_contact_email", + "name": "crn", "type": "TypeString", - "description": "The email of the primary contact of the enterprise.", + "description": "The Cloud Resource Name (CRN) of the enterprise.", + "cloud_data_type": "crn", "computed": true }, { @@ -107910,95 +112597,97 @@ "computed": true }, { - "name": "updated_at", + "name": "created_by", "type": "TypeString", - "description": "The time stamp at which the enterprise was last updated.", + "description": "The IAM ID of the user or service that created the enterprise.", "computed": true }, { - "name": "updated_by", + "name": "updated_at", "type": "TypeString", - "description": "The IAM ID of the user or service that updated the enterprise.", + "description": "The time stamp at which the enterprise was last updated.", "computed": true - }, - { - "name": "source_account_id", - "type": "TypeString", - "description": "The ID of the account that is used to create the enterprise.", - "immutable": true, - "required": true } ], "ibm_enterprise_account": [ { - "name": "account_id", + "name": "owner_iam_id", "type": "TypeString", - "description": "The source account id of account to be imported", + "description": "The IAM ID of the account owner, such as `IBMid-0123ABC`. The IAM ID must already exist.", + "immutable": true, "optional": true, "computed": true }, { - "name": "owner_email", - "type": "TypeString", - "description": "The email address of the owner of the account.", - "computed": true + "name": "traits", + "type": "TypeSet", + "description": "The traits object can be used to set properties on child accounts of an enterprise. You can pass a field to opt-out of Multi-Factor Authentication setting or setup enterprise IAM settings when creating a child account in the enterprise. This is an optional field.", + "optional": true, + "elem": { + "enterprise_iam_managed": { + "name": "enterprise_iam_managed", + "type": "TypeBool", + "description": "The Enterprise IAM settings property will be turned off for a newly created child account by default. You can enable this property by passing 'true' in this boolean field. This is an optional field.", + "optional": true + }, + "mfa": { + "name": "mfa", + "type": "TypeString", + "description": "By default MFA will be enabled on a child account. To opt out, pass the traits object with the mfa field set to empty string. This is an optional field.", + "optional": true + } + } }, { - "name": "updated_by", + "name": "url", "type": "TypeString", - "description": "The IAM ID of the user or service that updated the account.", + "description": "The URL of the account.", "computed": true }, { - "name": "enterprise_account_id", + "name": "account_id", "type": "TypeString", - "description": "The enterprise account ID.", + "description": "The source account id of account to be imported", "optional": true, "computed": true }, { - "name": "paid", - "type": "TypeBool", - "description": "The type of account - whether it is free or paid.", + "name": "enterprise_path", + "type": "TypeString", + "description": "The path from the enterprise to this particular account.", "computed": true }, { - "name": "created_at", + "name": "updated_by", "type": "TypeString", - "description": "The time stamp at which the account was created.", + "description": "The IAM ID of the user or service that updated the account.", "computed": true }, { - "name": "enterprise_path", + "name": "parent", "type": "TypeString", - "description": "The path from the enterprise to this particular account.", - "computed": true + "description": "The CRN of the parent under which the account will be created. The parent can be an existing account group or the enterprise itself.", + "required": true }, { - "name": "owner_iam_id", + "name": "name", "type": "TypeString", - "description": "The IAM ID of the account owner, such as `IBMid-0123ABC`. The IAM ID must already exist.", + "description": "The name of the account. This field must have 3 - 60 characters.", "immutable": true, "optional": true, "computed": true }, { - "name": "url", - "type": "TypeString", - "description": "The URL of the account.", - "computed": true - }, - { - "name": "crn", + "name": "enterprise_account_id", "type": "TypeString", - "description": "The Cloud Resource Name (CRN) of the account.", - "cloud_data_type": "crn", + "description": "The enterprise account ID.", + "optional": true, "computed": true }, { - "name": "state", - "type": "TypeString", - "description": "The state of the account.", + "name": "is_enterprise_account", + "type": "TypeBool", + "description": "The flag to indicate whether the account is an enterprise account or not.", "computed": true }, { @@ -108014,54 +112703,57 @@ "computed": true }, { - "name": "name", + "name": "state", "type": "TypeString", - "description": "The name of the account. This field must have 3 - 60 characters.", - "immutable": true, - "optional": true, + "description": "The state of the account.", "computed": true }, { - "name": "traits", - "type": "TypeSet", - "description": "The traits object can be used to set properties on child accounts of an enterprise. You can pass a field to opt-out of Multi-Factor Authentication setting or setup enterprise IAM settings when creating a child account in the enterprise. This is an optional field.", - "optional": true, - "elem": { - "enterprise_iam_managed": { - "name": "enterprise_iam_managed", - "type": "TypeBool", - "description": "The Enterprise IAM settings property will be turned off for a newly created child account by default. You can enable this property by passing 'true' in this boolean field. This is an optional field.", - "optional": true - }, - "mfa": { - "name": "mfa", - "type": "TypeString", - "description": "By default MFA will be enabled on a child account. To opt out, pass the traits object with the mfa field set to empty string. This is an optional field.", - "optional": true - } - } + "name": "paid", + "type": "TypeBool", + "description": "The type of account - whether it is free or paid.", + "computed": true }, { - "name": "enterprise_id", + "name": "owner_email", "type": "TypeString", - "description": "The enterprise ID that the account is a part of.", - "optional": true, + "description": "The email address of the owner of the account.", "computed": true }, { - "name": "is_enterprise_account", - "type": "TypeBool", - "description": "The flag to indicate whether the account is an enterprise account or not.", + "name": "crn", + "type": "TypeString", + "description": "The Cloud Resource Name (CRN) of the account.", + "cloud_data_type": "crn", "computed": true }, { - "name": "parent", + "name": "enterprise_id", "type": "TypeString", - "description": "The CRN of the parent under which the account will be created. The parent can be an existing account group or the enterprise itself.", - "required": true + "description": "The enterprise ID that the account is a part of.", + "optional": true, + "computed": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "The time stamp at which the account was created.", + "computed": true } ], "ibm_enterprise_account_group": [ + { + "name": "url", + "type": "TypeString", + "description": "The URL of the account group.", + "computed": true + }, + { + "name": "enterprise_account_id", + "type": "TypeString", + "description": "The enterprise account ID.", + "computed": true + }, { "name": "parent", "type": "TypeString", @@ -108075,6 +112767,13 @@ "description": "The IAM ID of the primary contact for this account group, such as `IBMid-0123ABC`. The IAM ID must already exist.", "required": true }, + { + "name": "crn", + "type": "TypeString", + "description": "The Cloud Resource Name (CRN) of the account group.", + "cloud_data_type": "crn", + "computed": true + }, { "name": "enterprise_id", "type": "TypeString", @@ -108082,28 +112781,27 @@ "computed": true }, { - "name": "state", + "name": "primary_contact_email", "type": "TypeString", - "description": "The state of the account group.", + "description": "The email address of the primary contact of the account group.", "computed": true }, { - "name": "enterprise_account_id", + "name": "created_by", "type": "TypeString", - "description": "The enterprise account ID.", + "description": "The IAM ID of the user or service that created the account group.", "computed": true }, { - "name": "crn", + "name": "name", "type": "TypeString", - "description": "The Cloud Resource Name (CRN) of the account group.", - "cloud_data_type": "crn", - "computed": true + "description": "The name of the account group. This field must have 3 - 60 characters.", + "required": true }, { - "name": "primary_contact_email", + "name": "state", "type": "TypeString", - "description": "The email address of the primary contact of the account group.", + "description": "The state of the account group.", "computed": true }, { @@ -108118,30 +112816,12 @@ "description": "The time stamp at which the account group was last updated.", "computed": true }, - { - "name": "name", - "type": "TypeString", - "description": "The name of the account group. This field must have 3 - 60 characters.", - "required": true - }, - { - "name": "url", - "type": "TypeString", - "description": "The URL of the account group.", - "computed": true - }, { "name": "enterprise_path", "type": "TypeString", "description": "The path from the enterprise to this particular account group.", "computed": true }, - { - "name": "created_by", - "type": "TypeString", - "description": "The IAM ID of the user or service that created the account group.", - "computed": true - }, { "name": "updated_by", "type": "TypeString", @@ -108150,6 +112830,20 @@ } ], "ibm_event_streams_schema": [ + { + "name": "schema", + "type": "TypeString", + "description": "The schema in JSON format", + "required": true + }, + { + "name": "schema_id", + "type": "TypeString", + "description": "The ID to be assigned to schema, which must be unique. If this value is not specified, a generated UUID is assigned.", + "immutable": true, + "optional": true, + "computed": true + }, { "name": "resource_instance_id", "type": "TypeString", @@ -108166,23 +112860,22 @@ "type": "TypeString", "description": "The API endpoint for interacting with an Event Streams REST API", "computed": true - }, - { - "name": "schema", - "type": "TypeString", - "description": "The schema in JSON format", - "required": true - }, - { - "name": "schema_id", - "type": "TypeString", - "description": "The ID to be assigned to schema, which must be unique. If this value is not specified, a generated UUID is assigned.", - "immutable": true, - "optional": true, - "computed": true } ], "ibm_event_streams_topic": [ + { + "name": "partitions", + "type": "TypeInt", + "description": "The number of partitions", + "default_value": 1, + "optional": true + }, + { + "name": "config", + "type": "TypeMap", + "description": "The configuration parameters of a topic", + "optional": true + }, { "name": "resource_instance_id", "type": "TypeString", @@ -108213,22 +112906,28 @@ "type": "TypeString", "description": "The name of the topic", "required": true + } + ], + "ibm_firewall": [ + { + "name": "location", + "type": "TypeString", + "description": "Location info", + "cloud_data_type": "region", + "computed": true }, { - "name": "partitions", - "type": "TypeInt", - "description": "The number of partitions", - "default_value": 1, - "optional": true + "name": "primary_ip", + "type": "TypeString", + "description": "Primary IP address", + "computed": true }, { - "name": "config", - "type": "TypeMap", - "description": "The configuration parameters of a topic", - "optional": true - } - ], - "ibm_firewall": [ + "name": "username", + "type": "TypeString", + "description": "User name", + "computed": true + }, { "name": "password", "type": "TypeString", @@ -108267,28 +112966,19 @@ "elem": { "type": "TypeString" } - }, - { - "name": "location", - "type": "TypeString", - "description": "Location info", - "cloud_data_type": "region", - "computed": true - }, - { - "name": "primary_ip", - "type": "TypeString", - "description": "Primary IP address", - "computed": true - }, - { - "name": "username", - "type": "TypeString", - "description": "User name", - "computed": true } ], "ibm_firewall_policy": [ + { + "name": "tags", + "type": "TypeSet", + "description": "List of tags", + "cloud_data_type": "tags", + "optional": true, + "elem": { + "type": "TypeString" + } + }, { "name": "firewall_id", "type": "TypeInt", @@ -108348,29 +113038,15 @@ "required": true } } - }, - { - "name": "tags", - "type": "TypeSet", - "description": "List of tags", - "cloud_data_type": "tags", - "optional": true, - "elem": { - "type": "TypeString" - } } ], "ibm_function_action": [ { - "name": "parameters", - "type": "TypeString", - "description": "All paramters set on action by user and those set by the IBM Cloud Function backend/API.", - "computed": true - }, - { - "name": "action_id", + "name": "namespace", "type": "TypeString", - "computed": true + "description": "IBM Cloud function namespace.", + "immutable": true, + "required": true }, { "name": "limits", @@ -108402,6 +113078,63 @@ }, "max_items": 1 }, + { + "name": "user_defined_parameters", + "type": "TypeString", + "description": "Parameters values in KEY VALUE format. Parameter bindings included in the context passed to the action.", + "default_value": "[]", + "optional": true + }, + { + "name": "name", + "type": "TypeString", + "description": "Name of action.", + "immutable": true, + "required": true, + "matches": "^[^/*][a-zA-Z0-9/_@.-]" + }, + { + "name": "publish", + "type": "TypeBool", + "description": "Action visibilty.", + "optional": true + }, + { + "name": "version", + "type": "TypeString", + "description": "Semantic version of the item.", + "computed": true + }, + { + "name": "user_defined_annotations", + "type": "TypeString", + "description": "Annotation values in KEY VALUE format.", + "default_value": "[]", + "optional": true + }, + { + "name": "annotations", + "type": "TypeString", + "description": "All annotations set on action by user and those set by the IBM Cloud Function backend/API.", + "computed": true + }, + { + "name": "parameters", + "type": "TypeString", + "description": "All paramters set on action by user and those set by the IBM Cloud Function backend/API.", + "computed": true + }, + { + "name": "action_id", + "type": "TypeString", + "computed": true + }, + { + "name": "target_endpoint_url", + "type": "TypeString", + "description": "Action target endpoint URL.", + "computed": true + }, { "name": "exec", "type": "TypeList", @@ -108456,69 +113189,9 @@ } }, "max_items": 1 - }, - { - "name": "version", - "type": "TypeString", - "description": "Semantic version of the item.", - "computed": true - }, - { - "name": "user_defined_annotations", - "type": "TypeString", - "description": "Annotation values in KEY VALUE format.", - "default_value": "[]", - "optional": true - }, - { - "name": "user_defined_parameters", - "type": "TypeString", - "description": "Parameters values in KEY VALUE format. Parameter bindings included in the context passed to the action.", - "default_value": "[]", - "optional": true - }, - { - "name": "annotations", - "type": "TypeString", - "description": "All annotations set on action by user and those set by the IBM Cloud Function backend/API.", - "computed": true - }, - { - "name": "target_endpoint_url", - "type": "TypeString", - "description": "Action target endpoint URL.", - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Name of action.", - "immutable": true, - "required": true, - "matches": "^[^/*][a-zA-Z0-9/_@.-]" - }, - { - "name": "namespace", - "type": "TypeString", - "description": "IBM Cloud function namespace.", - "immutable": true, - "required": true - }, - { - "name": "publish", - "type": "TypeBool", - "description": "Action visibilty.", - "optional": true } ], "ibm_function_namespace": [ - { - "name": "location", - "type": "TypeString", - "description": "Namespace Location.", - "cloud_data_type": "region", - "computed": true - }, { "name": "name", "type": "TypeString", @@ -108537,21 +113210,22 @@ "description": "Resource Group ID.", "immutable": true, "required": true + }, + { + "name": "location", + "type": "TypeString", + "description": "Namespace Location.", + "cloud_data_type": "region", + "computed": true } ], "ibm_function_package": [ { - "name": "publish", - "type": "TypeBool", - "description": "Package visibilty.", - "default_value": false, - "optional": true - }, - { - "name": "version", + "name": "user_defined_parameters", "type": "TypeString", - "description": "Semantic version of the item.", - "computed": true + "description": "Parameters values in KEY VALUE format. Parameter bindings included in the context passed to the package.", + "default_value": "[]", + "optional": true }, { "name": "annotations", @@ -108559,13 +113233,6 @@ "description": "All annotations set on package by user and those set by the IBM Cloud Function backend/API.", "computed": true }, - { - "name": "bind_package_name", - "type": "TypeString", - "description": "Name of package to be binded.", - "immutable": true, - "optional": true - }, { "name": "package_id", "type": "TypeString", @@ -108587,39 +113254,40 @@ "matches": "\\A([\\w]|[\\w][\\w@ .-]*[\\w@.-]+)\\z" }, { - "name": "user_defined_annotations", - "type": "TypeString", - "description": "Annotation values in KEY VALUE format.", - "default_value": "[]", - "optional": true - }, - { - "name": "user_defined_parameters", - "type": "TypeString", - "description": "Parameters values in KEY VALUE format. Parameter bindings included in the context passed to the package.", - "default_value": "[]", + "name": "publish", + "type": "TypeBool", + "description": "Package visibilty.", + "default_value": false, "optional": true }, { - "name": "parameters", + "name": "version", "type": "TypeString", - "description": "All parameters set on package by user and those set by the IBM Cloud Function backend/API.", + "description": "Semantic version of the item.", "computed": true - } - ], - "ibm_function_rule": [ + }, { - "name": "action_name", + "name": "user_defined_annotations", "type": "TypeString", - "description": "Name of action.", - "required": true + "description": "Annotation values in KEY VALUE format.", + "default_value": "[]", + "optional": true }, { - "name": "status", + "name": "parameters", "type": "TypeString", - "description": "Status of the rule.", + "description": "All parameters set on package by user and those set by the IBM Cloud Function backend/API.", "computed": true }, + { + "name": "bind_package_name", + "type": "TypeString", + "description": "Name of package to be binded.", + "immutable": true, + "optional": true + } + ], + "ibm_function_rule": [ { "name": "publish", "type": "TypeBool", @@ -108657,9 +113325,33 @@ "type": "TypeString", "description": "Name of trigger.", "required": true + }, + { + "name": "action_name", + "type": "TypeString", + "description": "Name of action.", + "required": true + }, + { + "name": "status", + "type": "TypeString", + "description": "Status of the rule.", + "computed": true } ], "ibm_function_trigger": [ + { + "name": "version", + "type": "TypeString", + "description": "Semantic version of the item.", + "computed": true + }, + { + "name": "annotations", + "type": "TypeString", + "description": "All annotations set on trigger by user and those set by the IBM Cloud Function backend/API.", + "computed": true + }, { "name": "trigger_id", "type": "TypeString", @@ -108696,18 +113388,6 @@ }, "max_items": 1 }, - { - "name": "publish", - "type": "TypeBool", - "description": "Trigger visbility.", - "computed": true - }, - { - "name": "version", - "type": "TypeString", - "description": "Semantic version of the item.", - "computed": true - }, { "name": "user_defined_annotations", "type": "TypeString", @@ -108737,20 +113417,13 @@ "matches": "\\A([\\w]|[\\w][\\w@ .-]*[\\w@.-]+)\\z" }, { - "name": "annotations", - "type": "TypeString", - "description": "All annotations set on trigger by user and those set by the IBM Cloud Function backend/API.", + "name": "publish", + "type": "TypeBool", + "description": "Trigger visbility.", "computed": true } ], "ibm_hardware_firewall_shared": [ - { - "name": "hardware_instance_id", - "type": "TypeInt", - "description": "Hardware instance ID", - "immutable": true, - "optional": true - }, { "name": "billing_item_id", "type": "TypeInt", @@ -108770,21 +113443,26 @@ "description": "Virtual instance ID", "immutable": true, "optional": true + }, + { + "name": "hardware_instance_id", + "type": "TypeInt", + "description": "Hardware instance ID", + "immutable": true, + "optional": true } ], "ibm_hpcs": [ { - "name": "resource_group_id", - "type": "TypeString", - "description": "The resource group id", - "cloud_data_type": "resource_group", - "optional": true, - "computed": true + "name": "failover_units", + "type": "TypeInt", + "description": "The number of failover crypto units for your service instance", + "optional": true }, { - "name": "resource_keys_url", + "name": "scheduled_reclaim_by", "type": "TypeString", - "description": "The relative path to the resource keys for the instance.", + "description": "The subject who initiated the instance reclamation.", "computed": true }, { @@ -108793,12 +113471,6 @@ "description": "The plan type of the HPCS Instance", "required": true }, - { - "name": "created_at", - "type": "TypeString", - "description": "The date when the instance was created.", - "computed": true - }, { "name": "created_by", "type": "TypeString", @@ -108806,35 +113478,23 @@ "computed": true }, { - "name": "scheduled_reclaim_by", + "name": "deleted_at", "type": "TypeString", - "description": "The subject who initiated the instance reclamation.", + "description": "The date when the instance was deleted.", "computed": true }, { - "name": "failover_units", - "type": "TypeInt", - "description": "The number of failover crypto units for your service instance", - "optional": true - }, - { - "name": "guid", - "type": "TypeString", - "description": "Guid of HPCS instance", + "name": "extensions", + "type": "TypeMap", + "description": "The extended metadata as a map associated with the HPCS instance.", "computed": true }, { - "name": "units", + "name": "revocation_threshold", "type": "TypeInt", - "description": "The number of operational crypto units for your service instance", + "description": "Revocation Threshold Value", "required": true }, - { - "name": "resource_aliases_url", - "type": "TypeString", - "description": "The relative path to the resource aliases for the instance.", - "computed": true - }, { "name": "location", "type": "TypeString", @@ -108843,23 +113503,37 @@ "required": true }, { - "name": "tags", - "type": "TypeSet", - "min_length": 1, - "max_length": 128, - "matches": "^[A-Za-z0-9:_ .-]+$", + "name": "resource_group_id", + "type": "TypeString", + "description": "The resource group id", + "cloud_data_type": "resource_group", "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "computed": true }, { - "name": "dashboard_url", + "name": "state", "type": "TypeString", - "description": "Dashboard URL to access resource.", + "description": "The current state of the instance.", + "computed": true + }, + { + "name": "update_at", + "type": "TypeString", + "description": "The date when the instance was last updated.", "computed": true }, + { + "name": "restored_at", + "type": "TypeString", + "description": "The date when the instance under reclamation was restored.", + "computed": true + }, + { + "name": "signature_threshold", + "type": "TypeInt", + "description": "Signature Threshold Value", + "required": true + }, { "name": "admins", "type": "TypeSet", @@ -108888,22 +113562,28 @@ } }, { - "name": "restored_by", - "type": "TypeString", - "description": "The subject who restored the instance back from reclamation.", - "computed": true + "name": "tags", + "type": "TypeSet", + "min_length": 1, + "max_length": 128, + "matches": "^[A-Za-z0-9:_ .-]+$", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "extensions", - "type": "TypeMap", - "description": "The extended metadata as a map associated with the HPCS instance.", + "name": "status", + "type": "TypeString", + "description": "Status of HPCS instance", "computed": true }, { - "name": "signature_server_url", + "name": "created_at", "type": "TypeString", - "description": "URL of signing service", - "optional": true + "description": "The date when the instance was created.", + "computed": true }, { "name": "name", @@ -108912,35 +113592,41 @@ "required": true }, { - "name": "crn", + "name": "units", + "type": "TypeInt", + "description": "The number of operational crypto units for your service instance", + "required": true + }, + { + "name": "restored_by", "type": "TypeString", - "description": "CRN of HPCS instance", - "cloud_data_type": "crn", + "description": "The subject who restored the instance back from reclamation.", "computed": true }, { - "name": "deleted_at", + "name": "service", "type": "TypeString", - "description": "The date when the instance was deleted.", - "computed": true + "description": "The name of the service offering `hs-crypto`", + "default_value": "hs-crypto", + "optional": true }, { - "name": "deleted_by", + "name": "dashboard_url", "type": "TypeString", - "description": "The subject who deleted the instance.", + "description": "Dashboard URL to access resource.", "computed": true }, { - "name": "restored_at", + "name": "resource_bindings_url", "type": "TypeString", - "description": "The date when the instance under reclamation was restored.", + "description": "The relative path to the resource bindings for the instance.", "computed": true }, { - "name": "signature_threshold", - "type": "TypeInt", - "description": "Signature Threshold Value", - "required": true + "name": "resource_keys_url", + "type": "TypeString", + "description": "The relative path to the resource keys for the instance.", + "computed": true }, { "name": "hsm_info", @@ -109017,74 +113703,82 @@ } }, { - "name": "update_by", + "name": "service_endpoints", "type": "TypeString", - "description": "The subject who updated the instance.", + "description": "Types of the service endpoints. Possible values are `public-and-private`, `private-only`.", + "optional": true, "computed": true }, { - "name": "revocation_threshold", - "type": "TypeInt", - "description": "Revocation Threshold Value", - "required": true - }, - { - "name": "service", + "name": "crn", "type": "TypeString", - "description": "The name of the service offering `hs-crypto`", - "default_value": "hs-crypto", - "optional": true + "description": "CRN of HPCS instance", + "cloud_data_type": "crn", + "computed": true }, { - "name": "service_endpoints", + "name": "guid", "type": "TypeString", - "description": "Types of the service endpoints. Possible values are `public-and-private`, `private-only`.", - "optional": true, + "description": "Guid of HPCS instance", "computed": true }, { - "name": "status", + "name": "scheduled_reclaim_at", "type": "TypeString", - "description": "Status of HPCS instance", + "description": "The date when the instance was scheduled for reclamation.", "computed": true }, { - "name": "resource_bindings_url", + "name": "signature_server_url", "type": "TypeString", - "description": "The relative path to the resource bindings for the instance.", - "computed": true + "description": "URL of signing service", + "optional": true }, { - "name": "update_at", + "name": "resource_aliases_url", "type": "TypeString", - "description": "The date when the instance was last updated.", + "description": "The relative path to the resource aliases for the instance.", "computed": true }, { - "name": "state", + "name": "update_by", "type": "TypeString", - "description": "The current state of the instance.", + "description": "The subject who updated the instance.", "computed": true }, { - "name": "scheduled_reclaim_at", + "name": "deleted_by", "type": "TypeString", - "description": "The date when the instance was scheduled for reclamation.", + "description": "The subject who deleted the instance.", "computed": true } ], "ibm_hpcs_key_template": [ { - "name": "updated_by", + "name": "instance_id", "type": "TypeString", - "description": "ID of the user that updated the key.", - "computed": true + "description": "The ID of the UKO instance this resource exists in.", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true, + "cloud_data_range": [ + "service:hs-crypto" + ] }, { - "name": "href", + "name": "description", "type": "TypeString", - "description": "A URL that uniquely identifies your cloud resource.", - "computed": true + "description": "Description of the key template.", + "max_length": 200, + "matches": "(.|\\\\n)*", + "optional": true + }, + { + "name": "uko_vault", + "type": "TypeString", + "description": "The UUID of the Vault in which the update is to take place.", + "immutable": true, + "required": true }, { "name": "vault", @@ -109102,6 +113796,77 @@ "max_items": 1, "min_items": 1 }, + { + "name": "keystores", + "type": "TypeList", + "description": "An array describing the type and group of target keystores the managed key is to be installed in.", + "required": true, + "elem": { + "google_key_protection_level": { + "name": "google_key_protection_level", + "type": "TypeString", + "optional": true + }, + "google_key_purpose": { + "name": "google_key_purpose", + "type": "TypeString", + "optional": true + }, + "google_kms_algorithm": { + "name": "google_kms_algorithm", + "type": "TypeString", + "optional": true + }, + "group": { + "name": "group", + "type": "TypeString", + "description": "Which keystore group to distribute the key to.", + "required": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "Type of keystore.", + "required": true + } + } + }, + { + "name": "created_at", + "type": "TypeString", + "description": "Date and time when the key template was created.", + "computed": true + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Date and time when the key template was updated.", + "computed": true + }, + { + "name": "updated_by", + "type": "TypeString", + "description": "ID of the user that updated the key.", + "computed": true + }, + { + "name": "region", + "type": "TypeString", + "description": "The region of the UKO instance this resource exists in.", + "immutable": true, + "required": true, + "options": "au-syd, in-che, jp-osa, jp-tok, kr-seo, eu-de, eu-gb, ca-tor, us-south, us-south-test, us-east, br-sao" + }, + { + "name": "name", + "type": "TypeString", + "description": "Name of the template, it will be referenced when creating managed keys.", + "immutable": true, + "required": true, + "min_length": 1, + "max_length": 30, + "matches": "^[A-Za-z][A-Za-z0-9-]*$" + }, { "name": "key", "type": "TypeList", @@ -109143,38 +113908,25 @@ "min_items": 1 }, { - "name": "created_at", + "name": "version", "type": "TypeString", - "description": "Date and time when the key template was created.", + "description": "Version of the key template. Every time the key template is updated, the version will be updated automatically.", "computed": true }, - { - "name": "instance_id", - "type": "TypeString", - "description": "The ID of the UKO instance this resource exists in.", - "cloud_data_type": "resource_instance", - "immutable": true, - "required": true, - "cloud_data_range": [ - "service:hs-crypto" - ] - }, - { - "name": "name", - "type": "TypeString", - "description": "Name of the template, it will be referenced when creating managed keys.", - "immutable": true, - "required": true, - "min_length": 1, - "max_length": 30, - "matches": "^[A-Za-z][A-Za-z0-9-]*$" - }, { "name": "created_by", "type": "TypeString", "description": "ID of the user that created the key template.", "computed": true }, + { + "name": "href", + "type": "TypeString", + "description": "A URL that uniquely identifies your cloud resource.", + "computed": true + } + ], + "ibm_hpcs_keystore": [ { "name": "uko_vault", "type": "TypeString", @@ -109183,104 +113935,96 @@ "required": true }, { - "name": "description", + "name": "google_location", "type": "TypeString", - "description": "Description of the key template.", - "max_length": 200, - "matches": "(.|\\\\n)*", + "description": "Location represents the geographical region where a Cloud KMS resource is stored and can be accessed. A key's location impacts the performance of applications using the key.", "optional": true }, { - "name": "updated_at", + "name": "google_project_id", "type": "TypeString", - "description": "Date and time when the key template was updated.", + "description": "The project id associated with this keystore.", + "optional": true + }, + { + "name": "aws_secret_access_key", + "type": "TypeString", + "description": "The secret access key used for connecting to this instance of AWS KMS.", + "secure": true, + "optional": true + }, + { + "name": "created_by", + "type": "TypeString", + "description": "ID of the user that created the key.", "computed": true }, { - "name": "region", + "name": "etag", "type": "TypeString", - "description": "The region of the UKO instance this resource exists in.", - "immutable": true, - "required": true, - "options": "au-syd, in-che, jp-osa, jp-tok, kr-seo, eu-de, eu-gb, ca-tor, us-south, us-south-test, us-east, br-sao" + "computed": true }, { - "name": "keystores", - "type": "TypeList", - "description": "An array describing the type and group of target keystores the managed key is to be installed in.", + "name": "location", + "type": "TypeString", + "description": "Geographic location of the keystore, if available.", + "cloud_data_type": "region", + "computed": true + }, + { + "name": "instance_id", + "type": "TypeString", + "description": "The ID of the UKO instance this resource exists in.", + "cloud_data_type": "resource_instance", + "immutable": true, "required": true, - "elem": { - "google_key_protection_level": { - "name": "google_key_protection_level", - "type": "TypeString", - "optional": true - }, - "google_key_purpose": { - "name": "google_key_purpose", - "type": "TypeString", - "optional": true - }, - "google_kms_algorithm": { - "name": "google_kms_algorithm", - "type": "TypeString", - "optional": true - }, - "group": { - "name": "group", - "type": "TypeString", - "description": "Which keystore group to distribute the key to.", - "required": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "Type of keystore.", - "required": true - } - } + "cloud_data_range": [ + "service:hs-crypto" + ] }, { - "name": "version", + "name": "region", "type": "TypeString", - "description": "Version of the key template. Every time the key template is updated, the version will be updated automatically.", - "computed": true - } - ], - "ibm_hpcs_keystore": [ + "description": "The region of the UKO instance this resource exists in.", + "immutable": true, + "required": true, + "options": "au-syd, in-che, jp-osa, jp-tok, kr-seo, eu-de, eu-gb, ca-tor, us-south, us-south-test, us-east, br-sao" + }, { - "name": "ibm_iam_endpoint", + "name": "google_key_ring", "type": "TypeString", - "description": "Endpoint of the IAM service for this IBM Cloud keystore.", + "description": "A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys.", "optional": true }, { - "name": "etag", + "name": "ibm_api_key", "type": "TypeString", - "computed": true + "description": "The IBM Cloud API key to be used for connecting to this IBM Cloud keystore.", + "secure": true, + "optional": true }, { - "name": "azure_location", + "name": "ibm_instance_id", "type": "TypeString", - "description": "Location of the Azure Key Vault.", + "description": "The instance ID of the IBM Cloud keystore.", "optional": true }, { - "name": "google_project_id", + "name": "updated_at", "type": "TypeString", - "description": "The project id associated with this keystore.", - "optional": true + "description": "Date and time when the target keystore was last updated.", + "computed": true }, { - "name": "azure_service_principal_client_id", + "name": "azure_resource_group", "type": "TypeString", - "description": "Azure service principal client ID.", + "description": "Resource group in Azure.", "optional": true }, { - "name": "azure_service_principal_password", + "name": "azure_location", "type": "TypeString", - "description": "Azure service principal password.", - "secure": true, + "description": "Location of the Azure Key Vault.", "optional": true }, { @@ -109290,42 +114034,46 @@ "optional": true }, { - "name": "azure_environment", + "name": "description", "type": "TypeString", - "description": "Azure environment, usually 'Azure'.", + "description": "Description of the keystore.", "optional": true }, { - "name": "ibm_key_ring", + "name": "type", "type": "TypeString", - "description": "The key ring of an IBM Cloud KMS Keystore.", + "description": "Type of keystore.", + "required": true + }, + { + "name": "dry_run", + "type": "TypeBool", + "description": "Do not create a keystore, only verify if keystore created with given parameters can be communciated with successfully.", + "default_value": false, "optional": true }, { - "name": "description", + "name": "azure_subscription_id", "type": "TypeString", - "description": "Description of the keystore.", + "description": "Subscription ID in Azure.", "optional": true }, { - "name": "region", + "name": "ibm_api_endpoint", "type": "TypeString", - "description": "The region of the UKO instance this resource exists in.", - "immutable": true, - "required": true, - "options": "au-syd, in-che, jp-osa, jp-tok, kr-seo, eu-de, eu-gb, ca-tor, us-south, us-south-test, us-east, br-sao" + "description": "API endpoint of the IBM Cloud keystore.", + "optional": true }, { - "name": "created_at", + "name": "updated_by", "type": "TypeString", - "description": "Date and time when the target keystore was created.", + "description": "ID of the user that last updated the key.", "computed": true }, { - "name": "google_credentials", + "name": "ibm_iam_endpoint", "type": "TypeString", - "description": "The value of the JSON key represented in the Base64 format.", - "secure": true, + "description": "Endpoint of the IAM service for this IBM Cloud keystore.", "optional": true }, { @@ -109355,36 +114103,16 @@ } }, { - "name": "created_by", - "type": "TypeString", - "description": "ID of the user that created the key.", - "computed": true - }, - { - "name": "uko_vault", - "type": "TypeString", - "description": "The UUID of the Vault in which the update is to take place.", - "immutable": true, - "required": true - }, - { - "name": "aws_secret_access_key", + "name": "google_credentials", "type": "TypeString", - "description": "The secret access key used for connecting to this instance of AWS KMS.", + "description": "The value of the JSON key represented in the Base64 format.", "secure": true, "optional": true }, { - "name": "ibm_api_endpoint", - "type": "TypeString", - "description": "API endpoint of the IBM Cloud keystore.", - "optional": true - }, - { - "name": "ibm_api_key", + "name": "google_private_key_id", "type": "TypeString", - "description": "The IBM Cloud API key to be used for connecting to this IBM Cloud keystore.", - "secure": true, + "description": "The private key id associated with this keystore.", "optional": true }, { @@ -109394,80 +114122,40 @@ "optional": true }, { - "name": "azure_subscription_id", - "type": "TypeString", - "description": "Subscription ID in Azure.", - "optional": true - }, - { - "name": "ibm_instance_id", + "name": "azure_service_name", "type": "TypeString", - "description": "The instance ID of the IBM Cloud keystore.", + "description": "Service name of the key vault instance from the Azure portal.", "optional": true }, { - "name": "groups", - "type": "TypeList", - "description": "List of groups that this keystore belongs to.", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "type", - "type": "TypeString", - "description": "Type of keystore.", - "required": true - }, - { - "name": "updated_at", - "type": "TypeString", - "description": "Date and time when the target keystore was last updated.", - "computed": true - }, - { - "name": "aws_access_key_id", + "name": "azure_service_principal_password", "type": "TypeString", - "description": "The access key id used for connecting to this instance of AWS KMS.", + "description": "Azure service principal password.", "secure": true, "optional": true }, { - "name": "google_private_key_id", - "type": "TypeString", - "description": "The private key id associated with this keystore.", - "optional": true - }, - { - "name": "google_key_ring", - "type": "TypeString", - "description": "A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys.", - "optional": true - }, - { - "name": "azure_resource_group", + "name": "azure_environment", "type": "TypeString", - "description": "Resource group in Azure.", + "description": "Azure environment, usually 'Azure'.", "optional": true }, { - "name": "location", + "name": "href", "type": "TypeString", - "description": "Geographic location of the keystore, if available.", - "cloud_data_type": "region", + "description": "A URL that uniquely identifies your cloud resource.", "computed": true }, { - "name": "href", + "name": "ibm_variant", "type": "TypeString", - "description": "A URL that uniquely identifies your cloud resource.", - "computed": true + "description": "Possible IBM Cloud KMS variants.", + "optional": true }, { - "name": "google_location", + "name": "ibm_key_ring", "type": "TypeString", - "description": "Location represents the geographical region where a Cloud KMS resource is stored and can be accessed. A key's location impacts the performance of applications using the key.", + "description": "The key ring of an IBM Cloud KMS Keystore.", "optional": true }, { @@ -109477,109 +114165,89 @@ "optional": true }, { - "name": "updated_by", - "type": "TypeString", - "description": "ID of the user that last updated the key.", - "computed": true + "name": "groups", + "type": "TypeList", + "description": "List of groups that this keystore belongs to.", + "optional": true, + "elem": { + "type": "TypeString" + } }, { - "name": "ibm_variant", + "name": "aws_access_key_id", "type": "TypeString", - "description": "Possible IBM Cloud KMS variants.", - "optional": true - }, - { - "name": "dry_run", - "type": "TypeBool", - "description": "Do not create a keystore, only verify if keystore created with given parameters can be communciated with successfully.", - "default_value": false, + "description": "The access key id used for connecting to this instance of AWS KMS.", + "secure": true, "optional": true }, { - "name": "azure_service_name", + "name": "azure_service_principal_client_id", "type": "TypeString", - "description": "Service name of the key vault instance from the Azure portal.", + "description": "Azure service principal client ID.", "optional": true }, { - "name": "instance_id", + "name": "created_at", "type": "TypeString", - "description": "The ID of the UKO instance this resource exists in.", - "cloud_data_type": "resource_instance", - "immutable": true, - "required": true, - "cloud_data_range": [ - "service:hs-crypto" - ] + "description": "Date and time when the target keystore was created.", + "computed": true } ], "ibm_hpcs_managed_key": [ { - "name": "size", - "type": "TypeString", - "description": "The size of the underlying cryptographic key or key pair. E.g. \"256\" for AES keys, or \"2048\" for RSA.", - "computed": true - }, - { - "name": "activation_date", - "type": "TypeString", - "description": "First day when the key is active.", - "computed": true - }, - { - "name": "created_by", - "type": "TypeString", - "description": "ID of the user that created the key.", - "computed": true - }, - { - "name": "key_id", - "type": "TypeString", - "description": "The UUID of the key.", - "computed": true - }, - { - "name": "template_name", + "name": "label", "type": "TypeString", - "description": "Name of the key template to use when creating a key.", + "description": "The label of the key.", "required": true, "min_length": 1, - "max_length": 30, - "matches": "^[A-Za-z][A-Za-z0-9-]+$" + "max_length": 255, + "matches": "^[A-Za-z0-9._ \\/-]+$" }, { - "name": "template", + "name": "tags", "type": "TypeList", - "description": "Reference to a key template.", - "computed": true, + "description": "Key-value pairs associated with the key.", + "cloud_data_type": "tags", + "optional": true, "elem": { - "href": { - "name": "href", + "name": { + "name": "name", "type": "TypeString", - "description": "A URL that uniquely identifies your cloud resource.", - "optional": true, - "computed": true + "description": "Name of a tag.", + "required": true }, - "id": { - "name": "id", + "value": { + "name": "value", "type": "TypeString", - "description": "The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.", - "optional": true, - "computed": true + "description": "Value of a tag.", + "required": true + } + } + }, + { + "name": "verification_patterns", + "type": "TypeList", + "description": "A list of verification patterns of the key (e.g. public key hash for RSA keys).", + "computed": true, + "elem": { + "method": { + "name": "method", + "type": "TypeString", + "description": "The method used for calculating the verification pattern.", + "required": true }, - "name": { - "name": "name", + "value": { + "name": "value", "type": "TypeString", - "description": "Name of the key template.", - "optional": true, - "computed": true + "description": "The calculated value.", + "required": true } } }, { - "name": "updated_at", + "name": "created_by", "type": "TypeString", - "description": "Date and time when the key was last updated.", + "description": "ID of the user that created the key.", "computed": true }, { @@ -109618,9 +114286,8 @@ } }, { - "name": "href", + "name": "etag", "type": "TypeString", - "description": "A URL that uniquely identifies your cloud resource.", "computed": true }, { @@ -109642,66 +114309,6 @@ "required": true, "options": "au-syd, in-che, jp-osa, jp-tok, kr-seo, eu-de, eu-gb, ca-tor, us-south, us-south-test, us-east, br-sao" }, - { - "name": "vault", - "type": "TypeList", - "description": "ID of the Vault where the entity is to be created in.", - "required": true, - "elem": { - "id": { - "name": "id", - "type": "TypeString", - "description": "The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.", - "required": true - } - }, - "max_items": 1, - "min_items": 1 - }, - { - "name": "tags", - "type": "TypeList", - "description": "Key-value pairs associated with the key.", - "cloud_data_type": "tags", - "optional": true, - "elem": { - "name": { - "name": "name", - "type": "TypeString", - "description": "Name of a tag.", - "required": true - }, - "value": { - "name": "value", - "type": "TypeString", - "description": "Value of a tag.", - "required": true - } - } - }, - { - "name": "algorithm", - "type": "TypeString", - "description": "The algorithm of the key.", - "computed": true - }, - { - "name": "expiration_date", - "type": "TypeString", - "description": "Last day when the key is active.", - "computed": true - }, - { - "name": "updated_by", - "type": "TypeString", - "description": "ID of the user that last updated the key.", - "computed": true - }, - { - "name": "etag", - "type": "TypeString", - "computed": true - }, { "name": "uko_vault", "type": "TypeString", @@ -109710,48 +114317,13 @@ "required": true }, { - "name": "label", + "name": "template_name", "type": "TypeString", - "description": "The label of the key.", + "description": "Name of the key template to use when creating a key.", "required": true, "min_length": 1, - "max_length": 255, - "matches": "^[A-Za-z0-9._ \\/-]+$" - }, - { - "name": "description", - "type": "TypeString", - "description": "Description of the managed key.", - "max_length": 200, - "matches": "(.|\\n)*", - "optional": true - }, - { - "name": "state", - "type": "TypeString", - "description": "The state of the key.", - "optional": true, - "computed": true - }, - { - "name": "verification_patterns", - "type": "TypeList", - "description": "A list of verification patterns of the key (e.g. public key hash for RSA keys).", - "computed": true, - "elem": { - "method": { - "name": "method", - "type": "TypeString", - "description": "The method used for calculating the verification pattern.", - "required": true - }, - "value": { - "name": "value", - "type": "TypeString", - "description": "The calculated value.", - "required": true - } - } + "max_length": 30, + "matches": "^[A-Za-z][A-Za-z0-9-]+$" }, { "name": "created_at", @@ -109821,43 +114393,117 @@ "computed": true } } - } - ], - "ibm_hpcs_vault": [ + }, { - "name": "instance_id", + "name": "key_id", "type": "TypeString", - "description": "The ID of the UKO instance this resource exists in.", - "cloud_data_type": "resource_instance", - "immutable": true, - "required": true, - "cloud_data_range": [ - "service:hs-crypto" - ] + "description": "The UUID of the key.", + "computed": true }, { - "name": "name", - "type": "TypeString", - "description": "A human-readable name to assign to your vault. To protect your privacy, do not use personal data, such as your name or location.", + "name": "vault", + "type": "TypeList", + "description": "ID of the Vault where the entity is to be created in.", "required": true, - "min_length": 1, - "max_length": 100, - "matches": "^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$" + "elem": { + "id": { + "name": "id", + "type": "TypeString", + "description": "The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.", + "required": true + } + }, + "max_items": 1, + "min_items": 1 }, { "name": "description", "type": "TypeString", - "description": "Description of the vault.", + "description": "Description of the managed key.", "max_length": 200, "matches": "(.|\\n)*", "optional": true }, { - "name": "created_at", + "name": "algorithm", "type": "TypeString", - "description": "Date and time when the vault was created.", + "description": "The algorithm of the key.", + "computed": true + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Date and time when the key was last updated.", + "computed": true + }, + { + "name": "href", + "type": "TypeString", + "description": "A URL that uniquely identifies your cloud resource.", + "computed": true + }, + { + "name": "template", + "type": "TypeList", + "description": "Reference to a key template.", + "computed": true, + "elem": { + "href": { + "name": "href", + "type": "TypeString", + "description": "A URL that uniquely identifies your cloud resource.", + "optional": true, + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The v4 UUID used to uniquely identify the resource, as specified by RFC 4122.", + "optional": true, + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Name of the key template.", + "optional": true, + "computed": true + } + } + }, + { + "name": "state", + "type": "TypeString", + "description": "The state of the key.", + "optional": true, + "computed": true + }, + { + "name": "size", + "type": "TypeString", + "description": "The size of the underlying cryptographic key or key pair. E.g. \"256\" for AES keys, or \"2048\" for RSA.", + "computed": true + }, + { + "name": "activation_date", + "type": "TypeString", + "description": "First day when the key is active.", "computed": true }, + { + "name": "expiration_date", + "type": "TypeString", + "description": "Last day when the key is active.", + "computed": true + }, + { + "name": "updated_by", + "type": "TypeString", + "description": "ID of the user that last updated the key.", + "computed": true + } + ], + "ibm_hpcs_vault": [ { "name": "href", "type": "TypeString", @@ -109870,12 +114516,18 @@ "computed": true }, { - "name": "region", + "name": "description", "type": "TypeString", - "description": "The region of the UKO instance this resource exists in.", - "immutable": true, - "required": true, - "options": "au-syd, in-che, jp-osa, jp-tok, kr-seo, eu-de, eu-gb, ca-tor, us-south, us-south-test, us-east, br-sao" + "description": "Description of the vault.", + "max_length": 200, + "matches": "(.|\\n)*", + "optional": true + }, + { + "name": "updated_by", + "type": "TypeString", + "description": "ID of the user that last updated the vault.", + "computed": true }, { "name": "vault_id", @@ -109883,6 +114535,21 @@ "description": "The ID of the vault.", "computed": true }, + { + "name": "name", + "type": "TypeString", + "description": "A human-readable name to assign to your vault. To protect your privacy, do not use personal data, such as your name or location.", + "required": true, + "min_length": 1, + "max_length": 100, + "matches": "^[A-Za-z0-9#@!$%'_-][A-Za-z0-9#@!$% '_-]*$" + }, + { + "name": "created_at", + "type": "TypeString", + "description": "Date and time when the vault was created.", + "computed": true + }, { "name": "updated_at", "type": "TypeString", @@ -109896,10 +114563,23 @@ "computed": true }, { - "name": "updated_by", + "name": "instance_id", "type": "TypeString", - "description": "ID of the user that last updated the vault.", - "computed": true + "description": "The ID of the UKO instance this resource exists in.", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true, + "cloud_data_range": [ + "service:hs-crypto" + ] + }, + { + "name": "region", + "type": "TypeString", + "description": "The region of the UKO instance this resource exists in.", + "immutable": true, + "required": true, + "options": "au-syd, in-che, jp-osa, jp-tok, kr-seo, eu-de, eu-gb, ca-tor, us-south, us-south-test, us-east, br-sao" } ], "ibm_iam_access_group": [ @@ -109945,6 +114625,29 @@ } ], "ibm_iam_access_group_dynamic_rule": [ + { + "name": "conditions", + "type": "TypeList", + "description": "conditions info", + "required": true, + "elem": { + "claim": { + "name": "claim", + "type": "TypeString", + "required": true + }, + "operator": { + "name": "operator", + "type": "TypeString", + "required": true + }, + "value": { + "name": "value", + "type": "TypeString", + "required": true + } + } + }, { "name": "rule_id", "type": "TypeString", @@ -109979,32 +114682,17 @@ "type": "TypeString", "description": "The realm name or identity proivider url", "required": true - }, - { - "name": "conditions", - "type": "TypeList", - "description": "conditions info", - "required": true, - "elem": { - "claim": { - "name": "claim", - "type": "TypeString", - "required": true - }, - "operator": { - "name": "operator", - "type": "TypeString", - "required": true - }, - "value": { - "name": "value", - "type": "TypeString", - "required": true - } - } } ], "ibm_iam_access_group_members": [ + { + "name": "iam_profile_ids", + "type": "TypeSet", + "optional": true, + "elem": { + "type": "TypeString" + } + }, { "name": "members", "type": "TypeList", @@ -110049,14 +114737,6 @@ "elem": { "type": "TypeString" } - }, - { - "name": "iam_profile_ids", - "type": "TypeSet", - "optional": true, - "elem": { - "type": "TypeString" - } } ], "ibm_iam_access_group_policy": [ @@ -110095,44 +114775,22 @@ "computed": true }, { - "name": "version", + "name": "rule_operator", "type": "TypeString", - "computed": true - }, - { - "name": "rule_conditions", - "type": "TypeSet", - "description": "Rule conditions enforced by the policy", - "optional": true, - "elem": { - "key": { - "name": "key", - "type": "TypeString", - "description": "Key of the condition", - "required": true - }, - "operator": { - "name": "operator", - "type": "TypeString", - "description": "Operator of the condition", - "required": true - }, - "value": { - "name": "value", - "type": "TypeList", - "description": "Value of the condition", - "required": true, - "elem": { - "type": "TypeString" - } - } - } + "description": "Operator that multiple rule conditions are evaluated over", + "optional": true }, { - "name": "pattern", + "name": "access_group_id", "type": "TypeString", - "description": "Pattern rule follows for time-based condition", - "optional": true + "description": "ID of access group", + "cloud_data_type": "iam", + "immutable": true, + "required": true, + "cloud_data_range": [ + "service:access_group", + "resolved_to:id" + ] }, { "name": "resources", @@ -110214,29 +114872,40 @@ } }, { - "name": "description", - "type": "TypeString", - "description": "Description of the Policy", - "optional": true + "name": "rule_conditions", + "type": "TypeSet", + "description": "Rule conditions enforced by the policy", + "optional": true, + "elem": { + "key": { + "name": "key", + "type": "TypeString", + "description": "Key of the condition", + "required": true + }, + "operator": { + "name": "operator", + "type": "TypeString", + "description": "Operator of the condition", + "required": true + }, + "value": { + "name": "value", + "type": "TypeList", + "description": "Value of the condition", + "required": true, + "elem": { + "type": "TypeString" + } + } + } }, { - "name": "rule_operator", + "name": "pattern", "type": "TypeString", - "description": "Operator that multiple rule conditions are evaluated over", + "description": "Pattern rule follows for time-based condition", "optional": true }, - { - "name": "access_group_id", - "type": "TypeString", - "description": "ID of access group", - "cloud_data_type": "iam", - "immutable": true, - "required": true, - "cloud_data_range": [ - "service:access_group", - "resolved_to:id" - ] - }, { "name": "roles", "type": "TypeList", @@ -110272,56 +114941,60 @@ "required": true } } + }, + { + "name": "description", + "type": "TypeString", + "description": "Description of the Policy", + "optional": true + }, + { + "name": "version", + "type": "TypeString", + "computed": true } ], "ibm_iam_access_group_template": [ { - "name": "policy_template_references", - "type": "TypeList", - "description": "References to policy templates assigned to the access group template.", - "immutable": true, + "name": "committed", + "type": "TypeBool", + "description": "A boolean indicating whether the access group template is committed. You must commit a template before you can assign it to child accounts.", "optional": true, - "elem": { - "id": { - "name": "id", - "type": "TypeString", - "description": "Policy template ID.", - "optional": true - }, - "version": { - "name": "version", - "type": "TypeString", - "description": "Policy template version.", - "optional": true - } - } + "computed": true }, { - "name": "last_modified_at", + "name": "created_at", "type": "TypeString", - "description": "The date and time when the access group template was last modified.", + "description": "The date and time when the access group template was created.", "computed": true }, { - "name": "account_id", + "name": "created_by_id", "type": "TypeString", - "description": "The ID of the account to which the access group template is assigned.", + "description": "The ID of the user who created the access group template.", "computed": true }, { - "name": "description", + "name": "last_modified_at", "type": "TypeString", - "description": "The description of the access group template.", - "max_length": 250, - "matches": "^[a-zA-Z0-9!@#$%^\u0026*()_+{}:;\"'\u003c\u003e,.?\\/|\\-\\s]+$", - "optional": true + "description": "The date and time when the access group template was last modified.", + "computed": true }, { - "name": "version", + "name": "last_modified_by_id", "type": "TypeString", - "description": "The version of the access group template.", + "description": "The ID of the user who last modified the access group template.", "computed": true }, + { + "name": "transaction_id", + "type": "TypeString", + "description": "An optional transaction id for the request.", + "min_length": 1, + "max_length": 50, + "matches": "^[a-zA-Z0-9_-]+$", + "optional": true + }, { "name": "name", "type": "TypeString", @@ -110332,21 +115005,9 @@ "matches": "^[a-zA-Z0-9!@#$%^\u0026*()_+{}:;\"'\u003c\u003e,.?\\/|\\-\\s]+$" }, { - "name": "created_by_id", - "type": "TypeString", - "description": "The ID of the user who created the access group template.", - "computed": true - }, - { - "name": "last_modified_by_id", - "type": "TypeString", - "description": "The ID of the user who last modified the access group template.", - "computed": true - }, - { - "name": "created_at", + "name": "account_id", "type": "TypeString", - "description": "The date and time when the access group template was created.", + "description": "The ID of the account to which the access group template is assigned.", "computed": true }, { @@ -110536,67 +115197,86 @@ "name": { "name": "name", "type": "TypeString", - "description": "Give the access group a unique name that doesn't conflict with other templates access group name in the given account. This is shown in child accounts.", - "required": true + "description": "Give the access group a unique name that doesn't conflict with other templates access group name in the given account. This is shown in child accounts.", + "required": true + } + }, + "max_items": 1 + }, + { + "name": "template_id", + "type": "TypeString", + "description": "Template ID.", + "computed": true + }, + { + "name": "policy_template_references", + "type": "TypeList", + "description": "References to policy templates assigned to the access group template.", + "immutable": true, + "optional": true, + "elem": { + "id": { + "name": "id", + "type": "TypeString", + "description": "Policy template ID.", + "optional": true + }, + "version": { + "name": "version", + "type": "TypeString", + "description": "Policy template version.", + "optional": true } - }, - "max_items": 1 - }, - { - "name": "committed", - "type": "TypeBool", - "description": "A boolean indicating whether the access group template is committed. You must commit a template before you can assign it to child accounts.", - "optional": true, - "computed": true + } }, { - "name": "href", + "name": "description", "type": "TypeString", - "description": "The URL of the access group template resource.", - "computed": true + "description": "The description of the access group template.", + "max_length": 250, + "matches": "^[a-zA-Z0-9!@#$%^\u0026*()_+{}:;\"'\u003c\u003e,.?\\/|\\-\\s]+$", + "optional": true }, { - "name": "template_id", + "name": "version", "type": "TypeString", - "description": "Template ID.", + "description": "The version of the access group template.", "computed": true }, { - "name": "transaction_id", + "name": "href", "type": "TypeString", - "description": "An optional transaction id for the request.", - "min_length": 1, - "max_length": 50, - "matches": "^[a-zA-Z0-9_-]+$", - "optional": true + "description": "The URL of the access group template resource.", + "computed": true } ], "ibm_iam_access_group_template_assignment": [ { - "name": "target", + "name": "target_type", "type": "TypeString", - "description": "The ID of the entity that the assignment applies to.", + "description": "The type of the entity that the assignment applies to.", "required": true, - "min_length": 1, - "max_length": 50, - "matches": "^[a-zA-Z0-9_-]+$" + "options": "Account, AccountGroup", + "min_length": 7, + "max_length": 12, + "matches": "^[a-zA-Z-]+$" }, { - "name": "last_modified_at", + "name": "account_id", "type": "TypeString", - "description": "The date and time when the assignment was last updated.", + "description": "The ID of the account that the assignment belongs to.", "computed": true }, { - "name": "href", + "name": "operation", "type": "TypeString", - "description": "The URL of the assignment resource.", + "description": "The operation that the assignment applies to (e.g. 'assign', 'update', 'remove').", "computed": true }, { - "name": "created_at", + "name": "etag", "type": "TypeString", - "description": "The date and time when the assignment was created.", "computed": true }, { @@ -110609,10 +115289,13 @@ "optional": true }, { - "name": "account_id", + "name": "template_id", "type": "TypeString", - "description": "The ID of the account that the assignment belongs to.", - "computed": true + "description": "The ID of the template that the assignment is based on.", + "required": true, + "min_length": 1, + "max_length": 100, + "matches": "^[a-zA-Z0-9_-]+$" }, { "name": "template_version", @@ -110624,11 +115307,20 @@ "matches": "^[0-9]+$" }, { - "name": "operation", + "name": "last_modified_at", "type": "TypeString", - "description": "The operation that the assignment applies to (e.g. 'assign', 'update', 'remove').", + "description": "The date and time when the assignment was last updated.", "computed": true }, + { + "name": "target", + "type": "TypeString", + "description": "The ID of the entity that the assignment applies to.", + "required": true, + "min_length": 1, + "max_length": 50, + "matches": "^[a-zA-Z0-9_-]+$" + }, { "name": "status", "type": "TypeString", @@ -110648,42 +115340,55 @@ "computed": true }, { - "name": "etag", + "name": "href", "type": "TypeString", + "description": "The URL of the assignment resource.", "computed": true }, { - "name": "template_id", - "type": "TypeString", - "description": "The ID of the template that the assignment is based on.", - "required": true, - "min_length": 1, - "max_length": 100, - "matches": "^[a-zA-Z0-9_-]+$" - }, - { - "name": "target_type", + "name": "created_at", "type": "TypeString", - "description": "The type of the entity that the assignment applies to.", - "required": true, - "options": "Account, AccountGroup", - "min_length": 7, - "max_length": 12, - "matches": "^[a-zA-Z-]+$" + "description": "The date and time when the assignment was created.", + "computed": true } ], "ibm_iam_access_group_template_version": [ { - "name": "last_modified_at", + "name": "transaction_id", "type": "TypeString", - "description": "The date and time when the access group template was last modified.", - "computed": true + "description": "An optional transaction id for the request.", + "min_length": 1, + "max_length": 50, + "matches": "^[a-zA-Z0-9_-]+$", + "optional": true }, { - "name": "last_modified_by_id", + "name": "policy_template_references", + "type": "TypeList", + "description": "References to policy templates assigned to the access group template.", + "optional": true, + "elem": { + "id": { + "name": "id", + "type": "TypeString", + "description": "Policy template ID.", + "optional": true + }, + "version": { + "name": "version", + "type": "TypeString", + "description": "Policy template version.", + "optional": true + } + } + }, + { + "name": "description", "type": "TypeString", - "description": "The ID of the user who last modified the access group template.", - "computed": true + "description": "The description of the access group template.", + "max_length": 250, + "matches": "^[a-zA-Z0-9!@#$%^\u0026*()_+{}:;\"'\u003c\u003e,.?\\/|\\-\\s]+$", + "optional": true }, { "name": "group", @@ -110881,16 +115586,9 @@ "max_items": 1 }, { - "name": "committed", - "type": "TypeBool", - "description": "A boolean indicating whether the access group template is committed. You must commit a template before you can assign it to child accounts.", - "optional": true, - "computed": true - }, - { - "name": "href", + "name": "last_modified_at", "type": "TypeString", - "description": "The URL of the access group template resource.", + "description": "The date and time when the access group template was last modified.", "computed": true }, { @@ -110903,38 +115601,27 @@ "optional": true }, { - "name": "created_at", + "name": "account_id", "type": "TypeString", - "description": "The date and time when the access group template was created.", + "description": "The ID of the account to which the access group template is assigned.", "computed": true }, { - "name": "transaction_id", - "type": "TypeString", - "description": "An optional transaction id for the request.", - "min_length": 1, - "max_length": 50, - "matches": "^[a-zA-Z0-9_-]+$", - "optional": true - }, - { - "name": "description", + "name": "version", "type": "TypeString", - "description": "The description of the access group template.", - "max_length": 250, - "matches": "^[a-zA-Z0-9!@#$%^\u0026*()_+{}:;\"'\u003c\u003e,.?\\/|\\-\\s]+$", - "optional": true + "description": "The version of the access group template.", + "computed": true }, { - "name": "version", + "name": "created_at", "type": "TypeString", - "description": "The version of the access group template.", + "description": "The date and time when the access group template was created.", "computed": true }, { - "name": "created_by_id", + "name": "last_modified_by_id", "type": "TypeString", - "description": "The ID of the user who created the access group template.", + "description": "The ID of the user who last modified the access group template.", "computed": true }, { @@ -110948,33 +115635,40 @@ "matches": "^[a-zA-Z0-9_-]+$" }, { - "name": "policy_template_references", - "type": "TypeList", - "description": "References to policy templates assigned to the access group template.", + "name": "committed", + "type": "TypeBool", + "description": "A boolean indicating whether the access group template is committed. You must commit a template before you can assign it to child accounts.", "optional": true, - "elem": { - "id": { - "name": "id", - "type": "TypeString", - "description": "Policy template ID.", - "optional": true - }, - "version": { - "name": "version", - "type": "TypeString", - "description": "Policy template version.", - "optional": true - } - } + "computed": true }, { - "name": "account_id", + "name": "href", "type": "TypeString", - "description": "The ID of the account to which the access group template is assigned.", + "description": "The URL of the access group template resource.", + "computed": true + }, + { + "name": "created_by_id", + "type": "TypeString", + "description": "The ID of the user who created the access group template.", "computed": true } ], "ibm_iam_account_settings": [ + { + "name": "restrict_create_platform_apikey", + "type": "TypeString", + "description": "Defines whether or not creating platform API keys is access controlled. Valid values: * RESTRICTED - to apply access control * NOT_RESTRICTED - to remove access control * NOT_SET - to 'unset' a previous set value.", + "options": "RESTRICTED, NOT_RESTRICTED, NOT_SET", + "optional": true, + "computed": true + }, + { + "name": "allowed_ip_addresses", + "type": "TypeString", + "description": "Defines the IP addresses and subnets from which IAM tokens can be created for the account.", + "optional": true + }, { "name": "entity_tag", "type": "TypeString", @@ -110982,6 +115676,57 @@ "optional": true, "computed": true }, + { + "name": "restrict_create_service_id", + "type": "TypeString", + "description": "Defines whether or not creating a Service Id is access controlled. Valid values: * RESTRICTED - to apply access control * NOT_RESTRICTED - to remove access control * NOT_SET - to 'unset' a previous set value.", + "options": "RESTRICTED, NOT_RESTRICTED, NOT_SET", + "optional": true, + "computed": true + }, + { + "name": "mfa", + "type": "TypeString", + "description": "Defines the MFA trait for the account. Valid values: * NONE - No MFA trait set * TOTP - For all non-federated IBMId users * TOTP4ALL - For all users * LEVEL1 - Email-based MFA for all users * LEVEL2 - TOTP-based MFA for all users * LEVEL3 - U2F MFA for all users.", + "options": "NONE, TOTP, TOTP4ALL, LEVEL1, LEVEL2, LEVEL3", + "optional": true, + "computed": true + }, + { + "name": "session_invalidation_in_seconds", + "type": "TypeString", + "description": "Defines the period of time in seconds in which a session will be invalidated due to inactivity. Valid values: * Any whole number between '900' and '7200' * NOT_SET - To unset account setting and use service default.", + "optional": true, + "computed": true + }, + { + "name": "system_access_token_expiration_in_seconds", + "type": "TypeString", + "description": "Defines the access token expiration in seconds. Valid values: * Any whole number between '900' and '3600' * NOT_SET - To unset account setting and use service default.", + "optional": true, + "computed": true + }, + { + "name": "system_refresh_token_expiration_in_seconds", + "type": "TypeString", + "description": "Defines the refresh token expiration in seconds. Valid values: * Any whole number between '900' and '2592000' * NOT_SET - To unset account setting and use service default.", + "optional": true, + "computed": true + }, + { + "name": "include_history", + "type": "TypeBool", + "description": "Defines if the entity history is included in the response.", + "default_value": false, + "optional": true + }, + { + "name": "if_match", + "type": "TypeString", + "description": "Version of the account settings to be updated. Specify the version that you retrieved as entity_tag (ETag header) when reading the account. This value helps identifying parallel usage of this API. Pass * to indicate to update any version available. This might result in stale updates.", + "default_value": "*", + "optional": true + }, { "name": "user_mfa", "type": "TypeList", @@ -111002,6 +115747,53 @@ } } }, + { + "name": "history", + "type": "TypeList", + "description": "History of the Account Settings.", + "computed": true, + "elem": { + "action": { + "name": "action", + "type": "TypeString", + "description": "Action of the history entry.", + "required": true + }, + "iam_id": { + "name": "iam_id", + "type": "TypeString", + "description": "IAM ID of the identity which triggered the action.", + "required": true + }, + "iam_id_account": { + "name": "iam_id_account", + "type": "TypeString", + "description": "Account of the identity which triggered the action.", + "required": true + }, + "message": { + "name": "message", + "type": "TypeString", + "description": "Message which summarizes the executed action.", + "required": true + }, + "params": { + "name": "params", + "type": "TypeList", + "description": "Params of the history entry.", + "required": true, + "elem": { + "type": "TypeString" + } + }, + "timestamp": { + "name": "timestamp", + "type": "TypeString", + "description": "Timestamp when the action was triggered.", + "required": true + } + } + }, { "name": "session_expiration_in_seconds", "type": "TypeString", @@ -111010,98 +115802,104 @@ "computed": true }, { - "name": "system_refresh_token_expiration_in_seconds", + "name": "max_sessions_per_identity", "type": "TypeString", - "description": "Defines the refresh token expiration in seconds. Valid values: * Any whole number between '900' and '2592000' * NOT_SET - To unset account setting and use service default.", + "description": "Defines the max allowed sessions per identity required by the account. Value values: * Any whole number greater than 0 * NOT_SET - To unset account setting and use service default.", "optional": true, "computed": true + } + ], + "ibm_iam_account_settings_template": [ + { + "name": "account_id", + "type": "TypeString", + "description": "ID of the account where the template resides.", + "computed": true }, { - "name": "include_history", - "type": "TypeBool", - "description": "Defines if the entity history is included in the response.", - "default_value": false, + "name": "name", + "type": "TypeString", + "description": "The name of the trusted profile template. This is visible only in the enterprise account.", "optional": true }, { - "name": "restrict_create_service_id", + "name": "description", "type": "TypeString", - "description": "Defines whether or not creating a Service Id is access controlled. Valid values: * RESTRICTED - to apply access control * NOT_RESTRICTED - to remove access control * NOT_SET - to 'unset' a previous set value.", - "options": "RESTRICTED, NOT_RESTRICTED, NOT_SET", - "optional": true, - "computed": true + "description": "The description of the trusted profile template. Describe the template for enterprise account users.", + "optional": true }, { - "name": "restrict_create_platform_apikey", + "name": "entity_tag", "type": "TypeString", - "description": "Defines whether or not creating platform API keys is access controlled. Valid values: * RESTRICTED - to apply access control * NOT_RESTRICTED - to remove access control * NOT_SET - to 'unset' a previous set value.", - "options": "RESTRICTED, NOT_RESTRICTED, NOT_SET", - "optional": true, + "description": "Entity tag for this templateId-version combination.", "computed": true }, { - "name": "session_invalidation_in_seconds", + "name": "created_by_id", "type": "TypeString", - "description": "Defines the period of time in seconds in which a session will be invalidated due to inactivity. Valid values: * Any whole number between '900' and '7200' * NOT_SET - To unset account setting and use service default.", - "optional": true, + "description": "IAMid of the creator.", "computed": true }, { - "name": "max_sessions_per_identity", + "name": "last_modified_by_id", "type": "TypeString", - "description": "Defines the max allowed sessions per identity required by the account. Value values: * Any whole number greater than 0 * NOT_SET - To unset account setting and use service default.", - "optional": true, + "description": "IAMid of the identity that made the latest modification.", "computed": true }, { - "name": "allowed_ip_addresses", + "name": "id", "type": "TypeString", - "description": "Defines the IP addresses and subnets from which IAM tokens can be created for the account.", - "optional": true + "description": "ID of the the template resource.", + "computed": true }, { - "name": "mfa", - "type": "TypeString", - "description": "Defines the MFA trait for the account. Valid values: * NONE - No MFA trait set * TOTP - For all non-federated IBMId users * TOTP4ALL - For all users * LEVEL1 - Email-based MFA for all users * LEVEL2 - TOTP-based MFA for all users * LEVEL3 - U2F MFA for all users.", - "options": "NONE, TOTP, TOTP4ALL, LEVEL1, LEVEL2, LEVEL3", + "name": "committed", + "type": "TypeBool", + "description": "Committed flag determines if the template is ready for assignment.", "optional": true, "computed": true }, + { + "name": "version", + "type": "TypeInt", + "description": "Version of the the template.", + "computed": true + }, { "name": "history", "type": "TypeList", - "description": "History of the Account Settings.", + "description": "History of the Template.", "computed": true, "elem": { "action": { "name": "action", "type": "TypeString", "description": "Action of the history entry.", - "required": true + "computed": true }, "iam_id": { "name": "iam_id", "type": "TypeString", "description": "IAM ID of the identity which triggered the action.", - "required": true + "computed": true }, "iam_id_account": { "name": "iam_id_account", "type": "TypeString", "description": "Account of the identity which triggered the action.", - "required": true + "computed": true }, "message": { "name": "message", "type": "TypeString", "description": "Message which summarizes the executed action.", - "required": true + "computed": true }, "params": { "name": "params", "type": "TypeList", "description": "Params of the history entry.", - "required": true, + "computed": true, "elem": { "type": "TypeString" } @@ -111110,26 +115908,17 @@ "name": "timestamp", "type": "TypeString", "description": "Timestamp when the action was triggered.", - "required": true + "computed": true } } }, { - "name": "if_match", - "type": "TypeString", - "description": "Version of the account settings to be updated. Specify the version that you retrieved as entity_tag (ETag header) when reading the account. This value helps identifying parallel usage of this API. Pass * to indicate to update any version available. This might result in stale updates.", - "default_value": "*", - "optional": true - }, - { - "name": "system_access_token_expiration_in_seconds", + "name": "crn", "type": "TypeString", - "description": "Defines the access token expiration in seconds. Valid values: * Any whole number between '900' and '3600' * NOT_SET - To unset account setting and use service default.", - "optional": true, + "description": "Cloud resource name.", + "cloud_data_type": "crn", "computed": true - } - ], - "ibm_iam_account_settings_template": [ + }, { "name": "account_settings", "type": "TypeList", @@ -111213,230 +116002,105 @@ "max_items": 1 }, { - "name": "entity_tag", + "name": "template_id", "type": "TypeString", - "description": "Entity tag for this templateId-version combination.", - "computed": true + "description": "ID of the the template.", + "optional": true }, { - "name": "last_modified_by_id", + "name": "created_at", "type": "TypeString", - "description": "IAMid of the identity that made the latest modification.", + "description": "Template Created At.", "computed": true }, { - "name": "description", + "name": "last_modified_at", "type": "TypeString", - "description": "The description of the trusted profile template. Describe the template for enterprise account users.", - "optional": true - }, + "description": "Template last modified at.", + "computed": true + } + ], + "ibm_iam_account_settings_template_assignment": [ { - "name": "template_id", + "name": "target", "type": "TypeString", - "description": "ID of the the template.", - "optional": true + "description": "Assignment target.", + "required": true }, { - "name": "history", + "name": "context", "type": "TypeList", - "description": "History of the Template.", + "description": "Context with key properties for problem determination.", "computed": true, "elem": { - "action": { - "name": "action", + "cluster_name": { + "name": "cluster_name", "type": "TypeString", - "description": "Action of the history entry.", + "description": "The cluster name.", "computed": true }, - "iam_id": { - "name": "iam_id", + "elapsed_time": { + "name": "elapsed_time", "type": "TypeString", - "description": "IAM ID of the identity which triggered the action.", + "description": "The elapsed time in msec.", "computed": true }, - "iam_id_account": { - "name": "iam_id_account", + "end_time": { + "name": "end_time", "type": "TypeString", - "description": "Account of the identity which triggered the action.", + "description": "The finish time of the request.", "computed": true }, - "message": { - "name": "message", + "host": { + "name": "host", "type": "TypeString", - "description": "Message which summarizes the executed action.", + "description": "The host of the server instance processing the request.", "computed": true }, - "params": { - "name": "params", - "type": "TypeList", - "description": "Params of the history entry.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "timestamp": { - "name": "timestamp", + "instance_id": { + "name": "instance_id", "type": "TypeString", - "description": "Timestamp when the action was triggered.", + "description": "The instance ID of the server instance processing the request.", "computed": true - } - } - }, - { - "name": "created_by_id", - "type": "TypeString", - "description": "IAMid of the creator.", - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "The name of the trusted profile template. This is visible only in the enterprise account.", - "optional": true - }, - { - "name": "created_at", - "type": "TypeString", - "description": "Template Created At.", - "computed": true - }, - { - "name": "last_modified_at", - "type": "TypeString", - "description": "Template last modified at.", - "computed": true - }, - { - "name": "account_id", - "type": "TypeString", - "description": "ID of the account where the template resides.", - "computed": true - }, - { - "name": "id", - "type": "TypeString", - "description": "ID of the the template resource.", - "computed": true - }, - { - "name": "version", - "type": "TypeInt", - "description": "Version of the the template.", - "computed": true - }, - { - "name": "committed", - "type": "TypeBool", - "description": "Committed flag determines if the template is ready for assignment.", - "optional": true, - "computed": true - }, - { - "name": "crn", - "type": "TypeString", - "description": "Cloud resource name.", - "cloud_data_type": "crn", - "computed": true - } - ], - "ibm_iam_account_settings_template_assignment": [ - { - "name": "created_by_id", - "type": "TypeString", - "description": "IAMid of the identity that created the assignment.", - "computed": true - }, - { - "name": "last_modified_at", - "type": "TypeString", - "description": "Assignment modified at.", - "computed": true - }, - { - "name": "template_id", - "type": "TypeString", - "description": "Template Id.", - "required": true - }, - { - "name": "target_type", - "type": "TypeString", - "description": "Assignment target type.", - "required": true, - "options": "Account, AccountGroup" - }, - { - "name": "history", - "type": "TypeList", - "description": "Assignment history.", - "computed": true, - "elem": { - "action": { - "name": "action", + }, + "operation": { + "name": "operation", "type": "TypeString", - "description": "Action of the history entry.", + "description": "The operation of the inbound REST request.", "computed": true }, - "iam_id": { - "name": "iam_id", + "start_time": { + "name": "start_time", "type": "TypeString", - "description": "IAM ID of the identity which triggered the action.", + "description": "The start time of the request.", "computed": true }, - "iam_id_account": { - "name": "iam_id_account", + "thread_id": { + "name": "thread_id", "type": "TypeString", - "description": "Account of the identity which triggered the action.", + "description": "The thread ID of the server instance processing the request.", "computed": true }, - "message": { - "name": "message", + "transaction_id": { + "name": "transaction_id", "type": "TypeString", - "description": "Message which summarizes the executed action.", + "description": "The transaction ID of the inbound REST request.", "computed": true }, - "params": { - "name": "params", - "type": "TypeList", - "description": "Params of the history entry.", - "computed": true, - "elem": { - "type": "TypeString" - } + "url": { + "name": "url", + "type": "TypeString", + "description": "The URL of that cluster.", + "computed": true }, - "timestamp": { - "name": "timestamp", + "user_agent": { + "name": "user_agent", "type": "TypeString", - "description": "Timestamp when the action was triggered.", + "description": "The user agent of the inbound REST request.", "computed": true } } }, - { - "name": "account_id", - "type": "TypeString", - "description": "Enterprise account Id.", - "computed": true - }, - { - "name": "status", - "type": "TypeString", - "description": "Assignment status.", - "computed": true - }, - { - "name": "last_modified_by_id", - "type": "TypeString", - "description": "IAMid of the identity that last modified the assignment.", - "computed": true - }, - { - "name": "target", - "type": "TypeString", - "description": "Assignment target.", - "required": true - }, { "name": "resources", "type": "TypeList", @@ -111511,21 +116175,40 @@ } }, { - "name": "href", + "name": "created_at", "type": "TypeString", - "description": "Href.", + "description": "Assignment created at.", "computed": true }, { - "name": "created_at", + "name": "created_by_id", "type": "TypeString", - "description": "Assignment created at.", + "description": "IAMid of the identity that created the assignment.", "computed": true }, { - "name": "entity_tag", + "name": "last_modified_at", "type": "TypeString", - "description": "Entity tag for this assignment record.", + "description": "Assignment modified at.", + "computed": true + }, + { + "name": "last_modified_by_id", + "type": "TypeString", + "description": "IAMid of the identity that last modified the assignment.", + "computed": true + }, + { + "name": "target_type", + "type": "TypeString", + "description": "Assignment target type.", + "required": true, + "options": "Account, AccountGroup" + }, + { + "name": "href", + "type": "TypeString", + "description": "Href.", "computed": true }, { @@ -111535,121 +116218,89 @@ "required": true }, { - "name": "context", + "name": "template_id", + "type": "TypeString", + "description": "Template Id.", + "required": true + }, + { + "name": "status", + "type": "TypeString", + "description": "Assignment status.", + "computed": true + }, + { + "name": "history", "type": "TypeList", - "description": "Context with key properties for problem determination.", + "description": "Assignment history.", "computed": true, "elem": { - "cluster_name": { - "name": "cluster_name", - "type": "TypeString", - "description": "The cluster name.", - "computed": true - }, - "elapsed_time": { - "name": "elapsed_time", - "type": "TypeString", - "description": "The elapsed time in msec.", - "computed": true - }, - "end_time": { - "name": "end_time", - "type": "TypeString", - "description": "The finish time of the request.", - "computed": true - }, - "host": { - "name": "host", - "type": "TypeString", - "description": "The host of the server instance processing the request.", - "computed": true - }, - "instance_id": { - "name": "instance_id", - "type": "TypeString", - "description": "The instance ID of the server instance processing the request.", - "computed": true - }, - "operation": { - "name": "operation", + "action": { + "name": "action", "type": "TypeString", - "description": "The operation of the inbound REST request.", + "description": "Action of the history entry.", "computed": true }, - "start_time": { - "name": "start_time", + "iam_id": { + "name": "iam_id", "type": "TypeString", - "description": "The start time of the request.", + "description": "IAM ID of the identity which triggered the action.", "computed": true }, - "thread_id": { - "name": "thread_id", + "iam_id_account": { + "name": "iam_id_account", "type": "TypeString", - "description": "The thread ID of the server instance processing the request.", + "description": "Account of the identity which triggered the action.", "computed": true }, - "transaction_id": { - "name": "transaction_id", + "message": { + "name": "message", "type": "TypeString", - "description": "The transaction ID of the inbound REST request.", + "description": "Message which summarizes the executed action.", "computed": true }, - "url": { - "name": "url", - "type": "TypeString", - "description": "The URL of that cluster.", - "computed": true + "params": { + "name": "params", + "type": "TypeList", + "description": "Params of the history entry.", + "computed": true, + "elem": { + "type": "TypeString" + } }, - "user_agent": { - "name": "user_agent", + "timestamp": { + "name": "timestamp", "type": "TypeString", - "description": "The user agent of the inbound REST request.", + "description": "Timestamp when the action was triggered.", "computed": true } } - } - ], - "ibm_iam_api_key": [ - { - "name": "store_value", - "type": "TypeBool", - "description": "Send true or false to set whether the API key value is retrievable in the future by using the Get details of an API key request. If you create an API key for a user, you must specify `false` or omit the value. We don't allow storing of API keys for users.", - "optional": true }, { "name": "entity_tag", "type": "TypeString", - "description": "Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.", - "computed": true - }, - { - "name": "created_at", - "type": "TypeString", - "description": "If set contains a date time string of the creation date in ISO format.", + "description": "Entity tag for this assignment record.", "computed": true }, { - "name": "modified_at", + "name": "account_id", "type": "TypeString", - "description": "If set contains a date time string of the last modification date in ISO format.", + "description": "Enterprise account Id.", "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.", - "required": true - }, + } + ], + "ibm_iam_api_key": [ { - "name": "account_id", + "name": "entity_lock", "type": "TypeString", - "description": "The account ID of the API key.", - "computed": true + "description": "Indicates if the API key is locked for further write operations. False by default.", + "default_value": "false", + "optional": true }, { - "name": "apikey_id", + "name": "entity_tag", "type": "TypeString", - "description": "Unique identifier of this API Key.", + "description": "Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.", "computed": true }, { @@ -111671,6 +116322,32 @@ "description": "The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.", "optional": true }, + { + "name": "apikey", + "type": "TypeString", + "description": "You can optionally passthrough the API key value for this API key. If passed, NO validation of that apiKey value is done, i.e. the value can be non-URL safe. If omitted, the API key management will create an URL safe opaque API key value. The value of the API key is checked for uniqueness. Please ensure enough variations when passing in this value.", + "secure": true, + "optional": true, + "computed": true + }, + { + "name": "store_value", + "type": "TypeBool", + "description": "Send true or false to set whether the API key value is retrievable in the future by using the Get details of an API key request. If you create an API key for a user, you must specify `false` or omit the value. We don't allow storing of API keys for users.", + "optional": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "If set contains a date time string of the creation date in ISO format.", + "computed": true + }, + { + "name": "account_id", + "type": "TypeString", + "description": "The account ID of the API key.", + "computed": true + }, { "name": "file", "type": "TypeString", @@ -111678,19 +116355,23 @@ "optional": true }, { - "name": "apikey", + "name": "apikey_id", "type": "TypeString", - "description": "You can optionally passthrough the API key value for this API key. If passed, NO validation of that apiKey value is done, i.e. the value can be non-URL safe. If omitted, the API key management will create an URL safe opaque API key value. The value of the API key is checked for uniqueness. Please ensure enough variations when passing in this value.", - "secure": true, - "optional": true, + "description": "Unique identifier of this API Key.", "computed": true }, { - "name": "created_by", + "name": "modified_at", "type": "TypeString", - "description": "IAM ID of the user or service which created the API key.", + "description": "If set contains a date time string of the last modification date in ISO format.", "computed": true }, + { + "name": "name", + "type": "TypeString", + "description": "Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.", + "required": true + }, { "name": "iam_id", "type": "TypeString", @@ -111698,23 +116379,13 @@ "computed": true }, { - "name": "entity_lock", + "name": "created_by", "type": "TypeString", - "description": "Indicates if the API key is locked for further write operations. False by default.", - "default_value": "false", - "optional": true + "description": "IAM ID of the user or service which created the API key.", + "computed": true } ], "ibm_iam_authorization_policy": [ - { - "name": "roles", - "type": "TypeList", - "description": "Role names of the policy definition", - "required": true, - "elem": { - "type": "TypeString" - } - }, { "name": "resource_attributes", "type": "TypeSet", @@ -111745,82 +116416,52 @@ } }, { - "name": "target_resource_group_id", - "type": "TypeString", - "description": "The target resource group Id", - "cloud_data_type": "resource_group", - "immutable": true, - "optional": true, - "computed": true, - "cloud_data_range": [ - "resolved_to:id" - ] - }, - { - "name": "source_resource_type", + "name": "transaction_id", "type": "TypeString", - "description": "Resource type of source service", - "immutable": true, + "description": "Set transactionID for debug", "optional": true, "computed": true }, { - "name": "target_resource_type", + "name": "target_service_name", "type": "TypeString", - "description": "Resource type of target service", + "description": "The target service name", "immutable": true, "optional": true, "computed": true }, { - "name": "subject_attributes", - "type": "TypeSet", - "description": "Set subject attributes.", - "immutable": true, - "optional": true, - "computed": true, - "elem": { - "name": { - "name": "name", - "type": "TypeString", - "description": "Name of attribute.", - "required": true - }, - "value": { - "name": "value", - "type": "TypeString", - "description": "Value of attribute.", - "required": true - } - } - }, - { - "name": "transaction_id", + "name": "target_resource_instance_id", "type": "TypeString", - "description": "Set transactionID for debug", + "description": "The target resource instance Id", + "immutable": true, "optional": true, "computed": true }, { - "name": "target_service_name", + "name": "target_resource_type", "type": "TypeString", - "description": "The target service name", + "description": "Resource type of target service", "immutable": true, "optional": true, "computed": true }, { - "name": "source_resource_instance_id", + "name": "source_resource_group_id", "type": "TypeString", - "description": "The source resource instance Id", + "description": "The source resource group Id", + "cloud_data_type": "resource_group", "immutable": true, "optional": true, - "computed": true + "computed": true, + "cloud_data_range": [ + "resolved_to:id" + ] }, { - "name": "source_resource_group_id", + "name": "target_resource_group_id", "type": "TypeString", - "description": "The source resource group Id", + "description": "The target resource group Id", "cloud_data_type": "resource_group", "immutable": true, "optional": true, @@ -111830,9 +116471,9 @@ ] }, { - "name": "target_resource_instance_id", + "name": "source_resource_type", "type": "TypeString", - "description": "The target resource instance Id", + "description": "Resource type of source service", "immutable": true, "optional": true, "computed": true @@ -111845,6 +116486,29 @@ "optional": true, "computed": true }, + { + "name": "description", + "type": "TypeString", + "description": "Description of the Policy", + "optional": true + }, + { + "name": "roles", + "type": "TypeList", + "description": "Role names of the policy definition", + "required": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "source_resource_instance_id", + "type": "TypeString", + "description": "The source resource instance Id", + "immutable": true, + "optional": true, + "computed": true + }, { "name": "version", "type": "TypeString", @@ -111859,10 +116523,26 @@ "computed": true }, { - "name": "description", - "type": "TypeString", - "description": "Description of the Policy", - "optional": true + "name": "subject_attributes", + "type": "TypeSet", + "description": "Set subject attributes.", + "immutable": true, + "optional": true, + "computed": true, + "elem": { + "name": { + "name": "name", + "type": "TypeString", + "description": "Name of attribute.", + "required": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "Value of attribute.", + "required": true + } + } } ], "ibm_iam_authorization_policy_detach": [ @@ -111894,22 +116574,12 @@ "computed": true }, { - "name": "name", + "name": "display_name", "type": "TypeString", - "description": "The name of the custom Role", - "immutable": true, + "description": "Display Name of the Custom Role", "required": true, "min_length": 1, - "max_length": 30, - "matches": "^[A-Z]{1}[A-Za-z0-9]{0,29}$" - }, - { - "name": "description", - "type": "TypeString", - "description": "The description of the role", - "min_length": 1, - "max_length": 250, - "optional": true + "max_length": 50 }, { "name": "service", @@ -111928,19 +116598,29 @@ } }, { - "name": "crn", + "name": "name", "type": "TypeString", - "description": "crn of the Custom Role", - "cloud_data_type": "crn", - "computed": true + "description": "The name of the custom Role", + "immutable": true, + "required": true, + "min_length": 1, + "max_length": 30, + "matches": "^[A-Z]{1}[A-Za-z0-9]{0,29}$" }, { - "name": "display_name", + "name": "description", "type": "TypeString", - "description": "Display Name of the Custom Role", - "required": true, + "description": "The description of the role", "min_length": 1, - "max_length": 50 + "max_length": 250, + "optional": true + }, + { + "name": "crn", + "type": "TypeString", + "description": "crn of the Custom Role", + "cloud_data_type": "crn", + "computed": true } ], "ibm_iam_policy_template": [ @@ -112293,18 +116973,27 @@ ], "ibm_iam_service_api_key": [ { - "name": "apikey", + "name": "iam_service_id", "type": "TypeString", - "description": "API key value for this API key", - "secure": true, + "description": "The service iam_id that this API key authenticates", + "cloud_data_type": "iam", "immutable": true, - "optional": true, + "required": true, + "cloud_data_range": [ + "service:service_id", + "resolved_to:id" + ] + }, + { + "name": "account_id", + "type": "TypeString", + "description": "The account ID of the API key", "computed": true }, { - "name": "store_value", - "type": "TypeBool", - "description": "Boolean value deciding whether API key value is retrievable in the future", + "name": "file", + "type": "TypeString", + "description": "File where api key is to be stored", "optional": true }, { @@ -112320,40 +117009,37 @@ "computed": true }, { - "name": "name", + "name": "modified_at", "type": "TypeString", - "description": "Name of the Service API key", - "required": true + "description": "The date and time Service API Key was modified", + "computed": true }, { - "name": "description", + "name": "created_by", "type": "TypeString", - "description": "description of the API key", - "optional": true, + "description": "IAM ID of the service which created the API key", "computed": true }, { - "name": "iam_service_id", + "name": "name", "type": "TypeString", - "description": "The service iam_id that this API key authenticates", - "cloud_data_type": "iam", - "immutable": true, - "required": true, - "cloud_data_range": [ - "service:service_id", - "resolved_to:id" - ] + "description": "Name of the Service API key", + "required": true }, { - "name": "account_id", + "name": "description", "type": "TypeString", - "description": "The account ID of the API key", + "description": "description of the API key", + "optional": true, "computed": true }, { - "name": "modified_at", + "name": "apikey", "type": "TypeString", - "description": "The date and time Service API Key was modified", + "description": "API key value for this API key", + "secure": true, + "immutable": true, + "optional": true, "computed": true }, { @@ -112363,9 +117049,9 @@ "optional": true }, { - "name": "file", - "type": "TypeString", - "description": "File where api key is to be stored", + "name": "store_value", + "type": "TypeBool", + "description": "Boolean value deciding whether API key value is retrievable in the future", "optional": true }, { @@ -112374,40 +117060,9 @@ "description": "crn of the Service API Key", "cloud_data_type": "crn", "computed": true - }, - { - "name": "created_by", - "type": "TypeString", - "description": "IAM ID of the service which created the API key", - "computed": true } ], "ibm_iam_service_id": [ - { - "name": "name", - "type": "TypeString", - "description": "Name of the serviceID", - "required": true - }, - { - "name": "description", - "type": "TypeString", - "description": "Description of the serviceID", - "optional": true - }, - { - "name": "version", - "type": "TypeString", - "description": "version of the serviceID", - "computed": true - }, - { - "name": "crn", - "type": "TypeString", - "description": "crn of the serviceID", - "cloud_data_type": "crn", - "computed": true - }, { "name": "iam_id", "type": "TypeString", @@ -112427,28 +117082,34 @@ "name": "locked", "type": "TypeBool", "computed": true - } - ], - "ibm_iam_service_policy": [ + }, { - "name": "rule_operator", + "name": "name", "type": "TypeString", - "description": "Operator that multiple rule conditions are evaluated over", - "optional": true + "description": "Name of the serviceID", + "required": true }, { - "name": "pattern", + "name": "description", "type": "TypeString", - "description": "Pattern rule follows for time-based condition", + "description": "Description of the serviceID", "optional": true }, { - "name": "iam_id", + "name": "version", "type": "TypeString", - "description": "IAM ID of ServiceID", - "immutable": true, - "optional": true + "description": "version of the serviceID", + "computed": true }, + { + "name": "crn", + "type": "TypeString", + "description": "crn of the serviceID", + "cloud_data_type": "crn", + "computed": true + } + ], + "ibm_iam_service_policy": [ { "name": "roles", "type": "TypeList", @@ -112485,6 +117146,42 @@ } } }, + { + "name": "tags", + "type": "TypeSet", + "cloud_data_type": "tags", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "resource_tags", + "type": "TypeSet", + "description": "Set access management tags.", + "optional": true, + "elem": { + "name": { + "name": "name", + "type": "TypeString", + "description": "Name of attribute.", + "required": true + }, + "operator": { + "name": "operator", + "type": "TypeString", + "description": "Operator of attribute.", + "default_value": "stringEquals", + "optional": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "Value of attribute.", + "required": true + } + } + }, { "name": "description", "type": "TypeString", @@ -112539,6 +117236,18 @@ "resolved_to:id" ] }, + { + "name": "pattern", + "type": "TypeString", + "description": "Pattern rule follows for time-based condition", + "optional": true + }, + { + "name": "rule_operator", + "type": "TypeString", + "description": "Operator that multiple rule conditions are evaluated over", + "optional": true + }, { "name": "resources", "type": "TypeList", @@ -112610,47 +117319,18 @@ "optional": true }, { - "name": "tags", - "type": "TypeSet", - "cloud_data_type": "tags", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "resource_tags", - "type": "TypeSet", - "description": "Set access management tags.", - "optional": true, - "elem": { - "name": { - "name": "name", - "type": "TypeString", - "description": "Name of attribute.", - "required": true - }, - "operator": { - "name": "operator", - "type": "TypeString", - "description": "Operator of attribute.", - "default_value": "stringEquals", - "optional": true - }, - "value": { - "name": "value", - "type": "TypeString", - "description": "Value of attribute.", - "required": true - } - } + "name": "iam_id", + "type": "TypeString", + "description": "IAM ID of ServiceID", + "immutable": true, + "optional": true } ], "ibm_iam_trusted_profile": [ { - "name": "account_id", + "name": "iam_id", "type": "TypeString", - "description": "The account ID of the trusted profile.", + "description": "The iam_id of this trusted profile.", "computed": true }, { @@ -112700,12 +117380,6 @@ } } }, - { - "name": "ims_account_id", - "type": "TypeInt", - "description": "IMS acount ID of the trusted profile.", - "computed": true - }, { "name": "name", "type": "TypeString", @@ -112713,27 +117387,27 @@ "required": true }, { - "name": "profile_id", + "name": "description", "type": "TypeString", - "description": "Unique identifier of this trusted profile.", - "computed": true + "description": "The optional description of the trusted profile. The 'description' property is only available if a description was provided during creation of trusted profile.", + "optional": true }, { - "name": "entity_tag", + "name": "profile_id", "type": "TypeString", - "description": "Version of the trusted profile details object. You need to specify this value when updating the trusted profile to avoid stale updates.", + "description": "Unique identifier of this trusted profile.", "computed": true }, { - "name": "created_at", + "name": "modified_at", "type": "TypeString", - "description": "If set contains a date time string of the creation date in ISO format.", + "description": "If set contains a date time string of the last modification date in ISO format.", "computed": true }, { - "name": "modified_at", + "name": "account_id", "type": "TypeString", - "description": "If set contains a date time string of the last modification date in ISO format.", + "description": "The account ID of the trusted profile.", "computed": true }, { @@ -112744,23 +117418,11 @@ "computed": true }, { - "name": "iam_id", + "name": "created_at", "type": "TypeString", - "description": "The iam_id of this trusted profile.", - "computed": true - }, - { - "name": "ims_user_id", - "type": "TypeInt", - "description": "IMS user ID of the trusted profile.", + "description": "If set contains a date time string of the creation date in ISO format.", "computed": true }, - { - "name": "description", - "type": "TypeString", - "description": "The optional description of the trusted profile. The 'description' property is only available if a description was provided during creation of trusted profile.", - "optional": true - }, { "name": "template_id", "type": "TypeString", @@ -112772,47 +117434,27 @@ "type": "TypeString", "description": "Id of assignment that assigned the template.", "computed": true - } - ], - "ibm_iam_trusted_profile_claim_rule": [ - { - "name": "conditions", - "type": "TypeList", - "description": "Conditions of this claim rule.", - "required": true, - "elem": { - "claim": { - "name": "claim", - "type": "TypeString", - "description": "The claim to evaluate against.", - "required": true - }, - "operator": { - "name": "operator", - "type": "TypeString", - "description": "The operation to perform on the claim. valid values are EQUALS, NOT_EQUALS, EQUALS_IGNORE_CASE, NOT_EQUALS_IGNORE_CASE, CONTAINS, IN.", - "required": true - }, - "value": { - "name": "value", - "type": "TypeString", - "description": "The stringified JSON value that the claim is compared to using the operator.", - "required": true - } - } }, { - "name": "cr_type", + "name": "entity_tag", "type": "TypeString", - "description": "The compute resource type the rule applies to, required only if type is specified as 'Profile-CR'. Valid values are VSI, IKS_SA, ROKS_SA.", - "optional": true + "description": "Version of the trusted profile details object. You need to specify this value when updating the trusted profile to avoid stale updates.", + "computed": true }, { - "name": "created_at", - "type": "TypeString", - "description": "If set contains a date time string of the creation date in ISO format.", + "name": "ims_account_id", + "type": "TypeInt", + "description": "IMS acount ID of the trusted profile.", "computed": true }, + { + "name": "ims_user_id", + "type": "TypeInt", + "description": "IMS user ID of the trusted profile.", + "computed": true + } + ], + "ibm_iam_trusted_profile_claim_rule": [ { "name": "expiration", "type": "TypeInt", @@ -112843,12 +117485,6 @@ "resolved_to:id" ] }, - { - "name": "rule_id", - "type": "TypeString", - "description": "Unique identifier of this claim rule.", - "computed": true - }, { "name": "type", "type": "TypeString", @@ -112862,31 +117498,57 @@ "optional": true }, { - "name": "realm_name", + "name": "cr_type", "type": "TypeString", - "description": "The realm name of the Idp this claim rule applies to. This field is required only if the type is specified as 'Profile-SAML'.", + "description": "The compute resource type the rule applies to, required only if type is specified as 'Profile-CR'. Valid values are VSI, IKS_SA, ROKS_SA.", "optional": true - } - ], - "ibm_iam_trusted_profile_identity": [ + }, { - "name": "type", + "name": "rule_id", "type": "TypeString", - "description": "Type of the identity.", - "immutable": true, - "required": true, - "options": "crn, serviceid, user" + "description": "Unique identifier of this claim rule.", + "computed": true }, { - "name": "accounts", + "name": "conditions", "type": "TypeList", - "description": "Only valid for the type user. Accounts from which a user can assume the trusted profile.", - "immutable": true, - "optional": true, + "description": "Conditions of this claim rule.", + "required": true, "elem": { - "type": "TypeString" + "claim": { + "name": "claim", + "type": "TypeString", + "description": "The claim to evaluate against.", + "required": true + }, + "operator": { + "name": "operator", + "type": "TypeString", + "description": "The operation to perform on the claim. valid values are EQUALS, NOT_EQUALS, EQUALS_IGNORE_CASE, NOT_EQUALS_IGNORE_CASE, CONTAINS, IN.", + "required": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "The stringified JSON value that the claim is compared to using the operator.", + "required": true + } } }, + { + "name": "realm_name", + "type": "TypeString", + "description": "The realm name of the Idp this claim rule applies to. This field is required only if the type is specified as 'Profile-SAML'.", + "optional": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "If set contains a date time string of the creation date in ISO format.", + "computed": true + } + ], + "ibm_iam_trusted_profile_identity": [ { "name": "description", "type": "TypeString", @@ -112915,9 +117577,39 @@ "description": "Identifier of the identity that can assume the trusted profiles. This can be a user identifier (IAM id), serviceid or crn. Internally it uses account id of the service id for the identifier 'serviceid' and for the identifier 'crn' it uses account id contained in the CRN.", "immutable": true, "required": true + }, + { + "name": "type", + "type": "TypeString", + "description": "Type of the identity.", + "immutable": true, + "required": true, + "options": "crn, serviceid, user" + }, + { + "name": "accounts", + "type": "TypeList", + "description": "Only valid for the type user. Accounts from which a user can assume the trusted profile.", + "immutable": true, + "optional": true, + "elem": { + "type": "TypeString" + } } ], "ibm_iam_trusted_profile_link": [ + { + "name": "created_at", + "type": "TypeString", + "description": "If set contains a date time string of the creation date in ISO format.", + "computed": true + }, + { + "name": "modified_at", + "type": "TypeString", + "description": "If set contains a date time string of the last modification date in ISO format.", + "computed": true + }, { "name": "profile_id", "type": "TypeString", @@ -112984,72 +117676,9 @@ "type": "TypeString", "description": "version of the claim rule.", "computed": true - }, - { - "name": "created_at", - "type": "TypeString", - "description": "If set contains a date time string of the creation date in ISO format.", - "computed": true - }, - { - "name": "modified_at", - "type": "TypeString", - "description": "If set contains a date time string of the last modification date in ISO format.", - "computed": true } ], "ibm_iam_trusted_profile_policy": [ - { - "name": "iam_id", - "type": "TypeString", - "description": "IAM ID of Trusted Profile", - "immutable": true, - "optional": true - }, - { - "name": "tags", - "type": "TypeSet", - "cloud_data_type": "tags", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "rule_conditions", - "type": "TypeSet", - "description": "Rule conditions enforced by the policy", - "optional": true, - "elem": { - "key": { - "name": "key", - "type": "TypeString", - "description": "Key of the condition", - "required": true - }, - "operator": { - "name": "operator", - "type": "TypeString", - "description": "Operator of the condition", - "required": true - }, - "value": { - "name": "value", - "type": "TypeList", - "description": "Value of the condition", - "required": true, - "elem": { - "type": "TypeString" - } - } - } - }, - { - "name": "pattern", - "type": "TypeString", - "description": "Pattern rule follows for time-based condition", - "optional": true - }, { "name": "profile_id", "type": "TypeString", @@ -113062,6 +117691,15 @@ "resolved_to:id" ] }, + { + "name": "roles", + "type": "TypeList", + "description": "Role names of the policy definition", + "required": true, + "elem": { + "type": "TypeString" + } + }, { "name": "resources", "type": "TypeList", @@ -113126,9 +117764,18 @@ "max_items": 1 }, { - "name": "resource_attributes", + "name": "tags", "type": "TypeSet", - "description": "Set resource attributes.", + "cloud_data_type": "tags", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "resource_tags", + "type": "TypeSet", + "description": "Set access management tags.", "optional": true, "elem": { "name": { @@ -113153,16 +117800,51 @@ } }, { - "name": "account_management", - "type": "TypeBool", - "description": "Give access to all account management services", - "default_value": false, + "name": "rule_conditions", + "type": "TypeSet", + "description": "Rule conditions enforced by the policy", + "optional": true, + "elem": { + "key": { + "name": "key", + "type": "TypeString", + "description": "Key of the condition", + "required": true + }, + "operator": { + "name": "operator", + "type": "TypeString", + "description": "Operator of the condition", + "required": true + }, + "value": { + "name": "value", + "type": "TypeList", + "description": "Value of the condition", + "required": true, + "elem": { + "type": "TypeString" + } + } + } + }, + { + "name": "pattern", + "type": "TypeString", + "description": "Pattern rule follows for time-based condition", "optional": true }, { - "name": "resource_tags", + "name": "iam_id", + "type": "TypeString", + "description": "IAM ID of Trusted Profile", + "immutable": true, + "optional": true + }, + { + "name": "resource_attributes", "type": "TypeSet", - "description": "Set access management tags.", + "description": "Set resource attributes.", "optional": true, "elem": { "name": { @@ -113186,6 +117868,13 @@ } } }, + { + "name": "account_management", + "type": "TypeBool", + "description": "Give access to all account management services", + "default_value": false, + "optional": true + }, { "name": "description", "type": "TypeString", @@ -113204,24 +117893,9 @@ "type": "TypeString", "description": "Operator that multiple rule conditions are evaluated over", "optional": true - }, - { - "name": "roles", - "type": "TypeList", - "description": "Role names of the policy definition", - "required": true, - "elem": { - "type": "TypeString" - } } ], "ibm_iam_trusted_profile_template": [ - { - "name": "template_id", - "type": "TypeString", - "description": "ID of the the template.", - "optional": true - }, { "name": "committed", "type": "TypeBool", @@ -113229,12 +117903,77 @@ "optional": true, "computed": true }, + { + "name": "created_by_id", + "type": "TypeString", + "description": "IAMid of the creator.", + "computed": true + }, { "name": "last_modified_by_id", "type": "TypeString", "description": "IAMid of the identity that made the latest modification.", "computed": true }, + { + "name": "template_id", + "type": "TypeString", + "description": "ID of the the template.", + "optional": true + }, + { + "name": "id", + "type": "TypeString", + "description": "ID of the the template.", + "computed": true + }, + { + "name": "history", + "type": "TypeList", + "description": "History of the trusted profile template.", + "computed": true, + "elem": { + "action": { + "name": "action", + "type": "TypeString", + "description": "Action of the history entry.", + "computed": true + }, + "iam_id": { + "name": "iam_id", + "type": "TypeString", + "description": "IAM ID of the identity which triggered the action.", + "computed": true + }, + "iam_id_account": { + "name": "iam_id_account", + "type": "TypeString", + "description": "Account of the identity which triggered the action.", + "computed": true + }, + "message": { + "name": "message", + "type": "TypeString", + "description": "Message which summarizes the executed action.", + "computed": true + }, + "params": { + "name": "params", + "type": "TypeList", + "description": "Params of the history entry.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "timestamp": { + "name": "timestamp", + "type": "TypeString", + "description": "Timestamp when the action was triggered.", + "computed": true + } + } + }, { "name": "profile", "type": "TypeList", @@ -113356,15 +118095,15 @@ "max_items": 1 }, { - "name": "id", + "name": "created_at", "type": "TypeString", - "description": "ID of the the template.", + "description": "Timestamp of when the template was created.", "computed": true }, { - "name": "version", - "type": "TypeInt", - "description": "Version of the the template.", + "name": "last_modified_at", + "type": "TypeString", + "description": "Timestamp of when the template was last modified.", "computed": true }, { @@ -113372,85 +118111,38 @@ "type": "TypeList", "description": "Existing policy templates that you can reference to assign access in the trusted profile component.", "optional": true, - "elem": { - "id": { - "name": "id", - "type": "TypeString", - "description": "ID of Access Policy Template.", - "required": true - }, - "version": { - "name": "version", - "type": "TypeString", - "description": "Version of Access Policy Template.", - "required": true - } - } - }, - { - "name": "history", - "type": "TypeList", - "description": "History of the trusted profile template.", - "computed": true, - "elem": { - "action": { - "name": "action", - "type": "TypeString", - "description": "Action of the history entry.", - "computed": true - }, - "iam_id": { - "name": "iam_id", - "type": "TypeString", - "description": "IAM ID of the identity which triggered the action.", - "computed": true - }, - "iam_id_account": { - "name": "iam_id_account", - "type": "TypeString", - "description": "Account of the identity which triggered the action.", - "computed": true - }, - "message": { - "name": "message", - "type": "TypeString", - "description": "Message which summarizes the executed action.", - "computed": true - }, - "params": { - "name": "params", - "type": "TypeList", - "description": "Params of the history entry.", - "computed": true, - "elem": { - "type": "TypeString" - } + "elem": { + "id": { + "name": "id", + "type": "TypeString", + "description": "ID of Access Policy Template.", + "required": true }, - "timestamp": { - "name": "timestamp", + "version": { + "name": "version", "type": "TypeString", - "description": "Timestamp when the action was triggered.", - "computed": true + "description": "Version of Access Policy Template.", + "required": true } } }, { - "name": "crn", - "type": "TypeString", - "description": "Cloud resource name.", - "cloud_data_type": "crn", + "name": "version", + "type": "TypeInt", + "description": "Version of the the template.", "computed": true }, { - "name": "created_by_id", + "name": "entity_tag", "type": "TypeString", - "description": "IAMid of the creator.", + "description": "Entity tag for this templateId-version combination.", "computed": true }, { - "name": "last_modified_at", + "name": "crn", "type": "TypeString", - "description": "Timestamp of when the template was last modified.", + "description": "Cloud resource name.", + "cloud_data_type": "crn", "computed": true }, { @@ -113470,38 +118162,20 @@ "type": "TypeString", "description": "The description of the trusted profile template. Describe the template for enterprise account users.", "optional": true - }, - { - "name": "entity_tag", - "type": "TypeString", - "description": "Entity tag for this templateId-version combination.", - "computed": true - }, - { - "name": "created_at", - "type": "TypeString", - "description": "Timestamp of when the template was created.", - "computed": true } ], "ibm_iam_trusted_profile_template_assignment": [ { - "name": "template_id", - "type": "TypeString", - "description": "Template Id.", + "name": "template_version", + "type": "TypeInt", + "description": "Template version.", "required": true }, { - "name": "status", - "type": "TypeString", - "description": "Assignment status.", - "computed": true - }, - { - "name": "entity_tag", + "name": "target", "type": "TypeString", - "description": "Entity tag for this assignment record.", - "computed": true + "description": "Assignment target.", + "required": true }, { "name": "context", @@ -113583,6 +118257,71 @@ "description": "Enterprise account Id.", "computed": true }, + { + "name": "last_modified_by_id", + "type": "TypeString", + "description": "IAMid of the identity that last modified the assignment.", + "computed": true + }, + { + "name": "history", + "type": "TypeList", + "description": "Assignment history.", + "computed": true, + "elem": { + "action": { + "name": "action", + "type": "TypeString", + "description": "Action of the history entry.", + "computed": true + }, + "iam_id": { + "name": "iam_id", + "type": "TypeString", + "description": "IAM ID of the identity which triggered the action.", + "computed": true + }, + "iam_id_account": { + "name": "iam_id_account", + "type": "TypeString", + "description": "Account of the identity which triggered the action.", + "computed": true + }, + "message": { + "name": "message", + "type": "TypeString", + "description": "Message which summarizes the executed action.", + "computed": true + }, + "params": { + "name": "params", + "type": "TypeList", + "description": "Params of the history entry.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "timestamp": { + "name": "timestamp", + "type": "TypeString", + "description": "Timestamp when the action was triggered.", + "computed": true + } + } + }, + { + "name": "href", + "type": "TypeString", + "description": "Href.", + "computed": true + }, + { + "name": "template_id", + "type": "TypeString", + "description": "Template Id.", + "required": true + }, { "name": "resources", "type": "TypeList", @@ -113741,109 +118480,44 @@ } }, { - "name": "last_modified_at", + "name": "entity_tag", "type": "TypeString", - "description": "Assignment modified at.", + "description": "Entity tag for this assignment record.", "computed": true }, { - "name": "target", + "name": "target_type", "type": "TypeString", - "description": "Assignment target.", - "required": true + "description": "Assignment target type.", + "required": true, + "options": "Account, AccountGroup" }, { - "name": "created_at", + "name": "status", "type": "TypeString", - "description": "Assignment created at.", + "description": "Assignment status.", "computed": true }, { - "name": "created_by_id", + "name": "created_at", "type": "TypeString", - "description": "IAMid of the identity that created the assignment.", + "description": "Assignment created at.", "computed": true }, { - "name": "template_version", - "type": "TypeInt", - "description": "Template version.", - "required": true - }, - { - "name": "target_type", - "type": "TypeString", - "description": "Assignment target type.", - "required": true, - "options": "Account, AccountGroup" - }, - { - "name": "history", - "type": "TypeList", - "description": "Assignment history.", - "computed": true, - "elem": { - "action": { - "name": "action", - "type": "TypeString", - "description": "Action of the history entry.", - "computed": true - }, - "iam_id": { - "name": "iam_id", - "type": "TypeString", - "description": "IAM ID of the identity which triggered the action.", - "computed": true - }, - "iam_id_account": { - "name": "iam_id_account", - "type": "TypeString", - "description": "Account of the identity which triggered the action.", - "computed": true - }, - "message": { - "name": "message", - "type": "TypeString", - "description": "Message which summarizes the executed action.", - "computed": true - }, - "params": { - "name": "params", - "type": "TypeList", - "description": "Params of the history entry.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "timestamp": { - "name": "timestamp", - "type": "TypeString", - "description": "Timestamp when the action was triggered.", - "computed": true - } - } - }, - { - "name": "href", + "name": "created_by_id", "type": "TypeString", - "description": "Href.", + "description": "IAMid of the identity that created the assignment.", "computed": true }, { - "name": "last_modified_by_id", + "name": "last_modified_at", "type": "TypeString", - "description": "IAMid of the identity that last modified the assignment.", + "description": "Assignment modified at.", "computed": true } ], "ibm_iam_user_invite": [ - { - "name": "number_of_invited_users", - "type": "TypeInt", - "description": "Number of users invited to an account", - "computed": true - }, { "name": "invited_users", "type": "TypeList", @@ -114182,6 +118856,12 @@ } } } + }, + { + "name": "number_of_invited_users", + "type": "TypeInt", + "description": "Number of users invited to an account", + "computed": true } ], "ibm_iam_user_policy": [ @@ -114220,13 +118900,11 @@ } }, { - "name": "tags", - "type": "TypeSet", - "cloud_data_type": "tags", + "name": "transaction_id", + "type": "TypeString", + "description": "Set transactionID for debug", "optional": true, - "elem": { - "type": "TypeString" - } + "computed": true }, { "name": "rule_operator", @@ -114319,6 +118997,15 @@ "default_value": false, "optional": true }, + { + "name": "tags", + "type": "TypeSet", + "cloud_data_type": "tags", + "optional": true, + "elem": { + "type": "TypeString" + } + }, { "name": "resource_tags", "type": "TypeSet", @@ -114352,13 +119039,6 @@ "description": "Description of the Policy", "optional": true }, - { - "name": "transaction_id", - "type": "TypeString", - "description": "Set transactionID for debug", - "optional": true, - "computed": true - }, { "name": "rule_conditions", "type": "TypeSet", @@ -114408,39 +119088,55 @@ } ], "ibm_ipsec_vpn": [ + { + "name": "datacenter", + "type": "TypeString", + "description": "Datacenter name", + "immutable": true, + "required": true + }, { "name": "name", "type": "TypeString", "computed": true }, { - "name": "address_translation", + "name": "phase_two", "type": "TypeList", "optional": true, "elem": { - "internal_ip_adress": { - "name": "internal_ip_adress", + "authentication": { + "name": "authentication", "type": "TypeString", - "required": true + "default_value": "MD5", + "optional": true }, - "notes": { - "name": "notes", - "type": "TypeString", + "diffie_hellman_group": { + "name": "diffie_hellman_group", + "type": "TypeInt", + "default_value": 2, "optional": true }, - "remote_ip_adress": { - "name": "remote_ip_adress", + "encryption": { + "name": "encryption", "type": "TypeString", - "required": true + "default_value": "3DES", + "optional": true + }, + "keylife": { + "name": "keylife", + "type": "TypeInt", + "default_value": 3600, + "optional": true } }, "max_items": 1, "min_items": 1 }, { - "name": "preshared_key", + "name": "customer_peer_ip", "type": "TypeString", - "description": "Preshared Key data", + "description": "Customer Peer IP Address", "optional": true }, { @@ -114468,41 +119164,16 @@ "min_items": 1 }, { - "name": "datacenter", - "type": "TypeString", - "description": "Datacenter name", - "immutable": true, - "required": true + "name": "service_subnet_id", + "type": "TypeInt", + "description": "Service subnet ID value", + "optional": true }, { "name": "internal_peer_ip_address", "type": "TypeString", "computed": true }, - { - "name": "customer_peer_ip", - "type": "TypeString", - "description": "Customer Peer IP Address", - "optional": true - }, - { - "name": "internal_subnet_id", - "type": "TypeInt", - "description": "Internal subnet ID value", - "optional": true - }, - { - "name": "remote_subnet_id", - "type": "TypeInt", - "description": "Remote subnet ID value", - "optional": true - }, - { - "name": "service_subnet_id", - "type": "TypeInt", - "description": "Service subnet ID value", - "optional": true - }, { "name": "phase_one", "type": "TypeList", @@ -114537,68 +119208,60 @@ "min_items": 1 }, { - "name": "phase_two", + "name": "address_translation", "type": "TypeList", "optional": true, "elem": { - "authentication": { - "name": "authentication", + "internal_ip_adress": { + "name": "internal_ip_adress", "type": "TypeString", - "default_value": "MD5", - "optional": true - }, - "diffie_hellman_group": { - "name": "diffie_hellman_group", - "type": "TypeInt", - "default_value": 2, - "optional": true + "required": true }, - "encryption": { - "name": "encryption", + "notes": { + "name": "notes", "type": "TypeString", - "default_value": "3DES", "optional": true }, - "keylife": { - "name": "keylife", - "type": "TypeInt", - "default_value": 3600, - "optional": true + "remote_ip_adress": { + "name": "remote_ip_adress", + "type": "TypeString", + "required": true } }, "max_items": 1, "min_items": 1 - } - ], - "ibm_is_backup_policy": [ + }, { - "name": "last_job_completed_at", + "name": "preshared_key", "type": "TypeString", - "description": "The date and time that the most recent job for this backup policy completed.", - "computed": true + "description": "Preshared Key data", + "optional": true }, { - "name": "resource_type", - "type": "TypeString", - "description": "The resource type.", - "computed": true + "name": "internal_subnet_id", + "type": "TypeInt", + "description": "Internal subnet ID value", + "optional": true }, { - "name": "version", + "name": "remote_subnet_id", + "type": "TypeInt", + "description": "Remote subnet ID value", + "optional": true + } + ], + "ibm_is_backup_policy": [ + { + "name": "href", "type": "TypeString", + "description": "The URL for this backup policy.", "computed": true }, { - "name": "match_user_tags", - "type": "TypeSet", - "description": "The user tags this backup policy applies to. Resources that have both a matching user tag and a matching type will be subject to the backup policy.", - "required": true, - "min_length": 1, - "max_length": 128, - "matches": "^[A-Za-z0-9:_ .-]+$", - "elem": { - "type": "TypeString" - } + "name": "last_job_completed_at", + "type": "TypeString", + "description": "The date and time that the most recent job for this backup policy completed.", + "computed": true }, { "name": "name", @@ -114609,6 +119272,22 @@ "max_length": 63, "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$" }, + { + "name": "crn", + "type": "TypeString", + "description": "The CRN for this backup policy.", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "resource_group", + "type": "TypeString", + "description": "The unique identifier of the resource group to use. If unspecified, the account's [default resourcegroup](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used.", + "cloud_data_type": "resource_group", + "immutable": true, + "optional": true, + "computed": true + }, { "name": "created_at", "type": "TypeString", @@ -114616,9 +119295,20 @@ "computed": true }, { - "name": "href", + "name": "lifecycle_state", + "type": "TypeString", + "description": "The lifecycle state of the backup policy.", + "computed": true + }, + { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true + }, + { + "name": "version", "type": "TypeString", - "description": "The URL for this backup policy.", "computed": true }, { @@ -114635,26 +119325,16 @@ } }, { - "name": "resource_group", - "type": "TypeString", - "description": "The unique identifier of the resource group to use. If unspecified, the account's [default resourcegroup](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used.", - "cloud_data_type": "resource_group", - "immutable": true, - "optional": true, - "computed": true - }, - { - "name": "crn", - "type": "TypeString", - "description": "The CRN for this backup policy.", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "lifecycle_state", - "type": "TypeString", - "description": "The lifecycle state of the backup policy.", - "computed": true + "name": "match_user_tags", + "type": "TypeSet", + "description": "The user tags this backup policy applies to. Resources that have both a matching user tag and a matching type will be subject to the backup policy.", + "required": true, + "min_length": 1, + "max_length": 128, + "matches": "^[A-Za-z0-9:_ .-]+$", + "elem": { + "type": "TypeString" + } } ], "ibm_is_backup_policy_plan": [ @@ -114666,19 +119346,13 @@ "required": true }, { - "name": "cron_spec", - "type": "TypeString", - "description": "The cron specification for the backup schedule.", - "required": true, - "min_length": 9, - "max_length": 63, - "matches": "^((((\\d+,)+\\d+|([\\d\\*]+(\\/|-)\\d+)|\\d+|\\*) ?){5,7})$" - }, - { - "name": "version", - "type": "TypeString", - "description": "Version of the BackupPolicyPlan.", - "computed": true + "name": "attach_user_tags", + "type": "TypeSet", + "description": "User tags to attach to each backup (snapshot) created by this plan. If unspecified, no user tags will be attached.", + "optional": true, + "elem": { + "type": "TypeString" + } }, { "name": "name", @@ -114689,6 +119363,34 @@ "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$", "optional": true }, + { + "name": "remote_region_policy", + "type": "TypeList", + "description": "Backup policy plan cross region rule.", + "optional": true, + "elem": { + "delete_over_count": { + "name": "delete_over_count", + "type": "TypeInt", + "description": "The maximum number of recent remote copies to keep in this region.", + "optional": true, + "computed": true + }, + "encryption_key": { + "name": "encryption_key", + "type": "TypeString", + "description": "The CRN of the [Key Protect Root Key](https://cloud.ibm.com/docs/key-protect?topic=key-protect-getting-started-tutorial) or [Hyper Protect Crypto Services Root Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started) for this resource.", + "optional": true, + "computed": true + }, + "region": { + "name": "region", + "type": "TypeString", + "description": "The globally unique name for this region.", + "required": true + } + } + }, { "name": "resource_type", "type": "TypeString", @@ -114696,33 +119398,27 @@ "computed": true }, { - "name": "backup_policy_plan_id", + "name": "cron_spec", "type": "TypeString", - "description": "The backup policy identifier.", - "computed": true + "description": "The cron specification for the backup schedule.", + "required": true, + "min_length": 9, + "max_length": 63, + "matches": "^((((\\d+,)+\\d+|([\\d\\*]+(\\/|-)\\d+)|\\d+|\\*) ?){5,7})$" }, { - "name": "deletion_trigger", - "type": "TypeList", + "name": "active", + "type": "TypeBool", + "description": "Indicates whether the plan is active.", "optional": true, - "computed": true, - "elem": { - "delete_after": { - "name": "delete_after", - "type": "TypeInt", - "description": "The maximum number of days to keep each backup after creation.", - "default_value": 30, - "optional": true - }, - "delete_over_count": { - "name": "delete_over_count", - "type": "TypeString", - "description": "The maximum number of recent backups to keep. If unspecified, there will be no maximum.", - "optional": true, - "computed": true - } - }, - "max_items": 1 + "computed": true + }, + { + "name": "copy_user_tags", + "type": "TypeBool", + "description": "Indicates whether to copy the source's user tags to the created backups (snapshots).", + "default_value": true, + "optional": true }, { "name": "clone_policy", @@ -114751,89 +119447,66 @@ "max_items": 1 }, { - "name": "created_at", + "name": "version", "type": "TypeString", - "description": "The date and time that the backup policy plan was created.", + "description": "Version of the BackupPolicyPlan.", "computed": true }, { - "name": "lifecycle_state", + "name": "href", "type": "TypeString", - "description": "The lifecycle state of this backup policy plan.", - "computed": true - }, - { - "name": "active", - "type": "TypeBool", - "description": "Indicates whether the plan is active.", - "optional": true, + "description": "The URL for this backup policy plan.", "computed": true }, { - "name": "attach_user_tags", - "type": "TypeSet", - "description": "User tags to attach to each backup (snapshot) created by this plan. If unspecified, no user tags will be attached.", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "copy_user_tags", - "type": "TypeBool", - "description": "Indicates whether to copy the source's user tags to the created backups (snapshots).", - "default_value": true, - "optional": true - }, - { - "name": "href", + "name": "backup_policy_plan_id", "type": "TypeString", - "description": "The URL for this backup policy plan.", + "description": "The backup policy identifier.", "computed": true }, { - "name": "remote_region_policy", + "name": "deletion_trigger", "type": "TypeList", - "description": "Backup policy plan cross region rule.", "optional": true, + "computed": true, "elem": { - "delete_over_count": { - "name": "delete_over_count", + "delete_after": { + "name": "delete_after", "type": "TypeInt", - "description": "The maximum number of recent remote copies to keep in this region.", - "optional": true, - "computed": true + "description": "The maximum number of days to keep each backup after creation.", + "default_value": 30, + "optional": true }, - "encryption_key": { - "name": "encryption_key", + "delete_over_count": { + "name": "delete_over_count", "type": "TypeString", - "description": "The CRN of the [Key Protect Root Key](https://cloud.ibm.com/docs/key-protect?topic=key-protect-getting-started-tutorial) or [Hyper Protect Crypto Services Root Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started) for this resource.", + "description": "The maximum number of recent backups to keep. If unspecified, there will be no maximum.", "optional": true, "computed": true - }, - "region": { - "name": "region", - "type": "TypeString", - "description": "The globally unique name for this region.", - "required": true } - } + }, + "max_items": 1 + }, + { + "name": "created_at", + "type": "TypeString", + "description": "The date and time that the backup policy plan was created.", + "computed": true + }, + { + "name": "lifecycle_state", + "type": "TypeString", + "description": "The lifecycle state of this backup policy plan.", + "computed": true } ], "ibm_is_bare_metal_server": [ { - "name": "network_interfaces", - "type": "TypeSet", - "optional": true, - "computed": true, + "name": "primary_network_interface", + "type": "TypeList", + "description": "Primary Network interface info", + "required": true, "elem": { - "allow_interface_to_float": { - "name": "allow_interface_to_float", - "type": "TypeBool", - "description": "Indicates if the interface can float to any other server within the same resource_group. The interface will float automatically if the network detects a GARP or RARP on another bare metal server in the resource group. Applies only to vlan type interfaces.", - "optional": true, - "computed": true - }, "allow_ip_spoofing": { "name": "allow_ip_spoofing", "type": "TypeBool", @@ -114871,15 +119544,15 @@ "interface_type": { "name": "interface_type", "type": "TypeString", - "description": "The network interface type: [ pci, vlan, hipersocket ]", + "description": "The network interface type: [ pci, hipersocket ]", "optional": true, "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "The user-defined name for this network interface. If unspecified, the name will be a hyphenated list of randomly-selected words", - "required": true + "optional": true, + "computed": true }, "port_speed": { "name": "port_speed", @@ -114939,7 +119612,6 @@ "security_groups": { "name": "security_groups", "type": "TypeSet", - "description": "Collection of security group ids", "optional": true, "computed": true, "elem": { @@ -114949,93 +119621,26 @@ "subnet": { "name": "subnet", "type": "TypeString", - "description": "The associated subnet", + "immutable": true, "required": true - }, - "vlan": { - "name": "vlan", - "type": "TypeInt", - "description": "Indicates the 802.1Q VLAN ID tag that must be used for all traffic on this interface", - "optional": true, - "computed": true } - } + }, + "max_items": 1, + "min_items": 1 }, { - "name": "keys", + "name": "network_interfaces", "type": "TypeSet", - "description": "SSH key Ids for the bare metal server", - "required": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "zone", - "type": "TypeString", - "description": "Zone name", - "immutable": true, - "required": true - }, - { - "name": "resource_group", - "type": "TypeString", - "description": "Resource group name", - "cloud_data_type": "resource_group", - "immutable": true, "optional": true, - "computed": true - }, - { - "name": "status", - "type": "TypeString", - "description": "Bare metal server status", - "computed": true - }, - { - "name": "boot_target", - "type": "TypeString", - "description": "The unique identifier for this bare metal server disk", - "computed": true - }, - { - "name": "cpu", - "type": "TypeList", - "description": "The bare metal server CPU configuration", "computed": true, "elem": { - "architecture": { - "name": "architecture", - "type": "TypeString", - "description": "The CPU architecture", - "computed": true - }, - "core_count": { - "name": "core_count", - "type": "TypeInt", - "description": "The total number of cores", - "computed": true - }, - "socket_count": { - "name": "socket_count", - "type": "TypeInt", - "description": "The total number of CPU sockets", + "allow_interface_to_float": { + "name": "allow_interface_to_float", + "type": "TypeBool", + "description": "Indicates if the interface can float to any other server within the same resource_group. The interface will float automatically if the network detects a GARP or RARP on another bare metal server in the resource group. Applies only to vlan type interfaces.", + "optional": true, "computed": true }, - "threads_per_core": { - "name": "threads_per_core", - "type": "TypeInt", - "description": "The total number of hardware threads per core", - "computed": true - } - } - }, - { - "name": "primary_network_interface", - "type": "TypeList", - "description": "Primary Network interface info", - "required": true, - "elem": { "allow_ip_spoofing": { "name": "allow_ip_spoofing", "type": "TypeBool", @@ -115073,15 +119678,15 @@ "interface_type": { "name": "interface_type", "type": "TypeString", - "description": "The network interface type: [ pci, hipersocket ]", + "description": "The network interface type: [ pci, vlan, hipersocket ]", "optional": true, "computed": true }, "name": { "name": "name", "type": "TypeString", - "optional": true, - "computed": true + "description": "The user-defined name for this network interface. If unspecified, the name will be a hyphenated list of randomly-selected words", + "required": true }, "port_speed": { "name": "port_speed", @@ -115141,6 +119746,7 @@ "security_groups": { "name": "security_groups", "type": "TypeSet", + "description": "Collection of security group ids", "optional": true, "computed": true, "elem": { @@ -115150,46 +119756,37 @@ "subnet": { "name": "subnet", "type": "TypeString", - "immutable": true, + "description": "The associated subnet", "required": true - } - }, - "max_items": 1, - "min_items": 1 - }, - { - "name": "status_reasons", - "type": "TypeList", - "computed": true, - "elem": { - "code": { - "name": "code", - "type": "TypeString", - "description": "A snake case string succinctly identifying the status reason", - "computed": true - }, - "message": { - "name": "message", - "type": "TypeString", - "description": "An explanation of the status reason", - "computed": true }, - "more_info": { - "name": "more_info", - "type": "TypeString", - "description": "Link to documentation about this status reason", + "vlan": { + "name": "vlan", + "type": "TypeInt", + "description": "Indicates the 802.1Q VLAN ID tag that must be used for all traffic on this interface", + "optional": true, "computed": true } } }, { - "name": "name", + "name": "zone", "type": "TypeString", - "description": "Bare metal server name", - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", - "optional": true + "description": "Zone name", + "immutable": true, + "required": true + }, + { + "name": "resource_type", + "type": "TypeString", + "description": "Resource type name", + "computed": true + }, + { + "name": "enable_secure_boot", + "type": "TypeBool", + "description": "Indicates whether secure boot is enabled. If enabled, the image must support secure boot or the server will fail to boot.", + "optional": true, + "computed": true }, { "name": "action", @@ -115198,6 +119795,61 @@ "options": "start, restart, stop", "optional": true }, + { + "name": "crn", + "type": "TypeString", + "description": "The CRN for this bare metal server", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "delete_type", + "type": "TypeString", + "description": "Enables stopping type of the bare metal server before deleting", + "default_value": "hard", + "optional": true + }, + { + "name": "access_tags", + "type": "TypeSet", + "description": "List of access management tags", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "trusted_platform_module", + "type": "TypeList", + "optional": true, + "computed": true, + "elem": { + "enabled": { + "name": "enabled", + "type": "TypeBool", + "description": "Indicates whether the trusted platform module is enabled.", + "computed": true + }, + "mode": { + "name": "mode", + "type": "TypeString", + "description": "The trusted platform module mode to use. The specified value must be listed in the bare metal server profile's supported_trusted_platform_module_modes", + "optional": true, + "computed": true + }, + "supported_modes": { + "name": "supported_modes", + "type": "TypeSet", + "description": "The trusted platform module (TPM) mode:: disabled: No TPM functionality, tpm_2: TPM 2.0. The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected property value was encountered. Enum: [ disabled, tpm_2 ]", + "computed": true, + "elem": { + "type": "TypeString" + } + } + }, + "max_items": 1 + }, { "name": "disks", "type": "TypeList", @@ -115249,79 +119901,74 @@ "computed": true }, { - "name": "user_data", + "name": "resource_group", "type": "TypeString", - "description": "User data given for the bare metal server", + "description": "Resource group name", + "cloud_data_type": "resource_group", "immutable": true, - "optional": true + "optional": true, + "computed": true }, { - "name": "tags", - "type": "TypeSet", - "description": "Tags for the Bare metal server", - "min_length": 1, - "max_length": 128, - "matches": "^[A-Za-z0-9:_ .-]+$", + "name": "vpc", + "type": "TypeString", + "description": "The VPC the bare metal server is to be a part of", + "immutable": true, "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "computed": true }, { - "name": "access_tags", - "type": "TypeSet", - "description": "List of access management tags", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "status", + "type": "TypeString", + "description": "Bare metal server status", + "computed": true }, { - "name": "enable_secure_boot", - "type": "TypeBool", - "description": "Indicates whether secure boot is enabled. If enabled, the image must support secure boot or the server will fail to boot.", - "optional": true, + "name": "name", + "type": "TypeString", + "description": "Bare metal server name", + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", + "optional": true + }, + { + "name": "bandwidth", + "type": "TypeInt", + "description": "The total bandwidth (in megabits per second)", "computed": true }, { - "name": "trusted_platform_module", + "name": "cpu", "type": "TypeList", - "optional": true, + "description": "The bare metal server CPU configuration", "computed": true, "elem": { - "enabled": { - "name": "enabled", - "type": "TypeBool", - "description": "Indicates whether the trusted platform module is enabled.", + "architecture": { + "name": "architecture", + "type": "TypeString", + "description": "The CPU architecture", "computed": true }, - "mode": { - "name": "mode", - "type": "TypeString", - "description": "The trusted platform module mode to use. The specified value must be listed in the bare metal server profile's supported_trusted_platform_module_modes", - "optional": true, + "core_count": { + "name": "core_count", + "type": "TypeInt", + "description": "The total number of cores", "computed": true }, - "supported_modes": { - "name": "supported_modes", - "type": "TypeSet", - "description": "The trusted platform module (TPM) mode:: disabled: No TPM functionality, tpm_2: TPM 2.0. The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected property value was encountered. Enum: [ disabled, tpm_2 ]", - "computed": true, - "elem": { - "type": "TypeString" - } + "socket_count": { + "name": "socket_count", + "type": "TypeInt", + "description": "The total number of CPU sockets", + "computed": true + }, + "threads_per_core": { + "name": "threads_per_core", + "type": "TypeInt", + "description": "The total number of hardware threads per core", + "computed": true } - }, - "max_items": 1 - }, - { - "name": "crn", - "type": "TypeString", - "description": "The CRN for this bare metal server", - "cloud_data_type": "crn", - "computed": true + } }, { "name": "image", @@ -115331,30 +119978,54 @@ "required": true }, { - "name": "profile", + "name": "user_data", "type": "TypeString", - "description": "profile name", + "description": "User data given for the bare metal server", "immutable": true, - "required": true + "optional": true }, { - "name": "vpc", - "type": "TypeString", - "description": "The VPC the bare metal server is to be a part of", - "immutable": true, - "optional": true, - "computed": true + "name": "status_reasons", + "type": "TypeList", + "computed": true, + "elem": { + "code": { + "name": "code", + "type": "TypeString", + "description": "A snake case string succinctly identifying the status reason", + "computed": true + }, + "message": { + "name": "message", + "type": "TypeString", + "description": "An explanation of the status reason", + "computed": true + }, + "more_info": { + "name": "more_info", + "type": "TypeString", + "description": "Link to documentation about this status reason", + "computed": true + } + } }, { - "name": "resource_type", - "type": "TypeString", - "description": "Resource type name", - "computed": true + "name": "tags", + "type": "TypeSet", + "description": "Tags for the Bare metal server", + "min_length": 1, + "max_length": 128, + "matches": "^[A-Za-z0-9:_ .-]+$", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "bandwidth", - "type": "TypeInt", - "description": "The total bandwidth (in megabits per second)", + "name": "boot_target", + "type": "TypeString", + "description": "The unique identifier for this bare metal server disk", "computed": true }, { @@ -115364,14 +120035,30 @@ "computed": true }, { - "name": "delete_type", + "name": "keys", + "type": "TypeSet", + "description": "SSH key Ids for the bare metal server", + "required": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "profile", "type": "TypeString", - "description": "Enables stopping type of the bare metal server before deleting", - "default_value": "hard", - "optional": true + "description": "profile name", + "immutable": true, + "required": true } ], "ibm_is_bare_metal_server_action": [ + { + "name": "bare_metal_server", + "type": "TypeString", + "description": "Bare metal server identifier", + "immutable": true, + "required": true + }, { "name": "stop_type", "type": "TypeString", @@ -115416,13 +120103,6 @@ "computed": true } } - }, - { - "name": "bare_metal_server", - "type": "TypeString", - "description": "Bare metal server identifier", - "immutable": true, - "required": true } ], "ibm_is_bare_metal_server_disk": [ @@ -115450,6 +120130,16 @@ } ], "ibm_is_bare_metal_server_network_interface": [ + { + "name": "allowed_vlans", + "type": "TypeSet", + "description": "Indicates what VLAN IDs (for VLAN type only) can use this physical (PCI type) interface. A given VLAN can only be in the allowed_vlans array for one PCI type adapter per bare metal server.", + "optional": true, + "computed": true, + "elem": { + "type": "TypeInt" + } + }, { "name": "vlan", "type": "TypeInt", @@ -115458,15 +120148,9 @@ "computed": true }, { - "name": "bare_metal_server", - "type": "TypeString", - "description": "Bare metal server identifier", - "required": true - }, - { - "name": "network_interface", + "name": "mac_address", "type": "TypeString", - "description": "The bare metal server network interface identifier", + "description": "The MAC address of the interface. If absent, the value is not known.", "computed": true }, { @@ -115520,38 +120204,43 @@ "max_items": 1 }, { - "name": "type", + "name": "href", "type": "TypeString", - "description": "The type of this bare metal server network interface : [ primary, secondary ]", + "description": "The URL for this network interface", "computed": true }, { - "name": "allow_interface_to_float", + "name": "allow_ip_spoofing", "type": "TypeBool", - "description": "Indicates if the interface can float to any other server within the same resource_group. The interface will float automatically if the network detects a GARP or RARP on another bare metal server in the resource group. Applies only to vlan type interfaces.", - "optional": true, - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "The user-defined name for this network interface", - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", + "description": "Indicates whether source IP spoofing is allowed on this interface. If false, source IP spoofing is prevented on this interface. If true, source IP spoofing is allowed on this interface.", "optional": true, "computed": true }, { - "name": "port_speed", - "type": "TypeInt", - "description": "The network interface port speed in Mbps", - "computed": true + "name": "floating_ips", + "type": "TypeList", + "description": "The floating IPs associated with this network interface.", + "computed": true, + "elem": { + "address": { + "name": "address", + "type": "TypeString", + "description": "The globally unique IP address", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The globally unique IP identifier", + "computed": true + } + } }, { - "name": "resource_type", - "type": "TypeString", - "description": "The resource type : [ subnet_reserved_ip ]", + "name": "enable_infrastructure_nat", + "type": "TypeBool", + "description": "If true, the VPC infrastructure performs any needed NAT operations. If false, the packet is passed unmodified to/from the network interface, allowing the workload to perform any needed NAT operations.", + "optional": true, "computed": true }, { @@ -115571,14 +120260,10 @@ "required": true }, { - "name": "allowed_vlans", - "type": "TypeSet", - "description": "Indicates what VLAN IDs (for VLAN type only) can use this physical (PCI type) interface. A given VLAN can only be in the allowed_vlans array for one PCI type adapter per bare metal server.", - "optional": true, - "computed": true, - "elem": { - "type": "TypeInt" - } + "name": "bare_metal_server", + "type": "TypeString", + "description": "Bare metal server identifier", + "required": true }, { "name": "hard_stop", @@ -115588,12 +120273,62 @@ "optional": true }, { - "name": "enable_infrastructure_nat", + "name": "name", + "type": "TypeString", + "description": "The user-defined name for this network interface", + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", + "optional": true, + "computed": true + }, + { + "name": "port_speed", + "type": "TypeInt", + "description": "The network interface port speed in Mbps", + "computed": true + }, + { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type : [ subnet_reserved_ip ]", + "computed": true + }, + { + "name": "status", + "type": "TypeString", + "description": "The status of the network interface : [ available, deleting, failed, pending ]", + "computed": true + }, + { + "name": "type", + "type": "TypeString", + "description": "The type of this bare metal server network interface : [ primary, secondary ]", + "computed": true + }, + { + "name": "allow_interface_to_float", "type": "TypeBool", - "description": "If true, the VPC infrastructure performs any needed NAT operations. If false, the packet is passed unmodified to/from the network interface, allowing the workload to perform any needed NAT operations.", + "description": "Indicates if the interface can float to any other server within the same resource_group. The interface will float automatically if the network detects a GARP or RARP on another bare metal server in the resource group. Applies only to vlan type interfaces.", "optional": true, "computed": true }, + { + "name": "network_interface", + "type": "TypeString", + "description": "The bare metal server network interface identifier", + "computed": true + }, + { + "name": "interface_type", + "type": "TypeString", + "description": "The network interface type: [ pci, vlan, hipersocket ]", + "options": "pci, hipersocket, vlan", + "optional": true, + "computed": true + } + ], + "ibm_is_bare_metal_server_network_interface_allow_float": [ { "name": "floating_ips", "type": "TypeList", @@ -115615,45 +120350,39 @@ } }, { - "name": "mac_address", + "name": "href", "type": "TypeString", - "description": "The MAC address of the interface. If absent, the value is not known.", + "description": "The URL for this network interface", "computed": true }, { - "name": "allow_ip_spoofing", - "type": "TypeBool", - "description": "Indicates whether source IP spoofing is allowed on this interface. If false, source IP spoofing is prevented on this interface. If true, source IP spoofing is allowed on this interface.", - "optional": true, + "name": "port_speed", + "type": "TypeInt", + "description": "The network interface port speed in Mbps", "computed": true }, { - "name": "href", + "name": "resource_type", "type": "TypeString", - "description": "The URL for this network interface", + "description": "The resource type : [ subnet_reserved_ip ]", "computed": true }, { - "name": "interface_type", + "name": "status", "type": "TypeString", - "description": "The network interface type: [ pci, vlan, hipersocket ]", - "options": "pci, hipersocket, vlan", - "optional": true, + "description": "The status of the network interface : [ available, deleting, failed, pending ]", "computed": true }, { - "name": "status", + "name": "floating_bare_metal_server", "type": "TypeString", - "description": "The status of the network interface : [ available, deleting, failed, pending ]", + "description": "Bare metal server identifier of the server to which nic is floating to", "computed": true - } - ], - "ibm_is_bare_metal_server_network_interface_allow_float": [ + }, { - "name": "name", + "name": "network_interface", "type": "TypeString", - "description": "The user-defined name for this network interface", - "optional": true, + "description": "The bare metal server network interface identifier", "computed": true }, { @@ -115666,49 +120395,6 @@ "type": "TypeString" } }, - { - "name": "status", - "type": "TypeString", - "description": "The status of the network interface : [ available, deleting, failed, pending ]", - "computed": true - }, - { - "name": "bare_metal_server", - "type": "TypeString", - "description": "Bare metal server identifier", - "required": true - }, - { - "name": "allow_ip_spoofing", - "type": "TypeBool", - "description": "Indicates whether source IP spoofing is allowed on this interface. If false, source IP spoofing is prevented on this interface. If true, source IP spoofing is allowed on this interface.", - "optional": true, - "computed": true - }, - { - "name": "vlan", - "type": "TypeInt", - "description": "Indicates the 802.1Q VLAN ID tag that must be used for all traffic on this interface", - "required": true - }, - { - "name": "href", - "type": "TypeString", - "description": "The URL for this network interface", - "computed": true - }, - { - "name": "mac_address", - "type": "TypeString", - "description": "The MAC address of the interface. If absent, the value is not known.", - "computed": true - }, - { - "name": "interface_type", - "type": "TypeString", - "description": "The network interface type: [ pci, vlan ]", - "computed": true - }, { "name": "primary_ip", "type": "TypeList", @@ -115760,72 +120446,66 @@ "max_items": 1 }, { - "name": "resource_type", + "name": "type", "type": "TypeString", - "description": "The resource type : [ subnet_reserved_ip ]", + "description": "The type of this bare metal server network interface : [ primary, secondary ]", "computed": true }, { - "name": "subnet", - "type": "TypeString", - "description": "The id of the associated subnet", + "name": "vlan", + "type": "TypeInt", + "description": "Indicates the 802.1Q VLAN ID tag that must be used for all traffic on this interface", "required": true }, { - "name": "allow_interface_to_float", - "type": "TypeBool", - "description": "Indicates if the interface can float to any other server within the same resource_group. The interface will float automatically if the network detects a GARP or RARP on another bare metal server in the resource group. Applies only to vlan type interfaces.", - "computed": true + "name": "bare_metal_server", + "type": "TypeString", + "description": "Bare metal server identifier", + "required": true }, { - "name": "enable_infrastructure_nat", - "type": "TypeBool", - "description": "If true, the VPC infrastructure performs any needed NAT operations. If false, the packet is passed unmodified to/from the network interface, allowing the workload to perform any needed NAT operations.", - "optional": true, + "name": "mac_address", + "type": "TypeString", + "description": "The MAC address of the interface. If absent, the value is not known.", "computed": true }, { - "name": "floating_ips", - "type": "TypeList", - "description": "The floating IPs associated with this network interface.", - "computed": true, - "elem": { - "address": { - "name": "address", - "type": "TypeString", - "description": "The globally unique IP address", - "computed": true - }, - "id": { - "name": "id", - "type": "TypeString", - "description": "The globally unique IP identifier", - "computed": true - } - } + "name": "interface_type", + "type": "TypeString", + "description": "The network interface type: [ pci, vlan ]", + "computed": true }, { - "name": "port_speed", - "type": "TypeInt", - "description": "The network interface port speed in Mbps", + "name": "name", + "type": "TypeString", + "description": "The user-defined name for this network interface", + "optional": true, "computed": true }, { - "name": "type", + "name": "subnet", "type": "TypeString", - "description": "The type of this bare metal server network interface : [ primary, secondary ]", + "description": "The id of the associated subnet", + "required": true + }, + { + "name": "allow_interface_to_float", + "type": "TypeBool", + "description": "Indicates if the interface can float to any other server within the same resource_group. The interface will float automatically if the network detects a GARP or RARP on another bare metal server in the resource group. Applies only to vlan type interfaces.", "computed": true }, { - "name": "floating_bare_metal_server", - "type": "TypeString", - "description": "Bare metal server identifier of the server to which nic is floating to", + "name": "allow_ip_spoofing", + "type": "TypeBool", + "description": "Indicates whether source IP spoofing is allowed on this interface. If false, source IP spoofing is prevented on this interface. If true, source IP spoofing is allowed on this interface.", + "optional": true, "computed": true }, { - "name": "network_interface", - "type": "TypeString", - "description": "The bare metal server network interface identifier", + "name": "enable_infrastructure_nat", + "type": "TypeBool", + "description": "If true, the VPC infrastructure performs any needed NAT operations. If false, the packet is passed unmodified to/from the network interface, allowing the workload to perform any needed NAT operations.", + "optional": true, "computed": true } ], @@ -115837,22 +120517,27 @@ "required": true }, { - "name": "zone", + "name": "name", "type": "TypeString", - "description": "Zone name", + "description": "Name of the floating IP", "computed": true }, { - "name": "target", + "name": "address", "type": "TypeString", - "description": "Target info", + "description": "Floating IP address", "computed": true }, { - "name": "crn", + "name": "zone", "type": "TypeString", - "description": "Floating IP crn", - "cloud_data_type": "crn", + "description": "Zone name", + "computed": true + }, + { + "name": "target", + "type": "TypeString", + "description": "Target info", "computed": true }, { @@ -115867,26 +120552,79 @@ "description": "The floating ip identifier of the network interface associated with the bare metal server", "required": true }, + { + "name": "status", + "type": "TypeString", + "description": "Floating IP status", + "computed": true + }, + { + "name": "crn", + "type": "TypeString", + "description": "Floating IP crn", + "cloud_data_type": "crn", + "computed": true + } + ], + "ibm_is_dedicated_host": [ + { + "name": "instance_placement_enabled", + "type": "TypeBool", + "description": "If set to true, instances can be placed on this dedicated host.", + "default_value": true, + "optional": true + }, { "name": "name", "type": "TypeString", - "description": "Name of the floating IP", + "description": "The unique user-defined name for this dedicated host. If unspecified, the name will be a hyphenated list of randomly-selected words.", + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", + "optional": true, "computed": true }, { - "name": "address", + "name": "crn", "type": "TypeString", - "description": "Floating IP address", + "description": "The CRN for this dedicated host.", + "cloud_data_type": "crn", "computed": true }, { - "name": "status", + "name": "memory", + "type": "TypeInt", + "description": "The total amount of memory in gibibytes for this host.", + "computed": true + }, + { + "name": "provisionable", + "type": "TypeBool", + "description": "Indicates whether this dedicated host is available for instance creation.", + "computed": true + }, + { + "name": "socket_count", + "type": "TypeInt", + "description": "The total number of sockets for this host.", + "computed": true + }, + { + "name": "resource_group", "type": "TypeString", - "description": "Floating IP status", + "description": "The unique identifier for the resource group to use. If unspecified, the account's [default resourcegroup](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used.", + "cloud_data_type": "resource_group", + "immutable": true, + "optional": true, "computed": true - } - ], - "ibm_is_dedicated_host": [ + }, + { + "name": "host_group", + "type": "TypeString", + "description": "The unique identifier of the dedicated host group for this dedicated host.", + "immutable": true, + "required": true + }, { "name": "available_memory", "type": "TypeInt", @@ -115914,12 +120652,86 @@ } }, { - "name": "crn", + "name": "state", "type": "TypeString", - "description": "The CRN for this dedicated host.", - "cloud_data_type": "crn", + "description": "The administrative state of the dedicated host.The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the dedicated host on which the unexpected property value was encountered.", + "computed": true + }, + { + "name": "zone", + "type": "TypeString", + "description": "The globally unique name of the zone this dedicated host resides in.", + "computed": true + }, + { + "name": "profile", + "type": "TypeString", + "description": "The Globally unique name of the dedicated host profile to use for this dedicated host.", + "immutable": true, + "required": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "The date and time that the dedicated host was created.", + "computed": true + }, + { + "name": "resource_type", + "type": "TypeString", + "description": "The type of resource referenced.", "computed": true }, + { + "name": "supported_instance_profiles", + "type": "TypeList", + "description": "Array of instance profiles that can be used by instances placed on this dedicated host.", + "computed": true, + "elem": { + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this virtual server instance profile.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The globally unique name for this virtual server instance profile.", + "computed": true + } + } + }, + { + "name": "vcpu", + "type": "TypeList", + "description": "The total VCPU of the dedicated host.", + "computed": true, + "elem": { + "architecture": { + "name": "architecture", + "type": "TypeString", + "description": "The VCPU architecture.", + "computed": true + }, + "count": { + "name": "count", + "type": "TypeInt", + "description": "The number of VCPUs assigned.", + "computed": true + } + } + }, + { + "name": "access_tags", + "type": "TypeSet", + "description": "List of access management tags", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, { "name": "disks", "type": "TypeList", @@ -116043,144 +120855,6 @@ } } }, - { - "name": "lifecycle_state", - "type": "TypeString", - "description": "The lifecycle state of the dedicated host resource.", - "computed": true - }, - { - "name": "instance_placement_enabled", - "type": "TypeBool", - "description": "If set to true, instances can be placed on this dedicated host.", - "default_value": true, - "optional": true - }, - { - "name": "profile", - "type": "TypeString", - "description": "The Globally unique name of the dedicated host profile to use for this dedicated host.", - "immutable": true, - "required": true - }, - { - "name": "resource_group", - "type": "TypeString", - "description": "The unique identifier for the resource group to use. If unspecified, the account's [default resourcegroup](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used.", - "cloud_data_type": "resource_group", - "immutable": true, - "optional": true, - "computed": true - }, - { - "name": "memory", - "type": "TypeInt", - "description": "The total amount of memory in gibibytes for this host.", - "computed": true - }, - { - "name": "supported_instance_profiles", - "type": "TypeList", - "description": "Array of instance profiles that can be used by instances placed on this dedicated host.", - "computed": true, - "elem": { - "href": { - "name": "href", - "type": "TypeString", - "description": "The URL for this virtual server instance profile.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "The globally unique name for this virtual server instance profile.", - "computed": true - } - } - }, - { - "name": "host_group", - "type": "TypeString", - "description": "The unique identifier of the dedicated host group for this dedicated host.", - "immutable": true, - "required": true - }, - { - "name": "socket_count", - "type": "TypeInt", - "description": "The total number of sockets for this host.", - "computed": true - }, - { - "name": "access_tags", - "type": "TypeSet", - "description": "List of access management tags", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "zone", - "type": "TypeString", - "description": "The globally unique name of the zone this dedicated host resides in.", - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "The unique user-defined name for this dedicated host. If unspecified, the name will be a hyphenated list of randomly-selected words.", - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", - "optional": true, - "computed": true - }, - { - "name": "resource_type", - "type": "TypeString", - "description": "The type of resource referenced.", - "computed": true - }, - { - "name": "vcpu", - "type": "TypeList", - "description": "The total VCPU of the dedicated host.", - "computed": true, - "elem": { - "architecture": { - "name": "architecture", - "type": "TypeString", - "description": "The VCPU architecture.", - "computed": true - }, - "count": { - "name": "count", - "type": "TypeInt", - "description": "The number of VCPUs assigned.", - "computed": true - } - } - }, - { - "name": "provisionable", - "type": "TypeBool", - "description": "Indicates whether this dedicated host is available for instance creation.", - "computed": true - }, - { - "name": "state", - "type": "TypeString", - "description": "The administrative state of the dedicated host.The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the dedicated host on which the unexpected property value was encountered.", - "computed": true - }, - { - "name": "created_at", - "type": "TypeString", - "description": "The date and time that the dedicated host was created.", - "computed": true - }, { "name": "href", "type": "TypeString", @@ -116232,6 +120906,12 @@ "computed": true } } + }, + { + "name": "lifecycle_state", + "type": "TypeString", + "description": "The lifecycle state of the dedicated host resource.", + "computed": true } ], "ibm_is_dedicated_host_disk_management": [ @@ -116265,44 +120945,42 @@ ], "ibm_is_dedicated_host_group": [ { - "name": "resource_type", + "name": "name", "type": "TypeString", - "description": "The type of resource referenced.", + "description": "The unique user-defined name for this dedicated host group. If unspecified, the name will be a hyphenated list of randomly-selected words.", + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", + "optional": true, "computed": true }, { - "name": "zone", + "name": "resource_group", "type": "TypeString", - "description": "The globally unique name of the zone this dedicated host group will reside in.", + "description": "The unique identifier of the resource group to use. If unspecified, the account's [default resourcegroup](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used.", + "cloud_data_type": "resource_group", "immutable": true, - "required": true - }, - { - "name": "crn", - "type": "TypeString", - "description": "The CRN for this dedicated host group.", - "cloud_data_type": "crn", + "optional": true, "computed": true }, { - "name": "href", + "name": "zone", "type": "TypeString", - "description": "The URL for this dedicated host group.", - "computed": true + "description": "The globally unique name of the zone this dedicated host group will reside in.", + "immutable": true, + "required": true }, { - "name": "resource_group", + "name": "created_at", "type": "TypeString", - "description": "The unique identifier of the resource group to use. If unspecified, the account's [default resourcegroup](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used.", - "cloud_data_type": "resource_group", - "immutable": true, - "optional": true, + "description": "The date and time that the dedicated host group was created.", "computed": true }, { - "name": "created_at", + "name": "crn", "type": "TypeString", - "description": "The date and time that the dedicated host group was created.", + "description": "The CRN for this dedicated host group.", + "cloud_data_type": "crn", "computed": true }, { @@ -116357,6 +121035,18 @@ } } }, + { + "name": "href", + "type": "TypeString", + "description": "The URL for this dedicated host group.", + "computed": true + }, + { + "name": "resource_type", + "type": "TypeString", + "description": "The type of resource referenced.", + "computed": true + }, { "name": "supported_instance_profiles", "type": "TypeList", @@ -116391,19 +121081,30 @@ "immutable": true, "required": true, "options": "balanced, compute, memory" - }, + } + ], + "ibm_is_floating_ip": [ { - "name": "name", + "name": "resource_group", "type": "TypeString", - "description": "The unique user-defined name for this dedicated host group. If unspecified, the name will be a hyphenated list of randomly-selected words.", - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", + "description": "Resource group info", + "cloud_data_type": "resource_group", + "immutable": true, "optional": true, "computed": true - } - ], - "ibm_is_floating_ip": [ + }, + { + "name": "resource_crn", + "type": "TypeString", + "description": "The crn of the resource", + "computed": true + }, + { + "name": "status", + "type": "TypeString", + "description": "Floating IP status", + "computed": true + }, { "name": "zone", "type": "TypeString", @@ -116503,28 +121204,34 @@ } }, { - "name": "target", + "name": "resource_name", "type": "TypeString", - "description": "Target info", - "optional": true, + "description": "The name of the resource", "computed": true }, { - "name": "resource_controller_url", + "name": "address", "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", + "description": "Floating IP address", "computed": true }, { - "name": "resource_status", - "type": "TypeString", - "description": "The status of the resource", - "computed": true + "name": "tags", + "type": "TypeSet", + "description": "Floating IP tags", + "min_length": 1, + "max_length": 128, + "matches": "^[A-Za-z0-9:_ .-]+$", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "resource_name", + "name": "resource_controller_url", "type": "TypeString", - "description": "The name of the resource", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", "computed": true }, { @@ -116535,21 +121242,15 @@ "computed": true }, { - "name": "resource_group_name", - "type": "TypeString", - "description": "The resource group name in which resource is provisioned", - "computed": true - }, - { - "name": "resource_crn", + "name": "resource_status", "type": "TypeString", - "description": "The crn of the resource", + "description": "The status of the resource", "computed": true }, { - "name": "address", + "name": "resource_group_name", "type": "TypeString", - "description": "Floating IP address", + "description": "The resource group name in which resource is provisioned", "computed": true }, { @@ -116562,24 +121263,54 @@ "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" }, { - "name": "status", + "name": "target", "type": "TypeString", - "description": "Floating IP status", + "description": "Target info", + "optional": true, "computed": true }, { - "name": "resource_group", + "name": "access_tags", + "type": "TypeSet", + "description": "List of access management tags", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + } + ], + "ibm_is_flow_log": [ + { + "name": "resource_name", "type": "TypeString", - "description": "Resource group info", - "cloud_data_type": "resource_group", + "description": "The name of the resource", + "computed": true + }, + { + "name": "storage_bucket", + "type": "TypeString", + "description": "The Cloud Object Storage bucket name where the collected flows will be logged", "immutable": true, - "optional": true, + "required": true + }, + { + "name": "active", + "type": "TypeBool", + "description": "Indicates whether this collector is active", + "default_value": true, + "optional": true + }, + { + "name": "auto_delete", + "type": "TypeBool", + "description": "If set to true, this flow log collector will be automatically deleted when the target is deleted", "computed": true }, { "name": "tags", "type": "TypeSet", - "description": "Floating IP tags", + "description": "Tags for the VPC Flow logs", "min_length": 1, "max_length": 128, "matches": "^[A-Za-z0-9:_ .-]+$", @@ -116590,23 +121321,10 @@ } }, { - "name": "access_tags", - "type": "TypeSet", - "description": "List of access management tags", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } - } - ], - "ibm_is_flow_log": [ - { - "name": "target", + "name": "resource_group_name", "type": "TypeString", - "description": "The target id that the flow log collector is to collect flow logs", - "immutable": true, - "required": true + "description": "The resource group name in which resource is provisioned", + "computed": true }, { "name": "resource_group", @@ -116618,61 +121336,69 @@ "computed": true }, { - "name": "lifecycle_state", + "name": "created_at", "type": "TypeString", - "description": "The lifecycle state of the flow log collector", + "description": "The date and time flow log was created", "computed": true }, { - "name": "storage_bucket", + "name": "lifecycle_state", "type": "TypeString", - "description": "The Cloud Object Storage bucket name where the collected flows will be logged", - "immutable": true, - "required": true + "description": "The lifecycle state of the flow log collector", + "computed": true }, { - "name": "auto_delete", - "type": "TypeBool", - "description": "If set to true, this flow log collector will be automatically deleted when the target is deleted", + "name": "resource_controller_url", + "type": "TypeString", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", "computed": true }, { - "name": "resource_name", + "name": "href", "type": "TypeString", - "description": "The name of the resource", + "description": "The URL for this flow log collector", "computed": true }, { - "name": "crn", + "name": "vpc", "type": "TypeString", - "description": "The CRN for this flow log collector", - "cloud_data_type": "crn", + "description": "The VPC this flow log collector is associated with", "computed": true }, { - "name": "created_at", + "name": "resource_crn", "type": "TypeString", - "description": "The date and time flow log was created", + "description": "The crn of the resource", "computed": true }, { - "name": "vpc", + "name": "resource_status", "type": "TypeString", - "description": "The VPC this flow log collector is associated with", + "description": "The status of the resource", "computed": true }, { - "name": "tags", - "type": "TypeSet", - "description": "Tags for the VPC Flow logs", + "name": "name", + "type": "TypeString", + "description": "Flow Log Collector name", + "required": true, "min_length": 1, - "max_length": 128, - "matches": "^[A-Za-z0-9:_ .-]+$", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" + }, + { + "name": "target", + "type": "TypeString", + "description": "The target id that the flow log collector is to collect flow logs", + "immutable": true, + "required": true + }, + { + "name": "crn", + "type": "TypeString", + "description": "The CRN for this flow log collector", + "cloud_data_type": "crn", + "computed": true }, { "name": "access_tags", @@ -116683,36 +121409,32 @@ "elem": { "type": "TypeString" } - }, - { - "name": "resource_controller_url", - "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", - "computed": true - }, + } + ], + "ibm_is_ike_policy": [ { - "name": "active", - "type": "TypeBool", - "description": "Indicates whether this collector is active", - "default_value": true, + "name": "ike_version", + "type": "TypeInt", + "description": "IKE version", + "options": "1, 2", "optional": true }, { "name": "href", "type": "TypeString", - "description": "The URL for this flow log collector", + "description": "IKE href value", "computed": true }, { - "name": "resource_crn", + "name": "resource_controller_url", "type": "TypeString", - "description": "The crn of the resource", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", "computed": true }, { - "name": "resource_status", + "name": "resource_name", "type": "TypeString", - "description": "The status of the resource", + "description": "The name of the resource", "computed": true }, { @@ -116722,24 +121444,11 @@ "computed": true }, { - "name": "name", - "type": "TypeString", - "description": "Flow Log Collector name", - "required": true, - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" - } - ], - "ibm_is_ike_policy": [ - { - "name": "name", + "name": "authentication_algorithm", "type": "TypeString", - "description": "IKE name", + "description": "Authentication algorithm type", "required": true, - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" + "options": "md5, sha1, sha256, sha512, sha384" }, { "name": "resource_group", @@ -116751,10 +121460,17 @@ "computed": true }, { - "name": "ike_version", + "name": "dh_group", "type": "TypeInt", - "description": "IKE version", - "options": "1, 2", + "description": "IKE DH group", + "required": true, + "options": "2, 5, 14, 19, 15, 16, 17, 18, 20, 21, 22, 23, 24, 31" + }, + { + "name": "key_lifetime", + "type": "TypeInt", + "description": "IKE Key lifetime", + "default_value": 28800, "optional": true }, { @@ -116786,23 +121502,13 @@ } }, { - "name": "resource_controller_url", - "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", - "computed": true - }, - { - "name": "resource_group_name", - "type": "TypeString", - "description": "The resource group name in which resource is provisioned", - "computed": true - }, - { - "name": "authentication_algorithm", + "name": "name", "type": "TypeString", - "description": "Authentication algorithm type", + "description": "IKE name", "required": true, - "options": "md5, sha1, sha256, sha512, sha384" + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" }, { "name": "encryption_algorithm", @@ -116810,78 +121516,53 @@ "description": "Encryption alogorithm type", "required": true, "options": "triple_des, aes128, aes192, aes256" - }, - { - "name": "dh_group", - "type": "TypeInt", - "description": "IKE DH group", - "required": true, - "options": "2, 5, 14, 19, 15, 16, 17, 18, 20, 21, 22, 23, 24, 31" - }, - { - "name": "key_lifetime", - "type": "TypeInt", - "description": "IKE Key lifetime", - "default_value": 28800, - "optional": true - }, - { - "name": "href", - "type": "TypeString", - "description": "IKE href value", - "computed": true - }, - { - "name": "resource_name", - "type": "TypeString", - "description": "The name of the resource", - "computed": true } ], "ibm_is_image": [ { - "name": "operating_system", + "name": "created_at", "type": "TypeString", - "description": "Image Operating system", - "immutable": true, - "optional": true, - "computed": true - }, - { - "name": "file", - "type": "TypeInt", - "description": "Details for the stored image file", + "description": "The date and time that the image was created", "computed": true }, { - "name": "source_volume", + "name": "deprecation_at", "type": "TypeString", - "description": "Image volume id", - "immutable": true, - "optional": true + "description": "The deprecation date and time (UTC) for this image. If absent, no deprecation date and time has been set.", + "optional": true, + "computed": true }, { - "name": "checksum", + "name": "obsolescence_at", "type": "TypeString", - "description": "The SHA256 checksum of this image", + "description": "The obsolescence date and time (UTC) for this image. If absent, no obsolescence date and time has been set.", + "optional": true, "computed": true }, { - "name": "resource_status", - "type": "TypeString", - "description": "The status of the resource", - "computed": true + "name": "tags", + "type": "TypeSet", + "description": "Tags for the image", + "min_length": 1, + "max_length": 128, + "matches": "^[A-Za-z0-9:_ .-]+$", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "resource_group_name", + "name": "status", "type": "TypeString", - "description": "The resource group name in which resource is provisioned", + "description": "The status of this image", "computed": true }, { - "name": "obsolete", - "type": "TypeBool", - "description": "Set to obsolete. You can set an image to `obsolete` as a warning to transition away from soon-to-be deleted images. You can't use obsolete images to provision resources.", + "name": "encrypted_data_key", + "type": "TypeString", + "description": "A base64-encoded, encrypted representation of the key that was used to encrypt the data for this image", + "immutable": true, "optional": true }, { @@ -116889,25 +121570,20 @@ "type": "TypeString", "description": "The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource", "immutable": true, - "optional": true - }, - { - "name": "tags", - "type": "TypeSet", - "description": "Tags for the image", - "min_length": 1, - "max_length": 128, - "matches": "^[A-Za-z0-9:_ .-]+$", + "optional": true + }, + { + "name": "operating_system", + "type": "TypeString", + "description": "Image Operating system", + "immutable": true, "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "computed": true }, { - "name": "encryption", - "type": "TypeString", - "description": "The type of encryption used on the image", + "name": "file", + "type": "TypeInt", + "description": "Details for the stored image file", "computed": true }, { @@ -116920,52 +121596,53 @@ "computed": true }, { - "name": "resource_name", + "name": "resource_controller_url", "type": "TypeString", - "description": "The name of the resource", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", "computed": true }, { - "name": "access_tags", - "type": "TypeSet", - "description": "List of access management tags", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "resource_crn", + "type": "TypeString", + "description": "The crn of the resource", + "computed": true }, { - "name": "encrypted_data_key", + "name": "crn", "type": "TypeString", - "description": "A base64-encoded, encrypted representation of the key that was used to encrypt the data for this image", - "immutable": true, - "optional": true + "description": "The crn of the resource", + "cloud_data_type": "crn", + "computed": true }, { - "name": "deprecation_at", + "name": "href", "type": "TypeString", - "description": "The deprecation date and time (UTC) for this image. If absent, no deprecation date and time has been set.", + "description": "Image Href value", "optional": true, "computed": true }, { - "name": "visibility", + "name": "checksum", "type": "TypeString", - "description": "Whether the image is publicly visible or private to the account", + "description": "The SHA256 checksum of this image", "computed": true }, { - "name": "resource_controller_url", + "name": "obsolete", + "type": "TypeBool", + "description": "Set to obsolete. You can set an image to `obsolete` as a warning to transition away from soon-to-be deleted images. You can't use obsolete images to provision resources.", + "optional": true + }, + { + "name": "encryption", "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", + "description": "The type of encryption used on the image", "computed": true }, { - "name": "crn", + "name": "resource_status", "type": "TypeString", - "description": "The crn of the resource", - "cloud_data_type": "crn", + "description": "The status of the resource", "computed": true }, { @@ -116975,42 +121652,45 @@ "optional": true }, { - "name": "obsolescence_at", - "type": "TypeString", - "description": "The obsolescence date and time (UTC) for this image. If absent, no obsolescence date and time has been set.", - "optional": true, + "name": "size", + "type": "TypeInt", + "description": "The minimum size (in gigabytes) of a volume onto which this image may be provisioned", "computed": true }, { - "name": "created_at", + "name": "visibility", "type": "TypeString", - "description": "The date and time that the image was created", + "description": "Whether the image is publicly visible or private to the account", "computed": true }, { - "name": "status", + "name": "source_volume", "type": "TypeString", - "description": "The status of this image", - "computed": true + "description": "Image volume id", + "immutable": true, + "optional": true }, { - "name": "size", - "type": "TypeInt", - "description": "The minimum size (in gigabytes) of a volume onto which this image may be provisioned", + "name": "resource_name", + "type": "TypeString", + "description": "The name of the resource", "computed": true }, { - "name": "resource_crn", + "name": "resource_group_name", "type": "TypeString", - "description": "The crn of the resource", + "description": "The resource group name in which resource is provisioned", "computed": true }, { - "name": "href", - "type": "TypeString", - "description": "Image Href value", + "name": "access_tags", + "type": "TypeSet", + "description": "List of access management tags", "optional": true, - "computed": true + "computed": true, + "elem": { + "type": "TypeString" + } }, { "name": "name", @@ -117024,25 +121704,15 @@ ], "ibm_is_image_deprecate": [ { - "name": "href", + "name": "encryption_key", "type": "TypeString", - "description": "Image Href value", + "description": "The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource", "computed": true }, { - "name": "tags", - "type": "TypeSet", - "description": "Tags for the image", - "cloud_data_type": "tags", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "status", + "name": "encryption", "type": "TypeString", - "description": "The status of this image", + "description": "The type of encryption used on the image", "computed": true }, { @@ -117052,33 +121722,28 @@ "computed": true }, { - "name": "deprecation_at", + "name": "crn", "type": "TypeString", - "description": "The deprecation date and time (UTC) for this image. If absent, no deprecation date and time has been set.", + "description": "The crn of the resource", + "cloud_data_type": "crn", "computed": true }, { - "name": "obsolescence_at", + "name": "href", "type": "TypeString", - "description": "The obsolescence date and time (UTC) for this image. If absent, no obsolescence date and time has been set.", + "description": "Image Href value", "computed": true }, { - "name": "encryption", + "name": "encrypted_data_key", "type": "TypeString", - "description": "The type of encryption used on the image", + "description": "A base64-encoded, encrypted representation of the key that was used to encrypt the data for this image", "computed": true }, { - "name": "source_volume", + "name": "created_at", "type": "TypeString", - "description": "Image volume id", - "computed": true - }, - { - "name": "size", - "type": "TypeInt", - "description": "The minimum size (in gigabytes) of a volume onto which this image may be provisioned", + "description": "The date and time that the image was created", "computed": true }, { @@ -117088,23 +121753,20 @@ "computed": true }, { - "name": "crn", - "type": "TypeString", - "description": "The crn of the resource", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "checksum", + "name": "resource_group", "type": "TypeString", - "description": "The SHA256 checksum of this image", + "description": "The resource group for this image", + "cloud_data_type": "resource_group", "computed": true }, { - "name": "name", - "type": "TypeString", - "description": "Image name", - "computed": true + "name": "access_tags", + "type": "TypeSet", + "description": "List of access management tags", + "computed": true, + "elem": { + "type": "TypeString" + } }, { "name": "image", @@ -117114,9 +121776,9 @@ "required": true }, { - "name": "encryption_key", + "name": "deprecation_at", "type": "TypeString", - "description": "The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource", + "description": "The deprecation date and time (UTC) for this image. If absent, no deprecation date and time has been set.", "computed": true }, { @@ -117126,59 +121788,53 @@ "computed": true }, { - "name": "encrypted_data_key", + "name": "status", "type": "TypeString", - "description": "A base64-encoded, encrypted representation of the key that was used to encrypt the data for this image", + "description": "The status of this image", "computed": true }, { - "name": "created_at", - "type": "TypeString", - "description": "The date and time that the image was created", + "name": "size", + "type": "TypeInt", + "description": "The minimum size (in gigabytes) of a volume onto which this image may be provisioned", "computed": true }, { - "name": "resource_group", + "name": "source_volume", "type": "TypeString", - "description": "The resource group for this image", - "cloud_data_type": "resource_group", + "description": "Image volume id", "computed": true }, { - "name": "access_tags", - "type": "TypeSet", - "description": "List of access management tags", - "computed": true, - "elem": { - "type": "TypeString" - } - } - ], - "ibm_is_image_export_job": [ - { - "name": "completed_at", + "name": "checksum", "type": "TypeString", - "description": "The date and time that the image export job was completed.If absent, the export job has not yet completed.", + "description": "The SHA256 checksum of this image", "computed": true }, { - "name": "status", + "name": "name", "type": "TypeString", - "description": "The status of this image export job:- `deleting`: Export job is being deleted- `failed`: Export job could not be completed successfully- `queued`: Export job is queued- `running`: Export job is in progress- `succeeded`: Export job was completed successfullyThe exported image object is automatically deleted for `failed` jobs.", + "description": "Image name", "computed": true }, { - "name": "storage_href", + "name": "obsolescence_at", "type": "TypeString", - "description": "The Cloud Object Storage location of the exported image object. The object at this location may not exist until the job is started, and will be incomplete while the job is running.After the job completes, the exported image object is not managed by the IBM VPC service, and may be removed or replaced with a different object by any user or service with IAM authorization to the bucket.", + "description": "The obsolescence date and time (UTC) for this image. If absent, no obsolescence date and time has been set.", "computed": true }, { - "name": "image_export_job", - "type": "TypeString", - "description": "The unique identifier for this image export job.", - "computed": true - }, + "name": "tags", + "type": "TypeSet", + "description": "Tags for the image", + "cloud_data_type": "tags", + "computed": true, + "elem": { + "type": "TypeString" + } + } + ], + "ibm_is_image_export_job": [ { "name": "image", "type": "TypeString", @@ -117186,6 +121842,42 @@ "immutable": true, "required": true }, + { + "name": "storage_bucket", + "type": "TypeList", + "description": "The name of the Cloud Object Storage bucket to export the image to.", + "immutable": true, + "required": true, + "elem": { + "crn": { + "name": "crn", + "type": "TypeString", + "description": "CRN of this Cloud Object Storage bucket", + "immutable": true, + "optional": true, + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Name of this Cloud Object Storage bucket", + "immutable": true, + "optional": true, + "computed": true + } + }, + "max_items": 1, + "min_items": 1 + }, + { + "name": "format", + "type": "TypeString", + "description": "The format to use for the exported image. If the image is encrypted, only `qcow2` is supported.", + "default_value": "qcow2", + "immutable": true, + "options": "qcow2, vhd", + "optional": true + }, { "name": "created_at", "type": "TypeString", @@ -117199,13 +121891,10 @@ "computed": true }, { - "name": "format", + "name": "status", "type": "TypeString", - "description": "The format to use for the exported image. If the image is encrypted, only `qcow2` is supported.", - "default_value": "qcow2", - "immutable": true, - "options": "qcow2, vhd", - "optional": true + "description": "The status of this image export job:- `deleting`: Export job is being deleted- `failed`: Export job could not be completed successfully- `queued`: Export job is queued- `running`: Export job is in progress- `succeeded`: Export job was completed successfullyThe exported image object is automatically deleted for `failed` jobs.", + "computed": true }, { "name": "encrypted_data_key", @@ -117214,9 +121903,9 @@ "computed": true }, { - "name": "href", + "name": "image_export_job", "type": "TypeString", - "description": "The URL for this image export job.", + "description": "The unique identifier for this image export job.", "computed": true }, { @@ -117251,16 +121940,6 @@ } } }, - { - "name": "name", - "type": "TypeString", - "description": "The user-defined name for this image export job. Names must be unique within the image this export job resides in. If unspecified, the name will be a hyphenated list of randomly-selected words prefixed with the first 16 characters of the parent image name.The exported image object name in Cloud Object Storage (`storage_object.name` in the response) will be based on this name. The object name will be unique within the bucket.", - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$", - "optional": true, - "computed": true - }, { "name": "storage_object", "type": "TypeList", @@ -117275,83 +121954,46 @@ } } }, - { - "name": "storage_bucket", - "type": "TypeList", - "description": "The name of the Cloud Object Storage bucket to export the image to.", - "immutable": true, - "required": true, - "elem": { - "crn": { - "name": "crn", - "type": "TypeString", - "description": "CRN of this Cloud Object Storage bucket", - "immutable": true, - "optional": true, - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Name of this Cloud Object Storage bucket", - "immutable": true, - "optional": true, - "computed": true - } - }, - "max_items": 1, - "min_items": 1 - } - ], - "ibm_is_image_obsolete": [ - { - "name": "crn", - "type": "TypeString", - "description": "The crn of the resource", - "cloud_data_type": "crn", - "computed": true - }, { "name": "name", "type": "TypeString", - "description": "Image name", + "description": "The user-defined name for this image export job. Names must be unique within the image this export job resides in. If unspecified, the name will be a hyphenated list of randomly-selected words prefixed with the first 16 characters of the parent image name.The exported image object name in Cloud Object Storage (`storage_object.name` in the response) will be based on this name. The object name will be unique within the bucket.", + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$", + "optional": true, "computed": true }, { - "name": "encrypted_data_key", + "name": "completed_at", "type": "TypeString", - "description": "A base64-encoded, encrypted representation of the key that was used to encrypt the data for this image", + "description": "The date and time that the image export job was completed.If absent, the export job has not yet completed.", "computed": true }, { - "name": "operating_system", + "name": "href", "type": "TypeString", - "description": "Image Operating system", - "computed": true - }, - { - "name": "size", - "type": "TypeInt", - "description": "The minimum size (in gigabytes) of a volume onto which this image may be provisioned", + "description": "The URL for this image export job.", "computed": true }, { - "name": "file", - "type": "TypeInt", - "description": "Details for the stored image file", + "name": "storage_href", + "type": "TypeString", + "description": "The Cloud Object Storage location of the exported image object. The object at this location may not exist until the job is started, and will be incomplete while the job is running.After the job completes, the exported image object is not managed by the IBM VPC service, and may be removed or replaced with a different object by any user or service with IAM authorization to the bucket.", "computed": true - }, + } + ], + "ibm_is_image_obsolete": [ { - "name": "resource_group", + "name": "visibility", "type": "TypeString", - "description": "The resource group for this image", - "cloud_data_type": "resource_group", + "description": "Whether the image is publicly visible or private to the account", "computed": true }, { - "name": "href", + "name": "name", "type": "TypeString", - "description": "Image Href value", + "description": "Image name", "computed": true }, { @@ -117367,6 +122009,24 @@ "description": "The date and time that the image was created", "computed": true }, + { + "name": "deprecation_at", + "type": "TypeString", + "description": "The deprecation date and time (UTC) for this image. If absent, no deprecation date and time has been set.", + "computed": true + }, + { + "name": "encryption", + "type": "TypeString", + "description": "The type of encryption used on the image", + "computed": true + }, + { + "name": "encryption_key", + "type": "TypeString", + "description": "The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource", + "computed": true + }, { "name": "tags", "type": "TypeSet", @@ -117377,12 +122037,6 @@ "type": "TypeString" } }, - { - "name": "visibility", - "type": "TypeString", - "description": "Whether the image is publicly visible or private to the account", - "computed": true - }, { "name": "access_tags", "type": "TypeSet", @@ -117399,15 +122053,23 @@ "computed": true }, { - "name": "encryption_key", + "name": "size", + "type": "TypeInt", + "description": "The minimum size (in gigabytes) of a volume onto which this image may be provisioned", + "computed": true + }, + { + "name": "resource_group", "type": "TypeString", - "description": "The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource", + "description": "The resource group for this image", + "cloud_data_type": "resource_group", "computed": true }, { - "name": "status", + "name": "crn", "type": "TypeString", - "description": "The status of this image", + "description": "The crn of the resource", + "cloud_data_type": "crn", "computed": true }, { @@ -117417,71 +122079,222 @@ "computed": true }, { - "name": "deprecation_at", + "name": "source_volume", "type": "TypeString", - "description": "The deprecation date and time (UTC) for this image. If absent, no deprecation date and time has been set.", + "description": "Image volume id", "computed": true }, { - "name": "encryption", + "name": "href", "type": "TypeString", - "description": "The type of encryption used on the image", + "description": "Image Href value", "computed": true }, { - "name": "source_volume", + "name": "encrypted_data_key", "type": "TypeString", - "description": "Image volume id", + "description": "A base64-encoded, encrypted representation of the key that was used to encrypt the data for this image", + "computed": true + }, + { + "name": "operating_system", + "type": "TypeString", + "description": "Image Operating system", + "computed": true + }, + { + "name": "status", + "type": "TypeString", + "description": "The status of this image", + "computed": true + }, + { + "name": "file", + "type": "TypeInt", + "description": "Details for the stored image file", "computed": true } ], "ibm_is_instance": [ { - "name": "default_trusted_profile_target", + "name": "resource_group_name", "type": "TypeString", - "description": "The unique identifier or CRN of the default IAM trusted profile to use for this virtual server instance.", + "description": "The resource group name in which resource is provisioned", + "computed": true + }, + { + "name": "zone", + "type": "TypeString", + "description": "Zone name", "immutable": true, + "optional": true, + "computed": true + }, + { + "name": "action", + "type": "TypeString", + "description": "Enables stopping of instance before deleting and waits till deletion is complete", + "options": "stop, start, reboot", "optional": true }, { - "name": "wait_before_delete", + "name": "force_action", "type": "TypeBool", - "description": "Enables stopping of instance before deleting and waits till deletion is complete", - "default_value": true, + "description": "If set to true, the action will be forced immediately, and all queued actions deleted. Ignored for the start action.", + "default_value": false, "optional": true }, { - "name": "status", + "name": "user_data", "type": "TypeString", - "description": "instance status", + "description": "User data given for the instance", + "immutable": true, + "optional": true + }, + { + "name": "memory", + "type": "TypeInt", + "description": "Instance memory", "computed": true }, { - "name": "status_reasons", + "name": "resource_status", + "type": "TypeString", + "description": "The status of the resource", + "computed": true + }, + { + "name": "catalog_offering", "type": "TypeList", - "description": "The reasons for the current status (if any).", + "description": "The catalog offering or offering version to use when provisioning this virtual server instance. If an offering is specified, the latest version of that offering will be used. The specified offering or offering version may be in a different account in the same enterprise, subject to IAM policies.", + "immutable": true, + "optional": true, + "elem": { + "offering_crn": { + "name": "offering_crn", + "type": "TypeString", + "description": "Identifies a catalog offering by a unique CRN property", + "immutable": true, + "optional": true + }, + "version_crn": { + "name": "version_crn", + "type": "TypeString", + "description": "Identifies a version of a catalog offering by a unique CRN property", + "immutable": true, + "optional": true + } + }, + "max_items": 1 + }, + { + "name": "gpu", + "type": "TypeList", + "description": "The virtual server instance GPU configuration", "computed": true, "elem": { - "code": { - "name": "code", + "count": { + "name": "count", + "type": "TypeInt", + "description": "The number of GPUs assigned to the instance", + "computed": true + }, + "manufacturer": { + "name": "manufacturer", "type": "TypeString", - "description": "A snake case string succinctly identifying the status reason", + "description": "The GPU manufacturer", "computed": true }, - "message": { - "name": "message", + "memory": { + "name": "memory", + "type": "TypeInt", + "description": "The overall amount of GPU memory in GiB (gibibytes)", + "computed": true + }, + "model": { + "name": "model", + "type": "TypeString", + "description": "The GPU model", + "computed": true + } + } + }, + { + "name": "availability_policy_host_failure", + "type": "TypeString", + "description": "The availability policy to use for this virtual server instance", + "options": "restart, stop", + "optional": true, + "computed": true + }, + { + "name": "vpc", + "type": "TypeString", + "description": "VPC id", + "immutable": true, + "optional": true, + "computed": true + }, + { + "name": "instance_template", + "type": "TypeString", + "description": "Id of the instance template", + "immutable": true, + "optional": true + }, + { + "name": "dedicated_host_group", + "type": "TypeString", + "description": "Unique Identifier of the Dedicated Host Group where the instance will be placed", + "optional": true + }, + { + "name": "keys", + "type": "TypeSet", + "description": "SSH key Ids for the instance", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "volume_attachments", + "type": "TypeList", + "computed": true, + "elem": { + "id": { + "name": "id", "type": "TypeString", - "description": "An explanation of the status reason", "computed": true }, - "more_info": { - "name": "more_info", + "name": { + "name": "name", + "type": "TypeString", + "computed": true + }, + "volume_crn": { + "name": "volume_crn", + "type": "TypeString", + "computed": true + }, + "volume_id": { + "name": "volume_id", + "type": "TypeString", + "computed": true + }, + "volume_name": { + "name": "volume_name", "type": "TypeString", - "description": "Link to documentation about this status reason", "computed": true } } }, + { + "name": "status", + "type": "TypeString", + "description": "instance status", + "computed": true + }, { "name": "resource_controller_url", "type": "TypeString", @@ -117489,55 +122302,239 @@ "computed": true }, { - "name": "disks", + "name": "profile", + "type": "TypeString", + "description": "Profile info", + "optional": true, + "computed": true + }, + { + "name": "default_trusted_profile_auto_link", + "type": "TypeBool", + "description": "If set to `true`, the system will create a link to the specified `target` trusted profile during instance creation. Regardless of whether a link is created by the system or manually using the IAM Identity service, it will be automatically deleted when the instance is deleted.", + "immutable": true, + "optional": true, + "computed": true + }, + { + "name": "default_trusted_profile_target", + "type": "TypeString", + "description": "The unique identifier or CRN of the default IAM trusted profile to use for this virtual server instance.", + "immutable": true, + "optional": true + }, + { + "name": "placement_group", + "type": "TypeString", + "description": "Unique Identifier of the Placement Group for restricting the placement of the instance", + "immutable": true, + "optional": true + }, + { + "name": "access_tags", + "type": "TypeSet", + "description": "list of access tags for the instance", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "force_recovery_time", + "type": "TypeInt", + "description": "Define timeout to force the instances to start/stop in minutes.", + "optional": true + }, + { + "name": "name", + "type": "TypeString", + "description": "Instance name", + "required": true, + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" + }, + { + "name": "bandwidth", + "type": "TypeInt", + "description": "The total bandwidth (in megabits per second) shared across the instance's network interfaces and storage volumes", + "computed": true + }, + { + "name": "total_network_bandwidth", + "type": "TypeInt", + "description": "The amount of bandwidth (in megabits per second) allocated exclusively to instance network interfaces.", + "computed": true + }, + { + "name": "tags", + "type": "TypeSet", + "description": "list of tags for the instance", + "min_length": 1, + "max_length": 128, + "matches": "^[A-Za-z0-9:_ .-]+$", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "metadata_service", "type": "TypeList", - "description": "Collection of the instance's disks.", + "description": "The metadata service configuration", + "optional": true, "computed": true, "elem": { - "created_at": { - "name": "created_at", - "type": "TypeString", - "description": "The date and time that the disk was created.", + "enabled": { + "name": "enabled", + "type": "TypeBool", + "description": "Indicates whether the metadata service endpoint will be available to the virtual server instance", + "optional": true, "computed": true }, - "href": { - "name": "href", + "protocol": { + "name": "protocol", "type": "TypeString", - "description": "The URL for this instance disk.", + "description": "The communication protocol to use for the metadata service endpoint. Applies only when the metadata service is enabled.", + "optional": true, "computed": true }, - "id": { - "name": "id", + "response_hop_limit": { + "name": "response_hop_limit", + "type": "TypeInt", + "description": "The hop limit (IP time to live) for IP response packets from the metadata service", + "optional": true, + "computed": true + } + }, + "max_items": 1, + "min_items": 1 + }, + { + "name": "resource_name", + "type": "TypeString", + "description": "The name of the resource", + "computed": true + }, + { + "name": "crn", + "type": "TypeString", + "description": "Crn for this Instance", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "total_volume_bandwidth", + "type": "TypeInt", + "description": "The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes", + "min_value": "500", + "optional": true, + "computed": true + }, + { + "name": "metadata_service_enabled", + "type": "TypeBool", + "description": "Indicates whether the metadata service endpoint is available to the virtual server instance", + "optional": true, + "computed": true, + "deprecated": "Use metadata_service instead" + }, + { + "name": "image", + "type": "TypeString", + "description": "image id", + "immutable": true, + "optional": true, + "computed": true + }, + { + "name": "volumes", + "type": "TypeList", + "description": "List of volumes", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "resource_group", + "type": "TypeString", + "description": "Instance resource group", + "cloud_data_type": "resource_group", + "immutable": true, + "optional": true, + "computed": true + }, + { + "name": "status_reasons", + "type": "TypeList", + "description": "The reasons for the current status (if any).", + "computed": true, + "elem": { + "code": { + "name": "code", "type": "TypeString", - "description": "The unique identifier for this instance disk.", + "description": "A snake case string succinctly identifying the status reason", "computed": true }, - "interface_type": { - "name": "interface_type", + "message": { + "name": "message", "type": "TypeString", - "description": "The disk interface used for attaching the disk.The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected property value was encountered.", + "description": "An explanation of the status reason", "computed": true }, - "name": { - "name": "name", + "more_info": { + "name": "more_info", "type": "TypeString", - "description": "The user-defined name for this disk.", + "description": "Link to documentation about this status reason", "computed": true - }, - "resource_type": { - "name": "resource_type", + } + } + }, + { + "name": "dedicated_host", + "type": "TypeString", + "description": "Unique Identifier of the Dedicated Host where the instance will be placed", + "optional": true + }, + { + "name": "wait_before_delete", + "type": "TypeBool", + "description": "Enables stopping of instance before deleting and waits till deletion is complete", + "default_value": true, + "optional": true + }, + { + "name": "vcpu", + "type": "TypeList", + "computed": true, + "elem": { + "architecture": { + "name": "architecture", "type": "TypeString", - "description": "The resource type.", "computed": true }, - "size": { - "name": "size", + "count": { + "name": "count", "type": "TypeInt", - "description": "The size of the disk in GB (gigabytes).", + "computed": true + }, + "manufacturer": { + "name": "manufacturer", + "type": "TypeString", + "description": "The VCPU manufacturer", "computed": true } } }, + { + "name": "resource_crn", + "type": "TypeString", + "description": "The crn of the resource", + "computed": true + }, { "name": "placement_target", "type": "TypeList", @@ -117591,52 +122588,59 @@ } }, { - "name": "crn", - "type": "TypeString", - "description": "Crn for this Instance", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "dedicated_host_group", - "type": "TypeString", - "description": "Unique Identifier of the Dedicated Host Group where the instance will be placed", - "optional": true - }, - { - "name": "force_action", - "type": "TypeBool", - "description": "If set to true, the action will be forced immediately, and all queued actions deleted. Ignored for the start action.", - "default_value": false, - "optional": true - }, - { - "name": "catalog_offering", + "name": "disks", "type": "TypeList", - "description": "The catalog offering or offering version to use when provisioning this virtual server instance. If an offering is specified, the latest version of that offering will be used. The specified offering or offering version may be in a different account in the same enterprise, subject to IAM policies.", - "immutable": true, - "optional": true, + "description": "Collection of the instance's disks.", + "computed": true, "elem": { - "offering_crn": { - "name": "offering_crn", + "created_at": { + "name": "created_at", "type": "TypeString", - "description": "Identifies a catalog offering by a unique CRN property", - "immutable": true, - "optional": true + "description": "The date and time that the disk was created.", + "computed": true }, - "version_crn": { - "name": "version_crn", + "href": { + "name": "href", "type": "TypeString", - "description": "Identifies a version of a catalog offering by a unique CRN property", - "immutable": true, - "optional": true + "description": "The URL for this instance disk.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this instance disk.", + "computed": true + }, + "interface_type": { + "name": "interface_type", + "type": "TypeString", + "description": "The disk interface used for attaching the disk.The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected property value was encountered.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The user-defined name for this disk.", + "computed": true + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true + }, + "size": { + "name": "size", + "type": "TypeInt", + "description": "The size of the disk in GB (gigabytes).", + "computed": true } - }, - "max_items": 1 + } }, { - "name": "network_interfaces", + "name": "primary_network_interface", "type": "TypeList", + "description": "Primary Network interface info", "optional": true, "computed": true, "elem": { @@ -117658,6 +122662,13 @@ "optional": true, "computed": true }, + "port_speed": { + "name": "port_speed", + "type": "TypeInt", + "optional": true, + "computed": true, + "deprecated": "This field is deprected" + }, "primary_ip": { "name": "primary_ip", "type": "TypeList", @@ -117697,6 +122708,7 @@ "name": "reserved_ip", "type": "TypeString", "description": "Identifies a reserved IP by a unique property.", + "immutable": true, "optional": true, "computed": true }, @@ -117732,111 +122744,13 @@ "immutable": true, "required": true } - } - }, - { - "name": "boot_volume", - "type": "TypeList", - "optional": true, - "computed": true, - "elem": { - "auto_delete_volume": { - "name": "auto_delete_volume", - "type": "TypeBool", - "description": "Auto delete boot volume along with instance", - "default_value": true, - "optional": true - }, - "encryption": { - "name": "encryption", - "type": "TypeString", - "optional": true, - "computed": true - }, - "iops": { - "name": "iops", - "type": "TypeInt", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "optional": true, - "computed": true - }, - "profile": { - "name": "profile", - "type": "TypeString", - "computed": true - }, - "size": { - "name": "size", - "type": "TypeInt", - "optional": true, - "computed": true - }, - "snapshot": { - "name": "snapshot", - "type": "TypeString", - "immutable": true, - "optional": true, - "computed": true - }, - "tags": { - "name": "tags", - "type": "TypeSet", - "description": "UserTags for the volume instance", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "volume_id": { - "name": "volume_id", - "type": "TypeString", - "description": "The unique identifier for this volume", - "immutable": true, - "optional": true, - "computed": true - } }, - "max_items": 1 - }, - { - "name": "memory", - "type": "TypeInt", - "description": "Instance memory", - "computed": true - }, - { - "name": "zone", - "type": "TypeString", - "description": "Zone name", - "immutable": true, - "optional": true, - "computed": true - }, - { - "name": "default_trusted_profile_auto_link", - "type": "TypeBool", - "description": "If set to `true`, the system will create a link to the specified `target` trusted profile during instance creation. Regardless of whether a link is created by the system or manually using the IAM Identity service, it will be automatically deleted when the instance is deleted.", - "immutable": true, - "optional": true, - "computed": true - }, - { - "name": "total_volume_bandwidth", - "type": "TypeInt", - "description": "The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes", - "min_value": "500", - "optional": true, - "computed": true + "max_items": 1, + "min_items": 1 }, { - "name": "primary_network_interface", + "name": "network_interfaces", "type": "TypeList", - "description": "Primary Network interface info", "optional": true, "computed": true, "elem": { @@ -117858,13 +122772,6 @@ "optional": true, "computed": true }, - "port_speed": { - "name": "port_speed", - "type": "TypeInt", - "optional": true, - "computed": true, - "deprecated": "This field is deprected" - }, "primary_ip": { "name": "primary_ip", "type": "TypeList", @@ -117904,7 +122811,6 @@ "name": "reserved_ip", "type": "TypeString", "description": "Identifies a reserved IP by a unique property.", - "immutable": true, "optional": true, "computed": true }, @@ -117940,60 +122846,76 @@ "immutable": true, "required": true } - }, - "max_items": 1, - "min_items": 1 - }, - { - "name": "volumes", - "type": "TypeList", - "description": "List of volumes", - "optional": true, - "elem": { - "type": "TypeString" } }, { - "name": "metadata_service", + "name": "boot_volume", "type": "TypeList", - "description": "The metadata service configuration", "optional": true, "computed": true, "elem": { - "enabled": { - "name": "enabled", + "auto_delete_volume": { + "name": "auto_delete_volume", "type": "TypeBool", - "description": "Indicates whether the metadata service endpoint will be available to the virtual server instance", + "description": "Auto delete boot volume along with instance", + "default_value": true, + "optional": true + }, + "encryption": { + "name": "encryption", + "type": "TypeString", "optional": true, "computed": true }, - "protocol": { - "name": "protocol", + "iops": { + "name": "iops", + "type": "TypeInt", + "computed": true + }, + "name": { + "name": "name", "type": "TypeString", - "description": "The communication protocol to use for the metadata service endpoint. Applies only when the metadata service is enabled.", "optional": true, "computed": true }, - "response_hop_limit": { - "name": "response_hop_limit", + "profile": { + "name": "profile", + "type": "TypeString", + "computed": true + }, + "size": { + "name": "size", "type": "TypeInt", - "description": "The hop limit (IP time to live) for IP response packets from the metadata service", + "optional": true, + "computed": true + }, + "snapshot": { + "name": "snapshot", + "type": "TypeString", + "immutable": true, + "optional": true, + "computed": true + }, + "tags": { + "name": "tags", + "type": "TypeSet", + "description": "UserTags for the volume instance", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "volume_id": { + "name": "volume_id", + "type": "TypeString", + "description": "The unique identifier for this volume", + "immutable": true, "optional": true, "computed": true } }, - "max_items": 1, - "min_items": 1 - }, - { - "name": "access_tags", - "type": "TypeSet", - "description": "list of access tags for the instance", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "max_items": 1 }, { "name": "auto_delete_volume", @@ -118002,29 +122924,11 @@ "optional": true }, { - "name": "resource_group", - "type": "TypeString", - "description": "Instance resource group", - "cloud_data_type": "resource_group", - "immutable": true, - "optional": true, - "computed": true - }, - { - "name": "resource_crn", + "name": "lifecycle_state", "type": "TypeString", - "description": "The crn of the resource", + "description": "The lifecycle state of the virtual server instance.", "computed": true }, - { - "name": "name", - "type": "TypeString", - "description": "Instance name", - "required": true, - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" - }, { "name": "lifecycle_reasons", "type": "TypeList", @@ -118050,233 +122954,36 @@ "computed": true } } - }, + } + ], + "ibm_is_instance_action": [ { - "name": "instance_template", + "name": "instance", "type": "TypeString", - "description": "Id of the instance template", + "description": "Instance identifier", "immutable": true, - "optional": true - }, - { - "name": "total_network_bandwidth", - "type": "TypeInt", - "description": "The amount of bandwidth (in megabits per second) allocated exclusively to instance network interfaces.", - "computed": true - }, - { - "name": "keys", - "type": "TypeSet", - "description": "SSH key Ids for the instance", - "optional": true, - "elem": { - "type": "TypeString" - } + "required": true }, { "name": "action", "type": "TypeString", - "description": "Enables stopping of instance before deleting and waits till deletion is complete", - "options": "stop, start, reboot", - "optional": true - }, - { - "name": "volume_attachments", - "type": "TypeList", - "computed": true, - "elem": { - "id": { - "name": "id", - "type": "TypeString", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "computed": true - }, - "volume_crn": { - "name": "volume_crn", - "type": "TypeString", - "computed": true - }, - "volume_id": { - "name": "volume_id", - "type": "TypeString", - "computed": true - }, - "volume_name": { - "name": "volume_name", - "type": "TypeString", - "computed": true - } - } - }, - { - "name": "image", - "type": "TypeString", - "description": "image id", - "immutable": true, - "optional": true, - "computed": true - }, - { - "name": "resource_name", - "type": "TypeString", - "description": "The name of the resource", - "computed": true - }, - { - "name": "resource_status", - "type": "TypeString", - "description": "The status of the resource", - "computed": true - }, - { - "name": "resource_group_name", - "type": "TypeString", - "description": "The resource group name in which resource is provisioned", - "computed": true - }, - { - "name": "profile", - "type": "TypeString", - "description": "Profile info", - "optional": true, - "computed": true - }, - { - "name": "user_data", - "type": "TypeString", - "description": "User data given for the instance", - "immutable": true, - "optional": true - }, - { - "name": "gpu", - "type": "TypeList", - "description": "The virtual server instance GPU configuration", - "computed": true, - "elem": { - "count": { - "name": "count", - "type": "TypeInt", - "description": "The number of GPUs assigned to the instance", - "computed": true - }, - "manufacturer": { - "name": "manufacturer", - "type": "TypeString", - "description": "The GPU manufacturer", - "computed": true - }, - "memory": { - "name": "memory", - "type": "TypeInt", - "description": "The overall amount of GPU memory in GiB (gibibytes)", - "computed": true - }, - "model": { - "name": "model", - "type": "TypeString", - "description": "The GPU model", - "computed": true - } - } - }, - { - "name": "force_recovery_time", - "type": "TypeInt", - "description": "Define timeout to force the instances to start/stop in minutes.", - "optional": true - }, - { - "name": "availability_policy_host_failure", - "type": "TypeString", - "description": "The availability policy to use for this virtual server instance", - "options": "restart, stop", - "optional": true, - "computed": true - }, - { - "name": "vpc", - "type": "TypeString", - "description": "VPC id", - "immutable": true, - "optional": true, - "computed": true - }, - { - "name": "dedicated_host", - "type": "TypeString", - "description": "Unique Identifier of the Dedicated Host where the instance will be placed", - "optional": true + "description": "This restart/start/stops an instance.", + "required": true, + "options": "start, reboot, stop" }, { - "name": "placement_group", - "type": "TypeString", - "description": "Unique Identifier of the Placement Group for restricting the placement of the instance", - "immutable": true, + "name": "force_action", + "type": "TypeBool", + "description": "If set to true, the action will be forced immediately, and all queued actions deleted. Ignored for the start action.", + "default_value": false, "optional": true }, { - "name": "bandwidth", - "type": "TypeInt", - "description": "The total bandwidth (in megabits per second) shared across the instance's network interfaces and storage volumes", - "computed": true - }, - { - "name": "tags", - "type": "TypeSet", - "description": "list of tags for the instance", - "min_length": 1, - "max_length": 128, - "matches": "^[A-Za-z0-9:_ .-]+$", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "vcpu", - "type": "TypeList", - "computed": true, - "elem": { - "architecture": { - "name": "architecture", - "type": "TypeString", - "computed": true - }, - "count": { - "name": "count", - "type": "TypeInt", - "computed": true - }, - "manufacturer": { - "name": "manufacturer", - "type": "TypeString", - "description": "The VCPU manufacturer", - "computed": true - } - } - }, - { - "name": "lifecycle_state", + "name": "status", "type": "TypeString", - "description": "The lifecycle state of the virtual server instance.", + "description": "Instance status", "computed": true }, - { - "name": "metadata_service_enabled", - "type": "TypeBool", - "description": "Indicates whether the metadata service endpoint is available to the virtual server instance", - "optional": true, - "computed": true, - "deprecated": "Use metadata_service instead" - } - ], - "ibm_is_instance_action": [ { "name": "status_reasons", "type": "TypeList", @@ -118301,33 +123008,6 @@ "computed": true } } - }, - { - "name": "instance", - "type": "TypeString", - "description": "Instance identifier", - "immutable": true, - "required": true - }, - { - "name": "action", - "type": "TypeString", - "description": "This restart/start/stops an instance.", - "required": true, - "options": "start, reboot, stop" - }, - { - "name": "force_action", - "type": "TypeBool", - "description": "If set to true, the action will be forced immediately, and all queued actions deleted. Ignored for the start action.", - "default_value": false, - "optional": true - }, - { - "name": "status", - "type": "TypeString", - "description": "Instance status", - "computed": true } ], "ibm_is_instance_disk_management": [ @@ -118361,34 +123041,24 @@ ], "ibm_is_instance_group": [ { - "name": "name", - "type": "TypeString", - "description": "The user-defined name for this instance group", - "required": true, - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" - }, - { - "name": "instance_count", + "name": "application_port", "type": "TypeInt", - "description": "The number of instances in the instance group", - "default_value": 0, - "min_value": "0", - "max_value": "1000", + "description": "Used by the instance group when scaling up instances to supply the port for the load balancer pool member.", + "min_value": "1", + "max_value": "65535", "optional": true }, { - "name": "crn", + "name": "instance_template", "type": "TypeString", - "description": "The CRN of this instance group", - "cloud_data_type": "crn", - "computed": true + "description": "instance template ID", + "required": true }, { - "name": "status", + "name": "crn", "type": "TypeString", - "description": "Instance group status - deleting, healthy, scaling, unhealthy", + "description": "The CRN of this instance group", + "cloud_data_type": "crn", "computed": true }, { @@ -118400,23 +123070,6 @@ "type": "TypeString" } }, - { - "name": "application_port", - "type": "TypeInt", - "description": "Used by the instance group when scaling up instances to supply the port for the load balancer pool member.", - "min_value": "1", - "max_value": "65535", - "optional": true - }, - { - "name": "managers", - "type": "TypeList", - "description": "list of Managers associated with instancegroup", - "computed": true, - "elem": { - "type": "TypeString" - } - }, { "name": "vpc", "type": "TypeString", @@ -118424,20 +123077,28 @@ "computed": true }, { - "name": "access_tags", - "type": "TypeSet", - "description": "List of access management tags", - "optional": true, + "name": "name", + "type": "TypeString", + "description": "The user-defined name for this instance group", + "required": true, + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" + }, + { + "name": "managers", + "type": "TypeList", + "description": "list of Managers associated with instancegroup", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "instance_template", - "type": "TypeString", - "description": "instance template ID", - "required": true + "name": "instances", + "type": "TypeInt", + "description": "number of instances in the intances group", + "computed": true }, { "name": "resource_group", @@ -118447,12 +123108,6 @@ "optional": true, "computed": true }, - { - "name": "load_balancer", - "type": "TypeString", - "description": "load balancer ID", - "optional": true - }, { "name": "load_balancer_pool", "type": "TypeString", @@ -118473,68 +123128,38 @@ } }, { - "name": "instances", - "type": "TypeInt", - "description": "number of instances in the intances group", - "computed": true - } - ], - "ibm_is_instance_group_manager": [ - { - "name": "enable_manager", - "type": "TypeBool", - "description": "enable instance group manager", - "default_value": true, - "optional": true - }, - { - "name": "manager_type", - "type": "TypeString", - "description": "The type of instance group manager.", - "default_value": "autoscale", - "immutable": true, - "options": "autoscale, scheduled", - "optional": true + "name": "access_tags", + "type": "TypeSet", + "description": "List of access management tags", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "aggregation_window", + "name": "instance_count", "type": "TypeInt", - "description": "The time window in seconds to aggregate metrics prior to evaluation", - "default_value": 90, - "min_value": "90", - "max_value": "600", + "description": "The number of instances in the instance group", + "default_value": 0, + "min_value": "0", + "max_value": "1000", "optional": true }, { - "name": "max_membership_count", - "type": "TypeInt", - "description": "The maximum number of members in a managed instance group", - "min_value": "1", - "max_value": "1000", + "name": "load_balancer", + "type": "TypeString", + "description": "load balancer ID", "optional": true }, { - "name": "actions", - "type": "TypeList", - "computed": true, - "elem": { - "instance_group_manager_action": { - "name": "instance_group_manager_action", - "type": "TypeString", - "computed": true - }, - "instance_group_manager_action_name": { - "name": "instance_group_manager_action_name", - "type": "TypeString", - "computed": true - }, - "resource_type": { - "name": "resource_type", - "type": "TypeString", - "computed": true - } - } - }, + "name": "status", + "type": "TypeString", + "description": "Instance group status - deleting, healthy, scaling, unhealthy", + "computed": true + } + ], + "ibm_is_instance_group_manager": [ { "name": "name", "type": "TypeString", @@ -118545,10 +123170,13 @@ "optional": true }, { - "name": "instance_group", - "type": "TypeString", - "description": "instance group ID", - "required": true + "name": "aggregation_window", + "type": "TypeInt", + "description": "The time window in seconds to aggregate metrics prior to evaluation", + "default_value": 90, + "min_value": "90", + "max_value": "600", + "optional": true }, { "name": "cooldown", @@ -118559,6 +123187,14 @@ "max_value": "3600", "optional": true }, + { + "name": "max_membership_count", + "type": "TypeInt", + "description": "The maximum number of members in a managed instance group", + "min_value": "1", + "max_value": "1000", + "optional": true + }, { "name": "min_membership_count", "type": "TypeInt", @@ -118574,6 +123210,28 @@ "description": "instance group manager ID", "computed": true }, + { + "name": "enable_manager", + "type": "TypeBool", + "description": "enable instance group manager", + "default_value": true, + "optional": true + }, + { + "name": "instance_group", + "type": "TypeString", + "description": "instance group ID", + "required": true + }, + { + "name": "manager_type", + "type": "TypeString", + "description": "The type of instance group manager.", + "default_value": "autoscale", + "immutable": true, + "options": "autoscale, scheduled", + "optional": true + }, { "name": "policies", "type": "TypeList", @@ -118582,48 +123240,66 @@ "elem": { "type": "TypeString" } + }, + { + "name": "actions", + "type": "TypeList", + "computed": true, + "elem": { + "instance_group_manager_action": { + "name": "instance_group_manager_action", + "type": "TypeString", + "computed": true + }, + "instance_group_manager_action_name": { + "name": "instance_group_manager_action_name", + "type": "TypeString", + "computed": true + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "computed": true + } + } } ], "ibm_is_instance_group_manager_action": [ { - "name": "action_id", + "name": "updated_at", "type": "TypeString", - "description": "Instance group manager action ID", + "description": "The date and time that the instance group manager action was modified.", "computed": true }, { - "name": "membership_count", - "type": "TypeInt", - "description": "The number of members the instance group should have at the scheduled time.", - "min_value": "0", - "max_value": "100", - "optional": true + "name": "action_type", + "type": "TypeString", + "description": "The type of action for the instance group.", + "computed": true }, { - "name": "target_manager", + "name": "last_applied_at", "type": "TypeString", - "description": "The unique identifier for this instance group manager of type autoscale.", - "optional": true + "description": "The date and time the scheduled action was last applied. If empty the action has never been applied.", + "computed": true }, { - "name": "updated_at", + "name": "next_run_at", "type": "TypeString", - "description": "The date and time that the instance group manager action was modified.", + "description": "The date and time the scheduled action will next run. If empty the system is currently calculating the next run time.", "computed": true }, { - "name": "auto_delete", - "type": "TypeBool", + "name": "action_id", + "type": "TypeString", + "description": "Instance group manager action ID", "computed": true }, { - "name": "name", + "name": "instance_group", "type": "TypeString", - "description": "instance group manager action name", - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$", - "optional": true + "description": "instance group ID", + "required": true }, { "name": "cron_spec", @@ -118635,56 +123311,50 @@ "optional": true }, { - "name": "min_membership_count", + "name": "max_membership_count", "type": "TypeInt", - "description": "The minimum number of members in a managed instance group", - "default_value": 1, + "description": "The maximum number of members in a managed instance group", "min_value": "1", "max_value": "1000", "optional": true }, { - "name": "target_manager_name", - "type": "TypeString", - "description": "Instance group manager name of type autoscale.", + "name": "auto_delete_timeout", + "type": "TypeInt", "computed": true }, { - "name": "max_membership_count", - "type": "TypeInt", - "description": "The maximum number of members in a managed instance group", - "min_value": "1", - "max_value": "1000", + "name": "run_at", + "type": "TypeString", + "description": "The date and time the scheduled action will run.", "optional": true }, { - "name": "action_type", + "name": "target_manager", "type": "TypeString", - "description": "The type of action for the instance group.", - "computed": true + "description": "The unique identifier for this instance group manager of type autoscale.", + "optional": true }, { - "name": "last_applied_at", + "name": "resource_type", "type": "TypeString", - "description": "The date and time the scheduled action was last applied. If empty the action has never been applied.", + "description": "The resource type.", "computed": true }, { - "name": "next_run_at", + "name": "status", "type": "TypeString", - "description": "The date and time the scheduled action will next run. If empty the system is currently calculating the next run time.", - "computed": true - }, - { - "name": "auto_delete_timeout", - "type": "TypeInt", + "description": "The status of the instance group action- `active`: Action is ready to be run- `completed`: Action was completed successfully- `failed`: Action could not be completed successfully- `incompatible`: Action parameters are not compatible with the group or manager- `omitted`: Action was not applied because this action's manager was disabled.", "computed": true }, { - "name": "instance_group", + "name": "name", "type": "TypeString", - "description": "instance group ID", - "required": true + "description": "instance group manager action name", + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$", + "optional": true }, { "name": "instance_group_manager", @@ -118693,50 +123363,41 @@ "required": true }, { - "name": "run_at", - "type": "TypeString", - "description": "The date and time the scheduled action will run.", + "name": "membership_count", + "type": "TypeInt", + "description": "The number of members the instance group should have at the scheduled time.", + "min_value": "0", + "max_value": "100", "optional": true }, { - "name": "resource_type", + "name": "created_at", "type": "TypeString", - "description": "The resource type.", + "description": "The date and time that the instance group manager action was modified.", "computed": true }, { - "name": "status", + "name": "min_membership_count", + "type": "TypeInt", + "description": "The minimum number of members in a managed instance group", + "default_value": 1, + "min_value": "1", + "max_value": "1000", + "optional": true + }, + { + "name": "target_manager_name", "type": "TypeString", - "description": "The status of the instance group action- `active`: Action is ready to be run- `completed`: Action was completed successfully- `failed`: Action could not be completed successfully- `incompatible`: Action parameters are not compatible with the group or manager- `omitted`: Action was not applied because this action's manager was disabled.", + "description": "Instance group manager name of type autoscale.", "computed": true }, { - "name": "created_at", - "type": "TypeString", - "description": "The date and time that the instance group manager action was modified.", + "name": "auto_delete", + "type": "TypeBool", "computed": true } ], "ibm_is_instance_group_manager_policy": [ - { - "name": "instance_group_manager", - "type": "TypeString", - "description": "Instance group manager ID", - "required": true - }, - { - "name": "metric_type", - "type": "TypeString", - "description": "The type of metric to be evaluated", - "required": true, - "options": "cpu,memory,network_in,network_out" - }, - { - "name": "metric_value", - "type": "TypeInt", - "description": "The metric value to be evaluated", - "required": true - }, { "name": "policy_type", "type": "TypeString", @@ -118764,33 +123425,52 @@ "type": "TypeString", "description": "instance group ID", "required": true + }, + { + "name": "instance_group_manager", + "type": "TypeString", + "description": "Instance group manager ID", + "required": true + }, + { + "name": "metric_type", + "type": "TypeString", + "description": "The type of metric to be evaluated", + "required": true, + "options": "cpu,memory,network_in,network_out" + }, + { + "name": "metric_value", + "type": "TypeInt", + "description": "The metric value to be evaluated", + "required": true } ], "ibm_is_instance_group_membership": [ { - "name": "instance", - "type": "TypeList", - "computed": true, - "elem": { - "crn": { - "name": "crn", - "type": "TypeString", - "description": "The CRN for this virtual server instance.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "The user-defined name for this virtual server instance (and default system hostname).", - "computed": true - }, - "virtual_server_instance": { - "name": "virtual_server_instance", - "type": "TypeString", - "description": "The unique identifier for this virtual server instance.", - "computed": true - } - } + "name": "instance_group", + "type": "TypeString", + "description": "The instance group identifier.", + "immutable": true, + "required": true, + "min_length": 1, + "max_length": 64, + "matches": "^[-0-9a-z_]+$" + }, + { + "name": "name", + "type": "TypeString", + "description": "The user-defined name for this instance group membership. Names must be unique within the instance group.", + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", + "optional": true + }, + { + "name": "delete_instance_on_membership_delete", + "type": "TypeBool", + "description": "If set to true, when deleting the membership the instance will also be deleted.", + "computed": true }, { "name": "instance_template", @@ -118817,50 +123497,6 @@ } } }, - { - "name": "status", - "type": "TypeString", - "description": "The status of the instance group membership- `deleting`: Membership is deleting dependent resources- `failed`: Membership was unable to maintain dependent resources- `healthy`: Membership is active and serving in the group- `pending`: Membership is waiting for dependent resources- `unhealthy`: Membership has unhealthy dependent resources.", - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "The user-defined name for this instance group membership. Names must be unique within the instance group.", - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", - "optional": true - }, - { - "name": "action_delete", - "type": "TypeBool", - "description": "The delete flag for this instance group membership. Must be set to true to delete instance group membership.", - "default_value": false, - "optional": true - }, - { - "name": "delete_instance_on_membership_delete", - "type": "TypeBool", - "description": "If set to true, when deleting the membership the instance will also be deleted.", - "computed": true - }, - { - "name": "load_balancer_pool_member", - "type": "TypeString", - "description": "The unique identifier for this load balancer pool member.", - "computed": true - }, - { - "name": "instance_group", - "type": "TypeString", - "description": "The instance group identifier.", - "immutable": true, - "required": true, - "min_length": 1, - "max_length": 64, - "matches": "^[-0-9a-z_]+$" - }, { "name": "instance_group_membership", "type": "TypeString", @@ -118869,86 +123505,57 @@ "min_length": 1, "max_length": 64, "matches": "^[-0-9a-z_]+$" - } - ], - "ibm_is_instance_network_interface": [ - { - "name": "name", - "type": "TypeString", - "description": "The user-defined name for this network interface. If unspecified, the name will be a hyphenated list of randomly-selected words.", - "required": true, - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" }, { - "name": "created_at", - "type": "TypeString", - "description": "The date and time that the network interface was created.", - "computed": true + "name": "action_delete", + "type": "TypeBool", + "description": "The delete flag for this instance group membership. Must be set to true to delete instance group membership.", + "default_value": false, + "optional": true }, { - "name": "floating_ips", + "name": "instance", "type": "TypeList", - "description": "The floating IPs associated with this network interface.", "computed": true, "elem": { - "address": { - "name": "address", - "type": "TypeString", - "description": "The globally unique IP address.", - "computed": true - }, "crn": { "name": "crn", "type": "TypeString", - "description": "The CRN for this floating IP.", + "description": "The CRN for this virtual server instance.", "computed": true }, - "deleted": { - "name": "deleted", - "type": "TypeList", - "description": "If present, this property indicates the referenced resource has been deleted and providessome supplementary information.", - "computed": true, - "elem": { - "more_info": { - "name": "more_info", - "type": "TypeString", - "description": "Link to documentation about deleted resources.", - "computed": true - } - } - }, - "href": { - "name": "href", + "name": { + "name": "name", "type": "TypeString", - "description": "The URL for this floating IP.", + "description": "The user-defined name for this virtual server instance (and default system hostname).", "computed": true }, - "id": { - "name": "id", - "type": "TypeString", - "description": "The unique identifier for this floating IP.", - "optional": true - }, - "name": { - "name": "name", + "virtual_server_instance": { + "name": "virtual_server_instance", "type": "TypeString", - "description": "The unique user-defined name for this floating IP.", + "description": "The unique identifier for this virtual server instance.", "computed": true } } }, { - "name": "resource_type", + "name": "load_balancer_pool_member", "type": "TypeString", - "description": "The resource type.", + "description": "The unique identifier for this load balancer pool member.", "computed": true }, { - "name": "instance", + "name": "status", "type": "TypeString", - "description": "The unique identifier of the instance.", + "description": "The status of the instance group membership- `deleting`: Membership is deleting dependent resources- `failed`: Membership was unable to maintain dependent resources- `healthy`: Membership is active and serving in the group- `pending`: Membership is waiting for dependent resources- `unhealthy`: Membership has unhealthy dependent resources.", + "computed": true + } + ], + "ibm_is_instance_network_interface": [ + { + "name": "subnet", + "type": "TypeString", + "description": "The unique identifier of the subnet.", "immutable": true, "required": true }, @@ -118963,19 +123570,16 @@ "deprecated": "primary_ipv4_address is deprecated and support will be removed. Use primary_ip instead" }, { - "name": "security_groups", - "type": "TypeSet", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "created_at", + "type": "TypeString", + "description": "The date and time that the network interface was created.", + "computed": true }, { - "name": "port_speed", - "type": "TypeInt", - "description": "The network interface port speed in Mbps.", - "computed": true + "name": "floating_ip", + "type": "TypeString", + "description": "The ID of the floating IP to attach to this network interface", + "optional": true }, { "name": "status", @@ -118984,9 +123588,9 @@ "computed": true }, { - "name": "type", - "type": "TypeString", - "description": "The type of this network interface as it relates to an instance.", + "name": "port_speed", + "type": "TypeInt", + "description": "The network interface port speed in Mbps.", "computed": true }, { @@ -119038,33 +123642,109 @@ "optional": true, "computed": true }, - "resource_type": { - "name": "resource_type", + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type", + "computed": true + } + }, + "max_items": 1 + }, + { + "name": "security_groups", + "type": "TypeSet", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "type", + "type": "TypeString", + "description": "The type of this network interface as it relates to an instance.", + "computed": true + }, + { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true + }, + { + "name": "instance", + "type": "TypeString", + "description": "The unique identifier of the instance.", + "immutable": true, + "required": true + }, + { + "name": "name", + "type": "TypeString", + "description": "The user-defined name for this network interface. If unspecified, the name will be a hyphenated list of randomly-selected words.", + "required": true, + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" + }, + { + "name": "network_interface", + "type": "TypeString", + "description": "The globally unique ID of this network interface", + "computed": true + }, + { + "name": "floating_ips", + "type": "TypeList", + "description": "The floating IPs associated with this network interface.", + "computed": true, + "elem": { + "address": { + "name": "address", + "type": "TypeString", + "description": "The globally unique IP address.", + "computed": true + }, + "crn": { + "name": "crn", + "type": "TypeString", + "description": "The CRN for this floating IP.", + "computed": true + }, + "deleted": { + "name": "deleted", + "type": "TypeList", + "description": "If present, this property indicates the referenced resource has been deleted and providessome supplementary information.", + "computed": true, + "elem": { + "more_info": { + "name": "more_info", + "type": "TypeString", + "description": "Link to documentation about deleted resources.", + "computed": true + } + } + }, + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this floating IP.", + "computed": true + }, + "id": { + "name": "id", "type": "TypeString", - "description": "The resource type", + "description": "The unique identifier for this floating IP.", + "optional": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The unique user-defined name for this floating IP.", "computed": true } - }, - "max_items": 1 - }, - { - "name": "network_interface", - "type": "TypeString", - "description": "The globally unique ID of this network interface", - "computed": true - }, - { - "name": "floating_ip", - "type": "TypeString", - "description": "The ID of the floating IP to attach to this network interface", - "optional": true - }, - { - "name": "subnet", - "type": "TypeString", - "description": "The unique identifier of the subnet.", - "immutable": true, - "required": true + } }, { "name": "href", @@ -119074,6 +123754,13 @@ } ], "ibm_is_instance_network_interface_floating_ip": [ + { + "name": "instance", + "type": "TypeString", + "description": "Instance identifier", + "immutable": true, + "required": true + }, { "name": "floating_ip", "type": "TypeString", @@ -119081,24 +123768,23 @@ "required": true }, { - "name": "status", + "name": "zone", "type": "TypeString", - "description": "Floating IP status", + "description": "Zone name", "computed": true }, { - "name": "crn", + "name": "target", "type": "TypeString", - "description": "Floating IP crn", - "cloud_data_type": "crn", + "description": "Target info", "computed": true }, { - "name": "instance", + "name": "crn", "type": "TypeString", - "description": "Instance identifier", - "immutable": true, - "required": true + "description": "Floating IP crn", + "cloud_data_type": "crn", + "computed": true }, { "name": "network_interface", @@ -119119,54 +123805,73 @@ "description": "Floating IP address", "computed": true }, + { + "name": "status", + "type": "TypeString", + "description": "Floating IP status", + "computed": true + } + ], + "ibm_is_instance_template": [ + { + "name": "crn", + "type": "TypeString", + "description": "The CRN for the instance", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "Instance Template name", + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", + "optional": true + }, { "name": "zone", "type": "TypeString", "description": "Zone name", + "immutable": true, + "required": true + }, + { + "name": "default_trusted_profile_auto_link", + "type": "TypeBool", + "description": "If set to `true`, the system will create a link to the specified `target` trusted profile during instance creation. Regardless of whether a link is created by the system or manually using the IAM Identity service, it will be automatically deleted when the instance is deleted.", + "immutable": true, + "optional": true, "computed": true }, { - "name": "target", + "name": "default_trusted_profile_target", "type": "TypeString", - "description": "Target info", - "computed": true - } - ], - "ibm_is_instance_template": [ + "description": "The unique identifier or CRN of the default IAM trusted profile to use for this virtual server instance.", + "immutable": true, + "optional": true + }, { - "name": "metadata_service", - "type": "TypeList", - "description": "The metadata service configuration", - "optional": true, - "computed": true, - "elem": { - "enabled": { - "name": "enabled", - "type": "TypeBool", - "description": "Indicates whether the metadata service endpoint will be available to the virtual server instance", - "immutable": true, - "optional": true, - "computed": true - }, - "protocol": { - "name": "protocol", - "type": "TypeString", - "description": "The communication protocol to use for the metadata service endpoint. Applies only when the metadata service is enabled.", - "immutable": true, - "optional": true, - "computed": true - }, - "response_hop_limit": { - "name": "response_hop_limit", - "type": "TypeInt", - "description": "The hop limit (IP time to live) for IP response packets from the metadata service", - "immutable": true, - "optional": true, - "computed": true - } - }, - "max_items": 1, - "min_items": 1 + "name": "dedicated_host", + "type": "TypeString", + "description": "Unique Identifier of the Dedicated Host where the instance will be placed", + "immutable": true, + "optional": true + }, + { + "name": "dedicated_host_group", + "type": "TypeString", + "description": "Unique Identifier of the Dedicated Host Group where the instance will be placed", + "immutable": true, + "optional": true + }, + { + "name": "total_volume_bandwidth", + "type": "TypeInt", + "description": "The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes", + "immutable": true, + "min_value": "500", + "optional": true }, { "name": "catalog_offering", @@ -119193,50 +123898,36 @@ "max_items": 1 }, { - "name": "resource_group", - "type": "TypeString", - "description": "Instance template resource group", - "cloud_data_type": "resource_group", - "immutable": true, - "optional": true, - "computed": true - }, - { - "name": "zone", + "name": "image", "type": "TypeString", - "description": "Zone name", + "description": "image name", "immutable": true, - "required": true + "optional": true }, { - "name": "profile", + "name": "resource_group", "type": "TypeString", - "description": "Profile info", - "immutable": true, - "required": true - }, - { - "name": "default_trusted_profile_auto_link", - "type": "TypeBool", - "description": "If set to `true`, the system will create a link to the specified `target` trusted profile during instance creation. Regardless of whether a link is created by the system or manually using the IAM Identity service, it will be automatically deleted when the instance is deleted.", + "description": "Instance template resource group", + "cloud_data_type": "resource_group", "immutable": true, "optional": true, "computed": true }, { - "name": "default_trusted_profile_target", + "name": "vpc", "type": "TypeString", - "description": "The unique identifier or CRN of the default IAM trusted profile to use for this virtual server instance.", + "description": "VPC id", "immutable": true, - "optional": true + "required": true }, { - "name": "total_volume_bandwidth", - "type": "TypeInt", - "description": "The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes", - "immutable": true, - "min_value": "500", - "optional": true + "name": "keys", + "type": "TypeSet", + "description": "SSH key Ids for the instance template", + "required": true, + "elem": { + "type": "TypeString" + } }, { "name": "primary_network_interface", @@ -119408,43 +124099,58 @@ } }, { - "name": "crn", - "type": "TypeString", - "description": "The CRN for the instance", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "image", + "name": "user_data", "type": "TypeString", - "description": "image name", + "description": "User data given for the instance", "immutable": true, "optional": true }, { - "name": "availability_policy_host_failure", - "type": "TypeString", - "description": "The availability policy to use for this virtual server instance", - "immutable": true, - "options": "restart, stop", + "name": "boot_volume", + "type": "TypeList", "optional": true, - "computed": true - }, - { - "name": "keys", - "type": "TypeSet", - "description": "SSH key Ids for the instance template", - "required": true, + "computed": true, "elem": { - "type": "TypeString" - } - }, - { - "name": "user_data", - "type": "TypeString", - "description": "User data given for the instance", - "immutable": true, - "optional": true + "delete_volume_on_instance_delete": { + "name": "delete_volume_on_instance_delete", + "type": "TypeBool", + "optional": true, + "computed": true + }, + "encryption": { + "name": "encryption", + "type": "TypeString", + "optional": true, + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "optional": true, + "computed": true + }, + "profile": { + "name": "profile", + "type": "TypeString", + "computed": true + }, + "size": { + "name": "size", + "type": "TypeInt", + "computed": true + }, + "tags": { + "name": "tags", + "type": "TypeSet", + "description": "UserTags for the volume instance", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + } + }, + "max_items": 1 }, { "name": "placement_target", @@ -119473,13 +124179,13 @@ } }, { - "name": "name", + "name": "availability_policy_host_failure", "type": "TypeString", - "description": "Instance Template name", - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", - "optional": true + "description": "The availability policy to use for this virtual server instance", + "immutable": true, + "options": "restart, stop", + "optional": true, + "computed": true }, { "name": "metadata_service_enabled", @@ -119491,25 +124197,46 @@ "deprecated": "Use metadata_service instead" }, { - "name": "vpc", - "type": "TypeString", - "description": "VPC id", - "immutable": true, - "required": true - }, - { - "name": "dedicated_host", - "type": "TypeString", - "description": "Unique Identifier of the Dedicated Host where the instance will be placed", - "immutable": true, - "optional": true + "name": "metadata_service", + "type": "TypeList", + "description": "The metadata service configuration", + "optional": true, + "computed": true, + "elem": { + "enabled": { + "name": "enabled", + "type": "TypeBool", + "description": "Indicates whether the metadata service endpoint will be available to the virtual server instance", + "immutable": true, + "optional": true, + "computed": true + }, + "protocol": { + "name": "protocol", + "type": "TypeString", + "description": "The communication protocol to use for the metadata service endpoint. Applies only when the metadata service is enabled.", + "immutable": true, + "optional": true, + "computed": true + }, + "response_hop_limit": { + "name": "response_hop_limit", + "type": "TypeInt", + "description": "The hop limit (IP time to live) for IP response packets from the metadata service", + "immutable": true, + "optional": true, + "computed": true + } + }, + "max_items": 1, + "min_items": 1 }, { - "name": "dedicated_host_group", + "name": "profile", "type": "TypeString", - "description": "Unique Identifier of the Dedicated Host Group where the instance will be placed", + "description": "Profile info", "immutable": true, - "optional": true + "required": true }, { "name": "placement_group", @@ -119592,72 +124319,39 @@ "min_items": 1 } } - }, - { - "name": "boot_volume", - "type": "TypeList", - "optional": true, - "computed": true, - "elem": { - "delete_volume_on_instance_delete": { - "name": "delete_volume_on_instance_delete", - "type": "TypeBool", - "optional": true, - "computed": true - }, - "encryption": { - "name": "encryption", - "type": "TypeString", - "optional": true, - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "optional": true, - "computed": true - }, - "profile": { - "name": "profile", - "type": "TypeString", - "computed": true - }, - "size": { - "name": "size", - "type": "TypeInt", - "computed": true - }, - "tags": { - "name": "tags", - "type": "TypeSet", - "description": "UserTags for the volume instance", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } - } - }, - "max_items": 1 } ], "ibm_is_instance_volume_attachment": [ { - "name": "type", + "name": "device", "type": "TypeString", - "description": "The type of volume attachment one of [ boot, data ]", + "description": "A unique identifier for the device which is exposed to the instance operating system", "computed": true }, { - "name": "volume_attachment_id", + "name": "href", "type": "TypeString", - "description": "The unique identifier for this volume attachment", + "description": "The URL for this volume attachment", "computed": true }, { - "name": "name", + "name": "delete_volume_on_instance_delete", + "type": "TypeBool", + "description": "If set to true, when deleting the instance the volume will also be deleted.", + "optional": true, + "computed": true + }, + { + "name": "delete_volume_on_attachment_delete", + "type": "TypeBool", + "description": "If set to true, when deleting the attachment, the volume will also be deleted. Default value for this true.", + "default_value": true, + "optional": true + }, + { + "name": "volume_name", "type": "TypeString", - "description": "The user-defined name for this volume attachment.", + "description": "The unique user-defined name for this volume", "min_length": 1, "max_length": 63, "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", @@ -119665,23 +124359,23 @@ "computed": true }, { - "name": "volume", + "name": "profile", "type": "TypeString", - "description": "Instance id", - "immutable": true, + "description": "The globally unique name for the volume profile to use for this volume.", + "options": "general-purpose, 5iops-tier, 10iops-tier, custom", "optional": true, "computed": true }, { - "name": "volume_deleted", + "name": "volume_crn", "type": "TypeString", - "description": "Link to documentation about deleted resources", + "description": "The CRN for this volume", "computed": true }, { - "name": "status", + "name": "volume_href", "type": "TypeString", - "description": "The status of this volume attachment, one of [ attached, attaching, deleting, detaching ]", + "description": "The URL for this volume", "computed": true }, { @@ -119690,30 +124384,17 @@ "computed": true }, { - "name": "delete_volume_on_attachment_delete", - "type": "TypeBool", - "description": "If set to true, when deleting the attachment, the volume will also be deleted. Default value for this true.", - "default_value": true, - "optional": true - }, - { - "name": "tags", - "type": "TypeSet", - "description": "UserTags for the volume instance", - "min_length": 1, - "max_length": 128, - "matches": "^[A-Za-z0-9:_ .-]+$", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "instance", + "type": "TypeString", + "description": "Instance id", + "immutable": true, + "required": true }, { - "name": "profile", + "name": "volume", "type": "TypeString", - "description": "The globally unique name for the volume profile to use for this volume.", - "options": "general-purpose, 5iops-tier, 10iops-tier, custom", + "description": "Instance id", + "immutable": true, "optional": true, "computed": true }, @@ -119726,50 +124407,51 @@ "computed": true }, { - "name": "href", + "name": "status", "type": "TypeString", - "description": "The URL for this volume attachment", + "description": "The status of this volume attachment, one of [ attached, attaching, deleting, detaching ]", "computed": true }, { - "name": "volume_name", + "name": "type", "type": "TypeString", - "description": "The unique user-defined name for this volume", - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", - "optional": true, + "description": "The type of volume attachment one of [ boot, data ]", "computed": true }, { - "name": "volume_crn", - "type": "TypeString", - "description": "The CRN for this volume", - "computed": true + "name": "tags", + "type": "TypeSet", + "description": "UserTags for the volume instance", + "min_length": 1, + "max_length": 128, + "matches": "^[A-Za-z0-9:_ .-]+$", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "device", + "name": "encryption_key", "type": "TypeString", - "description": "A unique identifier for the device which is exposed to the instance operating system", + "description": "The CRN of the [Key Protect Root Key](https://cloud.ibm.com/docs/key-protect?topic=key-protect-getting-started-tutorial) or [Hyper Protect Crypto Service Root Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started) for this resource.", + "immutable": true, + "optional": true, "computed": true }, { - "name": "volume_href", + "name": "volume_attachment_id", "type": "TypeString", - "description": "The URL for this volume", + "description": "The unique identifier for this volume attachment", "computed": true }, { - "name": "instance", + "name": "name", "type": "TypeString", - "description": "Instance id", - "immutable": true, - "required": true - }, - { - "name": "delete_volume_on_instance_delete", - "type": "TypeBool", - "description": "If set to true, when deleting the instance the volume will also be deleted.", + "description": "The user-defined name for this volume attachment.", + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", "optional": true, "computed": true }, @@ -119790,32 +124472,41 @@ "computed": true }, { - "name": "encryption_key", + "name": "volume_deleted", "type": "TypeString", - "description": "The CRN of the [Key Protect Root Key](https://cloud.ibm.com/docs/key-protect?topic=key-protect-getting-started-tutorial) or [Hyper Protect Crypto Service Root Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started) for this resource.", - "immutable": true, - "optional": true, + "description": "Link to documentation about deleted resources", "computed": true } ], "ibm_is_ipsec_policy": [ { - "name": "resource_name", + "name": "resource_crn", "type": "TypeString", - "description": "The name of the resource", + "description": "The crn of the resource", "computed": true }, { - "name": "resource_crn", + "name": "name", "type": "TypeString", - "description": "The crn of the resource", - "computed": true + "description": "IPSEC name", + "required": true, + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" }, { - "name": "resource_group_name", + "name": "encryption_algorithm", "type": "TypeString", - "description": "The resource group name in which resource is provisioned", - "computed": true + "description": "Encryption algorithm", + "required": true, + "options": "triple_des, aes128, aes256, aes128gcm16, aes192gcm16, aes256gcm16" + }, + { + "name": "pfs", + "type": "TypeString", + "description": "PFS info", + "required": true, + "options": "disabled, group_2, group_5, group_14, group_19, group_15, group_16, group_17, group_18, group_20, group_21, group_22, group_23, group_24, group_31" }, { "name": "resource_group", @@ -119827,25 +124518,29 @@ "computed": true }, { - "name": "authentication_algorithm", + "name": "transform_protocol", "type": "TypeString", - "description": "Authentication alorothm", - "required": true, - "options": "md5, sha1, sha256, sha512, sha384, disabled" + "description": "IPSEC transform protocol", + "computed": true }, { - "name": "encryption_algorithm", + "name": "resource_name", "type": "TypeString", - "description": "Encryption algorithm", - "required": true, - "options": "triple_des, aes128, aes256, aes128gcm16, aes192gcm16, aes256gcm16" + "description": "The name of the resource", + "computed": true }, { - "name": "pfs", + "name": "resource_group_name", "type": "TypeString", - "description": "PFS info", + "description": "The resource group name in which resource is provisioned", + "computed": true + }, + { + "name": "authentication_algorithm", + "type": "TypeString", + "description": "Authentication alorothm", "required": true, - "options": "disabled, group_2, group_5, group_14, group_19, group_15, group_16, group_17, group_18, group_20, group_21, group_22, group_23, group_24, group_31" + "options": "md5, sha1, sha256, sha512, sha384, disabled" }, { "name": "key_lifetime", @@ -119860,12 +124555,6 @@ "description": "IPSEC encapsulation mode", "computed": true }, - { - "name": "transform_protocol", - "type": "TypeString", - "description": "IPSEC transform protocol", - "computed": true - }, { "name": "vpn_connections", "type": "TypeList", @@ -119888,15 +124577,6 @@ } } }, - { - "name": "name", - "type": "TypeString", - "description": "IPSEC name", - "required": true, - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" - }, { "name": "resource_controller_url", "type": "TypeString", @@ -119906,20 +124586,12 @@ ], "ibm_is_lb": [ { - "name": "name", - "type": "TypeString", - "description": "Load Balancer name", - "required": true, - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" - }, - { - "name": "crn", - "type": "TypeString", - "description": "The CRN for this Load Balancer", - "cloud_data_type": "crn", - "computed": true + "name": "private_ips", + "type": "TypeList", + "computed": true, + "elem": { + "type": "TypeString" + } }, { "name": "subnets", @@ -119933,16 +124605,9 @@ "min_items": 1 }, { - "name": "resource_group", - "type": "TypeString", - "cloud_data_type": "resource_group", - "immutable": true, - "optional": true, - "computed": true - }, - { - "name": "hostname", - "type": "TypeString", + "name": "udp_supported", + "type": "TypeBool", + "description": "Indicates whether this load balancer supports UDP.", "computed": true }, { @@ -119952,16 +124617,36 @@ "computed": true }, { - "name": "type", + "name": "dns", + "type": "TypeList", + "description": "The DNS configuration for this load balancer.", + "optional": true, + "elem": { + "instance_crn": { + "name": "instance_crn", + "type": "TypeString", + "description": "The CRN for this DNS instance", + "required": true + }, + "zone_id": { + "name": "zone_id", + "type": "TypeString", + "description": "The unique identifier of the DNS zone.", + "required": true + } + }, + "max_items": 1, + "min_items": 1 + }, + { + "name": "crn", "type": "TypeString", - "description": "Load Balancer type", - "default_value": "public", - "immutable": true, - "options": "public, private", - "optional": true + "description": "The CRN for this Load Balancer", + "cloud_data_type": "crn", + "computed": true }, { - "name": "private_ips", + "name": "public_ips", "type": "TypeList", "computed": true, "elem": { @@ -120006,12 +124691,6 @@ } } }, - { - "name": "security_group_supported", - "type": "TypeBool", - "description": "Security Group Supported for this Load Balancer", - "computed": true - }, { "name": "route_mode", "type": "TypeBool", @@ -120021,37 +124700,34 @@ "optional": true }, { - "name": "resource_name", + "name": "hostname", "type": "TypeString", - "description": "The name of the resource", "computed": true }, { - "name": "dns", - "type": "TypeList", - "description": "The DNS configuration for this load balancer.", - "optional": true, - "elem": { - "instance_crn": { - "name": "instance_crn", - "type": "TypeString", - "description": "The CRN for this DNS instance", - "required": true - }, - "zone_id": { - "name": "zone_id", - "type": "TypeString", - "description": "The unique identifier of the DNS zone.", - "required": true - } - }, - "max_items": 1, - "min_items": 1 + "name": "logging", + "type": "TypeBool", + "description": "Logging of Load Balancer", + "default_value": false, + "optional": true }, { - "name": "status", + "name": "name", "type": "TypeString", - "computed": true + "description": "Load Balancer name", + "required": true, + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" + }, + { + "name": "type", + "type": "TypeString", + "description": "Load Balancer type", + "default_value": "public", + "immutable": true, + "options": "public, private", + "optional": true }, { "name": "operating_status", @@ -120069,29 +124745,40 @@ } }, { - "name": "access_tags", - "type": "TypeSet", - "description": "List of access management tags", + "name": "resource_group", + "type": "TypeString", + "cloud_data_type": "resource_group", + "immutable": true, "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "computed": true }, { - "name": "logging", - "type": "TypeBool", - "description": "Logging of Load Balancer", - "default_value": false, - "optional": true + "name": "resource_group_name", + "type": "TypeString", + "description": "The resource group name in which resource is provisioned", + "computed": true }, { - "name": "public_ips", - "type": "TypeList", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "version", + "type": "TypeString", + "computed": true + }, + { + "name": "resource_name", + "type": "TypeString", + "description": "The name of the resource", + "computed": true + }, + { + "name": "status", + "type": "TypeString", + "computed": true + }, + { + "name": "security_group_supported", + "type": "TypeBool", + "description": "Security Group Supported for this Load Balancer", + "computed": true }, { "name": "profile", @@ -120115,43 +124802,33 @@ } }, { - "name": "udp_supported", - "type": "TypeBool", - "description": "Indicates whether this load balancer supports UDP.", - "computed": true - }, - { - "name": "resource_group_name", - "type": "TypeString", - "description": "The resource group name in which resource is provisioned", - "computed": true - }, - { - "name": "version", - "type": "TypeString", - "computed": true + "name": "access_tags", + "type": "TypeSet", + "description": "List of access management tags", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } } ], "ibm_is_lb_listener": [ { - "name": "lb", + "name": "certificate_instance", "type": "TypeString", - "description": "Loadbalancer listener ID", - "immutable": true, - "required": true + "description": "certificate instance for the Loadbalancer", + "optional": true }, { - "name": "port", - "type": "TypeInt", - "description": "Loadbalancer listener port", - "optional": true, - "computed": true + "name": "https_redirect_uri", + "type": "TypeString", + "description": "Target URI where traffic will be redirected", + "optional": true }, { - "name": "connection_limit", - "type": "TypeInt", - "description": "Connection limit for Loadbalancer", - "optional": true + "name": "listener_id", + "type": "TypeString", + "computed": true }, { "name": "port_min", @@ -120168,11 +124845,17 @@ "computed": true }, { - "name": "accept_proxy_protocol", - "type": "TypeBool", - "description": "Listener will forward proxy protocol", - "optional": true, - "computed": true + "name": "protocol", + "type": "TypeString", + "description": "Loadbalancer protocol", + "required": true, + "options": "https, http, tcp, udp" + }, + { + "name": "https_redirect_status_code", + "type": "TypeInt", + "description": "The HTTP status code to be returned in the redirect response", + "optional": true }, { "name": "https_redirect_listener", @@ -120187,22 +124870,33 @@ "computed": true }, { - "name": "certificate_instance", - "type": "TypeString", - "description": "certificate instance for the Loadbalancer", - "optional": true + "name": "idle_connection_timeout", + "type": "TypeInt", + "description": "idle connection timeout of listener", + "min_value": "50", + "max_value": "7200", + "optional": true, + "computed": true }, { - "name": "https_redirect_status_code", + "name": "port", "type": "TypeInt", - "description": "The HTTP status code to be returned in the redirect response", - "optional": true + "description": "Loadbalancer listener port", + "optional": true, + "computed": true }, { - "name": "https_redirect_uri", + "name": "accept_proxy_protocol", + "type": "TypeBool", + "description": "Listener will forward proxy protocol", + "optional": true, + "computed": true + }, + { + "name": "status", "type": "TypeString", - "description": "Target URI where traffic will be redirected", - "optional": true + "description": "Loadbalancer listener status", + "computed": true }, { "name": "default_pool", @@ -120212,34 +124906,49 @@ "computed": true }, { - "name": "idle_connection_timeout", + "name": "lb", + "type": "TypeString", + "description": "Loadbalancer listener ID", + "immutable": true, + "required": true + }, + { + "name": "connection_limit", "type": "TypeInt", - "description": "idle connection timeout of listener", - "min_value": "50", - "max_value": "7200", - "optional": true, - "computed": true + "description": "Connection limit for Loadbalancer", + "optional": true + } + ], + "ibm_is_lb_listener_policy": [ + { + "name": "listener", + "type": "TypeString", + "description": "Listener ID", + "immutable": true, + "required": true }, { - "name": "protocol", + "name": "target_https_redirect_listener", "type": "TypeString", - "description": "Loadbalancer protocol", - "required": true, - "options": "https, http, tcp, udp" + "description": "ID of the listener that will be set as http redirect target", + "optional": true }, { - "name": "status", + "name": "related_crn", "type": "TypeString", - "description": "Loadbalancer listener status", + "description": "The crn of the LB resource", "computed": true }, { - "name": "listener_id", + "name": "name", "type": "TypeString", + "description": "Policy name", + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", + "optional": true, "computed": true - } - ], - "ibm_is_lb_listener_policy": [ + }, { "name": "rules", "type": "TypeList", @@ -120279,59 +124988,30 @@ } } }, - { - "name": "target_http_status_code", - "type": "TypeInt", - "description": "Listener Policy target HTTPS Status code.", - "optional": true - }, { "name": "provisioning_status", "type": "TypeString", "description": "Listner Policy status", "computed": true }, - { - "name": "related_crn", - "type": "TypeString", - "description": "The crn of the LB resource", - "computed": true - }, - { - "name": "listener", - "type": "TypeString", - "description": "Listener ID", - "immutable": true, - "required": true - }, { "name": "target_https_redirect_uri", "type": "TypeString", "description": "Target URI where traffic will be redirected", "optional": true }, - { - "name": "target_https_redirect_listener", - "type": "TypeString", - "description": "ID of the listener that will be set as http redirect target", - "optional": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Policy name", - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", - "optional": true, - "computed": true - }, { "name": "policy_id", "type": "TypeString", "description": "Listener Policy ID", "computed": true }, + { + "name": "target_http_status_code", + "type": "TypeInt", + "description": "Listener Policy target HTTPS Status code.", + "optional": true + }, { "name": "target_id", "type": "TypeString", @@ -120344,6 +125024,13 @@ "description": "Policy Target URL", "optional": true }, + { + "name": "lb", + "type": "TypeString", + "description": "Load Balancer Listener Policy", + "immutable": true, + "required": true + }, { "name": "target_https_redirect_status_code", "type": "TypeInt", @@ -120363,20 +125050,13 @@ "type": "TypeInt", "description": "Listener Policy Priority", "required": true - }, - { - "name": "lb", - "type": "TypeString", - "description": "Load Balancer Listener Policy", - "immutable": true, - "required": true } ], "ibm_is_lb_listener_policy_rule": [ { - "name": "listener", + "name": "lb", "type": "TypeString", - "description": "Listener ID.", + "description": "Loadbalancer ID", "immutable": true, "required": true }, @@ -120388,20 +125068,16 @@ "required": true }, { - "name": "condition", + "name": "type", "type": "TypeString", - "description": "Condition info of the rule.", + "description": "Policy rule type.", "required": true, - "options": "contains, equals, matches_regex" - }, - { - "name": "field", - "type": "TypeString", - "optional": true + "options": "header, hostname, path, body, query" }, { - "name": "rule", + "name": "related_crn", "type": "TypeString", + "description": "The crn of the LB resource", "computed": true }, { @@ -120410,17 +125086,18 @@ "computed": true }, { - "name": "related_crn", + "name": "listener", "type": "TypeString", - "description": "The crn of the LB resource", - "computed": true + "description": "Listener ID.", + "immutable": true, + "required": true }, { - "name": "lb", + "name": "condition", "type": "TypeString", - "description": "Loadbalancer ID", - "immutable": true, - "required": true + "description": "Condition info of the rule.", + "required": true, + "options": "contains, equals, matches_regex" }, { "name": "value", @@ -120429,20 +125106,22 @@ "required": true }, { - "name": "type", + "name": "field", "type": "TypeString", - "description": "Policy rule type.", - "required": true, - "options": "header, hostname, path, body, query" + "optional": true + }, + { + "name": "rule", + "type": "TypeString", + "computed": true } ], "ibm_is_lb_pool": [ { - "name": "algorithm", + "name": "pool_id", "type": "TypeString", - "description": "Load Balancer Pool algorithm", - "required": true, - "options": "round_robin, weighted_round_robin, least_connections" + "description": "The LB Pool id", + "computed": true }, { "name": "protocol", @@ -120452,16 +125131,26 @@ "options": "http, tcp, https, udp" }, { - "name": "pool_id", + "name": "health_delay", + "type": "TypeInt", + "description": "Load Blancer health delay time period", + "required": true + }, + { + "name": "health_monitor_url", "type": "TypeString", - "description": "The LB Pool id", + "description": "Health monitor URL of LB Pool", + "optional": true, "computed": true }, { - "name": "related_crn", + "name": "session_persistence_app_cookie_name", "type": "TypeString", - "description": "The crn of the LB resource", - "computed": true + "description": "Load Balancer Pool session persisence app cookie name.", + "min_length": 1, + "max_length": 63, + "matches": "^[-A-Za-z0-9!#$%\u0026'*+.^_`~|]+$", + "optional": true }, { "name": "name", @@ -120472,6 +125161,12 @@ "max_length": 63, "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" }, + { + "name": "health_timeout", + "type": "TypeInt", + "description": "Load Balancer health timeout interval", + "required": true + }, { "name": "health_type", "type": "TypeString", @@ -120483,43 +125178,28 @@ "name": "health_monitor_port", "type": "TypeInt", "description": "Health monitor Port the LB Pool", - "optional": true, - "computed": true - }, - { - "name": "session_persistence_http_cookie_name", - "type": "TypeString", - "description": "Load Balancer Pool session persisence http cookie name.", + "optional": true, "computed": true }, { - "name": "proxy_protocol", + "name": "provisioning_status", "type": "TypeString", - "description": "PROXY protocol setting for this pool", - "options": "disabled, v1, v2", - "optional": true, + "description": "Status of the LB Pool", "computed": true }, { - "name": "lb", + "name": "algorithm", "type": "TypeString", - "description": "Load Balancer ID", - "immutable": true, - "required": true + "description": "Load Balancer Pool algorithm", + "required": true, + "options": "round_robin, weighted_round_robin, least_connections" }, { - "name": "health_delay", + "name": "health_retries", "type": "TypeInt", - "description": "Load Blancer health delay time period", + "description": "Load Balancer health retry count", "required": true }, - { - "name": "health_monitor_url", - "type": "TypeString", - "description": "Health monitor URL of LB Pool", - "optional": true, - "computed": true - }, { "name": "session_persistence_type", "type": "TypeString", @@ -120528,39 +125208,40 @@ "optional": true }, { - "name": "health_retries", - "type": "TypeInt", - "description": "Load Balancer health retry count", - "required": true + "name": "session_persistence_http_cookie_name", + "type": "TypeString", + "description": "Load Balancer Pool session persisence http cookie name.", + "computed": true }, { - "name": "health_timeout", - "type": "TypeInt", - "description": "Load Balancer health timeout interval", - "required": true + "name": "proxy_protocol", + "type": "TypeString", + "description": "PROXY protocol setting for this pool", + "options": "disabled, v1, v2", + "optional": true, + "computed": true }, { - "name": "session_persistence_app_cookie_name", + "name": "related_crn", "type": "TypeString", - "description": "Load Balancer Pool session persisence app cookie name.", - "min_length": 1, - "max_length": 63, - "matches": "^[-A-Za-z0-9!#$%\u0026'*+.^_`~|]+$", - "optional": true + "description": "The crn of the LB resource", + "computed": true }, { - "name": "provisioning_status", + "name": "lb", "type": "TypeString", - "description": "Status of the LB Pool", - "computed": true + "description": "Load Balancer ID", + "immutable": true, + "required": true } ], "ibm_is_lb_pool_member": [ { - "name": "health", + "name": "lb", "type": "TypeString", - "description": "LB Pool member health", - "computed": true + "description": "Load balancer ID", + "immutable": true, + "required": true }, { "name": "port", @@ -120568,6 +125249,20 @@ "description": "Load Balancer Pool port", "required": true }, + { + "name": "target_address", + "type": "TypeString", + "description": "Load balancer pool member target address", + "optional": true, + "computed": true + }, + { + "name": "pool", + "type": "TypeString", + "description": "Loadblancer Poold ID", + "immutable": true, + "required": true + }, { "name": "target_id", "type": "TypeString", @@ -120590,6 +125285,12 @@ "description": "Load balancer Pool member provisioning status", "computed": true }, + { + "name": "health", + "type": "TypeString", + "description": "LB Pool member health", + "computed": true + }, { "name": "href", "type": "TypeString", @@ -120601,30 +125302,36 @@ "type": "TypeString", "description": "The crn of the LB resource", "computed": true - }, + } + ], + "ibm_is_network_acl": [ { - "name": "pool", + "name": "crn", "type": "TypeString", - "description": "Loadblancer Poold ID", - "immutable": true, - "required": true + "description": "The crn of the resource", + "cloud_data_type": "crn", + "computed": true }, { - "name": "lb", + "name": "name", "type": "TypeString", - "description": "Load balancer ID", - "immutable": true, - "required": true + "description": "Network ACL name", + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", + "optional": true, + "computed": true }, { - "name": "target_address", - "type": "TypeString", - "description": "Load balancer pool member target address", + "name": "access_tags", + "type": "TypeSet", + "description": "List of access management tags", "optional": true, - "computed": true - } - ], - "ibm_is_network_acl": [ + "computed": true, + "elem": { + "type": "TypeString" + } + }, { "name": "tags", "type": "TypeSet", @@ -120651,41 +125358,15 @@ "computed": true }, { - "name": "resource_group_name", - "type": "TypeString", - "description": "The resource group name in which resource is provisioned", - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "Network ACL name", - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", - "optional": true, - "computed": true - }, - { - "name": "resource_group", - "type": "TypeString", - "description": "Resource group ID for the network ACL", - "cloud_data_type": "resource_group", - "immutable": true, - "optional": true, - "computed": true - }, - { - "name": "crn", + "name": "resource_crn", "type": "TypeString", "description": "The crn of the resource", - "cloud_data_type": "crn", "computed": true }, { - "name": "resource_crn", + "name": "resource_group_name", "type": "TypeString", - "description": "The crn of the resource", + "description": "The resource group name in which resource is provisioned", "computed": true }, { @@ -120827,23 +125508,16 @@ "optional": true }, { - "name": "access_tags", - "type": "TypeSet", - "description": "List of access management tags", + "name": "resource_group", + "type": "TypeString", + "description": "Resource group ID for the network ACL", + "cloud_data_type": "resource_group", + "immutable": true, "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "computed": true } ], "ibm_is_network_acl_rule": [ - { - "name": "protocol", - "type": "TypeString", - "description": "The protocol of the rule.", - "computed": true - }, { "name": "action", "type": "TypeString", @@ -120852,45 +125526,9 @@ "options": "allow, deny" }, { - "name": "icmp", - "type": "TypeList", - "immutable": true, - "optional": true, - "elem": { - "code": { - "name": "code", - "type": "TypeInt", - "description": "The ICMP traffic code to allow. Valid values from 0 to 255.", - "optional": true - }, - "type": { - "name": "type", - "type": "TypeInt", - "description": "The ICMP traffic type to allow. Valid values from 0 to 254.", - "optional": true - } - }, - "max_items": 1 - }, - { - "name": "rule_id", - "type": "TypeString", - "description": "The network acl rule id.", - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "The user-defined name for this rule. Names must be unique within the network ACL the rule resides in. If unspecified, the name will be a hyphenated list of randomly-selected words.", - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", - "optional": true - }, - { - "name": "source", + "name": "destination", "type": "TypeString", - "description": "The source CIDR block. The CIDR block 0.0.0.0/0 applies to all addresses.", + "description": "The destination CIDR block. The CIDR block 0.0.0.0/0 applies to all addresses.", "required": true }, { @@ -120901,30 +125539,7 @@ "options": "inbound, outbound" }, { - "name": "network_acl", - "type": "TypeString", - "description": "Network ACL id", - "immutable": true, - "required": true, - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" - }, - { - "name": "before", - "type": "TypeString", - "description": "The rule that this rule is immediately before. If absent, this is the last rule.", - "optional": true, - "computed": true - }, - { - "name": "href", - "type": "TypeString", - "description": "The url of the rule.", - "computed": true - }, - { - "name": "udp", + "name": "tcp", "type": "TypeList", "immutable": true, "optional": true, @@ -120961,19 +125576,7 @@ "max_items": 1 }, { - "name": "ip_version", - "type": "TypeString", - "description": "The IP version for this rule.", - "computed": true - }, - { - "name": "destination", - "type": "TypeString", - "description": "The destination CIDR block. The CIDR block 0.0.0.0/0 applies to all addresses.", - "required": true - }, - { - "name": "tcp", + "name": "udp", "type": "TypeList", "immutable": true, "optional": true, @@ -121008,40 +125611,119 @@ } }, "max_items": 1 - } - ], - "ibm_is_placement_group": [ + }, { - "name": "resource_type", + "name": "protocol", "type": "TypeString", - "description": "The resource type.", + "description": "The protocol of the rule.", "computed": true }, { - "name": "strategy", + "name": "name", "type": "TypeString", - "description": "The strategy for this placement group- `host_spread`: place on different compute hosts- `power_spread`: place on compute hosts that use different power sourcesThe enumerated values for this property may expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the placement group on which the unexpected strategy was encountered.", + "description": "The user-defined name for this rule. Names must be unique within the network ACL the rule resides in. If unspecified, the name will be a hyphenated list of randomly-selected words.", + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", + "optional": true + }, + { + "name": "icmp", + "type": "TypeList", "immutable": true, - "required": true, - "options": "host_spread, power_spread" + "optional": true, + "elem": { + "code": { + "name": "code", + "type": "TypeInt", + "description": "The ICMP traffic code to allow. Valid values from 0 to 255.", + "optional": true + }, + "type": { + "name": "type", + "type": "TypeInt", + "description": "The ICMP traffic type to allow. Valid values from 0 to 254.", + "optional": true + } + }, + "max_items": 1 }, { - "name": "name", + "name": "network_acl", "type": "TypeString", - "description": "The unique user-defined name for this placement group. If unspecified, the name will be a hyphenated list of randomly-selected words.", + "description": "Network ACL id", + "immutable": true, "required": true, "min_length": 1, "max_length": 63, "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" }, { - "name": "resource_group", + "name": "source", "type": "TypeString", - "description": "The unique identifier of the resource group to use. If unspecified, the account's [default resourcegroup](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used.", - "cloud_data_type": "resource_group", - "immutable": true, + "description": "The source CIDR block. The CIDR block 0.0.0.0/0 applies to all addresses.", + "required": true + }, + { + "name": "href", + "type": "TypeString", + "description": "The url of the rule.", + "computed": true + }, + { + "name": "ip_version", + "type": "TypeString", + "description": "The IP version for this rule.", + "computed": true + }, + { + "name": "rule_id", + "type": "TypeString", + "description": "The network acl rule id.", + "computed": true + }, + { + "name": "before", + "type": "TypeString", + "description": "The rule that this rule is immediately before. If absent, this is the last rule.", "optional": true, "computed": true + } + ], + "ibm_is_placement_group": [ + { + "name": "created_at", + "type": "TypeString", + "description": "The date and time that the placement group was created.", + "computed": true + }, + { + "name": "crn", + "type": "TypeString", + "description": "The CRN for this placement group.", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "href", + "type": "TypeString", + "description": "The URL for this placement group.", + "computed": true + }, + { + "name": "lifecycle_state", + "type": "TypeString", + "description": "The lifecycle state of the placement group.", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "The unique user-defined name for this placement group. If unspecified, the name will be a hyphenated list of randomly-selected words.", + "required": true, + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" }, { "name": "tags", @@ -121056,12 +125738,6 @@ "type": "TypeString" } }, - { - "name": "href", - "type": "TypeString", - "description": "The URL for this placement group.", - "computed": true - }, { "name": "access_tags", "type": "TypeSet", @@ -121076,39 +125752,30 @@ } }, { - "name": "created_at", + "name": "strategy", "type": "TypeString", - "description": "The date and time that the placement group was created.", - "computed": true + "description": "The strategy for this placement group- `host_spread`: place on different compute hosts- `power_spread`: place on compute hosts that use different power sourcesThe enumerated values for this property may expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the placement group on which the unexpected strategy was encountered.", + "immutable": true, + "required": true, + "options": "host_spread, power_spread" }, { - "name": "crn", + "name": "resource_group", "type": "TypeString", - "description": "The CRN for this placement group.", - "cloud_data_type": "crn", + "description": "The unique identifier of the resource group to use. If unspecified, the account's [default resourcegroup](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used.", + "cloud_data_type": "resource_group", + "immutable": true, + "optional": true, "computed": true }, { - "name": "lifecycle_state", + "name": "resource_type", "type": "TypeString", - "description": "The lifecycle state of the placement group.", + "description": "The resource type.", "computed": true } ], "ibm_is_public_gateway": [ - { - "name": "floating_ip", - "type": "TypeMap", - "optional": true, - "computed": true - }, - { - "name": "vpc", - "type": "TypeString", - "description": "Public gateway VPC info", - "immutable": true, - "required": true - }, { "name": "name", "type": "TypeString", @@ -121118,6 +125785,12 @@ "max_length": 63, "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" }, + { + "name": "status", + "type": "TypeString", + "description": "Public gateway instance status", + "computed": true + }, { "name": "resource_group", "type": "TypeString", @@ -121128,46 +125801,18 @@ "computed": true }, { - "name": "crn", - "type": "TypeString", - "description": "The crn of the resource", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "resource_group_name", + "name": "vpc", "type": "TypeString", - "description": "The resource group name in which resource is provisioned", - "computed": true + "description": "Public gateway VPC info", + "immutable": true, + "required": true }, { - "name": "status", + "name": "zone", "type": "TypeString", - "description": "Public gateway instance status", - "computed": true - }, - { - "name": "tags", - "type": "TypeSet", - "description": "Service tags for the public gateway instance", - "min_length": 1, - "max_length": 128, - "matches": "^[A-Za-z0-9:_ .-]+$", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "access_tags", - "type": "TypeSet", - "description": "List of access management tags", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "description": "Public gateway zone info", + "immutable": true, + "required": true }, { "name": "resource_controller_url", @@ -121182,16 +125827,16 @@ "computed": true }, { - "name": "zone", + "name": "resource_crn", "type": "TypeString", - "description": "Public gateway zone info", - "immutable": true, - "required": true + "description": "The crn of the resource", + "computed": true }, { - "name": "resource_crn", + "name": "crn", "type": "TypeString", "description": "The crn of the resource", + "cloud_data_type": "crn", "computed": true }, { @@ -121199,25 +125844,20 @@ "type": "TypeString", "description": "The status of the resource", "computed": true - } - ], - "ibm_is_security_group": [ - { - "name": "resource_crn", - "type": "TypeString", - "description": "The crn of the resource", - "computed": true }, { - "name": "resource_group_name", - "type": "TypeString", - "description": "The resource group name in which resource is provisioned", + "name": "floating_ip", + "type": "TypeMap", + "optional": true, "computed": true }, { - "name": "access_tags", + "name": "tags", "type": "TypeSet", - "description": "List of access management tags", + "description": "Service tags for the public gateway instance", + "min_length": 1, + "max_length": 128, + "matches": "^[A-Za-z0-9:_ .-]+$", "optional": true, "computed": true, "elem": { @@ -121225,18 +125865,9 @@ } }, { - "name": "resource_controller_url", - "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", - "computed": true - }, - { - "name": "tags", + "name": "access_tags", "type": "TypeSet", - "description": "List of tags", - "min_length": 1, - "max_length": 128, - "matches": "^[A-Za-z0-9:_ .-]+$", + "description": "List of access management tags", "optional": true, "computed": true, "elem": { @@ -121244,12 +125875,13 @@ } }, { - "name": "crn", + "name": "resource_group_name", "type": "TypeString", - "description": "The crn of the resource", - "cloud_data_type": "crn", + "description": "The resource group name in which resource is provisioned", "computed": true - }, + } + ], + "ibm_is_security_group": [ { "name": "rules", "type": "TypeList", @@ -121301,6 +125933,55 @@ } } }, + { + "name": "resource_name", + "type": "TypeString", + "description": "The name of the resource", + "computed": true + }, + { + "name": "resource_group_name", + "type": "TypeString", + "description": "The resource group name in which resource is provisioned", + "computed": true + }, + { + "name": "tags", + "type": "TypeSet", + "description": "List of tags", + "min_length": 1, + "max_length": 128, + "matches": "^[A-Za-z0-9:_ .-]+$", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "vpc", + "type": "TypeString", + "description": "Security group's resource group id", + "immutable": true, + "required": true + }, + { + "name": "access_tags", + "type": "TypeSet", + "description": "List of access management tags", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "crn", + "type": "TypeString", + "description": "The crn of the resource", + "cloud_data_type": "crn", + "computed": true + }, { "name": "resource_group", "type": "TypeString", @@ -121311,9 +125992,15 @@ "computed": true }, { - "name": "resource_name", + "name": "resource_controller_url", "type": "TypeString", - "description": "The name of the resource", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", + "computed": true + }, + { + "name": "resource_crn", + "type": "TypeString", + "description": "The crn of the resource", "computed": true }, { @@ -121325,16 +126012,34 @@ "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", "optional": true, "computed": true + } + ], + "ibm_is_security_group_rule": [ + { + "name": "related_crn", + "type": "TypeString", + "description": "The crn of the Security Group", + "computed": true }, { - "name": "vpc", + "name": "protocol", "type": "TypeString", - "description": "Security group's resource group id", + "description": "The Security Group Rule Protocol", + "computed": true + }, + { + "name": "group", + "type": "TypeString", + "description": "Security group id", "immutable": true, "required": true - } - ], - "ibm_is_security_group_rule": [ + }, + { + "name": "rule_id", + "type": "TypeString", + "description": "Rule id", + "computed": true + }, { "name": "direction", "type": "TypeString", @@ -121342,14 +126047,6 @@ "required": true, "options": "inbound, outbound" }, - { - "name": "ip_version", - "type": "TypeString", - "description": "IP version: ipv4", - "default_value": "ipv4", - "options": "ipv4", - "optional": true - }, { "name": "remote", "type": "TypeString", @@ -121357,6 +126054,27 @@ "optional": true, "computed": true }, + { + "name": "icmp", + "type": "TypeList", + "description": "protocol=icmp", + "immutable": true, + "optional": true, + "elem": { + "code": { + "name": "code", + "type": "TypeInt", + "optional": true + }, + "type": { + "name": "type", + "type": "TypeInt", + "optional": true + } + }, + "max_items": 1, + "min_items": 1 + }, { "name": "udp", "type": "TypeList", @@ -121381,45 +126099,212 @@ "min_items": 1 }, { - "name": "group", + "name": "ip_version", + "type": "TypeString", + "description": "IP version: ipv4", + "default_value": "ipv4", + "options": "ipv4", + "optional": true + }, + { + "name": "tcp", + "type": "TypeList", + "description": "protocol=tcp", + "immutable": true, + "optional": true, + "elem": { + "port_max": { + "name": "port_max", + "type": "TypeInt", + "default_value": 65535, + "optional": true + }, + "port_min": { + "name": "port_min", + "type": "TypeInt", + "default_value": 1, + "optional": true + } + }, + "max_items": 1, + "min_items": 1 + } + ], + "ibm_is_security_group_target": [ + { + "name": "crn", + "type": "TypeString", + "description": "The CRN for this Security group target", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "resource_type", + "type": "TypeString", + "description": "Resource Type", + "computed": true + }, + { + "name": "security_group", "type": "TypeString", "description": "Security group id", "immutable": true, - "required": true + "required": true, + "min_length": 1, + "max_length": 64, + "matches": "^[-0-9a-z_]+$" }, { - "name": "rule_id", + "name": "target", "type": "TypeString", - "description": "Rule id", + "description": "security group target identifier", + "immutable": true, + "required": true, + "min_length": 1, + "max_length": 64, + "matches": "^[-0-9a-z_]+$" + }, + { + "name": "name", + "type": "TypeString", + "description": "Security group target name", + "computed": true + } + ], + "ibm_is_share": [ + { + "name": "encryption_key", + "type": "TypeString", + "description": "The CRN of the key to use for encrypting this file share.If no encryption key is provided, the share will not be encrypted.", + "immutable": true, + "optional": true, "computed": true }, { - "name": "related_crn", + "name": "replication_status_reasons", + "type": "TypeList", + "description": "The reasons for the current replication status (if any).The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered.", + "computed": true, + "elem": { + "code": { + "name": "code", + "type": "TypeString", + "description": "A snake case string succinctly identifying the status reason.", + "required": true + }, + "message": { + "name": "message", + "type": "TypeString", + "description": "An explanation of the status reason.", + "required": true + }, + "more_info": { + "name": "more_info", + "type": "TypeString", + "description": "Link to documentation about this status reason.", + "optional": true + } + } + }, + { + "name": "lifecycle_state", "type": "TypeString", - "description": "The crn of the Security Group", + "description": "The lifecycle state of the file share.", "computed": true }, { - "name": "protocol", + "name": "resource_group", "type": "TypeString", - "description": "The Security Group Rule Protocol", + "description": "The unique identifier of the resource group to use. If unspecified, the account's [default resourcegroup](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used.", + "cloud_data_type": "resource_group", + "immutable": true, + "optional": true, "computed": true }, { - "name": "icmp", + "name": "latest_job", "type": "TypeList", - "description": "protocol=icmp", + "description": "The latest job associated with this file share.This property will be absent if no jobs have been created for this file share.", + "computed": true, + "elem": { + "status": { + "name": "status", + "type": "TypeString", + "description": "The status of the file share job.The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the file share job on which the unexpected property value was encountered.* `cancelled`: This job has been cancelled.* `failed`: This job has failed.* `queued`: This job is queued.* `running`: This job is running.* `succeeded`: This job completed successfully.", + "computed": true + }, + "status_reasons": { + "name": "status_reasons", + "type": "TypeList", + "description": "The reasons for the file share job status (if any).The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered.", + "computed": true, + "elem": { + "code": { + "name": "code", + "type": "TypeString", + "description": "A snake case string succinctly identifying the status reason.", + "computed": true + }, + "message": { + "name": "message", + "type": "TypeString", + "description": "An explanation of the status reason.", + "computed": true + }, + "more_info": { + "name": "more_info", + "type": "TypeString", + "description": "Link to documentation about this status reason.", + "computed": true + } + } + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "The type of the file share job.The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the file share job on which the unexpected property value was encountered.* `replication_failover`: This is a share replication failover job.* `replication_init`: This is a share replication is initialization job.* `replication_split`: This is a share replication split job.* `replication_sync`: This is a share replication synchronization job.", + "computed": true + } + } + }, + { + "name": "zone", + "type": "TypeString", + "description": "The globally unique name of the zone this file share will reside in.", + "immutable": true, + "required": true + }, + { + "name": "encryption", + "type": "TypeString", + "description": "The type of encryption used for this file share.", + "computed": true + }, + { + "name": "href", + "type": "TypeString", + "description": "The URL for this share.", + "computed": true + }, + { + "name": "initial_owner", + "type": "TypeList", + "description": "The owner assigned to the file share at creation.", "immutable": true, "optional": true, "elem": { - "code": { - "name": "code", + "gid": { + "name": "gid", "type": "TypeInt", + "description": "The initial group identifier for the file share.", + "immutable": true, "optional": true }, - "type": { - "name": "type", + "uid": { + "name": "uid", "type": "TypeInt", + "description": "The initial user identifier for the file share.", + "immutable": true, "optional": true } }, @@ -121427,143 +126312,224 @@ "min_items": 1 }, { - "name": "tcp", + "name": "size", + "type": "TypeInt", + "description": "The size of the file share rounded up to the next gigabyte.", + "min_value": "10", + "max_value": "32000", + "optional": true, + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.", + "required": true, + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$" + }, + { + "name": "profile", + "type": "TypeString", + "description": "The globally unique name for this share profile.", + "required": true + }, + { + "name": "replication_role", + "type": "TypeString", + "description": "The replication role of the file share.* `none`: This share is not participating in replication.* `replica`: This share is a replication target.* `source`: This share is a replication source.", + "computed": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "The date and time that the file share is created.", + "computed": true + }, + { + "name": "replication_status", + "type": "TypeString", + "description": "The replication status of the file share.* `initializing`: This share is initializing replication.* `active`: This share is actively participating in replication.* `failover_pending`: This share is performing a replication failover.* `split_pending`: This share is performing a replication split.* `none`: This share is not participating in replication.* `degraded`: This share's replication sync is degraded.* `sync_pending`: This share is performing a replication sync.", + "computed": true + }, + { + "name": "last_sync_at", + "type": "TypeString", + "description": "The date and time that the file share was last synchronized to its replica.This property will be present when the `replication_role` is `source`.", + "computed": true + }, + { + "name": "access_control_mode", + "type": "TypeString", + "description": "The access control mode for the share:", + "optional": true, + "computed": true + }, + { + "name": "mount_targets", "type": "TypeList", - "description": "protocol=tcp", - "immutable": true, + "description": "The share targets for this file share.Share targets mounted from a replica must be mounted read-only.", "optional": true, + "computed": true, "elem": { - "port_max": { - "name": "port_max", - "type": "TypeInt", - "default_value": 65535, - "optional": true + "href": { + "name": "href", + "type": "TypeString", + "description": "Href of this mount target", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "ID of this mount target", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The user-defined name for this share target. Names must be unique within the share the share target resides in. If unspecified, the name will be a hyphenated list of randomly-selected words.", + "required": true + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "Resource type of mount target", + "computed": true + }, + "transit_encryption": { + "name": "transit_encryption", + "type": "TypeString", + "description": "The transit encryption mode.", + "optional": true, + "computed": true + }, + "virtual_network_interface": { + "name": "virtual_network_interface", + "type": "TypeList", + "description": "VNI for mount target.", + "optional": true, + "elem": { + "crn": { + "name": "crn", + "type": "TypeString", + "description": "CRN of virtual network interface", + "computed": true + }, + "href": { + "name": "href", + "type": "TypeString", + "description": "href of virtual network interface", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "ID of this VNI", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Name of this VNI", + "optional": true, + "computed": true + }, + "primary_ip": { + "name": "primary_ip", + "type": "TypeList", + "description": "VNI for mount target.", + "optional": true, + "computed": true, + "elem": { + "address": { + "name": "address", + "type": "TypeString", + "description": "The IP address to reserve, which must not already be reserved on the subnet.", + "optional": true, + "computed": true + }, + "auto_delete": { + "name": "auto_delete", + "type": "TypeBool", + "description": "Indicates whether this reserved IP member will be automatically deleted when either target is deleted, or the reserved IP is unbound.", + "optional": true, + "computed": true + }, + "href": { + "name": "href", + "type": "TypeString", + "description": "href of primary ip", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Name for reserved IP", + "optional": true, + "computed": true + }, + "reserved_ip": { + "name": "reserved_ip", + "type": "TypeString", + "description": "ID of reserved IP", + "optional": true, + "computed": true + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "Resource type of primary ip", + "computed": true + } + } + }, + "resource_group": { + "name": "resource_group", + "type": "TypeString", + "description": "Resource group id", + "optional": true, + "computed": true + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "Resource type of primary ip", + "computed": true + }, + "security_groups": { + "name": "security_groups", + "type": "TypeSet", + "description": "The security groups to use for this virtual network interface.", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "subnet": { + "name": "subnet", + "type": "TypeString", + "description": "The associated subnet. Required if primary_ip is not specified.", + "optional": true + } + } }, - "port_min": { - "name": "port_min", - "type": "TypeInt", - "default_value": 1, - "optional": true + "vpc": { + "name": "vpc", + "type": "TypeString", + "description": "The unique identifier of the VPC in which instances can mount the file share using this share target.This property will be removed in a future release.The `subnet` property should be used instead.", + "optional": true, + "computed": true } - }, - "max_items": 1, - "min_items": 1 - } - ], - "ibm_is_security_group_target": [ - { - "name": "security_group", - "type": "TypeString", - "description": "Security group id", - "immutable": true, - "required": true, - "min_length": 1, - "max_length": 64, - "matches": "^[-0-9a-z_]+$" - }, - { - "name": "target", - "type": "TypeString", - "description": "security group target identifier", - "immutable": true, - "required": true, - "min_length": 1, - "max_length": 64, - "matches": "^[-0-9a-z_]+$" - }, - { - "name": "name", - "type": "TypeString", - "description": "Security group target name", - "computed": true - }, - { - "name": "crn", - "type": "TypeString", - "description": "The CRN for this Security group target", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "resource_type", - "type": "TypeString", - "description": "Resource Type", - "computed": true - } - ], - "ibm_is_share": [ - { - "name": "tags", - "type": "TypeSet", - "description": "User Tags for the file share", - "min_length": 1, - "max_length": 128, - "matches": "^[A-Za-z0-9:_ .-]+$", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" } }, - { - "name": "name", - "type": "TypeString", - "description": "The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.", - "required": true, - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$" - }, - { - "name": "replication_cron_spec", - "type": "TypeString", - "description": "The cron specification for the file share replication schedule.Replication of a share can be scheduled to occur at most once per hour.", - "optional": true, - "computed": true - }, - { - "name": "last_sync_at", - "type": "TypeString", - "description": "The date and time that the file share was last synchronized to its replica.This property will be present when the `replication_role` is `source`.", - "computed": true - }, - { - "name": "lifecycle_state", - "type": "TypeString", - "description": "The lifecycle state of the file share.", - "computed": true - }, - { - "name": "initial_owner", - "type": "TypeList", - "description": "The owner assigned to the file share at creation.", - "immutable": true, - "optional": true, - "elem": { - "gid": { - "name": "gid", - "type": "TypeInt", - "description": "The initial group identifier for the file share.", - "immutable": true, - "optional": true - }, - "uid": { - "name": "uid", - "type": "TypeInt", - "description": "The initial user identifier for the file share.", - "immutable": true, - "optional": true - } - }, - "max_items": 1, - "min_items": 1 - }, { "name": "iops", "type": "TypeInt", "description": "The maximum input/output operation performance bandwidth per second for the file share.", "min_value": "100", - "max_value": "48000", + "max_value": "96000", "optional": true, "computed": true }, @@ -121843,234 +126809,25 @@ "optional": true }, { - "name": "replication_status", - "type": "TypeString", - "description": "The replication status of the file share.* `initializing`: This share is initializing replication.* `active`: This share is actively participating in replication.* `failover_pending`: This share is performing a replication failover.* `split_pending`: This share is performing a replication split.* `none`: This share is not participating in replication.* `degraded`: This share's replication sync is degraded.* `sync_pending`: This share is performing a replication sync.", - "computed": true - }, - { - "name": "replication_status_reasons", - "type": "TypeList", - "description": "The reasons for the current replication status (if any).The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered.", - "computed": true, - "elem": { - "code": { - "name": "code", - "type": "TypeString", - "description": "A snake case string succinctly identifying the status reason.", - "required": true - }, - "message": { - "name": "message", - "type": "TypeString", - "description": "An explanation of the status reason.", - "required": true - }, - "more_info": { - "name": "more_info", - "type": "TypeString", - "description": "Link to documentation about this status reason.", - "optional": true - } - } - }, - { - "name": "resource_type", - "type": "TypeString", - "description": "The type of resource referenced.", - "computed": true - }, - { - "name": "encryption_key", - "type": "TypeString", - "description": "The CRN of the key to use for encrypting this file share.If no encryption key is provided, the share will not be encrypted.", - "immutable": true, - "optional": true, - "computed": true - }, - { - "name": "resource_group", + "name": "replication_cron_spec", "type": "TypeString", - "description": "The unique identifier of the resource group to use. If unspecified, the account's [default resourcegroup](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used.", - "cloud_data_type": "resource_group", - "immutable": true, - "optional": true, - "computed": true - }, - { - "name": "size", - "type": "TypeInt", - "description": "The size of the file share rounded up to the next gigabyte.", - "min_value": "10", - "max_value": "32000", + "description": "The cron specification for the file share replication schedule.Replication of a share can be scheduled to occur at most once per hour.", "optional": true, "computed": true }, { - "name": "mount_targets", - "type": "TypeList", - "description": "The share targets for this file share.Share targets mounted from a replica must be mounted read-only.", + "name": "tags", + "type": "TypeSet", + "description": "User Tags for the file share", + "min_length": 1, + "max_length": 128, + "matches": "^[A-Za-z0-9:_ .-]+$", "optional": true, "computed": true, "elem": { - "href": { - "name": "href", - "type": "TypeString", - "description": "Href of this mount target", - "computed": true - }, - "id": { - "name": "id", - "type": "TypeString", - "description": "ID of this mount target", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "The user-defined name for this share target. Names must be unique within the share the share target resides in. If unspecified, the name will be a hyphenated list of randomly-selected words.", - "required": true - }, - "resource_type": { - "name": "resource_type", - "type": "TypeString", - "description": "Resource type of mount target", - "computed": true - }, - "transit_encryption": { - "name": "transit_encryption", - "type": "TypeString", - "description": "The transit encryption mode.", - "optional": true, - "computed": true - }, - "virtual_network_interface": { - "name": "virtual_network_interface", - "type": "TypeList", - "description": "VNI for mount target.", - "optional": true, - "elem": { - "crn": { - "name": "crn", - "type": "TypeString", - "description": "CRN of virtual network interface", - "computed": true - }, - "href": { - "name": "href", - "type": "TypeString", - "description": "href of virtual network interface", - "computed": true - }, - "id": { - "name": "id", - "type": "TypeString", - "description": "ID of this VNI", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Name of this VNI", - "optional": true, - "computed": true - }, - "primary_ip": { - "name": "primary_ip", - "type": "TypeList", - "description": "VNI for mount target.", - "optional": true, - "computed": true, - "elem": { - "address": { - "name": "address", - "type": "TypeString", - "description": "The IP address to reserve, which must not already be reserved on the subnet.", - "optional": true, - "computed": true - }, - "auto_delete": { - "name": "auto_delete", - "type": "TypeBool", - "description": "Indicates whether this reserved IP member will be automatically deleted when either target is deleted, or the reserved IP is unbound.", - "optional": true, - "computed": true - }, - "href": { - "name": "href", - "type": "TypeString", - "description": "href of primary ip", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Name for reserved IP", - "optional": true, - "computed": true - }, - "reserved_ip": { - "name": "reserved_ip", - "type": "TypeString", - "description": "ID of reserved IP", - "optional": true, - "computed": true - }, - "resource_type": { - "name": "resource_type", - "type": "TypeString", - "description": "Resource type of primary ip", - "computed": true - } - } - }, - "resource_group": { - "name": "resource_group", - "type": "TypeString", - "description": "Resource group id", - "optional": true, - "computed": true - }, - "resource_type": { - "name": "resource_type", - "type": "TypeString", - "description": "Resource type of primary ip", - "computed": true - }, - "security_groups": { - "name": "security_groups", - "type": "TypeSet", - "description": "The security groups to use for this virtual network interface.", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "subnet": { - "name": "subnet", - "type": "TypeString", - "description": "The associated subnet. Required if primary_ip is not specified.", - "optional": true - } - } - }, - "vpc": { - "name": "vpc", - "type": "TypeString", - "description": "The unique identifier of the VPC in which instances can mount the file share using this share target.This property will be removed in a future release.The `subnet` property should be used instead.", - "optional": true, - "computed": true - } + "type": "TypeString" } }, - { - "name": "zone", - "type": "TypeString", - "description": "The globally unique name of the zone this file share will reside in.", - "immutable": true, - "required": true - }, { "name": "access_tags", "type": "TypeSet", @@ -122081,12 +126838,6 @@ "type": "TypeString" } }, - { - "name": "created_at", - "type": "TypeString", - "description": "The date and time that the file share is created.", - "computed": true - }, { "name": "crn", "type": "TypeString", @@ -122095,107 +126846,19 @@ "computed": true }, { - "name": "access_control_mode", - "type": "TypeString", - "description": "The access control mode for the share:", - "optional": true, - "computed": true - }, - { - "name": "profile", - "type": "TypeString", - "description": "The globally unique name for this share profile.", - "required": true - }, - { - "name": "replication_role", - "type": "TypeString", - "description": "The replication role of the file share.* `none`: This share is not participating in replication.* `replica`: This share is a replication target.* `source`: This share is a replication source.", - "computed": true - }, - { - "name": "latest_job", - "type": "TypeList", - "description": "The latest job associated with this file share.This property will be absent if no jobs have been created for this file share.", - "computed": true, - "elem": { - "status": { - "name": "status", - "type": "TypeString", - "description": "The status of the file share job.The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the file share job on which the unexpected property value was encountered.* `cancelled`: This job has been cancelled.* `failed`: This job has failed.* `queued`: This job is queued.* `running`: This job is running.* `succeeded`: This job completed successfully.", - "computed": true - }, - "status_reasons": { - "name": "status_reasons", - "type": "TypeList", - "description": "The reasons for the file share job status (if any).The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered.", - "computed": true, - "elem": { - "code": { - "name": "code", - "type": "TypeString", - "description": "A snake case string succinctly identifying the status reason.", - "computed": true - }, - "message": { - "name": "message", - "type": "TypeString", - "description": "An explanation of the status reason.", - "computed": true - }, - "more_info": { - "name": "more_info", - "type": "TypeString", - "description": "Link to documentation about this status reason.", - "computed": true - } - } - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "The type of the file share job.The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the file share job on which the unexpected property value was encountered.* `replication_failover`: This is a share replication failover job.* `replication_init`: This is a share replication is initialization job.* `replication_split`: This is a share replication split job.* `replication_sync`: This is a share replication synchronization job.", - "computed": true - } - } - }, - { - "name": "encryption", - "type": "TypeString", - "description": "The type of encryption used for this file share.", - "computed": true - }, - { - "name": "href", + "name": "resource_type", "type": "TypeString", - "description": "The URL for this share.", + "description": "The type of resource referenced.", "computed": true } ], "ibm_is_share_mount_target": [ { - "name": "lifecycle_state", - "type": "TypeString", - "description": "The lifecycle state of the mount target.", - "computed": true - }, - { - "name": "resource_type", - "type": "TypeString", - "description": "The type of resource referenced.", - "computed": true - }, - { - "name": "share", + "name": "transit_encryption", "type": "TypeString", - "description": "The file share identifier.", + "description": "The transit encryption mode.", "immutable": true, - "required": true - }, - { - "name": "access_control_mode", - "type": "TypeString", - "description": "The access control mode for the share", + "optional": true, "computed": true }, { @@ -122314,24 +126977,50 @@ "max_items": 1, "min_items": 1 }, + { + "name": "vpc", + "type": "TypeString", + "description": "The unique identifier of the VPC in which instances can mount the file share using this share target.This property will be removed in a future release.The `subnet` property should be used instead.", + "optional": true, + "computed": true + }, { "name": "mount_target", "type": "TypeString", "description": "The unique identifier of this target", "computed": true }, + { + "name": "created_at", + "type": "TypeString", + "description": "The date and time that the share target was created.", + "computed": true + }, { "name": "href", "type": "TypeString", "description": "The URL for this share target.", "computed": true }, + { + "name": "lifecycle_state", + "type": "TypeString", + "description": "The lifecycle state of the mount target.", + "computed": true + }, { "name": "mount_path", "type": "TypeString", "description": "The mount path for the share.The IP addresses used in the mount path are currently within the IBM services IP range, but are expected to change to be within one of the VPC's subnets in the future.", "computed": true }, + { + "name": "share", + "type": "TypeString", + "description": "The file share identifier.", + "immutable": true, + "required": true + }, { "name": "name", "type": "TypeString", @@ -122342,36 +127031,19 @@ "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$" }, { - "name": "transit_encryption", - "type": "TypeString", - "description": "The transit encryption mode.", - "immutable": true, - "optional": true, - "computed": true - }, - { - "name": "vpc", + "name": "access_control_mode", "type": "TypeString", - "description": "The unique identifier of the VPC in which instances can mount the file share using this share target.This property will be removed in a future release.The `subnet` property should be used instead.", - "optional": true, + "description": "The access control mode for the share", "computed": true }, { - "name": "created_at", + "name": "resource_type", "type": "TypeString", - "description": "The date and time that the share target was created.", + "description": "The type of resource referenced.", "computed": true } ], "ibm_is_share_replica_operations": [ - { - "name": "timeout", - "type": "TypeInt", - "description": "The failover timeout in seconds", - "min_value": "300", - "max_value": "3600", - "optional": true - }, { "name": "split_share", "type": "TypeBool", @@ -122395,66 +127067,27 @@ "immutable": true, "options": "fail, split", "optional": true + }, + { + "name": "timeout", + "type": "TypeInt", + "description": "The failover timeout in seconds", + "min_value": "300", + "max_value": "3600", + "optional": true } ], "ibm_is_snapshot": [ { - "name": "source_snapshot_crn", - "type": "TypeString", - "description": "Source Snapshot CRN", - "immutable": true, - "optional": true - }, - { - "name": "source_image", - "type": "TypeString", - "description": "If present, the image id from which the data on this volume was most directly provisioned.", - "computed": true - }, - { - "name": "operating_system", - "type": "TypeString", - "description": "The globally unique name for the operating system included in this image", - "computed": true - }, - { - "name": "bootable", - "type": "TypeBool", - "description": "Indicates if a boot volume attachment can be created with a volume created from this snapshot", - "computed": true - }, - { - "name": "encryption_key", - "type": "TypeString", - "description": "A reference to the root key used to wrap the data encryption key for the source volume.", - "optional": true, - "computed": true - }, - { - "name": "clones", - "type": "TypeSet", - "description": "Zones for creating the snapshot clone", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "copies", + "name": "backup_policy_plan", "type": "TypeList", - "description": "The copies of this snapshot in other regions.", + "description": "If present, the backup policy plan which created this snapshot.", "computed": true, "elem": { - "crn": { - "name": "crn", - "type": "TypeString", - "description": "The CRN for the copied snapshot.", - "computed": true - }, "deleted": { "name": "deleted", "type": "TypeList", - "description": "If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.", + "description": "If present, this property indicates the referenced resource has been deleted and provides some supplementary information.", "computed": true, "elem": { "more_info": { @@ -122468,45 +127101,25 @@ "href": { "name": "href", "type": "TypeString", - "description": "The URL for the copied snapshot.", + "description": "The URL for this backup policy plan.", "computed": true }, "id": { "name": "id", "type": "TypeString", - "description": "The unique identifier for the copied snapshot.", + "description": "The unique identifier for this backup policy plan.", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "The name for the copied snapshot. The name is unique across all snapshots in the copied snapshot's native region.", + "description": "The unique user-defined name for this backup policy plan.", "computed": true }, - "remote": { - "name": "remote", - "type": "TypeList", - "description": "If present, this property indicates the referenced resource is remote to this region,and identifies the native region.", - "computed": true, - "elem": { - "href": { - "name": "href", - "type": "TypeString", - "description": "The URL for this region.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "The globally unique name for this region.", - "computed": true - } - } - }, "resource_type": { "name": "resource_type", "type": "TypeString", - "description": "The resource type.", + "description": "The type of resource referenced", "computed": true } } @@ -122583,6 +127196,12 @@ } } }, + { + "name": "bootable", + "type": "TypeBool", + "description": "Indicates if a boot volume attachment can be created with a volume created from this snapshot", + "computed": true + }, { "name": "crn", "type": "TypeString", @@ -122591,21 +127210,24 @@ "computed": true }, { - "name": "size", + "name": "minimum_capacity", "type": "TypeInt", - "description": "The size of the snapshot", + "description": "Minimum capacity of the snapshot", "computed": true }, { - "name": "name", + "name": "encryption_key", "type": "TypeString", - "description": "Snapshot name", - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", + "description": "A reference to the root key used to wrap the data encryption key for the source volume.", "optional": true, "computed": true }, + { + "name": "size", + "type": "TypeInt", + "description": "The size of the snapshot", + "computed": true + }, { "name": "resource_group", "type": "TypeString", @@ -122615,28 +127237,6 @@ "optional": true, "computed": true }, - { - "name": "lifecycle_state", - "type": "TypeString", - "description": "Snapshot lifecycle state", - "computed": true - }, - { - "name": "minimum_capacity", - "type": "TypeInt", - "description": "Minimum capacity of the snapshot", - "computed": true - }, - { - "name": "access_tags", - "type": "TypeSet", - "description": "List of access management tags", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } - }, { "name": "source_volume", "type": "TypeString", @@ -122646,46 +127246,33 @@ "computed": true }, { - "name": "encryption", - "type": "TypeString", - "description": "Encryption type of the snapshot", - "computed": true - }, - { - "name": "href", + "name": "operating_system", "type": "TypeString", - "description": "URL for the snapshot", + "description": "The globally unique name for the operating system included in this image", "computed": true }, { - "name": "resource_type", + "name": "lifecycle_state", "type": "TypeString", - "description": "The resource type of the snapshot", + "description": "Snapshot lifecycle state", "computed": true }, { - "name": "tags", - "type": "TypeSet", - "description": "User Tags for the snapshot", - "min_length": 1, - "max_length": 128, - "matches": "^[A-Za-z0-9:_ .-]+$", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "backup_policy_plan", + "name": "copies", "type": "TypeList", - "description": "If present, the backup policy plan which created this snapshot.", + "description": "The copies of this snapshot in other regions.", "computed": true, "elem": { + "crn": { + "name": "crn", + "type": "TypeString", + "description": "The CRN for the copied snapshot.", + "computed": true + }, "deleted": { "name": "deleted", "type": "TypeList", - "description": "If present, this property indicates the referenced resource has been deleted and provides some supplementary information.", + "description": "If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.", "computed": true, "elem": { "more_info": { @@ -122699,53 +127286,124 @@ "href": { "name": "href", "type": "TypeString", - "description": "The URL for this backup policy plan.", + "description": "The URL for the copied snapshot.", "computed": true }, "id": { "name": "id", "type": "TypeString", - "description": "The unique identifier for this backup policy plan.", + "description": "The unique identifier for the copied snapshot.", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "The unique user-defined name for this backup policy plan.", + "description": "The name for the copied snapshot. The name is unique across all snapshots in the copied snapshot's native region.", "computed": true }, + "remote": { + "name": "remote", + "type": "TypeList", + "description": "If present, this property indicates the referenced resource is remote to this region,and identifies the native region.", + "computed": true, + "elem": { + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this region.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The globally unique name for this region.", + "computed": true + } + } + }, "resource_type": { "name": "resource_type", "type": "TypeString", - "description": "The type of resource referenced", + "description": "The resource type.", "computed": true } } - } - ], - "ibm_is_ssh_key": [ + }, { - "name": "name", + "name": "href", "type": "TypeString", - "description": "SSH Key name", - "required": true, + "description": "URL for the snapshot", + "computed": true + }, + { + "name": "clones", + "type": "TypeSet", + "description": "Zones for creating the snapshot clone", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "tags", + "type": "TypeSet", + "description": "User Tags for the snapshot", "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" + "max_length": 128, + "matches": "^[A-Za-z0-9:_ .-]+$", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "type", + "name": "resource_type", "type": "TypeString", - "description": "Key type", + "description": "The resource type of the snapshot", + "computed": true + }, + { + "name": "access_tags", + "type": "TypeSet", + "description": "List of access management tags", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "name", + "type": "TypeString", + "description": "Snapshot name", + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", "optional": true, "computed": true }, { - "name": "fingerprint", + "name": "source_snapshot_crn", "type": "TypeString", - "description": "SSH key Fingerprint info", + "description": "Source Snapshot CRN", + "immutable": true, + "optional": true + }, + { + "name": "source_image", + "type": "TypeString", + "description": "If present, the image id from which the data on this volume was most directly provisioned.", "computed": true }, + { + "name": "encryption", + "type": "TypeString", + "description": "Encryption type of the snapshot", + "computed": true + } + ], + "ibm_is_ssh_key": [ { "name": "resource_name", "type": "TypeString", @@ -122753,10 +127411,24 @@ "computed": true }, { - "name": "crn", + "name": "resource_crn", "type": "TypeString", "description": "The crn of the resource", - "cloud_data_type": "crn", + "computed": true + }, + { + "name": "resource_group_name", + "type": "TypeString", + "description": "The resource group name in which resource is provisioned", + "computed": true + }, + { + "name": "resource_group", + "type": "TypeString", + "description": "Resource group ID", + "cloud_data_type": "resource_group", + "immutable": true, + "optional": true, "computed": true }, { @@ -122766,6 +127438,19 @@ "immutable": true, "required": true }, + { + "name": "type", + "type": "TypeString", + "description": "Key type", + "optional": true, + "computed": true + }, + { + "name": "fingerprint", + "type": "TypeString", + "description": "SSH key Fingerprint info", + "computed": true + }, { "name": "length", "type": "TypeInt", @@ -122785,15 +127470,6 @@ "type": "TypeString" } }, - { - "name": "resource_group", - "type": "TypeString", - "description": "Resource group ID", - "cloud_data_type": "resource_group", - "immutable": true, - "optional": true, - "computed": true - }, { "name": "resource_controller_url", "type": "TypeString", @@ -122801,16 +127477,20 @@ "computed": true }, { - "name": "resource_crn", + "name": "crn", "type": "TypeString", "description": "The crn of the resource", + "cloud_data_type": "crn", "computed": true }, { - "name": "resource_group_name", + "name": "name", "type": "TypeString", - "description": "The resource group name in which resource is provisioned", - "computed": true + "description": "SSH Key name", + "required": true, + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" }, { "name": "access_tags", @@ -122825,41 +127505,42 @@ ], "ibm_is_subnet": [ { - "name": "ipv4_cidr_block", + "name": "zone", "type": "TypeString", - "description": "IPV4 subnet - CIDR block", + "description": "Subnet zone info", "immutable": true, - "optional": true, - "computed": true + "required": true }, { - "name": "public_gateway", - "type": "TypeString", - "description": "Public Gateway of the subnet", - "optional": true, + "name": "available_ipv4_address_count", + "type": "TypeInt", + "description": "The number of IPv4 addresses in this subnet that are not in-use, and have not been reserved by the user or the provider.", "computed": true }, { - "name": "vpc", - "type": "TypeString", - "description": "VPC instance ID", + "name": "total_ipv4_address_count", + "type": "TypeInt", + "description": "The total number of IPv4 addresses in this subnet.", "immutable": true, - "required": true + "optional": true, + "computed": true }, { - "name": "resource_group", + "name": "ip_version", "type": "TypeString", - "description": "The resource group for this subnet", - "cloud_data_type": "resource_group", + "description": "The IP version(s) to support for this subnet.", + "default_value": "ipv4", "immutable": true, - "optional": true, - "computed": true + "optional": true }, { - "name": "resource_status", + "name": "name", "type": "TypeString", - "description": "The status of the resource", - "computed": true + "description": "Subnet name", + "required": true, + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" }, { "name": "access_tags", @@ -122875,34 +127556,26 @@ } }, { - "name": "status", + "name": "crn", "type": "TypeString", - "description": "The status of the subnet", + "description": "The crn of the resource", + "cloud_data_type": "crn", "computed": true }, { - "name": "resource_name", + "name": "network_acl", "type": "TypeString", - "description": "The name of the resource", - "computed": true - }, - { - "name": "tags", - "type": "TypeSet", - "description": "List of tags", - "min_length": 1, - "max_length": 128, - "matches": "^[A-Za-z0-9:_ .-]+$", + "description": "The network ACL for this subnet", "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "computed": true }, { - "name": "resource_controller_url", + "name": "resource_group", "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", + "description": "The resource group for this subnet", + "cloud_data_type": "resource_group", + "immutable": true, + "optional": true, "computed": true }, { @@ -122913,57 +127586,64 @@ "computed": true }, { - "name": "available_ipv4_address_count", - "type": "TypeInt", - "description": "The number of IPv4 addresses in this subnet that are not in-use, and have not been reserved by the user or the provider.", + "name": "resource_controller_url", + "type": "TypeString", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", "computed": true }, { - "name": "total_ipv4_address_count", - "type": "TypeInt", - "description": "The total number of IPv4 addresses in this subnet.", - "immutable": true, - "optional": true, + "name": "resource_group_name", + "type": "TypeString", + "description": "The resource group name in which resource is provisioned", "computed": true }, { - "name": "ip_version", + "name": "ipv4_cidr_block", "type": "TypeString", - "description": "The IP version(s) to support for this subnet.", - "default_value": "ipv4", + "description": "IPV4 subnet - CIDR block", "immutable": true, - "optional": true + "optional": true, + "computed": true }, { - "name": "name", + "name": "status", "type": "TypeString", - "description": "Subnet name", - "required": true, - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" + "description": "The status of the subnet", + "computed": true }, { - "name": "crn", - "type": "TypeString", - "description": "The crn of the resource", - "cloud_data_type": "crn", - "computed": true + "name": "tags", + "type": "TypeSet", + "description": "List of tags", + "min_length": 1, + "max_length": 128, + "matches": "^[A-Za-z0-9:_ .-]+$", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "network_acl", + "name": "public_gateway", "type": "TypeString", - "description": "The network ACL for this subnet", + "description": "Public Gateway of the subnet", "optional": true, "computed": true }, { - "name": "zone", + "name": "vpc", "type": "TypeString", - "description": "Subnet zone info", + "description": "VPC instance ID", "immutable": true, "required": true }, + { + "name": "resource_name", + "type": "TypeString", + "description": "The name of the resource", + "computed": true + }, { "name": "resource_crn", "type": "TypeString", @@ -122971,13 +127651,32 @@ "computed": true }, { - "name": "resource_group_name", + "name": "resource_status", "type": "TypeString", - "description": "The resource group name in which resource is provisioned", + "description": "The status of the resource", "computed": true } ], "ibm_is_subnet_network_acl_attachment": [ + { + "name": "subnet", + "type": "TypeString", + "description": "The subnet identifier", + "immutable": true, + "required": true + }, + { + "name": "network_acl", + "type": "TypeString", + "description": "The unique identifier of network ACL", + "required": true + }, + { + "name": "name", + "type": "TypeString", + "description": "Network ACL name", + "computed": true + }, { "name": "crn", "type": "TypeString", @@ -123127,64 +127826,52 @@ } } } - }, - { - "name": "subnet", - "type": "TypeString", - "description": "The subnet identifier", - "immutable": true, - "required": true - }, + } + ], + "ibm_is_subnet_public_gateway_attachment": [ { - "name": "network_acl", + "name": "public_gateway", "type": "TypeString", - "description": "The unique identifier of network ACL", + "description": "The unique identifier of public gateway", "required": true }, { "name": "name", "type": "TypeString", - "description": "Network ACL name", - "computed": true - } - ], - "ibm_is_subnet_public_gateway_attachment": [ - { - "name": "zone", - "type": "TypeString", - "description": "Public gateway zone info", + "description": "Name of the Public gateway instance", "computed": true }, { - "name": "subnet", + "name": "status", "type": "TypeString", - "description": "The subnet identifier", - "immutable": true, - "required": true + "description": "Public gateway instance status", + "computed": true }, { - "name": "public_gateway", + "name": "zone", "type": "TypeString", - "description": "The unique identifier of public gateway", - "required": true + "description": "Public gateway zone info", + "computed": true }, { - "name": "name", + "name": "resource_group_name", "type": "TypeString", - "description": "Name of the Public gateway instance", + "description": "The resource group name in which resource is provisioned", "computed": true }, { - "name": "status", + "name": "crn", "type": "TypeString", - "description": "Public gateway instance status", + "description": "The crn of the resource", + "cloud_data_type": "crn", "computed": true }, { - "name": "vpc", + "name": "subnet", "type": "TypeString", - "description": "Public gateway VPC info", - "computed": true + "description": "The subnet identifier", + "immutable": true, + "required": true }, { "name": "floating_ip", @@ -123199,63 +127886,53 @@ "computed": true }, { - "name": "resource_type", - "type": "TypeString", - "description": "The name of the resource", - "computed": true - }, - { - "name": "crn", + "name": "vpc", "type": "TypeString", - "description": "The crn of the resource", - "cloud_data_type": "crn", + "description": "Public gateway VPC info", "computed": true }, { - "name": "resource_group_name", + "name": "resource_type", "type": "TypeString", - "description": "The resource group name in which resource is provisioned", + "description": "The name of the resource", "computed": true } ], "ibm_is_subnet_reserved_ip": [ { - "name": "target_crn", - "type": "TypeString", - "description": "The crn for target.", + "name": "auto_delete", + "type": "TypeBool", + "description": "If set to true, this reserved IP will be automatically deleted", "optional": true, "computed": true }, { - "name": "lifecycle_state", - "type": "TypeString", - "description": "The lifecycle state of the reserved IP", - "computed": true - }, - { - "name": "address", + "name": "name", "type": "TypeString", - "description": "The address for this reserved IP.", - "immutable": true, + "description": "The user-defined or system-provided name for this reserved IP.", + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", "optional": true, "computed": true }, { - "name": "created_at", + "name": "target", "type": "TypeString", - "description": "The date and time that the reserved IP was created.", + "description": "The unique identifier for target.", + "optional": true, "computed": true }, { - "name": "href", + "name": "lifecycle_state", "type": "TypeString", - "description": "The URL for this reserved IP.", + "description": "The lifecycle state of the reserved IP", "computed": true }, { - "name": "resource_type", + "name": "reserved_ip", "type": "TypeString", - "description": "The resource type.", + "description": "The unique identifier of the reserved IP.", "computed": true }, { @@ -123266,66 +127943,76 @@ "required": true }, { - "name": "auto_delete", - "type": "TypeBool", - "description": "If set to true, this reserved IP will be automatically deleted", + "name": "address", + "type": "TypeString", + "description": "The address for this reserved IP.", + "immutable": true, "optional": true, "computed": true }, { - "name": "name", + "name": "created_at", "type": "TypeString", - "description": "The user-defined or system-provided name for this reserved IP.", - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", - "optional": true, + "description": "The date and time that the reserved IP was created.", "computed": true }, { - "name": "target", + "name": "href", "type": "TypeString", - "description": "The unique identifier for target.", - "optional": true, + "description": "The URL for this reserved IP.", "computed": true }, { - "name": "reserved_ip", + "name": "owner", "type": "TypeString", - "description": "The unique identifier of the reserved IP.", + "description": "The owner of a reserved IP, defining whether it is managed by the user or the provider.", "computed": true }, { - "name": "owner", + "name": "resource_type", "type": "TypeString", - "description": "The owner of a reserved IP, defining whether it is managed by the user or the provider.", + "description": "The resource type.", + "computed": true + }, + { + "name": "target_crn", + "type": "TypeString", + "description": "The crn for target.", + "optional": true, "computed": true } ], "ibm_is_subnet_routing_table_attachment": [ { - "name": "subnets", + "name": "route_vpc_zone_ingress", + "type": "TypeBool", + "description": "If true, this routing table will be used to route traffic that originates from subnets in other zones in this VPC.", + "computed": true + }, + { + "name": "routes", "type": "TypeList", "computed": true, "elem": { "id": { "name": "id", "type": "TypeString", - "description": "Subnet ID", + "description": "route ID", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "Subnet name", + "description": "route name", "computed": true } } }, { - "name": "routing_table", + "name": "subnet", "type": "TypeString", - "description": "The unique identifier of routing table", + "description": "The subnet identifier", + "immutable": true, "required": true }, { @@ -123335,15 +128022,15 @@ "computed": true }, { - "name": "name", - "type": "TypeString", - "description": "The name of the routing table", + "name": "is_default", + "type": "TypeBool", + "description": "Indicates whether this is the default routing table for this VPC", "computed": true }, { - "name": "resource_type", + "name": "lifecycle_state", "type": "TypeString", - "description": "The resource type", + "description": "he lifecycle state of the routing table [ deleting, failed, pending, stable, suspended, updating, waiting ]", "computed": true }, { @@ -123353,80 +128040,44 @@ "computed": true }, { - "name": "route_vpc_zone_ingress", - "type": "TypeBool", - "description": "If true, this routing table will be used to route traffic that originates from subnets in other zones in this VPC.", - "computed": true - }, - { - "name": "subnet", + "name": "routing_table", "type": "TypeString", - "description": "The subnet identifier", - "immutable": true, + "description": "The unique identifier of routing table", "required": true }, { - "name": "is_default", - "type": "TypeBool", - "description": "Indicates whether this is the default routing table for this VPC", + "name": "name", + "type": "TypeString", + "description": "The name of the routing table", "computed": true }, { - "name": "lifecycle_state", + "name": "resource_type", "type": "TypeString", - "description": "he lifecycle state of the routing table [ deleting, failed, pending, stable, suspended, updating, waiting ]", + "description": "The resource type", "computed": true }, { - "name": "routes", + "name": "subnets", "type": "TypeList", "computed": true, "elem": { "id": { "name": "id", "type": "TypeString", - "description": "route ID", + "description": "Subnet ID", "computed": true }, "name": { "name": "name", "type": "TypeString", - "description": "route name", + "description": "Subnet name", "computed": true } } } ], "ibm_is_virtual_endpoint_gateway": [ - { - "name": "security_groups", - "type": "TypeSet", - "description": "Endpoint gateway securitygroups list", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "resource_type", - "type": "TypeString", - "description": "Endpoint gateway resource type", - "options": "provider_cloud_service, provider_infrastructure_service", - "computed": true - }, - { - "name": "created_at", - "type": "TypeString", - "description": "Endpoint gateway created date and time", - "computed": true - }, - { - "name": "health_state", - "type": "TypeString", - "description": "Endpoint gateway health state", - "computed": true - }, { "name": "vpc", "type": "TypeString", @@ -123444,6 +128095,13 @@ "max_length": 63, "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" }, + { + "name": "resource_type", + "type": "TypeString", + "description": "Endpoint gateway resource type", + "options": "provider_cloud_service, provider_infrastructure_service", + "computed": true + }, { "name": "resource_group", "type": "TypeString", @@ -123454,47 +128112,14 @@ "computed": true }, { - "name": "lifecycle_state", - "type": "TypeString", - "description": "Endpoint gateway lifecycle state", - "computed": true - }, - { - "name": "target", - "type": "TypeList", - "description": "Endpoint gateway target", - "required": true, + "name": "security_groups", + "type": "TypeSet", + "description": "Endpoint gateway securitygroups list", + "optional": true, + "computed": true, "elem": { - "crn": { - "name": "crn", - "type": "TypeString", - "description": "The target crn", - "immutable": true, - "optional": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "The target name", - "immutable": true, - "optional": true - }, - "resource_type": { - "name": "resource_type", - "type": "TypeString", - "description": "The target resource type", - "required": true - } - }, - "max_items": 1, - "min_items": 1 - }, - { - "name": "crn", - "type": "TypeString", - "description": "The CRN for this Endpoint gateway", - "cloud_data_type": "crn", - "computed": true + "type": "TypeString" + } }, { "name": "ips", @@ -123537,6 +128162,56 @@ } } }, + { + "name": "target", + "type": "TypeList", + "description": "Endpoint gateway target", + "required": true, + "elem": { + "crn": { + "name": "crn", + "type": "TypeString", + "description": "The target crn", + "immutable": true, + "optional": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The target name", + "immutable": true, + "optional": true + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The target resource type", + "required": true + } + }, + "max_items": 1, + "min_items": 1 + }, + { + "name": "crn", + "type": "TypeString", + "description": "The CRN for this Endpoint gateway", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "health_state", + "type": "TypeString", + "description": "Endpoint gateway health state", + "computed": true + }, + { + "name": "allow_dns_resolution_binding", + "type": "TypeBool", + "description": "Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true.", + "optional": true, + "computed": true + }, { "name": "tags", "type": "TypeSet", @@ -123551,19 +128226,31 @@ } }, { - "name": "access_tags", - "type": "TypeSet", - "description": "List of access management tags", - "optional": true, + "name": "created_at", + "type": "TypeString", + "description": "Endpoint gateway created date and time", + "computed": true + }, + { + "name": "service_endpoints", + "type": "TypeList", + "description": "The fully qualified domain names for the target service. A fully qualified domain name for the target service", "computed": true, "elem": { "type": "TypeString" } }, { - "name": "service_endpoints", - "type": "TypeList", - "description": "The fully qualified domain names for the target service. A fully qualified domain name for the target service", + "name": "lifecycle_state", + "type": "TypeString", + "description": "Endpoint gateway lifecycle state", + "computed": true + }, + { + "name": "access_tags", + "type": "TypeSet", + "description": "List of access management tags", + "optional": true, "computed": true, "elem": { "type": "TypeString" @@ -123644,109 +128331,50 @@ ], "ibm_is_volume": [ { - "name": "encryption_type", + "name": "resource_crn", "type": "TypeString", - "description": "Volume encryption type info", + "description": "The crn of the resource", "computed": true }, { - "name": "crn", + "name": "resource_status", "type": "TypeString", - "description": "CRN value for the volume instance", - "cloud_data_type": "crn", + "description": "The status of the resource", "computed": true }, { - "name": "resource_controller_url", - "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", + "name": "bandwidth", + "type": "TypeInt", + "description": "The maximum bandwidth (in megabits per second) for the volume", "computed": true }, { - "name": "operating_system", - "type": "TypeList", - "description": "The operating system associated with this volume. If absent, this volume was notcreated from an image, or the image did not include an operating system.", - "computed": true, - "elem": { - "architecture": { - "name": "architecture", - "type": "TypeString", - "description": "The operating system architecture.", - "computed": true - }, - "dedicated_host_only": { - "name": "dedicated_host_only", - "type": "TypeBool", - "description": "Images with this operating system can only be used on dedicated hosts or dedicated host groups.", - "computed": true - }, - "display_name": { - "name": "display_name", - "type": "TypeString", - "description": "A unique, display-friendly name for the operating system.", - "computed": true - }, - "family": { - "name": "family", - "type": "TypeString", - "description": "The software family for this operating system.", - "computed": true - }, - "href": { - "name": "href", - "type": "TypeString", - "description": "The URL for this operating system.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "The globally unique name for this operating system.", - "computed": true - }, - "vendor": { - "name": "vendor", - "type": "TypeString", - "description": "The vendor of the operating system.", - "computed": true - }, - "version": { - "name": "version", - "type": "TypeString", - "description": "The major release version of this operating system.", - "computed": true - } - } - }, - { - "name": "zone", + "name": "profile", "type": "TypeString", - "description": "Zone name", - "immutable": true, - "required": true + "description": "Volume profile name", + "required": true, + "options": "general-purpose, 5iops-tier, 10iops-tier, custom" }, { - "name": "resource_group", - "type": "TypeString", - "description": "Resource group name", - "cloud_data_type": "resource_group", - "immutable": true, + "name": "capacity", + "type": "TypeInt", + "description": "Volume capacity value", + "min_value": "10", + "max_value": "16000", "optional": true, "computed": true }, { - "name": "iops", - "type": "TypeInt", - "description": "IOPS value for the Volume", - "min_value": "100", - "max_value": "48000", - "optional": true, + "name": "health_state", + "type": "TypeString", + "description": "The health of this resource.", "computed": true }, { - "name": "resource_crn", + "name": "crn", "type": "TypeString", - "description": "The crn of the resource", + "description": "CRN value for the volume instance", + "cloud_data_type": "crn", "computed": true }, { @@ -123760,33 +128388,30 @@ } }, { - "name": "resource_status", + "name": "resource_group_name", "type": "TypeString", - "description": "The status of the resource", + "description": "The resource group name in which resource is provisioned", "computed": true }, { - "name": "name", + "name": "zone", "type": "TypeString", - "description": "Volume name", - "required": true, - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" + "description": "Zone name", + "immutable": true, + "required": true }, { - "name": "encryption_key", + "name": "encryption_type", "type": "TypeString", - "description": "Volume encryption key info", - "immutable": true, - "optional": true + "description": "Volume encryption type info", + "computed": true }, { - "name": "capacity", + "name": "iops", "type": "TypeInt", - "description": "Volume capacity value", - "min_value": "10", - "max_value": "16000", + "description": "IOPS value for the Volume", + "min_value": "100", + "max_value": "48000", "optional": true, "computed": true }, @@ -123796,48 +128421,6 @@ "description": "Volume status", "computed": true }, - { - "name": "health_state", - "type": "TypeString", - "description": "The health of this resource.", - "computed": true - }, - { - "name": "delete_all_snapshots", - "type": "TypeBool", - "description": "Deletes all snapshots created from this volume", - "optional": true - }, - { - "name": "resource_group_name", - "type": "TypeString", - "description": "The resource group name in which resource is provisioned", - "computed": true - }, - { - "name": "bandwidth", - "type": "TypeInt", - "description": "The maximum bandwidth (in megabits per second) for the volume", - "computed": true - }, - { - "name": "profile", - "type": "TypeString", - "description": "Volume profile name", - "required": true, - "options": "general-purpose, 5iops-tier, 10iops-tier, custom" - }, - { - "name": "source_snapshot", - "type": "TypeString", - "description": "The unique identifier for this snapshot", - "immutable": true, - "min_length": 1, - "max_length": 64, - "matches": "^[-0-9a-z_]+$", - "optional": true, - "computed": true - }, { "name": "status_reasons", "type": "TypeList", @@ -123863,31 +128446,6 @@ } } }, - { - "name": "health_reasons", - "type": "TypeList", - "computed": true, - "elem": { - "code": { - "name": "code", - "type": "TypeString", - "description": "A snake case string succinctly identifying the reason for this health state.", - "computed": true - }, - "message": { - "name": "message", - "type": "TypeString", - "description": "An explanation of the reason for this health state.", - "computed": true - }, - "more_info": { - "name": "more_info", - "type": "TypeString", - "description": "Link to documentation about the reason for this health state.", - "computed": true - } - } - }, { "name": "tags", "type": "TypeSet", @@ -123902,127 +128460,152 @@ } }, { - "name": "resource_name", + "name": "resource_controller_url", "type": "TypeString", - "description": "The name of the resource", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", "computed": true - } - ], - "ibm_is_vpc": [ + }, { - "name": "id", + "name": "resource_name", "type": "TypeString", - "description": "Id of the ibm_is_vpc", - "cloud_data_type": "is", - "computed": true, - "cloud_data_range": [ - "service:vpc", - "resolved_to:id" - ] + "description": "The name of the resource", + "computed": true }, { - "name": "cse_source_addresses", - "type": "TypeList", - "computed": true, - "elem": { - "address": { - "name": "address", - "type": "TypeString", - "description": "Cloud service endpoint IP Address", - "computed": true - }, - "zone_name": { - "name": "zone_name", - "type": "TypeString", - "description": "Location info of CSE Address", - "computed": true - } - } + "name": "name", + "type": "TypeString", + "description": "Volume name", + "required": true, + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" }, { - "name": "no_sg_acl_rules", - "type": "TypeBool", - "description": "Delete all rules attached with default security group and default acl", - "default_value": false, + "name": "encryption_key", + "type": "TypeString", + "description": "Volume encryption key info", + "immutable": true, "optional": true }, { - "name": "resource_status", + "name": "source_snapshot", "type": "TypeString", - "description": "The status of the resource", + "description": "The unique identifier for this snapshot", + "immutable": true, + "min_length": 1, + "max_length": 64, + "matches": "^[-0-9a-z_]+$", + "optional": true, "computed": true }, { - "name": "subnets", + "name": "operating_system", "type": "TypeList", + "description": "The operating system associated with this volume. If absent, this volume was notcreated from an image, or the image did not include an operating system.", "computed": true, "elem": { - "available_ipv4_address_count": { - "name": "available_ipv4_address_count", - "type": "TypeInt", - "description": "Available IPv4 address count in the subnet", + "architecture": { + "name": "architecture", + "type": "TypeString", + "description": "The operating system architecture.", "computed": true }, - "id": { - "name": "id", + "dedicated_host_only": { + "name": "dedicated_host_only", + "type": "TypeBool", + "description": "Images with this operating system can only be used on dedicated hosts or dedicated host groups.", + "computed": true + }, + "display_name": { + "name": "display_name", "type": "TypeString", - "description": "subnet ID", + "description": "A unique, display-friendly name for the operating system.", "computed": true }, - "name": { - "name": "name", + "family": { + "name": "family", "type": "TypeString", - "description": "subent name", + "description": "The software family for this operating system.", "computed": true }, - "status": { - "name": "status", + "href": { + "name": "href", "type": "TypeString", - "description": "subnet status", + "description": "The URL for this operating system.", "computed": true }, - "total_ipv4_address_count": { - "name": "total_ipv4_address_count", - "type": "TypeInt", - "description": "Total IPv4 address count in the subnet", + "name": { + "name": "name", + "type": "TypeString", + "description": "The globally unique name for this operating system.", "computed": true }, - "zone": { - "name": "zone", + "vendor": { + "name": "vendor", "type": "TypeString", - "description": "subnet location", + "description": "The vendor of the operating system.", + "computed": true + }, + "version": { + "name": "version", + "type": "TypeString", + "description": "The major release version of this operating system.", "computed": true } } }, { - "name": "default_network_acl_name", + "name": "resource_group", "type": "TypeString", - "description": "Default Network ACL name", - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", + "description": "Resource group name", + "cloud_data_type": "resource_group", + "immutable": true, "optional": true, "computed": true }, { - "name": "access_tags", - "type": "TypeSet", - "description": "List of access management tags", - "optional": true, + "name": "health_reasons", + "type": "TypeList", "computed": true, "elem": { - "type": "TypeString" + "code": { + "name": "code", + "type": "TypeString", + "description": "A snake case string succinctly identifying the reason for this health state.", + "computed": true + }, + "message": { + "name": "message", + "type": "TypeString", + "description": "An explanation of the reason for this health state.", + "computed": true + }, + "more_info": { + "name": "more_info", + "type": "TypeString", + "description": "Link to documentation about the reason for this health state.", + "computed": true + } } }, { - "name": "name", + "name": "delete_all_snapshots", + "type": "TypeBool", + "description": "Deletes all snapshots created from this volume", + "optional": true + } + ], + "ibm_is_vpc": [ + { + "name": "id", "type": "TypeString", - "description": "VPC name", - "required": true, - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" + "description": "Id of the ibm_is_vpc", + "cloud_data_type": "is", + "computed": true, + "cloud_data_range": [ + "service:vpc", + "resolved_to:id" + ] }, { "name": "resource_group", @@ -124040,46 +128623,9 @@ "computed": true }, { - "name": "tags", - "type": "TypeSet", - "description": "List of tags", - "min_length": 1, - "max_length": 128, - "matches": "^[A-Za-z0-9:_ .-]+$", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "resource_controller_url", - "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", - "computed": true - }, - { - "name": "resource_group_name", - "type": "TypeString", - "description": "The resource group name in which resource is provisioned", - "computed": true - }, - { - "name": "default_network_acl", - "type": "TypeString", - "description": "Default network ACL ID", - "computed": true - }, - { - "name": "default_routing_table", - "type": "TypeString", - "description": "Default routing table associated with VPC", - "computed": true - }, - { - "name": "default_security_group_name", + "name": "default_network_acl_name", "type": "TypeString", - "description": "Default security group name", + "description": "Default Network ACL name", "min_length": 1, "max_length": 63, "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", @@ -124109,34 +128655,29 @@ "computed": true }, { - "name": "status", - "type": "TypeString", - "description": "VPC status", - "computed": true + "name": "access_tags", + "type": "TypeSet", + "description": "List of access management tags", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "crn", + "name": "resource_name", "type": "TypeString", - "description": "The crn of the resource", - "cloud_data_type": "crn", + "description": "The name of the resource", "computed": true }, { - "name": "address_prefix_management", + "name": "name", "type": "TypeString", - "description": "Address Prefix management value", - "default_value": "auto", - "immutable": true, - "options": "auto, manual", - "optional": true - }, - { - "name": "classic_access", - "type": "TypeBool", - "description": "Set to true if classic access needs to enabled to VPC", - "default_value": false, - "immutable": true, - "optional": true + "description": "VPC name", + "required": true, + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" }, { "name": "security_group", @@ -124215,9 +128756,46 @@ } }, { - "name": "resource_name", + "name": "status", "type": "TypeString", - "description": "The name of the resource", + "description": "VPC status", + "computed": true + }, + { + "name": "default_security_group_name", + "type": "TypeString", + "description": "Default security group name", + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", + "optional": true, + "computed": true + }, + { + "name": "resource_status", + "type": "TypeString", + "description": "The status of the resource", + "computed": true + }, + { + "name": "default_routing_table", + "type": "TypeString", + "description": "Default routing table associated with VPC", + "computed": true + }, + { + "name": "classic_access", + "type": "TypeBool", + "description": "Set to true if classic access needs to enabled to VPC", + "default_value": false, + "immutable": true, + "optional": true + }, + { + "name": "crn", + "type": "TypeString", + "description": "The crn of the resource", + "cloud_data_type": "crn", "computed": true }, { @@ -124225,16 +128803,269 @@ "type": "TypeString", "description": "The crn of the resource", "computed": true - } - ], - "ibm_is_vpc_address_prefix": [ + }, { - "name": "vpc", + "name": "cse_source_addresses", + "type": "TypeList", + "computed": true, + "elem": { + "address": { + "name": "address", + "type": "TypeString", + "description": "Cloud service endpoint IP Address", + "computed": true + }, + "zone_name": { + "name": "zone_name", + "type": "TypeString", + "description": "Location info of CSE Address", + "computed": true + } + } + }, + { + "name": "health_state", "type": "TypeString", - "description": "VPC id", - "immutable": true, - "required": true + "description": "The health of this resource.- `ok`: No abnormal behavior detected- `degraded`: Experiencing compromised performance, capacity, or connectivity- `faulted`: Completely unreachable, inoperative, or otherwise entirely incapacitated- `inapplicable`: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of `failed` or `deleting` will have a health state of `inapplicable`. A `pending` resource may also have this state.", + "computed": true + }, + { + "name": "no_sg_acl_rules", + "type": "TypeBool", + "description": "Delete all rules attached with default security group and default acl", + "default_value": false, + "optional": true + }, + { + "name": "resource_group_name", + "type": "TypeString", + "description": "The resource group name in which resource is provisioned", + "computed": true + }, + { + "name": "subnets", + "type": "TypeList", + "computed": true, + "elem": { + "available_ipv4_address_count": { + "name": "available_ipv4_address_count", + "type": "TypeInt", + "description": "Available IPv4 address count in the subnet", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "subnet ID", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "subent name", + "computed": true + }, + "status": { + "name": "status", + "type": "TypeString", + "description": "subnet status", + "computed": true + }, + "total_ipv4_address_count": { + "name": "total_ipv4_address_count", + "type": "TypeInt", + "description": "Total IPv4 address count in the subnet", + "computed": true + }, + "zone": { + "name": "zone", + "type": "TypeString", + "description": "subnet location", + "computed": true + } + } + }, + { + "name": "default_network_acl", + "type": "TypeString", + "description": "Default network ACL ID", + "computed": true + }, + { + "name": "tags", + "type": "TypeSet", + "description": "List of tags", + "min_length": 1, + "max_length": 128, + "matches": "^[A-Za-z0-9:_ .-]+$", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "dns", + "type": "TypeList", + "description": "The DNS configuration for this VPC.", + "optional": true, + "computed": true, + "elem": { + "enable_hub": { + "name": "enable_hub", + "type": "TypeBool", + "description": "Indicates whether this VPC is enabled as a DNS name resolution hub.", + "optional": true, + "computed": true + }, + "resolution_binding_count": { + "name": "resolution_binding_count", + "type": "TypeInt", + "description": "The number of DNS resolution bindings for this VPC.", + "computed": true + }, + "resolver": { + "name": "resolver", + "type": "TypeList", + "description": "The DNS resolver configuration for the VPC.", + "optional": true, + "computed": true, + "elem": { + "configuration": { + "name": "configuration", + "type": "TypeString", + "description": "The configuration of the system DNS resolver for this VPC.- `custom_resolver`: A custom DNS resolver is configured for this VPC.- `private_resolver`: A private DNS resolver is configured for this VPC. Applicable when the VPC has either or both of the following: - at least one endpoint gateway residing in it - a [DNS Services](https://cloud.ibm.com/docs/dns-svcs) private zone configured for it- `default`: The provider default DNS resolvers are configured for this VPC. This system DNS resolver configuration is used when the VPC has: - no custom DNS resolver configured for it, and - no endpoint gateways residing in it, and - no [DNS Services](https://cloud.ibm.com/docs/dns-svcs) private zone configured for it.", + "computed": true + }, + "manual_servers": { + "name": "manual_servers", + "type": "TypeSet", + "description": "The manually specified DNS servers for this VPC.", + "optional": true, + "computed": true, + "elem": { + "address": { + "name": "address", + "type": "TypeString", + "description": "The IP address.This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.", + "optional": true, + "computed": true + }, + "zone_affinity": { + "name": "zone_affinity", + "type": "TypeString", + "description": "The name of the zone. If present, DHCP configuration for this zone will have this DNS server listed first.", + "optional": true, + "computed": true + } + } + }, + "servers": { + "name": "servers", + "type": "TypeList", + "description": "The DNS servers for this VPC. The servers are populated:- by the system when `dns.resolver.type` is `system`- using the DNS servers in `dns.resolver.vpc` when `dns.resolver.type` is `delegated`- using `dns.resolver.manual_servers` when the `dns.resolver.type` is `manual`.", + "computed": true, + "elem": { + "address": { + "name": "address", + "type": "TypeString", + "description": "The IP address.This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.", + "computed": true + }, + "zone_affinity": { + "name": "zone_affinity", + "type": "TypeString", + "description": "Zone name, if present, DHCP configuration for this zone will have this DNS server listed first.", + "computed": true + } + } + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "The type of the DNS resolver used for the VPC.- `delegated`: DNS server addresses are provided by the DNS resolver of the VPC specified in `dns.resolver.vpc`.- `manual`: DNS server addresses are specified in `dns.resolver.manual_servers`.- `system`: DNS server addresses are provided by the system.", + "optional": true, + "computed": true + }, + "vpc_crn": { + "name": "vpc_crn", + "type": "TypeString", + "description": "The VPC crn whose DNS resolver provides the DNS server addresses for this VPC.The VPC may be remote and therefore may not be directly retrievable.", + "optional": true + }, + "vpc_id": { + "name": "vpc_id", + "type": "TypeString", + "description": "The VPC id whose DNS resolver provides the DNS server addresses for this VPC.The VPC may be remote and therefore may not be directly retrievable.", + "optional": true + }, + "vpc_name": { + "name": "vpc_name", + "type": "TypeString", + "description": "The VPC name whose DNS resolver provides the DNS server addresses for this VPC.The VPC may be remote and therefore may not be directly retrievable.", + "computed": true + }, + "vpc_remote_account_id": { + "name": "vpc_remote_account_id", + "type": "TypeString", + "description": "The unique identifier for this account.", + "computed": true + }, + "vpc_remote_region": { + "name": "vpc_remote_region", + "type": "TypeString", + "description": "Region name. If present, this property indicates that the referenced resource is remote to this region, and identifies the native region.", + "computed": true + } + }, + "max_items": 1 + } + }, + "max_items": 1 + }, + { + "name": "health_reasons", + "type": "TypeList", + "description": "The reasons for the current `health_state` (if any).The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered.", + "computed": true, + "elem": { + "code": { + "name": "code", + "type": "TypeString", + "description": "A snake case string succinctly identifying the reason for this health state.", + "computed": true + }, + "message": { + "name": "message", + "type": "TypeString", + "description": "An explanation of the reason for this health state.", + "computed": true + }, + "more_info": { + "name": "more_info", + "type": "TypeString", + "description": "Link to documentation about the reason for this health state.", + "computed": true + } + } + }, + { + "name": "resource_controller_url", + "type": "TypeString", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", + "computed": true }, + { + "name": "address_prefix_management", + "type": "TypeString", + "description": "Address Prefix management value", + "default_value": "auto", + "immutable": true, + "options": "auto, manual", + "optional": true + } + ], + "ibm_is_vpc_address_prefix": [ { "name": "has_subnets", "type": "TypeBool", @@ -124279,36 +129110,251 @@ "description": "Is default prefix for this zone in this VPC", "default_value": false, "optional": true + }, + { + "name": "vpc", + "type": "TypeString", + "description": "VPC id", + "immutable": true, + "required": true } ], - "ibm_is_vpc_routing_table": [ + "ibm_is_vpc_dns_resolution_binding": [ { - "name": "route_internet_ingress", - "type": "TypeBool", - "description": "If set to true, this routing table will be used to route traffic that originates from the internet. For this to succeed, the VPC must not already have a routing table with this property set to true.", - "default_value": false, - "optional": true + "name": "lifecycle_state", + "type": "TypeString", + "description": "The lifecycle state of the DNS resolution binding.", + "computed": true }, { "name": "name", "type": "TypeString", - "description": "The user-defined name for this routing table.", - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", + "description": "The name for this DNS resolution binding. The name is unique across all DNS resolution bindings for the VPC.", "optional": true, "computed": true }, { - "name": "href", + "name": "resource_type", "type": "TypeString", - "description": "Routing table Href", + "description": "The resource type.", "computed": true }, + { + "name": "vpc", + "type": "TypeList", + "description": "The VPC bound to for DNS resolution.The VPC may be remote and therefore may not be directly retrievable.", + "immutable": true, + "required": true, + "elem": { + "crn": { + "name": "crn", + "type": "TypeString", + "description": "The CRN for this VPC.", + "optional": true, + "computed": true + }, + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this VPC.", + "optional": true, + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this VPC.", + "optional": true, + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The name for this VPC. The name is unique across all VPCs in the region.", + "computed": true + }, + "remote": { + "name": "remote", + "type": "TypeList", + "description": "If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable.", + "computed": true, + "elem": { + "account": { + "name": "account", + "type": "TypeList", + "description": "If present, this property indicates that the referenced resource is remote to thisaccount, and identifies the owning account.", + "computed": true, + "elem": { + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this account.", + "computed": true + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true + } + } + }, + "region": { + "name": "region", + "type": "TypeList", + "description": "If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region.", + "computed": true, + "elem": { + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this region.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The globally unique name for this region.", + "computed": true + } + } + } + } + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true + } + }, + "max_items": 1, + "min_items": 1 + }, + { + "name": "vpc_id", + "type": "TypeString", + "description": "The VPC identifier.", + "required": true + }, { "name": "created_at", "type": "TypeString", - "description": "Routing table Created At", + "description": "The date and time that the DNS resolution binding was created.", + "computed": true + }, + { + "name": "endpoint_gateways", + "type": "TypeList", + "description": "The endpoint gateways in the bound to VPC that are allowed to participate in this DNS resolution binding.The endpoint gateways may be remote and therefore may not be directly retrievable.", + "computed": true, + "elem": { + "crn": { + "name": "crn", + "type": "TypeString", + "description": "The CRN for this endpoint gateway.", + "computed": true + }, + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this endpoint gateway.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this endpoint gateway.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The name for this endpoint gateway. The name is unique across all endpoint gateways in the VPC.", + "computed": true + }, + "remote": { + "name": "remote", + "type": "TypeList", + "description": "If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable.", + "computed": true, + "elem": { + "account": { + "name": "account", + "type": "TypeList", + "description": "If present, this property indicates that the referenced resource is remote to thisaccount, and identifies the owning account.", + "computed": true, + "elem": { + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this account.", + "computed": true + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true + } + } + }, + "region": { + "name": "region", + "type": "TypeList", + "description": "If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region.", + "computed": true, + "elem": { + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this region.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The globally unique name for this region.", + "computed": true + } + } + } + } + }, + "resource_type": { + "name": "resource_type", + "type": "TypeString", + "description": "The resource type.", + "computed": true + } + } + }, + { + "name": "href", + "type": "TypeString", + "description": "The URL for this DNS resolution binding.", + "computed": true + } + ], + "ibm_is_vpc_routing_table": [ + { + "name": "vpc", + "type": "TypeString", + "description": "The VPC identifier.", + "immutable": true, + "required": true + }, + { + "name": "route_internet_ingress", + "type": "TypeBool", + "description": "If set to true, this routing table will be used to route traffic that originates from the internet. For this to succeed, the VPC must not already have a routing table with this property set to true.", + "default_value": false, + "optional": true + }, + { + "name": "resource_type", + "type": "TypeString", + "description": "Routing table Resource Type", "computed": true }, { @@ -124318,14 +129364,10 @@ "computed": true }, { - "name": "accept_routes_from_resource_type", - "type": "TypeSet", - "description": "The filters specifying the resources that may create routes in this routing table, The resource type: vpn_gateway or vpn_server", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "created_at", + "type": "TypeString", + "description": "Routing table Created At", + "computed": true }, { "name": "route_transit_gateway_ingress", @@ -124335,29 +129377,43 @@ "optional": true }, { - "name": "routing_table", - "type": "TypeString", - "description": "The routing table identifier.", - "computed": true + "name": "route_vpc_zone_ingress", + "type": "TypeBool", + "description": "If set to true, this routing table will be used to route traffic that originates from subnets in other zones in this VPC.", + "default_value": false, + "optional": true }, { - "name": "resource_type", + "name": "name", "type": "TypeString", - "description": "Routing table Resource Type", + "description": "The user-defined name for this routing table.", + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", + "optional": true, "computed": true }, { - "name": "lifecycle_state", + "name": "routing_table", "type": "TypeString", - "description": "Routing table Lifecycle State", + "description": "The routing table identifier.", "computed": true }, { - "name": "vpc", + "name": "accept_routes_from_resource_type", + "type": "TypeSet", + "description": "The filters specifying the resources that may create routes in this routing table, The resource type: vpn_gateway or vpn_server", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "href", "type": "TypeString", - "description": "The VPC identifier.", - "immutable": true, - "required": true + "description": "Routing table Href", + "computed": true }, { "name": "subnets", @@ -124386,31 +129442,28 @@ "optional": true }, { - "name": "route_vpc_zone_ingress", - "type": "TypeBool", - "description": "If set to true, this routing table will be used to route traffic that originates from subnets in other zones in this VPC.", - "default_value": false, - "optional": true + "name": "lifecycle_state", + "type": "TypeString", + "description": "Routing table Lifecycle State", + "computed": true } ], "ibm_is_vpc_routing_table_route": [ { - "name": "href", - "type": "TypeString", - "description": "Routing table route Href", - "computed": true - }, - { - "name": "created_at", + "name": "routing_table", "type": "TypeString", - "description": "Routing table route Created At", - "computed": true + "description": "The routing table identifier.", + "immutable": true, + "required": true }, { - "name": "lifecycle_state", + "name": "action", "type": "TypeString", - "description": "Routing table route Lifecycle State", - "computed": true + "description": "The action to perform with a packet matching the route.", + "default_value": "deliver", + "immutable": true, + "options": "delegate, delegate_vpc, deliver, drop", + "optional": true }, { "name": "name", @@ -124443,31 +129496,15 @@ "required": true }, { - "name": "origin", + "name": "href", "type": "TypeString", - "description": "The origin of this route.", + "description": "Routing table route Href", "computed": true }, { - "name": "routing_table", - "type": "TypeString", - "description": "The routing table identifier.", - "immutable": true, - "required": true - }, - { - "name": "route_id", + "name": "created_at", "type": "TypeString", - "description": "The routing table route identifier.", - "computed": true - }, - { - "name": "priority", - "type": "TypeInt", - "description": "The route's priority. Smaller values have higher priority.", - "min_value": "0", - "max_value": "4", - "optional": true, + "description": "Routing table route Created At", "computed": true }, { @@ -124530,20 +129567,93 @@ } }, { - "name": "action", + "name": "route_id", "type": "TypeString", - "description": "The action to perform with a packet matching the route.", - "default_value": "deliver", - "immutable": true, - "options": "delegate, delegate_vpc, deliver, drop", - "optional": true + "description": "The routing table route identifier.", + "computed": true + }, + { + "name": "lifecycle_state", + "type": "TypeString", + "description": "Routing table route Lifecycle State", + "computed": true + }, + { + "name": "priority", + "type": "TypeInt", + "description": "The route's priority. Smaller values have higher priority.", + "min_value": "0", + "max_value": "4", + "optional": true, + "computed": true + }, + { + "name": "origin", + "type": "TypeString", + "description": "The origin of this route.", + "computed": true } ], "ibm_is_vpn_gateway": [ { - "name": "private_ip_address", + "name": "subnet", "type": "TypeString", - "description": "The Private IP address assigned to the VPN gateway member.", + "description": "VPNGateway subnet info", + "immutable": true, + "required": true + }, + { + "name": "resource_name", + "type": "TypeString", + "description": "The name of the resource", + "computed": true + }, + { + "name": "resource_status", + "type": "TypeString", + "description": "The status of the resource", + "computed": true + }, + { + "name": "resource_group_name", + "type": "TypeString", + "description": "The resource group name in which resource is provisioned", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "VPN Gateway instance name", + "required": true, + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" + }, + { + "name": "resource_group", + "type": "TypeString", + "description": "The resource group for this VPN gateway", + "cloud_data_type": "resource_group", + "immutable": true, + "optional": true, + "computed": true + }, + { + "name": "status", + "type": "TypeString", + "description": "The status of the VPN gateway", + "computed": true + }, + { + "name": "public_ip_address", + "type": "TypeString", + "description": "The public IP address assigned to the VPN gateway member.", + "computed": true + }, + { + "name": "public_ip_address2", + "type": "TypeString", + "description": "The second public IP address assigned to the VPN gateway member.", "computed": true }, { @@ -124572,27 +129682,47 @@ "computed": true }, { - "name": "resource_name", + "name": "resource_crn", "type": "TypeString", - "description": "The name of the resource", + "description": "The crn of the resource", "computed": true }, { - "name": "resource_group_name", + "name": "created_at", "type": "TypeString", - "description": "The resource group name in which resource is provisioned", + "description": "Created Time of the VPN Gateway", "computed": true }, { - "name": "status", + "name": "mode", "type": "TypeString", - "description": "The status of the VPN gateway", + "description": "mode in VPN gateway(route/policy)", + "default_value": "route", + "immutable": true, + "options": "route,policy", + "optional": true + }, + { + "name": "private_ip_address", + "type": "TypeString", + "description": "The Private IP address assigned to the VPN gateway member.", "computed": true }, { - "name": "public_ip_address2", + "name": "access_tags", + "type": "TypeSet", + "description": "List of access management tags", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "crn", "type": "TypeString", - "description": "The second public IP address assigned to the VPN gateway member.", + "description": "The crn of the resource", + "cloud_data_type": "crn", "computed": true }, { @@ -124627,65 +129757,6 @@ } } }, - { - "name": "created_at", - "type": "TypeString", - "description": "Created Time of the VPN Gateway", - "computed": true - }, - { - "name": "mode", - "type": "TypeString", - "description": "mode in VPN gateway(route/policy)", - "default_value": "route", - "immutable": true, - "options": "route,policy", - "optional": true - }, - { - "name": "crn", - "type": "TypeString", - "description": "The crn of the resource", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "resource_status", - "type": "TypeString", - "description": "The status of the resource", - "computed": true - }, - { - "name": "access_tags", - "type": "TypeSet", - "description": "List of access management tags", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "resource_crn", - "type": "TypeString", - "description": "The crn of the resource", - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "VPN Gateway instance name", - "required": true, - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" - }, - { - "name": "public_ip_address", - "type": "TypeString", - "description": "The public IP address assigned to the VPN gateway member.", - "computed": true - }, { "name": "vpc", "type": "TypeList", @@ -124731,61 +129802,9 @@ "computed": true } } - }, - { - "name": "subnet", - "type": "TypeString", - "description": "VPNGateway subnet info", - "immutable": true, - "required": true - }, - { - "name": "resource_group", - "type": "TypeString", - "description": "The resource group for this VPN gateway", - "cloud_data_type": "resource_group", - "immutable": true, - "optional": true, - "computed": true } ], "ibm_is_vpn_gateway_connection": [ - { - "name": "status", - "type": "TypeString", - "description": "VPN gateway connection status", - "computed": true - }, - { - "name": "resource_type", - "type": "TypeString", - "description": "The resource type", - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "VPN Gateway connection name", - "required": true, - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" - }, - { - "name": "preshared_key", - "type": "TypeString", - "description": "vpn gateway", - "required": true - }, - { - "name": "timeout", - "type": "TypeInt", - "description": "Timeout for dead peer detection", - "default_value": 10, - "min_value": "2", - "max_value": "86399", - "optional": true - }, { "name": "ipsec_policy", "type": "TypeString", @@ -124799,15 +129818,9 @@ "optional": true }, { - "name": "gateway_connection", - "type": "TypeString", - "description": "The unique identifier for this VPN gateway connection", - "computed": true - }, - { - "name": "peer_address", + "name": "preshared_key", "type": "TypeString", - "description": "VPN gateway connection peer address", + "description": "vpn gateway", "required": true }, { @@ -124836,11 +129849,16 @@ "required": true }, { - "name": "admin_state_up", - "type": "TypeBool", - "description": "VPN gateway connection admin state", - "default_value": false, - "optional": true + "name": "gateway_connection", + "type": "TypeString", + "description": "The unique identifier for this VPN gateway connection", + "computed": true + }, + { + "name": "status", + "type": "TypeString", + "description": "VPN gateway connection status", + "computed": true }, { "name": "mode", @@ -124849,14 +129867,13 @@ "computed": true }, { - "name": "peer_cidrs", - "type": "TypeSet", - "description": "VPN gateway connection peer CIDRs", - "immutable": true, - "optional": true, - "elem": { - "type": "TypeString" - } + "name": "name", + "type": "TypeString", + "description": "VPN Gateway connection name", + "required": true, + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$" }, { "name": "interval", @@ -124867,6 +129884,21 @@ "max_value": "86399", "optional": true }, + { + "name": "authentication_mode", + "type": "TypeString", + "description": "The authentication mode", + "computed": true + }, + { + "name": "timeout", + "type": "TypeInt", + "description": "Timeout for dead peer detection", + "default_value": 10, + "min_value": "2", + "max_value": "86399", + "optional": true + }, { "name": "related_crn", "type": "TypeString", @@ -124874,9 +129906,9 @@ "computed": true }, { - "name": "authentication_mode", + "name": "resource_type", "type": "TypeString", - "description": "The authentication mode", + "description": "The resource type", "computed": true }, { @@ -124904,33 +129936,32 @@ "computed": true } } - } - ], - "ibm_is_vpn_server": [ + }, { - "name": "crn", + "name": "peer_address", "type": "TypeString", - "description": "The CRN for this VPN server.", - "cloud_data_type": "crn", - "computed": true + "description": "VPN gateway connection peer address", + "required": true }, { - "name": "subnets", + "name": "admin_state_up", + "type": "TypeBool", + "description": "VPN gateway connection admin state", + "default_value": false, + "optional": true + }, + { + "name": "peer_cidrs", "type": "TypeSet", - "description": "The unique identifier for this subnet. The subnets to provision this VPN server in. Use subnets in different zones for high availability.", - "required": true, + "description": "VPN gateway connection peer CIDRs", + "immutable": true, + "optional": true, "elem": { "type": "TypeString" - }, - "max_items": 2, - "min_items": 1 - }, - { - "name": "certificate_crn", - "type": "TypeString", - "description": "The crn of certificate instance for this VPN server.", - "required": true - }, + } + } + ], + "ibm_is_vpn_server": [ { "name": "client_auto_delete_timeout", "type": "TypeInt", @@ -124938,26 +129969,26 @@ "computed": true }, { - "name": "enable_split_tunneling", - "type": "TypeBool", - "description": "Indicates whether the split tunneling is enabled on this VPN server.", - "default_value": false, - "optional": true + "name": "client_dns_server_ips", + "type": "TypeSet", + "description": "The DNS server addresses that will be provided to VPN clients connected to this VPN server. The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.", + "optional": true, + "elem": { + "type": "TypeString" + } }, { - "name": "href", + "name": "crn", "type": "TypeString", - "description": "The URL for this VPN server.", + "description": "The CRN for this VPN server.", + "cloud_data_type": "crn", "computed": true }, { - "name": "name", + "name": "health_state", "type": "TypeString", - "description": "The user-defined name for this VPN server. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the VPC this VPN server is serving.", - "min_length": 1, - "max_length": 63, - "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", - "optional": true + "description": "The health of this resource.- `ok`: Healthy- `degraded`: Suffering from compromised performance, capacity, or connectivity- `faulted`: Completely unreachable, inoperative, or otherwise entirely incapacitated- `inapplicable`: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of `failed` or `deleting` will have a health state of `inapplicable`. A `pending` resource may also have this state.", + "computed": true }, { "name": "private_ips", @@ -125012,70 +130043,15 @@ } }, { - "name": "protocol", - "type": "TypeString", - "description": "The transport protocol to use for this VPN server.", - "default_value": "udp", - "options": "tcp, udp", - "optional": true - }, - { - "name": "security_groups", + "name": "access_tags", "type": "TypeSet", - "description": "The unique identifier for this security group. The security groups to use for this VPN server. If unspecified, the VPC's default security group is used.", - "immutable": true, + "description": "List of access management tags", "optional": true, "computed": true, "elem": { "type": "TypeString" } }, - { - "name": "vpc", - "type": "TypeList", - "description": "The VPC this VPN server resides in.", - "computed": true, - "elem": { - "crn": { - "name": "crn", - "type": "TypeString", - "description": "The CRN for this VPC.", - "computed": true - }, - "deleted": { - "name": "deleted", - "type": "TypeList", - "description": "If present, this property indicates the referenced resource has been deleted and providessome supplementary information.", - "computed": true, - "elem": { - "more_info": { - "name": "more_info", - "type": "TypeString", - "description": "Link to documentation about deleted resources.", - "computed": true - } - } - }, - "href": { - "name": "href", - "type": "TypeString", - "description": "The URL for this VPC.", - "computed": true - }, - "id": { - "name": "id", - "type": "TypeString", - "description": "The unique identifier for this VPC.", - "computed": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "The unique user-defined name for this VPC.", - "computed": true - } - } - }, { "name": "client_authentication", "type": "TypeList", @@ -125104,20 +130080,26 @@ "max_items": 2 }, { - "name": "client_dns_server_ips", - "type": "TypeSet", - "description": "The DNS server addresses that will be provided to VPN clients connected to this VPN server. The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.", - "optional": true, - "elem": { - "type": "TypeString" - } + "name": "enable_split_tunneling", + "type": "TypeBool", + "description": "Indicates whether the split tunneling is enabled on this VPN server.", + "default_value": false, + "optional": true }, { - "name": "created_at", + "name": "vpn_server", "type": "TypeString", - "description": "The date and time that the VPN server was created.", + "description": "The unique identifier for this VPN server.", "computed": true }, + { + "name": "protocol", + "type": "TypeString", + "description": "The transport protocol to use for this VPN server.", + "default_value": "udp", + "options": "tcp, udp", + "optional": true + }, { "name": "resource_group", "type": "TypeString", @@ -125127,6 +130109,17 @@ "optional": true, "computed": true }, + { + "name": "subnets", + "type": "TypeSet", + "description": "The unique identifier for this subnet. The subnets to provision this VPN server in. Use subnets in different zones for high availability.", + "required": true, + "elem": { + "type": "TypeString" + }, + "max_items": 2, + "min_items": 1 + }, { "name": "resource_type", "type": "TypeString", @@ -125135,14 +130128,10 @@ "optional": true }, { - "name": "access_tags", - "type": "TypeSet", - "description": "List of access management tags", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "certificate_crn", + "type": "TypeString", + "description": "The crn of certificate instance for this VPN server.", + "required": true }, { "name": "client_auto_delete", @@ -125167,21 +130156,32 @@ "matches": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/(3[0-2]|[1-2][0-9]|[0-9]))$" }, { - "name": "health_state", + "name": "hostname", "type": "TypeString", - "description": "The health of this resource.- `ok`: Healthy- `degraded`: Suffering from compromised performance, capacity, or connectivity- `faulted`: Completely unreachable, inoperative, or otherwise entirely incapacitated- `inapplicable`: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of `failed` or `deleting` will have a health state of `inapplicable`. A `pending` resource may also have this state.", + "description": "Fully qualified domain name assigned to this VPN server.", "computed": true }, { - "name": "hostname", + "name": "security_groups", + "type": "TypeSet", + "description": "The unique identifier for this security group. The security groups to use for this VPN server. If unspecified, the VPC's default security group is used.", + "immutable": true, + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "created_at", "type": "TypeString", - "description": "Fully qualified domain name assigned to this VPN server.", + "description": "The date and time that the VPN server was created.", "computed": true }, { - "name": "vpn_server", + "name": "href", "type": "TypeString", - "description": "The unique identifier for this VPN server.", + "description": "The URL for this VPN server.", "computed": true }, { @@ -125190,6 +130190,15 @@ "description": "The lifecycle state of the VPN server.", "computed": true }, + { + "name": "name", + "type": "TypeString", + "description": "The user-defined name for this VPN server. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the VPC this VPN server is serving.", + "min_length": 1, + "max_length": 63, + "matches": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", + "optional": true + }, { "name": "port", "type": "TypeInt", @@ -125198,9 +130207,67 @@ "min_value": "1", "max_value": "65535", "optional": true + }, + { + "name": "vpc", + "type": "TypeList", + "description": "The VPC this VPN server resides in.", + "computed": true, + "elem": { + "crn": { + "name": "crn", + "type": "TypeString", + "description": "The CRN for this VPC.", + "computed": true + }, + "deleted": { + "name": "deleted", + "type": "TypeList", + "description": "If present, this property indicates the referenced resource has been deleted and providessome supplementary information.", + "computed": true, + "elem": { + "more_info": { + "name": "more_info", + "type": "TypeString", + "description": "Link to documentation about deleted resources.", + "computed": true + } + } + }, + "href": { + "name": "href", + "type": "TypeString", + "description": "The URL for this VPC.", + "computed": true + }, + "id": { + "name": "id", + "type": "TypeString", + "description": "The unique identifier for this VPC.", + "computed": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The unique user-defined name for this VPC.", + "computed": true + } + } } ], "ibm_is_vpn_server_client": [ + { + "name": "status_code", + "type": "TypeInt", + "description": "status code of the result.", + "computed": true + }, + { + "name": "description", + "type": "TypeString", + "description": "description of the result.", + "computed": true + }, { "name": "vpn_server", "type": "TypeString", @@ -125221,36 +130288,9 @@ "description": "The delete to use for this VPN client to be deleted or not, when false, client is disconneted and when set to true client is deleted.", "default_value": false, "optional": true - }, - { - "name": "status_code", - "type": "TypeInt", - "description": "status code of the result.", - "computed": true - }, - { - "name": "description", - "type": "TypeString", - "description": "description of the result.", - "computed": true } ], "ibm_is_vpn_server_route": [ - { - "name": "action", - "type": "TypeString", - "description": "The action to perform with a packet matching the VPN route:- `translate`: translate the source IP address to one of the private IP addresses of the VPN server, then deliver the packet to target.- `deliver`: deliver the packet to the target.- `drop`: drop the packetThe enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the VPN route on which the unexpected property value was encountered.", - "default_value": "deliver", - "immutable": true, - "options": "deliver, drop, translate", - "optional": true - }, - { - "name": "created_at", - "type": "TypeString", - "description": "The date and time that the VPN route was created.", - "computed": true - }, { "name": "resource_type", "type": "TypeString", @@ -125265,18 +130305,19 @@ "required": true }, { - "name": "vpn_route", + "name": "href", "type": "TypeString", - "description": "The VPN route identifier.", + "description": "The URL for this VPN route.", "computed": true }, { - "name": "destination", + "name": "action", "type": "TypeString", - "description": "The destination to use for this VPN route in the VPN server. Must be unique within the VPN server. If an incoming packet does not match any destination, it will be dropped.", + "description": "The action to perform with a packet matching the VPN route:- `translate`: translate the source IP address to one of the private IP addresses of the VPN server, then deliver the packet to target.- `deliver`: deliver the packet to the target.- `drop`: drop the packetThe enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the VPN route on which the unexpected property value was encountered.", + "default_value": "deliver", "immutable": true, - "required": true, - "matches": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/(3[0-2]|[1-2][0-9]|[0-9]))$" + "options": "deliver, drop, translate", + "optional": true }, { "name": "name", @@ -125289,9 +130330,9 @@ "computed": true }, { - "name": "href", + "name": "created_at", "type": "TypeString", - "description": "The URL for this VPN route.", + "description": "The date and time that the VPN route was created.", "computed": true }, { @@ -125299,13 +130340,27 @@ "type": "TypeString", "description": "The lifecycle state of the VPN route.", "computed": true + }, + { + "name": "vpn_route", + "type": "TypeString", + "description": "The VPN route identifier.", + "computed": true + }, + { + "name": "destination", + "type": "TypeString", + "description": "The destination to use for this VPN route in the VPN server. Must be unique within the VPN server. If an incoming packet does not match any destination, it will be dropped.", + "immutable": true, + "required": true, + "matches": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/(3[0-2]|[1-2][0-9]|[0-9]))$" } ], "ibm_kms_instance_policies": [ { - "name": "dual_auth_delete", + "name": "metrics", "type": "TypeList", - "description": "Data associated with the dual authorization delete policy for instance", + "description": "Data associated with the metric policy for instance", "optional": true, "elem": { "created_by": { @@ -125323,7 +130378,7 @@ "enabled": { "name": "enabled", "type": "TypeBool", - "description": "If set to true, Key Protect enables a dual authorization policy for the instance.", + "description": "If set to true, Key Protect enables a metrics policy on the instance.", "required": true }, "last_updated": { @@ -125342,9 +130397,20 @@ "max_items": 1 }, { - "name": "rotation", + "name": "instance_id", + "type": "TypeString", + "description": "Key protect or hpcs instance GUID or CRN", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true, + "cloud_data_range": [ + "service:kms|hs-crypto" + ] + }, + { + "name": "dual_auth_delete", "type": "TypeList", - "description": "Data associated with the rotation policy for instance", + "description": "Data associated with the dual authorization delete policy for instance", "optional": true, "elem": { "created_by": { @@ -125362,15 +130428,9 @@ "enabled": { "name": "enabled", "type": "TypeBool", - "description": "If set to true, Key Protect enables a rotation policy for the instance.", + "description": "If set to true, Key Protect enables a dual authorization policy for the instance.", "required": true }, - "interval_month": { - "name": "interval_month", - "type": "TypeInt", - "description": "Specifies the rotation time interval in months for the instance.", - "optional": true - }, "last_updated": { "name": "last_updated", "type": "TypeString", @@ -125387,25 +130447,11 @@ "max_items": 1 }, { - "name": "key_create_import_access", + "name": "rotation", "type": "TypeList", - "description": "Data associated with the key create import access policy for the instance", + "description": "Data associated with the rotation policy for instance", "optional": true, "elem": { - "create_root_key": { - "name": "create_root_key", - "type": "TypeBool", - "description": "If set to true, Key Protect allows you or any authorized users to create root keys in the instance.", - "default_value": true, - "optional": true - }, - "create_standard_key": { - "name": "create_standard_key", - "type": "TypeBool", - "description": "If set to true, Key Protect allows you or any authorized users to create standard keys in the instance.", - "default_value": true, - "optional": true - }, "created_by": { "name": "created_by", "type": "TypeString", @@ -125421,28 +130467,13 @@ "enabled": { "name": "enabled", "type": "TypeBool", - "description": "If set to true, Key Protect enables a KCIA policy for the instance.", + "description": "If set to true, Key Protect enables a rotation policy for the instance.", "required": true }, - "enforce_token": { - "name": "enforce_token", - "type": "TypeBool", - "description": "If set to true, the service prevents you or any authorized users from importing key material into the specified service instance without using an import token.", - "default_value": false, - "optional": true - }, - "import_root_key": { - "name": "import_root_key", - "type": "TypeBool", - "description": "If set to true, Key Protect allows you or any authorized users to import root keys into the instance.", - "default_value": true, - "optional": true - }, - "import_standard_key": { - "name": "import_standard_key", - "type": "TypeBool", - "description": "If set to true, Key Protect allows you or any authorized users to import standard keys into the instance.", - "default_value": true, + "interval_month": { + "name": "interval_month", + "type": "TypeInt", + "description": "Specifies the rotation time interval in months for the instance.", "optional": true }, "last_updated": { @@ -125461,11 +130492,25 @@ "max_items": 1 }, { - "name": "metrics", + "name": "key_create_import_access", "type": "TypeList", - "description": "Data associated with the metric policy for instance", + "description": "Data associated with the key create import access policy for the instance", "optional": true, "elem": { + "create_root_key": { + "name": "create_root_key", + "type": "TypeBool", + "description": "If set to true, Key Protect allows you or any authorized users to create root keys in the instance.", + "default_value": true, + "optional": true + }, + "create_standard_key": { + "name": "create_standard_key", + "type": "TypeBool", + "description": "If set to true, Key Protect allows you or any authorized users to create standard keys in the instance.", + "default_value": true, + "optional": true + }, "created_by": { "name": "created_by", "type": "TypeString", @@ -125481,9 +130526,30 @@ "enabled": { "name": "enabled", "type": "TypeBool", - "description": "If set to true, Key Protect enables a metrics policy on the instance.", + "description": "If set to true, Key Protect enables a KCIA policy for the instance.", "required": true }, + "enforce_token": { + "name": "enforce_token", + "type": "TypeBool", + "description": "If set to true, the service prevents you or any authorized users from importing key material into the specified service instance without using an import token.", + "default_value": false, + "optional": true + }, + "import_root_key": { + "name": "import_root_key", + "type": "TypeBool", + "description": "If set to true, Key Protect allows you or any authorized users to import root keys into the instance.", + "default_value": true, + "optional": true + }, + "import_standard_key": { + "name": "import_standard_key", + "type": "TypeBool", + "description": "If set to true, Key Protect allows you or any authorized users to import standard keys into the instance.", + "default_value": true, + "optional": true + }, "last_updated": { "name": "last_updated", "type": "TypeString", @@ -125498,35 +130564,39 @@ } }, "max_items": 1 - }, - { - "name": "instance_id", - "type": "TypeString", - "description": "Key protect or hpcs instance GUID or CRN", - "cloud_data_type": "resource_instance", - "immutable": true, - "required": true, - "cloud_data_range": [ - "service:kms|hs-crypto" - ] } ], "ibm_kms_key": [ { - "name": "instance_id", + "name": "key_id", "type": "TypeString", - "description": "Key protect or hpcs instance GUID or CRN", - "cloud_data_type": "resource_instance", + "description": "Key ID", + "computed": true + }, + { + "name": "key_name", + "type": "TypeString", + "description": "Key name", "immutable": true, - "required": true, - "cloud_data_range": [ - "service:kms|hs-crypto" - ] + "required": true }, { - "name": "encrypted_nonce", + "name": "resource_crn", "type": "TypeString", - "description": "Only for imported root key", + "description": "The crn of the resource", + "computed": true + }, + { + "name": "resource_status", + "type": "TypeString", + "description": "The status of the resource", + "computed": true + }, + { + "name": "key_ring_id", + "type": "TypeString", + "description": "Key Ring for the Key", + "default_value": "default", "immutable": true, "optional": true }, @@ -125537,6 +130607,12 @@ "default_value": false, "optional": true }, + { + "name": "instance_crn", + "type": "TypeString", + "description": "Key protect or hpcs instance CRN", + "computed": true + }, { "name": "expiration_date", "type": "TypeString", @@ -125545,9 +130621,9 @@ "optional": true }, { - "name": "resource_group_name", + "name": "resource_name", "type": "TypeString", - "description": "The resource group name in which resource is provisioned", + "description": "The name of the resource", "computed": true }, { @@ -125557,94 +130633,103 @@ "computed": true }, { - "name": "key_ring_id", + "name": "instance_id", "type": "TypeString", - "description": "Key Ring for the Key", - "default_value": "default", + "description": "Key protect or hpcs instance GUID or CRN", + "cloud_data_type": "resource_instance", "immutable": true, - "optional": true + "required": true, + "cloud_data_range": [ + "service:kms|hs-crypto" + ] }, { - "name": "endpoint_type", + "name": "type", "type": "TypeString", - "description": "public or private", - "optional": true, + "description": "type of service hs-crypto or kms", "computed": true }, { - "name": "payload", + "name": "description", "type": "TypeString", + "description": "description of the key", "immutable": true, - "optional": true, - "computed": true + "optional": true }, { - "name": "iv_value", + "name": "standard_key", + "type": "TypeBool", + "description": "Standard key type", + "default_value": false, + "immutable": true, + "optional": true + }, + { + "name": "encrypted_nonce", "type": "TypeString", "description": "Only for imported root key", "immutable": true, "optional": true }, { - "name": "crn", + "name": "endpoint_type", "type": "TypeString", - "description": "Crn of the key", - "cloud_data_type": "crn", + "description": "public or private", + "optional": true, "computed": true }, { - "name": "resource_crn", + "name": "payload", "type": "TypeString", - "description": "The crn of the resource", + "secure": true, + "immutable": true, + "optional": true, "computed": true }, { - "name": "key_name", + "name": "iv_value", "type": "TypeString", - "description": "Key name", + "description": "Only for imported root key", "immutable": true, - "required": true + "optional": true }, { - "name": "instance_crn", + "name": "crn", "type": "TypeString", - "description": "Key protect or hpcs instance CRN", + "description": "Crn of the key", + "cloud_data_type": "crn", "computed": true }, { - "name": "resource_name", + "name": "resource_group_name", "type": "TypeString", - "description": "The name of the resource", + "description": "The resource group name in which resource is provisioned", "computed": true - }, + } + ], + "ibm_kms_key_alias": [ { "name": "key_id", "type": "TypeString", "description": "Key ID", - "computed": true + "immutable": true, + "optional": true }, { - "name": "type", + "name": "existing_alias", "type": "TypeString", - "description": "type of service hs-crypto or kms", - "computed": true - }, - { - "name": "standard_key", - "type": "TypeBool", - "description": "Standard key type", - "default_value": false, + "description": "Existing Alias of the Key", "immutable": true, "optional": true }, { - "name": "resource_status", + "name": "endpoint_type", "type": "TypeString", - "description": "The status of the resource", + "description": "public or private", + "immutable": true, + "optional": true, "computed": true - } - ], - "ibm_kms_key_alias": [ + }, { "name": "instance_id", "type": "TypeString", @@ -125662,36 +130747,51 @@ "description": "Key protect or hpcs key alias name", "immutable": true, "required": true - }, + } + ], + "ibm_kms_key_policies": [ { "name": "key_id", "type": "TypeString", "description": "Key ID", - "immutable": true, "optional": true }, { - "name": "existing_alias", + "name": "endpoint_type", "type": "TypeString", - "description": "Existing Alias of the Key", + "description": "public or private", + "default_value": "public", "immutable": true, "optional": true }, { - "name": "endpoint_type", + "name": "resource_name", "type": "TypeString", - "description": "public or private", - "immutable": true, - "optional": true, + "description": "The name of the resource", "computed": true - } - ], - "ibm_kms_key_policies": [ + }, { - "name": "key_id", + "name": "resource_crn", "type": "TypeString", - "description": "Key ID", - "optional": true + "description": "The crn of the resource", + "computed": true + }, + { + "name": "resource_controller_url", + "type": "TypeString", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource", + "computed": true + }, + { + "name": "instance_id", + "type": "TypeString", + "description": "Key protect or hpcs instance GUID", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true, + "cloud_data_range": [ + "service:kms|hs-crypto" + ] }, { "name": "alias", @@ -125806,48 +130906,11 @@ } } }, - { - "name": "resource_crn", - "type": "TypeString", - "description": "The crn of the resource", - "computed": true - }, - { - "name": "instance_id", - "type": "TypeString", - "description": "Key protect or hpcs instance GUID", - "cloud_data_type": "resource_instance", - "immutable": true, - "required": true, - "cloud_data_range": [ - "service:kms|hs-crypto" - ] - }, - { - "name": "endpoint_type", - "type": "TypeString", - "description": "public or private", - "default_value": "public", - "immutable": true, - "optional": true - }, - { - "name": "resource_name", - "type": "TypeString", - "description": "The name of the resource", - "computed": true - }, { "name": "resource_status", "type": "TypeString", "description": "The status of the resource", "computed": true - }, - { - "name": "resource_controller_url", - "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource", - "computed": true } ], "ibm_kms_key_rings": [ @@ -125872,6 +130935,13 @@ "max_length": 100, "matches": "^[a-zA-Z0-9-]*$" }, + { + "name": "force_delete", + "type": "TypeBool", + "description": "set to true to force delete this key ring. This allows key ring deletion as long as all keys inside have key state equals to 5 (destroyed). Keys are moved to the default key ring.", + "default_value": false, + "optional": true + }, { "name": "endpoint_type", "type": "TypeString", @@ -125883,31 +130953,9 @@ ], "ibm_kms_key_with_policy_overrides": [ { - "name": "key_id", - "type": "TypeString", - "description": "Key ID", - "computed": true - }, - { - "name": "standard_key", - "type": "TypeBool", - "description": "Standard key type", - "default_value": false, - "immutable": true, - "optional": true - }, - { - "name": "iv_value", - "type": "TypeString", - "description": "Only for imported root key", - "immutable": true, - "optional": true - }, - { - "name": "crn", + "name": "resource_status", "type": "TypeString", - "description": "Crn of the key", - "cloud_data_type": "crn", + "description": "The status of the resource", "computed": true }, { @@ -125922,25 +130970,34 @@ ] }, { - "name": "key_ring_id", - "type": "TypeString", - "description": "Key Ring for the Key", - "default_value": "default", + "name": "standard_key", + "type": "TypeBool", + "description": "Standard key type", + "default_value": false, "immutable": true, "optional": true }, { - "name": "key_name", + "name": "payload", "type": "TypeString", - "description": "Key name", + "secure": true, "immutable": true, - "required": true + "optional": true, + "computed": true }, { - "name": "instance_crn", + "name": "iv_value", "type": "TypeString", - "description": "Key protect or HPCS instance CRN", - "computed": true + "description": "Only for imported root key", + "immutable": true, + "optional": true + }, + { + "name": "force_delete", + "type": "TypeBool", + "description": "set to true to force delete the key", + "default_value": false, + "optional": true }, { "name": "resource_name", @@ -125949,30 +131006,41 @@ "computed": true }, { - "name": "resource_crn", + "name": "resource_controller_url", "type": "TypeString", - "description": "The crn of the resource", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource", "computed": true }, { - "name": "resource_status", + "name": "description", "type": "TypeString", - "description": "The status of the resource", - "computed": true + "description": "description of the key", + "immutable": true, + "optional": true }, { - "name": "type", + "name": "key_ring_id", "type": "TypeString", - "description": "Type of service hs-crypto or kms", - "computed": true + "description": "Key Ring for the Key", + "default_value": "default", + "immutable": true, + "optional": true }, { - "name": "payload", + "name": "endpoint_type", "type": "TypeString", + "description": "Public or Private", "immutable": true, "optional": true, "computed": true }, + { + "name": "crn", + "type": "TypeString", + "description": "Crn of the key", + "cloud_data_type": "crn", + "computed": true + }, { "name": "expiration_date", "type": "TypeString", @@ -125981,47 +131049,22 @@ "optional": true }, { - "name": "dual_auth_delete", - "type": "TypeList", - "description": "Data associated with the dual authorization delete policy.", - "optional": true, - "computed": true, - "elem": { - "enabled": { - "name": "enabled", - "type": "TypeBool", - "description": "If set to true, Key Protect enables a dual authorization policy on a single key.", - "required": true - } - } - }, - { - "name": "resource_controller_url", + "name": "resource_group_name", "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource", + "description": "The resource group name in which resource is provisioned", "computed": true }, { - "name": "endpoint_type", + "name": "type", "type": "TypeString", - "description": "Public or Private", - "immutable": true, - "optional": true, + "description": "Type of service hs-crypto or kms", "computed": true }, { - "name": "encrypted_nonce", + "name": "instance_crn", "type": "TypeString", - "description": "Only for imported root key", - "immutable": true, - "optional": true - }, - { - "name": "force_delete", - "type": "TypeBool", - "description": "set to true to force delete the key", - "default_value": false, - "optional": true + "description": "Key protect or HPCS instance CRN", + "computed": true }, { "name": "rotation", @@ -126045,13 +131088,32 @@ } }, { - "name": "resource_group_name", + "name": "dual_auth_delete", + "type": "TypeList", + "description": "Data associated with the dual authorization delete policy.", + "optional": true, + "computed": true, + "elem": { + "enabled": { + "name": "enabled", + "type": "TypeBool", + "description": "If set to true, Key Protect enables a dual authorization policy on a single key.", + "required": true + } + } + }, + { + "name": "resource_crn", "type": "TypeString", - "description": "The resource group name in which resource is provisioned", + "description": "The crn of the resource", "computed": true - } - ], - "ibm_kp_key": [ + }, + { + "name": "key_id", + "type": "TypeString", + "description": "Key ID", + "computed": true + }, { "name": "key_name", "type": "TypeString", @@ -126060,13 +131122,14 @@ "required": true }, { - "name": "standard_key", - "type": "TypeBool", - "description": "Standard key type", - "default_value": false, + "name": "encrypted_nonce", + "type": "TypeString", + "description": "Only for imported root key", "immutable": true, "optional": true - }, + } + ], + "ibm_kp_key": [ { "name": "payload", "type": "TypeString", @@ -126074,41 +131137,57 @@ "computed": true }, { - "name": "resource_controller_url", + "name": "iv_value", "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource", - "computed": true + "description": "Only for imported root key", + "immutable": true, + "optional": true }, { - "name": "key_id", + "name": "resource_group_name", "type": "TypeString", - "description": "Key ID", + "description": "The resource group name in which resource is provisioned", "computed": true }, { - "name": "force_delete", + "name": "standard_key", "type": "TypeBool", - "description": "set to true to force delete the key", + "description": "Standard key type", "default_value": false, + "immutable": true, "optional": true }, { - "name": "iv_value", + "name": "resource_controller_url", "type": "TypeString", - "description": "Only for imported root key", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource", + "computed": true + }, + { + "name": "key_protect_id", + "type": "TypeString", + "description": "Key protect instance ID", "immutable": true, - "optional": true + "required": true }, { - "name": "resource_group_name", + "name": "key_name", "type": "TypeString", - "description": "The resource group name in which resource is provisioned", + "description": "Key name", + "immutable": true, + "required": true + }, + { + "name": "crn", + "type": "TypeString", + "description": "Crn of the key", + "cloud_data_type": "crn", "computed": true }, { - "name": "resource_crn", + "name": "resource_name", "type": "TypeString", - "description": "The crn of the resource", + "description": "The name of the resource", "computed": true }, { @@ -126118,11 +131197,17 @@ "computed": true }, { - "name": "key_protect_id", + "name": "key_id", "type": "TypeString", - "description": "Key protect instance ID", - "immutable": true, - "required": true + "description": "Key ID", + "computed": true + }, + { + "name": "force_delete", + "type": "TypeBool", + "description": "set to true to force delete the key", + "default_value": false, + "optional": true }, { "name": "encrypted_nonce", @@ -126132,20 +131217,21 @@ "optional": true }, { - "name": "crn", - "type": "TypeString", - "description": "Crn of the key", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "resource_name", + "name": "resource_crn", "type": "TypeString", - "description": "The name of the resource", + "description": "The crn of the resource", "computed": true } ], "ibm_lb": [ + { + "name": "dedicated", + "type": "TypeBool", + "description": "Boolena value true if Load balncer is dedicated type", + "default_value": false, + "immutable": true, + "optional": true + }, { "name": "hostname", "type": "TypeString", @@ -126158,15 +131244,24 @@ "required": true }, { - "name": "datacenter", + "name": "ip_address", "type": "TypeString", - "description": "Datacenter name info", - "immutable": true, - "required": true + "computed": true }, { - "name": "ip_address", - "type": "TypeString", + "name": "security_certificate_id", + "type": "TypeInt", + "description": "Security certificate ID", + "optional": true + }, + { + "name": "subnet_id", + "type": "TypeInt", + "computed": true + }, + { + "name": "ssl_enabled", + "type": "TypeBool", "computed": true }, { @@ -126186,6 +131281,13 @@ "type": "TypeString" } }, + { + "name": "datacenter", + "type": "TypeString", + "description": "Datacenter name info", + "immutable": true, + "required": true + }, { "name": "ha_enabled", "type": "TypeBool", @@ -126193,33 +131295,29 @@ "default_value": false, "immutable": true, "optional": true - }, + } + ], + "ibm_lb_service": [ { - "name": "security_certificate_id", + "name": "service_group_id", "type": "TypeInt", - "description": "Security certificate ID", - "optional": true + "description": "service group ID", + "immutable": true, + "required": true }, { - "name": "subnet_id", + "name": "ip_address_id", "type": "TypeInt", - "computed": true - }, - { - "name": "dedicated", - "type": "TypeBool", - "description": "Boolena value true if Load balncer is dedicated type", - "default_value": false, + "description": "IP Address ID", "immutable": true, - "optional": true + "required": true }, { - "name": "ssl_enabled", - "type": "TypeBool", - "computed": true - } - ], - "ibm_lb_service": [ + "name": "port", + "type": "TypeInt", + "description": "Port number", + "required": true + }, { "name": "enabled", "type": "TypeBool", @@ -126247,29 +131345,38 @@ "elem": { "type": "TypeString" } + } + ], + "ibm_lb_service_group": [ + { + "name": "tags", + "type": "TypeSet", + "description": "List of tags", + "cloud_data_type": "tags", + "optional": true, + "elem": { + "type": "TypeString" + } }, { - "name": "service_group_id", + "name": "load_balancer_id", "type": "TypeInt", - "description": "service group ID", + "description": "Loadbalancer ID", "immutable": true, "required": true }, { - "name": "ip_address_id", - "type": "TypeInt", - "description": "IP Address ID", - "immutable": true, + "name": "routing_method", + "type": "TypeString", + "description": "Routing method", "required": true }, { - "name": "port", - "type": "TypeInt", - "description": "Port number", + "name": "routing_type", + "type": "TypeString", + "description": "Routing type", "required": true - } - ], - "ibm_lb_service_group": [ + }, { "name": "timeout", "type": "TypeInt", @@ -126288,29 +131395,6 @@ "description": "Service group ID", "computed": true }, - { - "name": "load_balancer_id", - "type": "TypeInt", - "description": "Loadbalancer ID", - "immutable": true, - "required": true - }, - { - "name": "routing_type", - "type": "TypeString", - "description": "Routing type", - "required": true - }, - { - "name": "tags", - "type": "TypeSet", - "description": "List of tags", - "cloud_data_type": "tags", - "optional": true, - "elem": { - "type": "TypeString" - } - }, { "name": "allocation", "type": "TypeInt", @@ -126322,54 +131406,34 @@ "type": "TypeInt", "description": "Port number", "required": true - }, - { - "name": "routing_method", - "type": "TypeString", - "description": "Routing method", - "required": true } ], "ibm_lb_vpx": [ { - "name": "tags", - "type": "TypeSet", - "description": "List of the tags", - "cloud_data_type": "tags", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "version", + "name": "datacenter", "type": "TypeString", - "description": "version info", + "description": "Datacenter name", "immutable": true, "required": true }, { - "name": "public_vlan_id", + "name": "private_vlan_id", "type": "TypeInt", - "description": "Piblic VLAN id", + "description": "Private VLAN id", "immutable": true, "optional": true, "computed": true }, { - "name": "public_subnet", + "name": "name", "type": "TypeString", - "description": "Public subnet", - "immutable": true, - "optional": true, + "description": "Name", "computed": true }, { - "name": "private_vlan_id", - "type": "TypeInt", - "description": "Private VLAN id", - "immutable": true, - "optional": true, + "name": "type", + "type": "TypeString", + "description": "Type of the VPX", "computed": true }, { @@ -126381,39 +131445,44 @@ "computed": true }, { - "name": "vip_pool", - "type": "TypeList", - "description": "List of VIP ids", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "name", + "name": "management_ip_address", "type": "TypeString", - "description": "Name", + "description": "management IP address", "computed": true }, { - "name": "type", - "type": "TypeString", - "description": "Type of the VPX", - "computed": true + "name": "tags", + "type": "TypeSet", + "description": "List of the tags", + "cloud_data_type": "tags", + "optional": true, + "elem": { + "type": "TypeString" + } }, { - "name": "management_ip_address", + "name": "version", "type": "TypeString", - "description": "management IP address", - "computed": true + "description": "version info", + "immutable": true, + "required": true }, { - "name": "datacenter", - "type": "TypeString", - "description": "Datacenter name", + "name": "ip_count", + "type": "TypeInt", + "description": "IP address count", "immutable": true, "required": true }, + { + "name": "vip_pool", + "type": "TypeList", + "description": "List of VIP ids", + "computed": true, + "elem": { + "type": "TypeString" + } + }, { "name": "speed", "type": "TypeInt", @@ -126429,11 +131498,20 @@ "required": true }, { - "name": "ip_count", + "name": "public_vlan_id", "type": "TypeInt", - "description": "IP address count", + "description": "Piblic VLAN id", "immutable": true, - "required": true + "optional": true, + "computed": true + }, + { + "name": "public_subnet", + "type": "TypeString", + "description": "Public subnet", + "immutable": true, + "optional": true, + "computed": true } ], "ibm_lb_vpx_ha": [ @@ -126471,42 +131549,25 @@ ], "ibm_lb_vpx_service": [ { - "name": "destination_port", + "name": "weight", "type": "TypeInt", - "description": "Destination Port number", - "immutable": true, + "description": "Weight value", "required": true }, { - "name": "tags", - "type": "TypeSet", - "description": "list of tags associated with the resource", - "cloud_data_type": "tags", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "name", + "name": "vip_id", "type": "TypeString", - "description": "name", + "description": "VIP id", "immutable": true, "required": true }, { - "name": "destination_ip_address", + "name": "name", "type": "TypeString", - "description": "Destination IP Address", + "description": "name", "immutable": true, "required": true }, - { - "name": "weight", - "type": "TypeInt", - "description": "Weight value", - "required": true - }, { "name": "connection_limit", "type": "TypeInt", @@ -126527,14 +131588,38 @@ "optional": true }, { - "name": "vip_id", + "name": "tags", + "type": "TypeSet", + "description": "list of tags associated with the resource", + "cloud_data_type": "tags", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "destination_ip_address", "type": "TypeString", - "description": "VIP id", + "description": "Destination IP Address", + "immutable": true, + "required": true + }, + { + "name": "destination_port", + "type": "TypeInt", + "description": "Destination Port number", "immutable": true, "required": true } ], "ibm_lb_vpx_vip": [ + { + "name": "persistence", + "type": "TypeString", + "description": "Persistance value", + "optional": true, + "computed": true + }, { "name": "source_port", "type": "TypeInt", @@ -126550,24 +131635,9 @@ "required": true }, { - "name": "nad_controller_id", - "type": "TypeInt", - "description": "NAD controller ID", - "immutable": true, - "required": true - }, - { - "name": "persistence", - "type": "TypeString", - "description": "Persistance value", - "optional": true, - "computed": true - }, - { - "name": "name", + "name": "virtual_ip_address", "type": "TypeString", - "description": "Name", - "immutable": true, + "description": "Virtual IP address", "required": true }, { @@ -126580,51 +131650,35 @@ "type": "TypeString" } }, + { + "name": "nad_controller_id", + "type": "TypeInt", + "description": "NAD controller ID", + "immutable": true, + "required": true + }, { "name": "load_balancing_method", "type": "TypeString", "description": "Load balancing method", "required": true }, + { + "name": "name", + "type": "TypeString", + "description": "Name", + "immutable": true, + "required": true + }, { "name": "security_certificate_id", "type": "TypeInt", "description": "security certificate ID", "immutable": true, "optional": true - }, - { - "name": "virtual_ip_address", - "type": "TypeString", - "description": "Virtual IP address", - "required": true } ], "ibm_lbaas": [ - { - "name": "description", - "type": "TypeString", - "description": "Description of a load balancer.", - "optional": true - }, - { - "name": "status", - "type": "TypeString", - "description": "The operation status 'ONLINE' or 'OFFLINE' of a load balancer.", - "computed": true - }, - { - "name": "vip", - "type": "TypeString", - "description": "The virtual ip address of this load balancer", - "computed": true - }, - { - "name": "resource_status", - "type": "TypeString", - "description": "The status of the resource", - "computed": true - }, { "name": "use_system_public_ip_pool", "type": "TypeBool", @@ -126632,89 +131686,6 @@ "optional": true, "computed": true }, - { - "name": "ssl_ciphers", - "type": "TypeSet", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "health_monitors", - "type": "TypeList", - "computed": true, - "elem": { - "interval": { - "name": "interval", - "type": "TypeInt", - "computed": true - }, - "max_retries": { - "name": "max_retries", - "type": "TypeInt", - "computed": true - }, - "monitor_id": { - "name": "monitor_id", - "type": "TypeString", - "computed": true - }, - "port": { - "name": "port", - "type": "TypeInt", - "computed": true - }, - "protocol": { - "name": "protocol", - "type": "TypeString", - "computed": true - }, - "timeout": { - "name": "timeout", - "type": "TypeInt", - "computed": true - }, - "url_path": { - "name": "url_path", - "type": "TypeString", - "computed": true - } - } - }, - { - "name": "name", - "type": "TypeString", - "description": "The load balancer's name.", - "immutable": true, - "required": true - }, - { - "name": "type", - "type": "TypeString", - "description": "Specifies if a load balancer is public or private", - "default_value": "PUBLIC", - "immutable": true, - "optional": true - }, - { - "name": "datacenter", - "type": "TypeString", - "computed": true - }, - { - "name": "subnets", - "type": "TypeList", - "description": "The subnet where this Load Balancer will be provisioned.", - "immutable": true, - "required": true, - "elem": { - "type": "TypeInt" - }, - "max_items": 1, - "min_items": 1 - }, { "name": "protocols", "type": "TypeSet", @@ -126784,27 +131755,127 @@ "default_value": 90, "optional": true }, + { + "name": "health_monitors", + "type": "TypeList", + "computed": true, + "elem": { + "interval": { + "name": "interval", + "type": "TypeInt", + "computed": true + }, + "max_retries": { + "name": "max_retries", + "type": "TypeInt", + "computed": true + }, + "monitor_id": { + "name": "monitor_id", + "type": "TypeString", + "computed": true + }, + "port": { + "name": "port", + "type": "TypeInt", + "computed": true + }, + "protocol": { + "name": "protocol", + "type": "TypeString", + "computed": true + }, + "timeout": { + "name": "timeout", + "type": "TypeInt", + "computed": true + }, + "url_path": { + "name": "url_path", + "type": "TypeString", + "computed": true + } + } + }, + { + "name": "subnets", + "type": "TypeList", + "description": "The subnet where this Load Balancer will be provisioned.", + "immutable": true, + "required": true, + "elem": { + "type": "TypeInt" + }, + "max_items": 1, + "min_items": 1 + }, + { + "name": "vip", + "type": "TypeString", + "description": "The virtual ip address of this load balancer", + "computed": true + }, + { + "name": "datacenter", + "type": "TypeString", + "computed": true + }, { "name": "resource_controller_url", "type": "TypeString", "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", "computed": true }, + { + "name": "status", + "type": "TypeString", + "description": "The operation status 'ONLINE' or 'OFFLINE' of a load balancer.", + "computed": true + }, { "name": "resource_name", "type": "TypeString", "description": "The name of the resource", "computed": true - } - ], - "ibm_lbaas_health_monitor": [ + }, { - "name": "monitor_id", + "name": "resource_status", "type": "TypeString", - "description": "Monitor ID", + "description": "The status of the resource", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "The load balancer's name.", "immutable": true, "required": true }, + { + "name": "type", + "type": "TypeString", + "description": "Specifies if a load balancer is public or private", + "default_value": "PUBLIC", + "immutable": true, + "optional": true + }, + { + "name": "description", + "type": "TypeString", + "description": "Description of a load balancer.", + "optional": true + }, + { + "name": "ssl_ciphers", + "type": "TypeSet", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + } + ], + "ibm_lbaas_health_monitor": [ { "name": "lbaas_id", "type": "TypeString", @@ -126851,16 +131922,16 @@ "description": "URL Path", "default_value": "/", "optional": true - } - ], - "ibm_lbaas_server_instance_attachment": [ + }, { - "name": "lbaas_id", + "name": "monitor_id", "type": "TypeString", - "description": "The UUID of a load balancer", + "description": "Monitor ID", "immutable": true, "required": true - }, + } + ], + "ibm_lbaas_server_instance_attachment": [ { "name": "uuid", "type": "TypeString", @@ -126880,6 +131951,13 @@ "description": "The weight of a load balancer member.", "optional": true, "computed": true + }, + { + "name": "lbaas_id", + "type": "TypeString", + "description": "The UUID of a load balancer", + "immutable": true, + "required": true } ], "ibm_metrics_router_route": [ @@ -126983,6 +132061,26 @@ "description": "Id of the ibm_metrics_router_settings", "computed": true }, + { + "name": "private_api_endpoint_only", + "type": "TypeBool", + "description": "If you set this true then you cannot access api through public network.", + "optional": true + }, + { + "name": "default_targets", + "type": "TypeList", + "description": "A list of default target references.", + "optional": true, + "elem": { + "id": { + "name": "id", + "type": "TypeString", + "description": "The target uuid for a pre-defined metrics router target.", + "required": true + } + } + }, { "name": "permitted_target_regions", "type": "TypeList", @@ -127010,26 +132108,6 @@ "max_length": 256, "matches": "^[a-zA-Z0-9 \\-_]+$", "optional": true - }, - { - "name": "private_api_endpoint_only", - "type": "TypeBool", - "description": "If you set this true then you cannot access api through public network.", - "optional": true - }, - { - "name": "default_targets", - "type": "TypeList", - "description": "A list of default target references.", - "optional": true, - "elem": { - "id": { - "name": "id", - "type": "TypeString", - "description": "The target uuid for a pre-defined metrics router target.", - "required": true - } - } } ], "ibm_metrics_router_target": [ @@ -127089,32 +132167,34 @@ ], "ibm_multi_vlan_firewall": [ { - "name": "private_ip", - "type": "TypeString", - "description": "Private IP Address", - "computed": true + "name": "addon_configuration", + "type": "TypeList", + "description": "High Availability - [Web Filtering Add-on, NGFW Add-on, AV Add-on] or [Web Filtering Add-on, NGFW Add-on, AV Add-on]", + "optional": true, + "elem": { + "type": "TypeString" + } }, { - "name": "username", + "name": "datacenter", "type": "TypeString", - "description": "User name", - "computed": true + "description": "Datacenter name", + "immutable": true, + "required": true }, { - "name": "password", + "name": "pod", "type": "TypeString", - "description": "Password", - "secure": true, - "computed": true + "description": "POD name", + "immutable": true, + "required": true }, { - "name": "addon_configuration", - "type": "TypeList", - "description": "High Availability - [Web Filtering Add-on, NGFW Add-on, AV Add-on] or [Web Filtering Add-on, NGFW Add-on, AV Add-on]", - "optional": true, - "elem": { - "type": "TypeString" - } + "name": "name", + "type": "TypeString", + "description": "name", + "immutable": true, + "required": true }, { "name": "private_vlan_id", @@ -127123,15 +132203,16 @@ "computed": true }, { - "name": "public_ip", + "name": "private_ip", "type": "TypeString", - "description": "Public IP Address", + "description": "Private IP Address", "computed": true }, { - "name": "public_ipv6", + "name": "password", "type": "TypeString", - "description": "Public IPV6 IP", + "description": "Password", + "secure": true, "computed": true }, { @@ -127148,25 +132229,22 @@ "required": true }, { - "name": "datacenter", + "name": "public_ip", "type": "TypeString", - "description": "Datacenter name", - "immutable": true, - "required": true + "description": "Public IP Address", + "computed": true }, { - "name": "pod", + "name": "public_ipv6", "type": "TypeString", - "description": "POD name", - "immutable": true, - "required": true + "description": "Public IPV6 IP", + "computed": true }, { - "name": "name", + "name": "username", "type": "TypeString", - "description": "name", - "immutable": true, - "required": true + "description": "User name", + "computed": true } ], "ibm_network_gateway": [ @@ -127175,11 +132253,21 @@ "type": "TypeString", "computed": true }, + { + "name": "private_vlan_id", + "type": "TypeInt", + "computed": true + }, { "name": "public_ip_address_id", "type": "TypeInt", "computed": true }, + { + "name": "status", + "type": "TypeString", + "computed": true + }, { "name": "members", "type": "TypeSet", @@ -127401,38 +132489,6 @@ "max_items": 2, "min_items": 1 }, - { - "name": "name", - "type": "TypeString", - "description": "The name of the gateway", - "required": true - }, - { - "name": "post_install_script_uri", - "type": "TypeString", - "immutable": true, - "optional": true - }, - { - "name": "private_ip_address_id", - "type": "TypeInt", - "computed": true - }, - { - "name": "public_ipv6_address_id", - "type": "TypeInt", - "computed": true - }, - { - "name": "public_vlan_id", - "type": "TypeInt", - "computed": true - }, - { - "name": "status", - "type": "TypeString", - "computed": true - }, { "name": "associated_vlans", "type": "TypeList", @@ -127458,6 +132514,32 @@ } } }, + { + "name": "name", + "type": "TypeString", + "description": "The name of the gateway", + "required": true + }, + { + "name": "private_ip_address_id", + "type": "TypeInt", + "computed": true + }, + { + "name": "public_ipv4_address", + "type": "TypeString", + "computed": true + }, + { + "name": "public_ipv6_address_id", + "type": "TypeInt", + "computed": true + }, + { + "name": "public_vlan_id", + "type": "TypeInt", + "computed": true + }, { "name": "ssh_key_ids", "type": "TypeList", @@ -127468,14 +132550,10 @@ } }, { - "name": "public_ipv4_address", + "name": "post_install_script_uri", "type": "TypeString", - "computed": true - }, - { - "name": "private_vlan_id", - "type": "TypeInt", - "computed": true + "immutable": true, + "optional": true } ], "ibm_network_gateway_vlan_association": [ @@ -127556,19 +132634,6 @@ } ], "ibm_network_vlan": [ - { - "name": "type", - "type": "TypeString", - "description": "VLAN type", - "immutable": true, - "required": true - }, - { - "name": "vlan_number", - "type": "TypeInt", - "description": "VLAN number", - "computed": true - }, { "name": "subnets", "type": "TypeSet", @@ -127601,29 +132666,6 @@ } } }, - { - "name": "tags", - "type": "TypeSet", - "description": "List of tags", - "cloud_data_type": "tags", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "resource_controller_url", - "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", - "computed": true - }, - { - "name": "datacenter", - "type": "TypeString", - "description": "Datacenter name", - "immutable": true, - "required": true - }, { "name": "name", "type": "TypeString", @@ -127638,6 +132680,12 @@ "optional": true, "computed": true }, + { + "name": "vlan_number", + "type": "TypeInt", + "description": "VLAN number", + "computed": true + }, { "name": "softlayer_managed", "type": "TypeBool", @@ -127645,9 +132693,9 @@ "computed": true }, { - "name": "child_resource_count", - "type": "TypeInt", - "description": "Child resource count", + "name": "resource_controller_url", + "type": "TypeString", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", "computed": true }, { @@ -127655,6 +132703,36 @@ "type": "TypeString", "description": "The name of the resource", "computed": true + }, + { + "name": "datacenter", + "type": "TypeString", + "description": "Datacenter name", + "immutable": true, + "required": true + }, + { + "name": "type", + "type": "TypeString", + "description": "VLAN type", + "immutable": true, + "required": true + }, + { + "name": "child_resource_count", + "type": "TypeInt", + "description": "Child resource count", + "computed": true + }, + { + "name": "tags", + "type": "TypeSet", + "description": "List of tags", + "cloud_data_type": "tags", + "optional": true, + "elem": { + "type": "TypeString" + } } ], "ibm_network_vlan_spanning": [ @@ -127666,6 +132744,18 @@ } ], "ibm_ob_logging": [ + { + "name": "agent_namespace", + "type": "TypeString", + "description": "Agent Namespace", + "computed": true + }, + { + "name": "discovered_agent", + "type": "TypeBool", + "description": "Discovered agent", + "computed": true + }, { "name": "cluster", "type": "TypeString", @@ -127674,29 +132764,21 @@ "required": true }, { - "name": "logdna_ingestion_key", + "name": "daemonset_name", "type": "TypeString", - "description": "LogDNA ingestion key", - "optional": true, - "computed": true - }, - { - "name": "private_endpoint", - "type": "TypeBool", - "description": "Add this option to connect to your LogDNA service instance through the private service endpoint", - "optional": true, + "description": "Daemon Set Name", "computed": true }, { - "name": "daemonset_name", + "name": "instance_name", "type": "TypeString", - "description": "Daemon Set Name", + "description": "LogDNA instance Name", "computed": true }, { - "name": "agent_namespace", + "name": "agent_key", "type": "TypeString", - "description": "Agent Namespace", + "description": "Agent key name", "computed": true }, { @@ -127713,15 +132795,17 @@ "required": true }, { - "name": "instance_name", + "name": "logdna_ingestion_key", "type": "TypeString", - "description": "LogDNA instance Name", + "description": "LogDNA ingestion key", + "optional": true, "computed": true }, { - "name": "agent_key", - "type": "TypeString", - "description": "Agent key name", + "name": "private_endpoint", + "type": "TypeBool", + "description": "Add this option to connect to your LogDNA service instance through the private service endpoint", + "optional": true, "computed": true }, { @@ -127730,39 +132814,9 @@ "description": "CRN", "cloud_data_type": "crn", "computed": true - }, - { - "name": "discovered_agent", - "type": "TypeBool", - "description": "Discovered agent", - "computed": true } ], "ibm_ob_monitoring": [ - { - "name": "agent_key", - "type": "TypeString", - "description": "Agent key name", - "computed": true - }, - { - "name": "agent_namespace", - "type": "TypeString", - "description": "Agent Namespace", - "computed": true - }, - { - "name": "discovered_agent", - "type": "TypeBool", - "description": "Discovered agent", - "computed": true - }, - { - "name": "namespace", - "type": "TypeString", - "description": "Namespace", - "computed": true - }, { "name": "cluster", "type": "TypeString", @@ -127771,16 +132825,15 @@ "required": true }, { - "name": "sysdig_access_key", + "name": "daemonset_name", "type": "TypeString", - "description": "Sysdig ingestion key", - "optional": true, + "description": "Daemon Set Name", "computed": true }, { - "name": "daemonset_name", + "name": "agent_namespace", "type": "TypeString", - "description": "Daemon Set Name", + "description": "Agent Namespace", "computed": true }, { @@ -127797,6 +132850,13 @@ "cloud_data_type": "resource_instance", "required": true }, + { + "name": "sysdig_access_key", + "type": "TypeString", + "description": "Sysdig ingestion key", + "optional": true, + "computed": true + }, { "name": "private_endpoint", "type": "TypeBool", @@ -127809,30 +132869,27 @@ "type": "TypeString", "description": "Sysdig instance Name", "computed": true - } - ], - "ibm_object_storage_account": [ + }, { - "name": "name", + "name": "agent_key", "type": "TypeString", + "description": "Agent key name", "computed": true }, { - "name": "local_note", - "type": "TypeString", - "optional": true + "name": "discovered_agent", + "type": "TypeBool", + "description": "Discovered agent", + "computed": true }, { - "name": "tags", - "type": "TypeSet", - "cloud_data_type": "tags", - "optional": true, - "elem": { - "type": "TypeString" - } + "name": "namespace", + "type": "TypeString", + "description": "Namespace", + "computed": true } ], - "ibm_org": [ + "ibm_object_storage_account": [ { "name": "tags", "type": "TypeSet", @@ -127842,6 +132899,18 @@ "type": "TypeString" } }, + { + "name": "name", + "type": "TypeString", + "computed": true + }, + { + "name": "local_note", + "type": "TypeString", + "optional": true + } + ], + "ibm_org": [ { "name": "name", "type": "TypeString", @@ -127890,22 +132959,34 @@ "elem": { "type": "TypeString" } + }, + { + "name": "tags", + "type": "TypeSet", + "cloud_data_type": "tags", + "optional": true, + "elem": { + "type": "TypeString" + } } ], "ibm_pi_capture": [ { - "name": "pi_capture_name", + "name": "pi_instance_name", "type": "TypeString", - "description": "Name of the capture to create. Note : this must be unique", + "description": "Instance Name of the Power VM", "immutable": true, "required": true }, { - "name": "pi_capture_destination", - "type": "TypeString", - "description": "Destination for the deployable image", + "name": "pi_capture_volume_ids", + "type": "TypeSet", + "description": "List of Data volume IDs", "immutable": true, - "required": true + "optional": true, + "elem": { + "type": "TypeString" + } }, { "name": "pi_capture_cloud_storage_region", @@ -127915,19 +132996,17 @@ "optional": true }, { - "name": "pi_capture_cloud_storage_access_key", + "name": "pi_capture_storage_image_path", "type": "TypeString", - "description": "Name of Cloud Storage Access Key", - "secure": true, + "description": "Cloud Storage Image Path (bucket-name [/folder/../..])", "immutable": true, "optional": true }, { - "name": "pi_capture_storage_image_path", + "name": "image_id", "type": "TypeString", - "description": "Cloud Storage Image Path (bucket-name [/folder/../..])", - "immutable": true, - "optional": true + "description": "Image ID of Capture Instance", + "computed": true }, { "name": "pi_cloud_instance_id", @@ -127937,21 +133016,19 @@ "required": true }, { - "name": "pi_instance_name", + "name": "pi_capture_destination", "type": "TypeString", - "description": "Instance Name of the Power VM", + "description": "Destination for the deployable image", "immutable": true, "required": true }, { - "name": "pi_capture_volume_ids", - "type": "TypeSet", - "description": "List of Data volume IDs", + "name": "pi_capture_cloud_storage_access_key", + "type": "TypeString", + "description": "Name of Cloud Storage Access Key", + "secure": true, "immutable": true, - "optional": true, - "elem": { - "type": "TypeString" - } + "optional": true }, { "name": "pi_capture_cloud_storage_secret_key", @@ -127962,55 +133039,25 @@ "optional": true }, { - "name": "image_id", + "name": "pi_capture_name", "type": "TypeString", - "description": "Image ID of Capture Instance", - "computed": true + "description": "Name of the capture to create. Note : this must be unique", + "immutable": true, + "required": true } ], "ibm_pi_cloud_connection": [ { - "name": "pi_cloud_connection_vpc_enabled", - "type": "TypeBool", - "description": "Enable VPC for this cloud connection", - "default_value": false, - "optional": true - }, - { - "name": "user_ip_address", + "name": "connection_mode", "type": "TypeString", - "description": "User IP address", + "description": "Type of service the gateway is attached to", "computed": true }, { - "name": "pi_cloud_connection_networks", - "type": "TypeSet", - "description": "Set of Networks to attach to this cloud connection", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "pi_cloud_connection_classic_enabled", - "type": "TypeBool", - "description": "Enable classic endpoint destination", - "default_value": false, - "optional": true - }, - { - "name": "pi_cloud_connection_transit_enabled", - "type": "TypeBool", - "description": "Enable transit gateway for this cloud connection", - "default_value": false, - "optional": true - }, - { - "name": "status", + "name": "pi_cloud_instance_id", "type": "TypeString", - "description": "Link status", - "computed": true + "description": "PI cloud instance ID", + "required": true }, { "name": "pi_cloud_connection_global_routing", @@ -128027,42 +133074,56 @@ "optional": true }, { - "name": "pi_cloud_connection_gre_destination_address", + "name": "pi_cloud_connection_gre_cidr", "type": "TypeString", - "description": "GRE destination IP address", + "description": "GRE network in CIDR notation", "optional": true }, { - "name": "ibm_ip_address", + "name": "status", "type": "TypeString", - "description": "IBM IP address", + "description": "Link status", "computed": true }, { - "name": "pi_cloud_instance_id", + "name": "gre_source_address", "type": "TypeString", - "description": "PI cloud instance ID", - "required": true + "description": "GRE auto-assigned source IP address", + "computed": true }, { - "name": "pi_cloud_connection_gre_cidr", + "name": "pi_cloud_connection_name", "type": "TypeString", - "description": "GRE network in CIDR notation", - "optional": true + "description": "Name of the cloud connection", + "required": true }, { - "name": "pi_cloud_connection_vpc_crns", + "name": "pi_cloud_connection_speed", + "type": "TypeInt", + "description": "Speed of the cloud connection (speed in megabits per second)", + "required": true + }, + { + "name": "pi_cloud_connection_networks", "type": "TypeSet", - "description": "Set of VPCs to attach to this cloud connection", + "description": "Set of Networks to attach to this cloud connection", "optional": true, + "computed": true, "elem": { "type": "TypeString" } }, { - "name": "cloud_connection_id", + "name": "pi_cloud_connection_classic_enabled", + "type": "TypeBool", + "description": "Enable classic endpoint destination", + "default_value": false, + "optional": true + }, + { + "name": "user_ip_address", "type": "TypeString", - "description": "Cloud connection ID", + "description": "User IP address", "computed": true }, { @@ -128072,28 +133133,45 @@ "computed": true }, { - "name": "gre_source_address", + "name": "pi_cloud_connection_gre_destination_address", "type": "TypeString", - "description": "GRE auto-assigned source IP address", - "computed": true + "description": "GRE destination IP address", + "optional": true }, { - "name": "connection_mode", - "type": "TypeString", - "description": "Type of service the gateway is attached to", - "computed": true + "name": "pi_cloud_connection_vpc_crns", + "type": "TypeSet", + "description": "Set of VPCs to attach to this cloud connection", + "optional": true, + "elem": { + "type": "TypeString" + } }, { - "name": "pi_cloud_connection_name", + "name": "pi_cloud_connection_vpc_enabled", + "type": "TypeBool", + "description": "Enable VPC for this cloud connection", + "default_value": false, + "optional": true + }, + { + "name": "pi_cloud_connection_transit_enabled", + "type": "TypeBool", + "description": "Enable transit gateway for this cloud connection", + "default_value": false, + "optional": true + }, + { + "name": "cloud_connection_id", "type": "TypeString", - "description": "Name of the cloud connection", - "required": true + "description": "Cloud connection ID", + "computed": true }, { - "name": "pi_cloud_connection_speed", - "type": "TypeInt", - "description": "Speed of the cloud connection (speed in megabits per second)", - "required": true + "name": "ibm_ip_address", + "type": "TypeString", + "description": "IBM IP address", + "computed": true } ], "ibm_pi_cloud_connection_network_attach": [ @@ -128140,20 +133218,6 @@ } ], "ibm_pi_dhcp": [ - { - "name": "pi_cloud_instance_id", - "type": "TypeString", - "description": "PI cloud instance ID", - "immutable": true, - "required": true - }, - { - "name": "pi_cloud_connection_id", - "type": "TypeString", - "description": "Optional cloud connection uuid to connect with DHCP private network", - "immutable": true, - "optional": true - }, { "name": "pi_dhcp_name", "type": "TypeString", @@ -128162,16 +133226,37 @@ "optional": true }, { - "name": "network_id", + "name": "dhcp_id", "type": "TypeString", - "description": "The ID of the DHCP Server private network", + "description": "The ID of the DHCP Server", "computed": true }, { - "name": "status", + "name": "leases", + "type": "TypeList", + "description": "The list of DHCP Server PVM Instance leases", + "computed": true, + "elem": { + "instance_ip": { + "name": "instance_ip", + "type": "TypeString", + "description": "The IP of the PVM Instance", + "computed": true + }, + "instance_mac": { + "name": "instance_mac", + "type": "TypeString", + "description": "The MAC Address of the PVM Instance", + "computed": true + } + } + }, + { + "name": "pi_cloud_instance_id", "type": "TypeString", - "description": "The status of the DHCP Server", - "computed": true + "description": "PI cloud instance ID", + "immutable": true, + "required": true }, { "name": "pi_cidr", @@ -128180,6 +133265,13 @@ "immutable": true, "optional": true }, + { + "name": "pi_cloud_connection_id", + "type": "TypeString", + "description": "Optional cloud connection uuid to connect with DHCP private network", + "immutable": true, + "optional": true + }, { "name": "pi_dns_server", "type": "TypeString", @@ -128196,35 +133288,15 @@ "optional": true }, { - "name": "dhcp_id", + "name": "network", "type": "TypeString", - "description": "The ID of the DHCP Server", + "description": "The ID of the DHCP Server private network (deprecated - replaced by network_id)", "computed": true }, { - "name": "leases", - "type": "TypeList", - "description": "The list of DHCP Server PVM Instance leases", - "computed": true, - "elem": { - "instance_ip": { - "name": "instance_ip", - "type": "TypeString", - "description": "The IP of the PVM Instance", - "computed": true - }, - "instance_mac": { - "name": "instance_mac", - "type": "TypeString", - "description": "The MAC Address of the PVM Instance", - "computed": true - } - } - }, - { - "name": "network", + "name": "network_id", "type": "TypeString", - "description": "The ID of the DHCP Server private network (deprecated - replaced by network_id)", + "description": "The ID of the DHCP Server private network", "computed": true }, { @@ -128232,19 +133304,31 @@ "type": "TypeString", "description": "The name of the DHCP Server private network", "computed": true + }, + { + "name": "status", + "type": "TypeString", + "description": "The status of the DHCP Server", + "computed": true } ], "ibm_pi_ike_policy": [ { - "name": "pi_policy_name", + "name": "policy_id", "type": "TypeString", - "description": "Name of the IKE Policy", + "description": "IKE Policy ID", + "computed": true + }, + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "description": "PI cloud instance ID", "required": true }, { - "name": "pi_policy_dh_group", - "type": "TypeInt", - "description": "DH group of the IKE Policy", + "name": "pi_policy_encryption", + "type": "TypeString", + "description": "Encryption of the IKE Policy", "required": true }, { @@ -128261,21 +133345,15 @@ "optional": true }, { - "name": "policy_id", - "type": "TypeString", - "description": "IKE Policy ID", - "computed": true - }, - { - "name": "pi_cloud_instance_id", + "name": "pi_policy_name", "type": "TypeString", - "description": "PI cloud instance ID", + "description": "Name of the IKE Policy", "required": true }, { - "name": "pi_policy_encryption", - "type": "TypeString", - "description": "Encryption of the IKE Policy", + "name": "pi_policy_dh_group", + "type": "TypeInt", + "description": "DH group of the IKE Policy", "required": true }, { @@ -128293,37 +133371,46 @@ ], "ibm_pi_image": [ { - "name": "pi_image_storage_pool", + "name": "pi_image_bucket_region", "type": "TypeString", - "description": "Storage pool where the image will be loaded, if provided then pi_image_storage_type and pi_affinity_policy will be ignored", + "description": "Cloud Object Storage region", "immutable": true, "optional": true }, { - "name": "pi_affinity_policy", + "name": "pi_image_bucket_file_name", "type": "TypeString", - "description": "Affinity policy for image; ignored if pi_image_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified", + "description": "Cloud Object Storage image filename", "immutable": true, "optional": true }, { - "name": "pi_cloud_instance_id", + "name": "pi_affinity_instance", "type": "TypeString", - "description": "PI cloud instance ID", + "description": "PVM Instance (ID or Name) to base storage affinity policy against; required if requesting storage affinity and pi_affinity_volume is not provided", + "immutable": true, + "optional": true + }, + { + "name": "pi_image_name", + "type": "TypeString", + "description": "Image name", "immutable": true, "required": true }, { - "name": "pi_image_storage_type", + "name": "pi_image_access_key", "type": "TypeString", - "description": "Type of storage", + "description": "Cloud Object Storage access key; required for buckets with private access", + "secure": true, "immutable": true, "optional": true }, { - "name": "pi_image_bucket_file_name", + "name": "pi_image_secret_key", "type": "TypeString", - "description": "Cloud Object Storage image filename", + "description": "Cloud Object Storage secret key; required for buckets with private access", + "secure": true, "immutable": true, "optional": true }, @@ -128338,55 +133425,41 @@ } }, { - "name": "image_id", - "type": "TypeString", - "description": "Image ID", - "computed": true - }, - { - "name": "pi_image_access_key", - "type": "TypeString", - "description": "Cloud Object Storage access key; required for buckets with private access", - "secure": true, - "immutable": true, - "optional": true - }, - { - "name": "pi_image_bucket_region", + "name": "pi_cloud_instance_id", "type": "TypeString", - "description": "Cloud Object Storage region", + "description": "PI cloud instance ID", "immutable": true, - "optional": true + "required": true }, { - "name": "pi_image_bucket_name", + "name": "pi_affinity_policy", "type": "TypeString", - "description": "Cloud Object Storage bucket name; bucket-name[/optional/folder]", + "description": "Affinity policy for image; ignored if pi_image_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified", "immutable": true, "optional": true }, { - "name": "pi_image_bucket_access", - "type": "TypeString", - "description": "Indicates if the bucket has public or private access", - "default_value": "public", + "name": "pi_anti_affinity_volumes", + "type": "TypeList", + "description": "List of volumes to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided", "immutable": true, - "optional": true + "optional": true, + "elem": { + "type": "TypeString" + } }, { - "name": "pi_image_secret_key", + "name": "pi_affinity_volume", "type": "TypeString", - "description": "Cloud Object Storage secret key; required for buckets with private access", - "secure": true, + "description": "Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided", "immutable": true, "optional": true }, { - "name": "pi_image_name", + "name": "image_id", "type": "TypeString", - "description": "Image name", - "immutable": true, - "required": true + "description": "Image ID", + "computed": true }, { "name": "pi_image_id", @@ -128396,31 +133469,43 @@ "optional": true }, { - "name": "pi_anti_affinity_volumes", - "type": "TypeList", - "description": "List of volumes to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided", + "name": "pi_image_storage_type", + "type": "TypeString", + "description": "Type of storage", "immutable": true, - "optional": true, - "elem": { - "type": "TypeString" - } + "optional": true }, { - "name": "pi_affinity_volume", + "name": "pi_image_storage_pool", "type": "TypeString", - "description": "Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided", + "description": "Storage pool where the image will be loaded, if provided then pi_image_storage_type and pi_affinity_policy will be ignored", "immutable": true, "optional": true }, { - "name": "pi_affinity_instance", + "name": "pi_image_bucket_name", "type": "TypeString", - "description": "PVM Instance (ID or Name) to base storage affinity policy against; required if requesting storage affinity and pi_affinity_volume is not provided", + "description": "Cloud Object Storage bucket name; bucket-name[/optional/folder]", + "immutable": true, + "optional": true + }, + { + "name": "pi_image_bucket_access", + "type": "TypeString", + "description": "Indicates if the bucket has public or private access", + "default_value": "public", "immutable": true, "optional": true } ], "ibm_pi_image_export": [ + { + "name": "pi_image_bucket_region", + "type": "TypeString", + "description": "Cloud Object Storage region", + "immutable": true, + "required": true + }, { "name": "pi_cloud_instance_id", "type": "TypeString", @@ -128457,28 +133542,9 @@ "secure": true, "immutable": true, "required": true - }, - { - "name": "pi_image_bucket_region", - "type": "TypeString", - "description": "Cloud Object Storage region", - "immutable": true, - "required": true } ], "ibm_pi_instance": [ - { - "name": "min_processors", - "type": "TypeFloat", - "description": "Minimum number of the CPUs", - "computed": true - }, - { - "name": "pi_image_id", - "type": "TypeString", - "description": "PI instance image id", - "required": true - }, { "name": "pi_key_pair_name", "type": "TypeString", @@ -128486,16 +133552,10 @@ "optional": true }, { - "name": "pi_affinity_volume", - "type": "TypeString", - "description": "Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided", - "optional": true - }, - { - "name": "pi_affinity_instance", - "type": "TypeString", - "description": "PVM Instance (ID or Name) to base storage affinity policy against; required if requesting storage affinity and pi_affinity_volume is not provided", - "optional": true + "name": "max_processors", + "type": "TypeFloat", + "description": "Maximum number of processors", + "computed": true }, { "name": "pi_anti_affinity_volumes", @@ -128552,42 +133612,23 @@ } }, { - "name": "pi_cloud_instance_id", + "name": "pi_sap_profile_id", "type": "TypeString", - "description": "This is the Power Instance id that is assigned to the account", - "immutable": true, - "required": true - }, - { - "name": "pi_migratable", - "type": "TypeBool", - "description": "set to true to enable migration of the PI instance", - "optional": true, - "computed": true + "description": "SAP Profile ID for the amount of cores and memory", + "optional": true }, { - "name": "pi_storage_pool", + "name": "pi_sys_type", "type": "TypeString", - "description": "Storage Pool for server deployment; if provided then pi_affinity_policy and pi_storage_type will be ignored", + "description": "PI Instance system type", "optional": true, "computed": true }, { - "name": "os_type", - "type": "TypeString", - "description": "OS Type", - "computed": true - }, - { - "name": "pi_placement_group_id", - "type": "TypeString", - "description": "Placement group ID", - "optional": true - }, - { - "name": "pi_sap_deployment_type", - "type": "TypeString", - "description": "Custom SAP Deployment Type Information", + "name": "pi_replicants", + "type": "TypeInt", + "description": "PI Instance replicas count", + "default_value": 1, "optional": true }, { @@ -128597,27 +133638,38 @@ "computed": true }, { - "name": "pi_sys_type", + "name": "pi_storage_type", "type": "TypeString", - "description": "PI Instance system type", + "description": "Storage type for server deployment", "optional": true, "computed": true }, { - "name": "pi_volume_ids", - "type": "TypeSet", - "description": "List of PI volumes", + "name": "pin_policy", + "type": "TypeString", + "description": "PIN Policy of the Instance", + "computed": true + }, + { + "name": "pi_memory", + "type": "TypeFloat", + "description": "Memory size", "optional": true, - "elem": { - "type": "TypeString" - } + "computed": true }, { - "name": "pi_affinity_policy", + "name": "pi_deployment_type", "type": "TypeString", - "description": "Affinity policy for pvm instance being created; ignored if pi_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified", + "description": "Custom Deployment Type Information", "optional": true }, + { + "name": "pi_migratable", + "type": "TypeBool", + "description": "set to true to enable migration of the PI instance", + "optional": true, + "computed": true + }, { "name": "instance_id", "type": "TypeString", @@ -128626,71 +133678,103 @@ "computed": true }, { - "name": "pi_replication_policy", - "type": "TypeString", - "description": "Replication policy for the PI Instance", - "default_value": "none", - "optional": true - }, - { - "name": "pi_replication_scheme", + "name": "pi_image_id", "type": "TypeString", - "description": "Replication scheme", - "default_value": "suffix", - "optional": true + "description": "PI instance image id", + "required": true }, { - "name": "pi_virtual_cores_assigned", - "type": "TypeInt", - "description": "Virtual Cores Assigned to the PVMInstance", + "name": "pi_processors", + "type": "TypeFloat", + "description": "Processors count", "optional": true, "computed": true }, { - "name": "min_virtual_cores", - "type": "TypeInt", - "description": "Minimum Virtual Cores Assigned to the PVMInstance", + "name": "operating_system", + "type": "TypeString", + "description": "Operating System", "computed": true }, { - "name": "pi_user_data", + "name": "status", "type": "TypeString", - "description": "Base64 encoded data to be passed in for invoking a cloud init script", + "description": "PI instance status", + "computed": true + }, + { + "name": "pi_storage_pool_affinity", + "type": "TypeBool", + "description": "Indicates if all volumes attached to the server must reside in the same storage pool", + "default_value": true, "optional": true }, { - "name": "pi_storage_type", + "name": "shared_processor_pool_id", "type": "TypeString", - "description": "Storage type for server deployment", - "optional": true, + "description": "Shared Processor Pool ID the instance is deployed on", "computed": true }, { - "name": "pi_deployment_type", + "name": "health_status", "type": "TypeString", - "description": "Custom Deployment Type Information", + "description": "PI Instance health status", + "computed": true + }, + { + "name": "pi_pin_policy", + "type": "TypeString", + "description": "Pin Policy of the instance", + "default_value": "none", "optional": true }, { - "name": "pi_shared_processor_pool", + "name": "pi_user_data", "type": "TypeString", - "description": "Shared Processor Pool the instance is deployed on", - "immutable": true, + "description": "Base64 encoded data to be passed in for invoking a cloud init script", "optional": true }, { - "name": "pi_sap_profile_id", + "name": "pi_affinity_instance", "type": "TypeString", - "description": "SAP Profile ID for the amount of cores and memory", + "description": "PVM Instance (ID or Name) to base storage affinity policy against; required if requesting storage affinity and pi_affinity_volume is not provided", "optional": true }, { - "name": "pi_pin_policy", + "name": "pi_anti_affinity_instances", + "type": "TypeList", + "description": "List of pvmInstances to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "pi_replication_policy", "type": "TypeString", - "description": "Pin Policy of the instance", + "description": "Replication policy for the PI Instance", "default_value": "none", "optional": true }, + { + "name": "pi_virtual_cores_assigned", + "type": "TypeInt", + "description": "Virtual Cores Assigned to the PVMInstance", + "optional": true, + "computed": true + }, + { + "name": "max_virtual_cores", + "type": "TypeInt", + "description": "Maximum Virtual Cores Assigned to the PVMInstance", + "computed": true + }, + { + "name": "min_virtual_cores", + "type": "TypeInt", + "description": "Minimum Virtual Cores Assigned to the PVMInstance", + "computed": true + }, { "name": "pi_license_repository_capacity", "type": "TypeInt", @@ -128699,15 +133783,23 @@ "computed": true }, { - "name": "min_memory", + "name": "min_processors", "type": "TypeFloat", - "description": "Minimum memory", + "description": "Minimum number of the CPUs", "computed": true }, { - "name": "max_memory", - "type": "TypeFloat", - "description": "Maximum memory size", + "name": "pi_shared_processor_pool", + "type": "TypeString", + "description": "Shared Processor Pool the instance is deployed on", + "immutable": true, + "optional": true + }, + { + "name": "pi_proc_type", + "type": "TypeString", + "description": "Instance processor type", + "optional": true, "computed": true }, { @@ -128718,99 +133810,103 @@ "optional": true }, { - "name": "max_virtual_cores", - "type": "TypeInt", - "description": "Maximum Virtual Cores Assigned to the PVMInstance", - "computed": true + "name": "pi_affinity_policy", + "type": "TypeString", + "description": "Affinity policy for pvm instance being created; ignored if pi_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified", + "optional": true }, { - "name": "pi_storage_pool_affinity", - "type": "TypeBool", - "description": "Indicates if all volumes attached to the server must reside in the same storage pool", - "default_value": true, - "optional": true + "name": "pi_instance_name", + "type": "TypeString", + "description": "PI Instance name", + "required": true }, { - "name": "shared_processor_pool_id", + "name": "pi_sap_deployment_type", "type": "TypeString", - "description": "Shared Processor Pool ID the instance is deployed on", - "computed": true + "description": "Custom SAP Deployment Type Information", + "optional": true }, { - "name": "health_status", + "name": "os_type", "type": "TypeString", - "description": "PI Instance health status", + "description": "OS Type", "computed": true }, { - "name": "operating_system", + "name": "pi_storage_pool", "type": "TypeString", - "description": "Operating System", + "description": "Storage Pool for server deployment; if provided then pi_affinity_policy and pi_storage_type will be ignored", + "optional": true, "computed": true }, { - "name": "pi_anti_affinity_instances", - "type": "TypeList", - "description": "List of pvmInstances to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided", - "optional": true, - "elem": { - "type": "TypeString" - } + "name": "pi_affinity_volume", + "type": "TypeString", + "description": "Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided", + "optional": true }, { - "name": "pi_processors", - "type": "TypeFloat", - "description": "Processors count", - "optional": true, - "computed": true + "name": "pi_placement_group_id", + "type": "TypeString", + "description": "Placement group ID", + "optional": true }, { - "name": "pi_replicants", - "type": "TypeInt", - "description": "PI Instance replicas count", - "default_value": 1, + "name": "pi_replication_scheme", + "type": "TypeString", + "description": "Replication scheme", + "default_value": "suffix", "optional": true }, { - "name": "pi_instance_name", + "name": "pi_cloud_instance_id", "type": "TypeString", - "description": "PI Instance name", + "description": "This is the Power Instance id that is assigned to the account", + "immutable": true, "required": true }, { - "name": "pi_proc_type", - "type": "TypeString", - "description": "Instance processor type", - "optional": true, + "name": "min_memory", + "type": "TypeFloat", + "description": "Minimum memory", "computed": true }, { - "name": "pi_memory", + "name": "max_memory", "type": "TypeFloat", - "description": "Memory size", - "optional": true, + "description": "Maximum memory size", "computed": true }, { - "name": "status", + "name": "pi_volume_ids", + "type": "TypeSet", + "description": "List of PI volumes", + "optional": true, + "elem": { + "type": "TypeString" + } + } + ], + "ibm_pi_instance_action": [ + { + "name": "pi_cloud_instance_id", "type": "TypeString", - "description": "PI instance status", - "computed": true + "description": "PI Cloud instance id", + "required": true }, { - "name": "max_processors", - "type": "TypeFloat", - "description": "Maximum number of processors", - "computed": true + "name": "pi_instance_id", + "type": "TypeString", + "description": "PVM instance ID", + "required": true }, { - "name": "pin_policy", + "name": "pi_action", "type": "TypeString", - "description": "PIN Policy of the Instance", - "computed": true - } - ], - "ibm_pi_instance_action": [ + "description": "PVM instance action type", + "required": true + }, { "name": "pi_health_status", "type": "TypeString", @@ -128835,24 +133931,6 @@ "type": "TypeString", "description": "The PVM's health status value", "computed": true - }, - { - "name": "pi_cloud_instance_id", - "type": "TypeString", - "description": "PI Cloud instance id", - "required": true - }, - { - "name": "pi_instance_id", - "type": "TypeString", - "description": "PVM instance ID", - "required": true - }, - { - "name": "pi_action", - "type": "TypeString", - "description": "PVM instance action type", - "required": true } ], "ibm_pi_ipsec_policy": [ @@ -128907,6 +133985,12 @@ } ], "ibm_pi_key": [ + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "description": "PI cloud instance ID", + "required": true + }, { "name": "pi_key_name", "type": "TypeString", @@ -128942,33 +134026,9 @@ "type": "TypeString", "description": "SSH RSA key", "computed": true - }, - { - "name": "pi_cloud_instance_id", - "type": "TypeString", - "description": "PI cloud instance ID", - "required": true } ], "ibm_pi_network": [ - { - "name": "network_id", - "type": "TypeString", - "description": "PI network ID", - "computed": true - }, - { - "name": "vlan_id", - "type": "TypeFloat", - "description": "VLAN Id value", - "computed": true - }, - { - "name": "pi_network_type", - "type": "TypeString", - "description": "PI network type", - "required": true - }, { "name": "pi_dns", "type": "TypeSet", @@ -128979,25 +134039,6 @@ "type": "TypeString" } }, - { - "name": "pi_gateway", - "type": "TypeString", - "description": "PI network gateway", - "optional": true, - "computed": true - }, - { - "name": "pi_cloud_instance_id", - "type": "TypeString", - "description": "PI cloud instance ID", - "required": true - }, - { - "name": "pi_network_name", - "type": "TypeString", - "description": "PI network name", - "required": true - }, { "name": "pi_cidr", "type": "TypeString", @@ -129005,13 +134046,6 @@ "optional": true, "computed": true }, - { - "name": "pi_network_jumbo", - "type": "TypeBool", - "description": "PI network enable MTU Jumbo option", - "optional": true, - "computed": true - }, { "name": "pi_ipaddress_range", "type": "TypeList", @@ -129032,9 +134066,59 @@ "required": true } } + }, + { + "name": "pi_network_name", + "type": "TypeString", + "description": "PI network name", + "required": true + }, + { + "name": "pi_gateway", + "type": "TypeString", + "description": "PI network gateway", + "optional": true, + "computed": true + }, + { + "name": "pi_network_jumbo", + "type": "TypeBool", + "description": "PI network enable MTU Jumbo option", + "optional": true, + "computed": true + }, + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "description": "PI cloud instance ID", + "required": true + }, + { + "name": "network_id", + "type": "TypeString", + "description": "PI network ID", + "computed": true + }, + { + "name": "vlan_id", + "type": "TypeFloat", + "description": "VLAN Id value", + "computed": true + }, + { + "name": "pi_network_type", + "type": "TypeString", + "description": "PI network type", + "required": true } ], "ibm_pi_network_port": [ + { + "name": "pi_network_port_description", + "type": "TypeString", + "optional": true, + "computed": true + }, { "name": "pi_network_port_ipaddress", "type": "TypeString", @@ -129070,31 +134154,12 @@ "name": "pi_cloud_instance_id", "type": "TypeString", "required": true - }, - { - "name": "pi_network_port_description", - "type": "TypeString", - "optional": true, - "computed": true } ], "ibm_pi_network_port_attach": [ { - "name": "port_id", - "type": "TypeString", - "computed": true, - "deprecated": "port_id attribute is deprecated, use network_port_id instead." - }, - { - "name": "network_port_id", - "type": "TypeString", - "computed": true - }, - { - "name": "pi_network_port_ipaddress", + "name": "public_ip", "type": "TypeString", - "immutable": true, - "optional": true, "computed": true }, { @@ -129112,17 +134177,17 @@ "required": true }, { - "name": "pi_network_port_description", + "name": "pi_network_port_ipaddress", "type": "TypeString", - "description": "A human readable description for this network Port", - "default_value": "Port Created via Terraform", "immutable": true, - "optional": true + "optional": true, + "computed": true }, { - "name": "macaddress", + "name": "port_id", "type": "TypeString", - "computed": true + "computed": true, + "deprecated": "port_id attribute is deprecated, use network_port_id instead." }, { "name": "status", @@ -129130,24 +134195,31 @@ "computed": true }, { - "name": "public_ip", + "name": "pi_cloud_instance_id", "type": "TypeString", - "computed": true + "immutable": true, + "required": true }, { - "name": "pi_cloud_instance_id", + "name": "pi_network_port_description", "type": "TypeString", + "description": "A human readable description for this network Port", + "default_value": "Port Created via Terraform", "immutable": true, - "required": true - } - ], - "ibm_pi_placement_group": [ + "optional": true + }, { - "name": "placement_group_id", + "name": "macaddress", "type": "TypeString", - "description": "PI placement group ID", "computed": true }, + { + "name": "network_port_id", + "type": "TypeString", + "computed": true + } + ], + "ibm_pi_placement_group": [ { "name": "pi_placement_group_name", "type": "TypeString", @@ -129174,27 +134246,15 @@ "elem": { "type": "TypeString" } - } - ], - "ibm_pi_shared_processor_pool": [ - { - "name": "pi_shared_processor_pool_host_group", - "type": "TypeString", - "description": "Host group of the shared processor pool", - "required": true }, { - "name": "pi_cloud_instance_id", + "name": "placement_group_id", "type": "TypeString", - "description": "PI cloud instance ID", - "required": true - }, - { - "name": "available_cores", - "type": "TypeInt", - "description": "Shared processor pool available cores", + "description": "PI placement group ID", "computed": true - }, + } + ], + "ibm_pi_shared_processor_pool": [ { "name": "instances", "type": "TypeList", @@ -129251,12 +134311,6 @@ } } }, - { - "name": "status_detail", - "type": "TypeString", - "description": "The status details of the shared processor pool", - "computed": true - }, { "name": "pi_shared_processor_pool_name", "type": "TypeString", @@ -129264,22 +134318,25 @@ "required": true }, { - "name": "pi_shared_processor_pool_reserved_cores", - "type": "TypeInt", - "description": "The amount of reserved cores for the shared processor pool", + "name": "pi_shared_processor_pool_host_group", + "type": "TypeString", + "description": "Host group of the shared processor pool", "required": true }, { - "name": "pi_shared_processor_pool_placement_group_id", - "type": "TypeString", - "description": "Placement group the shared processor pool is created in", - "optional": true + "name": "available_cores", + "type": "TypeInt", + "description": "Shared processor pool available cores", + "computed": true }, { - "name": "shared_processor_pool_id", - "type": "TypeString", - "description": "Shared processor pool ID", - "computed": true + "name": "spp_placement_groups", + "type": "TypeList", + "description": "SPP placement groups the shared processor pool are in", + "optional": true, + "elem": { + "type": "TypeString" + } }, { "name": "allocated_cores", @@ -129300,43 +134357,37 @@ "computed": true }, { - "name": "spp_placement_groups", - "type": "TypeList", - "description": "SPP placement groups the shared processor pool are in", - "optional": true, - "elem": { - "type": "TypeString" - } - } - ], - "ibm_pi_snapshot": [ - { - "name": "snapshot_id", + "name": "status_detail", "type": "TypeString", - "description": "ID of the PVM instance snapshot", + "description": "The status details of the shared processor pool", "computed": true }, { - "name": "pi_snap_shot_name", - "type": "TypeString", - "description": "Unique name of the snapshot", + "name": "pi_shared_processor_pool_reserved_cores", + "type": "TypeInt", + "description": "The amount of reserved cores for the shared processor pool", "required": true }, { - "name": "pi_instance_name", + "name": "pi_cloud_instance_id", "type": "TypeString", - "description": "Instance name / id of the pvm", + "description": "PI cloud instance ID", "required": true }, { - "name": "pi_volume_ids", - "type": "TypeSet", - "description": "List of PI volumes", - "optional": true, - "elem": { - "type": "TypeString" - } + "name": "pi_shared_processor_pool_placement_group_id", + "type": "TypeString", + "description": "Placement group the shared processor pool is created in", + "optional": true }, + { + "name": "shared_processor_pool_id", + "type": "TypeString", + "description": "Shared processor pool ID", + "computed": true + } + ], + "ibm_pi_snapshot": [ { "name": "pi_description", "type": "TypeString", @@ -129351,10 +134402,25 @@ "deprecated": "This field is deprecated, use snapshot_id instead" }, { - "name": "volume_snapshots", - "type": "TypeMap", + "name": "status", + "type": "TypeString", "computed": true }, + { + "name": "pi_snap_shot_name", + "type": "TypeString", + "description": "Unique name of the snapshot", + "required": true + }, + { + "name": "pi_volume_ids", + "type": "TypeSet", + "description": "List of PI volumes", + "optional": true, + "elem": { + "type": "TypeString" + } + }, { "name": "pi_cloud_instance_id", "type": "TypeString", @@ -129369,8 +134435,9 @@ "deprecated": "This field is deprecated, use pi_description instead" }, { - "name": "status", + "name": "snapshot_id", "type": "TypeString", + "description": "ID of the PVM instance snapshot", "computed": true }, { @@ -129382,6 +134449,17 @@ "name": "last_update_date", "type": "TypeString", "computed": true + }, + { + "name": "volume_snapshots", + "type": "TypeMap", + "computed": true + }, + { + "name": "pi_instance_name", + "type": "TypeString", + "description": "Instance name / id of the pvm", + "required": true } ], "ibm_pi_spp_placement_group": [ @@ -129424,22 +134502,15 @@ ], "ibm_pi_volume": [ { - "name": "pi_volume_size", - "type": "TypeFloat", - "description": "Size of the volume in GB", - "required": true - }, - { - "name": "pi_volume_pool", - "type": "TypeString", - "description": "Volume pool where the volume will be created; if provided then pi_volume_type and pi_affinity_policy values will be ignored", - "optional": true, - "computed": true + "name": "pi_volume_shareable", + "type": "TypeBool", + "description": "Flag to indicate if the volume can be shared across multiple instances?", + "optional": true }, { - "name": "pi_affinity_policy", + "name": "pi_affinity_volume", "type": "TypeString", - "description": "Affinity policy for data volume being created; ignored if pi_volume_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified", + "description": "Volume (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_instance is not provided", "optional": true }, { @@ -129450,23 +134521,41 @@ "computed": true }, { - "name": "volume_status", + "name": "volume_id", "type": "TypeString", - "description": "Volume status", + "description": "Volume ID", "computed": true }, { - "name": "auxiliary_volume_name", + "name": "auxiliary", + "type": "TypeBool", + "description": "true if volume is auxiliary otherwise false", + "computed": true + }, + { + "name": "replication_status", "type": "TypeString", - "description": "Indicates auxiliary volume name", + "description": "Replication status of a volume", "computed": true }, + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "description": "Cloud Instance ID - This is the service_instance_id.", + "required": true + }, { "name": "pi_volume_name", "type": "TypeString", "description": "Volume Name to create", "required": true }, + { + "name": "pi_affinity_policy", + "type": "TypeString", + "description": "Affinity policy for data volume being created; ignored if pi_volume_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified", + "optional": true + }, { "name": "pi_affinity_instance", "type": "TypeString", @@ -129483,41 +134572,26 @@ } }, { - "name": "delete_on_termination", - "type": "TypeBool", - "description": "Should the volume be deleted during termination", - "computed": true - }, - { - "name": "replication_type", - "type": "TypeString", - "description": "Replication type(metro,global)", - "computed": true + "name": "pi_anti_affinity_instances", + "type": "TypeList", + "description": "List of pvmInstances to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided", + "optional": true, + "elem": { + "type": "TypeString" + } }, { - "name": "mirroring_state", + "name": "volume_status", "type": "TypeString", - "description": "Mirroring state for replication enabled volume", + "description": "Volume status", "computed": true }, { - "name": "primary_role", + "name": "master_volume_name", "type": "TypeString", - "description": "Indicates whether master/aux volume is playing the primary role", + "description": "Indicates master volume name", "computed": true }, - { - "name": "pi_cloud_instance_id", - "type": "TypeString", - "description": "Cloud Instance ID - This is the service_instance_id.", - "required": true - }, - { - "name": "pi_volume_shareable", - "type": "TypeBool", - "description": "Flag to indicate if the volume can be shared across multiple instances?", - "optional": true - }, { "name": "pi_volume_type", "type": "TypeString", @@ -129526,13 +134600,10 @@ "computed": true }, { - "name": "pi_anti_affinity_instances", - "type": "TypeList", - "description": "List of pvmInstances to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided", - "optional": true, - "elem": { - "type": "TypeString" - } + "name": "delete_on_termination", + "type": "TypeBool", + "description": "Should the volume be deleted during termination", + "computed": true }, { "name": "consistency_group_name", @@ -129547,21 +134618,22 @@ "computed": true }, { - "name": "master_volume_name", + "name": "auxiliary_volume_name", "type": "TypeString", - "description": "Indicates master volume name", + "description": "Indicates auxiliary volume name", "computed": true }, { - "name": "pi_affinity_volume", - "type": "TypeString", - "description": "Volume (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_instance is not provided", - "optional": true + "name": "pi_volume_size", + "type": "TypeFloat", + "description": "Size of the volume in GB", + "required": true }, { - "name": "volume_id", + "name": "pi_volume_pool", "type": "TypeString", - "description": "Volume ID", + "description": "Volume pool where the volume will be created; if provided then pi_volume_type and pi_affinity_policy values will be ignored", + "optional": true, "computed": true }, { @@ -129571,19 +134643,32 @@ "computed": true }, { - "name": "auxiliary", - "type": "TypeBool", - "description": "true if volume is auxiliary otherwise false", + "name": "replication_type", + "type": "TypeString", + "description": "Replication type(metro,global)", "computed": true }, { - "name": "replication_status", + "name": "mirroring_state", "type": "TypeString", - "description": "Replication status of a volume", + "description": "Mirroring state for replication enabled volume", + "computed": true + }, + { + "name": "primary_role", + "type": "TypeString", + "description": "Indicates whether master/aux volume is playing the primary role", "computed": true } ], "ibm_pi_volume_attach": [ + { + "name": "pi_cloud_instance_id", + "type": "TypeString", + "description": "Cloud Instance ID - This is the service_instance_id.", + "immutable": true, + "required": true + }, { "name": "pi_volume_id", "type": "TypeString", @@ -129602,13 +134687,6 @@ "name": "status", "type": "TypeString", "computed": true - }, - { - "name": "pi_cloud_instance_id", - "type": "TypeString", - "description": "Cloud Instance ID - This is the service_instance_id.", - "immutable": true, - "required": true } ], "ibm_pi_volume_group": [ @@ -129627,12 +134705,36 @@ "type": "TypeString" } }, + { + "name": "volume_group_id", + "type": "TypeString", + "description": "Volume Group ID", + "computed": true + }, + { + "name": "volume_group_status", + "type": "TypeString", + "description": "Volume Group Status", + "computed": true + }, { "name": "replication_status", "type": "TypeString", "description": "Volume Group Replication Status", "computed": true }, + { + "name": "pi_volume_group_name", + "type": "TypeString", + "description": "Volume Group Name to create", + "optional": true + }, + { + "name": "pi_consistency_group_name", + "type": "TypeString", + "description": "The name of consistency group at storage controller level", + "optional": true + }, { "name": "status_description_errors", "type": "TypeSet", @@ -129663,30 +134765,6 @@ "type": "TypeString", "description": "Consistency Group Name if volume is a part of volume group", "computed": true - }, - { - "name": "pi_volume_group_name", - "type": "TypeString", - "description": "Volume Group Name to create", - "optional": true - }, - { - "name": "pi_consistency_group_name", - "type": "TypeString", - "description": "The name of consistency group at storage controller level", - "optional": true - }, - { - "name": "volume_group_id", - "type": "TypeString", - "description": "Volume Group ID", - "computed": true - }, - { - "name": "volume_group_status", - "type": "TypeString", - "description": "Volume Group Status", - "computed": true } ], "ibm_pi_volume_group_action": [ @@ -129778,13 +134856,10 @@ ], "ibm_pi_volume_onboarding": [ { - "name": "input_volumes", - "type": "TypeList", - "description": "List of volumes requested to be onboarded", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "onboarding_id", + "type": "TypeString", + "description": "Indicates the volume onboarding operation id", + "computed": true }, { "name": "progress", @@ -129792,34 +134867,6 @@ "description": "Indicates the progress of volume onboarding operation", "computed": true }, - { - "name": "results_onboarded_volumes", - "type": "TypeList", - "description": "List of volumes which are onboarded successfully", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "pi_description", - "type": "TypeString", - "description": "Description of the volume onboarding operation", - "optional": true, - "computed": true - }, - { - "name": "create_time", - "type": "TypeString", - "description": "Indicates the create-time of volume onboarding operation", - "computed": true - }, - { - "name": "onboarding_id", - "type": "TypeString", - "description": "Indicates the volume onboarding operation id", - "computed": true - }, { "name": "results_volume_onboarding_failures", "type": "TypeList", @@ -129889,43 +134936,74 @@ } }, "min_items": 1 + }, + { + "name": "create_time", + "type": "TypeString", + "description": "Indicates the create-time of volume onboarding operation", + "computed": true + }, + { + "name": "pi_description", + "type": "TypeString", + "description": "Description of the volume onboarding operation", + "optional": true, + "computed": true + }, + { + "name": "input_volumes", + "type": "TypeList", + "description": "List of volumes requested to be onboarded", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "results_onboarded_volumes", + "type": "TypeList", + "description": "List of volumes which are onboarded successfully", + "computed": true, + "elem": { + "type": "TypeString" + } } ], "ibm_pi_vpn_connection": [ { - "name": "pi_vpn_connection_mode", + "name": "pi_ipsec_policy_id", "type": "TypeString", - "description": "Mode used by this VPN Connection, either 'policy' or 'route'", + "description": "Unique identifier of IPSec Policy selected for this VPN Connection", "required": true }, { - "name": "pi_peer_gateway_address", + "name": "pi_vpn_connection_mode", "type": "TypeString", - "description": "Peer Gateway address", + "description": "Mode used by this VPN Connection, either 'policy' or 'route'", "required": true }, { - "name": "gateway_address", + "name": "local_gateway_address", "type": "TypeString", - "description": "Public IP address of the VPN Gateway (vSRX) attached to this VPN Connection", + "description": "Local Gateway address, only in 'route' mode", "computed": true }, { - "name": "dead_peer_detections", - "type": "TypeMap", - "description": "Dead Peer Detection", + "name": "connection_status", + "type": "TypeString", + "description": "Status of the VPN connection", "computed": true }, { - "name": "pi_cloud_instance_id", + "name": "gateway_address", "type": "TypeString", - "description": "PI cloud instance ID", - "required": true + "description": "Public IP address of the VPN Gateway (vSRX) attached to this VPN Connection", + "computed": true }, { - "name": "pi_vpn_connection_name", + "name": "pi_cloud_instance_id", "type": "TypeString", - "description": "Name of the VPN Connection", + "description": "PI cloud instance ID", "required": true }, { @@ -129935,26 +135013,11 @@ "required": true }, { - "name": "pi_ipsec_policy_id", + "name": "pi_peer_gateway_address", "type": "TypeString", - "description": "Unique identifier of IPSec Policy selected for this VPN Connection", + "description": "Peer Gateway address", "required": true }, - { - "name": "connection_status", - "type": "TypeString", - "description": "Status of the VPN connection", - "computed": true - }, - { - "name": "pi_networks", - "type": "TypeSet", - "description": "Set of network IDs to attach to this VPN connection", - "required": true, - "elem": { - "type": "TypeString" - } - }, { "name": "pi_peer_subnets", "type": "TypeSet", @@ -129971,19 +135034,28 @@ "computed": true }, { - "name": "local_gateway_address", - "type": "TypeString", - "description": "Local Gateway address, only in 'route' mode", + "name": "dead_peer_detections", + "type": "TypeMap", + "description": "Dead Peer Detection", "computed": true - } - ], - "ibm_pn_application_chrome": [ + }, { - "name": "web_site_url", + "name": "pi_vpn_connection_name", "type": "TypeString", - "description": "The URL of the WebSite / WebApp that should be permitted to subscribe to WebPush.", + "description": "Name of the VPN Connection", "required": true }, + { + "name": "pi_networks", + "type": "TypeSet", + "description": "Set of network IDs to attach to this VPN connection", + "required": true, + "elem": { + "type": "TypeString" + } + } + ], + "ibm_pn_application_chrome": [ { "name": "guid", "type": "TypeString", @@ -129996,91 +135068,15 @@ "type": "TypeString", "description": "A server key that gives the push service an authorized access to Google services that is used for Chrome Web Push.", "required": true + }, + { + "name": "web_site_url", + "type": "TypeString", + "description": "The URL of the WebSite / WebApp that should be permitted to subscribe to WebPush.", + "required": true } ], "ibm_project_instance": [ - { - "name": "metadata", - "type": "TypeList", - "description": "The metadata of the project.", - "computed": true, - "elem": { - "created_at": { - "name": "created_at", - "type": "TypeString", - "description": "A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ, matching the date and time format as specified by RFC 3339.", - "computed": true - }, - "crn": { - "name": "crn", - "type": "TypeString", - "description": "An IBM Cloud resource name, which uniquely identifies a resource.", - "computed": true - }, - "cumulative_needs_attention_view": { - "name": "cumulative_needs_attention_view", - "type": "TypeList", - "description": "The cumulative list of needs attention items for a project.", - "computed": true, - "elem": { - "config_id": { - "name": "config_id", - "type": "TypeString", - "description": "The unique ID of a project.", - "computed": true - }, - "config_version": { - "name": "config_version", - "type": "TypeInt", - "description": "The version number of the configuration.", - "computed": true - }, - "event": { - "name": "event", - "type": "TypeString", - "description": "The event name.", - "computed": true - }, - "event_id": { - "name": "event_id", - "type": "TypeString", - "description": "The unique ID of a project.", - "computed": true - } - } - }, - "cumulative_needs_attention_view_err": { - "name": "cumulative_needs_attention_view_err", - "type": "TypeString", - "description": "True indicates that the fetch of the needs attention items failed.", - "computed": true - }, - "event_notifications_crn": { - "name": "event_notifications_crn", - "type": "TypeString", - "description": "The CRN of the event notifications instance if one is connected to this project.", - "computed": true - }, - "location": { - "name": "location", - "type": "TypeString", - "description": "The IBM Cloud location where a resource is deployed.", - "computed": true - }, - "resource_group": { - "name": "resource_group", - "type": "TypeString", - "description": "The resource group where the project's data and tools are created.", - "computed": true - }, - "state": { - "name": "state", - "type": "TypeString", - "description": "The project status value.", - "computed": true - } - } - }, { "name": "name", "type": "TypeString", @@ -130202,29 +135198,121 @@ "description": "An IBM Cloud resource name, which uniquely identifies a resource.", "cloud_data_type": "crn", "computed": true + }, + { + "name": "metadata", + "type": "TypeList", + "description": "The metadata of the project.", + "computed": true, + "elem": { + "created_at": { + "name": "created_at", + "type": "TypeString", + "description": "A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ, matching the date and time format as specified by RFC 3339.", + "computed": true + }, + "crn": { + "name": "crn", + "type": "TypeString", + "description": "An IBM Cloud resource name, which uniquely identifies a resource.", + "computed": true + }, + "cumulative_needs_attention_view": { + "name": "cumulative_needs_attention_view", + "type": "TypeList", + "description": "The cumulative list of needs attention items for a project.", + "computed": true, + "elem": { + "config_id": { + "name": "config_id", + "type": "TypeString", + "description": "The unique ID of a project.", + "computed": true + }, + "config_version": { + "name": "config_version", + "type": "TypeInt", + "description": "The version number of the configuration.", + "computed": true + }, + "event": { + "name": "event", + "type": "TypeString", + "description": "The event name.", + "computed": true + }, + "event_id": { + "name": "event_id", + "type": "TypeString", + "description": "The unique ID of a project.", + "computed": true + } + } + }, + "cumulative_needs_attention_view_err": { + "name": "cumulative_needs_attention_view_err", + "type": "TypeString", + "description": "True indicates that the fetch of the needs attention items failed.", + "computed": true + }, + "event_notifications_crn": { + "name": "event_notifications_crn", + "type": "TypeString", + "description": "The CRN of the event notifications instance if one is connected to this project.", + "computed": true + }, + "location": { + "name": "location", + "type": "TypeString", + "description": "The IBM Cloud location where a resource is deployed.", + "computed": true + }, + "resource_group": { + "name": "resource_group", + "type": "TypeString", + "description": "The resource group where the project's data and tools are created.", + "computed": true + }, + "state": { + "name": "state", + "type": "TypeString", + "description": "The project status value.", + "computed": true + } + } } ], "ibm_resource_group": [ { - "name": "payment_methods_url", + "name": "crn", "type": "TypeString", - "description": "The URL to access the payment methods details that associated with the resource group.", + "description": "The full CRN associated with the resource group", + "cloud_data_type": "crn", "computed": true }, { - "name": "quota_id", + "name": "created_at", "type": "TypeString", - "description": "An alpha-numeric value identifying the quota ID associated with the resource group.", + "description": "The date when the resource group was initially created.", "computed": true }, { - "name": "resource_linkages", - "type": "TypeSet", - "description": "An array of the resources that linked to the resource group", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "updated_at", + "type": "TypeString", + "description": "The date when the resource group was last updated.", + "computed": true + }, + { + "name": "teams_url", + "type": "TypeString", + "description": "The URL to access the team details that associated with the resource group.", + "computed": true + }, + { + "name": "default", + "type": "TypeBool", + "description": "Specifies whether its default resource group or not", + "computed": true }, { "name": "state", @@ -130242,28 +135330,19 @@ } }, { - "name": "created_at", - "type": "TypeString", - "description": "The date when the resource group was initially created.", - "computed": true - }, - { - "name": "updated_at", - "type": "TypeString", - "description": "The date when the resource group was last updated.", - "computed": true - }, - { - "name": "teams_url", + "name": "quota_id", "type": "TypeString", - "description": "The URL to access the team details that associated with the resource group.", + "description": "An alpha-numeric value identifying the quota ID associated with the resource group.", "computed": true }, { - "name": "quota_url", - "type": "TypeString", - "description": "The URL to access the quota details that associated with the resource group.", - "computed": true + "name": "resource_linkages", + "type": "TypeSet", + "description": "An array of the resources that linked to the resource group", + "computed": true, + "elem": { + "type": "TypeString" + } }, { "name": "name", @@ -130272,66 +135351,53 @@ "required": true }, { - "name": "default", - "type": "TypeBool", - "description": "Specifies whether its default resource group or not", + "name": "payment_methods_url", + "type": "TypeString", + "description": "The URL to access the payment methods details that associated with the resource group.", "computed": true }, { - "name": "crn", + "name": "quota_url", "type": "TypeString", - "description": "The full CRN associated with the resource group", - "cloud_data_type": "crn", + "description": "The URL to access the quota details that associated with the resource group.", "computed": true } ], "ibm_resource_instance": [ { - "name": "type", + "name": "resource_plan_id", "type": "TypeString", - "description": "The type of the instance, e.g. service_instance.", + "description": "The unique ID of the plan associated with the offering", "computed": true }, { - "name": "restored_at", + "name": "deleted_at", "type": "TypeString", - "description": "The date when the instance under reclamation was restored.", + "description": "The date when the instance was deleted.", "computed": true }, { - "name": "resource_crn", + "name": "scheduled_reclaim_at", "type": "TypeString", - "description": "The crn of the resource", - "computed": true - }, - { - "name": "extensions", - "type": "TypeMap", - "description": "The extended metadata as a map associated with the resource instance.", + "description": "The date when the instance was scheduled for reclamation.", "computed": true }, { - "name": "name", - "type": "TypeString", - "description": "A name for the resource instance", - "required": true - }, - { - "name": "plan", + "name": "scheduled_reclaim_by", "type": "TypeString", - "description": "The plan type of the service", - "required": true + "description": "The subject who initiated the instance reclamation.", + "computed": true }, { - "name": "resource_group_crn", + "name": "restored_by", "type": "TypeString", - "description": "The long ID (full CRN) of the resource group", + "description": "The subject who restored the instance back from reclamation.", "computed": true }, { - "name": "guid", + "name": "resource_controller_url", "type": "TypeString", - "description": "Guid of resource instance", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource", "computed": true }, { @@ -130353,15 +135419,15 @@ } }, { - "name": "resource_plan_id", + "name": "resource_id", "type": "TypeString", - "description": "The unique ID of the plan associated with the offering", + "description": "The unique ID of the offering", "computed": true }, { - "name": "allow_cleanup", - "type": "TypeBool", - "description": "A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.", + "name": "resource_bindings_url", + "type": "TypeString", + "description": "The relative path to the resource bindings for the instance.", "computed": true }, { @@ -130371,30 +135437,62 @@ "computed": true }, { - "name": "update_at", + "name": "service", "type": "TypeString", - "description": "The date when the instance was last updated.", - "computed": true + "description": "The name of the service offering like cloud-object-storage, kms etc", + "immutable": true, + "required": true }, { - "name": "restored_by", + "name": "update_by", "type": "TypeString", - "description": "The subject who restored the instance back from reclamation.", + "description": "The subject who updated the instance.", "computed": true }, { - "name": "resource_status", + "name": "restored_at", "type": "TypeString", - "description": "The status of the resource", + "description": "The date when the instance under reclamation was restored.", "computed": true }, { - "name": "service", + "name": "location", "type": "TypeString", - "description": "The name of the service offering like cloud-object-storage, kms etc", + "description": "The location where the instance available", + "cloud_data_type": "region", "immutable": true, "required": true }, + { + "name": "status", + "type": "TypeString", + "description": "Status of resource instance", + "computed": true + }, + { + "name": "target_crn", + "type": "TypeString", + "description": "The full deployment CRN as defined in the global catalog", + "computed": true + }, + { + "name": "locked", + "type": "TypeBool", + "description": "A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.", + "computed": true + }, + { + "name": "created_by", + "type": "TypeString", + "description": "The subject who created the instance.", + "computed": true + }, + { + "name": "resource_status", + "type": "TypeString", + "description": "The status of the resource", + "computed": true + }, { "name": "tags", "type": "TypeSet", @@ -130408,53 +135506,51 @@ } }, { - "name": "resource_group_name", + "name": "resource_group_id", "type": "TypeString", - "description": "The resource group name in which resource is provisioned", - "computed": true + "description": "The resource group id", + "cloud_data_type": "resource_group", + "immutable": true, + "optional": true, + "computed": true, + "cloud_data_range": [ + "resolved_to:id" + ] }, { - "name": "update_by", + "name": "state", "type": "TypeString", - "description": "The subject who updated the instance.", + "description": "The current state of the instance.", "computed": true }, { - "name": "service_endpoints", + "name": "sub_type", "type": "TypeString", - "description": "Types of the service endpoints. Possible values are 'public', 'private', 'public-and-private'.", - "optional": true, + "description": "The sub-type of instance, e.g. cfaas .", "computed": true }, { - "name": "resource_bindings_url", + "name": "resource_group_name", "type": "TypeString", - "description": "The relative path to the resource bindings for the instance.", + "description": "The resource group name in which resource is provisioned", "computed": true }, { - "name": "target_crn", + "name": "plan", "type": "TypeString", - "description": "The full deployment CRN as defined in the global catalog", - "computed": true + "description": "The plan type of the service", + "required": true }, { - "name": "locked", - "type": "TypeBool", - "description": "A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.", + "name": "guid", + "type": "TypeString", + "description": "Guid of resource instance", "computed": true }, { - "name": "parameters", - "type": "TypeMap", - "description": "Arbitrary parameters to pass. Must be a JSON object", - "optional": true - }, - { - "name": "crn", + "name": "type", "type": "TypeString", - "description": "CRN of resource instance", - "cloud_data_type": "crn", + "description": "The type of the instance, e.g. service_instance.", "computed": true }, { @@ -130464,52 +135560,34 @@ "computed": true }, { - "name": "deleted_by", - "type": "TypeString", - "description": "The subject who deleted the instance.", - "computed": true - }, - { - "name": "status", - "type": "TypeString", - "description": "Status of resource instance", - "computed": true - }, - { - "name": "state", + "name": "created_at", "type": "TypeString", - "description": "The current state of the instance.", + "description": "The date when the instance was created.", "computed": true }, { - "name": "sub_type", + "name": "update_at", "type": "TypeString", - "description": "The sub-type of instance, e.g. cfaas .", + "description": "The date when the instance was last updated.", "computed": true }, { - "name": "deleted_at", + "name": "deleted_by", "type": "TypeString", - "description": "The date when the instance was deleted.", + "description": "The subject who deleted the instance.", "computed": true }, { - "name": "scheduled_reclaim_at", + "name": "resource_crn", "type": "TypeString", - "description": "The date when the instance was scheduled for reclamation.", + "description": "The crn of the resource", "computed": true }, { - "name": "resource_group_id", + "name": "name", "type": "TypeString", - "description": "The resource group id", - "cloud_data_type": "resource_group", - "immutable": true, - "optional": true, - "computed": true, - "cloud_data_range": [ - "resolved_to:id" - ] + "description": "A name for the resource instance", + "required": true }, { "name": "parameters_json", @@ -130524,9 +135602,9 @@ "computed": true }, { - "name": "resource_id", + "name": "resource_group_crn", "type": "TypeString", - "description": "The unique ID of the offering", + "description": "The long ID (full CRN) of the resource group", "computed": true }, { @@ -130536,30 +135614,29 @@ "computed": true }, { - "name": "created_at", + "name": "resource_name", "type": "TypeString", - "description": "The date when the instance was created.", + "description": "The name of the resource", "computed": true }, { - "name": "created_by", - "type": "TypeString", - "description": "The subject who created the instance.", + "name": "extensions", + "type": "TypeMap", + "description": "The extended metadata as a map associated with the resource instance.", "computed": true }, { - "name": "scheduled_reclaim_by", - "type": "TypeString", - "description": "The subject who initiated the instance reclamation.", - "computed": true + "name": "parameters", + "type": "TypeMap", + "description": "Arbitrary parameters to pass. Must be a JSON object", + "optional": true }, { - "name": "location", + "name": "service_endpoints", "type": "TypeString", - "description": "The location where the instance available", - "cloud_data_type": "region", - "immutable": true, - "required": true + "description": "Types of the service endpoints. Possible values are 'public', 'private', 'public-and-private'.", + "optional": true, + "computed": true }, { "name": "dashboard_url", @@ -130568,25 +135645,20 @@ "computed": true }, { - "name": "resource_name", - "type": "TypeString", - "description": "The name of the resource", + "name": "allow_cleanup", + "type": "TypeBool", + "description": "A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.", "computed": true }, { - "name": "resource_controller_url", + "name": "crn", "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource", + "description": "CRN of resource instance", + "cloud_data_type": "crn", "computed": true } ], "ibm_resource_key": [ - { - "name": "deleted_by", - "type": "TypeString", - "description": "The subject who deleted the key.", - "computed": true - }, { "name": "name", "type": "TypeString", @@ -130595,42 +135667,33 @@ "required": true }, { - "name": "parameters", - "type": "TypeMap", - "description": "Arbitrary parameters to pass. Must be a JSON object", - "optional": true - }, - { - "name": "tags", - "type": "TypeSet", - "cloud_data_type": "tags", - "optional": true, - "elem": { - "type": "TypeString" - } + "name": "url", + "type": "TypeString", + "description": "When you created a new key, a relative URL path is created identifying the location of the key.", + "computed": true }, { - "name": "guid", + "name": "source_crn", "type": "TypeString", - "description": "When you create a new key, a globally unique identifier (GUID) is assigned.", + "description": "The CRN of resource instance or alias associated to the key.", "computed": true }, { - "name": "account_id", + "name": "created_at", "type": "TypeString", - "description": "An alpha-numeric value identifying the account ID.", + "description": "The date when the key was created.", "computed": true }, { - "name": "source_crn", + "name": "created_by", "type": "TypeString", - "description": "The CRN of resource instance or alias associated to the key.", + "description": "The subject who created the key.", "computed": true }, { - "name": "updated_by", + "name": "resource_instance_url", "type": "TypeString", - "description": "The subject who updated the key.", + "description": "The relative path to the resource.", "computed": true }, { @@ -130640,6 +135703,13 @@ "immutable": true, "optional": true }, + { + "name": "credentials", + "type": "TypeMap", + "description": "Credentials asociated with the key", + "secure": true, + "computed": true + }, { "name": "credentials_json", "type": "TypeString", @@ -130647,6 +135717,15 @@ "secure": true, "computed": true }, + { + "name": "tags", + "type": "TypeSet", + "cloud_data_type": "tags", + "optional": true, + "elem": { + "type": "TypeString" + } + }, { "name": "crn", "type": "TypeString", @@ -130655,22 +135734,39 @@ "computed": true }, { - "name": "resource_group_id", + "name": "deleted_at", "type": "TypeString", - "description": "The short ID of the resource group.", - "cloud_data_type": "resource_group", + "description": "The date when the key was deleted.", "computed": true }, { - "name": "state", + "name": "deleted_by", "type": "TypeString", - "description": "The state of the key.", + "description": "The subject who deleted the key.", "computed": true }, { - "name": "iam_compatible", - "type": "TypeBool", - "description": "Specifies whether the key's credentials support IAM.", + "name": "parameters", + "type": "TypeMap", + "description": "Arbitrary parameters to pass. Must be a JSON object", + "optional": true + }, + { + "name": "status", + "type": "TypeString", + "description": "Status of resource key", + "computed": true + }, + { + "name": "guid", + "type": "TypeString", + "description": "When you create a new key, a globally unique identifier (GUID) is assigned.", + "computed": true + }, + { + "name": "state", + "type": "TypeString", + "description": "The state of the key.", "computed": true }, { @@ -130679,6 +135775,12 @@ "description": "The date when the key was last updated.", "computed": true }, + { + "name": "updated_by", + "type": "TypeString", + "description": "The subject who updated the key.", + "computed": true + }, { "name": "role", "type": "TypeString", @@ -130698,56 +135800,26 @@ ] }, { - "name": "credentials", - "type": "TypeMap", - "description": "Credentials asociated with the key", - "secure": true, - "computed": true - }, - { - "name": "status", - "type": "TypeString", - "description": "Status of resource key", - "computed": true - }, - { - "name": "url", - "type": "TypeString", - "description": "When you created a new key, a relative URL path is created identifying the location of the key.", - "computed": true - }, - { - "name": "resource_instance_url", - "type": "TypeString", - "description": "The relative path to the resource.", - "computed": true - }, - { - "name": "created_by", + "name": "account_id", "type": "TypeString", - "description": "The subject who created the key.", + "description": "An alpha-numeric value identifying the account ID.", "computed": true }, { - "name": "created_at", + "name": "resource_group_id", "type": "TypeString", - "description": "The date when the key was created.", + "description": "The short ID of the resource group.", + "cloud_data_type": "resource_group", "computed": true }, { - "name": "deleted_at", - "type": "TypeString", - "description": "The date when the key was deleted.", + "name": "iam_compatible", + "type": "TypeBool", + "description": "Specifies whether the key's credentials support IAM.", "computed": true } ], "ibm_resource_tag": [ - { - "name": "acccount_id", - "type": "TypeString", - "description": "The ID of the account that owns the resources to be tagged (required if tag-type is set to service)", - "computed": true - }, { "name": "resource_id", "type": "TypeString", @@ -130783,16 +135855,15 @@ "options": "service,access,user", "optional": true, "computed": true + }, + { + "name": "acccount_id", + "type": "TypeString", + "description": "The ID of the account that owns the resources to be tagged (required if tag-type is set to service)", + "computed": true } ], "ibm_satellite_cluster": [ - { - "name": "worker_count", - "type": "TypeInt", - "description": "The number of worker nodes per zone in the default worker pool. Required when '--host-label' is specified. (default: 0)", - "optional": true, - "computed": true - }, { "name": "pod_subnet", "type": "TypeString", @@ -130801,20 +135872,17 @@ "computed": true }, { - "name": "ingress_hostname", - "type": "TypeString", - "computed": true - }, - { - "name": "ingress_secret", + "name": "public_service_endpoint_url", "type": "TypeString", - "secure": true, "computed": true }, { - "name": "host_labels", + "name": "tags", "type": "TypeSet", - "description": "Labels that describe a Satellite host for default workerpool", + "description": "List of tags for the resources", + "min_length": 1, + "max_length": 128, + "matches": "^[A-Za-z0-9:_ .-]+$", "optional": true, "computed": true, "elem": { @@ -130822,11 +135890,39 @@ } }, { - "name": "state", + "name": "disable_public_service_endpoint", + "type": "TypeBool", + "description": "Boolean value true if Public service endpoint to be disabled", + "default_value": false, + "optional": true + }, + { + "name": "crn_token", "type": "TypeString", - "description": "The lifecycle state of the cluster.", + "description": "The IBM Cloud Identity and Access Management (IAM) service CRN token for the service that creates the cluster.", + "secure": true, + "optional": true + }, + { + "name": "operating_system", + "type": "TypeString", + "description": "Operating system of the default worker pool. Options are REDHAT_7_64, REDHAT_8_64, or RHCOS.", + "optional": true, + "computed": true + }, + { + "name": "worker_count", + "type": "TypeInt", + "description": "The number of worker nodes per zone in the default worker pool. Required when '--host-label' is specified. (default: 0)", + "optional": true, "computed": true }, + { + "name": "pull_secret", + "type": "TypeString", + "description": "The RedHat pull secret to create the OpenShift cluster", + "optional": true + }, { "name": "resource_group_id", "type": "TypeString", @@ -130836,16 +135932,23 @@ "computed": true }, { - "name": "resource_group_name", + "name": "name", + "type": "TypeString", + "description": "The unique name for the new IBM Cloud Satellite cluster", + "immutable": true, + "required": true + }, + { + "name": "master_url", "type": "TypeString", - "description": "The resource group name in which resource is provisioned", "computed": true }, { - "name": "patch_version", + "name": "location", "type": "TypeString", - "description": "Kubernetes patch version", - "optional": true + "description": "The name or ID of the Satellite location", + "cloud_data_type": "region", + "required": true }, { "name": "public_service_endpoint_enabled", @@ -130853,50 +135956,20 @@ "computed": true }, { - "name": "kube_version", + "name": "ingress_hostname", "type": "TypeString", - "description": "The OpenShift Container Platform version", - "optional": true, "computed": true }, { - "name": "tags", + "name": "host_labels", "type": "TypeSet", - "description": "List of tags for the resources", - "min_length": 1, - "max_length": 128, - "matches": "^[A-Za-z0-9:_ .-]+$", + "description": "Labels that describe a Satellite host for default workerpool", "optional": true, "computed": true, "elem": { "type": "TypeString" } }, - { - "name": "crn_token", - "type": "TypeString", - "description": "The IBM Cloud Identity and Access Management (IAM) service CRN token for the service that creates the cluster.", - "secure": true, - "optional": true - }, - { - "name": "master_status", - "type": "TypeString", - "computed": true - }, - { - "name": "wait_for_worker_update", - "type": "TypeBool", - "description": "Wait for worker node to update during kube version update.", - "default_value": true, - "optional": true - }, - { - "name": "retry_patch_version", - "type": "TypeInt", - "description": "Argument which helps to retry the patch version updates on worker nodes. Increment the value to retry the patch updates if the previous apply fails", - "optional": true - }, { "name": "zones", "type": "TypeSet", @@ -130913,36 +135986,9 @@ } }, { - "name": "service_subnet", - "type": "TypeString", - "description": "User provided value for service subnet", - "optional": true, - "computed": true - }, - { - "name": "location", - "type": "TypeString", - "description": "The name or ID of the Satellite location", - "cloud_data_type": "region", - "required": true - }, - { - "name": "crn", - "type": "TypeString", - "description": "CRN of resource instance", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "operating_system", - "type": "TypeString", - "description": "Operating system of the default worker pool. Options are REDHAT_7_64, REDHAT_8_64, or RHCOS.", - "optional": true, - "computed": true - }, - { - "name": "public_service_endpoint_url", + "name": "resource_group_name", "type": "TypeString", + "description": "The resource group name in which resource is provisioned", "computed": true }, { @@ -130951,23 +135997,22 @@ "computed": true }, { - "name": "name", + "name": "state", "type": "TypeString", - "description": "The unique name for the new IBM Cloud Satellite cluster", - "immutable": true, - "required": true + "description": "The lifecycle state of the cluster.", + "computed": true }, { - "name": "master_url", + "name": "patch_version", "type": "TypeString", - "computed": true + "description": "Kubernetes patch version", + "optional": true }, { - "name": "enable_config_admin", - "type": "TypeBool", - "description": "Grant cluster admin access to Satellite Config to manage Kubernetes resources.", - "optional": true, - "computed": true + "name": "retry_patch_version", + "type": "TypeInt", + "description": "Argument which helps to retry the patch version updates on worker nodes. Increment the value to retry the patch updates if the previous apply fails", + "optional": true }, { "name": "default_worker_pool_labels", @@ -130980,22 +136025,17 @@ } }, { - "name": "pull_secret", + "name": "crn", "type": "TypeString", - "description": "The RedHat pull secret to create the OpenShift cluster", - "optional": true - }, - { - "name": "private_service_endpoint_enabled", - "type": "TypeBool", + "description": "CRN of resource instance", + "cloud_data_type": "crn", "computed": true }, { - "name": "disable_public_service_endpoint", - "type": "TypeBool", - "description": "Boolean value true if Public service endpoint to be disabled", - "default_value": false, - "optional": true + "name": "ingress_secret", + "type": "TypeString", + "secure": true, + "computed": true }, { "name": "infrastructure_topology", @@ -131004,32 +136044,47 @@ "immutable": true, "optional": true, "computed": true - } - ], - "ibm_satellite_cluster_worker_pool": [ + }, { - "name": "disk_encryption", - "type": "TypeBool", - "description": "Disk encryption for worker node", - "optional": true + "name": "kube_version", + "type": "TypeString", + "description": "The OpenShift Container Platform version", + "optional": true, + "computed": true }, { - "name": "operating_system", + "name": "master_status", "type": "TypeString", - "description": "Operating system of the worker pool. Options are REDHAT_7_64, REDHAT_8_64, or RHCOS.", + "computed": true + }, + { + "name": "service_subnet", + "type": "TypeString", + "description": "User provided value for service subnet", "optional": true, "computed": true }, { - "name": "worker_pool_labels", - "type": "TypeMap", - "description": "Labels on all the workers in the worker pool", + "name": "wait_for_worker_update", + "type": "TypeBool", + "description": "Wait for worker node to update during kube version update.", + "default_value": true, + "optional": true + }, + { + "name": "enable_config_admin", + "type": "TypeBool", + "description": "Grant cluster admin access to Satellite Config to manage Kubernetes resources.", "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "computed": true }, + { + "name": "private_service_endpoint_enabled", + "type": "TypeBool", + "computed": true + } + ], + "ibm_satellite_cluster_worker_pool": [ { "name": "host_labels", "type": "TypeSet", @@ -131049,27 +136104,6 @@ "optional": true, "computed": true }, - { - "name": "zones", - "type": "TypeSet", - "description": "Zone info for worker pool", - "optional": true, - "computed": true, - "elem": { - "id": { - "name": "id", - "type": "TypeString", - "description": "Zone for the worker pool in a multizone cluster", - "required": true - } - } - }, - { - "name": "name", - "type": "TypeString", - "description": "The name for the worker pool", - "required": true - }, { "name": "cluster", "type": "TypeString", @@ -131077,19 +136111,6 @@ "immutable": true, "required": true }, - { - "name": "flavor", - "type": "TypeString", - "description": "The flavor defines the amount of virtual CPU, memory, and disk space that is set up in each worker node", - "optional": true, - "computed": true - }, - { - "name": "isolation", - "type": "TypeString", - "optional": true, - "computed": true - }, { "name": "entitlement", "type": "TypeString", @@ -131101,177 +136122,118 @@ "description": "Specify the desired number of workers per zone in this worker pool", "optional": true, "computed": true - } - ], - "ibm_satellite_cluster_worker_pool_zone_attachment": [ + }, { - "name": "messages", - "type": "TypeList", - "description": "Filter features by a list of comma separated collections.", + "name": "zones", + "type": "TypeSet", + "description": "Zone info for worker pool", + "optional": true, "computed": true, "elem": { - "type": "TypeString" + "id": { + "name": "id", + "type": "TypeString", + "description": "Zone for the worker pool in a multizone cluster", + "required": true + } } }, { - "name": "worker_count", - "type": "TypeInt", - "description": "Number of workers", - "computed": true - }, - { - "name": "cluster", - "type": "TypeString", - "immutable": true, - "required": true - }, - { - "name": "worker_pool", - "type": "TypeString", - "immutable": true, - "required": true + "name": "worker_pool_labels", + "type": "TypeMap", + "description": "Labels on all the workers in the worker pool", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "zone", + "name": "name", "type": "TypeString", - "immutable": true, + "description": "The name for the worker pool", "required": true }, { - "name": "resource_group_id", + "name": "flavor", "type": "TypeString", - "description": "The ID of the resource group that the Satellite location is in. To list the resource group ID of the location, use the `GET /v2/satellite/getController` API method.", - "cloud_data_type": "resource_group", - "immutable": true, - "optional": true - }, - { - "name": "autobalance_enabled", - "type": "TypeBool", + "description": "The flavor defines the amount of virtual CPU, memory, and disk space that is set up in each worker node", + "optional": true, "computed": true - } - ], - "ibm_satellite_endpoint": [ - { - "name": "timeout", - "type": "TypeInt", - "description": "The inactivity timeout in the Endpoint side.", - "min_value": "1", - "max_value": "180", - "optional": true - }, - { - "name": "created_by", - "type": "TypeString", - "description": "The service or person who created the endpoint. Must be 1000 characters or fewer.", - "optional": true - }, - { - "name": "location", - "type": "TypeString", - "description": "The Location ID.", - "cloud_data_type": "region", - "required": true - }, - { - "name": "server_port", - "type": "TypeInt", - "description": "The port number of the server endpoint. For 'http-tunnel' protocol, server_port can be 0, which means any port. Such as 0 is good for 80 (http) and 443 (https).", - "required": true - }, - { - "name": "sni", - "type": "TypeString", - "description": "The server name indicator (SNI) which used to connect to the server endpoint. Only useful if server side requires SNI.", - "optional": true }, { - "name": "client_mutual_auth", + "name": "disk_encryption", "type": "TypeBool", - "description": "Whether enable mutual auth in the client application side, when client_protocol is 'tls' or 'https', this field is required.", - "default_value": false, + "description": "Disk encryption for worker node", "optional": true }, { - "name": "server_protocol", + "name": "isolation", "type": "TypeString", - "description": "The protocol in the server application side. This parameter will change to default value if it is omitted even when using PATCH API. If client_protocol is 'udp', server_protocol must be 'udp'. If client_protocol is 'tcp'/'http', server_protocol could be 'tcp'/'tls' and default to 'tcp'. If client_protocol is 'tls'/'https', server_protocol could be 'tcp'/'tls' and default to 'tls'. If client_protocol is 'http-tunnel', server_protocol must be 'tcp'.", - "options": "tcp, tls, udp", - "optional": true - }, - { - "name": "reject_unauth", - "type": "TypeBool", - "description": "Whether reject any connection to the server application which is not authorized with the list of supplied CAs in the fields certs.server_cert.", - "default_value": false, - "optional": true + "optional": true, + "computed": true }, { - "name": "sources", - "type": "TypeList", - "computed": true, - "elem": { - "enabled": { - "name": "enabled", - "type": "TypeBool", - "description": "Whether the source is enabled for the endpoint.", - "optional": true - }, - "last_change": { - "name": "last_change", - "type": "TypeString", - "description": "The last time modify the Endpoint configurations.", - "optional": true - }, - "pending": { - "name": "pending", - "type": "TypeBool", - "description": "Whether the source has been enabled on this endpoint.", - "optional": true - }, - "source_id": { - "name": "source_id", - "type": "TypeString", - "description": "The Source ID.", - "optional": true - } + "name": "operating_system", + "type": "TypeString", + "description": "Operating system of the worker pool. Options are REDHAT_7_64, REDHAT_8_64, or RHCOS.", + "optional": true, + "computed": true + } + ], + "ibm_satellite_cluster_worker_pool_zone_attachment": [ + { + "name": "autobalance_enabled", + "type": "TypeBool", + "computed": true + }, + { + "name": "messages", + "type": "TypeList", + "description": "Filter features by a list of comma separated collections.", + "computed": true, + "elem": { + "type": "TypeString" } }, { - "name": "last_change", - "type": "TypeString", - "description": "The last time modify the Endpoint configurations.", + "name": "worker_count", + "type": "TypeInt", + "description": "Number of workers", "computed": true }, { - "name": "display_name", + "name": "cluster", "type": "TypeString", - "description": "The display name of the endpoint. Endpoint names must start with a letter and end with an alphanumeric character, can contain letters, numbers, and hyphen (-), and must be 63 characters or fewer.", + "immutable": true, "required": true }, { - "name": "client_protocol", + "name": "worker_pool", "type": "TypeString", - "description": "The protocol in the client application side.", - "required": true, - "options": "http, http-tunnel, https, tcp, tls, udp" + "immutable": true, + "required": true }, { - "name": "endpoint_id", + "name": "zone", "type": "TypeString", - "description": "The Endpoint ID.", - "computed": true + "immutable": true, + "required": true }, { - "name": "server_host", + "name": "resource_group_id", "type": "TypeString", - "description": "The host name or IP address of the server endpoint. For 'http-tunnel' protocol, server_host can start with '*.' , which means a wildcard to it's sub domains. Such as '*.example.com' can accept request to 'api.example.com' and 'www.example.com'.", - "required": true - }, + "description": "The ID of the resource group that the Satellite location is in. To list the resource group ID of the location, use the `GET /v2/satellite/getController` API method.", + "cloud_data_type": "resource_group", + "immutable": true, + "optional": true + } + ], + "ibm_satellite_endpoint": [ { - "name": "server_mutual_auth", + "name": "client_mutual_auth", "type": "TypeBool", - "description": "Whether enable mutual auth in the server application side, when client_protocol is 'tls', this field is required.", + "description": "Whether enable mutual auth in the client application side, when client_protocol is 'tls' or 'https', this field is required.", "default_value": false, "optional": true }, @@ -131282,88 +136244,36 @@ "computed": true }, { - "name": "crn", + "name": "endpoint_id", "type": "TypeString", - "description": "Service instance associated with this location.", - "cloud_data_type": "crn", + "description": "The Endpoint ID.", "computed": true }, { - "name": "status", + "name": "server_port", + "type": "TypeInt", + "description": "The port number of the server endpoint. For 'http-tunnel' protocol, server_port can be 0, which means any port. Such as 0 is good for 80 (http) and 443 (https).", + "required": true + }, + { + "name": "client_protocol", "type": "TypeString", - "description": "Whether the Endpoint is active or not.", - "computed": true + "description": "The protocol in the client application side.", + "required": true, + "options": "http, http-tunnel, https, tcp, tls, udp" }, { - "name": "performance", - "type": "TypeList", - "description": "The last performance data of the endpoint.", - "computed": true, - "elem": { - "bandwidth": { - "name": "bandwidth", - "type": "TypeInt", - "description": "Average Tatal Bandwidth of last two minutes, unit is Byte/s.", - "optional": true - }, - "connection": { - "name": "connection", - "type": "TypeInt", - "description": "Concurrent connections number of moment when probe read the data.", - "optional": true - }, - "connectors": { - "name": "connectors", - "type": "TypeList", - "description": "The last performance data of the endpoint from each Connector.", - "optional": true, - "elem": { - "connections": { - "name": "connections", - "type": "TypeInt", - "description": "Concurrent connections number of moment when probe read the data from the Connector.", - "optional": true - }, - "connector": { - "name": "connector", - "type": "TypeString", - "description": "The name of the connector reported the performance data.", - "optional": true - }, - "rx_bw": { - "name": "rx_bw", - "type": "TypeInt", - "description": "Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.", - "optional": true - }, - "tx_bw": { - "name": "tx_bw", - "type": "TypeInt", - "description": "Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.", - "optional": true - } - } - }, - "rx_bandwidth": { - "name": "rx_bandwidth", - "type": "TypeInt", - "description": "Average Receive (to Cloud) Bandwidth of last two minutes, unit is Byte/s.", - "optional": true - }, - "tx_bandwidth": { - "name": "tx_bandwidth", - "type": "TypeInt", - "description": "Average Transmitted (to Location) Bandwidth of last two minutes, unit is Byte/s.", - "optional": true - } - } + "name": "server_mutual_auth", + "type": "TypeBool", + "description": "Whether enable mutual auth in the server application side, when client_protocol is 'tls', this field is required.", + "default_value": false, + "optional": true }, { - "name": "connection_type", + "name": "created_by", "type": "TypeString", - "description": "The type of the endpoint.", - "required": true, - "options": "cloud, location" + "description": "The service or person who created the endpoint. Must be 1000 characters or fewer.", + "optional": true }, { "name": "certs", @@ -131485,6 +136395,53 @@ }, "max_items": 1 }, + { + "name": "last_change", + "type": "TypeString", + "description": "The last time modify the Endpoint configurations.", + "computed": true + }, + { + "name": "display_name", + "type": "TypeString", + "description": "The display name of the endpoint. Endpoint names must start with a letter and end with an alphanumeric character, can contain letters, numbers, and hyphen (-), and must be 63 characters or fewer.", + "required": true + }, + { + "name": "sni", + "type": "TypeString", + "description": "The server name indicator (SNI) which used to connect to the server endpoint. Only useful if server side requires SNI.", + "optional": true + }, + { + "name": "server_protocol", + "type": "TypeString", + "description": "The protocol in the server application side. This parameter will change to default value if it is omitted even when using PATCH API. If client_protocol is 'udp', server_protocol must be 'udp'. If client_protocol is 'tcp'/'http', server_protocol could be 'tcp'/'tls' and default to 'tcp'. If client_protocol is 'tls'/'https', server_protocol could be 'tcp'/'tls' and default to 'tls'. If client_protocol is 'http-tunnel', server_protocol must be 'tcp'.", + "options": "tcp, tls, udp", + "optional": true + }, + { + "name": "reject_unauth", + "type": "TypeBool", + "description": "Whether reject any connection to the server application which is not authorized with the list of supplied CAs in the fields certs.server_cert.", + "default_value": false, + "optional": true + }, + { + "name": "timeout", + "type": "TypeInt", + "description": "The inactivity timeout in the Endpoint side.", + "min_value": "1", + "max_value": "180", + "optional": true + }, + { + "name": "crn", + "type": "TypeString", + "description": "Service instance associated with this location.", + "cloud_data_type": "crn", + "computed": true + }, { "name": "service_name", "type": "TypeString", @@ -131497,6 +136454,19 @@ "description": "The hostname which Satellite Link server listen on for the on-location endpoint, or the hostname which the connector server listen on for the on-cloud endpoint destiantion.", "computed": true }, + { + "name": "connection_type", + "type": "TypeString", + "description": "The type of the endpoint.", + "required": true, + "options": "cloud, location" + }, + { + "name": "server_host", + "type": "TypeString", + "description": "The host name or IP address of the server endpoint. For 'http-tunnel' protocol, server_host can start with '*.' , which means a wildcard to it's sub domains. Such as '*.example.com' can accept request to 'api.example.com' and 'www.example.com'.", + "required": true + }, { "name": "client_port", "type": "TypeInt", @@ -131508,15 +136478,123 @@ "type": "TypeString", "description": "The time when the Endpoint is created.", "computed": true + }, + { + "name": "status", + "type": "TypeString", + "description": "Whether the Endpoint is active or not.", + "computed": true + }, + { + "name": "performance", + "type": "TypeList", + "description": "The last performance data of the endpoint.", + "computed": true, + "elem": { + "bandwidth": { + "name": "bandwidth", + "type": "TypeInt", + "description": "Average Tatal Bandwidth of last two minutes, unit is Byte/s.", + "optional": true + }, + "connection": { + "name": "connection", + "type": "TypeInt", + "description": "Concurrent connections number of moment when probe read the data.", + "optional": true + }, + "connectors": { + "name": "connectors", + "type": "TypeList", + "description": "The last performance data of the endpoint from each Connector.", + "optional": true, + "elem": { + "connections": { + "name": "connections", + "type": "TypeInt", + "description": "Concurrent connections number of moment when probe read the data from the Connector.", + "optional": true + }, + "connector": { + "name": "connector", + "type": "TypeString", + "description": "The name of the connector reported the performance data.", + "optional": true + }, + "rx_bw": { + "name": "rx_bw", + "type": "TypeInt", + "description": "Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.", + "optional": true + }, + "tx_bw": { + "name": "tx_bw", + "type": "TypeInt", + "description": "Average Transmitted (to Location) Bandwidth of last two minutes read from the Connector, unit is Byte/s.", + "optional": true + } + } + }, + "rx_bandwidth": { + "name": "rx_bandwidth", + "type": "TypeInt", + "description": "Average Receive (to Cloud) Bandwidth of last two minutes, unit is Byte/s.", + "optional": true + }, + "tx_bandwidth": { + "name": "tx_bandwidth", + "type": "TypeInt", + "description": "Average Transmitted (to Location) Bandwidth of last two minutes, unit is Byte/s.", + "optional": true + } + } + }, + { + "name": "location", + "type": "TypeString", + "description": "The Location ID.", + "cloud_data_type": "region", + "required": true + }, + { + "name": "sources", + "type": "TypeList", + "computed": true, + "elem": { + "enabled": { + "name": "enabled", + "type": "TypeBool", + "description": "Whether the source is enabled for the endpoint.", + "optional": true + }, + "last_change": { + "name": "last_change", + "type": "TypeString", + "description": "The last time modify the Endpoint configurations.", + "optional": true + }, + "pending": { + "name": "pending", + "type": "TypeBool", + "description": "Whether the source has been enabled on this endpoint.", + "optional": true + }, + "source_id": { + "name": "source_id", + "type": "TypeString", + "description": "The Source ID.", + "optional": true + } + } } ], "ibm_satellite_host": [ { - "name": "wait_till", + "name": "location", "type": "TypeString", - "description": "Wait until location is normal", - "options": "location_normal", - "optional": true + "description": "The name or ID of the Satellite location", + "cloud_data_type": "region", + "required": true }, { "name": "cluster", @@ -131525,6 +136603,12 @@ "optional": true, "computed": true }, + { + "name": "host_id", + "type": "TypeString", + "description": "The specific host ID to assign to a Satellite location or cluster", + "required": true + }, { "name": "labels", "type": "TypeSet", @@ -131536,10 +136620,11 @@ } }, { - "name": "host_provider", + "name": "zone", "type": "TypeString", - "description": "Host Provider", - "optional": true + "description": "The zone within the cluster to assign the host to", + "optional": true, + "computed": true }, { "name": "worker_pool", @@ -131549,30 +136634,23 @@ "computed": true }, { - "name": "host_state", - "type": "TypeString", - "description": "Health status of the host", - "computed": true - }, - { - "name": "location", + "name": "host_provider", "type": "TypeString", - "description": "The name or ID of the Satellite location", - "cloud_data_type": "region", - "required": true + "description": "Host Provider", + "optional": true }, { - "name": "host_id", + "name": "host_state", "type": "TypeString", - "description": "The specific host ID to assign to a Satellite location or cluster", - "required": true + "description": "Health status of the host", + "computed": true }, { - "name": "zone", + "name": "wait_till", "type": "TypeString", - "description": "The zone within the cluster to assign the host to", - "optional": true, - "computed": true + "description": "Wait until location is normal", + "options": "location_normal", + "optional": true } ], "ibm_satellite_link": [ @@ -131609,6 +136687,26 @@ "description": "Timestamp of creation of location.", "computed": true }, + { + "name": "location", + "type": "TypeString", + "description": "Location ID.", + "cloud_data_type": "region", + "immutable": true, + "required": true + }, + { + "name": "description", + "type": "TypeString", + "description": "Description of the location.", + "computed": true + }, + { + "name": "last_change", + "type": "TypeString", + "description": "Timestamp of latest modification of location.", + "computed": true + }, { "name": "performance", "type": "TypeList", @@ -131677,419 +136775,1450 @@ "description": "Tunnels number estbalished from the Location.", "optional": true }, - "tx_bandwidth": { - "name": "tx_bandwidth", + "tx_bandwidth": { + "name": "tx_bandwidth", + "type": "TypeInt", + "description": "Average Transmitted (to Location) Bandwidth of last two minutes, unit is Byte/s.", + "optional": true + } + } + } + ], + "ibm_satellite_location": [ + { + "name": "host_attached_count", + "type": "TypeInt", + "description": "The total number of hosts that are attached to the Satellite location.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "created_on", + "type": "TypeString", + "description": "Created Date", + "computed": true + }, + { + "name": "cos_config", + "type": "TypeList", + "description": "COSBucket - IBM Cloud Object Storage bucket configuration details", + "optional": true, + "elem": { + "bucket": { + "name": "bucket", + "type": "TypeString", + "optional": true + }, + "endpoint": { + "name": "endpoint", + "type": "TypeString", + "optional": true + }, + "region": { + "name": "region", + "type": "TypeString", + "optional": true + } + }, + "max_items": 1 + }, + { + "name": "cos_credentials", + "type": "TypeList", + "description": "COSAuthorization - IBM Cloud Object Storage authorization keys", + "optional": true, + "elem": { + "access_key_id": { + "name": "access_key_id", + "type": "TypeString", + "description": "The HMAC secret access key ID", + "optional": true + }, + "secret_access_key": { + "name": "secret_access_key", + "type": "TypeString", + "description": "The HMAC secret access key", + "optional": true + } + }, + "max_items": 1 + }, + { + "name": "crn", + "type": "TypeString", + "description": "Location CRN", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "host_available_count", + "type": "TypeInt", + "description": "The available number of hosts that can be assigned to a cluster resource in the Satellite location.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "ingress_hostname", + "type": "TypeString", + "computed": true + }, + { + "name": "description", + "type": "TypeString", + "description": "A description of the new Satellite location", + "optional": true + }, + { + "name": "logging_account_id", + "type": "TypeString", + "description": "The account ID for IBM Log Analysis with LogDNA log forwarding", + "optional": true + }, + { + "name": "coreos_enabled", + "type": "TypeBool", + "description": "Enable Red Hat CoreOS features within the Satellite location", + "optional": true, + "computed": true + }, + { + "name": "resource_group_name", + "type": "TypeString", + "description": "Name of the resource group", + "computed": true + }, + { + "name": "ingress_secret", + "type": "TypeString", + "secure": true, + "computed": true + }, + { + "name": "location", + "type": "TypeString", + "description": "A unique name for the new Satellite location", + "cloud_data_type": "region", + "required": true + }, + { + "name": "managed_from", + "type": "TypeString", + "description": "The IBM Cloud metro from which the Satellite location is managed", + "required": true + }, + { + "name": "tags", + "type": "TypeSet", + "description": "List of tags associated with resource instance", + "min_length": 1, + "max_length": 128, + "matches": "^[A-Za-z0-9:_ .-]+$", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "zones", + "type": "TypeSet", + "description": "The names of at least three high availability zones to use for the location", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "resource_group_id", + "type": "TypeString", + "description": "ID of the resource group.", + "cloud_data_type": "resource_group", + "optional": true, + "computed": true + } + ], + "ibm_satellite_location_nlb_dns": [ + { + "name": "location", + "type": "TypeString", + "cloud_data_type": "region", + "immutable": true, + "required": true + }, + { + "name": "ips", + "type": "TypeSet", + "immutable": true, + "required": true, + "elem": { + "type": "TypeString" + } + } + ], + "ibm_satellite_storage_assignment": [ + { + "name": "uuid", + "type": "TypeString", + "description": "The Universally Unique IDentifier (UUID) of the Assignment.", + "immutable": true, + "computed": true + }, + { + "name": "owner", + "type": "TypeString", + "description": "The Owner of the Assignment.", + "computed": true + }, + { + "name": "config", + "type": "TypeString", + "description": "Storage Configuration Name or ID.", + "required": true + }, + { + "name": "config_version_uuid", + "type": "TypeString", + "description": "The Universally Unique IDentifier (UUID) of the Storage Configuration Version.", + "computed": true + }, + { + "name": "created", + "type": "TypeString", + "description": "The Time of Creation of the Assignment.", + "computed": true + }, + { + "name": "rollout_error_count", + "type": "TypeInt", + "description": "The Rollout Error Count of the Assignment.", + "computed": true + }, + { + "name": "sat_cluster", + "type": "TypeString", + "description": "ID of the Satellite cluster that you applied the configuration to.", + "computed": true + }, + { + "name": "config_uuid", + "type": "TypeString", + "description": "The Universally Unique IDentifier (UUID) of the Storage Configuration.", + "computed": true + }, + { + "name": "assignment_type", + "type": "TypeString", + "description": "The Type of Assignment.", + "computed": true + }, + { + "name": "rollout_success_count", + "type": "TypeInt", + "description": "The Rollout Success Count of the Assignment.", + "computed": true + }, + { + "name": "cluster", + "type": "TypeString", + "description": "ID of the Satellite cluster or Service Cluster that you want to apply the configuration to.", + "optional": true + }, + { + "name": "svc_cluster", + "type": "TypeString", + "description": "ID of the Service Cluster that you applied the configuration to.", + "computed": true + }, + { + "name": "is_assignment_upgrade_available", + "type": "TypeBool", + "description": "Whether an Upgrade is Available for the Assignment.", + "computed": true + }, + { + "name": "update_config_revision", + "type": "TypeBool", + "description": "Updating an assignment to the latest available storage configuration version.", + "default_value": false, + "optional": true + }, + { + "name": "controller", + "type": "TypeString", + "description": "The Name or ID of the Satellite Location.", + "optional": true + }, + { + "name": "assignment_name", + "type": "TypeString", + "description": "Name of the Assignment.", + "required": true + }, + { + "name": "groups", + "type": "TypeList", + "description": "One or more cluster groups on which you want to apply the configuration. Note that at least one cluster group is required.", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "config_version", + "type": "TypeString", + "description": "The Storage Configuration Version.", + "computed": true + } + ], + "ibm_satellite_storage_configuration": [ + { + "name": "storage_class_parameters", + "type": "TypeList", + "optional": true, + "elem": { + "type": "TypeMap", + "description": "The List of Storage Class Parameters as a list of a Map of string key-value.", + "elem": { + "type": "TypeString" + } + } + }, + { + "name": "uuid", + "type": "TypeString", + "description": "The Universally Unique IDentifier (UUID) of the Storage Configuration.", + "immutable": true, + "computed": true + }, + { + "name": "update_assignments", + "type": "TypeBool", + "description": "Set to update all assignments during a configuration update.", + "default_value": false, + "optional": true + }, + { + "name": "location", + "type": "TypeString", + "description": "Location ID.", + "cloud_data_type": "region", + "required": true + }, + { + "name": "config_version", + "type": "TypeString", + "description": "Version of the Storage Configuration.", + "computed": true + }, + { + "name": "storage_template_name", + "type": "TypeString", + "description": "The Storage Template Name.", + "required": true + }, + { + "name": "user_secret_parameters", + "type": "TypeMap", + "description": "User Secret Parameters to pass as a Map of string key-value.", + "secure": true, + "required": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "config_name", + "type": "TypeString", + "description": "Name of the Storage Configuration.", + "immutable": true, + "required": true + }, + { + "name": "storage_template_version", + "type": "TypeString", + "description": "The Storage Template Version.", + "required": true + }, + { + "name": "user_config_parameters", + "type": "TypeMap", + "description": "User Config Parameters to pass as a Map of string key-value.", + "required": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "delete_assignments", + "type": "TypeBool", + "description": "Set to delete all assignments during a configuration destroy.", + "default_value": false, + "optional": true + } + ], + "ibm_scc_account_settings": [], + "ibm_scc_control_library": [ + { + "name": "controls_count", + "type": "TypeInt", + "description": "The number of controls.", + "computed": true + }, + { + "name": "updated_on", + "type": "TypeString", + "description": "The date when the control library was updated.", + "computed": true + }, + { + "name": "control_library_id", + "type": "TypeString", + "description": "The control library ID.", + "computed": true + }, + { + "name": "control_library_description", + "type": "TypeString", + "description": "The control library description.", + "required": true, + "min_length": 2, + "max_length": 256, + "matches": "[A-Za-z0-9]+" + }, + { + "name": "version_group_label", + "type": "TypeString", + "description": "The version group label.", + "min_length": 36, + "max_length": 36, + "matches": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "optional": true + }, + { + "name": "created_on", + "type": "TypeString", + "description": "The date when the control library was created.", + "computed": true + }, + { + "name": "created_by", + "type": "TypeString", + "description": "The user who created the control library.", + "computed": true + }, + { + "name": "hierarchy_enabled", + "type": "TypeBool", + "description": "The indication of whether hierarchy is enabled for the control library.", + "computed": true + }, + { + "name": "latest", + "type": "TypeBool", + "description": "The latest version of the control library.", + "optional": true + }, + { + "name": "account_id", + "type": "TypeString", + "description": "The account ID.", + "computed": true + }, + { + "name": "control_library_version", + "type": "TypeString", + "description": "The control library version.", + "min_length": 5, + "max_length": 64, + "matches": "^[a-zA-Z0-9_\\-.]*$", + "optional": true + }, + { + "name": "controls", + "type": "TypeList", + "description": "The list of controls in a control library.", + "required": true, + "elem": { + "control_category": { + "name": "control_category", + "type": "TypeString", + "description": "The control category.", + "optional": true + }, + "control_description": { + "name": "control_description", + "type": "TypeString", + "description": "The control description.", + "optional": true + }, + "control_docs": { + "name": "control_docs", + "type": "TypeList", + "description": "The control documentation.", + "optional": true, + "elem": { + "control_docs_id": { + "name": "control_docs_id", + "type": "TypeString", + "description": "The ID of the control documentation.", + "optional": true + }, + "control_docs_type": { + "name": "control_docs_type", + "type": "TypeString", + "description": "The type of control documentation.", + "optional": true + } + }, + "max_items": 1 + }, + "control_id": { + "name": "control_id", + "type": "TypeString", + "description": "The ID of the control library that contains the profile.", + "optional": true + }, + "control_name": { + "name": "control_name", + "type": "TypeString", + "description": "The control name.", + "optional": true + }, + "control_parent": { + "name": "control_parent", + "type": "TypeString", + "description": "The parent control.", + "optional": true + }, + "control_requirement": { + "name": "control_requirement", + "type": "TypeBool", + "description": "Is this a control that can be automated or manually evaluated.", + "optional": true + }, + "control_specifications": { + "name": "control_specifications", + "type": "TypeList", + "description": "The control specifications.", + "optional": true, + "elem": { + "assessments": { + "name": "assessments", + "type": "TypeList", + "description": "The assessments.", + "optional": true, + "elem": { + "assessment_description": { + "name": "assessment_description", + "type": "TypeString", + "description": "The assessment description.", + "optional": true + }, + "assessment_id": { + "name": "assessment_id", + "type": "TypeString", + "description": "The assessment ID.", + "optional": true + }, + "assessment_method": { + "name": "assessment_method", + "type": "TypeString", + "description": "The assessment method.", + "optional": true + }, + "assessment_type": { + "name": "assessment_type", + "type": "TypeString", + "description": "The assessment type.", + "optional": true + }, + "parameter_count": { + "name": "parameter_count", + "type": "TypeInt", + "description": "The parameter count.", + "computed": true + }, + "parameters": { + "name": "parameters", + "type": "TypeList", + "description": "The parameters.", + "optional": true, + "elem": { + "parameter_display_name": { + "name": "parameter_display_name", + "type": "TypeString", + "description": "The parameter display name.", + "optional": true + }, + "parameter_name": { + "name": "parameter_name", + "type": "TypeString", + "description": "The parameter name.", + "optional": true + }, + "parameter_type": { + "name": "parameter_type", + "type": "TypeString", + "description": "The parameter type.", + "optional": true + } + } + } + } + }, + "assessments_count": { + "name": "assessments_count", + "type": "TypeInt", + "description": "The number of assessments.", + "computed": true + }, + "component_id": { + "name": "component_id", + "type": "TypeString", + "description": "The component ID.", + "optional": true + }, + "component_name": { + "name": "component_name", + "type": "TypeString", + "description": "The component name.", + "optional": true + }, + "control_specification_description": { + "name": "control_specification_description", + "type": "TypeString", + "description": "The control specifications description.", + "optional": true + }, + "control_specification_id": { + "name": "control_specification_id", + "type": "TypeString", + "description": "The control specification ID.", + "optional": true + }, + "environment": { + "name": "environment", + "type": "TypeString", + "description": "The control specifications environment.", + "optional": true + }, + "responsibility": { + "name": "responsibility", + "type": "TypeString", + "description": "The responsibility for managing the control.", + "optional": true + } + } + }, + "control_tags": { + "name": "control_tags", + "type": "TypeList", + "description": "The control tags.", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + "status": { + "name": "status", + "type": "TypeString", + "description": "The control status.", + "optional": true + } + } + }, + { + "name": "updated_by", + "type": "TypeString", + "description": "The user who updated the control library.", + "computed": true + }, + { + "name": "control_parents_count", + "type": "TypeInt", + "description": "The number of parent controls in the control library.", + "computed": true + }, + { + "name": "instance_id", + "type": "TypeString", + "description": "The ID of the Security and Compliance Center instance.", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true + }, + { + "name": "control_library_name", + "type": "TypeString", + "description": "The control library name.", + "required": true, + "min_length": 2, + "max_length": 64, + "matches": "^[a-zA-Z0-9_\\s\\-]*$" + }, + { + "name": "control_library_type", + "type": "TypeString", + "description": "The control library type.", + "required": true, + "options": "custom, predefined" + } + ], + "ibm_scc_profile": [ + { + "name": "profile_id", + "type": "TypeString", + "description": "The profile name.", + "computed": true + }, + { + "name": "profile_name", + "type": "TypeString", + "description": "The profile name.", + "required": true, + "min_length": 2, + "max_length": 64, + "matches": "^[a-zA-Z0-9_\\s\\-]*$" + }, + { + "name": "latest", + "type": "TypeBool", + "description": "The latest version of the profile.", + "computed": true + }, + { + "name": "hierarchy_enabled", + "type": "TypeBool", + "description": "The indication of whether hierarchy is enabled for the profile.", + "computed": true + }, + { + "name": "controls_count", + "type": "TypeInt", + "description": "The number of controls for the profile.", + "computed": true + }, + { + "name": "profile_description", + "type": "TypeString", + "description": "The profile description.", + "required": true, + "min_length": 2, + "max_length": 256, + "matches": "^[a-zA-Z0-9_,'\"\\s\\-\\[\\]]+$" + }, + { + "name": "controls", + "type": "TypeList", + "description": "The array of controls that are used to create the profile.", + "required": true, + "elem": { + "control_category": { + "name": "control_category", + "type": "TypeString", + "description": "The control category.", + "computed": true + }, + "control_description": { + "name": "control_description", + "type": "TypeString", + "description": "The control description.", + "computed": true + }, + "control_docs": { + "name": "control_docs", + "type": "TypeList", + "description": "The control documentation.", + "computed": true, + "elem": { + "control_docs_id": { + "name": "control_docs_id", + "type": "TypeString", + "description": "The ID of the control documentation.", + "optional": true + }, + "control_docs_type": { + "name": "control_docs_type", + "type": "TypeString", + "description": "The type of control documentation.", + "optional": true + } + } + }, + "control_id": { + "name": "control_id", + "type": "TypeString", + "description": "The unique ID of the control inside the control library.", + "optional": true + }, + "control_library_id": { + "name": "control_library_id", + "type": "TypeString", + "description": "The ID of the control library that contains the profile.", + "optional": true + }, + "control_library_version": { + "name": "control_library_version", + "type": "TypeString", + "description": "The most recent version of the control library.", + "computed": true + }, + "control_name": { + "name": "control_name", + "type": "TypeString", + "description": "The control name.", + "computed": true + }, + "control_parent": { + "name": "control_parent", + "type": "TypeString", + "description": "The parent control.", + "computed": true + }, + "control_requirement": { + "name": "control_requirement", + "type": "TypeBool", + "description": "Is this a control that can be automated or manually evaluated.", + "computed": true + }, + "control_specifications": { + "name": "control_specifications", + "type": "TypeList", + "description": "The control specifications.", + "computed": true, + "elem": { + "assessments": { + "name": "assessments", + "type": "TypeList", + "description": "The assessments.", + "computed": true, + "elem": { + "assessment_description": { + "name": "assessment_description", + "type": "TypeString", + "description": "The assessment description.", + "computed": true + }, + "assessment_id": { + "name": "assessment_id", + "type": "TypeString", + "description": "The assessment ID.", + "computed": true + }, + "assessment_method": { + "name": "assessment_method", + "type": "TypeString", + "description": "The assessment method.", + "computed": true + }, + "assessment_type": { + "name": "assessment_type", + "type": "TypeString", + "description": "The assessment type.", + "computed": true + }, + "parameter_count": { + "name": "parameter_count", + "type": "TypeInt", + "description": "The parameter count.", + "computed": true + }, + "parameters": { + "name": "parameters", + "type": "TypeList", + "description": "The parameters.", + "computed": true, + "elem": { + "parameter_display_name": { + "name": "parameter_display_name", + "type": "TypeString", + "description": "The parameter display name.", + "computed": true + }, + "parameter_name": { + "name": "parameter_name", + "type": "TypeString", + "description": "The parameter name.", + "computed": true + }, + "parameter_type": { + "name": "parameter_type", + "type": "TypeString", + "description": "The parameter type.", + "computed": true + } + } + } + } + }, + "assessments_count": { + "name": "assessments_count", + "type": "TypeInt", + "description": "The number of assessments.", + "computed": true + }, + "component_id": { + "name": "component_id", + "type": "TypeString", + "description": "The component ID.", + "computed": true + }, + "component_name": { + "name": "component_name", + "type": "TypeString", + "description": "The component name.", + "computed": true + }, + "control_specification_description": { + "name": "control_specification_description", + "type": "TypeString", + "description": "The control specifications description.", + "computed": true + }, + "control_specification_id": { + "name": "control_specification_id", + "type": "TypeString", + "description": "The control specification ID.", + "computed": true + }, + "environment": { + "name": "environment", + "type": "TypeString", + "description": "The control specifications environment.", + "computed": true + }, + "responsibility": { + "name": "responsibility", + "type": "TypeString", + "description": "The responsibility for managing the control.", + "computed": true + } + } + }, + "control_specifications_count": { + "name": "control_specifications_count", "type": "TypeInt", - "description": "Average Transmitted (to Location) Bandwidth of last two minutes, unit is Byte/s.", - "optional": true + "description": "The number of control specifications.", + "computed": true } } }, { - "name": "location", - "type": "TypeString", - "description": "Location ID.", - "cloud_data_type": "region", - "immutable": true, - "required": true - }, - { - "name": "description", + "name": "updated_by", "type": "TypeString", - "description": "Description of the location.", + "description": "The user who updated the profile.", "computed": true }, { - "name": "last_change", + "name": "updated_on", "type": "TypeString", - "description": "Timestamp of latest modification of location.", + "description": "The date when the profile was updated.", "computed": true - } - ], - "ibm_satellite_location": [ + }, { - "name": "ingress_hostname", - "type": "TypeString", + "name": "control_parents_count", + "type": "TypeInt", + "description": "The number of parent controls for the profile.", "computed": true }, { - "name": "host_attached_count", - "type": "TypeInt", - "description": "The total number of hosts that are attached to the Satellite location.", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "profile_type", + "type": "TypeString", + "description": "The profile type, such as custom or predefined.", + "required": true }, { - "name": "cos_config", + "name": "default_parameters", "type": "TypeList", - "description": "COSBucket - IBM Cloud Object Storage bucket configuration details", + "description": "The default parameters of the profile.", "optional": true, "elem": { - "bucket": { - "name": "bucket", + "assessment_id": { + "name": "assessment_id", "type": "TypeString", + "description": "The implementation ID of the parameter.", "optional": true }, - "endpoint": { - "name": "endpoint", + "assessment_type": { + "name": "assessment_type", "type": "TypeString", + "description": "The type of the implementation.", "optional": true }, - "region": { - "name": "region", + "parameter_default_value": { + "name": "parameter_default_value", "type": "TypeString", + "description": "The default value of the parameter.", "optional": true - } - }, - "max_items": 1 - }, - { - "name": "cos_credentials", - "type": "TypeList", - "description": "COSAuthorization - IBM Cloud Object Storage authorization keys", - "optional": true, - "elem": { - "access_key_id": { - "name": "access_key_id", + }, + "parameter_display_name": { + "name": "parameter_display_name", "type": "TypeString", - "description": "The HMAC secret access key ID", + "description": "The parameter display name.", "optional": true }, - "secret_access_key": { - "name": "secret_access_key", + "parameter_name": { + "name": "parameter_name", "type": "TypeString", - "description": "The HMAC secret access key", + "description": "The parameter name.", + "optional": true + }, + "parameter_type": { + "name": "parameter_type", + "type": "TypeString", + "description": "The parameter type.", "optional": true } - }, - "max_items": 1 + } }, { - "name": "resource_group_id", + "name": "version_group_label", "type": "TypeString", - "description": "ID of the resource group.", - "cloud_data_type": "resource_group", - "optional": true, + "description": "The version group label of the profile.", "computed": true }, { - "name": "crn", + "name": "instance_id", "type": "TypeString", - "description": "Location CRN", - "cloud_data_type": "crn", - "computed": true + "description": "The ID of the Security and Compliance Center instance.", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true }, { - "name": "resource_group_name", + "name": "created_on", "type": "TypeString", - "description": "Name of the resource group", + "description": "The date when the profile was created.", "computed": true }, { - "name": "host_available_count", - "type": "TypeInt", - "description": "The available number of hosts that can be assigned to a cluster resource in the Satellite location.", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "profile_version", + "type": "TypeString", + "description": "The version status of the profile.", + "computed": true }, { - "name": "created_on", + "name": "created_by", "type": "TypeString", - "description": "Created Date", + "description": "The user who created the profile.", "computed": true }, { - "name": "location", + "name": "attachments_count", + "type": "TypeInt", + "description": "The number of attachments related to this profile.", + "computed": true + } + ], + "ibm_scc_profile_attachment": [ + { + "name": "profile_id", "type": "TypeString", - "description": "A unique name for the new Satellite location", - "cloud_data_type": "region", - "required": true + "description": "The ID of the profile that is specified in the attachment.", + "immutable": true, + "required": true, + "min_length": 36, + "max_length": 36, + "matches": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { - "name": "managed_from", + "name": "instance_id", "type": "TypeString", - "description": "The IBM Cloud metro from which the Satellite location is managed", + "description": "The ID of the Security and Compliance Center instance.", + "cloud_data_type": "resource_instance", + "immutable": true, "required": true }, { - "name": "logging_account_id", + "name": "updated_by", "type": "TypeString", - "description": "The account ID for IBM Log Analysis with LogDNA log forwarding", - "optional": true + "description": "The user who updated the attachment.", + "computed": true }, { - "name": "tags", - "type": "TypeSet", - "description": "List of tags associated with resource instance", - "min_length": 1, - "max_length": 128, - "matches": "^[A-Za-z0-9:_ .-]+$", + "name": "attachment_parameters", + "type": "TypeList", + "description": "The profile parameters for the attachment.", "optional": true, - "computed": true, "elem": { - "type": "TypeString" + "assessment_id": { + "name": "assessment_id", + "type": "TypeString", + "description": "The implementation ID of the parameter.", + "optional": true + }, + "assessment_type": { + "name": "assessment_type", + "type": "TypeString", + "description": "The type of the implementation.", + "optional": true + }, + "parameter_display_name": { + "name": "parameter_display_name", + "type": "TypeString", + "description": "The parameter display name.", + "optional": true + }, + "parameter_name": { + "name": "parameter_name", + "type": "TypeString", + "description": "The parameter name.", + "optional": true + }, + "parameter_type": { + "name": "parameter_type", + "type": "TypeString", + "description": "The parameter type.", + "optional": true + }, + "parameter_value": { + "name": "parameter_value", + "type": "TypeString", + "description": "The value of the parameter.", + "optional": true + } } }, { - "name": "description", + "name": "attachment_id", "type": "TypeString", - "description": "A description of the new Satellite location", - "optional": true + "description": "The ID of the attachment.", + "computed": true }, { - "name": "coreos_enabled", - "type": "TypeBool", - "description": "Enable Red Hat CoreOS features within the Satellite location", - "optional": true, + "name": "account_id", + "type": "TypeString", + "description": "The account ID that is associated to the attachment.", "computed": true }, { - "name": "zones", - "type": "TypeSet", - "description": "The names of at least three high availability zones to use for the location", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "created_by", + "type": "TypeString", + "description": "The user who created the attachment.", + "computed": true }, { - "name": "ingress_secret", + "name": "created_on", "type": "TypeString", - "secure": true, + "description": "The date when the attachment was created.", "computed": true - } - ], - "ibm_satellite_location_nlb_dns": [ + }, { - "name": "location", + "name": "schedule", "type": "TypeString", - "cloud_data_type": "region", - "immutable": true, + "description": "The schedule of an attachment evaluation.", "required": true }, { - "name": "ips", - "type": "TypeSet", - "immutable": true, - "required": true, - "elem": { - "type": "TypeString" - } - } - ], - "ibm_scc_account_settings": [ - { - "name": "location_id", + "name": "profile_attachment_id", "type": "TypeString", - "description": "The programatic ID of the location that you want to work in.", - "options": "us, eu, uk", - "optional": true, - "deprecated": "The attribute location_id will soon be deprecated. Please use location instead. See https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/scc_account_settings for details" + "description": "The profile attachment ID.", + "computed": true }, { - "name": "location", + "name": "scope", "type": "TypeList", - "description": "Location Settings.", - "cloud_data_type": "region", - "optional": true, + "description": "The scope payload for the multi cloud feature.", + "required": true, "elem": { - "location_id": { - "name": "location_id", + "environment": { + "name": "environment", "type": "TypeString", - "description": "The programatic ID of the location that you want to work in.", + "description": "The environment that relates to this scope.", "required": true - } - }, - "max_items": 1 - }, - { - "name": "event_notifications", - "type": "TypeList", - "description": "The Event Notification settings to register.", - "optional": true, - "elem": { - "instance_crn": { - "name": "instance_crn", - "type": "TypeString", - "description": "The Cloud Resource Name (CRN) of the Event Notifications instance that you want to connect.", - "default_value": "", - "optional": true - } - }, - "max_items": 1 - } - ], - "ibm_scc_rule": [ - { - "name": "target", - "type": "TypeList", - "description": "The properties that describe the resource that you want to targetwith the rule or template.", - "required": true, - "elem": { - "additional_target_attributes": { - "name": "additional_target_attributes", + }, + "properties": { + "name": "properties", "type": "TypeList", - "description": "An extra qualifier for the resource kind. When you include additional attributes, only the resources that match the definition are included in the rule or template.", - "optional": true, + "description": "The properties supported for scoping by this environment.", + "required": true, "elem": { "name": { "name": "name", "type": "TypeString", - "description": "The name of the additional attribute that you want to use to further qualify the target.Options differ depending on the service or resource that you are targeting with a rule or template. For more information, refer to the service documentation.", - "optional": true - }, - "operator": { - "name": "operator", - "type": "TypeString", - "description": "The way in which the `name` field is compared to its value.There are three types of operators: string, numeric, and boolean.", + "description": "The name of the property.", "optional": true }, "value": { "name": "value", "type": "TypeString", - "description": "The value that you want to apply to `name` field.Options differ depending on the rule or template that you configure. For more information, refer to the service documentation.", + "description": "The value of the property.", "optional": true } } + } + } + }, + { + "name": "notifications", + "type": "TypeList", + "description": "The request payload of the attachment notifications.", + "required": true, + "elem": { + "controls": { + "name": "controls", + "type": "TypeList", + "description": "The failed controls.", + "optional": true, + "elem": { + "failed_control_ids": { + "name": "failed_control_ids", + "type": "TypeList", + "description": "The failed control IDs.", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + "threshold_limit": { + "name": "threshold_limit", + "type": "TypeInt", + "description": "The threshold limit.", + "optional": true + } + }, + "max_items": 1, + "min_items": 1 }, - "resource_kind": { - "name": "resource_kind", + "enabled": { + "name": "enabled", + "type": "TypeBool", + "description": "enabled notifications.", + "optional": true + } + } + }, + { + "name": "last_scan", + "type": "TypeList", + "description": "The details of the last scan of an attachment.", + "computed": true, + "elem": { + "id": { + "name": "id", "type": "TypeString", - "description": "The type of resource that you want to target.", - "required": true + "description": "The ID of the last scan of an attachment.", + "optional": true }, - "service_name": { - "name": "service_name", + "status": { + "name": "status", "type": "TypeString", - "description": "The programmatic name of the IBM Cloud service that you want to target with the rule or template.", - "required": true + "description": "The status of the last scan of an attachment.", + "optional": true + }, + "time": { + "name": "time", + "type": "TypeString", + "description": "The time when the last scan started.", + "optional": true } - }, - "max_items": 1 + } + }, + { + "name": "next_scan_time", + "type": "TypeString", + "description": "The start time of the next scan.", + "computed": true }, { "name": "name", "type": "TypeString", - "description": "A human-readable alias to assign to your rule.", + "description": "The name of the attachment.", "required": true }, { "name": "description", "type": "TypeString", - "description": "An extended description of your rule.", + "description": "The description for the attachment.", + "optional": true + }, + { + "name": "updated_on", + "type": "TypeString", + "description": "The date when the attachment was updated.", + "computed": true + }, + { + "name": "status", + "type": "TypeString", + "description": "The status of an attachment evaluation.", "required": true + } + ], + "ibm_scc_provider_type_instance": [ + { + "name": "attributes", + "type": "TypeMap", + "optional": true }, { - "name": "rule_type", + "name": "type", "type": "TypeString", - "description": "The type of rule. Rules that you create are `user_defined`.", + "description": "The type of the provider type.", "computed": true }, { - "name": "modification_date", + "name": "created_at", "type": "TypeString", - "description": "The date the resource was last modified.", + "description": "Time at which resource was created.", "computed": true }, { - "name": "modified_by", + "name": "updated_at", "type": "TypeString", - "description": "The unique identifier for the user or application that last modified the resource.", + "description": "Time at which resource was updated.", "computed": true }, { - "name": "version", + "name": "provider_type_instance_id", "type": "TypeString", + "description": "The unique identifier of the provider type instance.", "computed": true }, { - "name": "account_id", + "name": "instance_id", "type": "TypeString", - "description": "Your IBM Cloud account ID.", + "description": "The ID of the Security and Compliance Center instance.", + "cloud_data_type": "resource_instance", + "immutable": true, "required": true }, { - "name": "labels", - "type": "TypeList", - "description": "Labels that you can use to group and search for similar rules, such as those that help you to meet a specific organization guideline.", - "optional": true, - "elem": { - "type": "TypeString" - } + "name": "provider_type_id", + "type": "TypeString", + "description": "The provider type ID.", + "immutable": true, + "required": true, + "min_length": 32, + "max_length": 36, + "matches": "^[a-zA-Z0-9 ,\\-_]+$" }, { - "name": "creation_date", + "name": "name", "type": "TypeString", - "description": "The date the resource was created.", + "description": "The name of the provider type instance.", + "required": true, + "min_length": 1, + "max_length": 64, + "matches": "[A-Za-z0-9]+" + } + ], + "ibm_scc_rule": [ + { + "name": "created_by", + "type": "TypeString", + "description": "The user who created the rule.", "computed": true }, { - "name": "created_by", + "name": "description", "type": "TypeString", - "description": "The unique identifier for the user or application that created the resource.", + "description": "The details of a rule's response.", + "required": true, + "max_length": 512, + "matches": "[A-Za-z0-9]+" + }, + { + "name": "etag", + "type": "TypeString", + "description": "The etag of the rule.", "computed": true }, { - "name": "enforcement_actions", + "name": "import", "type": "TypeList", - "description": "The actions that the service must run on your behalf when a request to create or modify the target resource does not comply with your conditions.", + "description": "The collection of import parameters.", "optional": true, "elem": { - "action": { - "name": "action", - "type": "TypeString", - "description": "To block a request from completing, use `disallow`.", - "required": true + "parameters": { + "name": "parameters", + "type": "TypeList", + "description": "The list of import parameters.", + "optional": true, + "elem": { + "description": { + "name": "description", + "type": "TypeString", + "description": "The propery description.", + "optional": true + }, + "display_name": { + "name": "display_name", + "type": "TypeString", + "description": "The display name of the property.", + "optional": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "The import parameter name.", + "optional": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "The property type.", + "optional": true + } + } } }, "max_items": 1 }, + { + "name": "labels", + "type": "TypeList", + "description": "The list of labels.", + "optional": true, + "elem": { + "type": "TypeString" + } + }, { "name": "required_config", "type": "TypeList", - "description": "The requirements that must be met to determine the resource's level of compliance in accordance with the rule. Use logical operators (and/or) to define multiple property checks and conditions. To define requirements for a rule, list one or more property check objects in the and array. To add conditions to a property check, use or.", + "description": "The required configurations.", "required": true, "elem": { "and": { "name": "and", "type": "TypeList", - "description": "A condition with the and logical operator.", + "description": "The `AND` required configurations.", "optional": true, "elem": { "and": { "name": "and", "type": "TypeList", - "description": "A condition with the and logical operator.", + "description": "The `AND` required configurations.", "optional": true, "elem": { "description": { "name": "description", "type": "TypeString", - "description": "The programmatic name of the IBM Cloud service that you want to target with the rule or template.", + "description": "The required config description.", "optional": true }, "operator": { "name": "operator", "type": "TypeString", - "description": "The way in which the `name` field is compared to its value.There are three types of operators: string, numeric, and boolean.", - "optional": true + "description": "The operator.", + "required": true }, "property": { "name": "property", "type": "TypeString", - "description": "The name of the additional attribute that you want to use to further qualify the target.Options differ depending on the service or resource that you are targeting with a rule or template. For more information, refer to the service documentation.", - "optional": true + "description": "The property.", + "required": true }, "value": { "name": "value", "type": "TypeString", - "description": "The value that you want to apply to `name` field.Options differ depending on the rule or template that you configure. For more information, refer to the service documentation.", - "default_value": "", + "description": "Schema for any JSON type.", "optional": true } } @@ -132097,44 +138226,43 @@ "description": { "name": "description", "type": "TypeString", - "description": "The programmatic name of the IBM Cloud service that you want to target with the rule or template.", + "description": "The required config description.", "optional": true }, "operator": { "name": "operator", "type": "TypeString", - "description": "The way in which the `name` field is compared to its value.There are three types of operators: string, numeric, and boolean.", + "description": "The operator.", "optional": true }, "or": { "name": "or", "type": "TypeList", - "description": "A condition with the or logical operator.", + "description": "The `OR` required configurations.", "optional": true, "elem": { "description": { "name": "description", "type": "TypeString", - "description": "The programmatic name of the IBM Cloud service that you want to target with the rule or template.", + "description": "The required config description.", "optional": true }, "operator": { "name": "operator", "type": "TypeString", - "description": "The way in which the `name` field is compared to its value.There are three types of operators: string, numeric, and boolean.", - "optional": true + "description": "The operator.", + "required": true }, "property": { "name": "property", "type": "TypeString", - "description": "The name of the additional attribute that you want to use to further qualify the target.Options differ depending on the service or resource that you are targeting with a rule or template. For more information, refer to the service documentation.", - "optional": true + "description": "The property.", + "required": true }, "value": { "name": "value", "type": "TypeString", - "description": "The value that you want to apply to `name` field.Options differ depending on the rule or template that you configure. For more information, refer to the service documentation.", - "default_value": "", + "description": "Schema for any JSON type.", "optional": true } } @@ -132142,14 +138270,13 @@ "property": { "name": "property", "type": "TypeString", - "description": "The name of the additional attribute that you want to use to further qualify the target.Options differ depending on the service or resource that you are targeting with a rule or template. For more information, refer to the service documentation.", + "description": "The property.", "optional": true }, "value": { "name": "value", "type": "TypeString", - "description": "The value that you want to apply to `name` field.Options differ depending on the rule or template that you configure. For more information, refer to the service documentation.", - "default_value": "", + "description": "Schema for any JSON type.", "optional": true } } @@ -132157,50 +138284,49 @@ "description": { "name": "description", "type": "TypeString", - "description": "The programmatic name of the IBM Cloud service that you want to target with the rule or template.", + "description": "The required config description.", "optional": true }, "operator": { "name": "operator", "type": "TypeString", - "description": "The way in which the `name` field is compared to its value.There are three types of operators: string, numeric, and boolean.", + "description": "The operator.", "optional": true }, "or": { "name": "or", "type": "TypeList", - "description": "A condition with the or logical operator.", + "description": "The `OR` required configurations.", "optional": true, "elem": { "and": { "name": "and", "type": "TypeList", - "description": "A condition with the and logical operator.", + "description": "The `AND` required configurations.", "optional": true, "elem": { "description": { "name": "description", "type": "TypeString", - "description": "The programmatic name of the IBM Cloud service that you want to target with the rule or template.", + "description": "The required config description.", "optional": true }, "operator": { "name": "operator", "type": "TypeString", - "description": "The way in which the `name` field is compared to its value.There are three types of operators: string, numeric, and boolean.", - "optional": true + "description": "The operator.", + "required": true }, "property": { "name": "property", "type": "TypeString", - "description": "The name of the additional attribute that you want to use to further qualify the target.Options differ depending on the service or resource that you are targeting with a rule or template. For more information, refer to the service documentation.", - "optional": true + "description": "The property.", + "required": true }, "value": { "name": "value", "type": "TypeString", - "description": "The value that you want to apply to `name` field.Options differ depending on the rule or template that you configure. For more information, refer to the service documentation.", - "default_value": "", + "description": "Schema for any JSON type.", "optional": true } } @@ -132208,44 +138334,43 @@ "description": { "name": "description", "type": "TypeString", - "description": "The programmatic name of the IBM Cloud service that you want to target with the rule or template.", + "description": "The required config description.", "optional": true }, "operator": { "name": "operator", "type": "TypeString", - "description": "The way in which the `name` field is compared to its value.There are three types of operators: string, numeric, and boolean.", + "description": "The operator.", "optional": true }, "or": { "name": "or", "type": "TypeList", - "description": "A condition with the or logical operator.", + "description": "The `OR` required configurations.", "optional": true, "elem": { "description": { "name": "description", "type": "TypeString", - "description": "The programmatic name of the IBM Cloud service that you want to target with the rule or template.", + "description": "The required config description.", "optional": true }, "operator": { "name": "operator", "type": "TypeString", - "description": "The way in which the `name` field is compared to its value.There are three types of operators: string, numeric, and boolean.", - "optional": true + "description": "The operator.", + "required": true }, "property": { "name": "property", "type": "TypeString", - "description": "The name of the additional attribute that you want to use to further qualify the target.Options differ depending on the service or resource that you are targeting with a rule or template. For more information, refer to the service documentation.", - "optional": true + "description": "The property.", + "required": true }, "value": { "name": "value", "type": "TypeString", - "description": "The value that you want to apply to `name` field.Options differ depending on the rule or template that you configure. For more information, refer to the service documentation.", - "default_value": "", + "description": "Schema for any JSON type.", "optional": true } } @@ -132253,14 +138378,13 @@ "property": { "name": "property", "type": "TypeString", - "description": "The name of the additional attribute that you want to use to further qualify the target.Options differ depending on the service or resource that you are targeting with a rule or template. For more information, refer to the service documentation.", + "description": "The property.", "optional": true }, "value": { "name": "value", "type": "TypeString", - "description": "The value that you want to apply to `name` field.Options differ depending on the rule or template that you configure. For more information, refer to the service documentation.", - "default_value": "", + "description": "Schema for any JSON type.", "optional": true } } @@ -132268,147 +138392,156 @@ "property": { "name": "property", "type": "TypeString", - "description": "The name of the additional attribute that you want to use to further qualify the target.Options differ depending on the service or resource that you are targeting with a rule or template. For more information, refer to the service documentation.", + "description": "The property.", "optional": true }, "value": { "name": "value", "type": "TypeString", - "description": "The value that you want to apply to `name` field.Options differ depending on the rule or template that you configure. For more information, refer to the service documentation.", - "default_value": "", + "description": "Schema for any JSON type.", "optional": true } }, - "max_items": 1 - } - ], - "ibm_scc_rule_attachment": [ + "max_items": 1, + "min_items": 1 + }, { - "name": "account_id", + "name": "updated_by", "type": "TypeString", - "description": "Your IBM Cloud account ID.", - "required": true + "description": "The user who modified the rule.", + "computed": true }, { - "name": "included_scope", - "type": "TypeList", - "description": "The extent at which the rule can be attached across your accounts.", - "required": true, - "elem": { - "note": { - "name": "note", - "type": "TypeString", - "description": "A short description or alias to assign to the scope.", - "optional": true - }, - "scope_id": { - "name": "scope_id", - "type": "TypeString", - "description": "The ID of the scope, such as an enterprise, account, or account group, that you want to evaluate.", - "required": true - }, - "scope_type": { - "name": "scope_type", - "type": "TypeString", - "description": "The type of scope that you want to evaluate.", - "required": true - } - }, - "max_items": 1 + "name": "creation_date", + "type": "TypeString", + "description": "The date the resource was created.", + "computed": true, + "deprecated": "use created_on instead" + }, + { + "name": "version", + "type": "TypeString", + "description": "The version number of a rule.", + "min_length": 5, + "max_length": 10, + "matches": "^[0-9][0-9.]*$", + "optional": true }, { - "name": "excluded_scopes", + "name": "enforcement_actions", "type": "TypeList", - "description": "The extent at which the rule can be excluded from the included scope.", + "description": "The actions that the service must run on your behalf when a request to create or modify the target resource does not comply with your conditions.", "optional": true, "elem": { - "note": { - "name": "note", - "type": "TypeString", - "description": "A short description or alias to assign to the scope.", - "optional": true - }, - "scope_id": { - "name": "scope_id", - "type": "TypeString", - "description": "The ID of the scope, such as an enterprise, account, or account group, that you want to evaluate.", - "required": true - }, - "scope_type": { - "name": "scope_type", + "action": { + "name": "action", "type": "TypeString", - "description": "The type of scope that you want to evaluate.", + "description": "To block a request from completing, use `disallow`.", "required": true } - } + }, + "max_items": 1, + "deprecated": "enforcement_actions is now deprecated" }, { - "name": "version", + "name": "created_on", "type": "TypeString", + "description": "The date when the rule was created.", "computed": true }, { - "name": "attachment_id", + "name": "type", "type": "TypeString", - "description": "The UUID that uniquely identifies the attachment.", + "description": "The rule type (allowable values are `user_defined` or `system_defined`).", "computed": true }, { - "name": "rule_id", + "name": "updated_on", "type": "TypeString", - "description": "The UUID that uniquely identifies the rule.", - "immutable": true, - "required": true - } - ], - "ibm_scc_template": [ + "description": "The date when the rule was modified.", + "computed": true + }, { - "name": "template_id", + "name": "modification_date", + "type": "TypeString", + "description": "The date the resource was last modified.", + "computed": true, + "deprecated": "use updated_on instead" + }, + { + "name": "rule_type", + "type": "TypeString", + "description": "The type of rule. Rules that you create are `user_defined`.", + "computed": true, + "deprecated": "use type instead" + }, + { + "name": "modified_by", + "type": "TypeString", + "description": "The unique identifier for the user or application that last modified the resource.", + "computed": true, + "deprecated": "use updated_by" + }, + { + "name": "rule_id", "type": "TypeString", - "description": "The UUID that uniquely identifies the template.", + "description": "The rule ID.", "computed": true }, { - "name": "version", + "name": "account_id", "type": "TypeString", + "description": "The account ID.", "computed": true }, { "name": "target", "type": "TypeList", - "description": "The properties that describe the resource that you want to targetwith the rule or template.", + "description": "The rule target.", "required": true, "elem": { "additional_target_attributes": { "name": "additional_target_attributes", "type": "TypeList", - "description": "An extra qualifier for the resource kind. When you include additional attributes, only the resources that match the definition are included in the rule or template.", + "description": "The list of targets supported properties.", "optional": true, "elem": { "name": { "name": "name", "type": "TypeString", - "description": "The name of the additional attribute that you want to use to further qualify the target.Options differ depending on the service or resource that you are targeting with a rule or template. For more information, refer to the service documentation.", - "required": true + "description": "The additional target attribute name.", + "optional": true + }, + "operator": { + "name": "operator", + "type": "TypeString", + "description": "The operator.", + "optional": true }, "value": { "name": "value", "type": "TypeString", - "description": "The value that you want to apply to `name` field.Options differ depending on the rule or template that you configure. For more information, refer to the service documentation.", - "required": true + "description": "The value.", + "optional": true } } }, "resource_kind": { "name": "resource_kind", "type": "TypeString", - "description": "The type of resource that you want to target.", + "description": "The target resource kind.", "required": true }, + "service_display_name": { + "name": "service_display_name", + "type": "TypeString", + "description": "The display name of the target service.", + "optional": true + }, "service_name": { "name": "service_name", "type": "TypeString", - "description": "The programmatic name of the IBM Cloud service that you want to target with the rule or template.", + "description": "The target service name.", "required": true } }, @@ -132416,338 +138549,37 @@ "min_items": 1 }, { - "name": "customized_defaults", - "type": "TypeList", - "description": "A list of default property values to apply to your template.", - "required": true, - "elem": { - "property": { - "name": "property", - "type": "TypeString", - "description": "The name of the resource property that you want to configure.Property options differ depending on the service or resource that you are targeting with a template. To view a list of properties that are compatible with templates, refer to the service documentation.", - "required": true - }, - "value": { - "name": "value", - "type": "TypeString", - "description": "The custom value that you want to apply as the default for the resource property in the `name` field.This value is used to to override the default value that is provided by IBM when a resource is created. Value options differ depending on the resource that you are configuring. To learn more about your options, refer to the service documentation.", - "required": true - } - } - }, - { - "name": "account_id", + "name": "instance_id", "type": "TypeString", - "description": "Your IBM Cloud account ID.", + "description": "The ID of the Security and Compliance Center instance.", + "cloud_data_type": "resource_instance", + "immutable": true, "required": true }, { "name": "name", "type": "TypeString", - "description": "A human-readablse alias to assign to your template.", - "required": true, - "min_length": 1, - "max_length": 32, - "matches": ".*" - }, - { - "name": "description", - "type": "TypeString", - "description": "An extended description of your template.", - "required": true, - "min_length": 1, - "max_length": 256, - "matches": ".*" - } - ], - "ibm_scc_template_attachment": [ - { - "name": "attachment_id", - "type": "TypeString", - "description": "The UUID that uniquely identifies the template.", - "computed": true - }, - { - "name": "template_id", - "type": "TypeString", - "description": "The UUID that uniquely identifies the template.", - "required": true - }, - { - "name": "account_id", - "type": "TypeString", - "description": "Your IBM Cloud account ID.", - "required": true - }, - { - "name": "included_scope", - "type": "TypeList", - "description": "The extent at which the template can be attached across your accounts.", - "required": true, - "elem": { - "note": { - "name": "note", - "type": "TypeString", - "description": "A short description or alias to assign to the scope.", - "optional": true - }, - "scope_id": { - "name": "scope_id", - "type": "TypeString", - "description": "The ID of the scope, such as an enterprise, account, or account group, where you want to apply the customized defaults that are associated with a template.", - "required": true - }, - "scope_type": { - "name": "scope_type", - "type": "TypeString", - "description": "The type of scope.", - "required": true - } - } - }, - { - "name": "excluded_scopes", - "type": "TypeList", + "description": "A human-readable alias to assign to your rule.", "optional": true, - "elem": { - "note": { - "name": "note", - "type": "TypeString", - "description": "A short description or alias to assign to the scope.", - "optional": true - }, - "scope_id": { - "name": "scope_id", - "type": "TypeString", - "description": "The ID of the scope, such as an enterprise, account, or account group, where you want to apply the customized defaults that are associated with a template.", - "required": true - }, - "scope_type": { - "name": "scope_type", - "type": "TypeString", - "description": "The type of scope.", - "required": true - } - } - }, - { - "name": "version", - "type": "TypeString", - "computed": true + "deprecated": "name is now deprecated" } ], + "ibm_scc_rule_attachment": [], + "ibm_scc_template": [], + "ibm_scc_template_attachment": [], "ibm_schematics_action": [ { - "name": "user_state", - "type": "TypeList", - "description": "User defined status of the Schematics object.", - "optional": true, - "computed": true, - "elem": { - "set_at": { - "name": "set_at", - "type": "TypeString", - "description": "When the User who set the state of the Object.", - "optional": true, - "computed": true - }, - "set_by": { - "name": "set_by", - "type": "TypeString", - "description": "Name of the User who set the state of the Object.", - "optional": true, - "computed": true - }, - "state": { - "name": "state", - "type": "TypeString", - "description": "User-defined states * `draft` Object can be modified; can be used by Jobs run by the author, during execution * `live` Object can be modified; can be used by Jobs during execution * `locked` Object cannot be modified; can be used by Jobs during execution * `disable` Object can be modified. cannot be used by Jobs during execution.", - "optional": true - } - } - }, - { - "name": "crn", - "type": "TypeString", - "description": "Action Cloud Resource Name.", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "created_by", - "type": "TypeString", - "description": "E-mail address of the user who created an action.", - "computed": true - }, - { - "name": "resource_group", + "name": "name", "type": "TypeString", - "description": "Resource-group name for an action. By default, action is created in default resource group.", - "cloud_data_type": "resource_group", - "optional": true - }, - { - "name": "bastion", - "type": "TypeList", - "description": "Describes a bastion resource.", - "optional": true, - "elem": { - "host": { - "name": "host", - "type": "TypeString", - "description": "Reference to the Inventory resource definition.", - "optional": true - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Bastion Name(Unique).", - "optional": true - } - }, - "max_items": 1 - }, - { - "name": "action_inputs", - "type": "TypeList", - "description": "Input variables for the Action.", - "optional": true, - "elem": { - "link": { - "name": "link", - "type": "TypeString", - "description": "Reference link to the variable value By default the expression will point to self.value.", - "optional": true, - "computed": true - }, - "metadata": { - "name": "metadata", - "type": "TypeList", - "description": "User editable metadata for the variables.", - "optional": true, - "elem": { - "aliases": { - "name": "aliases", - "type": "TypeList", - "description": "List of aliases for the variable name.", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - "default_value": { - "name": "default_value", - "type": "TypeString", - "description": "Default value for the variable, if the override value is not specified.", - "optional": true - }, - "description": { - "name": "description", - "type": "TypeString", - "description": "Description of the meta data.", - "optional": true - }, - "group_by": { - "name": "group_by", - "type": "TypeString", - "description": "Display name of the group this variable belongs to.", - "optional": true - }, - "hidden": { - "name": "hidden", - "type": "TypeBool", - "description": "If true, the variable will not be displayed on UI or CLI.", - "optional": true - }, - "immutable": { - "name": "immutable", - "type": "TypeBool", - "description": "Is the variable readonly ?.", - "optional": true - }, - "matches": { - "name": "matches", - "type": "TypeString", - "description": "Regex for the variable value.", - "optional": true - }, - "max_length": { - "name": "max_length", - "type": "TypeInt", - "description": "Maximum length of the variable value. Applicable for string type.", - "optional": true - }, - "max_value": { - "name": "max_value", - "type": "TypeInt", - "description": "Maximum value of the variable. Applicable for integer type.", - "optional": true - }, - "min_length": { - "name": "min_length", - "type": "TypeInt", - "description": "Minimum length of the variable value. Applicable for string type.", - "optional": true - }, - "min_value": { - "name": "min_value", - "type": "TypeInt", - "description": "Minimum value of the variable. Applicable for integer type.", - "optional": true - }, - "options": { - "name": "options", - "type": "TypeList", - "description": "List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - "position": { - "name": "position", - "type": "TypeInt", - "description": "Relative position of this variable in a list.", - "optional": true - }, - "secure": { - "name": "secure", - "type": "TypeBool", - "description": "Is the variable secure or sensitive ?.", - "optional": true - }, - "source": { - "name": "source", - "type": "TypeString", - "description": "Source of this meta-data.", - "optional": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "Type of the variable.", - "optional": true - } - } - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Name of the variable.", - "optional": true - }, - "value": { - "name": "value", - "type": "TypeString", - "description": "Value for the variable or reference to the value.", - "optional": true - } - } + "description": "The unique name of your action. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores. **Example** you can use the name to stop action.", + "required": true, + "min_length": 1, + "max_length": 65 }, { - "name": "settings", + "name": "bastion_credential", "type": "TypeList", - "description": "Environment variables for the Action.", + "description": "User editable variable data \u0026 system generated reference to value.", "optional": true, "elem": { "link": { @@ -132848,257 +138680,44 @@ "optional": true }, "secure": { - "name": "secure", - "type": "TypeBool", - "description": "Is the variable secure or sensitive ?.", - "optional": true - }, - "source": { - "name": "source", - "type": "TypeString", - "description": "Source of this meta-data.", - "optional": true - }, - "type": { - "name": "type", - "type": "TypeString", - "description": "Type of the variable.", - "optional": true - } - } - }, - "name": { - "name": "name", - "type": "TypeString", - "description": "Name of the variable.", - "optional": true - }, - "value": { - "name": "value", - "type": "TypeString", - "description": "Value for the variable or reference to the value.", - "optional": true - } - } - }, - { - "name": "created_at", - "type": "TypeString", - "description": "Action creation time.", - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "The unique name of your action. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores. **Example** you can use the name to stop action.", - "required": true, - "min_length": 1, - "max_length": 65 - }, - { - "name": "description", - "type": "TypeString", - "description": "Action description.", - "optional": true - }, - { - "name": "source_created_by", - "type": "TypeString", - "description": "E-mail address of user who created the Action Playbook Source.", - "computed": true - }, - { - "name": "location", - "type": "TypeString", - "description": "List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.", - "options": "eu-de, eu-gb, us-east, us-south", - "optional": true, - "computed": true - }, - { - "name": "targets_ini", - "type": "TypeString", - "description": "Inventory of host and host group for the playbook in `INI` file format. For example, `\"targets_ini\": \"[webserverhost] 172.22.192.6 [dbhost] 172.22.192.5\"`. For more information, about an inventory host group syntax, see [Inventory host groups](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-reference#schematics-inventory-host-grps).", - "optional": true - }, - { - "name": "state", - "type": "TypeList", - "description": "Computed state of the Action.", - "computed": true, - "elem": { - "status_code": { - "name": "status_code", - "type": "TypeString", - "description": "Status of automation (workspace or action).", - "optional": true - }, - "status_job_id": { - "name": "status_job_id", - "type": "TypeString", - "description": "Job id reference for this status.", - "optional": true - }, - "status_message": { - "name": "status_message", - "type": "TypeString", - "description": "Automation status message - to be displayed along with the status_code.", - "optional": true - } - } - }, - { - "name": "source_updated_at", - "type": "TypeString", - "description": "The action playbook updation time.", - "computed": true - }, - { - "name": "updated_by", - "type": "TypeString", - "description": "E-mail address of the user who updated an action.", - "computed": true - }, - { - "name": "playbook_names", - "type": "TypeList", - "description": "Playbook names retrieved from the respository.", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "source_created_at", - "type": "TypeString", - "description": "Action Playbook Source creation time.", - "computed": true - }, - { - "name": "source_readme_url", - "type": "TypeString", - "description": "URL of the `README` file, for the source URL.", - "optional": true - }, - { - "name": "source", - "type": "TypeList", - "description": "Source of templates, playbooks, or controls.", - "optional": true, - "elem": { - "catalog": { - "name": "catalog", - "type": "TypeList", - "description": "Connection details to IBM Cloud Catalog source.", - "optional": true, - "elem": { - "catalog_name": { - "name": "catalog_name", - "type": "TypeString", - "description": "name of the private catalog.", - "optional": true - }, - "offering_id": { - "name": "offering_id", - "type": "TypeString", - "description": "Id of the offering the IBM Catalog.", - "optional": true - }, - "offering_kind": { - "name": "offering_kind", - "type": "TypeString", - "description": "Type of the offering, in the IBM Catalog.", - "optional": true - }, - "offering_name": { - "name": "offering_name", - "type": "TypeString", - "description": "Name of the offering in the IBM Catalog.", - "optional": true - }, - "offering_repo_url": { - "name": "offering_repo_url", - "type": "TypeString", - "description": "Repo Url of the offering, in the IBM Catalog.", - "optional": true - }, - "offering_version": { - "name": "offering_version", - "type": "TypeString", - "description": "Version string of the offering in the IBM Catalog.", - "optional": true - }, - "offering_version_id": { - "name": "offering_version_id", - "type": "TypeString", - "description": "Id of the offering version the IBM Catalog.", - "optional": true - } - }, - "max_items": 1 - }, - "git": { - "name": "git", - "type": "TypeList", - "description": "Connection details to Git source.", - "optional": true, - "elem": { - "computed_git_repo_url": { - "name": "computed_git_repo_url", - "type": "TypeString", - "description": "The Complete URL which is computed by git_repo_url, git_repo_folder and branch.", - "optional": true - }, - "git_branch": { - "name": "git_branch", - "type": "TypeString", - "description": "Name of the branch, used to fetch the Git Repo.", - "optional": true - }, - "git_release": { - "name": "git_release", - "type": "TypeString", - "description": "Name of the release tag, used to fetch the Git Repo.", - "optional": true - }, - "git_repo_folder": { - "name": "git_repo_folder", - "type": "TypeString", - "description": "Name of the folder in the Git Repo, that contains the template.", + "name": "secure", + "type": "TypeBool", + "description": "Is the variable secure or sensitive ?.", "optional": true }, - "git_repo_url": { - "name": "git_repo_url", + "source": { + "name": "source", "type": "TypeString", - "description": "URL to the GIT Repo that can be used to clone the template.", + "description": "Source of this meta-data.", "optional": true }, - "git_token": { - "name": "git_token", + "type": { + "name": "type", "type": "TypeString", - "description": "Personal Access Token to connect to Git URLs.", + "description": "Type of the variable.", "optional": true } } }, - "source_type": { - "name": "source_type", + "name": { + "name": "name", "type": "TypeString", - "description": "Type of source for the Template.", - "required": true + "description": "Name of the variable.", + "optional": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "Value for the variable or reference to the value.", + "optional": true } - } - }, - { - "name": "inventory", - "type": "TypeString", - "description": "Target inventory record ID, used by the action or ansible playbook.", - "optional": true + }, + "max_items": 1 }, { - "name": "credentials", + "name": "action_inputs", "type": "TypeList", - "description": "credentials of the Action.", + "description": "Input variables for the Action.", "optional": true, "elem": { "link": { @@ -133230,8 +138849,46 @@ "description": "Value for the variable or reference to the value.", "optional": true } - }, - "max_items": 1 + } + }, + { + "name": "source_created_at", + "type": "TypeString", + "description": "Action Playbook Source creation time.", + "computed": true + }, + { + "name": "source_updated_by", + "type": "TypeString", + "description": "E-mail address of user who updated the action playbook source.", + "computed": true + }, + { + "name": "location", + "type": "TypeString", + "description": "List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.", + "options": "eu-de, eu-gb, us-east, us-south", + "optional": true, + "computed": true + }, + { + "name": "source_readme_url", + "type": "TypeString", + "description": "URL of the `README` file, for the source URL.", + "optional": true + }, + { + "name": "source_type", + "type": "TypeString", + "description": "Type of source for the Template.", + "options": "cos_bucket, external_scm, git_hub, git_hub_enterprise, git_lab, ibm_cloud_catalog, ibm_git_lab, local", + "optional": true + }, + { + "name": "command_parameter", + "type": "TypeString", + "description": "Schematics job command parameter (playbook-name).", + "optional": true }, { "name": "sys_lock", @@ -133261,17 +138918,29 @@ } }, { - "name": "x_github_token", + "name": "account", "type": "TypeString", - "description": "The personal access token to authenticate with your private GitHub or GitLab repository and access your Terraform template.", - "optional": true + "description": "Action account ID.", + "computed": true }, { - "name": "account", + "name": "created_at", "type": "TypeString", - "description": "Action account ID.", + "description": "Action creation time.", "computed": true }, + { + "name": "targets_ini", + "type": "TypeString", + "description": "Inventory of host and host group for the playbook in `INI` file format. For example, `\"targets_ini\": \"[webserverhost] 172.22.192.6 [dbhost] 172.22.192.5\"`. For more information, about an inventory host group syntax, see [Inventory host groups](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-reference#schematics-inventory-host-grps).", + "optional": true + }, + { + "name": "x_github_token", + "type": "TypeString", + "description": "The personal access token to authenticate with your private GitHub or GitLab repository and access your Terraform template.", + "optional": true + }, { "name": "updated_at", "type": "TypeString", @@ -133279,32 +138948,34 @@ "computed": true }, { - "name": "tags", - "type": "TypeList", - "description": "Action tags.", - "cloud_data_type": "tags", - "optional": true, - "elem": { - "type": "TypeString" - } + "name": "updated_by", + "type": "TypeString", + "description": "E-mail address of the user who updated an action.", + "computed": true }, { - "name": "source_type", + "name": "resource_group", "type": "TypeString", - "description": "Type of source for the Template.", - "options": "cos_bucket, external_scm, git_hub, git_hub_enterprise, git_lab, ibm_cloud_catalog, ibm_git_lab, local", + "description": "Resource-group name for an action. By default, action is created in default resource group.", + "cloud_data_type": "resource_group", "optional": true }, { - "name": "command_parameter", + "name": "inventory", "type": "TypeString", - "description": "Schematics job command parameter (playbook-name).", + "description": "Target inventory record ID, used by the action or ansible playbook.", "optional": true }, { - "name": "bastion_credential", + "name": "source_created_by", + "type": "TypeString", + "description": "E-mail address of user who created the Action Playbook Source.", + "computed": true + }, + { + "name": "action_outputs", "type": "TypeList", - "description": "User editable variable data \u0026 system generated reference to value.", + "description": "Output variables for the Action.", "optional": true, "elem": { "link": { @@ -133436,13 +139107,18 @@ "description": "Value for the variable or reference to the value.", "optional": true } - }, - "max_items": 1 + } }, { - "name": "action_outputs", + "name": "created_by", + "type": "TypeString", + "description": "E-mail address of the user who created an action.", + "computed": true + }, + { + "name": "credentials", "type": "TypeList", - "description": "Output variables for the Action.", + "description": "credentials of the Action.", "optional": true, "elem": { "link": { @@ -133574,90 +139250,13 @@ "description": "Value for the variable or reference to the value.", "optional": true } - } - }, - { - "name": "source_updated_by", - "type": "TypeString", - "description": "E-mail address of user who updated the action playbook source.", - "computed": true - } - ], - "ibm_schematics_inventory": [ - { - "name": "created_at", - "type": "TypeString", - "description": "Inventory creation time.", - "computed": true - }, - { - "name": "updated_at", - "type": "TypeString", - "description": "Inventory updation time.", - "computed": true - }, - { - "name": "name", - "type": "TypeString", - "description": "The unique name of your Inventory definition. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores.", - "min_length": 3, - "max_length": 64, - "optional": true - }, - { - "name": "location", - "type": "TypeString", - "description": "List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.", - "options": "eu-de, eu-gb, us-east, us-south", - "optional": true, - "computed": true - }, - { - "name": "inventories_ini", - "type": "TypeString", - "description": "Input inventory of host and host group for the playbook, in the `.ini` file format.", - "optional": true - }, - { - "name": "resource_queries", - "type": "TypeList", - "description": "Input resource query definitions that is used to dynamically generate the inventory of host and host group for the playbook.", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "description", - "type": "TypeString", - "description": "The description of your Inventory definition. The description can be up to 2048 characters long in size.", - "optional": true - }, - { - "name": "resource_group", - "type": "TypeString", - "description": "Resource-group name for the Inventory definition. By default, Inventory definition will be created in Default Resource Group.", - "cloud_data_type": "resource_group", - "optional": true - }, - { - "name": "created_by", - "type": "TypeString", - "description": "Email address of user who created the Inventory.", - "computed": true + }, + "max_items": 1 }, { - "name": "updated_by", - "type": "TypeString", - "description": "Email address of user who updated the Inventory.", - "computed": true - } - ], - "ibm_schematics_job": [ - { - "name": "job_env_settings", + "name": "settings", "type": "TypeList", - "description": "Environment variables used by the Job while performing Action or Workspace.", + "description": "Environment variables for the Action.", "optional": true, "elem": { "link": { @@ -133773,7 +139372,7 @@ "name": "type", "type": "TypeString", "description": "Type of the variable.", - "required": true + "optional": true } } }, @@ -133781,26 +139380,285 @@ "name": "name", "type": "TypeString", "description": "Name of the variable.", - "required": true + "optional": true }, "value": { "name": "value", "type": "TypeString", "description": "Value for the variable or reference to the value.", - "required": true + "optional": true + } + } + }, + { + "name": "state", + "type": "TypeList", + "description": "Computed state of the Action.", + "computed": true, + "elem": { + "status_code": { + "name": "status_code", + "type": "TypeString", + "description": "Status of automation (workspace or action).", + "optional": true + }, + "status_job_id": { + "name": "status_job_id", + "type": "TypeString", + "description": "Job id reference for this status.", + "optional": true + }, + "status_message": { + "name": "status_message", + "type": "TypeString", + "description": "Automation status message - to be displayed along with the status_code.", + "optional": true } } }, + { + "name": "crn", + "type": "TypeString", + "description": "Action Cloud Resource Name.", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "source_updated_at", + "type": "TypeString", + "description": "The action playbook updation time.", + "computed": true + }, + { + "name": "playbook_names", + "type": "TypeList", + "description": "Playbook names retrieved from the respository.", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "description", + "type": "TypeString", + "description": "Action description.", + "optional": true + }, { "name": "tags", "type": "TypeList", - "description": "User defined tags, while running the job.", + "description": "Action tags.", "cloud_data_type": "tags", "optional": true, "elem": { "type": "TypeString" } }, + { + "name": "user_state", + "type": "TypeList", + "description": "User defined status of the Schematics object.", + "optional": true, + "computed": true, + "elem": { + "set_at": { + "name": "set_at", + "type": "TypeString", + "description": "When the User who set the state of the Object.", + "optional": true, + "computed": true + }, + "set_by": { + "name": "set_by", + "type": "TypeString", + "description": "Name of the User who set the state of the Object.", + "optional": true, + "computed": true + }, + "state": { + "name": "state", + "type": "TypeString", + "description": "User-defined states * `draft` Object can be modified; can be used by Jobs run by the author, during execution * `live` Object can be modified; can be used by Jobs during execution * `locked` Object cannot be modified; can be used by Jobs during execution * `disable` Object can be modified. cannot be used by Jobs during execution.", + "optional": true + } + } + }, + { + "name": "source", + "type": "TypeList", + "description": "Source of templates, playbooks, or controls.", + "optional": true, + "elem": { + "catalog": { + "name": "catalog", + "type": "TypeList", + "description": "Connection details to IBM Cloud Catalog source.", + "optional": true, + "elem": { + "catalog_name": { + "name": "catalog_name", + "type": "TypeString", + "description": "name of the private catalog.", + "optional": true + }, + "offering_id": { + "name": "offering_id", + "type": "TypeString", + "description": "Id of the offering the IBM Catalog.", + "optional": true + }, + "offering_kind": { + "name": "offering_kind", + "type": "TypeString", + "description": "Type of the offering, in the IBM Catalog.", + "optional": true + }, + "offering_name": { + "name": "offering_name", + "type": "TypeString", + "description": "Name of the offering in the IBM Catalog.", + "optional": true + }, + "offering_repo_url": { + "name": "offering_repo_url", + "type": "TypeString", + "description": "Repo Url of the offering, in the IBM Catalog.", + "optional": true + }, + "offering_version": { + "name": "offering_version", + "type": "TypeString", + "description": "Version string of the offering in the IBM Catalog.", + "optional": true + }, + "offering_version_id": { + "name": "offering_version_id", + "type": "TypeString", + "description": "Id of the offering version the IBM Catalog.", + "optional": true + } + }, + "max_items": 1 + }, + "git": { + "name": "git", + "type": "TypeList", + "description": "Connection details to Git source.", + "optional": true, + "elem": { + "computed_git_repo_url": { + "name": "computed_git_repo_url", + "type": "TypeString", + "description": "The Complete URL which is computed by git_repo_url, git_repo_folder and branch.", + "optional": true + }, + "git_branch": { + "name": "git_branch", + "type": "TypeString", + "description": "Name of the branch, used to fetch the Git Repo.", + "optional": true + }, + "git_release": { + "name": "git_release", + "type": "TypeString", + "description": "Name of the release tag, used to fetch the Git Repo.", + "optional": true + }, + "git_repo_folder": { + "name": "git_repo_folder", + "type": "TypeString", + "description": "Name of the folder in the Git Repo, that contains the template.", + "optional": true + }, + "git_repo_url": { + "name": "git_repo_url", + "type": "TypeString", + "description": "URL to the GIT Repo that can be used to clone the template.", + "optional": true + }, + "git_token": { + "name": "git_token", + "type": "TypeString", + "description": "Personal Access Token to connect to Git URLs.", + "optional": true + } + } + }, + "source_type": { + "name": "source_type", + "type": "TypeString", + "description": "Type of source for the Template.", + "required": true + } + } + }, + { + "name": "bastion", + "type": "TypeList", + "description": "Describes a bastion resource.", + "optional": true, + "elem": { + "host": { + "name": "host", + "type": "TypeString", + "description": "Reference to the Inventory resource definition.", + "optional": true + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Bastion Name(Unique).", + "optional": true + } + }, + "max_items": 1 + } + ], + "ibm_schematics_inventory": [ + { + "name": "description", + "type": "TypeString", + "description": "The description of your Inventory definition. The description can be up to 2048 characters long in size.", + "optional": true + }, + { + "name": "inventories_ini", + "type": "TypeString", + "description": "Input inventory of host and host group for the playbook, in the `.ini` file format.", + "optional": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "Inventory creation time.", + "computed": true + }, + { + "name": "created_by", + "type": "TypeString", + "description": "Email address of user who created the Inventory.", + "computed": true + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "Inventory updation time.", + "computed": true + }, + { + "name": "updated_by", + "type": "TypeString", + "description": "Email address of user who updated the Inventory.", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "The unique name of your Inventory definition. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores.", + "min_length": 3, + "max_length": 64, + "optional": true + }, { "name": "location", "type": "TypeString", @@ -133809,6 +139667,24 @@ "optional": true, "computed": true }, + { + "name": "resource_group", + "type": "TypeString", + "description": "Resource-group name for the Inventory definition. By default, Inventory definition will be created in Default Resource Group.", + "cloud_data_type": "resource_group", + "optional": true + }, + { + "name": "resource_queries", + "type": "TypeList", + "description": "Input resource query definitions that is used to dynamically generate the inventory of host and host group for the playbook.", + "optional": true, + "elem": { + "type": "TypeString" + } + } + ], + "ibm_schematics_job": [ { "name": "bastion", "type": "TypeList", @@ -133831,359 +139707,181 @@ "max_items": 1 }, { - "name": "log_summary", + "name": "start_at", + "type": "TypeString", + "description": "Job start time.", + "computed": true + }, + { + "name": "duration", + "type": "TypeString", + "description": "Duration of job execution; example 40 sec.", + "computed": true + }, + { + "name": "command_options", "type": "TypeList", - "description": "Job log summary record.", + "description": "Command line options for the command.", "optional": true, - "computed": true, "elem": { - "action_job": { - "name": "action_job", - "type": "TypeList", - "description": "Flow Job log summary.", - "optional": true, - "elem": { - "play_count": { - "name": "play_count", - "type": "TypeFloat", - "description": "number of plays in playbook.", - "optional": true, - "computed": true - }, - "recap": { - "name": "recap", - "type": "TypeList", - "description": "Recap records.", - "optional": true, - "elem": { - "changed": { - "name": "changed", - "type": "TypeFloat", - "description": "Number of changed.", - "optional": true - }, - "failed": { - "name": "failed", - "type": "TypeFloat", - "description": "Number of failed.", - "optional": true - }, - "ok": { - "name": "ok", - "type": "TypeFloat", - "description": "Number of OK.", - "optional": true - }, - "skipped": { - "name": "skipped", - "type": "TypeFloat", - "description": "Number of skipped.", - "optional": true - }, - "target": { - "name": "target", - "type": "TypeList", - "description": "List of target or host name.", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - "unreachable": { - "name": "unreachable", - "type": "TypeFloat", - "description": "Number of unreachable.", - "optional": true - } - } - }, - "target_count": { - "name": "target_count", - "type": "TypeFloat", - "description": "number of targets or hosts.", - "optional": true, - "computed": true - }, - "task_count": { - "name": "task_count", - "type": "TypeFloat", - "description": "number of tasks in playbook.", - "optional": true, - "computed": true - } - } - }, - "elapsed_time": { - "name": "elapsed_time", - "type": "TypeFloat", - "description": "Job log elapsed time (log_analyzed_till - log_start_at).", + "type": "TypeString" + } + }, + { + "name": "job_env_settings", + "type": "TypeList", + "description": "Environment variables used by the Job while performing Action or Workspace.", + "optional": true, + "elem": { + "link": { + "name": "link", + "type": "TypeString", + "description": "Reference link to the variable value By default the expression will point to self.value.", "optional": true, "computed": true }, - "flow_job": { - "name": "flow_job", + "metadata": { + "name": "metadata", "type": "TypeList", - "description": "Flow Job log summary.", + "description": "User editable metadata for the variables.", "optional": true, "elem": { - "workitems": { - "name": "workitems", + "aliases": { + "name": "aliases", "type": "TypeList", + "description": "List of aliases for the variable name.", "optional": true, "elem": { - "job_id": { - "name": "job_id", - "type": "TypeString", - "description": "workspace JOB ID.", - "optional": true - }, - "log_url": { - "name": "log_url", - "type": "TypeString", - "description": "Log url for job.", - "optional": true - }, - "resources_add": { - "name": "resources_add", - "type": "TypeFloat", - "description": "Number of resources add.", - "optional": true, - "computed": true - }, - "resources_destroy": { - "name": "resources_destroy", - "type": "TypeFloat", - "description": "Number of resources destroy.", - "optional": true, - "computed": true - }, - "resources_modify": { - "name": "resources_modify", - "type": "TypeFloat", - "description": "Number of resources modify.", - "optional": true, - "computed": true - }, - "workspace_id": { - "name": "workspace_id", - "type": "TypeString", - "description": "workspace ID.", - "optional": true - } + "type": "TypeString" } }, - "workitems_completed": { - "name": "workitems_completed", - "type": "TypeFloat", - "description": "Number of workitems completed successfully.", - "optional": true, - "computed": true + "default_value": { + "name": "default_value", + "type": "TypeString", + "description": "Default value for the variable, if the override value is not specified.", + "optional": true }, - "workitems_failed": { - "name": "workitems_failed", - "type": "TypeFloat", - "description": "Number of workitems failed.", - "optional": true, - "computed": true + "description": { + "name": "description", + "type": "TypeString", + "description": "Description of the meta data.", + "optional": true }, - "workitems_pending": { - "name": "workitems_pending", - "type": "TypeFloat", - "description": "Number of workitems pending in the flow.", - "optional": true, - "computed": true - } - }, - "max_items": 1 - }, - "job_id": { - "name": "job_id", - "type": "TypeString", - "description": "Workspace Id.", - "optional": true, - "computed": true - }, - "job_type": { - "name": "job_type", - "type": "TypeString", - "description": "Type of Job.", - "optional": true - }, - "log_analyzed_till": { - "name": "log_analyzed_till", - "type": "TypeString", - "description": "Job log update timestamp.", - "optional": true, - "computed": true - }, - "log_errors": { - "name": "log_errors", - "type": "TypeList", - "description": "Job log errors.", - "optional": true, - "computed": true, - "elem": { - "error_code": { - "name": "error_code", + "group_by": { + "name": "group_by", "type": "TypeString", - "description": "Error code in the Log.", + "description": "Display name of the group this variable belongs to.", "optional": true }, - "error_count": { - "name": "error_count", - "type": "TypeFloat", - "description": "Number of occurrence.", + "hidden": { + "name": "hidden", + "type": "TypeBool", + "description": "If true, the variable will not be displayed on UI or CLI.", "optional": true }, - "error_msg": { - "name": "error_msg", - "type": "TypeString", - "description": "Summary error message in the log.", + "immutable": { + "name": "immutable", + "type": "TypeBool", + "description": "Is the variable readonly ?.", "optional": true - } - } - }, - "log_start_at": { - "name": "log_start_at", - "type": "TypeString", - "description": "Job log start timestamp.", - "optional": true, - "computed": true - }, - "repo_download_job": { - "name": "repo_download_job", - "type": "TypeList", - "description": "Repo download Job log summary.", - "optional": true, - "elem": { - "detected_filetype": { - "name": "detected_filetype", - "type": "TypeString", - "description": "Detected template or data file type.", - "optional": true, - "computed": true }, - "inputs_count": { - "name": "inputs_count", + "matches": { + "name": "matches", "type": "TypeString", - "description": "Number of inputs detected.", - "optional": true, - "computed": true + "description": "Regex for the variable value.", + "optional": true }, - "outputs_count": { - "name": "outputs_count", - "type": "TypeString", - "description": "Number of outputs detected.", - "optional": true, - "computed": true + "max_length": { + "name": "max_length", + "type": "TypeInt", + "description": "Maximum length of the variable value. Applicable for string type.", + "optional": true }, - "quarantined_file_count": { - "name": "quarantined_file_count", - "type": "TypeFloat", - "description": "Number of files quarantined.", - "optional": true, - "computed": true + "max_value": { + "name": "max_value", + "type": "TypeInt", + "description": "Maximum value of the variable. Applicable for integer type.", + "optional": true }, - "scanned_file_count": { - "name": "scanned_file_count", - "type": "TypeFloat", - "description": "Number of files scanned.", - "optional": true, - "computed": true - } - } - }, - "system_job": { - "name": "system_job", - "type": "TypeList", - "description": "System Job log summary.", - "optional": true, - "elem": { - "failed": { - "name": "failed", - "type": "TypeFloat", - "description": "Number of failed.", + "min_length": { + "name": "min_length", + "type": "TypeInt", + "description": "Minimum length of the variable value. Applicable for string type.", "optional": true }, - "success": { - "name": "success", - "type": "TypeFloat", - "description": "Number of passed.", + "min_value": { + "name": "min_value", + "type": "TypeInt", + "description": "Minimum value of the variable. Applicable for integer type.", "optional": true }, - "target_count": { - "name": "target_count", - "type": "TypeFloat", - "description": "number of targets or hosts.", - "optional": true, - "computed": true - } - }, - "max_items": 1 - }, - "workspace_job": { - "name": "workspace_job", - "type": "TypeList", - "description": "Workspace Job log summary.", - "optional": true, - "elem": { - "resources_add": { - "name": "resources_add", - "type": "TypeFloat", - "description": "Number of resources add.", + "options": { + "name": "options", + "type": "TypeList", + "description": "List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.", "optional": true, - "computed": true + "elem": { + "type": "TypeString" + } }, - "resources_destroy": { - "name": "resources_destroy", - "type": "TypeFloat", - "description": "Number of resources destroy.", - "optional": true, - "computed": true + "position": { + "name": "position", + "type": "TypeInt", + "description": "Relative position of this variable in a list.", + "optional": true }, - "resources_modify": { - "name": "resources_modify", - "type": "TypeFloat", - "description": "Number of resources modify.", - "optional": true, - "computed": true + "secure": { + "name": "secure", + "type": "TypeBool", + "description": "Is the variable secure or sensitive ?.", + "optional": true + }, + "source": { + "name": "source", + "type": "TypeString", + "description": "Source of this meta-data.", + "optional": true + }, + "type": { + "name": "type", + "type": "TypeString", + "description": "Type of the variable.", + "required": true } - }, - "max_items": 1 + } + }, + "name": { + "name": "name", + "type": "TypeString", + "description": "Name of the variable.", + "required": true + }, + "value": { + "name": "value", + "type": "TypeString", + "description": "Value for the variable or reference to the value.", + "required": true } } }, { - "name": "resource_group", - "type": "TypeString", - "description": "Resource-group name derived from the related Workspace or Action.", - "cloud_data_type": "resource_group", - "computed": true - }, - { - "name": "start_at", - "type": "TypeString", - "description": "Job start time.", - "computed": true - }, - { - "name": "log_store_url", - "type": "TypeString", - "description": "Job log store URL.", - "computed": true + "name": "tags", + "type": "TypeList", + "description": "User defined tags, while running the job.", + "cloud_data_type": "tags", + "optional": true, + "elem": { + "type": "TypeString" + } }, { - "name": "updated_at", + "name": "location", "type": "TypeString", - "description": "Job status updation timestamp.", + "description": "List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.", + "options": "eu-de, eu-gb, us-east, us-south", + "optional": true, "computed": true }, - { - "name": "command_object_id", - "type": "TypeString", - "description": "Job command object id (workspace-id, action-id).", - "required": true - }, { "name": "status", "type": "TypeList", @@ -134551,15 +140249,35 @@ } }, { - "name": "submitted_by", + "name": "command_name", "type": "TypeString", - "description": "Email address of user who submitted the job.", + "description": "Schematics job command name.", + "required": true, + "options": "ansible_playbook_check, ansible_playbook_run, create_action, create_cart, create_environment, create_workspace, delete_action, delete_environment, delete_workspace, environment_init, environment_install, environment_uninstall, patch_action, patch_workspace, put_action, put_environment, put_workspace, repository_process, system_key_delete, system_key_disable, system_key_enable, system_key_restore, system_key_rotate, workspace_apply, workspace_destroy, workspace_plan, workspace_refresh" + }, + { + "name": "resource_group", + "type": "TypeString", + "description": "Resource-group name derived from the related Workspace or Action.", + "cloud_data_type": "resource_group", "computed": true }, { - "name": "results_url", + "name": "submitted_at", "type": "TypeString", - "description": "Job results store URL.", + "description": "Job submission time.", + "computed": true + }, + { + "name": "log_store_url", + "type": "TypeString", + "description": "Job log store URL.", + "computed": true + }, + { + "name": "state_store_url", + "type": "TypeString", + "description": "Job state store URL.", "computed": true }, { @@ -134705,41 +140423,6 @@ } } }, - { - "name": "end_at", - "type": "TypeString", - "description": "Job end time.", - "computed": true - }, - { - "name": "duration", - "type": "TypeString", - "description": "Duration of job execution; example 40 sec.", - "computed": true - }, - { - "name": "command_object", - "type": "TypeString", - "description": "Name of the Schematics automation resource.", - "required": true, - "options": "action, environment, system, workspace" - }, - { - "name": "command_name", - "type": "TypeString", - "description": "Schematics job command name.", - "required": true, - "options": "ansible_playbook_check, ansible_playbook_run, create_action, create_cart, create_environment, create_workspace, delete_action, delete_environment, delete_workspace, environment_init, environment_install, environment_uninstall, patch_action, patch_workspace, put_action, put_environment, put_workspace, repository_process, system_key_delete, system_key_disable, system_key_enable, system_key_restore, system_key_rotate, workspace_apply, workspace_destroy, workspace_plan, workspace_refresh" - }, - { - "name": "command_options", - "type": "TypeList", - "description": "Command line options for the command.", - "optional": true, - "elem": { - "type": "TypeString" - } - }, { "name": "data", "type": "TypeList", @@ -136832,27 +142515,375 @@ } }, { - "name": "name", + "name": "submitted_by", "type": "TypeString", - "description": "Job name, uniquely derived from the related Workspace or Action.", + "description": "Email address of user who submitted the job.", "computed": true }, { - "name": "description", + "name": "end_at", "type": "TypeString", - "description": "The description of your job is derived from the related action or workspace. The description can be up to 2048 characters long in size.", + "description": "Job end time.", "computed": true }, { - "name": "submitted_at", + "name": "results_url", "type": "TypeString", - "description": "Job submission time.", + "description": "Job results store URL.", "computed": true }, { - "name": "state_store_url", + "name": "updated_at", "type": "TypeString", - "description": "Job state store URL.", + "description": "Job status updation timestamp.", + "computed": true + }, + { + "name": "command_object", + "type": "TypeString", + "description": "Name of the Schematics automation resource.", + "required": true, + "options": "action, environment, system, workspace" + }, + { + "name": "command_object_id", + "type": "TypeString", + "description": "Job command object id (workspace-id, action-id).", + "required": true + }, + { + "name": "log_summary", + "type": "TypeList", + "description": "Job log summary record.", + "optional": true, + "computed": true, + "elem": { + "action_job": { + "name": "action_job", + "type": "TypeList", + "description": "Flow Job log summary.", + "optional": true, + "elem": { + "play_count": { + "name": "play_count", + "type": "TypeFloat", + "description": "number of plays in playbook.", + "optional": true, + "computed": true + }, + "recap": { + "name": "recap", + "type": "TypeList", + "description": "Recap records.", + "optional": true, + "elem": { + "changed": { + "name": "changed", + "type": "TypeFloat", + "description": "Number of changed.", + "optional": true + }, + "failed": { + "name": "failed", + "type": "TypeFloat", + "description": "Number of failed.", + "optional": true + }, + "ok": { + "name": "ok", + "type": "TypeFloat", + "description": "Number of OK.", + "optional": true + }, + "skipped": { + "name": "skipped", + "type": "TypeFloat", + "description": "Number of skipped.", + "optional": true + }, + "target": { + "name": "target", + "type": "TypeList", + "description": "List of target or host name.", + "optional": true, + "elem": { + "type": "TypeString" + } + }, + "unreachable": { + "name": "unreachable", + "type": "TypeFloat", + "description": "Number of unreachable.", + "optional": true + } + } + }, + "target_count": { + "name": "target_count", + "type": "TypeFloat", + "description": "number of targets or hosts.", + "optional": true, + "computed": true + }, + "task_count": { + "name": "task_count", + "type": "TypeFloat", + "description": "number of tasks in playbook.", + "optional": true, + "computed": true + } + } + }, + "elapsed_time": { + "name": "elapsed_time", + "type": "TypeFloat", + "description": "Job log elapsed time (log_analyzed_till - log_start_at).", + "optional": true, + "computed": true + }, + "flow_job": { + "name": "flow_job", + "type": "TypeList", + "description": "Flow Job log summary.", + "optional": true, + "elem": { + "workitems": { + "name": "workitems", + "type": "TypeList", + "optional": true, + "elem": { + "job_id": { + "name": "job_id", + "type": "TypeString", + "description": "workspace JOB ID.", + "optional": true + }, + "log_url": { + "name": "log_url", + "type": "TypeString", + "description": "Log url for job.", + "optional": true + }, + "resources_add": { + "name": "resources_add", + "type": "TypeFloat", + "description": "Number of resources add.", + "optional": true, + "computed": true + }, + "resources_destroy": { + "name": "resources_destroy", + "type": "TypeFloat", + "description": "Number of resources destroy.", + "optional": true, + "computed": true + }, + "resources_modify": { + "name": "resources_modify", + "type": "TypeFloat", + "description": "Number of resources modify.", + "optional": true, + "computed": true + }, + "workspace_id": { + "name": "workspace_id", + "type": "TypeString", + "description": "workspace ID.", + "optional": true + } + } + }, + "workitems_completed": { + "name": "workitems_completed", + "type": "TypeFloat", + "description": "Number of workitems completed successfully.", + "optional": true, + "computed": true + }, + "workitems_failed": { + "name": "workitems_failed", + "type": "TypeFloat", + "description": "Number of workitems failed.", + "optional": true, + "computed": true + }, + "workitems_pending": { + "name": "workitems_pending", + "type": "TypeFloat", + "description": "Number of workitems pending in the flow.", + "optional": true, + "computed": true + } + }, + "max_items": 1 + }, + "job_id": { + "name": "job_id", + "type": "TypeString", + "description": "Workspace Id.", + "optional": true, + "computed": true + }, + "job_type": { + "name": "job_type", + "type": "TypeString", + "description": "Type of Job.", + "optional": true + }, + "log_analyzed_till": { + "name": "log_analyzed_till", + "type": "TypeString", + "description": "Job log update timestamp.", + "optional": true, + "computed": true + }, + "log_errors": { + "name": "log_errors", + "type": "TypeList", + "description": "Job log errors.", + "optional": true, + "computed": true, + "elem": { + "error_code": { + "name": "error_code", + "type": "TypeString", + "description": "Error code in the Log.", + "optional": true + }, + "error_count": { + "name": "error_count", + "type": "TypeFloat", + "description": "Number of occurrence.", + "optional": true + }, + "error_msg": { + "name": "error_msg", + "type": "TypeString", + "description": "Summary error message in the log.", + "optional": true + } + } + }, + "log_start_at": { + "name": "log_start_at", + "type": "TypeString", + "description": "Job log start timestamp.", + "optional": true, + "computed": true + }, + "repo_download_job": { + "name": "repo_download_job", + "type": "TypeList", + "description": "Repo download Job log summary.", + "optional": true, + "elem": { + "detected_filetype": { + "name": "detected_filetype", + "type": "TypeString", + "description": "Detected template or data file type.", + "optional": true, + "computed": true + }, + "inputs_count": { + "name": "inputs_count", + "type": "TypeString", + "description": "Number of inputs detected.", + "optional": true, + "computed": true + }, + "outputs_count": { + "name": "outputs_count", + "type": "TypeString", + "description": "Number of outputs detected.", + "optional": true, + "computed": true + }, + "quarantined_file_count": { + "name": "quarantined_file_count", + "type": "TypeFloat", + "description": "Number of files quarantined.", + "optional": true, + "computed": true + }, + "scanned_file_count": { + "name": "scanned_file_count", + "type": "TypeFloat", + "description": "Number of files scanned.", + "optional": true, + "computed": true + } + } + }, + "system_job": { + "name": "system_job", + "type": "TypeList", + "description": "System Job log summary.", + "optional": true, + "elem": { + "failed": { + "name": "failed", + "type": "TypeFloat", + "description": "Number of failed.", + "optional": true + }, + "success": { + "name": "success", + "type": "TypeFloat", + "description": "Number of passed.", + "optional": true + }, + "target_count": { + "name": "target_count", + "type": "TypeFloat", + "description": "number of targets or hosts.", + "optional": true, + "computed": true + } + }, + "max_items": 1 + }, + "workspace_job": { + "name": "workspace_job", + "type": "TypeList", + "description": "Workspace Job log summary.", + "optional": true, + "elem": { + "resources_add": { + "name": "resources_add", + "type": "TypeFloat", + "description": "Number of resources add.", + "optional": true, + "computed": true + }, + "resources_destroy": { + "name": "resources_destroy", + "type": "TypeFloat", + "description": "Number of resources destroy.", + "optional": true, + "computed": true + }, + "resources_modify": { + "name": "resources_modify", + "type": "TypeFloat", + "description": "Number of resources modify.", + "optional": true, + "computed": true + } + }, + "max_items": 1 + } + } + }, + { + "name": "name", + "type": "TypeString", + "description": "Job name, uniquely derived from the related Workspace or Action.", + "computed": true + }, + { + "name": "description", + "type": "TypeString", + "description": "The description of your job is derived from the related action or workspace. The description can be up to 2048 characters long in size.", "computed": true } ], @@ -136952,15 +142983,23 @@ ], "ibm_schematics_workspace": [ { - "name": "frozen", - "type": "TypeBool", - "description": "If set to true, the workspace is frozen and changes to the workspace are disabled.", + "name": "frozen_by", + "type": "TypeString", + "description": "The user ID that froze the workspace.", "optional": true }, { - "name": "created_by", + "name": "locked", + "type": "TypeBool", + "description": "If set to true, the workspace is locked and disabled for changes.", + "optional": true, + "computed": true + }, + { + "name": "crn", "type": "TypeString", - "description": "The user ID that created the workspace.", + "description": "The workspace CRN.", + "cloud_data_type": "crn", "computed": true }, { @@ -136970,6 +143009,108 @@ "max_length": 2048, "optional": true }, + { + "name": "shared_data", + "type": "TypeList", + "description": "Information about the Target used by the templates originating from the IBM Cloud catalog offerings. This information is not relevant for workspace created using your own Terraform template.", + "optional": true, + "elem": { + "cluster_created_on": { + "name": "cluster_created_on", + "type": "TypeString", + "description": "Cluster created on.", + "optional": true + }, + "cluster_id": { + "name": "cluster_id", + "type": "TypeString", + "description": "The ID of the cluster where you want to provision the resources of all IBM Cloud catalog templates that are included in the catalog offering.", + "optional": true + }, + "cluster_name": { + "name": "cluster_name", + "type": "TypeString", + "description": "The cluster name.", + "optional": true + }, + "cluster_type": { + "name": "cluster_type", + "type": "TypeString", + "description": "The cluster type.", + "optional": true + }, + "entitlement_keys": { + "name": "entitlement_keys", + "type": "TypeList", + "description": "The entitlement key that you want to use to install IBM Cloud entitled software.", + "optional": true, + "elem": { + "type": "TypeMap" + } + }, + "namespace": { + "name": "namespace", + "type": "TypeString", + "description": "The Kubernetes namespace or OpenShift project where the resources of all IBM Cloud catalog templates that are included in the catalog offering are deployed into.", + "optional": true + }, + "region": { + "name": "region", + "type": "TypeString", + "description": "The IBM Cloud region that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.", + "optional": true + }, + "resource_group_id": { + "name": "resource_group_id", + "type": "TypeString", + "description": "The ID of the resource group that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.", + "optional": true + }, + "worker_count": { + "name": "worker_count", + "type": "TypeInt", + "description": "The cluster worker count.", + "optional": true + }, + "worker_machine_type": { + "name": "worker_machine_type", + "type": "TypeString", + "description": "The cluster worker type.", + "optional": true + } + }, + "max_items": 1 + }, + { + "name": "template_uninstall_script_name", + "type": "TypeString", + "description": "Uninstall script name.", + "optional": true + }, + { + "name": "template_git_branch", + "type": "TypeString", + "description": "The repository branch.", + "optional": true + }, + { + "name": "template_git_url", + "type": "TypeString", + "description": "The source URL.", + "optional": true + }, + { + "name": "status_code", + "type": "TypeString", + "description": "The success or error code that was returned for the last plan, apply, or destroy job that ran against your workspace.", + "computed": true + }, + { + "name": "status_msg", + "type": "TypeString", + "description": "The success or error message that was returned for the last plan, apply, or destroy job that ran against your workspace.", + "computed": true + }, { "name": "template_env_settings", "type": "TypeList", @@ -136980,10 +143121,37 @@ } }, { - "name": "template_values", + "name": "locked_by", "type": "TypeString", - "description": "A list of variable values that you want to apply during the Helm chart installation. The list must be provided in JSON format, such as `\"autoscaling: enabled: true minReplicas: 2\"`. The values that you define here override the default Helm chart values. This field is supported only for IBM Cloud catalog offerings that are provisioned by using the Terraform Helm provider.", - "optional": true + "description": "The user ID that initiated a resource-related action, such as applying or destroying resources, that locked the workspace.", + "optional": true, + "computed": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "The timestamp when the workspace was created.", + "computed": true + }, + { + "name": "status", + "type": "TypeString", + "description": "The status of the workspace. **Active**: After you successfully ran your infrastructure code by applying your Terraform execution plan, the state of your workspace changes to `Active`. **Connecting**: Schematics tries to connect to the template in your source repo. If successfully connected, the template is downloaded and metadata, such as input parameters, is extracted. After the template is downloaded, the state of the workspace changes to `Scanning`. **Draft**: The workspace is created without a reference to a GitHub or GitLab repository. **Failed**: If errors occur during the execution of your infrastructure code in IBM Cloud Schematics, your workspace status is set to `Failed`. **Inactive**: The Terraform template was scanned successfully and the workspace creation is complete. You can now start running Schematics plan and apply jobs to provision the IBM Cloud resources that you specified in your template. If you have an `Active` workspace and decide to remove all your resources, your workspace is set to `Inactive` after all your resources are removed. **In progress**: When you instruct IBM Cloud Schematics to run your infrastructure code by applying your Terraform execution plan, the status of our workspace changes to `In progress`. **Scanning**: The download of the Terraform template is complete and vulnerability scanning started. If the scan is successful, the workspace state changes to `Inactive`. If errors in your template are found, the state changes to `Template Error`. **Stopped**: The Schematics plan, apply, or destroy job was cancelled manually. **Template Error**: The Schematics template contains errors and cannot be processed.", + "computed": true + }, + { + "name": "updated_by", + "type": "TypeString", + "description": "The user ID that updated the workspace.", + "computed": true + }, + { + "name": "location", + "type": "TypeString", + "description": "The location where you want to create your Schematics workspace and run the Schematics jobs. The location that you enter must match the API endpoint that you use. For example, if you use the Frankfurt API endpoint, you must specify `eu-de` as your location. If you use an API endpoint for a geography and you do not specify a location, Schematics determines the location based on availability.", + "cloud_data_type": "region", + "optional": true, + "computed": true }, { "name": "template_values_metadata", @@ -137115,85 +143283,143 @@ } }, { - "name": "template_ref", + "name": "template_git_folder", "type": "TypeString", - "description": "Workspace template ref.", + "description": "The subfolder in your GitHub or GitLab repository where your Terraform template is stored.", "optional": true }, { - "name": "template_uninstall_script_name", + "name": "template_init_state_file", "type": "TypeString", - "description": "Uninstall script name.", + "description": "The content of an existing Terraform statefile that you want to import in to your workspace. To get the content of a Terraform statefile for a specific Terraform template in an existing workspace, run `ibmcloud schematics state pull --id \u003cworkspace_id\u003e --template \u003ctemplate_id\u003e`.", "optional": true }, { - "name": "template_git_repo_sha_value", + "name": "created_by", "type": "TypeString", - "description": "The repository SHA value.", - "optional": true + "description": "The user ID that created the workspace.", + "computed": true }, { - "name": "locked", - "type": "TypeBool", - "description": "If set to true, the workspace is locked and disabled for changes.", + "name": "applied_shareddata_ids", + "type": "TypeList", + "description": "List of applied shared dataset ID.", "optional": true, - "computed": true + "elem": { + "type": "TypeString" + } }, { - "name": "status", - "type": "TypeString", - "description": "The status of the workspace. **Active**: After you successfully ran your infrastructure code by applying your Terraform execution plan, the state of your workspace changes to `Active`. **Connecting**: Schematics tries to connect to the template in your source repo. If successfully connected, the template is downloaded and metadata, such as input parameters, is extracted. After the template is downloaded, the state of the workspace changes to `Scanning`. **Draft**: The workspace is created without a reference to a GitHub or GitLab repository. **Failed**: If errors occur during the execution of your infrastructure code in IBM Cloud Schematics, your workspace status is set to `Failed`. **Inactive**: The Terraform template was scanned successfully and the workspace creation is complete. You can now start running Schematics plan and apply jobs to provision the IBM Cloud resources that you specified in your template. If you have an `Active` workspace and decide to remove all your resources, your workspace is set to `Inactive` after all your resources are removed. **In progress**: When you instruct IBM Cloud Schematics to run your infrastructure code by applying your Terraform execution plan, the status of our workspace changes to `In progress`. **Scanning**: The download of the Terraform template is complete and vulnerability scanning started. If the scan is successful, the workspace state changes to `Inactive`. If errors in your template are found, the state changes to `Template Error`. **Stopped**: The Schematics plan, apply, or destroy job was cancelled manually. **Template Error**: The Schematics template contains errors and cannot be processed.", - "computed": true + "name": "tags", + "type": "TypeList", + "description": "A list of tags that are associated with the workspace.", + "cloud_data_type": "tags", + "optional": true, + "elem": { + "type": "TypeString" + } }, { - "name": "status_code", + "name": "template_git_repo_sha_value", "type": "TypeString", - "description": "The success or error code that was returned for the last plan, apply, or destroy job that ran against your workspace.", - "computed": true + "description": "The repository SHA value.", + "optional": true }, { - "name": "resource_group", + "name": "frozen_at", "type": "TypeString", - "description": "The ID of the resource group where you want to provision the workspace.", - "cloud_data_type": "resource_group", + "description": "The timestamp when the workspace was frozen.", "optional": true }, { - "name": "template_git_branch", + "name": "x_github_token", "type": "TypeString", - "description": "The repository branch.", + "description": "The personal access token to authenticate with your private GitHub or GitLab repository and access your Terraform template.", "optional": true }, { - "name": "last_health_check_at", - "type": "TypeString", - "description": "The timestamp when the last health check was performed by Schematics.", - "computed": true + "name": "catalog_ref", + "type": "TypeList", + "description": "Information about the software template that you chose from the IBM Cloud catalog. This information is returned for IBM Cloud catalog offerings only.", + "optional": true, + "elem": { + "dry_run": { + "name": "dry_run", + "type": "TypeBool", + "description": "Dry run.", + "optional": true + }, + "item_icon_url": { + "name": "item_icon_url", + "type": "TypeString", + "description": "The URL to the icon of the software template in the IBM Cloud catalog.", + "optional": true + }, + "item_id": { + "name": "item_id", + "type": "TypeString", + "description": "The ID of the software template that you chose to install from the IBM Cloud catalog. This software is provisioned with Schematics.", + "optional": true + }, + "item_name": { + "name": "item_name", + "type": "TypeString", + "description": "The name of the software that you chose to install from the IBM Cloud catalog.", + "optional": true + }, + "item_readme_url": { + "name": "item_readme_url", + "type": "TypeString", + "description": "The URL to the readme file of the software template in the IBM Cloud catalog.", + "optional": true + }, + "item_url": { + "name": "item_url", + "type": "TypeString", + "description": "The URL to the software template in the IBM Cloud catalog.", + "optional": true + }, + "launch_url": { + "name": "launch_url", + "type": "TypeString", + "description": "The URL to the dashboard to access your software.", + "optional": true + }, + "offering_version": { + "name": "offering_version", + "type": "TypeString", + "description": "The version of the software template that you chose to install from the IBM Cloud catalog.", + "optional": true + }, + "owning_account": { + "name": "owning_account", + "type": "TypeString", + "description": "Owning account ID of the catalog.", + "optional": true + } + }, + "max_items": 1 }, { - "name": "template_git_folder", + "name": "name", "type": "TypeString", - "description": "The subfolder in your GitHub or GitLab repository where your Terraform template is stored.", - "optional": true + "description": "The name of your workspace. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores. When you create a workspace for your own Terraform template, consider including the microservice component that you set up with your Terraform template and the IBM Cloud environment where you want to deploy your resources in your name.", + "required": true, + "min_length": 1, + "max_length": 128, + "matches": "^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$" }, { - "name": "template_init_state_file", + "name": "template_ref", "type": "TypeString", - "description": "The content of an existing Terraform statefile that you want to import in to your workspace. To get the content of a Terraform statefile for a specific Terraform template in an existing workspace, run `ibmcloud schematics state pull --id \u003cworkspace_id\u003e --template \u003ctemplate_id\u003e`.", + "description": "Workspace template ref.", "optional": true }, { - "name": "template_type", - "type": "TypeString", - "description": "The Terraform version that you want to use to run your Terraform code. Enter `terraform_v0.12` to use Terraform version 0.12, and `terraform_v0.11` to use Terraform version 0.11. The Terraform config files are run with Terraform version 0.11. This is a required variable. Make sure that your Terraform config files are compatible with the Terraform version that you select.", - "required": true, - "matches": "^terraform_v(?:0\\.11|0\\.12|0\\.13|0\\.14|0\\.15|1\\.0|1\\.1|1\\.2|1\\.3|1\\.4)(?:\\.\\d+)?$" - }, - { - "name": "status_msg", + "name": "template_git_release", "type": "TypeString", - "description": "The success or error message that was returned for the last plan, apply, or destroy job that ran against your workspace.", - "computed": true + "description": "The repository release.", + "optional": true }, { "name": "template_git_has_uploadedgitrepotar", @@ -137202,25 +143428,6 @@ "optional": true, "computed": true }, - { - "name": "frozen_at", - "type": "TypeString", - "description": "The timestamp when the workspace was frozen.", - "optional": true - }, - { - "name": "locked_time", - "type": "TypeString", - "description": "The timestamp when the workspace was locked.", - "optional": true, - "computed": true - }, - { - "name": "x_github_token", - "type": "TypeString", - "description": "The personal access token to authenticate with your private GitHub or GitLab repository and access your Terraform template.", - "optional": true - }, { "name": "runtime_data", "type": "TypeList", @@ -137284,67 +143491,10 @@ } }, { - "name": "catalog_ref", - "type": "TypeList", - "description": "Information about the software template that you chose from the IBM Cloud catalog. This information is returned for IBM Cloud catalog offerings only.", - "optional": true, - "elem": { - "dry_run": { - "name": "dry_run", - "type": "TypeBool", - "description": "Dry run.", - "optional": true - }, - "item_icon_url": { - "name": "item_icon_url", - "type": "TypeString", - "description": "The URL to the icon of the software template in the IBM Cloud catalog.", - "optional": true - }, - "item_id": { - "name": "item_id", - "type": "TypeString", - "description": "The ID of the software template that you chose to install from the IBM Cloud catalog. This software is provisioned with Schematics.", - "optional": true - }, - "item_name": { - "name": "item_name", - "type": "TypeString", - "description": "The name of the software that you chose to install from the IBM Cloud catalog.", - "optional": true - }, - "item_readme_url": { - "name": "item_readme_url", - "type": "TypeString", - "description": "The URL to the readme file of the software template in the IBM Cloud catalog.", - "optional": true - }, - "item_url": { - "name": "item_url", - "type": "TypeString", - "description": "The URL to the software template in the IBM Cloud catalog.", - "optional": true - }, - "launch_url": { - "name": "launch_url", - "type": "TypeString", - "description": "The URL to the dashboard to access your software.", - "optional": true - }, - "offering_version": { - "name": "offering_version", - "type": "TypeString", - "description": "The version of the software template that you chose to install from the IBM Cloud catalog.", - "optional": true - }, - "owning_account": { - "name": "owning_account", - "type": "TypeString", - "description": "Owning account ID of the catalog.", - "optional": true - } - }, - "max_items": 1 + "name": "updated_at", + "type": "TypeString", + "description": "The timestamp when the workspace was last updated.", + "computed": true }, { "name": "template_inputs", @@ -137391,168 +143541,49 @@ } }, { - "name": "template_git_release", + "name": "template_git_repo_url", "type": "TypeString", - "description": "The repository release.", + "description": "The repository URL.", "optional": true }, { - "name": "crn", - "type": "TypeString", - "description": "The workspace CRN.", - "cloud_data_type": "crn", - "computed": true - }, - { - "name": "frozen_by", - "type": "TypeString", - "description": "The user ID that froze the workspace.", + "name": "frozen", + "type": "TypeBool", + "description": "If set to true, the workspace is frozen and changes to the workspace are disabled.", "optional": true }, { - "name": "created_at", - "type": "TypeString", - "description": "The timestamp when the workspace was created.", - "computed": true - }, - { - "name": "updated_at", - "type": "TypeString", - "description": "The timestamp when the workspace was last updated.", - "computed": true - }, - { - "name": "applied_shareddata_ids", - "type": "TypeList", - "description": "List of applied shared dataset ID.", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "location", + "name": "locked_time", "type": "TypeString", - "description": "The location where you want to create your Schematics workspace and run the Schematics jobs. The location that you enter must match the API endpoint that you use. For example, if you use the Frankfurt API endpoint, you must specify `eu-de` as your location. If you use an API endpoint for a geography and you do not specify a location, Schematics determines the location based on availability.", - "cloud_data_type": "region", + "description": "The timestamp when the workspace was locked.", "optional": true, "computed": true }, { - "name": "name", - "type": "TypeString", - "description": "The name of your workspace. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores. When you create a workspace for your own Terraform template, consider including the microservice component that you set up with your Terraform template and the IBM Cloud environment where you want to deploy your resources in your name.", - "required": true, - "min_length": 1, - "max_length": 128, - "matches": "^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$" - }, - { - "name": "shared_data", - "type": "TypeList", - "description": "Information about the Target used by the templates originating from the IBM Cloud catalog offerings. This information is not relevant for workspace created using your own Terraform template.", - "optional": true, - "elem": { - "cluster_created_on": { - "name": "cluster_created_on", - "type": "TypeString", - "description": "Cluster created on.", - "optional": true - }, - "cluster_id": { - "name": "cluster_id", - "type": "TypeString", - "description": "The ID of the cluster where you want to provision the resources of all IBM Cloud catalog templates that are included in the catalog offering.", - "optional": true - }, - "cluster_name": { - "name": "cluster_name", - "type": "TypeString", - "description": "The cluster name.", - "optional": true - }, - "cluster_type": { - "name": "cluster_type", - "type": "TypeString", - "description": "The cluster type.", - "optional": true - }, - "entitlement_keys": { - "name": "entitlement_keys", - "type": "TypeList", - "description": "The entitlement key that you want to use to install IBM Cloud entitled software.", - "optional": true, - "elem": { - "type": "TypeMap" - } - }, - "namespace": { - "name": "namespace", - "type": "TypeString", - "description": "The Kubernetes namespace or OpenShift project where the resources of all IBM Cloud catalog templates that are included in the catalog offering are deployed into.", - "optional": true - }, - "region": { - "name": "region", - "type": "TypeString", - "description": "The IBM Cloud region that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.", - "optional": true - }, - "resource_group_id": { - "name": "resource_group_id", - "type": "TypeString", - "description": "The ID of the resource group that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.", - "optional": true - }, - "worker_count": { - "name": "worker_count", - "type": "TypeInt", - "description": "The cluster worker count.", - "optional": true - }, - "worker_machine_type": { - "name": "worker_machine_type", - "type": "TypeString", - "description": "The cluster worker type.", - "optional": true - } - }, - "max_items": 1 - }, - { - "name": "tags", - "type": "TypeList", - "description": "A list of tags that are associated with the workspace.", - "cloud_data_type": "tags", - "optional": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "updated_by", + "name": "last_health_check_at", "type": "TypeString", - "description": "The user ID that updated the workspace.", + "description": "The timestamp when the last health check was performed by Schematics.", "computed": true }, { - "name": "template_git_repo_url", + "name": "resource_group", "type": "TypeString", - "description": "The repository URL.", + "description": "The ID of the resource group where you want to provision the workspace.", + "cloud_data_type": "resource_group", "optional": true }, { - "name": "template_git_url", + "name": "template_type", "type": "TypeString", - "description": "The source URL.", - "optional": true + "description": "The Terraform version that you want to use to run your Terraform code. Enter `terraform_v0.12` to use Terraform version 0.12, and `terraform_v0.11` to use Terraform version 0.11. The Terraform config files are run with Terraform version 0.11. This is a required variable. Make sure that your Terraform config files are compatible with the Terraform version that you select.", + "required": true, + "matches": "^terraform_v(?:0\\.11|0\\.12|0\\.13|0\\.14|0\\.15|1\\.0|1\\.1|1\\.2|1\\.3|1\\.4)(?:\\.\\d+)?$" }, { - "name": "locked_by", + "name": "template_values", "type": "TypeString", - "description": "The user ID that initiated a resource-related action, such as applying or destroying resources, that locked the workspace.", - "optional": true, - "computed": true + "description": "A list of variable values that you want to apply during the Helm chart installation. The list must be provided in JSON format, such as `\"autoscaling: enabled: true minReplicas: 2\"`. The values that you define here override the default Helm chart values. This field is supported only for IBM Cloud catalog offerings that are provisioned by using the Terraform Helm provider.", + "optional": true } ], "ibm_security_group": [ @@ -137570,36 +143601,6 @@ } ], "ibm_security_group_rule": [ - { - "name": "port_range_min", - "type": "TypeInt", - "description": "Port number minimum range", - "optional": true - }, - { - "name": "port_range_max", - "type": "TypeInt", - "description": "Port number max range", - "optional": true - }, - { - "name": "remote_group_id", - "type": "TypeInt", - "description": "remote group ID", - "optional": true - }, - { - "name": "remote_ip", - "type": "TypeString", - "description": "Remote IP Address", - "optional": true - }, - { - "name": "protocol", - "type": "TypeString", - "description": "icmp, tcp or udp", - "optional": true - }, { "name": "security_group_id", "type": "TypeInt", @@ -137619,23 +143620,39 @@ "description": "IP version IPv4 or IPv6", "default_value": "IPv4", "optional": true - } - ], - "ibm_service_instance": [ + }, + { + "name": "port_range_min", + "type": "TypeInt", + "description": "Port number minimum range", + "optional": true + }, + { + "name": "port_range_max", + "type": "TypeInt", + "description": "Port number max range", + "optional": true + }, + { + "name": "remote_group_id", + "type": "TypeInt", + "description": "remote group ID", + "optional": true + }, { - "name": "space_guid", + "name": "remote_ip", "type": "TypeString", - "description": "The guid of the space in which the instance will be created", - "immutable": true, - "required": true + "description": "Remote IP Address", + "optional": true }, { - "name": "service", + "name": "protocol", "type": "TypeString", - "description": "The name of the service offering like speech_to_text, text_to_speech etc", - "immutable": true, - "required": true - }, + "description": "icmp, tcp or udp", + "optional": true + } + ], + "ibm_service_instance": [ { "name": "credentials", "type": "TypeMap", @@ -137677,10 +143694,11 @@ "optional": true }, { - "name": "plan", - "type": "TypeString", - "description": "The plan type of the service", - "required": true + "name": "wait_time_minutes", + "type": "TypeInt", + "description": "Define timeout to wait for the service instances to succeeded/deleted etc.", + "default_value": 10, + "optional": true }, { "name": "name", @@ -137689,17 +143707,24 @@ "required": true }, { - "name": "wait_time_minutes", - "type": "TypeInt", - "description": "Define timeout to wait for the service instances to succeeded/deleted etc.", - "default_value": 10, - "optional": true + "name": "space_guid", + "type": "TypeString", + "description": "The guid of the space in which the instance will be created", + "immutable": true, + "required": true }, { - "name": "dashboard_url", + "name": "service", "type": "TypeString", - "description": "Dashboard URL to access resource.", - "computed": true + "description": "The name of the service offering like speech_to_text, text_to_speech etc", + "immutable": true, + "required": true + }, + { + "name": "plan", + "type": "TypeString", + "description": "The plan type of the service", + "required": true }, { "name": "tags", @@ -137709,6 +143734,12 @@ "elem": { "type": "TypeString" } + }, + { + "name": "dashboard_url", + "type": "TypeString", + "description": "Dashboard URL to access resource.", + "computed": true } ], "ibm_service_key": [ @@ -137752,27 +143783,73 @@ ], "ibm_sm_arbitrary_secret": [ { - "name": "secret_type", + "name": "payload", "type": "TypeString", - "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", + "description": "The arbitrary secret data payload.", + "secure": true, + "required": true + }, + { + "name": "crn", + "type": "TypeString", + "description": "A CRN that uniquely identifies an IBM Cloud resource.", + "cloud_data_type": "crn", "computed": true }, { - "name": "version_custom_metadata", - "type": "TypeMap", - "description": "The secret version metadata that a user can customize.", + "name": "locks_total", + "type": "TypeInt", + "description": "The number of locks of the secret.", + "computed": true + }, + { + "name": "description", + "type": "TypeString", + "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", + "optional": true + }, + { + "name": "labels", + "type": "TypeList", + "description": "Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.", "optional": true, "computed": true, "elem": { "type": "TypeString" } }, + { + "name": "downloaded", + "type": "TypeBool", + "description": "Indicates whether the secret data that is associated with a secret version was retrieved.", + "computed": true + }, + { + "name": "secret_group_id", + "type": "TypeString", + "description": "A v4 UUID identifier, or `default` secret group.", + "immutable": true, + "optional": true, + "computed": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "The date that a resource was created. The date format follows RFC 3339.", + "computed": true + }, { "name": "updated_at", "type": "TypeString", "description": "The date that a resource was recently modified. The date format follows RFC 3339.", "computed": true }, + { + "name": "versions_total", + "type": "TypeInt", + "description": "The number of versions of the secret.", + "computed": true + }, { "name": "instance_id", "type": "TypeString", @@ -137782,30 +143859,34 @@ "required": true }, { - "name": "expiration_date", + "name": "secret_type", "type": "TypeString", - "description": "The date a secret is expired. The date format follows RFC 3339.", - "optional": true + "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", + "computed": true }, { - "name": "secret_group_id", - "type": "TypeString", - "description": "A v4 UUID identifier, or `default` secret group.", - "immutable": true, + "name": "custom_metadata", + "type": "TypeMap", + "description": "The secret metadata that a user can customize.", "optional": true, - "computed": true + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "created_by", + "name": "expiration_date", "type": "TypeString", - "description": "The unique identifier that is associated with the entity that created the secret.", - "computed": true + "description": "The date a secret is expired. The date format follows RFC 3339.", + "optional": true }, { - "name": "crn", + "name": "region", "type": "TypeString", - "description": "A CRN that uniquely identifies an IBM Cloud resource.", - "cloud_data_type": "crn", + "description": "The region of the Secrets Manager instance.", + "cloud_data_type": "region", + "immutable": true, + "optional": true, "computed": true }, { @@ -137821,12 +143902,9 @@ "computed": true }, { - "name": "region", + "name": "state_description", "type": "TypeString", - "description": "The region of the Secrets Manager instance.", - "cloud_data_type": "region", - "immutable": true, - "optional": true, + "description": "A text representation of the secret state.", "computed": true }, { @@ -137842,16 +143920,9 @@ "required": true }, { - "name": "payload", - "type": "TypeString", - "description": "The arbitrary secret data payload.", - "secure": true, - "required": true - }, - { - "name": "custom_metadata", + "name": "version_custom_metadata", "type": "TypeMap", - "description": "The secret metadata that a user can customize.", + "description": "The secret version metadata that a user can customize.", "optional": true, "computed": true, "elem": { @@ -137859,53 +143930,36 @@ } }, { - "name": "description", - "type": "TypeString", - "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", - "optional": true - }, - { - "name": "created_at", + "name": "created_by", "type": "TypeString", - "description": "The date that a resource was created. The date format follows RFC 3339.", - "computed": true - }, - { - "name": "downloaded", - "type": "TypeBool", - "description": "Indicates whether the secret data that is associated with a secret version was retrieved.", + "description": "The unique identifier that is associated with the entity that created the secret.", "computed": true - }, + } + ], + "ibm_sm_en_registration": [ { - "name": "versions_total", - "type": "TypeInt", - "description": "The number of versions of the secret.", - "computed": true + "name": "instance_id", + "type": "TypeString", + "description": "The ID of the Secrets Manager instance.", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true }, { - "name": "labels", - "type": "TypeList", - "description": "Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.", + "name": "region", + "type": "TypeString", + "description": "The region of the Secrets Manager instance.", + "cloud_data_type": "region", + "immutable": true, "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "locks_total", - "type": "TypeInt", - "description": "The number of locks of the secret.", "computed": true }, { - "name": "state_description", + "name": "endpoint_type", "type": "TypeString", - "description": "A text representation of the secret state.", - "computed": true - } - ], - "ibm_sm_en_registration": [ + "description": "public or private.", + "optional": true + }, { "name": "event_notifications_instance_crn", "type": "TypeString", @@ -137934,59 +143988,9 @@ "max_length": 1024, "matches": "(.*?)", "optional": true - }, - { - "name": "instance_id", - "type": "TypeString", - "description": "The ID of the Secrets Manager instance.", - "cloud_data_type": "resource_instance", - "immutable": true, - "required": true - }, - { - "name": "region", - "type": "TypeString", - "description": "The region of the Secrets Manager instance.", - "cloud_data_type": "region", - "immutable": true, - "optional": true, - "computed": true - }, - { - "name": "endpoint_type", - "type": "TypeString", - "description": "public or private.", - "optional": true } ], "ibm_sm_iam_credentials_configuration": [ - { - "name": "instance_id", - "type": "TypeString", - "description": "The ID of the Secrets Manager instance.", - "cloud_data_type": "resource_instance", - "immutable": true, - "required": true - }, - { - "name": "endpoint_type", - "type": "TypeString", - "description": "public or private.", - "optional": true - }, - { - "name": "api_key", - "type": "TypeString", - "description": "An IBM Cloud API key that can create and manage service IDs. The API key must be assigned the Editor platform role on the Access Groups Service and the Operator platform role on the IAM Identity Service. For more information, see the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-configure-iam-engine).", - "secure": true, - "required": true - }, - { - "name": "secret_type", - "type": "TypeString", - "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", - "computed": true - }, { "name": "created_by", "type": "TypeString", @@ -138005,6 +144009,14 @@ "description": "The date when a resource was recently modified. The date format follows RFC 3339.", "computed": true }, + { + "name": "instance_id", + "type": "TypeString", + "description": "The ID of the Secrets Manager instance.", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true + }, { "name": "region", "type": "TypeString", @@ -138014,6 +144026,12 @@ "optional": true, "computed": true }, + { + "name": "endpoint_type", + "type": "TypeString", + "description": "public or private.", + "optional": true + }, { "name": "name", "type": "TypeString", @@ -138026,33 +144044,28 @@ "type": "TypeString", "description": "The configuration type.", "computed": true - } - ], - "ibm_sm_iam_credentials_secret": [ + }, { - "name": "endpoint_type", + "name": "api_key", "type": "TypeString", - "description": "public or private.", - "optional": true + "description": "An IBM Cloud API key that can create and manage service IDs. The API key must be assigned the Editor platform role on the Access Groups Service and the Operator platform role on the IAM Identity Service. For more information, see the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-configure-iam-engine).", + "secure": true, + "required": true }, { "name": "secret_type", "type": "TypeString", "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", "computed": true - }, + } + ], + "ibm_sm_iam_credentials_secret": [ { "name": "created_at", "type": "TypeString", "description": "The date when a resource was created. The date format follows RFC 3339.", "computed": true }, - { - "name": "locks_total", - "type": "TypeInt", - "description": "The number of locks of the secret.", - "computed": true - }, { "name": "next_rotation_date", "type": "TypeString", @@ -138060,19 +144073,16 @@ "computed": true }, { - "name": "version_custom_metadata", - "type": "TypeMap", - "description": "The secret version metadata that a user can customize.", - "immutable": true, - "optional": true, - "elem": { - "type": "TypeString" - } + "name": "reuse_api_key", + "type": "TypeBool", + "description": "Determines whether to use the same service ID and API key for future read operations on an`iam_credentials` secret. Must be set to `true` for IAM credentials secrets managed with Terraform.", + "default_value": true, + "optional": true }, { - "name": "state_description", + "name": "created_by", "type": "TypeString", - "description": "A text representation of the secret state.", + "description": "The unique identifier that is associated with the entity that created the secret.", "computed": true }, { @@ -138087,16 +144097,6 @@ "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", "optional": true }, - { - "name": "labels", - "type": "TypeList", - "description": "Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } - }, { "name": "rotation", "type": "TypeList", @@ -138142,29 +144142,38 @@ "computed": true }, { - "name": "crn", + "name": "region", "type": "TypeString", - "description": "A CRN that uniquely identifies an IBM Cloud resource.", - "cloud_data_type": "crn", + "description": "The region of the Secrets Manager instance.", + "cloud_data_type": "region", + "immutable": true, + "optional": true, "computed": true }, { - "name": "secret_id", - "type": "TypeString", - "description": "A v4 UUID identifier.", - "computed": true + "name": "custom_metadata", + "type": "TypeMap", + "description": "The secret metadata that a user can customize.", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "created_by", - "type": "TypeString", - "description": "The unique identifier that is associated with the entity that created the secret.", - "computed": true + "name": "version_custom_metadata", + "type": "TypeMap", + "description": "The secret version metadata that a user can customize.", + "immutable": true, + "optional": true, + "elem": { + "type": "TypeString" + } }, { - "name": "api_key", - "type": "TypeString", - "description": "The API key that is generated for this secret.After the secret reaches the end of its lease (see the `ttl` field), the API key is deleted automatically.", - "secure": true, + "name": "downloaded", + "type": "TypeBool", + "description": "Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", "computed": true }, { @@ -138176,28 +144185,9 @@ "required": true }, { - "name": "service_id_is_static", - "type": "TypeBool", - "description": "Indicates whether an `iam_credentials` secret was created with a static service ID.If it is set to `true`, the service ID for the secret was provided by the user at secret creation. If it is set to `false`, the service ID was generated by Secrets Manager.", - "computed": true - }, - { - "name": "name", + "name": "secret_id", "type": "TypeString", - "description": "A human-readable name to assign to your secret.To protect your privacy, do not use personal data, such as your name or location, as a name for your secret.", - "required": true - }, - { - "name": "reuse_api_key", - "type": "TypeBool", - "description": "Determines whether to use the same service ID and API key for future read operations on an`iam_credentials` secret. Must be set to `true` for IAM credentials secrets managed with Terraform.", - "default_value": true, - "optional": true - }, - { - "name": "downloaded", - "type": "TypeBool", - "description": "Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", + "description": "A v4 UUID identifier.", "computed": true }, { @@ -138207,28 +144197,17 @@ "computed": true }, { - "name": "custom_metadata", - "type": "TypeMap", - "description": "The secret metadata that a user can customize.", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "secret_group_id", + "name": "api_key", "type": "TypeString", - "description": "A v4 UUID identifier, or `default` secret group.", - "immutable": true, - "optional": true, + "description": "The API key that is generated for this secret.After the secret reaches the end of its lease (see the `ttl` field), the API key is deleted automatically.", + "secure": true, "computed": true }, { - "name": "ttl", + "name": "secret_type", "type": "TypeString", - "description": "The time-to-live (TTL) or lease duration to assign to generated credentials.For `iam_credentials` secrets, the TTL defines for how long each generated API key remains valid. The value is an integer that specifies the number of seconds .Minimum duration is 1 minute. Maximum is 90 days.", - "required": true + "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", + "computed": true }, { "name": "access_groups", @@ -138249,49 +144228,35 @@ "computed": true }, { - "name": "updated_at", + "name": "crn", "type": "TypeString", - "description": "The date when a resource was recently modified. The date format follows RFC 3339.", + "description": "A CRN that uniquely identifies an IBM Cloud resource.", + "cloud_data_type": "crn", "computed": true }, { - "name": "region", - "type": "TypeString", - "description": "The region of the Secrets Manager instance.", - "cloud_data_type": "region", - "immutable": true, - "optional": true, - "computed": true - } - ], - "ibm_sm_imported_certificate": [ - { - "name": "key_algorithm", - "type": "TypeString", - "description": "The identifier for the cryptographic algorithm to be used to generate the public key that is associated with the certificate.The algorithm that you select determines the encryption algorithm (`RSA` or `ECDSA`) and key size to be used to generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to provide more encryption protection. Allowed values: RSA2048, RSA4096, EC256, EC384.", + "name": "locks_total", + "type": "TypeInt", + "description": "The number of locks of the secret.", "computed": true }, { - "name": "versions_total", - "type": "TypeInt", - "description": "The number of versions of the secret.", + "name": "updated_at", + "type": "TypeString", + "description": "The date when a resource was recently modified. The date format follows RFC 3339.", "computed": true }, { - "name": "downloaded", + "name": "service_id_is_static", "type": "TypeBool", - "description": "Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", + "description": "Indicates whether an `iam_credentials` secret was created with a static service ID.If it is set to `true`, the service ID for the secret was provided by the user at secret creation. If it is set to `false`, the service ID was generated by Secrets Manager.", "computed": true }, { - "name": "labels", - "type": "TypeList", - "description": "Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "endpoint_type", + "type": "TypeString", + "description": "public or private.", + "optional": true }, { "name": "name", @@ -138300,48 +144265,59 @@ "required": true }, { - "name": "alt_names", - "type": "TypeList", - "description": "With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.", - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "ttl", + "type": "TypeString", + "description": "The time-to-live (TTL) or lease duration to assign to generated credentials.For `iam_credentials` secrets, the TTL defines for how long each generated API key remains valid. The value is an integer that specifies the number of seconds .Minimum duration is 1 minute. Maximum is 90 days.", + "required": true }, { - "name": "state", - "type": "TypeInt", - "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", + "name": "state_description", + "type": "TypeString", + "description": "A text representation of the secret state.", "computed": true }, { - "name": "signing_algorithm", + "name": "secret_group_id", "type": "TypeString", - "description": "The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.", + "description": "A v4 UUID identifier, or `default` secret group.", + "immutable": true, + "optional": true, "computed": true }, { - "name": "endpoint_type", + "name": "labels", + "type": "TypeList", + "description": "Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + } + ], + "ibm_sm_imported_certificate": [ + { + "name": "common_name", "type": "TypeString", - "description": "public or private.", - "optional": true + "description": "The Common Name (AKA CN) represents the server name that is protected by the SSL certificate.", + "computed": true }, { - "name": "issuer", + "name": "created_by", "type": "TypeString", - "description": "The distinguished name that identifies the entity that signed and issued the certificate.", + "description": "The unique identifier that is associated with the entity that created the secret.", "computed": true }, { - "name": "expiration_date", + "name": "endpoint_type", "type": "TypeString", - "description": "The date a secret is expired. The date format follows RFC 3339.", - "computed": true + "description": "public or private.", + "optional": true }, { - "name": "version_custom_metadata", + "name": "custom_metadata", "type": "TypeMap", - "description": "The secret version metadata that a user can customize.", + "description": "The secret metadata that a user can customize.", "optional": true, "computed": true, "elem": { @@ -138349,11 +144325,10 @@ } }, { - "name": "certificate", + "name": "description", "type": "TypeString", - "description": "The PEM-encoded contents of your certificate.", - "secure": true, - "required": true + "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", + "optional": true }, { "name": "intermediate", @@ -138363,75 +144338,70 @@ "optional": true }, { - "name": "created_by", + "name": "private_key", "type": "TypeString", - "description": "The unique identifier that is associated with the entity that created the secret.", - "computed": true - }, - { - "name": "locks_total", - "type": "TypeInt", - "description": "The number of locks of the secret.", - "computed": true + "description": "(Optional) The PEM-encoded private key to associate with the certificate.", + "secure": true, + "optional": true }, { - "name": "secret_group_id", + "name": "created_at", "type": "TypeString", - "description": "A v4 UUID identifier, or `default` secret group.", - "immutable": true, - "optional": true, + "description": "The date when a resource was created. The date format follows RFC 3339.", "computed": true }, { - "name": "created_at", + "name": "crn", "type": "TypeString", - "description": "The date when a resource was created. The date format follows RFC 3339.", + "description": "A CRN that uniquely identifies an IBM Cloud resource.", + "cloud_data_type": "crn", "computed": true }, { - "name": "state_description", - "type": "TypeString", - "description": "A text representation of the secret state.", + "name": "downloaded", + "type": "TypeBool", + "description": "Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", "computed": true }, { - "name": "updated_at", - "type": "TypeString", - "description": "The date when a resource was recently modified. The date format follows RFC 3339.", + "name": "state", + "type": "TypeInt", + "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", "computed": true }, { - "name": "region", + "name": "expiration_date", "type": "TypeString", - "description": "The region of the Secrets Manager instance.", - "cloud_data_type": "region", - "immutable": true, - "optional": true, + "description": "The date a secret is expired. The date format follows RFC 3339.", "computed": true }, { - "name": "description", - "type": "TypeString", - "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", - "optional": true + "name": "version_custom_metadata", + "type": "TypeMap", + "description": "The secret version metadata that a user can customize.", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "private_key", + "name": "certificate", "type": "TypeString", - "description": "(Optional) The PEM-encoded private key to associate with the certificate.", + "description": "The PEM-encoded contents of your certificate.", "secure": true, - "optional": true + "required": true }, { - "name": "common_name", - "type": "TypeString", - "description": "The Common Name (AKA CN) represents the server name that is protected by the SSL certificate.", + "name": "versions_total", + "type": "TypeInt", + "description": "The number of versions of the secret.", "computed": true }, { - "name": "serial_number", - "type": "TypeString", - "description": "The unique serial number that was assigned to a certificate by the issuing certificate authority.", + "name": "intermediate_included", + "type": "TypeBool", + "description": "Indicates whether the certificate was imported with an associated intermediate certificate.", "computed": true }, { @@ -138455,19 +144425,21 @@ } }, { - "name": "custom_metadata", - "type": "TypeMap", - "description": "The secret metadata that a user can customize.", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "key_algorithm", + "type": "TypeString", + "description": "The identifier for the cryptographic algorithm to be used to generate the public key that is associated with the certificate.The algorithm that you select determines the encryption algorithm (`RSA` or `ECDSA`) and key size to be used to generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to provide more encryption protection. Allowed values: RSA2048, RSA4096, EC256, EC384.", + "computed": true }, { - "name": "secret_id", + "name": "state_description", "type": "TypeString", - "description": "A v4 UUID identifier.", + "description": "A text representation of the secret state.", + "computed": true + }, + { + "name": "issuer", + "type": "TypeString", + "description": "The distinguished name that identifies the entity that signed and issued the certificate.", "computed": true }, { @@ -138476,6 +144448,16 @@ "description": "Indicates whether the certificate was imported with an associated private key.", "computed": true }, + { + "name": "labels", + "type": "TypeList", + "description": "Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, { "name": "secret_type", "type": "TypeString", @@ -138483,28 +144465,31 @@ "computed": true }, { - "name": "crn", + "name": "signing_algorithm", "type": "TypeString", - "description": "A CRN that uniquely identifies an IBM Cloud resource.", - "cloud_data_type": "crn", + "description": "The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.", "computed": true }, { - "name": "intermediate_included", - "type": "TypeBool", - "description": "Indicates whether the certificate was imported with an associated intermediate certificate.", + "name": "secret_id", + "type": "TypeString", + "description": "A v4 UUID identifier.", "computed": true }, { - "name": "instance_id", + "name": "name", "type": "TypeString", - "description": "The ID of the Secrets Manager instance.", - "cloud_data_type": "resource_instance", - "immutable": true, + "description": "A human-readable name to assign to your secret.To protect your privacy, do not use personal data, such as your name or location, as a name for your secret.", "required": true - } - ], - "ibm_sm_kv_secret": [ + }, + { + "name": "secret_group_id", + "type": "TypeString", + "description": "A v4 UUID identifier, or `default` secret group.", + "immutable": true, + "optional": true, + "computed": true + }, { "name": "region", "type": "TypeString", @@ -138515,46 +144500,52 @@ "computed": true }, { - "name": "name", - "type": "TypeString", - "description": "A human-readable name to assign to your secret.To protect your privacy, do not use personal data, such as your name or location, as a name for your secret.", - "required": true + "name": "locks_total", + "type": "TypeInt", + "description": "The number of locks of the secret.", + "computed": true }, { - "name": "secret_group_id", + "name": "updated_at", "type": "TypeString", - "description": "A v4 UUID identifier, or `default` secret group.", - "immutable": true, - "optional": true, + "description": "The date when a resource was recently modified. The date format follows RFC 3339.", "computed": true }, { - "name": "data", - "type": "TypeMap", - "description": "The payload data of a key-value secret.", - "secure": true, - "required": true, + "name": "alt_names", + "type": "TypeList", + "description": "With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.", + "computed": true, "elem": { "type": "TypeString" } }, { - "name": "crn", + "name": "serial_number", "type": "TypeString", - "description": "A CRN that uniquely identifies an IBM Cloud resource.", - "cloud_data_type": "crn", + "description": "The unique serial number that was assigned to a certificate by the issuing certificate authority.", "computed": true }, { - "name": "locks_total", - "type": "TypeInt", - "description": "The number of locks of the secret.", + "name": "instance_id", + "type": "TypeString", + "description": "The ID of the Secrets Manager instance.", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true + } + ], + "ibm_sm_kv_secret": [ + { + "name": "downloaded", + "type": "TypeBool", + "description": "Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", "computed": true }, { - "name": "state_description", - "type": "TypeString", - "description": "A text representation of the secret state.", + "name": "state", + "type": "TypeInt", + "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", "computed": true }, { @@ -138563,12 +144554,46 @@ "description": "The number of versions of the secret.", "computed": true }, + { + "name": "name", + "type": "TypeString", + "description": "A human-readable name to assign to your secret.To protect your privacy, do not use personal data, such as your name or location, as a name for your secret.", + "required": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "The date when a resource was created. The date format follows RFC 3339.", + "computed": true + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "The date when a resource was recently modified. The date format follows RFC 3339.", + "computed": true + }, { "name": "secret_id", "type": "TypeString", "description": "A v4 UUID identifier.", "computed": true }, + { + "name": "endpoint_type", + "type": "TypeString", + "description": "public or private.", + "optional": true + }, + { + "name": "custom_metadata", + "type": "TypeMap", + "description": "The secret metadata that a user can customize.", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, { "name": "description", "type": "TypeString", @@ -138576,9 +144601,27 @@ "optional": true }, { - "name": "labels", - "type": "TypeList", - "description": "Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.", + "name": "secret_group_id", + "type": "TypeString", + "description": "A v4 UUID identifier, or `default` secret group.", + "immutable": true, + "optional": true, + "computed": true + }, + { + "name": "data", + "type": "TypeMap", + "description": "The payload data of a key-value secret.", + "secure": true, + "required": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "version_custom_metadata", + "type": "TypeMap", + "description": "The secret version metadata that a user can customize.", "optional": true, "computed": true, "elem": { @@ -138592,51 +144635,63 @@ "computed": true }, { - "name": "created_at", + "name": "crn", "type": "TypeString", - "description": "The date when a resource was created. The date format follows RFC 3339.", + "description": "A CRN that uniquely identifies an IBM Cloud resource.", + "cloud_data_type": "crn", "computed": true }, { - "name": "state", - "type": "TypeInt", - "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", + "name": "state_description", + "type": "TypeString", + "description": "A text representation of the secret state.", "computed": true }, { - "name": "instance_id", + "name": "secret_type", "type": "TypeString", - "description": "The ID of the Secrets Manager instance.", - "cloud_data_type": "resource_instance", - "immutable": true, - "required": true + "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", + "computed": true }, { - "name": "endpoint_type", + "name": "region", "type": "TypeString", - "description": "public or private.", - "optional": true + "description": "The region of the Secrets Manager instance.", + "cloud_data_type": "region", + "immutable": true, + "optional": true, + "computed": true }, { - "name": "secret_type", - "type": "TypeString", - "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", + "name": "locks_total", + "type": "TypeInt", + "description": "The number of locks of the secret.", "computed": true }, { - "name": "custom_metadata", - "type": "TypeMap", - "description": "The secret metadata that a user can customize.", + "name": "instance_id", + "type": "TypeString", + "description": "The ID of the Secrets Manager instance.", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true + }, + { + "name": "labels", + "type": "TypeList", + "description": "Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.", "optional": true, "computed": true, "elem": { "type": "TypeString" } - }, + } + ], + "ibm_sm_private_certificate": [ { - "name": "version_custom_metadata", - "type": "TypeMap", - "description": "The secret version metadata that a user can customize.", + "name": "labels", + "type": "TypeList", + "description": "Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.", "optional": true, "computed": true, "elem": { @@ -138644,30 +144699,22 @@ } }, { - "name": "downloaded", - "type": "TypeBool", - "description": "Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", - "computed": true + "name": "uri_sans", + "type": "TypeString", + "description": "The URI Subject Alternative Names to define for the CA certificate, in a comma-delimited list.", + "immutable": true, + "optional": true }, { - "name": "updated_at", - "type": "TypeString", - "description": "The date when a resource was recently modified. The date format follows RFC 3339.", + "name": "locks_total", + "type": "TypeInt", + "description": "The number of locks of the secret.", "computed": true - } - ], - "ibm_sm_private_certificate": [ - { - "name": "private_key_format", - "type": "TypeString", - "description": "The format of the generated private key.", - "default_value": "der", - "optional": true }, { - "name": "state", + "name": "versions_total", "type": "TypeInt", - "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", + "description": "The number of versions of the secret.", "computed": true }, { @@ -138691,23 +144738,43 @@ } }, { - "name": "revocation_time_rfc3339", + "name": "version_custom_metadata", + "type": "TypeMap", + "description": "The secret version metadata that a user can customize.", + "immutable": true, + "optional": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "signing_algorithm", "type": "TypeString", - "description": "The date and time that the certificate was revoked. The date format follows RFC 3339.", + "description": "The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.", "computed": true }, { - "name": "secret_type", + "name": "next_rotation_date", "type": "TypeString", - "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", + "description": "The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.", "computed": true }, { - "name": "ip_sans", + "name": "ca_chain", + "type": "TypeList", + "description": "The chain of certificate authorities that are associated with the certificate.", + "secure": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "crn", "type": "TypeString", - "description": "The IP Subject Alternative Names to define for the CA certificate, in a comma-delimited list.", - "immutable": true, - "optional": true + "description": "A CRN that uniquely identifies an IBM Cloud resource.", + "cloud_data_type": "crn", + "computed": true }, { "name": "secret_id", @@ -138716,41 +144783,37 @@ "computed": true }, { - "name": "state_description", + "name": "updated_at", "type": "TypeString", - "description": "A text representation of the secret state.", + "description": "The date when a resource was recently modified. The date format follows RFC 3339.", "computed": true }, { - "name": "certificate_authority", + "name": "expiration_date", "type": "TypeString", - "description": "The intermediate certificate authority that signed this certificate.", + "description": "The date a secret is expired. The date format follows RFC 3339.", "computed": true }, { - "name": "name", + "name": "secret_group_id", "type": "TypeString", - "description": "A human-readable name to assign to your secret.To protect your privacy, do not use personal data, such as your name or location, as a name for your secret.", - "required": true - }, - { - "name": "exclude_cn_from_sans", - "type": "TypeBool", - "description": "Controls whether the common name is excluded from Subject Alternative Names (SANs).If the common name set to `true`, it is not included in DNS or Email SANs if they apply. This field can be useful if the common name is a human-readable identifier, instead of a hostname or an email address.", + "description": "A v4 UUID identifier, or `default` secret group.", "immutable": true, - "optional": true + "optional": true, + "computed": true }, { - "name": "ttl", + "name": "certificate_template", "type": "TypeString", - "description": "The time-to-live (TTL) or lease duration to assign to generated credentials.For `iam_credentials` secrets, the TTL defines for how long each generated API key remains valid. The value can be either an integer that specifies the number of seconds, or the string representation of a duration, such as `120m` or `24h`.Minimum duration is 1 minute. Maximum is 90 days.", + "description": "The name of the certificate template.", "immutable": true, - "optional": true + "required": true }, { - "name": "labels", + "name": "alt_names", "type": "TypeList", - "description": "Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.", + "description": "With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.", + "immutable": true, "optional": true, "computed": true, "elem": { @@ -138758,32 +144821,19 @@ } }, { - "name": "csr", - "type": "TypeString", - "description": "The certificate signing request.", - "immutable": true, - "optional": true - }, - { - "name": "next_rotation_date", - "type": "TypeString", - "description": "The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.", - "computed": true - }, - { - "name": "ca_chain", - "type": "TypeList", - "description": "The chain of certificate authorities that are associated with the certificate.", - "secure": true, + "name": "custom_metadata", + "type": "TypeMap", + "description": "The secret metadata that a user can customize.", + "optional": true, "computed": true, "elem": { "type": "TypeString" } }, { - "name": "expiration_date", + "name": "issuer", "type": "TypeString", - "description": "The date a secret is expired. The date format follows RFC 3339.", + "description": "The distinguished name that identifies the entity that signed and issued the certificate.", "computed": true }, { @@ -138795,108 +144845,98 @@ "optional": true }, { - "name": "certificate", - "type": "TypeString", - "description": "The PEM-encoded contents of your certificate.", - "secure": true, - "computed": true - }, - { - "name": "certificate_template", + "name": "instance_id", "type": "TypeString", - "description": "The name of the certificate template.", + "description": "The ID of the Secrets Manager instance.", + "cloud_data_type": "resource_instance", "immutable": true, "required": true }, { - "name": "common_name", + "name": "region", "type": "TypeString", - "description": "The Common Name (AKA CN) represents the server name that is protected by the SSL certificate.", + "description": "The region of the Secrets Manager instance.", + "cloud_data_type": "region", "immutable": true, - "required": true + "optional": true, + "computed": true }, { - "name": "alt_names", - "type": "TypeList", - "description": "With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.", + "name": "csr", + "type": "TypeString", + "description": "The certificate signing request.", "immutable": true, - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "optional": true }, { - "name": "other_sans", - "type": "TypeList", - "description": "The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the CA certificate.The alternative names must match the values that are specified in the `allowed_other_sans` field in the associated certificate template. The format is the same as OpenSSL: `\u003coid\u003e:\u003ctype\u003e:\u003cvalue\u003e` where the current valid type is `UTF8`.", + "name": "exclude_cn_from_sans", + "type": "TypeBool", + "description": "Controls whether the common name is excluded from Subject Alternative Names (SANs).If the common name set to `true`, it is not included in DNS or Email SANs if they apply. This field can be useful if the common name is a human-readable identifier, instead of a hostname or an email address.", "immutable": true, - "optional": true, - "elem": { - "type": "TypeString" - } + "optional": true }, { - "name": "versions_total", - "type": "TypeInt", - "description": "The number of versions of the secret.", - "computed": true + "name": "ttl", + "type": "TypeString", + "description": "The time-to-live (TTL) or lease duration to assign to generated credentials.For `iam_credentials` secrets, the TTL defines for how long each generated API key remains valid. The value can be either an integer that specifies the number of seconds, or the string representation of a duration, such as `120m` or `24h`.Minimum duration is 1 minute. Maximum is 90 days.", + "immutable": true, + "optional": true }, { - "name": "region", + "name": "created_at", "type": "TypeString", - "description": "The region of the Secrets Manager instance.", - "cloud_data_type": "region", - "immutable": true, - "optional": true, + "description": "The date when a resource was created. The date format follows RFC 3339.", "computed": true }, { - "name": "updated_at", + "name": "name", "type": "TypeString", - "description": "The date when a resource was recently modified. The date format follows RFC 3339.", - "computed": true + "description": "A human-readable name to assign to your secret.To protect your privacy, do not use personal data, such as your name or location, as a name for your secret.", + "required": true }, { - "name": "revocation_time_seconds", - "type": "TypeInt", - "description": "The timestamp of the certificate revocation.", - "computed": true + "name": "common_name", + "type": "TypeString", + "description": "The Common Name (AKA CN) represents the server name that is protected by the SSL certificate.", + "immutable": true, + "required": true }, { - "name": "endpoint_type", + "name": "ip_sans", "type": "TypeString", - "description": "public or private.", + "description": "The IP Subject Alternative Names to define for the CA certificate, in a comma-delimited list.", + "immutable": true, "optional": true }, { - "name": "crn", + "name": "other_sans", + "type": "TypeList", + "description": "The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the CA certificate.The alternative names must match the values that are specified in the `allowed_other_sans` field in the associated certificate template. The format is the same as OpenSSL: `\u003coid\u003e:\u003ctype\u003e:\u003cvalue\u003e` where the current valid type is `UTF8`.", + "immutable": true, + "optional": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "certificate_authority", "type": "TypeString", - "description": "A CRN that uniquely identifies an IBM Cloud resource.", - "cloud_data_type": "crn", + "description": "The intermediate certificate authority that signed this certificate.", "computed": true }, { - "name": "private_key", + "name": "serial_number", "type": "TypeString", - "description": "(Optional) The PEM-encoded private key to associate with the certificate.", - "secure": true, + "description": "The unique serial number that was assigned to a certificate by the issuing certificate authority.", "computed": true }, { - "name": "issuing_ca", + "name": "certificate", "type": "TypeString", - "description": "The PEM-encoded certificate of the certificate authority that signed and issued this certificate.", + "description": "The PEM-encoded contents of your certificate.", "secure": true, "computed": true }, - { - "name": "uri_sans", - "type": "TypeString", - "description": "The URI Subject Alternative Names to define for the CA certificate, in a comma-delimited list.", - "immutable": true, - "optional": true - }, { "name": "format", "type": "TypeString", @@ -138936,99 +144976,82 @@ "max_items": 1 }, { - "name": "version_custom_metadata", - "type": "TypeMap", - "description": "The secret version metadata that a user can customize.", - "immutable": true, - "optional": true, - "elem": { - "type": "TypeString" - } + "name": "issuing_ca", + "type": "TypeString", + "description": "The PEM-encoded certificate of the certificate authority that signed and issued this certificate.", + "secure": true, + "computed": true }, { - "name": "created_by", + "name": "secret_type", "type": "TypeString", - "description": "The unique identifier that is associated with the entity that created the secret.", + "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", "computed": true }, { - "name": "instance_id", - "type": "TypeString", - "description": "The ID of the Secrets Manager instance.", - "cloud_data_type": "resource_instance", - "immutable": true, - "required": true + "name": "downloaded", + "type": "TypeBool", + "description": "Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", + "computed": true }, { - "name": "locks_total", + "name": "state", "type": "TypeInt", - "description": "The number of locks of the secret.", + "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", "computed": true }, { - "name": "signing_algorithm", + "name": "state_description", "type": "TypeString", - "description": "The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.", + "description": "A text representation of the secret state.", "computed": true }, { - "name": "issuer", + "name": "revocation_time_rfc3339", "type": "TypeString", - "description": "The distinguished name that identifies the entity that signed and issued the certificate.", + "description": "The date and time that the certificate was revoked. The date format follows RFC 3339.", "computed": true }, { - "name": "description", + "name": "private_key", "type": "TypeString", - "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", - "optional": true + "description": "(Optional) The PEM-encoded private key to associate with the certificate.", + "secure": true, + "computed": true }, { - "name": "secret_group_id", + "name": "endpoint_type", "type": "TypeString", - "description": "A v4 UUID identifier, or `default` secret group.", - "immutable": true, - "optional": true, - "computed": true + "description": "public or private.", + "optional": true }, { - "name": "custom_metadata", - "type": "TypeMap", - "description": "The secret metadata that a user can customize.", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "description", + "type": "TypeString", + "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", + "optional": true }, { - "name": "created_at", + "name": "private_key_format", "type": "TypeString", - "description": "The date when a resource was created. The date format follows RFC 3339.", - "computed": true + "description": "The format of the generated private key.", + "default_value": "der", + "optional": true }, { - "name": "downloaded", - "type": "TypeBool", - "description": "Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", + "name": "created_by", + "type": "TypeString", + "description": "The unique identifier that is associated with the entity that created the secret.", "computed": true }, { - "name": "serial_number", - "type": "TypeString", - "description": "The unique serial number that was assigned to a certificate by the issuing certificate authority.", + "name": "revocation_time_seconds", + "type": "TypeInt", + "description": "The timestamp of the certificate revocation.", "computed": true } ], "ibm_sm_private_certificate_configuration_action_set_signed": [ - { - "name": "certificate", - "type": "TypeString", - "description": "The PEM-encoded certificate.", - "secure": true, - "immutable": true, - "required": true - }, { "name": "instance_id", "type": "TypeString", @@ -139058,74 +145081,44 @@ "description": "The name that uniquely identifies a configuration", "immutable": true, "required": true + }, + { + "name": "certificate", + "type": "TypeString", + "description": "The PEM-encoded certificate.", + "secure": true, + "immutable": true, + "required": true } ], "ibm_sm_private_certificate_configuration_action_sign_csr": [ { - "name": "name", + "name": "common_name", "type": "TypeString", - "description": "The name that uniquely identifies a configuration", + "description": "The Common Name (AKA CN) represents the server name that is protected by the SSL certificate.", "immutable": true, - "required": true + "optional": true }, { - "name": "format", - "type": "TypeString", - "description": "The format of the returned data.", + "name": "max_path_length", + "type": "TypeInt", + "description": "The maximum path length to encode in the generated certificate. `-1` means no limit.If the signing certificate has a maximum path length set, the path length is set to one less than that of the signing certificate. A limit of `0` means a literal path length of zero.", "immutable": true, "optional": true, "computed": true }, { - "name": "data", - "type": "TypeList", - "description": "The configuration action data.", - "secure": true, - "computed": true, - "elem": { - "ca_chain": { - "name": "ca_chain", - "type": "TypeList", - "description": "The chain of certificate authorities that are associated with the certificate.", - "secure": true, - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "certificate": { - "name": "certificate", - "type": "TypeString", - "description": "The PEM-encoded contents of your certificate.", - "secure": true, - "computed": true - }, - "expiration": { - "name": "expiration", - "type": "TypeInt", - "description": "The certificate expiration time.", - "computed": true - }, - "issuing_ca": { - "name": "issuing_ca", - "type": "TypeString", - "description": "The PEM-encoded certificate of the certificate authority that signed and issued this certificate.", - "secure": true, - "computed": true - } - } - }, - { - "name": "use_csr_values", + "name": "exclude_cn_from_sans", "type": "TypeBool", - "description": "Determines whether to use values from a certificate signing request (CSR) to complete a `private_cert_configuration_action_sign_csr` action.", + "description": "Controls whether the common name is excluded from Subject Alternative Names (SANs).If the common name set to `true`, it is not included in DNS or Email SANs if they apply. This field can be useful if the common name is a human-readable identifier, instead of a hostname or an email address.", + "default_value": false, "immutable": true, "optional": true }, { - "name": "organization", + "name": "street_address", "type": "TypeList", - "description": "The Organization (O) values to define in the subject field of the resulting certificate.", + "description": "The street address values to define in the subject field of the resulting certificate.", "immutable": true, "optional": true, "elem": { @@ -139143,16 +145136,9 @@ } }, { - "name": "ip_sans", - "type": "TypeString", - "description": "The IP Subject Alternative Names to define for the CA certificate, in a comma-delimited list.", - "immutable": true, - "optional": true - }, - { - "name": "other_sans", + "name": "province", "type": "TypeList", - "description": "The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the CA certificate.The alternative names must match the values that are specified in the `allowed_other_sans` field in the associated certificate template. The format is the same as OpenSSL: `\u003coid\u003e:\u003ctype\u003e:\u003cvalue\u003e` where the current valid type is `UTF8`.", + "description": "The Province (ST) values to define in the subject field of the resulting certificate.", "immutable": true, "optional": true, "elem": { @@ -139160,20 +145146,22 @@ } }, { - "name": "ttl", + "name": "serial_number", "type": "TypeString", - "description": "The requested time-to-live (TTL) for certificates that are created by this CA. This field's value cannot be longer than the `max_ttl` limit.The value can be supplied as a string representation of a duration in hours, for example '8760h'. In the API response, this value is returned in seconds (integer).", + "description": "The serial number to assign to the generated certificate. To assign a random serial number, you can omit this field.", "immutable": true, "optional": true, "computed": true }, { - "name": "max_path_length", - "type": "TypeInt", - "description": "The maximum path length to encode in the generated certificate. `-1` means no limit.If the signing certificate has a maximum path length set, the path length is set to one less than that of the signing certificate. A limit of `0` means a literal path length of zero.", + "name": "alt_names", + "type": "TypeList", + "description": "With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.", "immutable": true, "optional": true, - "computed": true + "elem": { + "type": "TypeString" + } }, { "name": "permitted_dns_domains", @@ -139186,9 +145174,16 @@ } }, { - "name": "postal_code", + "name": "use_csr_values", + "type": "TypeBool", + "description": "Determines whether to use values from a certificate signing request (CSR) to complete a `private_cert_configuration_action_sign_csr` action.", + "immutable": true, + "optional": true + }, + { + "name": "ou", "type": "TypeList", - "description": "The postal code values to define in the subject field of the resulting certificate.", + "description": "The Organizational Unit (OU) values to define in the subject field of the resulting certificate.", "immutable": true, "optional": true, "elem": { @@ -139196,20 +145191,64 @@ } }, { - "name": "serial_number", + "name": "endpoint_type", "type": "TypeString", - "description": "The serial number to assign to the generated certificate. To assign a random serial number, you can omit this field.", + "description": "public or private.", + "optional": true + }, + { + "name": "uri_sans", + "type": "TypeString", + "description": "The URI Subject Alternative Names to define for the CA certificate, in a comma-delimited list.", "immutable": true, - "optional": true, - "computed": true + "optional": true }, { - "name": "instance_id", + "name": "ttl", "type": "TypeString", - "description": "The ID of the Secrets Manager instance.", - "cloud_data_type": "resource_instance", + "description": "The requested time-to-live (TTL) for certificates that are created by this CA. This field's value cannot be longer than the `max_ttl` limit.The value can be supplied as a string representation of a duration in hours, for example '8760h'. In the API response, this value is returned in seconds (integer).", "immutable": true, - "required": true + "optional": true, + "computed": true + }, + { + "name": "data", + "type": "TypeList", + "description": "The configuration action data.", + "secure": true, + "computed": true, + "elem": { + "ca_chain": { + "name": "ca_chain", + "type": "TypeList", + "description": "The chain of certificate authorities that are associated with the certificate.", + "secure": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "certificate": { + "name": "certificate", + "type": "TypeString", + "description": "The PEM-encoded contents of your certificate.", + "secure": true, + "computed": true + }, + "expiration": { + "name": "expiration", + "type": "TypeInt", + "description": "The certificate expiration time.", + "computed": true + }, + "issuing_ca": { + "name": "issuing_ca", + "type": "TypeString", + "description": "The PEM-encoded certificate of the certificate authority that signed and issued this certificate.", + "secure": true, + "computed": true + } + } }, { "name": "region", @@ -139221,27 +145260,17 @@ "computed": true }, { - "name": "csr", + "name": "format", "type": "TypeString", - "description": "The certificate signing request.", - "secure": true, - "immutable": true, - "required": true - }, - { - "name": "alt_names", - "type": "TypeList", - "description": "With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.", + "description": "The format of the returned data.", "immutable": true, "optional": true, - "elem": { - "type": "TypeString" - } + "computed": true }, { - "name": "ou", + "name": "organization", "type": "TypeList", - "description": "The Organizational Unit (OU) values to define in the subject field of the resulting certificate.", + "description": "The Organization (O) values to define in the subject field of the resulting certificate.", "immutable": true, "optional": true, "elem": { @@ -139249,9 +145278,9 @@ } }, { - "name": "province", + "name": "locality", "type": "TypeList", - "description": "The Province (ST) values to define in the subject field of the resulting certificate.", + "description": "The Locality (L) values to define in the subject field of the resulting certificate.", "immutable": true, "optional": true, "elem": { @@ -139259,9 +145288,9 @@ } }, { - "name": "street_address", + "name": "postal_code", "type": "TypeList", - "description": "The street address values to define in the subject field of the resulting certificate.", + "description": "The postal code values to define in the subject field of the resulting certificate.", "immutable": true, "optional": true, "elem": { @@ -139269,31 +145298,31 @@ } }, { - "name": "common_name", + "name": "name", "type": "TypeString", - "description": "The Common Name (AKA CN) represents the server name that is protected by the SSL certificate.", + "description": "The name that uniquely identifies a configuration", "immutable": true, - "optional": true + "required": true }, { - "name": "uri_sans", + "name": "csr", "type": "TypeString", - "description": "The URI Subject Alternative Names to define for the CA certificate, in a comma-delimited list.", + "description": "The certificate signing request.", + "secure": true, "immutable": true, - "optional": true + "required": true }, { - "name": "exclude_cn_from_sans", - "type": "TypeBool", - "description": "Controls whether the common name is excluded from Subject Alternative Names (SANs).If the common name set to `true`, it is not included in DNS or Email SANs if they apply. This field can be useful if the common name is a human-readable identifier, instead of a hostname or an email address.", - "default_value": false, + "name": "ip_sans", + "type": "TypeString", + "description": "The IP Subject Alternative Names to define for the CA certificate, in a comma-delimited list.", "immutable": true, "optional": true }, { - "name": "locality", + "name": "other_sans", "type": "TypeList", - "description": "The Locality (L) values to define in the subject field of the resulting certificate.", + "description": "The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the CA certificate.The alternative names must match the values that are specified in the `allowed_other_sans` field in the associated certificate template. The format is the same as OpenSSL: `\u003coid\u003e:\u003ctype\u003e:\u003cvalue\u003e` where the current valid type is `UTF8`.", "immutable": true, "optional": true, "elem": { @@ -139301,41 +145330,32 @@ } }, { - "name": "endpoint_type", + "name": "instance_id", "type": "TypeString", - "description": "public or private.", - "optional": true + "description": "The ID of the Secrets Manager instance.", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true } ], "ibm_sm_private_certificate_configuration_intermediate_ca": [ { - "name": "other_sans", - "type": "TypeList", - "description": "The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the CA certificate.The alternative names must match the values that are specified in the `allowed_other_sans` field in the associated certificate template. The format is the same as OpenSSL: `\u003coid\u003e:\u003ctype\u003e:\u003cvalue\u003e` where the current valid type is `UTF8`.", - "immutable": true, - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "name", + "name": "issuer", "type": "TypeString", - "description": "A human-readable unique name to assign to your configuration.To protect your privacy, do not use personal data, such as your name or location, as an name for your secret.", + "description": "The distinguished name that identifies the entity that signed and issued the certificate.", "immutable": true, - "required": true + "optional": true }, { - "name": "max_ttl", + "name": "ttl", "type": "TypeString", - "description": "The maximum time-to-live (TTL) for certificates that are created by this CA.The value can be supplied as a string representation of a duration in hours, for example '8760h'. In the API response, this value is returned in seconds (integer).Minimum value is one hour (`1h`). Maximum value is 100 years (`876000h`).", - "required": true + "description": "Specifies the requested Time To Live (after which the certificate will be expired). The value can be provided provided as a string duration with time suffix (e.g. '24h') or the number of seconds as string (e.g. '86400').", + "optional": true }, { - "name": "alt_names", + "name": "permitted_dns_domains", "type": "TypeList", - "description": "With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.", + "description": "The allowed DNS domains or subdomains for the certificates that are to be signed and issued by this CA certificate.", "immutable": true, "optional": true, "elem": { @@ -139343,93 +145363,56 @@ } }, { - "name": "country", - "type": "TypeList", - "description": "The Country (C) values to define in the subject field of the resulting certificate.", + "name": "instance_id", + "type": "TypeString", + "description": "The ID of the Secrets Manager instance.", + "cloud_data_type": "resource_instance", "immutable": true, - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "required": true }, { - "name": "locality", - "type": "TypeList", - "description": "The Locality (L) values to define in the subject field of the resulting certificate.", + "name": "region", + "type": "TypeString", + "description": "The region of the Secrets Manager instance.", + "cloud_data_type": "region", "immutable": true, "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "computed": true }, { - "name": "issuer", + "name": "endpoint_type", "type": "TypeString", - "description": "The distinguished name that identifies the entity that signed and issued the certificate.", - "immutable": true, - "optional": true - }, - { - "name": "max_path_length", - "type": "TypeInt", - "description": "The maximum path length to encode in the generated certificate. `-1` means no limit.", - "immutable": true, - "optional": true - }, - { - "name": "use_csr_values", - "type": "TypeBool", - "description": "Determines whether to use values from a certificate signing request (CSR) to complete a `private_cert_configuration_action_sign_csr` action.", - "immutable": true, + "description": "public or private.", "optional": true }, { - "name": "crl_expiry_seconds", - "type": "TypeInt", + "name": "crl_expiry", + "type": "TypeString", "description": "The time until the certificate revocation list (CRL) expires.The value can be supplied as a string representation of a duration in hours, such as `48h`. The default is 72 hours. In the API response, this value is returned in seconds (integer).**Note:** The CRL is rotated automatically before it expires.", + "optional": true, "computed": true }, { - "name": "common_name", - "type": "TypeString", - "description": "The Common Name (AKA CN) represents the server name that is protected by the SSL certificate.", - "immutable": true, - "required": true - }, - { - "name": "exclude_cn_from_sans", + "name": "issuing_certificates_urls_encoded", "type": "TypeBool", - "description": "Controls whether the common name is excluded from Subject Alternative Names (SANs).If the common name set to `true`, it is not included in DNS or Email SANs if they apply. This field can be useful if the common name is a human-readable identifier, instead of a hostname or an email address.", + "description": "Determines whether to encode the URL of the issuing certificate in the certificates that are issued by this certificate authority.", "default_value": false, - "immutable": true, "optional": true }, { - "name": "status", - "type": "TypeString", - "description": "The status of the certificate authority. The status of a root certificate authority is either `configured` or `expired`. For intermediate certificate authorities, possible statuses include `signing_required`,`signed_certificate_required`, `certificate_template_required`, `configured`, `expired` or `revoked`.", - "computed": true - }, - { - "name": "max_ttl_seconds", - "type": "TypeInt", - "description": "The maximum time-to-live (TTL) for certificates that are created by this CA.The value can be supplied as a string representation of a duration in hours, for example '8760h'. In the API response, this value is returned in seconds (integer).Minimum value is one hour (`1h`). Maximum value is 100 years (`876000h`).", - "computed": true - }, - { - "name": "format", - "type": "TypeString", - "description": "The format of the returned data.", + "name": "alt_names", + "type": "TypeList", + "description": "With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.", "immutable": true, "optional": true, - "computed": true + "elem": { + "type": "TypeString" + } }, { - "name": "postal_code", + "name": "other_sans", "type": "TypeList", - "description": "The postal code values to define in the subject field of the resulting certificate.", + "description": "The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the CA certificate.The alternative names must match the values that are specified in the `allowed_other_sans` field in the associated certificate template. The format is the same as OpenSSL: `\u003coid\u003e:\u003ctype\u003e:\u003cvalue\u003e` where the current valid type is `UTF8`.", "immutable": true, "optional": true, "computed": true, @@ -139438,32 +145421,20 @@ } }, { - "name": "instance_id", + "name": "private_key_format", "type": "TypeString", - "description": "The ID of the Secrets Manager instance.", - "cloud_data_type": "resource_instance", + "description": "The format of the generated private key.", + "default_value": "der", "immutable": true, - "required": true - }, - { - "name": "secret_type", - "type": "TypeString", - "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", - "computed": true + "optional": true }, { - "name": "key_bits", - "type": "TypeInt", - "description": "The number of bits to use to generate the private key.Allowable values for RSA keys are: `2048` and `4096`. Allowable values for EC keys are: `224`, `256`, `384`, and `521`. The default for RSA keys is `2048`. The default for EC keys is `256`.", + "name": "exclude_cn_from_sans", + "type": "TypeBool", + "description": "Controls whether the common name is excluded from Subject Alternative Names (SANs).If the common name set to `true`, it is not included in DNS or Email SANs if they apply. This field can be useful if the common name is a human-readable identifier, instead of a hostname or an email address.", + "default_value": false, "immutable": true, - "optional": true, - "computed": true - }, - { - "name": "serial_number", - "type": "TypeString", - "description": "The unique serial number that was assigned to a certificate by the issuing certificate authority.", - "computed": true + "optional": true }, { "name": "ou", @@ -139477,9 +145448,9 @@ } }, { - "name": "province", + "name": "locality", "type": "TypeList", - "description": "The Province (ST) values to define in the subject field of the resulting certificate.", + "description": "The Locality (L) values to define in the subject field of the resulting certificate.", "immutable": true, "optional": true, "computed": true, @@ -139488,60 +145459,33 @@ } }, { - "name": "expiration_date", - "type": "TypeString", - "description": "The date a secret is expired. The date format follows RFC 3339.", + "name": "crl_expiry_seconds", + "type": "TypeInt", + "description": "The time until the certificate revocation list (CRL) expires.The value can be supplied as a string representation of a duration in hours, such as `48h`. The default is 72 hours. In the API response, this value is returned in seconds (integer).**Note:** The CRL is rotated automatically before it expires.", "computed": true }, { - "name": "ttl", + "name": "common_name", "type": "TypeString", - "description": "Specifies the requested Time To Live (after which the certificate will be expired). The value can be provided provided as a string duration with time suffix (e.g. '24h') or the number of seconds as string (e.g. '86400').", - "optional": true + "description": "The Common Name (AKA CN) represents the server name that is protected by the SSL certificate.", + "immutable": true, + "required": true }, { - "name": "permitted_dns_domains", + "name": "organization", "type": "TypeList", - "description": "The allowed DNS domains or subdomains for the certificates that are to be signed and issued by this CA certificate.", + "description": "The Organization (O) values to define in the subject field of the resulting certificate.", "immutable": true, "optional": true, + "computed": true, "elem": { "type": "TypeString" } }, { - "name": "config_type", - "type": "TypeString", - "description": "The configuration type.", - "computed": true - }, - { - "name": "issuing_certificates_urls_encoded", - "type": "TypeBool", - "description": "Determines whether to encode the URL of the issuing certificate in the certificates that are issued by this certificate authority.", - "default_value": false, - "optional": true - }, - { - "name": "ip_sans", - "type": "TypeString", - "description": "The IP Subject Alternative Names to define for the CA certificate, in a comma-delimited list.", - "immutable": true, - "optional": true - }, - { - "name": "region", - "type": "TypeString", - "description": "The region of the Secrets Manager instance.", - "cloud_data_type": "region", - "immutable": true, - "optional": true, - "computed": true - }, - { - "name": "street_address", + "name": "province", "type": "TypeList", - "description": "The street address values to define in the subject field of the resulting certificate.", + "description": "The Province (ST) values to define in the subject field of the resulting certificate.", "immutable": true, "optional": true, "computed": true, @@ -139607,13 +145551,6 @@ } } }, - { - "name": "crl_distribution_points_encoded", - "type": "TypeBool", - "description": "Determines whether to encode the certificate revocation list (CRL) distribution points in the certificates that are issued by this certificate authority.", - "default_value": false, - "optional": true - }, { "name": "uri_sans", "type": "TypeString", @@ -139622,61 +145559,71 @@ "optional": true }, { - "name": "private_key_format", + "name": "format", "type": "TypeString", - "description": "The format of the generated private key.", - "default_value": "der", + "description": "The format of the returned data.", "immutable": true, - "optional": true + "optional": true, + "computed": true }, { - "name": "endpoint_type", + "name": "max_ttl_seconds", + "type": "TypeInt", + "description": "The maximum time-to-live (TTL) for certificates that are created by this CA.The value can be supplied as a string representation of a duration in hours, for example '8760h'. In the API response, this value is returned in seconds (integer).Minimum value is one hour (`1h`). Maximum value is 100 years (`876000h`).", + "computed": true + }, + { + "name": "ip_sans", "type": "TypeString", - "description": "public or private.", + "description": "The IP Subject Alternative Names to define for the CA certificate, in a comma-delimited list.", + "immutable": true, "optional": true }, { - "name": "crl_expiry", + "name": "key_type", "type": "TypeString", - "description": "The time until the certificate revocation list (CRL) expires.The value can be supplied as a string representation of a duration in hours, such as `48h`. The default is 72 hours. In the API response, this value is returned in seconds (integer).**Note:** The CRL is rotated automatically before it expires.", + "description": "The type of private key to generate.", + "immutable": true, "optional": true, "computed": true }, { - "name": "crl_disable", + "name": "use_csr_values", "type": "TypeBool", - "description": "Disables or enables certificate revocation list (CRL) building.If CRL building is disabled, a signed but zero-length CRL is returned when downloading the CRL. If CRL building is enabled, it will rebuild the CRL.", - "default_value": false, + "description": "Determines whether to use values from a certificate signing request (CSR) to complete a `private_cert_configuration_action_sign_csr` action.", + "immutable": true, "optional": true }, { - "name": "signing_method", + "name": "config_type", "type": "TypeString", - "description": "The signing method to use with this certificate authority to generate private certificates.You can choose between internal or externally signed options. For more information, see the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-intermediate-certificate-authorities).", - "immutable": true, - "required": true + "description": "The configuration type.", + "computed": true }, { - "name": "key_type", + "name": "name", "type": "TypeString", - "description": "The type of private key to generate.", + "description": "A human-readable unique name to assign to your configuration.To protect your privacy, do not use personal data, such as your name or location, as an name for your secret.", "immutable": true, - "optional": true, - "computed": true + "required": true }, { - "name": "organization", + "name": "street_address", "type": "TypeList", - "description": "The Organization (O) values to define in the subject field of the resulting certificate.", + "description": "The street address values to define in the subject field of the resulting certificate.", "immutable": true, "optional": true, "computed": true, "elem": { "type": "TypeString" } - } - ], - "ibm_sm_private_certificate_configuration_root_ca": [ + }, + { + "name": "status", + "type": "TypeString", + "description": "The status of the certificate authority. The status of a root certificate authority is either `configured` or `expired`. For intermediate certificate authorities, possible statuses include `signing_required`,`signed_certificate_required`, `certificate_template_required`, `configured`, `expired` or `revoked`.", + "computed": true + }, { "name": "crl_disable", "type": "TypeBool", @@ -139685,24 +145632,29 @@ "optional": true }, { - "name": "ttl", - "type": "TypeString", - "description": "The requested time-to-live (TTL) for certificates that are created by this CA. This field's value cannot be longer than the `max_ttl` limit.The value can be supplied as a string representation of a duration in hours, for example '8760h'. In the API response, this value is returned in seconds (integer).", + "name": "key_bits", + "type": "TypeInt", + "description": "The number of bits to use to generate the private key.Allowable values for RSA keys are: `2048` and `4096`. Allowable values for EC keys are: `224`, `256`, `384`, and `521`. The default for RSA keys is `2048`. The default for EC keys is `256`.", + "immutable": true, "optional": true, "computed": true }, { - "name": "format", + "name": "max_ttl", "type": "TypeString", - "description": "The format of the returned data.", - "immutable": true, - "optional": true, + "description": "The maximum time-to-live (TTL) for certificates that are created by this CA.The value can be supplied as a string representation of a duration in hours, for example '8760h'. In the API response, this value is returned in seconds (integer).Minimum value is one hour (`1h`). Maximum value is 100 years (`876000h`).", + "required": true + }, + { + "name": "expiration_date", + "type": "TypeString", + "description": "The date a secret is expired. The date format follows RFC 3339.", "computed": true }, { - "name": "permitted_dns_domains", + "name": "postal_code", "type": "TypeList", - "description": "The allowed DNS domains or subdomains for the certificates that are to be signed and issued by this CA certificate.", + "description": "The postal code values to define in the subject field of the resulting certificate.", "immutable": true, "optional": true, "computed": true, @@ -139711,15 +145663,11 @@ } }, { - "name": "ou", - "type": "TypeList", - "description": "The Organizational Unit (OU) values to define in the subject field of the resulting certificate.", + "name": "signing_method", + "type": "TypeString", + "description": "The signing method to use with this certificate authority to generate private certificates.You can choose between internal or externally signed options. For more information, see the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-intermediate-certificate-authorities).", "immutable": true, - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "required": true }, { "name": "country", @@ -139733,9 +145681,37 @@ } }, { - "name": "locality", + "name": "serial_number", + "type": "TypeString", + "description": "The unique serial number that was assigned to a certificate by the issuing certificate authority.", + "computed": true + }, + { + "name": "max_path_length", + "type": "TypeInt", + "description": "The maximum path length to encode in the generated certificate. `-1` means no limit.", + "immutable": true, + "optional": true + }, + { + "name": "secret_type", + "type": "TypeString", + "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", + "computed": true + }, + { + "name": "crl_distribution_points_encoded", + "type": "TypeBool", + "description": "Determines whether to encode the certificate revocation list (CRL) distribution points in the certificates that are issued by this certificate authority.", + "default_value": false, + "optional": true + } + ], + "ibm_sm_private_certificate_configuration_root_ca": [ + { + "name": "country", "type": "TypeList", - "description": "The Locality (L) values to define in the subject field of the resulting certificate.", + "description": "The Country (C) values to define in the subject field of the resulting certificate.", "immutable": true, "optional": true, "computed": true, @@ -139750,63 +145726,54 @@ "computed": true }, { - "name": "data", + "name": "created_at", + "type": "TypeString", + "description": "The date when a resource was created. The date format follows RFC 3339.", + "computed": true + }, + { + "name": "endpoint_type", + "type": "TypeString", + "description": "public or private.", + "optional": true + }, + { + "name": "max_ttl", + "type": "TypeString", + "description": "The maximum time-to-live (TTL) for certificates that are created by this CA.The value can be supplied as a string representation of a duration in hours, for example '8760h'. In the API response, this value is returned in seconds (integer).Minimum value is one hour (`1h`). Maximum value is 100 years (`876000h`).", + "required": true + }, + { + "name": "other_sans", "type": "TypeList", - "description": "The configuration data of your Private Certificate.", - "secure": true, + "description": "The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the CA certificate.The alternative names must match the values that are specified in the `allowed_other_sans` field in the associated certificate template. The format is the same as OpenSSL: `\u003coid\u003e:\u003ctype\u003e:\u003cvalue\u003e` where the current valid type is `UTF8`.", + "immutable": true, + "optional": true, "computed": true, "elem": { - "ca_chain": { - "name": "ca_chain", - "type": "TypeList", - "description": "The chain of certificate authorities that are associated with the certificate.", - "secure": true, - "computed": true, - "elem": { - "type": "TypeString" - } - }, - "certificate": { - "name": "certificate", - "type": "TypeString", - "description": "The PEM-encoded contents of your certificate.", - "secure": true, - "computed": true - }, - "csr": { - "name": "csr", - "type": "TypeString", - "description": "The certificate signing request.", - "computed": true - }, - "expiration": { - "name": "expiration", - "type": "TypeInt", - "description": "The certificate expiration time.", - "computed": true - }, - "issuing_ca": { - "name": "issuing_ca", - "type": "TypeString", - "description": "The PEM-encoded certificate of the certificate authority that signed and issued this certificate.", - "secure": true, - "computed": true - }, - "private_key": { - "name": "private_key", - "type": "TypeString", - "description": "(Optional) The PEM-encoded private key to associate with the certificate.", - "secure": true, - "computed": true - }, - "private_key_type": { - "name": "private_key_type", - "type": "TypeString", - "description": "The type of private key to generate.", - "computed": true - } + "type": "TypeString" } }, + { + "name": "status", + "type": "TypeString", + "description": "The status of the certificate authority. The status of a root certificate authority is either `configured` or `expired`. For intermediate certificate authorities, possible statuses include `signing_required`,`signed_certificate_required`, `certificate_template_required`, `configured`, `expired` or `revoked`.", + "computed": true + }, + { + "name": "crl_disable", + "type": "TypeBool", + "description": "Disables or enables certificate revocation list (CRL) building.If CRL building is disabled, a signed but zero-length CRL is returned when downloading the CRL. If CRL building is enabled, it will rebuild the CRL.", + "default_value": false, + "optional": true + }, + { + "name": "crl_distribution_points_encoded", + "type": "TypeBool", + "description": "Determines whether to encode the certificate revocation list (CRL) distribution points in the certificates that are issued by this certificate authority.", + "default_value": false, + "optional": true + }, { "name": "alt_names", "type": "TypeList", @@ -139818,9 +145785,16 @@ } }, { - "name": "other_sans", + "name": "uri_sans", + "type": "TypeString", + "description": "The URI Subject Alternative Names to define for the CA certificate, in a comma-delimited list.", + "immutable": true, + "optional": true + }, + { + "name": "permitted_dns_domains", "type": "TypeList", - "description": "The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the CA certificate.The alternative names must match the values that are specified in the `allowed_other_sans` field in the associated certificate template. The format is the same as OpenSSL: `\u003coid\u003e:\u003ctype\u003e:\u003cvalue\u003e` where the current valid type is `UTF8`.", + "description": "The allowed DNS domains or subdomains for the certificates that are to be signed and issued by this CA certificate.", "immutable": true, "optional": true, "computed": true, @@ -139829,12 +145803,15 @@ } }, { - "name": "key_bits", - "type": "TypeInt", - "description": "The number of bits to use to generate the private key.Allowable values for RSA keys are: `2048` and `4096`. Allowable values for EC keys are: `224`, `256`, `384`, and `521`. The default for RSA keys is `2048`. The default for EC keys is `256`.", + "name": "organization", + "type": "TypeList", + "description": "The Organization (O) values to define in the subject field of the resulting certificate.", "immutable": true, "optional": true, - "computed": true + "computed": true, + "elem": { + "type": "TypeString" + } }, { "name": "street_address", @@ -139847,6 +145824,14 @@ "type": "TypeString" } }, + { + "name": "instance_id", + "type": "TypeString", + "description": "The ID of the Secrets Manager instance.", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true + }, { "name": "postal_code", "type": "TypeList", @@ -139859,9 +145844,9 @@ } }, { - "name": "secret_type", + "name": "created_by", "type": "TypeString", - "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", + "description": "The unique identifier that is associated with the entity that created the secret.", "computed": true }, { @@ -139871,23 +145856,30 @@ "computed": true }, { - "name": "crl_expiry", + "name": "config_type", "type": "TypeString", - "description": "The time until the certificate revocation list (CRL) expires.The value can be supplied as a string representation of a duration in hours, such as `48h`. The default is 72 hours. In the API response, this value is returned in seconds (integer).**Note:** The CRL is rotated automatically before it expires.", - "optional": true, + "description": "The configuration type.", "computed": true }, { - "name": "uri_sans", + "name": "name", "type": "TypeString", - "description": "The URI Subject Alternative Names to define for the CA certificate, in a comma-delimited list.", + "description": "A human-readable unique name to assign to your configuration.To protect your privacy, do not use personal data, such as your name or location, as an name for your secret.", "immutable": true, - "optional": true + "required": true }, { - "name": "organization", + "name": "format", + "type": "TypeString", + "description": "The format of the returned data.", + "immutable": true, + "optional": true, + "computed": true + }, + { + "name": "ou", "type": "TypeList", - "description": "The Organization (O) values to define in the subject field of the resulting certificate.", + "description": "The Organizational Unit (OU) values to define in the subject field of the resulting certificate.", "immutable": true, "optional": true, "computed": true, @@ -139896,42 +145888,66 @@ } }, { - "name": "status", + "name": "locality", + "type": "TypeList", + "description": "The Locality (L) values to define in the subject field of the resulting certificate.", + "immutable": true, + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "province", + "type": "TypeList", + "description": "The Province (ST) values to define in the subject field of the resulting certificate.", + "immutable": true, + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "updated_at", "type": "TypeString", - "description": "The status of the certificate authority. The status of a root certificate authority is either `configured` or `expired`. For intermediate certificate authorities, possible statuses include `signing_required`,`signed_certificate_required`, `certificate_template_required`, `configured`, `expired` or `revoked`.", + "description": "The date when a resource was recently modified. The date format follows RFC 3339.", "computed": true }, { - "name": "max_ttl", + "name": "crl_expiry", "type": "TypeString", - "description": "The maximum time-to-live (TTL) for certificates that are created by this CA.The value can be supplied as a string representation of a duration in hours, for example '8760h'. In the API response, this value is returned in seconds (integer).Minimum value is one hour (`1h`). Maximum value is 100 years (`876000h`).", - "required": true + "description": "The time until the certificate revocation list (CRL) expires.The value can be supplied as a string representation of a duration in hours, such as `48h`. The default is 72 hours. In the API response, this value is returned in seconds (integer).**Note:** The CRL is rotated automatically before it expires.", + "optional": true, + "computed": true }, { - "name": "ttl_seconds", - "type": "TypeInt", + "name": "ttl", + "type": "TypeString", "description": "The requested time-to-live (TTL) for certificates that are created by this CA. This field's value cannot be longer than the `max_ttl` limit.The value can be supplied as a string representation of a duration in hours, for example '8760h'. In the API response, this value is returned in seconds (integer).", + "optional": true, "computed": true }, { - "name": "crl_expiry_seconds", + "name": "max_path_length", "type": "TypeInt", - "description": "The time until the certificate revocation list (CRL) expires, in seconds.", + "description": "The maximum path length to encode in the generated certificate. `-1` means no limit.If the signing certificate has a maximum path length set, the path length is set to one less than that of the signing certificate. A limit of `0` means a literal path length of zero.", + "immutable": true, + "optional": true, "computed": true }, { - "name": "name", + "name": "secret_type", "type": "TypeString", - "description": "A human-readable unique name to assign to your configuration.To protect your privacy, do not use personal data, such as your name or location, as an name for your secret.", - "immutable": true, - "required": true + "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", + "computed": true }, { - "name": "common_name", + "name": "expiration_date", "type": "TypeString", - "description": "The Common Name (AKA CN) represents the server name that is protected by the SSL certificate.", - "immutable": true, - "required": true + "description": "The date a secret is expired. The date format follows RFC 3339.", + "computed": true }, { "name": "ip_sans", @@ -139941,18 +145957,18 @@ "optional": true }, { - "name": "exclude_cn_from_sans", - "type": "TypeBool", - "description": "Controls whether the common name is excluded from Subject Alternative Names (SANs).If the common name set to `true`, it is not included in DNS or Email SANs if they apply. This field can be useful if the common name is a human-readable identifier, instead of a hostname or an email address.", - "default_value": false, - "immutable": true, - "optional": true + "name": "ttl_seconds", + "type": "TypeInt", + "description": "The requested time-to-live (TTL) for certificates that are created by this CA. This field's value cannot be longer than the `max_ttl` limit.The value can be supplied as a string representation of a duration in hours, for example '8760h'. In the API response, this value is returned in seconds (integer).", + "computed": true }, { - "name": "updated_at", + "name": "private_key_format", "type": "TypeString", - "description": "The date when a resource was recently modified. The date format follows RFC 3339.", - "computed": true + "description": "The format of the generated private key.", + "default_value": "der", + "immutable": true, + "optional": true }, { "name": "region", @@ -139963,19 +145979,6 @@ "optional": true, "computed": true }, - { - "name": "endpoint_type", - "type": "TypeString", - "description": "public or private.", - "optional": true - }, - { - "name": "crl_distribution_points_encoded", - "type": "TypeBool", - "description": "Determines whether to encode the certificate revocation list (CRL) distribution points in the certificates that are issued by this certificate authority.", - "default_value": false, - "optional": true - }, { "name": "issuing_certificates_urls_encoded", "type": "TypeBool", @@ -139984,28 +145987,9 @@ "optional": true }, { - "name": "created_by", - "type": "TypeString", - "description": "The unique identifier that is associated with the entity that created the secret.", - "computed": true - }, - { - "name": "created_at", - "type": "TypeString", - "description": "The date when a resource was created. The date format follows RFC 3339.", - "computed": true - }, - { - "name": "expiration_date", - "type": "TypeString", - "description": "The date a secret is expired. The date format follows RFC 3339.", - "computed": true - }, - { - "name": "instance_id", + "name": "common_name", "type": "TypeString", - "description": "The ID of the Secrets Manager instance.", - "cloud_data_type": "resource_instance", + "description": "The Common Name (AKA CN) represents the server name that is protected by the SSL certificate.", "immutable": true, "required": true }, @@ -140018,58 +146002,131 @@ "computed": true }, { - "name": "max_path_length", + "name": "key_bits", "type": "TypeInt", - "description": "The maximum path length to encode in the generated certificate. `-1` means no limit.If the signing certificate has a maximum path length set, the path length is set to one less than that of the signing certificate. A limit of `0` means a literal path length of zero.", + "description": "The number of bits to use to generate the private key.Allowable values for RSA keys are: `2048` and `4096`. Allowable values for EC keys are: `224`, `256`, `384`, and `521`. The default for RSA keys is `2048`. The default for EC keys is `256`.", "immutable": true, "optional": true, "computed": true }, { - "name": "config_type", - "type": "TypeString", - "description": "The configuration type.", + "name": "exclude_cn_from_sans", + "type": "TypeBool", + "description": "Controls whether the common name is excluded from Subject Alternative Names (SANs).If the common name set to `true`, it is not included in DNS or Email SANs if they apply. This field can be useful if the common name is a human-readable identifier, instead of a hostname or an email address.", + "default_value": false, + "immutable": true, + "optional": true + }, + { + "name": "crl_expiry_seconds", + "type": "TypeInt", + "description": "The time until the certificate revocation list (CRL) expires, in seconds.", "computed": true }, { - "name": "private_key_format", - "type": "TypeString", - "description": "The format of the generated private key.", - "default_value": "der", - "immutable": true, - "optional": true + "name": "data", + "type": "TypeList", + "description": "The configuration data of your Private Certificate.", + "secure": true, + "computed": true, + "elem": { + "ca_chain": { + "name": "ca_chain", + "type": "TypeList", + "description": "The chain of certificate authorities that are associated with the certificate.", + "secure": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, + "certificate": { + "name": "certificate", + "type": "TypeString", + "description": "The PEM-encoded contents of your certificate.", + "secure": true, + "computed": true + }, + "csr": { + "name": "csr", + "type": "TypeString", + "description": "The certificate signing request.", + "computed": true + }, + "expiration": { + "name": "expiration", + "type": "TypeInt", + "description": "The certificate expiration time.", + "computed": true + }, + "issuing_ca": { + "name": "issuing_ca", + "type": "TypeString", + "description": "The PEM-encoded certificate of the certificate authority that signed and issued this certificate.", + "secure": true, + "computed": true + }, + "private_key": { + "name": "private_key", + "type": "TypeString", + "description": "(Optional) The PEM-encoded private key to associate with the certificate.", + "secure": true, + "computed": true + }, + "private_key_type": { + "name": "private_key_type", + "type": "TypeString", + "description": "The type of private key to generate.", + "computed": true + } + } + } + ], + "ibm_sm_private_certificate_configuration_template": [ + { + "name": "config_type", + "type": "TypeString", + "description": "The configuration type.", + "computed": true }, { - "name": "province", + "name": "allowed_other_sans", "type": "TypeList", - "description": "The Province (ST) values to define in the subject field of the resulting certificate.", - "immutable": true, + "description": "The custom Object Identifier (OID) or UTF8-string Subject Alternative Names (SANs) to allow for private certificates.The format for each element in the list is the same as OpenSSL: `\u003coid\u003e:\u003ctype\u003e:\u003cvalue\u003e` where the current valid type is `UTF8`. To allow any value for an OID, use `*` as its value. Alternatively, specify a single `*` to allow any `other_sans` input.", "optional": true, "computed": true, "elem": { "type": "TypeString" } - } - ], - "ibm_sm_private_certificate_configuration_template": [ + }, { - "name": "ttl", - "type": "TypeString", - "description": "The requested time-to-live (TTL) for certificates that are created by this CA. This field's value cannot be longer than the `max_ttl` limit.The value can be supplied as a string representation of a duration in hours, for example '8760h'. In the API response, this value is returned in seconds (integer).", - "optional": true + "name": "server_flag", + "type": "TypeBool", + "description": "Determines whether private certificates are flagged for server use.", + "optional": true, + "computed": true }, { - "name": "key_type", - "type": "TypeString", - "description": "The type of private key to generate.", + "name": "code_signing_flag", + "type": "TypeBool", + "description": "Determines whether private certificates are flagged for code signing use.", "optional": true, "computed": true }, { - "name": "key_bits", - "type": "TypeInt", - "description": "The number of bits to use to generate the private key.Allowable values for RSA keys are: `2048` and `4096`. Allowable values for EC keys are: `224`, `256`, `384`, and `521`. The default for RSA keys is `2048`. The default for EC keys is `256`.", + "name": "key_usage", + "type": "TypeList", + "description": "The allowed key usage constraint to define for private certificates.You can find valid values in the [Go x509 package documentation](https://pkg.go.dev/crypto/x509#KeyUsage). Omit the `KeyUsage` part of the value. Values are not case-sensitive. To specify no key usage constraints, set this field to an empty list.", "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "The date when a resource was recently modified. The date format follows RFC 3339.", "computed": true }, { @@ -140080,15 +146137,15 @@ "computed": true }, { - "name": "updated_at", + "name": "secret_type", "type": "TypeString", - "description": "The date when a resource was recently modified. The date format follows RFC 3339.", + "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", "computed": true }, { - "name": "ttl_seconds", - "type": "TypeInt", - "description": "The requested Time To Live, after which the certificate will be expired.", + "name": "created_at", + "type": "TypeString", + "description": "The date when a resource was created. The date format follows RFC 3339.", "computed": true }, { @@ -140098,50 +146155,28 @@ "optional": true }, { - "name": "max_ttl", + "name": "region", "type": "TypeString", - "description": "The maximum time-to-live (TTL) for certificates that are created by this CA.The value can be supplied as a string representation of a duration in hours, for example '8760h'. In the API response, this value is returned in seconds (integer).Minimum value is one hour (`1h`). Maximum value is 100 years (`876000h`).", - "optional": true - }, - { - "name": "require_cn", - "type": "TypeBool", - "description": "Determines whether to require a common name to create a private certificate.By default, a common name is required to generate a certificate. To make the `common_name` field optional, set the `require_cn` option to `false`.", - "optional": true, - "computed": true - }, - { - "name": "email_protection_flag", - "type": "TypeBool", - "description": "Determines whether private certificates are flagged for email protection use.", - "optional": true, - "computed": true - }, - { - "name": "allow_subdomains", - "type": "TypeBool", - "description": "Determines whether to allow clients to request private certificates with common names (CN) that are subdomains of the CNs that are allowed by the other certificate template options. This includes wildcard subdomains.For example, if `allowed_domains` has a value of `example.com` and `allow_subdomains`is set to `true`, then the following subdomains are allowed: `foo.example.com`, `bar.example.com`, `*.example.com`.**Note:** This field is redundant if you use the `allow_any_name` option.", - "optional": true, - "computed": true - }, - { - "name": "allow_wildcard_certificates", - "type": "TypeBool", - "description": "Determines whether the issuance of certificates with RFC 6125 wildcards in the CN field.When set to false, this field prevents wildcards from being issued even if they can be allowed by an option `allow_glob_domains`.", + "description": "The region of the Secrets Manager instance.", + "cloud_data_type": "region", + "immutable": true, "optional": true, "computed": true }, { - "name": "code_signing_flag", - "type": "TypeBool", - "description": "Determines whether private certificates are flagged for code signing use.", + "name": "organization", + "type": "TypeList", + "description": "The Organization (O) values to define in the subject field of the resulting certificate.", "optional": true, - "computed": true + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "ext_key_usage_oids", + "name": "country", "type": "TypeList", - "description": "A list of extended key usage Object Identifiers (OIDs).", + "description": "The Country (C) values to define in the subject field of the resulting certificate.", "optional": true, "computed": true, "elem": { @@ -140149,9 +146184,9 @@ } }, { - "name": "allowed_domains", + "name": "province", "type": "TypeList", - "description": "The domains to define for the certificate template. This property is used along with the `allow_bare_domains` and `allow_subdomains` options.", + "description": "The Province (ST) values to define in the subject field of the resulting certificate.", "optional": true, "computed": true, "elem": { @@ -140159,9 +146194,9 @@ } }, { - "name": "allowed_uri_sans", + "name": "street_address", "type": "TypeList", - "description": "The URI Subject Alternative Names to allow for private certificates.Values can contain glob patterns, for example `spiffe://hostname/_*`.", + "description": "The street address values to define in the subject field of the resulting certificate.", "optional": true, "computed": true, "elem": { @@ -140169,34 +146204,42 @@ } }, { - "name": "client_flag", + "name": "allowed_domains_template", "type": "TypeBool", - "description": "Determines whether private certificates are flagged for client use.", + "description": "Determines whether to allow the domains that are supplied in the `allowed_domains` field to contain access control list (ACL) templates.", "optional": true, "computed": true }, { - "name": "created_by", - "type": "TypeString", - "description": "The unique identifier that is associated with the entity that created the secret.", + "name": "client_flag", + "type": "TypeBool", + "description": "Determines whether private certificates are flagged for client use.", + "optional": true, "computed": true }, { - "name": "max_ttl_seconds", + "name": "not_before_duration_seconds", "type": "TypeInt", - "description": "The maximum time-to-live (TTL) for certificates that are created by this CA in seconds.", + "description": "The duration in seconds by which to backdate the `not_before` property of an issued private certificate.", "computed": true }, { - "name": "config_type", + "name": "ttl", "type": "TypeString", - "description": "The configuration type.", + "description": "The requested time-to-live (TTL) for certificates that are created by this CA. This field's value cannot be longer than the `max_ttl` limit.The value can be supplied as a string representation of a duration in hours, for example '8760h'. In the API response, this value is returned in seconds (integer).", + "optional": true + }, + { + "name": "allow_localhost", + "type": "TypeBool", + "description": "Determines whether to allow `localhost` to be included as one of the requested common names.", + "optional": true, "computed": true }, { - "name": "country", + "name": "allowed_domains", "type": "TypeList", - "description": "The Country (C) values to define in the subject field of the resulting certificate.", + "description": "The domains to define for the certificate template. This property is used along with the `allow_bare_domains` and `allow_subdomains` options.", "optional": true, "computed": true, "elem": { @@ -140204,9 +146247,16 @@ } }, { - "name": "province", + "name": "allow_wildcard_certificates", + "type": "TypeBool", + "description": "Determines whether the issuance of certificates with RFC 6125 wildcards in the CN field.When set to false, this field prevents wildcards from being issued even if they can be allowed by an option `allow_glob_domains`.", + "optional": true, + "computed": true + }, + { + "name": "allowed_uri_sans", "type": "TypeList", - "description": "The Province (ST) values to define in the subject field of the resulting certificate.", + "description": "The URI Subject Alternative Names to allow for private certificates.Values can contain glob patterns, for example `spiffe://hostname/_*`.", "optional": true, "computed": true, "elem": { @@ -140214,9 +146264,22 @@ } }, { - "name": "street_address", + "name": "max_ttl_seconds", + "type": "TypeInt", + "description": "The maximum time-to-live (TTL) for certificates that are created by this CA in seconds.", + "computed": true + }, + { + "name": "name", + "type": "TypeString", + "description": "A human-readable unique name to assign to your configuration.To protect your privacy, do not use personal data, such as your name or location, as an name for your secret.", + "immutable": true, + "required": true + }, + { + "name": "ou", "type": "TypeList", - "description": "The street address values to define in the subject field of the resulting certificate.", + "description": "The Organizational Unit (OU) values to define in the subject field of the resulting certificate.", "optional": true, "computed": true, "elem": { @@ -140224,18 +146287,36 @@ } }, { - "name": "use_csr_sans", + "name": "allowed_secret_groups", + "type": "TypeString", + "description": "Scopes the creation of private certificates to only the secret groups that you specify.This field can be supplied as a comma-delimited list of secret group IDs.", + "optional": true, + "computed": true + }, + { + "name": "allow_bare_domains", "type": "TypeBool", - "description": "When used with the `private_cert_configuration_action_sign_csr` action, this field determines whether to use the Subject Alternative Names(SANs) from a certificate signing request (CSR) instead of the SANs that are included in the data of the certificate.Does not include the common name in the CSR. To use the common name, include the `use_csr_common_name` property.", + "description": "Determines whether to allow clients to request private certificates that match the value of the actual domains on the final certificate.For example, if you specify `example.com` in the `allowed_domains` field, you grant clients the ability to request a certificate that contains the name `example.com` as one of the DNS values on the final certificate.**Important:** In some scenarios, allowing bare domains can be considered a security risk.", "optional": true, "computed": true }, { - "name": "secret_type", - "type": "TypeString", - "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", + "name": "enforce_hostnames", + "type": "TypeBool", + "description": "Determines whether to enforce only valid host names for common names, DNS Subject Alternative Names, and the host section of email addresses.", + "optional": true, "computed": true }, + { + "name": "ext_key_usage_oids", + "type": "TypeList", + "description": "A list of extended key usage Object Identifiers (OIDs).", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } + }, { "name": "instance_id", "type": "TypeString", @@ -140245,45 +146326,50 @@ "required": true }, { - "name": "region", + "name": "key_type", "type": "TypeString", - "description": "The region of the Secrets Manager instance.", - "cloud_data_type": "region", - "immutable": true, + "description": "The type of private key to generate.", "optional": true, "computed": true }, { - "name": "name", - "type": "TypeString", - "description": "A human-readable unique name to assign to your configuration.To protect your privacy, do not use personal data, such as your name or location, as an name for your secret.", - "immutable": true, - "required": true + "name": "key_bits", + "type": "TypeInt", + "description": "The number of bits to use to generate the private key.Allowable values for RSA keys are: `2048` and `4096`. Allowable values for EC keys are: `224`, `256`, `384`, and `521`. The default for RSA keys is `2048`. The default for EC keys is `256`.", + "optional": true, + "computed": true }, { - "name": "organization", - "type": "TypeList", - "description": "The Organization (O) values to define in the subject field of the resulting certificate.", + "name": "serial_number", + "type": "TypeString", + "description": "Unused field.", "optional": true, "computed": true, - "elem": { - "type": "TypeString" - } + "deprecated": "This field is deprecated." }, { - "name": "locality", - "type": "TypeList", - "description": "The Locality (L) values to define in the subject field of the resulting certificate.", + "name": "allow_any_name", + "type": "TypeBool", + "description": "Determines whether to allow clients to request a private certificate that matches any common name.", "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "computed": true }, { - "name": "postal_code", + "name": "created_by", + "type": "TypeString", + "description": "The unique identifier that is associated with the entity that created the secret.", + "computed": true + }, + { + "name": "ttl_seconds", + "type": "TypeInt", + "description": "The requested Time To Live, after which the certificate will be expired.", + "computed": true + }, + { + "name": "locality", "type": "TypeList", - "description": "The postal code values to define in the subject field of the resulting certificate.", + "description": "The Locality (L) values to define in the subject field of the resulting certificate.", "optional": true, "computed": true, "elem": { @@ -140297,40 +146383,23 @@ "required": true }, { - "name": "allowed_secret_groups", - "type": "TypeString", - "description": "Scopes the creation of private certificates to only the secret groups that you specify.This field can be supplied as a comma-delimited list of secret group IDs.", - "optional": true, - "computed": true - }, - { - "name": "allow_localhost", + "name": "allow_subdomains", "type": "TypeBool", - "description": "Determines whether to allow `localhost` to be included as one of the requested common names.", + "description": "Determines whether to allow clients to request private certificates with common names (CN) that are subdomains of the CNs that are allowed by the other certificate template options. This includes wildcard subdomains.For example, if `allowed_domains` has a value of `example.com` and `allow_subdomains`is set to `true`, then the following subdomains are allowed: `foo.example.com`, `bar.example.com`, `*.example.com`.**Note:** This field is redundant if you use the `allow_any_name` option.", "optional": true, "computed": true }, { - "name": "allowed_domains_template", + "name": "allow_glob_domains", "type": "TypeBool", - "description": "Determines whether to allow the domains that are supplied in the `allowed_domains` field to contain access control list (ACL) templates.", + "description": "Determines whether to allow glob patterns, for example, `ftp*.example.com`, in the names that are specified in the `allowed_domains` field.If set to `true`, clients are allowed to request private certificates with names that match the glob patterns.", "optional": true, "computed": true }, { - "name": "ou", - "type": "TypeList", - "description": "The Organizational Unit (OU) values to define in the subject field of the resulting certificate.", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "key_usage", + "name": "ext_key_usage", "type": "TypeList", - "description": "The allowed key usage constraint to define for private certificates.You can find valid values in the [Go x509 package documentation](https://pkg.go.dev/crypto/x509#KeyUsage). Omit the `KeyUsage` part of the value. Values are not case-sensitive. To specify no key usage constraints, set this field to an empty list.", + "description": "The allowed extended key usage constraint on private certificates.You can find valid values in the [Go x509 package documentation](https://golang.org/pkg/crypto/x509/#ExtKeyUsage). Omit the `ExtKeyUsage` part of the value. Values are not case-sensitive. To specify no key usage constraints, set this field to an empty list.", "optional": true, "computed": true, "elem": { @@ -140345,36 +146414,21 @@ "computed": true }, { - "name": "not_before_duration_seconds", - "type": "TypeInt", - "description": "The duration in seconds by which to backdate the `not_before` property of an issued private certificate.", - "computed": true - }, - { - "name": "allow_ip_sans", - "type": "TypeBool", - "description": "Determines whether to allow clients to request a private certificate with IP Subject Alternative Names.", - "optional": true, - "computed": true - }, - { - "name": "enforce_hostnames", - "type": "TypeBool", - "description": "Determines whether to enforce only valid host names for common names, DNS Subject Alternative Names, and the host section of email addresses.", - "optional": true, - "computed": true + "name": "not_before_duration", + "type": "TypeString", + "description": "The duration in seconds by which to backdate the `not_before` property of an issued private certificate.The value can be supplied as a string representation of a duration, such as `30s`. In the API response, this value is returned in seconds (integer).", + "optional": true }, { - "name": "server_flag", - "type": "TypeBool", - "description": "Determines whether private certificates are flagged for server use.", - "optional": true, - "computed": true + "name": "max_ttl", + "type": "TypeString", + "description": "The maximum time-to-live (TTL) for certificates that are created by this CA.The value can be supplied as a string representation of a duration in hours, for example '8760h'. In the API response, this value is returned in seconds (integer).Minimum value is one hour (`1h`). Maximum value is 100 years (`876000h`).", + "optional": true }, { - "name": "policy_identifiers", + "name": "postal_code", "type": "TypeList", - "description": "A list of policy Object Identifiers (OIDs).", + "description": "The postal code values to define in the subject field of the resulting certificate.", "optional": true, "computed": true, "elem": { @@ -140382,121 +146436,92 @@ } }, { - "name": "created_at", - "type": "TypeString", - "description": "The date when a resource was created. The date format follows RFC 3339.", - "computed": true - }, - { - "name": "allow_glob_domains", + "name": "allow_ip_sans", "type": "TypeBool", - "description": "Determines whether to allow glob patterns, for example, `ftp*.example.com`, in the names that are specified in the `allowed_domains` field.If set to `true`, clients are allowed to request private certificates with names that match the glob patterns.", + "description": "Determines whether to allow clients to request a private certificate with IP Subject Alternative Names.", "optional": true, "computed": true }, { - "name": "allow_bare_domains", + "name": "email_protection_flag", "type": "TypeBool", - "description": "Determines whether to allow clients to request private certificates that match the value of the actual domains on the final certificate.For example, if you specify `example.com` in the `allowed_domains` field, you grant clients the ability to request a certificate that contains the name `example.com` as one of the DNS values on the final certificate.**Important:** In some scenarios, allowing bare domains can be considered a security risk.", + "description": "Determines whether private certificates are flagged for email protection use.", "optional": true, "computed": true }, { - "name": "allow_any_name", + "name": "use_csr_sans", "type": "TypeBool", - "description": "Determines whether to allow clients to request a private certificate that matches any common name.", + "description": "When used with the `private_cert_configuration_action_sign_csr` action, this field determines whether to use the Subject Alternative Names(SANs) from a certificate signing request (CSR) instead of the SANs that are included in the data of the certificate.Does not include the common name in the CSR. To use the common name, include the `use_csr_common_name` property.", "optional": true, "computed": true }, { - "name": "allowed_other_sans", - "type": "TypeList", - "description": "The custom Object Identifier (OID) or UTF8-string Subject Alternative Names (SANs) to allow for private certificates.The format for each element in the list is the same as OpenSSL: `\u003coid\u003e:\u003ctype\u003e:\u003cvalue\u003e` where the current valid type is `UTF8`. To allow any value for an OID, use `*` as its value. Alternatively, specify a single `*` to allow any `other_sans` input.", + "name": "require_cn", + "type": "TypeBool", + "description": "Determines whether to require a common name to create a private certificate.By default, a common name is required to generate a certificate. To make the `common_name` field optional, set the `require_cn` option to `false`.", "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "computed": true }, { - "name": "ext_key_usage", + "name": "policy_identifiers", "type": "TypeList", - "description": "The allowed extended key usage constraint on private certificates.You can find valid values in the [Go x509 package documentation](https://golang.org/pkg/crypto/x509/#ExtKeyUsage). Omit the `ExtKeyUsage` part of the value. Values are not case-sensitive. To specify no key usage constraints, set this field to an empty list.", + "description": "A list of policy Object Identifiers (OIDs).", "optional": true, "computed": true, "elem": { "type": "TypeString" } - }, - { - "name": "not_before_duration", - "type": "TypeString", - "description": "The duration in seconds by which to backdate the `not_before` property of an issued private certificate.The value can be supplied as a string representation of a duration, such as `30s`. In the API response, this value is returned in seconds (integer).", - "optional": true - }, - { - "name": "serial_number", - "type": "TypeString", - "description": "Unused field.", - "optional": true, - "computed": true, - "deprecated": "This field is deprecated." } ], "ibm_sm_public_certificate": [ { - "name": "serial_number", - "type": "TypeString", - "description": "The unique serial number that was assigned to a certificate by the issuing certificate authority.", - "computed": true - }, - { - "name": "instance_id", + "name": "ca", "type": "TypeString", - "description": "The ID of the Secrets Manager instance.", - "cloud_data_type": "resource_instance", + "description": "The name of the certificate authority configuration.", "immutable": true, "required": true }, { - "name": "secret_type", - "type": "TypeString", - "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", + "name": "versions_total", + "type": "TypeInt", + "description": "The number of versions of the secret.", "computed": true }, { - "name": "name", - "type": "TypeString", - "description": "A human-readable name to assign to your secret.To protect your privacy, do not use personal data, such as your name or location, as a name for your secret.", - "required": true - }, - { - "name": "state", - "type": "TypeInt", - "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", - "computed": true + "name": "validity", + "type": "TypeList", + "description": "The date and time that the certificate validity period begins and ends.", + "computed": true, + "elem": { + "not_after": { + "name": "not_after", + "type": "TypeString", + "description": "The date-time format follows RFC 3339.", + "computed": true + }, + "not_before": { + "name": "not_before", + "type": "TypeString", + "description": "The date-time format follows RFC 3339.", + "computed": true + } + } }, { - "name": "private_key", + "name": "certificate", "type": "TypeString", - "description": "(Optional) The PEM-encoded private key to associate with the certificate.", + "description": "The PEM-encoded contents of your certificate.", "secure": true, "computed": true }, { - "name": "key_algorithm", - "type": "TypeString", - "description": "The identifier for the cryptographic algorithm to be used to generate the public key that is associated with the certificate.The algorithm that you select determines the encryption algorithm (`RSA` or `ECDSA`) and key size to be used to generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to provide more encryption protection. Allowed values: RSA2048, RSA4096, EC256, EC384.", - "default_value": "RSA2048", - "immutable": true, - "optional": true - }, - { - "name": "version_custom_metadata", - "type": "TypeMap", - "description": "The secret version metadata that a user can customize.", + "name": "alt_names", + "type": "TypeList", + "description": "With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.", "immutable": true, "optional": true, + "computed": true, "elem": { "type": "TypeString" } @@ -140574,44 +146599,81 @@ "max_items": 1 }, { - "name": "created_at", + "name": "state_description", "type": "TypeString", - "description": "The date when a resource was created. The date format follows RFC 3339.", + "description": "A text representation of the secret state.", "computed": true }, { - "name": "signing_algorithm", + "name": "private_key", "type": "TypeString", - "description": "The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.", + "description": "(Optional) The PEM-encoded private key to associate with the certificate.", + "secure": true, "computed": true }, { - "name": "validity", + "name": "created_by", + "type": "TypeString", + "description": "The unique identifier that is associated with the entity that created the secret.", + "computed": true + }, + { + "name": "secret_id", + "type": "TypeString", + "description": "A v4 UUID identifier.", + "computed": true + }, + { + "name": "issuer", + "type": "TypeString", + "description": "The distinguished name that identifies the entity that signed and issued the certificate.", + "computed": true + }, + { + "name": "secret_group_id", + "type": "TypeString", + "description": "A v4 UUID identifier, or `default` secret group.", + "immutable": true, + "optional": true, + "computed": true + }, + { + "name": "key_algorithm", + "type": "TypeString", + "description": "The identifier for the cryptographic algorithm to be used to generate the public key that is associated with the certificate.The algorithm that you select determines the encryption algorithm (`RSA` or `ECDSA`) and key size to be used to generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to provide more encryption protection. Allowed values: RSA2048, RSA4096, EC256, EC384.", + "default_value": "RSA2048", + "immutable": true, + "optional": true + }, + { + "name": "rotation", "type": "TypeList", - "description": "The date and time that the certificate validity period begins and ends.", + "description": "Determines whether Secrets Manager rotates your secrets automatically.", + "optional": true, "computed": true, "elem": { - "not_after": { - "name": "not_after", - "type": "TypeString", - "description": "The date-time format follows RFC 3339.", + "auto_rotate": { + "name": "auto_rotate", + "type": "TypeBool", + "description": "Determines whether Secrets Manager rotates your secret automatically.Default is `false`. If `auto_rotate` is set to `true` the service rotates your certificate 31 days before it expires.", + "optional": true, "computed": true }, - "not_before": { - "name": "not_before", - "type": "TypeString", - "description": "The date-time format follows RFC 3339.", + "rotate_keys": { + "name": "rotate_keys", + "type": "TypeBool", + "description": "Determines whether Secrets Manager rotates the private key for your public certificate automatically.Default is `false`. If it is set to `true`, the service generates and stores a new private key for your rotated certificate.", + "optional": true, "computed": true } - } + }, + "max_items": 1 }, { - "name": "bundle_certs", - "type": "TypeBool", - "description": "Determines whether your issued certificate is bundled with intermediate certificates. Set to `false` for the certificate file to contain only the issued certificate.", - "default_value": true, - "immutable": true, - "optional": true + "name": "signing_algorithm", + "type": "TypeString", + "description": "The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.", + "computed": true }, { "name": "expiration_date", @@ -140708,45 +146770,23 @@ } }, { - "name": "issuer", - "type": "TypeString", - "description": "The distinguished name that identifies the entity that signed and issued the certificate.", - "computed": true - }, - { - "name": "state_description", + "name": "instance_id", "type": "TypeString", - "description": "A text representation of the secret state.", - "computed": true - }, - { - "name": "versions_total", - "type": "TypeInt", - "description": "The number of versions of the secret.", - "computed": true - }, - { - "name": "alt_names", - "type": "TypeList", - "description": "With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.", + "description": "The ID of the Secrets Manager instance.", + "cloud_data_type": "resource_instance", "immutable": true, - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "required": true }, { - "name": "ca", + "name": "endpoint_type", "type": "TypeString", - "description": "The name of the certificate authority configuration.", - "immutable": true, - "required": true + "description": "public or private.", + "optional": true }, { - "name": "dns", + "name": "common_name", "type": "TypeString", - "description": "The name of the DNS provider configuration.", + "description": "The Common Name (AKA CN) represents the server name that is protected by the SSL certificate.", "immutable": true, "required": true }, @@ -140758,85 +146798,84 @@ "computed": true }, { - "name": "secret_id", - "type": "TypeString", - "description": "A v4 UUID identifier.", + "name": "state", + "type": "TypeInt", + "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", "computed": true }, { - "name": "locks_total", - "type": "TypeInt", - "description": "The number of locks of the secret.", + "name": "region", + "type": "TypeString", + "description": "The region of the Secrets Manager instance.", + "cloud_data_type": "region", + "immutable": true, + "optional": true, "computed": true }, { - "name": "intermediate", + "name": "secret_type", "type": "TypeString", - "description": "(Optional) The PEM-encoded intermediate certificate to associate with the root certificate.", - "secure": true, + "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", "computed": true }, { - "name": "description", + "name": "name", "type": "TypeString", - "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", - "optional": true + "description": "A human-readable name to assign to your secret.To protect your privacy, do not use personal data, such as your name or location, as a name for your secret.", + "required": true }, { - "name": "rotation", + "name": "downloaded", + "type": "TypeBool", + "description": "Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", + "computed": true + }, + { + "name": "labels", "type": "TypeList", - "description": "Determines whether Secrets Manager rotates your secrets automatically.", + "description": "Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.", "optional": true, "computed": true, "elem": { - "auto_rotate": { - "name": "auto_rotate", - "type": "TypeBool", - "description": "Determines whether Secrets Manager rotates your secret automatically.Default is `false`. If `auto_rotate` is set to `true` the service rotates your certificate 31 days before it expires.", - "optional": true, - "computed": true - }, - "rotate_keys": { - "name": "rotate_keys", - "type": "TypeBool", - "description": "Determines whether Secrets Manager rotates the private key for your public certificate automatically.Default is `false`. If it is set to `true`, the service generates and stores a new private key for your rotated certificate.", - "optional": true, - "computed": true - } - }, - "max_items": 1 + "type": "TypeString" + } }, { - "name": "created_by", + "name": "created_at", "type": "TypeString", - "description": "The unique identifier that is associated with the entity that created the secret.", - "computed": true - }, - { - "name": "downloaded", - "type": "TypeBool", - "description": "Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", + "description": "The date when a resource was created. The date format follows RFC 3339.", "computed": true }, { - "name": "certificate", + "name": "serial_number", "type": "TypeString", - "description": "The PEM-encoded contents of your certificate.", - "secure": true, + "description": "The unique serial number that was assigned to a certificate by the issuing certificate authority.", "computed": true }, { - "name": "endpoint_type", - "type": "TypeString", - "description": "public or private.", - "optional": true + "name": "custom_metadata", + "type": "TypeMap", + "description": "The secret metadata that a user can customize.", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } }, { - "name": "secret_group_id", - "type": "TypeString", - "description": "A v4 UUID identifier, or `default` secret group.", + "name": "version_custom_metadata", + "type": "TypeMap", + "description": "The secret version metadata that a user can customize.", "immutable": true, "optional": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "locks_total", + "type": "TypeInt", + "description": "The number of locks of the secret.", "computed": true }, { @@ -140846,43 +146885,44 @@ "computed": true }, { - "name": "region", + "name": "intermediate", "type": "TypeString", - "description": "The region of the Secrets Manager instance.", - "cloud_data_type": "region", - "immutable": true, - "optional": true, + "description": "(Optional) The PEM-encoded intermediate certificate to associate with the root certificate.", + "secure": true, "computed": true }, { - "name": "labels", - "type": "TypeList", - "description": "Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "description", + "type": "TypeString", + "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", + "optional": true }, { - "name": "common_name", + "name": "dns", "type": "TypeString", - "description": "The Common Name (AKA CN) represents the server name that is protected by the SSL certificate.", + "description": "The name of the DNS provider configuration.", "immutable": true, "required": true }, { - "name": "custom_metadata", - "type": "TypeMap", - "description": "The secret metadata that a user can customize.", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "bundle_certs", + "type": "TypeBool", + "description": "Determines whether your issued certificate is bundled with intermediate certificates. Set to `false` for the certificate file to contain only the issued certificate.", + "default_value": true, + "immutable": true, + "optional": true } ], "ibm_sm_public_certificate_action_validate_manual_dns": [ + { + "name": "region", + "type": "TypeString", + "description": "The region of the Secrets Manager instance.", + "cloud_data_type": "region", + "immutable": true, + "optional": true, + "computed": true + }, { "name": "endpoint_type", "type": "TypeString", @@ -140903,25 +146943,9 @@ "cloud_data_type": "resource_instance", "immutable": true, "required": true - }, - { - "name": "region", - "type": "TypeString", - "description": "The region of the Secrets Manager instance.", - "cloud_data_type": "region", - "immutable": true, - "optional": true, - "computed": true } ], "ibm_sm_public_certificate_configuration_ca_lets_encrypt": [ - { - "name": "name", - "type": "TypeString", - "description": "A human-readable unique name to assign to your configuration.To protect your privacy, do not use personal data, such as your name or location, as an name for your secret.", - "immutable": true, - "required": true - }, { "name": "lets_encrypt_environment", "type": "TypeString", @@ -140969,16 +146993,16 @@ "type": "TypeString", "description": "public or private.", "optional": true - } - ], - "ibm_sm_public_certificate_configuration_dns_cis": [ + }, { "name": "name", "type": "TypeString", "description": "A human-readable unique name to assign to your configuration.To protect your privacy, do not use personal data, such as your name or location, as an name for your secret.", "immutable": true, "required": true - }, + } + ], + "ibm_sm_public_certificate_configuration_dns_cis": [ { "name": "created_by", "type": "TypeString", @@ -140986,16 +147010,21 @@ "computed": true }, { - "name": "updated_at", + "name": "created_at", "type": "TypeString", - "description": "The date when a resource was recently modified. The date format follows RFC 3339.", + "description": "The date when a resource was created. The date format follows RFC 3339.", "computed": true }, { - "name": "instance_id", + "name": "endpoint_type", "type": "TypeString", - "description": "The ID of the Secrets Manager instance.", - "cloud_data_type": "resource_instance", + "description": "public or private.", + "optional": true + }, + { + "name": "name", + "type": "TypeString", + "description": "A human-readable unique name to assign to your configuration.To protect your privacy, do not use personal data, such as your name or location, as an name for your secret.", "immutable": true, "required": true }, @@ -141005,15 +147034,6 @@ "description": "The configuration type.", "computed": true }, - { - "name": "cloud_internet_services_apikey", - "type": "TypeString", - "description": "An IBM Cloud API key that can to list domains in your Cloud Internet Services instance.To grant Secrets Manager the ability to view the Cloud Internet Services instance and all of its domains, the API key must be assigned the Reader service role on Internet Services (`internet-svcs`).If you need to manage specific domains, you can assign the Manager role. For production environments, it is recommended that you assign the Reader access role, and then use the[IAM Policy Management API](https://cloud.ibm.com/apidocs/iam-policy-management#create-policy) to control specific domains. For more information, see the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-prepare-order-certificates#authorize-specific-domains).", - "min_length": 4, - "max_length": 128, - "matches": "(.*?)", - "optional": true - }, { "name": "cloud_internet_services_crn", "type": "TypeString", @@ -141030,11 +147050,28 @@ "computed": true }, { - "name": "created_at", + "name": "cloud_internet_services_apikey", "type": "TypeString", - "description": "The date when a resource was created. The date format follows RFC 3339.", + "description": "An IBM Cloud API key that can to list domains in your Cloud Internet Services instance.To grant Secrets Manager the ability to view the Cloud Internet Services instance and all of its domains, the API key must be assigned the Reader service role on Internet Services (`internet-svcs`).If you need to manage specific domains, you can assign the Manager role. For production environments, it is recommended that you assign the Reader access role, and then use the[IAM Policy Management API](https://cloud.ibm.com/apidocs/iam-policy-management#create-policy) to control specific domains. For more information, see the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-prepare-order-certificates#authorize-specific-domains).", + "min_length": 4, + "max_length": 128, + "matches": "(.*?)", + "optional": true + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "The date when a resource was recently modified. The date format follows RFC 3339.", "computed": true }, + { + "name": "instance_id", + "type": "TypeString", + "description": "The ID of the Secrets Manager instance.", + "cloud_data_type": "resource_instance", + "immutable": true, + "required": true + }, { "name": "region", "type": "TypeString", @@ -141043,51 +147080,50 @@ "immutable": true, "optional": true, "computed": true - }, - { - "name": "endpoint_type", - "type": "TypeString", - "description": "public or private.", - "optional": true } ], "ibm_sm_public_certificate_configuration_dns_classic_infrastructure": [ { - "name": "created_at", + "name": "name", "type": "TypeString", - "description": "The date when a resource was created. The date format follows RFC 3339.", - "computed": true + "description": "A human-readable unique name to assign to your configuration.To protect your privacy, do not use personal data, such as your name or location, as an name for your secret.", + "immutable": true, + "required": true }, { - "name": "updated_at", + "name": "config_type", "type": "TypeString", - "description": "The date when a resource was recently modified. The date format follows RFC 3339.", + "description": "The configuration type.", "computed": true }, { - "name": "instance_id", + "name": "classic_infrastructure_username", "type": "TypeString", - "description": "The ID of the Secrets Manager instance.", - "cloud_data_type": "resource_instance", - "immutable": true, - "required": true + "description": "The username that is associated with your classic infrastructure account.In most cases, your classic infrastructure username is your `\u003caccount_id\u003e_\u003cemail_address\u003e`. For more information, see the [docs](https://cloud.ibm.com/docs/account?topic=account-classic_keys).", + "required": true, + "min_length": 2, + "max_length": 128, + "matches": "(.*?)" }, { - "name": "endpoint_type", + "name": "classic_infrastructure_password", "type": "TypeString", - "description": "public or private.", - "optional": true + "description": "Your classic infrastructure API key.For information about viewing and accessing your classic infrastructure API key, see the [docs](https://cloud.ibm.com/docs/account?topic=account-classic_keys).", + "required": true, + "min_length": 2, + "max_length": 128, + "matches": "(.*?)" }, { - "name": "config_type", + "name": "secret_type", "type": "TypeString", - "description": "The configuration type.", + "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", "computed": true }, { - "name": "secret_type", + "name": "updated_at", "type": "TypeString", - "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", + "description": "The date when a resource was recently modified. The date format follows RFC 3339.", "computed": true }, { @@ -141097,41 +147133,50 @@ "computed": true }, { - "name": "region", + "name": "created_at", "type": "TypeString", - "description": "The region of the Secrets Manager instance.", - "cloud_data_type": "region", - "immutable": true, - "optional": true, + "description": "The date when a resource was created. The date format follows RFC 3339.", "computed": true }, { - "name": "name", + "name": "instance_id", "type": "TypeString", - "description": "A human-readable unique name to assign to your configuration.To protect your privacy, do not use personal data, such as your name or location, as an name for your secret.", + "description": "The ID of the Secrets Manager instance.", + "cloud_data_type": "resource_instance", "immutable": true, "required": true }, { - "name": "classic_infrastructure_username", + "name": "region", "type": "TypeString", - "description": "The username that is associated with your classic infrastructure account.In most cases, your classic infrastructure username is your `\u003caccount_id\u003e_\u003cemail_address\u003e`. For more information, see the [docs](https://cloud.ibm.com/docs/account?topic=account-classic_keys).", - "required": true, - "min_length": 2, - "max_length": 128, - "matches": "(.*?)" + "description": "The region of the Secrets Manager instance.", + "cloud_data_type": "region", + "immutable": true, + "optional": true, + "computed": true }, { - "name": "classic_infrastructure_password", + "name": "endpoint_type", "type": "TypeString", - "description": "Your classic infrastructure API key.For information about viewing and accessing your classic infrastructure API key, see the [docs](https://cloud.ibm.com/docs/account?topic=account-classic_keys).", - "required": true, - "min_length": 2, - "max_length": 128, - "matches": "(.*?)" + "description": "public or private.", + "optional": true } ], "ibm_sm_secret_group": [ + { + "name": "description", + "type": "TypeString", + "description": "An extended description of your secret group.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", + "max_length": 1024, + "matches": "(.*?)", + "optional": true + }, + { + "name": "created_at", + "type": "TypeString", + "description": "The date that a resource was created. The date format follows RFC 3339.", + "computed": true + }, { "name": "updated_at", "type": "TypeString", @@ -141175,61 +147220,59 @@ "min_length": 2, "max_length": 64, "matches": "[A-Za-z0-9][A-Za-z0-9]*(?:_*-*\\\\.*[A-Za-z0-9]+)*$" - }, - { - "name": "description", - "type": "TypeString", - "description": "An extended description of your secret group.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", - "max_length": 1024, - "matches": "(.*?)", - "optional": true - }, - { - "name": "created_at", - "type": "TypeString", - "description": "The date that a resource was created. The date format follows RFC 3339.", - "computed": true } ], "ibm_sm_username_password_secret": [ { - "name": "description", - "type": "TypeString", - "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", - "optional": true - }, - { - "name": "secret_group_id", - "type": "TypeString", - "description": "A v4 UUID identifier, or `default` secret group.", - "immutable": true, - "optional": true, - "computed": true - }, - { - "name": "created_by", + "name": "secret_type", "type": "TypeString", - "description": "The unique identifier that is associated with the entity that created the secret.", + "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", "computed": true }, { - "name": "created_at", - "type": "TypeString", - "description": "The date when a resource was created. The date format follows RFC 3339.", - "computed": true + "name": "rotation", + "type": "TypeList", + "description": "Determines whether Secrets Manager rotates your secrets automatically.", + "optional": true, + "computed": true, + "elem": { + "auto_rotate": { + "name": "auto_rotate", + "type": "TypeBool", + "description": "Determines whether Secrets Manager rotates your secret automatically.Default is `false`. If `auto_rotate` is set to `true` the service rotates your secret based on the defined interval.", + "optional": true + }, + "interval": { + "name": "interval", + "type": "TypeInt", + "description": "The length of the secret rotation time interval.", + "optional": true, + "computed": true + }, + "unit": { + "name": "unit", + "type": "TypeString", + "description": "The units for the secret rotation time interval.", + "optional": true, + "computed": true + } + }, + "max_items": 1 }, { - "name": "state_description", + "name": "username", "type": "TypeString", - "description": "A text representation of the secret state.", - "computed": true + "description": "The username that is assigned to the secret.", + "immutable": true, + "required": true }, { - "name": "crn", + "name": "password", "type": "TypeString", - "description": "A CRN that uniquely identifies an IBM Cloud resource.", - "cloud_data_type": "crn", - "computed": true + "description": "The password that is assigned to the secret.", + "secure": true, + "immutable": true, + "required": true }, { "name": "locks_total", @@ -141238,20 +147281,16 @@ "computed": true }, { - "name": "state", - "type": "TypeInt", - "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", + "name": "next_rotation_date", + "type": "TypeString", + "description": "The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.", "computed": true }, { - "name": "custom_metadata", - "type": "TypeMap", - "description": "The secret metadata that a user can customize.", - "optional": true, - "computed": true, - "elem": { - "type": "TypeString" - } + "name": "expiration_date", + "type": "TypeString", + "description": "The date a secret is expired. The date format follows RFC 3339.", + "optional": true }, { "name": "name", @@ -141260,9 +147299,12 @@ "required": true }, { - "name": "secret_type", + "name": "region", "type": "TypeString", - "description": "The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.", + "description": "The region of the Secrets Manager instance.", + "cloud_data_type": "region", + "immutable": true, + "optional": true, "computed": true }, { @@ -141276,18 +147318,22 @@ } }, { - "name": "password", + "name": "created_at", "type": "TypeString", - "description": "The password that is assigned to the secret.", - "secure": true, - "immutable": true, - "required": true + "description": "The date when a resource was created. The date format follows RFC 3339.", + "computed": true }, { - "name": "updated_at", + "name": "endpoint_type", "type": "TypeString", - "description": "The date when a resource was recently modified. The date format follows RFC 3339.", - "computed": true + "description": "public or private.", + "optional": true + }, + { + "name": "description", + "type": "TypeString", + "description": "An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.", + "optional": true }, { "name": "secret_id", @@ -141296,48 +147342,54 @@ "computed": true }, { - "name": "rotation", - "type": "TypeList", - "description": "Determines whether Secrets Manager rotates your secrets automatically.", + "name": "downloaded", + "type": "TypeBool", + "description": "Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", + "computed": true + }, + { + "name": "versions_total", + "type": "TypeInt", + "description": "The number of versions of the secret.", + "computed": true + }, + { + "name": "secret_group_id", + "type": "TypeString", + "description": "A v4 UUID identifier, or `default` secret group.", + "immutable": true, "optional": true, - "computed": true, - "elem": { - "auto_rotate": { - "name": "auto_rotate", - "type": "TypeBool", - "description": "Determines whether Secrets Manager rotates your secret automatically.Default is `false`. If `auto_rotate` is set to `true` the service rotates your secret based on the defined interval.", - "optional": true - }, - "interval": { - "name": "interval", - "type": "TypeInt", - "description": "The length of the secret rotation time interval.", - "optional": true, - "computed": true - }, - "unit": { - "name": "unit", - "type": "TypeString", - "description": "The units for the secret rotation time interval.", - "optional": true, - "computed": true - } - }, - "max_items": 1 + "computed": true + }, + { + "name": "crn", + "type": "TypeString", + "description": "A CRN that uniquely identifies an IBM Cloud resource.", + "cloud_data_type": "crn", + "computed": true + }, + { + "name": "created_by", + "type": "TypeString", + "description": "The unique identifier that is associated with the entity that created the secret.", + "computed": true }, { - "name": "versions_total", + "name": "state", "type": "TypeInt", - "description": "The number of versions of the secret.", + "description": "The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", "computed": true }, { - "name": "region", + "name": "state_description", "type": "TypeString", - "description": "The region of the Secrets Manager instance.", - "cloud_data_type": "region", - "immutable": true, - "optional": true, + "description": "A text representation of the secret state.", + "computed": true + }, + { + "name": "updated_at", + "type": "TypeString", + "description": "The date when a resource was recently modified. The date format follows RFC 3339.", "computed": true }, { @@ -141349,16 +147401,14 @@ "required": true }, { - "name": "endpoint_type", - "type": "TypeString", - "description": "public or private.", - "optional": true - }, - { - "name": "expiration_date", - "type": "TypeString", - "description": "The date a secret is expired. The date format follows RFC 3339.", - "optional": true + "name": "custom_metadata", + "type": "TypeMap", + "description": "The secret metadata that a user can customize.", + "optional": true, + "computed": true, + "elem": { + "type": "TypeString" + } }, { "name": "labels", @@ -141369,37 +147419,9 @@ "elem": { "type": "TypeString" } - }, - { - "name": "username", - "type": "TypeString", - "description": "The username that is assigned to the secret.", - "immutable": true, - "required": true - }, - { - "name": "downloaded", - "type": "TypeBool", - "description": "Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", - "computed": true - }, - { - "name": "next_rotation_date", - "type": "TypeString", - "description": "The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.", - "computed": true } ], "ibm_space": [ - { - "name": "tags", - "type": "TypeSet", - "cloud_data_type": "tags", - "optional": true, - "elem": { - "type": "TypeString" - } - }, { "name": "name", "type": "TypeString", @@ -141446,74 +147468,108 @@ "description": "The name of the Space Quota Definition", "immutable": true, "optional": true + }, + { + "name": "tags", + "type": "TypeSet", + "cloud_data_type": "tags", + "optional": true, + "elem": { + "type": "TypeString" + } } ], "ibm_ssl_certificate": [ { - "name": "server_count", - "type": "TypeInt", - "description": "Server count", - "required": true + "name": "technical_contact_same_as_org_address_flag", + "type": "TypeBool", + "description": "Technical contact same as org address flag", + "default_value": false, + "optional": true }, { - "name": "organization_information", + "name": "administrative_address_same_as_organization_flag", + "type": "TypeBool", + "description": "administrative address same as organization flag", + "default_value": false, + "optional": true + }, + { + "name": "technical_contact", "type": "TypeSet", - "description": "Organization information", + "description": "Technical contact info", "required": true, "elem": { - "org_address": { - "name": "org_address", + "tech_address": { + "name": "tech_address", "type": "TypeSet", - "description": "Organization address", - "required": true, + "optional": true, "elem": { - "org_address_line1": { - "name": "org_address_line1", + "tech_address_line1": { + "name": "tech_address_line1", "type": "TypeString", - "required": true + "optional": true }, - "org_address_line2": { - "name": "org_address_line2", + "tech_address_line2": { + "name": "tech_address_line2", "type": "TypeString", "optional": true }, - "org_city": { - "name": "org_city", + "tech_city": { + "name": "tech_city", "type": "TypeString", - "required": true + "optional": true }, - "org_country_code": { - "name": "org_country_code", + "tech_country_code": { + "name": "tech_country_code", "type": "TypeString", - "required": true + "optional": true }, - "org_postal_code": { - "name": "org_postal_code", + "tech_postal_code": { + "name": "tech_postal_code", "type": "TypeString", - "required": true + "optional": true }, - "org_state": { - "name": "org_state", + "tech_state": { + "name": "tech_state", "type": "TypeString", - "required": true + "optional": true } } }, - "org_fax_number": { - "name": "org_fax_number", + "tech_email_address": { + "name": "tech_email_address", + "type": "TypeString", + "required": true + }, + "tech_fax_number": { + "name": "tech_fax_number", "type": "TypeString", "optional": true }, - "org_organization_name": { - "name": "org_organization_name", + "tech_first_name": { + "name": "tech_first_name", "type": "TypeString", - "description": "Organization name", "required": true }, - "org_phone_number": { - "name": "org_phone_number", + "tech_last_name": { + "name": "tech_last_name", + "type": "TypeString", + "required": true + }, + "tech_organization_name": { + "name": "tech_organization_name", + "type": "TypeString", + "required": true + }, + "tech_phone_number": { + "name": "tech_phone_number", + "type": "TypeString", + "required": true + }, + "tech_title": { + "name": "tech_title", "type": "TypeString", - "description": "Organization phone number", "required": true } }, @@ -141601,9 +147657,41 @@ "max_items": 1 }, { - "name": "server_type", + "name": "administrative_contact_same_as_technical_flag", + "type": "TypeBool", + "description": "Administrative contact same as technical flag", + "default_value": false, + "optional": true + }, + { + "name": "billing_contact_same_as_technical_flag", + "type": "TypeBool", + "description": "billing contact", + "default_value": false, + "optional": true + }, + { + "name": "server_count", + "type": "TypeInt", + "description": "Server count", + "required": true + }, + { + "name": "ssl_type", "type": "TypeString", - "description": "server type", + "description": "ssl type", + "required": true + }, + { + "name": "certificate_signing_request", + "type": "TypeString", + "description": "certificate signing request info", + "required": true + }, + { + "name": "order_approver_email_address", + "type": "TypeString", + "description": "Email address of the approver", "required": true }, { @@ -141694,18 +147782,10 @@ "max_items": 1 }, { - "name": "technical_contact_same_as_org_address_flag", - "type": "TypeBool", - "description": "Technical contact same as org address flag", - "default_value": false, - "optional": true - }, - { - "name": "administrative_contact_same_as_technical_flag", - "type": "TypeBool", - "description": "Administrative contact same as technical flag", - "default_value": false, - "optional": true + "name": "server_type", + "type": "TypeString", + "description": "server type", + "required": true }, { "name": "validity_months", @@ -141721,172 +147801,116 @@ "optional": true }, { - "name": "order_approver_email_address", - "type": "TypeString", - "description": "Email address of the approver", - "required": true - }, - { - "name": "administrative_address_same_as_organization_flag", - "type": "TypeBool", - "description": "administrative address same as organization flag", - "default_value": false, - "optional": true - }, - { - "name": "technical_contact", + "name": "organization_information", "type": "TypeSet", - "description": "Technical contact info", + "description": "Organization information", "required": true, "elem": { - "tech_address": { - "name": "tech_address", + "org_address": { + "name": "org_address", "type": "TypeSet", - "optional": true, + "description": "Organization address", + "required": true, "elem": { - "tech_address_line1": { - "name": "tech_address_line1", + "org_address_line1": { + "name": "org_address_line1", "type": "TypeString", - "optional": true + "required": true }, - "tech_address_line2": { - "name": "tech_address_line2", + "org_address_line2": { + "name": "org_address_line2", "type": "TypeString", "optional": true }, - "tech_city": { - "name": "tech_city", + "org_city": { + "name": "org_city", "type": "TypeString", - "optional": true + "required": true }, - "tech_country_code": { - "name": "tech_country_code", + "org_country_code": { + "name": "org_country_code", "type": "TypeString", - "optional": true + "required": true }, - "tech_postal_code": { - "name": "tech_postal_code", + "org_postal_code": { + "name": "org_postal_code", "type": "TypeString", - "optional": true + "required": true }, - "tech_state": { - "name": "tech_state", + "org_state": { + "name": "org_state", "type": "TypeString", - "optional": true + "required": true } } }, - "tech_email_address": { - "name": "tech_email_address", - "type": "TypeString", - "required": true - }, - "tech_fax_number": { - "name": "tech_fax_number", + "org_fax_number": { + "name": "org_fax_number", "type": "TypeString", "optional": true }, - "tech_first_name": { - "name": "tech_first_name", - "type": "TypeString", - "required": true - }, - "tech_last_name": { - "name": "tech_last_name", - "type": "TypeString", - "required": true - }, - "tech_organization_name": { - "name": "tech_organization_name", - "type": "TypeString", - "required": true - }, - "tech_phone_number": { - "name": "tech_phone_number", + "org_organization_name": { + "name": "org_organization_name", "type": "TypeString", + "description": "Organization name", "required": true }, - "tech_title": { - "name": "tech_title", + "org_phone_number": { + "name": "org_phone_number", "type": "TypeString", + "description": "Organization phone number", "required": true } }, "max_items": 1 - }, - { - "name": "ssl_type", - "type": "TypeString", - "description": "ssl type", - "required": true - }, - { - "name": "certificate_signing_request", - "type": "TypeString", - "description": "certificate signing request info", - "required": true - }, - { - "name": "billing_contact_same_as_technical_flag", - "type": "TypeBool", - "description": "billing contact", - "default_value": false, - "optional": true } ], "ibm_storage_block": [ { - "name": "capacity", - "type": "TypeInt", - "description": "Storage block size", - "required": true - }, - { - "name": "iops", - "type": "TypeFloat", - "description": "IOPS value required", - "required": true - }, - { - "name": "resource_name", - "type": "TypeString", - "description": "The name of the resource", - "computed": true + "name": "allowed_virtual_guest_ids", + "type": "TypeSet", + "description": "List of allowed virtual guest IDs", + "optional": true, + "computed": true, + "elem": { + "type": "TypeInt" + } }, { - "name": "allowed_ip_addresses", + "name": "tags", "type": "TypeSet", - "description": "Allowed IP addresses", + "description": "List of tags associated with the resource", + "cloud_data_type": "tags", "optional": true, "elem": { "type": "TypeString" } }, { - "name": "datacenter", - "type": "TypeString", - "description": "Datacenter name", + "name": "hourly_billing", + "type": "TypeBool", + "description": "Billing done hourly, if set to true", + "default_value": false, "immutable": true, - "required": true + "optional": true }, { - "name": "hostname", + "name": "resource_controller_url", "type": "TypeString", - "description": "Hostname", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", "computed": true }, { - "name": "os_format_type", - "type": "TypeString", - "description": "OS formatr type", - "immutable": true, + "name": "capacity", + "type": "TypeInt", + "description": "Storage block size", "required": true }, { - "name": "notes", + "name": "lunid", "type": "TypeString", - "description": "Additional note info", - "optional": true + "description": "LUN Id", + "computed": true }, { "name": "allowed_virtual_guest_info", @@ -141917,8 +147941,8 @@ "deprecated": "Please use 'allowed_host_info' instead" }, { - "name": "allowed_hardware_info", - "type": "TypeSet", + "name": "allowed_host_info", + "type": "TypeList", "computed": true, "elem": { "host_iqn": { @@ -141941,26 +147965,58 @@ "type": "TypeString", "computed": true } - }, - "deprecated": "Please use 'allowed_host_info' instead" + } }, { - "name": "tags", + "name": "target_address", + "type": "TypeList", + "description": "List of target Addresses", + "computed": true, + "elem": { + "type": "TypeString" + } + }, + { + "name": "type", + "type": "TypeString", + "description": "Storage block type", + "immutable": true, + "required": true + }, + { + "name": "iops", + "type": "TypeFloat", + "description": "IOPS value required", + "required": true + }, + { + "name": "snapshot_capacity", + "type": "TypeInt", + "description": "Snapshot capacity in GB", + "immutable": true, + "optional": true + }, + { + "name": "allowed_ip_addresses", "type": "TypeSet", - "description": "List of tags associated with the resource", - "cloud_data_type": "tags", + "description": "Allowed IP addresses", "optional": true, "elem": { "type": "TypeString" } }, { - "name": "hourly_billing", - "type": "TypeBool", - "description": "Billing done hourly, if set to true", - "default_value": false, + "name": "resource_name", + "type": "TypeString", + "description": "The name of the resource", + "computed": true + }, + { + "name": "datacenter", + "type": "TypeString", + "description": "Datacenter name", "immutable": true, - "optional": true + "required": true }, { "name": "volumename", @@ -141969,21 +148025,37 @@ "computed": true }, { - "name": "lunid", + "name": "hostname", "type": "TypeString", - "description": "LUN Id", + "description": "Hostname", "computed": true }, { - "name": "snapshot_capacity", - "type": "TypeInt", - "description": "Snapshot capacity in GB", + "name": "os_format_type", + "type": "TypeString", + "description": "OS formatr type", "immutable": true, + "required": true + }, + { + "name": "notes", + "type": "TypeString", + "description": "Additional note info", "optional": true }, { - "name": "allowed_host_info", - "type": "TypeList", + "name": "allowed_hardware_ids", + "type": "TypeSet", + "description": "List of allowe hardware IDs", + "optional": true, + "computed": true, + "elem": { + "type": "TypeInt" + } + }, + { + "name": "allowed_hardware_info", + "type": "TypeSet", "computed": true, "elem": { "host_iqn": { @@ -142006,65 +148078,11 @@ "type": "TypeString", "computed": true } - } - }, - { - "name": "resource_controller_url", - "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", - "computed": true - }, - { - "name": "target_address", - "type": "TypeList", - "description": "List of target Addresses", - "computed": true, - "elem": { - "type": "TypeString" - } - }, - { - "name": "type", - "type": "TypeString", - "description": "Storage block type", - "immutable": true, - "required": true - }, - { - "name": "allowed_virtual_guest_ids", - "type": "TypeSet", - "description": "List of allowed virtual guest IDs", - "optional": true, - "computed": true, - "elem": { - "type": "TypeInt" - } - }, - { - "name": "allowed_hardware_ids", - "type": "TypeSet", - "description": "List of allowe hardware IDs", - "optional": true, - "computed": true, - "elem": { - "type": "TypeInt" - } + }, + "deprecated": "Please use 'allowed_host_info' instead" } ], "ibm_storage_evault": [ - { - "name": "hardware_instance_id", - "type": "TypeInt", - "description": "Hardware instance ID", - "immutable": true, - "optional": true - }, - { - "name": "username", - "type": "TypeString", - "description": "user name", - "computed": true - }, { "name": "password", "type": "TypeString", @@ -142107,15 +148125,22 @@ "description": "Virtual instance ID", "immutable": true, "optional": true - } - ], - "ibm_storage_file": [ + }, { - "name": "resource_status", + "name": "hardware_instance_id", + "type": "TypeInt", + "description": "Hardware instance ID", + "immutable": true, + "optional": true + }, + { + "name": "username", "type": "TypeString", - "description": "The status of the resource", + "description": "user name", "computed": true - }, + } + ], + "ibm_storage_file": [ { "name": "type", "type": "TypeString", @@ -142124,26 +148149,10 @@ "required": true }, { - "name": "capacity", - "type": "TypeInt", - "description": "Storage capacity", - "required": true - }, - { - "name": "iops", - "type": "TypeFloat", - "description": "iops rate", - "required": true - }, - { - "name": "allowed_virtual_guest_ids", - "type": "TypeSet", - "description": "Virtual guest ID", - "optional": true, - "computed": true, - "elem": { - "type": "TypeInt" - } + "name": "volumename", + "type": "TypeString", + "description": "Storage volume name", + "computed": true }, { "name": "allowed_subnets", @@ -142155,13 +148164,10 @@ } }, { - "name": "allowed_ip_addresses", - "type": "TypeSet", - "description": "Allowed range of IP addresses", - "optional": true, - "elem": { - "type": "TypeString" - } + "name": "notes", + "type": "TypeString", + "description": "Notes", + "optional": true }, { "name": "snapshot_schedule", @@ -142206,6 +148212,22 @@ }, "max_items": 3 }, + { + "name": "resource_controller_url", + "type": "TypeString", + "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", + "computed": true + }, + { + "name": "tags", + "type": "TypeSet", + "description": "Tags set for the storage volume", + "cloud_data_type": "tags", + "optional": true, + "elem": { + "type": "TypeString" + } + }, { "name": "hourly_billing", "type": "TypeBool", @@ -142215,22 +148237,34 @@ "optional": true }, { - "name": "resource_controller_url", + "name": "datacenter", "type": "TypeString", - "description": "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance", - "computed": true + "description": "Datacenter name", + "immutable": true, + "required": true }, { - "name": "volumename", - "type": "TypeString", - "description": "Storage volume name", - "computed": true + "name": "iops", + "type": "TypeFloat", + "description": "iops rate", + "required": true }, { - "name": "hostname", - "type": "TypeString", - "description": "Hostname", - "computed": true + "name": "snapshot_capacity", + "type": "TypeInt", + "description": "Snapshot capacity", + "immutable": true, + "optional": true + }, + { + "name": "allowed_virtual_guest_ids", + "type": "TypeSet", + "description": "Virtual guest ID", + "optional": true, + "computed": true, + "elem": { + "type": "TypeInt" + } }, { "name": "allowed_hardware_ids", @@ -142249,43 +148283,53 @@ "computed": true }, { - "name": "resource_name", - "type": "TypeString", - "description": "The name of the resource", - "computed": true - }, - { - "name": "datacenter", - "type": "TypeString", - "description": "Datacenter name", - "immutable": true, - "required": true - }, - { - "name": "snapshot_capacity", + "name": "capacity", "type": "TypeInt", - "description": "Snapshot capacity", - "immutable": true, - "optional": true + "description": "Storage capacity", + "required": true }, { - "name": "notes", + "name": "hostname", "type": "TypeString", - "description": "Notes", - "optional": true + "description": "Hostname", + "computed": true }, { - "name": "tags", + "name": "allowed_ip_addresses", "type": "TypeSet", - "description": "Tags set for the storage volume", - "cloud_data_type": "tags", + "description": "Allowed range of IP addresses", "optional": true, "elem": { "type": "TypeString" } + }, + { + "name": "resource_name", + "type": "TypeString", + "description": "The name of the resource", + "computed": true + }, + { + "name": "resource_status", + "type": "TypeString", + "description": "The status of the resource", + "computed": true } ], "ibm_subnet": [ + { + "name": "endpoint_ip", + "type": "TypeString", + "description": "endpoint IP", + "immutable": true, + "optional": true + }, + { + "name": "subnet_cidr", + "type": "TypeString", + "description": "CIDR notation for the subnet", + "computed": true + }, { "name": "notes", "type": "TypeString", @@ -142293,14 +148337,12 @@ "optional": true }, { - "name": "tags", - "type": "TypeSet", - "description": "tags set for the resource", - "cloud_data_type": "tags", - "optional": true, - "elem": { - "type": "TypeString" - } + "name": "private", + "type": "TypeBool", + "description": "private subnet", + "default_value": false, + "immutable": true, + "optional": true }, { "name": "ip_version", @@ -142310,12 +148352,6 @@ "immutable": true, "optional": true }, - { - "name": "subnet_cidr", - "type": "TypeString", - "description": "CIDR notation for the subnet", - "computed": true - }, { "name": "capacity", "type": "TypeInt", @@ -142332,19 +148368,14 @@ "computed": true }, { - "name": "endpoint_ip", - "type": "TypeString", - "description": "endpoint IP", - "immutable": true, - "optional": true - }, - { - "name": "private", - "type": "TypeBool", - "description": "private subnet", - "default_value": false, - "immutable": true, - "optional": true + "name": "tags", + "type": "TypeSet", + "description": "tags set for the resource", + "cloud_data_type": "tags", + "optional": true, + "elem": { + "type": "TypeString" + } }, { "name": "type", @@ -142356,67 +148387,62 @@ ], "ibm_tg_connection": [ { - "name": "base_network_type", - "type": "TypeString", - "description": "The type of network the unbound gre tunnel is targeting. This field is required for network type 'unbound_gre_tunnel'.", - "optional": true, - "computed": true - }, - { - "name": "updated_at", + "name": "created_at", "type": "TypeString", - "description": "The date and time that this connection was last updated", + "description": "The date and time that this connection was created", "computed": true }, { - "name": "request_status", + "name": "status", "type": "TypeString", - "description": "Only visible for cross account connections, this field represents the status of the request to connect the given network between accounts.Possible values: [pending,approved,rejected,expired,detached]", + "description": "What is the current configuration state of this connection. Possible values: [attached,failed,pending,deleting,detaching,detached]", "computed": true }, { - "name": "created_at", + "name": "base_network_type", "type": "TypeString", - "description": "The date and time that this connection was created", + "description": "The type of network the unbound gre tunnel is targeting. This field is required for network type 'unbound_gre_tunnel'.", + "optional": true, "computed": true }, { - "name": "connection_id", + "name": "local_tunnel_ip", "type": "TypeString", - "description": "The Transit Gateway Connection identifier", + "description": "The local tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.", + "immutable": true, + "optional": true, "computed": true }, { - "name": "network_type", + "name": "remote_gateway_ip", "type": "TypeString", - "description": "Defines what type of network is connected via this connection. Allowable values (classic,directlink,vpc,gre_tunnel,unbound_gre_tunnel,power_virtual_server)", + "description": "The remote gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.", "immutable": true, - "required": true, - "options": "classic, directlink, vpc, gre_tunnel, unbound_gre_tunnel, power_virtual_server" + "optional": true, + "computed": true }, { - "name": "local_gateway_ip", + "name": "network_account_id", "type": "TypeString", - "description": "The local gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.", + "description": "The ID of the account which owns the network that is being connected. Generally only used if the network is in a different account than the gateway. This field is required for type 'unbound_gre_tunnel' when the associated_network_type is 'classic' and the GRE tunnel is in a different account than the gateway.", "immutable": true, "optional": true, "computed": true }, { - "name": "local_tunnel_ip", + "name": "remote_tunnel_ip", "type": "TypeString", - "description": "The local tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.", + "description": "The remote tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.", "immutable": true, "optional": true, "computed": true }, { - "name": "remote_gateway_ip", + "name": "gateway", "type": "TypeString", - "description": "The remote gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.", + "description": "The Transit Gateway identifier", "immutable": true, - "optional": true, - "computed": true + "required": true }, { "name": "name", @@ -142428,9 +148454,11 @@ "optional": true }, { - "name": "status", + "name": "network_id", "type": "TypeString", - "description": "What is the current configuration state of this connection. Possible values: [attached,failed,pending,deleting,detaching,detached]", + "description": "The ID of the network being connected via this connection. This field is required for some types, such as 'vpc' or 'directlink' or 'power_virtual_server'. The value of this is the CRN of the VPC or direct link or power_virtual_server gateway to be connected. This field is required to be unspecified for network type 'classic', 'gre_tunnel', and 'unbound_gre_tunnel'.", + "immutable": true, + "optional": true, "computed": true }, { @@ -142440,62 +148468,73 @@ "computed": true }, { - "name": "remote_tunnel_ip", + "name": "base_connection_id", "type": "TypeString", - "description": "The remote tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.", + "description": "The ID of a network_type 'classic' connection a tunnel is configured over. This field only applies to network type 'gre_tunnel' connections.", "immutable": true, "optional": true, "computed": true }, { - "name": "zone", + "name": "local_gateway_ip", "type": "TypeString", - "description": "Location of GRE tunnel. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.", + "description": "The local gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.", "immutable": true, "optional": true, "computed": true }, { - "name": "gateway", - "type": "TypeString", - "description": "The Transit Gateway identifier", + "name": "remote_bgp_asn", + "type": "TypeInt", + "description": "The remote network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.", "immutable": true, - "required": true + "optional": true, + "computed": true }, { - "name": "network_id", + "name": "updated_at", "type": "TypeString", - "description": "The ID of the network being connected via this connection. This field is required for some types, such as 'vpc' or 'directlink' or 'power_virtual_server'. The value of this is the CRN of the VPC or direct link or power_virtual_server gateway to be connected. This field is required to be unspecified for network type 'classic', 'gre_tunnel', and 'unbound_gre_tunnel'.", - "immutable": true, - "optional": true, + "description": "The date and time that this connection was last updated", "computed": true }, { - "name": "network_account_id", + "name": "request_status", "type": "TypeString", - "description": "The ID of the account which owns the network that is being connected. Generally only used if the network is in a different account than the gateway. This field is required for type 'unbound_gre_tunnel' when the associated_network_type is 'classic' and the GRE tunnel is in a different account than the gateway.", - "immutable": true, - "optional": true, + "description": "Only visible for cross account connections, this field represents the status of the request to connect the given network between accounts.Possible values: [pending,approved,rejected,expired,detached]", "computed": true }, { - "name": "base_connection_id", + "name": "connection_id", "type": "TypeString", - "description": "The ID of a network_type 'classic' connection a tunnel is configured over. This field only applies to network type 'gre_tunnel' connections.", - "immutable": true, - "optional": true, + "description": "The Transit Gateway Connection identifier", "computed": true }, { - "name": "remote_bgp_asn", - "type": "TypeInt", - "description": "The remote network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.", + "name": "network_type", + "type": "TypeString", + "description": "Defines what type of network is connected via this connection. Allowable values (classic,directlink,vpc,gre_tunnel,unbound_gre_tunnel,power_virtual_server)", + "immutable": true, + "required": true, + "options": "classic, directlink, vpc, gre_tunnel, unbound_gre_tunnel, power_virtual_server" + }, + { + "name": "zone", + "type": "TypeString", + "description": "Location of GRE tunnel. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.", "immutable": true, "optional": true, "computed": true } ], "ibm_tg_connection_action": [ + { + "name": "action", + "type": "TypeString", + "description": "The Transit Gateway Connection cross account action", + "immutable": true, + "required": true, + "options": "approve, reject" + }, { "name": "gateway", "type": "TypeString", @@ -142509,23 +148548,9 @@ "description": "The Transit Gateway Connection identifier", "immutable": true, "required": true - }, - { - "name": "action", - "type": "TypeString", - "description": "The Transit Gateway Connection cross account action", - "immutable": true, - "required": true, - "options": "approve, reject" } ], "ibm_tg_connection_prefix_filter": [ - { - "name": "le", - "type": "TypeInt", - "description": "IP Prefix LE", - "optional": true - }, { "name": "prefix", "type": "TypeString", @@ -142533,24 +148558,23 @@ "required": true }, { - "name": "updated_at", + "name": "created_at", "type": "TypeString", - "description": "The date and time that this prefix filter was last updated", + "description": "The date and time that this prefix filter was created", "computed": true }, - { - "name": "gateway", - "type": "TypeString", - "description": "The Transit Gateway identifier", - "immutable": true, - "required": true - }, { "name": "ge", "type": "TypeInt", "description": "IP Prefix GE", "optional": true }, + { + "name": "le", + "type": "TypeInt", + "description": "IP Prefix LE", + "optional": true + }, { "name": "action", "type": "TypeString", @@ -142565,11 +148589,18 @@ "optional": true }, { - "name": "created_at", + "name": "updated_at", "type": "TypeString", - "description": "The date and time that this prefix filter was created", + "description": "The date and time that this prefix filter was last updated", "computed": true }, + { + "name": "gateway", + "type": "TypeString", + "description": "The Transit Gateway identifier", + "immutable": true, + "required": true + }, { "name": "connection_id", "type": "TypeString", @@ -142584,19 +148615,6 @@ } ], "ibm_tg_gateway": [ - { - "name": "resource_status", - "type": "TypeString", - "description": "The status of the resource", - "computed": true - }, - { - "name": "crn", - "type": "TypeString", - "description": "The crn of the resource", - "cloud_data_type": "crn", - "computed": true - }, { "name": "created_at", "type": "TypeString", @@ -142604,20 +148622,11 @@ "computed": true }, { - "name": "status", + "name": "updated_at", "type": "TypeString", - "description": "The Status of the resource", + "description": "The updation time of the resource", "computed": true }, - { - "name": "name", - "type": "TypeString", - "description": "Name Transit Gateway Services", - "required": true, - "options": "^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$}", - "min_length": 1, - "max_length": 63 - }, { "name": "tags", "type": "TypeSet", @@ -142639,15 +148648,22 @@ "computed": true }, { - "name": "resource_name", + "name": "crn", "type": "TypeString", - "description": "The name of the resource", + "description": "The crn of the resource", + "cloud_data_type": "crn", "computed": true }, { - "name": "resource_group_name", + "name": "resource_crn", "type": "TypeString", - "description": "The resource group name in which resource is provisioned", + "description": "The crn of the resource", + "computed": true + }, + { + "name": "resource_status", + "type": "TypeString", + "description": "The status of the resource", "computed": true }, { @@ -142658,6 +148674,15 @@ "immutable": true, "required": true }, + { + "name": "name", + "type": "TypeString", + "description": "Name Transit Gateway Services", + "required": true, + "options": "^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$}", + "min_length": 1, + "max_length": 63 + }, { "name": "global", "type": "TypeBool", @@ -142666,9 +148691,15 @@ "optional": true }, { - "name": "updated_at", + "name": "resource_group_name", "type": "TypeString", - "description": "The updation time of the resource", + "description": "The resource group name in which resource is provisioned", + "computed": true + }, + { + "name": "status", + "type": "TypeString", + "description": "The Status of the resource", "computed": true }, { @@ -142678,49 +148709,13 @@ "computed": true }, { - "name": "resource_crn", + "name": "resource_name", "type": "TypeString", - "description": "The crn of the resource", + "description": "The name of the resource", "computed": true } ], "ibm_tg_route_report": [ - { - "name": "created_at", - "type": "TypeString", - "computed": true - }, - { - "name": "overlapping_routes", - "type": "TypeList", - "description": "Collection of transit gateway overlapping routes", - "computed": true, - "elem": { - "routes": { - "name": "routes", - "type": "TypeList", - "description": "Collection of transit gateway overlapping route's details", - "computed": true, - "elem": { - "connection_id": { - "name": "connection_id", - "type": "TypeString", - "computed": true - }, - "prefix": { - "name": "prefix", - "type": "TypeString", - "computed": true - } - } - } - } - }, - { - "name": "status", - "type": "TypeString", - "computed": true - }, { "name": "updated_at", "type": "TypeString", @@ -142802,8 +148797,44 @@ "computed": true } } + }, + { + "name": "created_at", + "type": "TypeString", + "computed": true + }, + { + "name": "overlapping_routes", + "type": "TypeList", + "description": "Collection of transit gateway overlapping routes", + "computed": true, + "elem": { + "routes": { + "name": "routes", + "type": "TypeList", + "description": "Collection of transit gateway overlapping route's details", + "computed": true, + "elem": { + "connection_id": { + "name": "connection_id", + "type": "TypeString", + "computed": true + }, + "prefix": { + "name": "prefix", + "type": "TypeString", + "computed": true + } + } + } + } + }, + { + "name": "status", + "type": "TypeString", + "computed": true } ] }, - "Version": "1.57.0" + "Version": "1.58.0" } \ No newline at end of file diff --git a/version/version.go b/version/version.go index 29bdb4ea4d..3fc06faa13 100644 --- a/version/version.go +++ b/version/version.go @@ -5,7 +5,7 @@ import ( ) // Version is the current provider main version -const Version = "1.57.0" +const Version = "1.58.1" // GitCommit is the git commit that was compiled. This will be filled in by the compiler. var GitCommit string diff --git a/website/allowed-subcategories.txt b/website/allowed-subcategories.txt index 21cbcd0eca..1e97423139 100644 --- a/website/allowed-subcategories.txt +++ b/website/allowed-subcategories.txt @@ -36,4 +36,5 @@ Schematics Secrets Manager Security and Compliance Center Transit Gateway +Usage Reports VPC infrastructure diff --git a/website/docs/d/atracker_routes.html.markdown b/website/docs/d/atracker_routes.html.markdown index 8d871d9580..a451160ec4 100644 --- a/website/docs/d/atracker_routes.html.markdown +++ b/website/docs/d/atracker_routes.html.markdown @@ -8,7 +8,7 @@ subcategory: "Activity Tracker" # ibm_atracker_routes -Provides a read-only data source for atracker_routes. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax. +Provides a read-only data source to retrieve information about atracker_routes. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax. ## Example Usage diff --git a/website/docs/d/atracker_targets.html.markdown b/website/docs/d/atracker_targets.html.markdown index 7c63ee8d0d..2ff868251b 100644 --- a/website/docs/d/atracker_targets.html.markdown +++ b/website/docs/d/atracker_targets.html.markdown @@ -8,7 +8,7 @@ subcategory: "Activity Tracker" # ibm_atracker_targets -Provides a read-only data source for atracker_targets. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax. +Provides a read-only data source to retrieve information about atracker_targets. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax. ## Example usage diff --git a/website/docs/d/billing_snapshot_list.html.markdown b/website/docs/d/billing_snapshot_list.html.markdown new file mode 100644 index 0000000000..7182d6af60 --- /dev/null +++ b/website/docs/d/billing_snapshot_list.html.markdown @@ -0,0 +1,79 @@ +--- +layout: "ibm" +page_title: "IBM : ibm_billing_snapshot_list" +description: |- + Get information about billing_snapshot_list +subcategory: "Usage Reports" +--- + +# ibm_billing_snapshot_list + +Provides a read-only data source to retrieve information about a billing_snapshot_list. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax. + +## Example Usage + +```hcl +data "ibm_billing_snapshot_list" "billing_snapshot_list" { + date_from = 1675209600000 + date_to = 1675987200000 + month = "2023-02" +} +``` + +## Argument Reference + +You can specify the following arguments for this data source. + +* `date_from` - (Optional, Integer) Timestamp in milliseconds for which billing report snapshot is requested. +* `date_to` - (Optional, Integer) Timestamp in milliseconds for which billing report snapshot is requested. +* `month` - (Required, String) The month for which billing report snapshot is requested. Format is yyyy-mm. + +## Attribute Reference + +After your data source is created, you can read values from the following attributes. + +* `id` - The unique identifier of the billing_snapshot_list. +* `count` - (Integer) Number of total snapshots. + +* `first` - (List) Reference to the first page of the search query. +Nested schema for **first**: + * `href` - (String) + +* `next` - (List) Reference to the next page of the search query if any. +Nested schema for **next**: + * `href` - (String) + +* `snapshots` - (List) +Nested schema for **snapshots**: + * `account_id` - (String) Account ID for which billing report snapshot is configured. + * `account_type` - (String) Type of account. Possible values are [enterprise, account]. + * Constraints: Allowable values are: `account`, `enterprise`. + * `billing_period` - (List) Period of billing in snapshot. + Nested schema for **billing_period**: + * `end` - (String) Date and time of end of billing in the respective snapshot. + * `start` - (String) Date and time of start of billing in the respective snapshot. + * `bucket` - (String) The name of the COS bucket to store the snapshot of the billing reports. + * `charset` - (String) Character encoding used. + * `compression` - (String) Compression format of the snapshot report. + * `content_type` - (String) Type of content stored in snapshot report. + * `created_on` - (String) Date and time of creation of snapshot. + * `expected_processed_at` - (Integer) Timestamp of snapshot processed. + * `files` - (List) List of location of reports. + Nested schema for **files**: + * `account_id` - (String) Account ID for which billing report is captured. + * `location` - (String) Absolute path of the billing report in the COS instance. + * `report_types` - (String) The type of billing report stored. Possible values are [account_summary, enterprise_summary, account_resource_instance_usage]. + * Constraints: Allowable values are: `account_summary`, `enterprise_summary`, `account_resource_instance_usage`. + * `month` - (String) Month of captured snapshot. + * Constraints: The value must match regular expression `/^\\d{4}\\-(0?[1-9]|1[012])$/`. + * `processed_at` - (Integer) Timestamp at which snapshot is captured. + * `report_types` - (List) List of report types configured for the snapshot. + Nested schema for **report_types**: + * `type` - (String) The type of billing report of the snapshot. Possible values are [account_summary, enterprise_summary, account_resource_instance_usage]. + * Constraints: Allowable values are: `account_summary`, `enterprise_summary`, `account_resource_instance_usage`. + * `version` - (String) Version of the snapshot. + * `snapshot_id` - (String) Id of the snapshot captured. + * `state` - (String) Status of the billing snapshot configuration. Possible values are [enabled, disabled]. + * Constraints: Allowable values are: `enabled`, `disabled`. + * `version` - (String) Version of the snapshot. + diff --git a/website/docs/d/cd_toolchains.html.markdown b/website/docs/d/cd_toolchains.html.markdown new file mode 100644 index 0000000000..bcf436b139 --- /dev/null +++ b/website/docs/d/cd_toolchains.html.markdown @@ -0,0 +1,55 @@ +--- +layout: "ibm" +page_title: "IBM : ibm_cd_toolchains" +description: |- + Get information about cd_toolchains +subcategory: "Continuous Delivery" +--- + +# ibm_cd_toolchains + +Provides a read-only data source to retrieve information about cd_toolchains. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax. + +## Example Usage + +```hcl +data "ibm_cd_toolchains" "cd_toolchains" { + name = "TestToolchainV2" + resource_group_id = "6a9a01f2cff54a7f966f803d92877123" +} +``` + +## Argument Reference + +You can specify the following arguments for this data source. + +* `name` - (Optional, String) Name of toolchain to look up. + * Constraints: The maximum length is `128` characters. The minimum length is `0` characters. The value must match regular expression `/^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$/`. +* `resource_group_id` - (Required, String) The resource group ID where the toolchains exist. + * Constraints: The maximum length is `32` characters. The minimum length is `32` characters. The value must match regular expression `/^[0-9a-f]{32}$/`. + +## Attribute Reference + +After your data source is created, you can read values from the following attributes. + +* `id` - The unique identifier of the cd_toolchains. +* `toolchains` - (List) Toolchain results returned from the collection. + * Constraints: The maximum length is `200` items. The minimum length is `0` items. +Nested schema for **toolchains**: + * `account_id` - (String) Account ID where toolchain can be found. + * `created_at` - (String) Toolchain creation timestamp. + * `created_by` - (String) Identity that created the toolchain. + * `crn` - (String) Toolchain CRN. + * `description` - (String) Describes the toolchain. + * Constraints: The maximum length is `500` characters. The minimum length is `0` characters. The value must match regular expression `/^(.*?)$/`. + * `href` - (String) URI that can be used to retrieve toolchain. + * `id` - (String) Toolchain ID. + * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/`. + * `location` - (String) Toolchain region. + * `name` - (String) Toolchain name. + * Constraints: The maximum length is `128` characters. The minimum length is `0` characters. The value must match regular expression `/^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$/`. + * `resource_group_id` - (Forces new resource, String) Resource group where the toolchain is located. + * Constraints: The maximum length is `32` characters. The minimum length is `32` characters. The value must match regular expression `/^[0-9a-f]{32}$/`. + * `ui_href` - (String) URL of a user-facing user interface for this toolchain. + * `updated_at` - (String) Latest toolchain update timestamp. + diff --git a/website/docs/d/container_cluster_config.html.markdown b/website/docs/d/container_cluster_config.html.markdown index 2610b414ca..dc03c748c1 100644 --- a/website/docs/d/container_cluster_config.html.markdown +++ b/website/docs/d/container_cluster_config.html.markdown @@ -83,7 +83,7 @@ resource "kubernetes_namespace" "example" { } } ``` -## Example usage +## Example usage5 Example usage for connecting to Kubernetes provider for classic OpenShift cluster with host and token. ```terraform @@ -103,6 +103,18 @@ resource "kubernetes_namespace" "example" { } ``` +## Example usage6 +Example for getting kubeconfig for VPC Kubernetes cluster with admin certificates and with VPE Gateway as server URL + +```terraform +data "ibm_container_cluster_config" "cluster_foo" { + cluster_name_id = "FOO" + config_dir = "/home/foo_config" + admint = "true" + endpoint_type = "vpe" +} +``` + ## Argument reference Review the argument references that you can specify for your data source. @@ -113,6 +125,7 @@ Review the argument references that you can specify for your data source. - `download` - (Optional, Bool) Set the value to **false** to skip downloading the configuration for the administrator. The default value is **true**. The configuration files and certificates are downloaded to the directory that you specified in `config_dir` every time that you run your infrastructure code. - `network` - (Optional, Bool) If set to **true**, the Calico configuration file, TLS certificates, and permission files that are required to run `calicoctl` commands in your cluster are downloaded in addition to the configuration files for the administrator. The default value is **false**. - `resource_group_id` - (Optional, String) The ID of the resource group where your cluster is provisioned into. To find the resource group, run `ibmcloud resource groups` or use the `ibm_resource_group` data source. If this parameter is not provided, the `default` resource group is used. +- `endpoint_type` - (Optional, String) The server URL for the cluster context. If you do not include this parameter, the default cluster service endpoint is used. Available options: `private`, `link` (Satellite), `vpe` (VPC). For Satellite clusters, the `link` endpoint is the default. When the public service endpoint is disabled in Red Hat OpenShift on IBM Cloud clusters, the `endpoint_type` parameter will also influence the communication method used by the provider plugin with the cluster when generating the cluster config. If you set it to `private`, the plugin will utilize the cluster's Private Service Endpoint URL for communication, while setting it to `vpe` will make it use the cluster's Virtual Private Endpoint gateway URL for communication purposes. **Deprecated reference** diff --git a/website/docs/d/iam_authorization_policies.html.markdown b/website/docs/d/iam_authorization_policies.html.markdown index 68840df95d..90422aa000 100644 --- a/website/docs/d/iam_authorization_policies.html.markdown +++ b/website/docs/d/iam_authorization_policies.html.markdown @@ -38,12 +38,12 @@ In addition to all argument reference list, you can access the following attribu - `resources`- (List of objects) A nested block describes the resources in the policy. Nested scheme for `resources`: - - `source_service_account` - (Optional, Forces new resource, string) The account GUID of source service. - - `source_service_name` - (Required, Forces new resource, string) The source service name. - - `target_service_name` - (Required, Forces new resource, string) The target service name. - - `source_resource_instance_id` - (Optional, Forces new resource, string) The source resource instance id. - - `target_resource_instance_id` - (Optional, Forces new resource, string) The target resource instance id. - - `source_resource_type` - (Optional, Forces new resource, string) The resource type of source service. - - `target_resource_type` - (Optional, Forces new resource, string) The resource type of target service. - - `source_resource_group_id` - (Optional, Forces new resource, string) The source resource group id. - - `target_resource_group_id` - (Optional, Forces new resource, string) The target resource group id. + - `source_service_account` - (string) The account GUID of source service. + - `source_service_name` - (string) The source service name. + - `target_service_name` - (string) The target service name. + - `source_resource_instance_id` - (string) The source resource instance id. + - `target_resource_instance_id` - (string) The target resource instance id. + - `source_resource_type` - (string) The resource type of source service. + - `target_resource_type` - (string) The resource type of target service. + - `source_resource_group_id` - (string) The source resource group id. + - `target_resource_group_id` - (string) The target resource group id. diff --git a/website/docs/d/is_virtual_endpoint_gateway.html.markdown b/website/docs/d/is_virtual_endpoint_gateway.html.markdown index 89ebe8761f..115c9c4550 100644 --- a/website/docs/d/is_virtual_endpoint_gateway.html.markdown +++ b/website/docs/d/is_virtual_endpoint_gateway.html.markdown @@ -37,6 +37,9 @@ Review the argument references that you can specify for your data source. In addition to the argument reference list, you can access the following attribute references after your data source is created. - `access_tags` - (List) Access management tags associated for the virtual endpoint gateway. + +-> **NOTE:** `allow_dns_resolution_binding` attribute is a select location availability, invitation only feature. In other regions value might not be present. +- `allow_dns_resolution_binding` - (Bool) Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true. - `created_at` - (Timestamp) The created date and time of the endpoint gateway. - `crn` - (String) The CRN for this endpoint gateway. - `health_state` - (String) Endpoint gateway health state. `ok: Healthy`, `degraded: Suffering from compromised performance, capacity, or connectivity`, `faulted: Completely unreachable, inoperative, or entirely incapacitated`, `inapplicable: The health state does not apply because of the current lifecycle state`. A resource with a lifecycle state of failed or deleting will have a health state of inapplicable. A pending resource may have this state. diff --git a/website/docs/d/is_virtual_endpoint_gateways.html.markdown b/website/docs/d/is_virtual_endpoint_gateways.html.markdown index f1b0e35814..1d77ab428d 100644 --- a/website/docs/d/is_virtual_endpoint_gateways.html.markdown +++ b/website/docs/d/is_virtual_endpoint_gateways.html.markdown @@ -41,6 +41,9 @@ In addition to the argument reference list, you can access the following attribu Nested scheme for `virtual_endpoint_gateways`: - `access_tags` - (List) Access management tags associated for the virtual endpoint gateway. + + -> **NOTE:** `allow_dns_resolution_binding` attribute is a select location availability, invitation only feature. In other regions value might not be present. + - `allow_dns_resolution_binding` - (Bool) Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true. - `created_at` - (Timestamp) The created date and time of the endpoint gateway. - `crn` - (String) The CRN for this endpoint gateway. - `health_state` - (String) The endpoint gateway health state. **ok: Healthy**, **degraded: Suffering from compromised performance, capacity, or connectivity**, **faulted: Completely unreachable, inoperative, or entirely incapacitated**, **inapplicable: The health state does not apply because of the current lifecycle state**. A resource with a lifecycle state of failed or deleting will have a health state of inapplicable. A pending resource may have this state. diff --git a/website/docs/d/is_vpc.html.markdown b/website/docs/d/is_vpc.html.markdown index e9520a7545..dae6f53b6a 100644 --- a/website/docs/d/is_vpc.html.markdown +++ b/website/docs/d/is_vpc.html.markdown @@ -54,6 +54,25 @@ In addition to all argument reference list, you can access the following attribu - `default_security_group_name` - (String) The name of the default security group. - `default_routing_table`- (String) The unique identifier of the VPC default routing table. - `default_routing_table_name` - (String) The name of the default routing table. + +-> **NOTE:** `dns` attribute is a select location availability, invitation only feature. In other regions value might not be present. +- `dns` - (List) The DNS configuration for this VPC. + + Nested scheme for `dns`: + - `enable_hub` - (Boolean) Indicates whether this VPC is enabled as a DNS name resolution hub. + - `resolver` - (List) The zone list this backup policy plan will create snapshot clones in. + + Nested scheme for `resolver`: + - `manual_servers` - (Integer) The DNS servers to use for this VPC, replacing any existing servers. All the DNS servers must either: **have a unique zone_affinity**, or **not have a zone_affinity**. + - `type` - (String) The type of the DNS resolver to use. + - `vpc` - (String) The VPC to provide DNS server addresses for this VPC. The specified VPC must be configured with a DNS Services custom resolver and must be in one of this VPC's DNS resolution bindings. +- `health_reasons` - (List) The reasons for the current `health_state` (if any).The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered. + Nested schema for **health_reasons**: + - `code` - (String) A snake case string succinctly identifying the reason for this health state. + - `message` - (String) An explanation of the reason for this health state. + - `more_info` - (String) Link to documentation about the reason for this health state. + +- `health_state` - (String) The health of this resource.- `ok`: No abnormal behavior detected- `degraded`: Experiencing compromised performance, capacity, or connectivity- `faulted`: Completely unreachable, inoperative, or otherwise entirely incapacitated- `inapplicable`: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of `failed` or `deleting` will have a health state of `inapplicable`. A `pending` resource may also have this state.[`degraded`, `faulted`, `inapplicable`, `ok`] - `resource_group` - (String) The resource group ID where the VPC created. - `security_group` - (String) A list of security groups attached to VPC. The nested security group block has the following structure: diff --git a/website/docs/d/is_vpc_dns_resolution_binding.html.markdown b/website/docs/d/is_vpc_dns_resolution_binding.html.markdown new file mode 100644 index 0000000000..2264bb5453 --- /dev/null +++ b/website/docs/d/is_vpc_dns_resolution_binding.html.markdown @@ -0,0 +1,85 @@ +--- +layout: "ibm" +page_title: "IBM : ibm_is_vpc_dns_resolution_binding" +description: |- + Get information about VPCDNSResolutionBinding +subcategory: "Virtual Private Cloud API" +--- + +-> **NOTE:** `ibm_is_vpc_dns_resolution_binding` datasource is a select location availability, invitation only feature. In other regions value might not be present. +# ibm_is_vpc_dns_resolution_binding + +Provides a read-only data source for VPCDNSResolutionBinding. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax. + +## Example Usage + +```terraform +data "ibm_is_vpc_dns_resolution_binding" "is_vpc_dns_resolution_binding" { + identifier = "id" + vpc_id = "vpc_id" +} +``` + +## Argument Reference + +Review the argument reference that you can specify for your data source. + +- `identifier` - (Required, Forces new resource, String) The DNS resolution binding identifier. +- `vpc_id` - (Required, Forces new resource, String) The VPC identifier. + +## Attribute Reference + +In addition to all argument references listed, you can access the following attribute references after your data source is created. + +- `id` - The unique identifier of the VPCDNSResolutionBinding. +- `created_at` - (String) The date and time that the DNS resolution binding was created. + +- `endpoint_gateways` - (List) The endpoint gateways in the bound to VPC that are allowed to participate in this DNS resolution binding.The endpoint gateways may be remote and therefore may not be directly retrievable. + - Constraints: The minimum length is `0` items. + Nested scheme for **endpoint_gateways**: + - `crn` - (String) The CRN for this endpoint gateway. + - Constraints: The maximum length is `512` characters. The minimum length is `9` characters. + - `href` - (String) The URL for this endpoint gateway. + - `id` - (String) The unique identifier for this endpoint gateway. + - `name` - (String) The name for this endpoint gateway. The name is unique across all endpoint gateways in the VPC. + - `remote` - (List) If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable. + Nested scheme for **remote**: + - `account` - (List) If present, this property indicates that the referenced resource is remote to thisaccount, and identifies the owning account. + Nested scheme for **account**: + - `id` - (String) The unique identifier for this account. + - Constraints: The value must match regular expression `/^[0-9a-f]{32}$/`. + - `resource_type` - (String) The resource type. + - `region` - (List) If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region. + Nested scheme for **region**: + - `href` - (String) The URL for this region. + - `name` - (String) The globally unique name for this region. + - `resource_type` - (String) The resource type. + +- `href` - (String) The URL for this DNS resolution binding. + +- `lifecycle_state` - (String) The lifecycle state of the DNS resolution binding. + - Constraints: Allowable values are: `deleting`, `failed`, `pending`, `stable`, `suspended`, `updating`, `waiting`. + +- `name` - (String) The name for this DNS resolution binding. The name is unique across all DNS resolution bindings for the VPC. + +- `resource_type` - (String) The resource type. + +- `vpc` - (List) The VPC bound to for DNS resolution.The VPC may be remote and therefore may not be directly retrievable. + Nested scheme for **vpc**: + - `crn` - (String) The CRN for this VPC. + - Constraints: The maximum length is `512` characters. The minimum length is `9` characters. + - `href` - (String) The URL for this VPC. + - `id` - (String) The unique identifier for this VPC. + - `name` - (String) The name for this VPC. The name is unique across all VPCs in the region. + - `remote` - (List) If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable. + Nested scheme for **remote**: + - `account` - (List) If present, this property indicates that the referenced resource is remote to thisaccount, and identifies the owning account. + Nested scheme for **account**: + - `id` - (String) The unique identifier for this account. + - `resource_type` - (String) The resource type. + - `region` - (List) If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region. + Nested scheme for **region**: + - `href` - (String) The URL for this region. + - `name` - (String) The globally unique name for this region. + - `resource_type` - (String) The resource type. + diff --git a/website/docs/d/is_vpc_dns_resolution_bindings.html.markdown b/website/docs/d/is_vpc_dns_resolution_bindings.html.markdown new file mode 100644 index 0000000000..a16092d195 --- /dev/null +++ b/website/docs/d/is_vpc_dns_resolution_bindings.html.markdown @@ -0,0 +1,87 @@ +--- +layout: "ibm" +page_title: "IBM : ibm_is_vpc_dns_resolution_bindings" +description: |- + List information about VPCDNSResolutionBindings +subcategory: "Virtual Private Cloud API" +--- + +-> **NOTE:** `ibm_is_vpc_dns_resolution_bindings` datasource is a select location availability, invitation only feature. In other regions value might not be present. +# ibm_is_vpc_dns_resolution_bindings + +Provides a read-only data source for VPCDNSResolutionBindings. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax. + +## Example Usage + +```terraform +data "ibm_is_vpc_dns_resolution_bindings" "is_vpc_dns_resolution_bindings" { + vpc_id = "vpc_id" +} +``` + +## Argument Reference + +Review the argument reference that you can specify for your data source. + +- `vpc_id` - (Required, Forces new resource, String) The VPC identifier. + +## Attribute Reference + +In addition to all argument references listed, you can access the following attribute references after your data source is created. + +- `id` - The unique identifier of the VPCDNSResolutionBinding. + +- `dns_resolution_bindings` - (List) Collection of the dns_resolution_binding. + + Nested `dns_resolution_binding` blocks have the following structure: + - `created_at` - (String) The date and time that the DNS resolution binding was created. + + - `endpoint_gateways` - (List) The endpoint gateways in the bound to VPC that are allowed to participate in this DNS resolution binding.The endpoint gateways may be remote and therefore may not be directly retrievable. + Nested scheme for **endpoint_gateways**: + - `crn` - (String) The CRN for this endpoint gateway. + - Constraints: The maximum length is `512` characters. The minimum length is `9` characters. + - `href` - (String) The URL for this endpoint gateway. + - `id` - (String) The unique identifier for this endpoint gateway. + - `name` - (String) The name for this endpoint gateway. The name is unique across all endpoint gateways in the VPC. + - `remote` - (List) If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable. + Nested scheme for **remote**: + - `account` - (List) If present, this property indicates that the referenced resource is remote to thisaccount, and identifies the owning account. + Nested scheme for **account**: + - `id` - (String) The unique identifier for this account. + - Constraints: The value must match regular expression `/^[0-9a-f]{32}$/`. + - `resource_type` - (String) The resource type. + - `region` - (List) If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region. + Nested scheme for **region**: + - `href` - (String) The URL for this region. + - `name` - (String) The globally unique name for this region. + - `resource_type` - (String) The resource type. + + - `href` - (String) The URL for this DNS resolution binding. + + - `lifecycle_state` - (String) The lifecycle state of the DNS resolution binding. + - Constraints: Allowable values are: `deleting`, `failed`, `pending`, `stable`, `suspended`, `updating`, `waiting`. + + - `name` - (String) The name for this DNS resolution binding. The name is unique across all DNS resolution bindings for the VPC. + + - `resource_type` - (String) The resource type. + + - `vpc` - (List) The VPC bound to for DNS resolution.The VPC may be remote and therefore may not be directly retrievable. + Nested scheme for **vpc**: + - `crn` - (String) The CRN for this VPC. + - `href` - (String) The URL for this VPC. + - `id` - (String) The unique identifier for this VPC. + - `name` - (String) The name for this VPC. The name is unique across all VPCs in the region. + - `remote` - (List) If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable. + Nested scheme for **remote**: + - `account` - (List) If present, this property indicates that the referenced resource is remote to thisaccount, and identifies the owning account. + Nested scheme for **account**: + - `id` - (String) The unique identifier for this account. + - Constraints: The value must match regular expression `/^[0-9a-f]{32}$/`. + - `resource_type` - (String) The resource type. + - `region` - (List) If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region. + Nested scheme for **region**: + - `href` - (String) The URL for this region. + - `name` - (String) The globally unique name for this region. + - `resource_type` - (String) The resource type. + + diff --git a/website/docs/d/is_vpcs.html.markdown b/website/docs/d/is_vpcs.html.markdown index bc2751ee2a..102f7d8634 100644 --- a/website/docs/d/is_vpcs.html.markdown +++ b/website/docs/d/is_vpcs.html.markdown @@ -56,6 +56,26 @@ You can access the following attribute references after your data source is crea - `default_security_group_name` - (String) The name of the default security group. - `default_routing_table`- (String) The unique identifier of the VPC default routing table. - `default_routing_table_name` - (String) The name of the default routing table. + + -> **NOTE:** `dns` attribute is a select location availability, invitation only feature. In other regions value might not be present. + - `dns` - (List) The DNS configuration for this VPC. + + Nested scheme for `dns`: + - `enable_hub` - (Boolean) Indicates whether this VPC is enabled as a DNS name resolution hub. + - `resolver` - (List) The zone list this backup policy plan will create snapshot clones in. + + Nested scheme for `resolver`: + - `manual_servers` - (Integer) The DNS servers to use for this VPC, replacing any existing servers. All the DNS servers must either: **have a unique zone_affinity**, or **not have a zone_affinity**. + - `type` - (String) The type of the DNS resolver to use. + - `vpc` - (String) The VPC to provide DNS server addresses for this VPC. The specified VPC must be configured with a DNS Services custom resolver and must be in one of this VPC's DNS resolution bindings. + - `health_reasons` - (List) The reasons for the current `health_state` (if any).The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered. + Nested schema for **health_reasons**: + - `code` - (String) A snake case string succinctly identifying the reason for this health state. + - `message` - (String) An explanation of the reason for this health state. + - `more_info` - (String) Link to documentation about the reason for this health state. + + - `health_state` - (String) The health of this resource.- `ok`: No abnormal behavior detected- `degraded`: Experiencing compromised performance, capacity, or connectivity- `faulted`: Completely unreachable, inoperative, or otherwise entirely incapacitated- `inapplicable`: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of `failed` or `deleting` will have a health state of `inapplicable`. A `pending` resource may also have this state.[`degraded`, `faulted`, `inapplicable`, `ok`] + - `id` - (String) The ID of the VPC. - `name` - (String) The name of the VPC. - `resource_group` - (String) The resource group ID where the VPC created. diff --git a/website/docs/d/metrics_router_targets.html.markdown b/website/docs/d/metrics_router_targets.html.markdown index 476553d35b..c5f5451b4f 100644 --- a/website/docs/d/metrics_router_targets.html.markdown +++ b/website/docs/d/metrics_router_targets.html.markdown @@ -34,7 +34,7 @@ In addition to all argument references listed, you can access the following attr Nested scheme for **targets**: * `created_at` - (String) The timestamp of the target creation time. * `crn` - (String) The crn of the target resource. - * `destination_crn` - (String) The CRN of the destination service instance or resource. + * `destination_crn` - (String) The CRN of the destination service instance or resource. Ensure you have a service authorization between IBM Cloud Metrics Routing and your Cloud resource. Read [S2S authorization](https://cloud.ibm.com/docs/metrics-router?topic=metrics-router-target-monitoring&interface=ui#target-monitoring-ui) for details. * Constraints: The maximum length is `1000` characters. The minimum length is `3` characters. The value must match regular expression `/^[a-zA-Z0-9 \\-._:\/]+$/`. * `id` - (String) The UUID of the target resource. * `name` - (String) The name of the target resource. diff --git a/website/docs/d/scc_control_library.html.markdown b/website/docs/d/scc_control_library.html.markdown index d0c0fe7521..20db99ed77 100644 --- a/website/docs/d/scc_control_library.html.markdown +++ b/website/docs/d/scc_control_library.html.markdown @@ -10,11 +10,14 @@ subcategory: "Security and Compliance Center" Retrieve information about a scc_control_library from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. +~> NOTE: if you specify the `region` in the provider, that region will become the default URL. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will override any URL(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://us-south.compliance.ibm.com`). + ## Example Usage ```hcl data "ibm_scc_control_library" "scc_control_library" { - control_library_id = ibm_scc_control_library.scc_control_library_instance.controlLibrary_id + instance_id = "00000000-1111-2222-3333-444444444444" + control_library_id = "aaaaaaaa-1111-bbbb-2222-cccccccccccc" } ``` @@ -24,6 +27,7 @@ You can specify the following arguments for this data source. * `control_library_id` - (Required, Forces new resource, String) The control library ID. * Constraints: The maximum length is `256` characters. The minimum length is `1` character. The value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/`. +* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. ## Attribute Reference diff --git a/website/docs/d/scc_instance_settings.html.markdown b/website/docs/d/scc_instance_settings.html.markdown index 42e46b64c1..4c2d84e148 100644 --- a/website/docs/d/scc_instance_settings.html.markdown +++ b/website/docs/d/scc_instance_settings.html.markdown @@ -15,8 +15,11 @@ Provides a read-only data source to retrieve information about scc_instance_sett ```hcl resource "ibm_scc_instance_settings" "scc_instance_settings_instance" { + instance_id = "00000000-1111-2222-3333-444444444444" } ``` +## Argument Reference + ## Attribute Reference diff --git a/website/docs/d/scc_latest_reports.html.markdown b/website/docs/d/scc_latest_reports.html.markdown index 5afa715527..8fc6676f60 100644 --- a/website/docs/d/scc_latest_reports.html.markdown +++ b/website/docs/d/scc_latest_reports.html.markdown @@ -10,11 +10,14 @@ subcategory: "Security and Compliance Center" Retrieve information about the latest reports from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. +~> NOTE: if you specify the `region` in the provider, that region will become the default URL. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will override any URL(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://us-south.compliance.ibm.com`). + ## Example Usage ```hcl data "ibm_scc_latest_reports" "scc_latest_reports" { - sort = "profile_name" + instance_id = "00000000-1111-2222-3333-444444444444" + sort = "profile_name" } ``` @@ -24,6 +27,7 @@ You can specify the following arguments for this data source. * `sort` - (Optional, String) This field sorts results by using a valid sort field. To learn more, see [Sorting](https://cloud.ibm.com/docs/api-handbook?topic=api-handbook-sorting). * Constraints: The maximum length is `32` characters. The minimum length is `1` character. The value must match regular expression `/^[\\-]?[a-z0-9_]+$/`. +* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. ## Attribute Reference diff --git a/website/docs/d/scc_profile.html.markdown b/website/docs/d/scc_profile.html.markdown index d5cec8a076..521f2f2316 100644 --- a/website/docs/d/scc_profile.html.markdown +++ b/website/docs/d/scc_profile.html.markdown @@ -10,11 +10,14 @@ subcategory: "Security and Compliance Center" Retrieve information about a profile from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. +~> NOTE: if you specify the `region` in the provider, that region will become the default URL. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will override any URL(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://us-south.compliance.ibm.com`). + ## Example Usage ```hcl data "ibm_scc_profile" "scc_profile" { - profile_id = ibm_scc_profile.scc_profile_instance.profile_id + instance_id = "00000000-1111-2222-3333-444444444444" + profile_id = ibm_scc_profile.scc_profile_instance.profile_id } ``` @@ -22,6 +25,7 @@ data "ibm_scc_profile" "scc_profile" { You can specify the following arguments for this data source. +* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. * `profile_id` - (Required, Forces new resource, String) The profile ID. * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/`. diff --git a/website/docs/d/scc_profile_attachment.html.markdown b/website/docs/d/scc_profile_attachment.html.markdown index 7c239c317f..ae30e2d3fb 100644 --- a/website/docs/d/scc_profile_attachment.html.markdown +++ b/website/docs/d/scc_profile_attachment.html.markdown @@ -10,12 +10,15 @@ subcategory: "Security and Compliance Center" Retrieve information about a profile attachment from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. +~> NOTE: if you specify the `region` in the provider, that region will become the default URL. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will override any URL(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://us-south.compliance.ibm.com`). + ## Example Usage ```hcl data "ibm_scc_profile_attachment" "scc_profile_attachment" { - attachment_id = "attachment_id" - profile_id = ibm_scc_profile_attachment.scc_profile_attachment.profiles_id + instance_id = "00000000-1111-2222-3333-444444444444" + attachment_id = "attachment_id" + profile_id = ibm_scc_profile_attachment.scc_profile_attachment.profiles_id } ``` @@ -23,6 +26,7 @@ data "ibm_scc_profile_attachment" "scc_profile_attachment" { You can specify the following arguments for this data source. +* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. * `attachment_id` - (Required, Forces new resource, String) The attachment ID. * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$|^$/`. * `profile_id` - (Required, Forces new resource, String) The profile ID. diff --git a/website/docs/d/scc_provider_type.html.markdown b/website/docs/d/scc_provider_type.html.markdown index 0bb1d28b18..cc2c8d4d4f 100644 --- a/website/docs/d/scc_provider_type.html.markdown +++ b/website/docs/d/scc_provider_type.html.markdown @@ -10,11 +10,13 @@ subcategory: "Security and Compliance Center" Retrieve information about a provider type from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. +~> NOTE: if you specify the `region` in the provider, that region will become the default URL. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will override any URL(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://us-south.compliance.ibm.com`). + ## Example Usage ```hcl data "ibm_scc_provider_type" "scc_provider_type" { - provider_type_id = "provider_type_id" + provider_type_id = "provider_type_id" } ``` diff --git a/website/docs/d/scc_provider_type_collection.html.markdown b/website/docs/d/scc_provider_type_collection.html.markdown index c704adfa5c..96d9c51e2e 100644 --- a/website/docs/d/scc_provider_type_collection.html.markdown +++ b/website/docs/d/scc_provider_type_collection.html.markdown @@ -10,6 +10,8 @@ subcategory: "Security and Compliance Center" Retrieve information about a provider type collection from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. +~> NOTE: if you specify the `region` in the provider, that region will become the default URL. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will override any URL(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://us-south.compliance.ibm.com`). + ## Example Usage ```hcl diff --git a/website/docs/d/scc_provider_type_instance.html.markdown b/website/docs/d/scc_provider_type_instance.html.markdown index 6b028f7ce3..6f5dc1b7b8 100644 --- a/website/docs/d/scc_provider_type_instance.html.markdown +++ b/website/docs/d/scc_provider_type_instance.html.markdown @@ -3,19 +3,22 @@ layout: "ibm" page_title: "IBM : ibm_scc_provider_type_instance" description: |- Get information about scc_provider_type_instance -subcategory: "Security and Compliance Center APIs" +subcategory: "Security and Compliance Center" --- # ibm_scc_provider_type_instance Retrieve information about a provider type instance from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. +~> NOTE: if you specify the `region` in the provider, that region will become the default URL. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will override any URL(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://us-south.compliance.ibm.com`). + ## Example Usage ```hcl data "ibm_scc_provider_type_instance" "scc_provider_type_instance" { - provider_type_id = ibm_scc_provider_type_instance.scc_provider_type_instance.provider_type_id - provider_type_instance_id = ibm_scc_provider_type_instance.scc_provider_type_instance_instance.providerTypeInstanceItem_id + instance_id = "00000000-1111-2222-3333-444444444444" + provider_type_id = ibm_scc_provider_type_instance.scc_provider_type_instance.provider_type_id + provider_type_instance_id = ibm_scc_provider_type_instance.scc_provider_type_instance_instance.providerTypeInstanceItem_id } ``` @@ -23,6 +26,7 @@ data "ibm_scc_provider_type_instance" "scc_provider_type_instance" { You can specify the following arguments for this data source. +* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. * `provider_type_id` - (Required, Forces new resource, String) The provider type ID. * Constraints: The maximum length is `36` characters. The minimum length is `32` characters. The value must match regular expression `/^[a-zA-Z0-9 ,\\-_]+$/`. * `provider_type_instance_id` - (Required, Forces new resource, String) The provider type instance ID. diff --git a/website/docs/d/scc_report.html.markdown b/website/docs/d/scc_report.html.markdown index 4d7b4b60ab..576c99daea 100644 --- a/website/docs/d/scc_report.html.markdown +++ b/website/docs/d/scc_report.html.markdown @@ -10,11 +10,14 @@ subcategory: "Security and Compliance Center" Retrieve information about a report from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. +~> NOTE: if you specify the `region` in the provider, that region will become the default URL. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will override any URL(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://us-south.compliance.ibm.com`). + ## Example Usage ```hcl data "ibm_scc_report" "scc_report" { - report_id = "report_id" + instance_id = "00000000-1111-2222-3333-444444444444" + report_id = "report_id" } ``` @@ -22,6 +25,7 @@ data "ibm_scc_report" "scc_report" { You can specify the following arguments for this data source. +* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. * `report_id` - (Required, Forces new resource, String) The ID of the scan that is associated with a report. * Constraints: The maximum length is `128` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9\\-]+$/`. diff --git a/website/docs/d/scc_report_controls.html.markdown b/website/docs/d/scc_report_controls.html.markdown index 8c7223d410..e36ab1805b 100644 --- a/website/docs/d/scc_report_controls.html.markdown +++ b/website/docs/d/scc_report_controls.html.markdown @@ -10,12 +10,15 @@ subcategory: "Security and Compliance Center" Retrieve information about report controls from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. +~> NOTE: if you specify the `region` in the provider, that region will become the default URL. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will override any URL(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://us-south.compliance.ibm.com`). + ## Example Usage ```hcl data "ibm_scc_report_controls" "scc_report_controls" { - report_id = "report_id" - status = "compliant" + instance_id = "00000000-1111-2222-3333-444444444444" + report_id = "report_id" + status = "compliant" } ``` @@ -23,6 +26,7 @@ data "ibm_scc_report_controls" "scc_report_controls" { You can specify the following arguments for this data source. +* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. * `control_category` - (Optional, String) A control category value. * Constraints: The maximum length is `1024` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9\\-]+$/`. * `control_description` - (Optional, String) The description of the control. diff --git a/website/docs/d/scc_report_evaluations.html.markdown b/website/docs/d/scc_report_evaluations.html.markdown index de4db941f2..e67c25a800 100644 --- a/website/docs/d/scc_report_evaluations.html.markdown +++ b/website/docs/d/scc_report_evaluations.html.markdown @@ -10,12 +10,15 @@ subcategory: "Security and Compliance Center" Retrieve information about report evaluations from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. +~> NOTE: if you specify the `region` in the provider, that region will become the default URL. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will override any URL(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://us-south.compliance.ibm.com`). + ## Example Usage ```hcl data "ibm_scc_report_evaluations" "scc_report_evaluations" { - report_id = "report_id" - status = "failure" + instance_id = "00000000-1111-2222-3333-444444444444" + report_id = "report_id" + status = "failure" } ``` @@ -23,6 +26,7 @@ data "ibm_scc_report_evaluations" "scc_report_evaluations" { You can specify the following arguments for this data source. +* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. * `assessment_id` - (Optional, String) The ID of the assessment. * Constraints: The maximum length is `128` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9\\-]+$/`. * `component_id` - (Optional, String) The ID of component. diff --git a/website/docs/d/scc_report_resources.html.markdown b/website/docs/d/scc_report_resources.html.markdown index c57af64836..340cf9d7f5 100644 --- a/website/docs/d/scc_report_resources.html.markdown +++ b/website/docs/d/scc_report_resources.html.markdown @@ -10,12 +10,15 @@ subcategory: "Security and Compliance Center" Retrieve information about report resources from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. +~> NOTE: if you specify the `region` in the provider, that region will become the default URL. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will override any URL(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://us-south.compliance.ibm.com`). + ## Example Usage ```hcl data "ibm_scc_report_resources" "scc_report_resources" { - report_id = "report_id" - status = "compliant" + instance_id = "00000000-1111-2222-3333-444444444444" + report_id = "report_id" + status = "compliant" } ``` @@ -23,6 +26,7 @@ data "ibm_scc_report_resources" "scc_report_resources" { You can specify the following arguments for this data source. +* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. * `account_id` - (Optional, String) The ID of the account owning a resource. * Constraints: The maximum length is `128` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9\\-]+$/`. * `component_id` - (Optional, String) The ID of component. diff --git a/website/docs/d/scc_report_rule.html.markdown b/website/docs/d/scc_report_rule.html.markdown index ed2221dea7..f579ad4380 100644 --- a/website/docs/d/scc_report_rule.html.markdown +++ b/website/docs/d/scc_report_rule.html.markdown @@ -10,12 +10,15 @@ subcategory: "Security and Compliance Center" Retrieve information about a report rule from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. +~> NOTE: if you specify the `region` in the provider, that region will become the default URL. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will override any URL(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://us-south.compliance.ibm.com`). + ## Example Usage ```hcl data "ibm_scc_report_rule" "scc_report_rule" { - report_id = "report_id" - rule_id = "rule-8d444f8c-fd1d-48de-bcaa-f43732568761" + instance_id = "00000000-1111-2222-3333-444444444444" + report_id = "report_id" + rule_id = "rule-8d444f8c-fd1d-48de-bcaa-f43732568761" } ``` @@ -23,6 +26,7 @@ data "ibm_scc_report_rule" "scc_report_rule" { You can specify the following arguments for this data source. +* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. * `report_id` - (Required, Forces new resource, String) The ID of the scan that is associated with a report. * Constraints: The maximum length is `128` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9\\-]+$/`. * `rule_id` - (Required, Forces new resource, String) The ID of a rule in a report. diff --git a/website/docs/d/scc_report_summary.html.markdown b/website/docs/d/scc_report_summary.html.markdown index 4a3c375da0..f48e4615ba 100644 --- a/website/docs/d/scc_report_summary.html.markdown +++ b/website/docs/d/scc_report_summary.html.markdown @@ -10,10 +10,13 @@ subcategory: "Security and Compliance Center" Retrieve information about a report summary from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. +~> NOTE: if you specify the `region` in the provider, that region will become the default URL. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will override any URL(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://us-south.compliance.ibm.com`). + ## Example Usage ```hcl data "ibm_scc_report_summary" "scc_report_summary" { + instance_id = "00000000-1111-2222-3333-444444444444" report_id = "report_id" } ``` @@ -22,6 +25,7 @@ data "ibm_scc_report_summary" "scc_report_summary" { You can specify the following arguments for this data source. +* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. * `report_id` - (Required, Forces new resource, String) The ID of the scan that is associated with a report. * Constraints: The maximum length is `128` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9\\-]+$/`. diff --git a/website/docs/d/scc_report_tags.html.markdown b/website/docs/d/scc_report_tags.html.markdown index 82e388fa7b..dbc8b0e175 100644 --- a/website/docs/d/scc_report_tags.html.markdown +++ b/website/docs/d/scc_report_tags.html.markdown @@ -10,11 +10,14 @@ subcategory: "Security and Compliance Center" Retrieve information about report tags from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. +~> NOTE: if you specify the `region` in the provider, that region will become the default URL. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will override any URL(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://us-south.compliance.ibm.com`). + ## Example Usage ```hcl data "ibm_scc_report_tags" "scc_report_tags" { - report_id = "report_id" + instance_id = "00000000-1111-2222-3333-444444444444" + report_id = "report_id" } ``` @@ -22,6 +25,7 @@ data "ibm_scc_report_tags" "scc_report_tags" { You can specify the following arguments for this data source. +* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. * `report_id` - (Required, Forces new resource, String) The ID of the scan that is associated with a report. * Constraints: The maximum length is `128` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9\\-]+$/`. diff --git a/website/docs/d/scc_report_violation_drift.html.markdown b/website/docs/d/scc_report_violation_drift.html.markdown index fac3217bd8..d6738d4404 100644 --- a/website/docs/d/scc_report_violation_drift.html.markdown +++ b/website/docs/d/scc_report_violation_drift.html.markdown @@ -10,11 +10,14 @@ subcategory: "Security and Compliance Center" Retrieve information about a report violation drift from a read-only data source. Then, yo can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. +~> NOTE: if you specify the `region` in the provider, that region will become the default URL. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will override any URL(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://us-south.compliance.ibm.com`). + ## Example Usage ```hcl data "ibm_scc_report_violation_drift" "scc_report_violation_drift" { - report_id = "report_id" + instance_id = "00000000-1111-2222-3333-444444444444" + report_id = "report_id" } ``` @@ -22,6 +25,7 @@ data "ibm_scc_report_violation_drift" "scc_report_violation_drift" { You can specify the following arguments for this data source. +* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. * `report_id` - (Required, Forces new resource, String) The ID of the scan that is associated with a report. * Constraints: The maximum length is `128` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9\\-]+$/`. * `scan_time_duration` - (Optional, Integer) The duration of the `scan_time` timestamp in number of days. diff --git a/website/docs/d/scc_rule.html.markdown b/website/docs/d/scc_rule.html.markdown index c78a372590..f9728bb5b3 100644 --- a/website/docs/d/scc_rule.html.markdown +++ b/website/docs/d/scc_rule.html.markdown @@ -10,11 +10,14 @@ subcategory: "Security and Compliance Center" Retrieve information about a rule from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. +~> NOTE: if you specify the `region` in the provider, that region will become the default URL. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will override any URL(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://us-south.compliance.ibm.com`). + ## Example Usage ```hcl data "ibm_scc_rule" "scc_rule" { - rule_id = ibm_scc_rule.scc_rule_instance.rule_id + instance_id = "00000000-1111-2222-3333-444444444444" + rule_id = ibm_scc_rule.scc_rule_instance.rule_id } ``` @@ -22,6 +25,7 @@ data "ibm_scc_rule" "scc_rule" { You can specify the following arguments for this data source. +* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. * `rule_id` - (Required, Forces new resource, String) The ID of the corresponding rule. * Constraints: The maximum length is `41` characters. The minimum length is `41` characters. The value must match regular expression `/rule-[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}/`. diff --git a/website/docs/d/sm_arbitrary_secret.html.markdown b/website/docs/d/sm_arbitrary_secret.html.markdown index 7b6cc94657..80c207e8d8 100644 --- a/website/docs/d/sm_arbitrary_secret.html.markdown +++ b/website/docs/d/sm_arbitrary_secret.html.markdown @@ -9,9 +9,11 @@ subcategory: "Secrets Manager" # ibm_sm_arbitrary_secret Provides a read-only data source for an arbitrary secret. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax. +The data source can be defined by providing the secret ID or the secret and secret group names. ## Example Usage +By secret id ```hcl data "ibm_sm_arbitrary_secret" "arbitrary_secret" { instance_id = ibm_resource_instance.sm_instance.guid @@ -20,6 +22,16 @@ data "ibm_sm_arbitrary_secret" "arbitrary_secret" { } ``` +By secret name and group name +```hcl +data "ibm_sm_arbitrary_secret" "arbitrary_secret" { + instance_id = ibm_resource_instance.sm_instance.guid + region = "us-south" + name = "secret-name" + secret_group_name = "group-name" +} +``` + ## Argument Reference Review the argument reference that you can specify for your data source. @@ -28,8 +40,12 @@ Review the argument reference that you can specify for your data source. * `region` - (Optional, Forces new resource, String) The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration. * `endpoint_type` - (Optional, String) - The endpoint type. If not provided the endpoint type is determined by the `visibility` argument provided in the provider configuration. * Constraints: Allowable values are: `private`, `public`. -* `secret_id` - (Required, String) The ID of the secret. +* `secret_id` - (Optional, String) The ID of the secret. * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/`. +* `name` - (Optional, String) The human-readable name of your secret. To be used in combination with `secret_group_name`. + * Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `^[A-Za-z0-9][A-Za-z0-9]*(?:_*-*\\.*[A-Za-z0-9]+)*$`. +* `secret_group_name` - (Optional, String) The name of your existing secret group. To be used in combination with `name`. + * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/(.*?)/`. ## Attribute Reference diff --git a/website/docs/d/sm_iam_credentials_secret.html.markdown b/website/docs/d/sm_iam_credentials_secret.html.markdown index bc14cbad5a..8355a081f0 100644 --- a/website/docs/d/sm_iam_credentials_secret.html.markdown +++ b/website/docs/d/sm_iam_credentials_secret.html.markdown @@ -9,9 +9,11 @@ subcategory: "Secrets Manager" # ibm_sm_iam_credentials_secret Provides a read-only data source for an IAM credentials secret. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax. +The data source can be defined by providing the secret ID or the secret and secret group names. ## Example Usage +By secret id ```hcl data "ibm_sm_iam_credentials_secret" "iam_secret" { instance_id = ibm_resource_instance.sm_instance.guid @@ -20,6 +22,17 @@ data "ibm_sm_iam_credentials_secret" "iam_secret" { } ``` + +By secret name and group name +```hcl +data "ibm_sm_iam_credentials_secret" "iam_secret" { + instance_id = ibm_resource_instance.sm_instance.guid + region = "us-south" + name = "secret-name" + secret_group_name = "group-name" +} +``` + ## Argument Reference Review the argument reference that you can specify for your data source. @@ -28,8 +41,12 @@ Review the argument reference that you can specify for your data source. * `region` - (Optional, Forces new resource, String) The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration. * `endpoint_type` - (Optional, String) - The endpoint type. If not provided the endpoint type is determined by the `visibility` argument provided in the provider configuration. * Constraints: Allowable values are: `private`, `public`. -* `secret_id` - (Required, String) The ID of the secret. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/`. +* `secret_id` - (Optional, String) The ID of the secret. + * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/`. +* `name` - (Optional, String) The human-readable name of your secret. To be used in combination with `secret_group_name`. + * Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `^[A-Za-z0-9][A-Za-z0-9]*(?:_*-*\\.*[A-Za-z0-9]+)*$`. +* `secret_group_name` - (Optional, String) The name of your existing secret group. To be used in combination with `name`. + * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/(.*?)/`. ## Attribute Reference diff --git a/website/docs/d/sm_imported_certificate.html.markdown b/website/docs/d/sm_imported_certificate.html.markdown index 3abbd36db5..4b6e1209fd 100644 --- a/website/docs/d/sm_imported_certificate.html.markdown +++ b/website/docs/d/sm_imported_certificate.html.markdown @@ -9,9 +9,11 @@ subcategory: "Secrets Manager" # ibm_sm_imported_certificate Provides a read-only data source for an imported certificate. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax. +The data source can be defined by providing the secret ID or the secret and secret group names. ## Example Usage +By secret id ```hcl data "ibm_sm_imported_certificate" "imported_certificate" { instance_id = ibm_resource_instance.sm_instance.guid @@ -20,6 +22,16 @@ data "ibm_sm_imported_certificate" "imported_certificate" { } ``` +By secret name and group name +```hcl +data "ibm_sm_imported_certificate" "imported_certificate" { + instance_id = ibm_resource_instance.sm_instance.guid + region = "us-south" + name = "secret-name" + secret_group_name = "group-name" +} +``` + ## Argument Reference Review the argument reference that you can specify for your data source. @@ -28,8 +40,13 @@ Review the argument reference that you can specify for your data source. * `region` - (Optional, Forces new resource, String) The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration. * `endpoint_type` - (Optional, String) - The endpoint type. If not provided the endpoint type is determined by the `visibility` argument provided in the provider configuration. * Constraints: Allowable values are: `private`, `public`. -* `secret_id` - (Required, String) The ID of the secret. +* `secret_id` - (Optional, String) The ID of the secret. * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/`. +* `name` - (Optional, String) The human-readable name of your secret. To be used in combination with `secret_group_name`. + * Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `^[A-Za-z0-9][A-Za-z0-9]*(?:_*-*\\.*[A-Za-z0-9]+)*$`. +* `secret_group_name` - (Optional, String) The name of your existing secret group. To be used in combination with `name`. + * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/(.*?)/`. + ## Attribute Reference diff --git a/website/docs/d/sm_kv_secret.html.markdown b/website/docs/d/sm_kv_secret.html.markdown index 1247e7143f..bc5ff3474d 100644 --- a/website/docs/d/sm_kv_secret.html.markdown +++ b/website/docs/d/sm_kv_secret.html.markdown @@ -9,9 +9,11 @@ subcategory: "Secrets Manager" # ibm_sm_kv_secret Provides a read-only data source for a KV secret. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax. +The data source can be defined by providing the secret ID or the secret and secret group names. ## Example Usage +By secret id ```hcl data "ibm_sm_kv_secret" "kv_secret" { instance_id = ibm_resource_instance.sm_instance.guid @@ -20,6 +22,16 @@ data "ibm_sm_kv_secret" "kv_secret" { } ``` +By secret name and group name +```hcl +data "ibm_sm_kv_secret" "kv_secret" { + instance_id = ibm_resource_instance.sm_instance.guid + region = "us-south" + name = "secret-name" + secret_group_name = "group-name" +} +``` + ## Argument Reference Review the argument reference that you can specify for your data source. @@ -28,8 +40,13 @@ Review the argument reference that you can specify for your data source. * `region` - (Optional, Forces new resource, String) The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration. * `endpoint_type` - (Optional, String) - The endpoint type. If not provided the endpoint type is determined by the `visibility` argument provided in the provider configuration. * Constraints: Allowable values are: `private`, `public`. -* `secret_id` - (Required, String) The ID of the secret. +* `secret_id` - (Optional, String) The ID of the secret. * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/`. +* `name` - (Optional, String) The human-readable name of your secret. To be used in combination with `secret_group_name`. + * Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `^[A-Za-z0-9][A-Za-z0-9]*(?:_*-*\\.*[A-Za-z0-9]+)*$`. +* `secret_group_name` - (Optional, String) The name of your existing secret group. To be used in combination with `name`. + * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/(.*?)/`. + ## Attribute Reference diff --git a/website/docs/d/sm_private_certificate.html.markdown b/website/docs/d/sm_private_certificate.html.markdown index 7e880d82b7..3e7331c496 100644 --- a/website/docs/d/sm_private_certificate.html.markdown +++ b/website/docs/d/sm_private_certificate.html.markdown @@ -2,16 +2,18 @@ layout: "ibm" page_title: "IBM : ibm_sm_private_certificate" description: |- - Get information about PrivateCertificate +Get information about PrivateCertificate subcategory: "Secrets Manager" --- # ibm_sm_private_certificate Provides a read-only data source for a private certificate. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax. +The data source can be defined by providing the secret ID or the secret and secret group names. ## Example Usage +By secret id ```hcl data "ibm_sm_private_certificate" "private_certificate" { instance_id = ibm_resource_instance.sm_instance.guid @@ -20,6 +22,16 @@ data "ibm_sm_private_certificate" "private_certificate" { } ``` +By secret name and group name +```hcl +data "ibm_sm_private_certificate" "private_certificate" { + instance_id = ibm_resource_instance.sm_instance.guid + region = "us-south" + name = "secret-name" + secret_group_name = "group-name" +} +``` + ## Argument Reference Review the argument reference that you can specify for your data source. @@ -28,8 +40,13 @@ Review the argument reference that you can specify for your data source. * `region` - (Optional, Forces new resource, String) The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration. * `endpoint_type` - (Optional, String) - The endpoint type. If not provided the endpoint type is determined by the `visibility` argument provided in the provider configuration. * Constraints: Allowable values are: `private`, `public`. -* `secret_id` - (Required, String) The ID of the secret. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/`. +* `secret_id` - (Optional, String) The ID of the secret. + * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/`. +* `name` - (Optional, String) The human-readable name of your secret. To be used in combination with `secret_group_name`. + * Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `^[A-Za-z0-9][A-Za-z0-9]*(?:_*-*\\.*[A-Za-z0-9]+)*$`. +* `secret_group_name` - (Optional, String) The name of your existing secret group. To be used in combination with `name`. + * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/(.*?)/`. + ## Attribute Reference @@ -37,100 +54,100 @@ In addition to all argument references listed, you can access the following attr * `id` - The unique identifier of the data source. * `alt_names` - (List) With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate. - * Constraints: The list items must match regular expression `/^(.*?)$/`. The maximum length is `99` items. The minimum length is `0` items. + * Constraints: The list items must match regular expression `/^(.*?)$/`. The maximum length is `99` items. The minimum length is `0` items. * `ca_chain` - (List) The chain of certificate authorities that are associated with the certificate. - * Constraints: The list items must match regular expression `/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/`. The maximum length is `16` items. The minimum length is `1` item. + * Constraints: The list items must match regular expression `/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/`. The maximum length is `16` items. The minimum length is `1` item. * `certificate` - (String) The PEM-encoded contents of your certificate. - * Constraints: The maximum length is `100000` characters. The minimum length is `50` characters. The value must match regular expression `/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/`. + * Constraints: The maximum length is `100000` characters. The minimum length is `50` characters. The value must match regular expression `/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/`. * `certificate_authority` - (String) The intermediate certificate authority that signed this certificate. * `certificate_template` - (String) The name of the certificate template. - * Constraints: The maximum length is `128` characters. The minimum length is `2` characters. The value must match regular expression `/^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$/`. + * Constraints: The maximum length is `128` characters. The minimum length is `2` characters. The value must match regular expression `/^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$/`. * `common_name` - (String) The Common Name (AKA CN) represents the server name that is protected by the SSL certificate. - * Constraints: The maximum length is `128` characters. The minimum length is `4` characters. The value must match regular expression `/(.*?)/`. + * Constraints: The maximum length is `128` characters. The minimum length is `4` characters. The value must match regular expression `/(.*?)/`. * `created_at` - (String) The date when a resource was created. The date format follows RFC 3339. * `created_by` - (String) The unique identifier that is associated with the entity that created the secret. - * Constraints: The maximum length is `128` characters. The minimum length is `4` characters. + * Constraints: The maximum length is `128` characters. The minimum length is `4` characters. * `crn` - (String) A CRN that uniquely identifies an IBM Cloud resource. - * Constraints: The maximum length is `512` characters. The minimum length is `9` characters. The value must match regular expression `/^crn:v[0-9](:([A-Za-z0-9-._~!$&'()*+,;=@\/]|%[0-9A-Z]{2})*){8}$/`. + * Constraints: The maximum length is `512` characters. The minimum length is `9` characters. The value must match regular expression `/^crn:v[0-9](:([A-Za-z0-9-._~!$&'()*+,;=@\/]|%[0-9A-Z]{2})*){8}$/`. * `custom_metadata` - (Map) The secret metadata that a user can customize. * `description` - (String) An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group. - * Constraints: The maximum length is `1024` characters. The minimum length is `0` characters. The value must match regular expression `/(.*?)/`. + * Constraints: The maximum length is `1024` characters. The minimum length is `0` characters. The value must match regular expression `/(.*?)/`. * `downloaded` - (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API. * `expiration_date` - (String) The date a secret is expired. The date format follows RFC 3339. * `issuer` - (String) The distinguished name that identifies the entity that signed and issued the certificate. - * Constraints: The maximum length is `128` characters. The minimum length is `2` characters. The value must match regular expression `/(.*?)/`. + * Constraints: The maximum length is `128` characters. The minimum length is `2` characters. The value must match regular expression `/(.*?)/`. * `issuing_ca` - (String) The PEM-encoded certificate of the certificate authority that signed and issued this certificate. - * Constraints: The value must match regular expression `/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/`. + * Constraints: The value must match regular expression `/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/`. * `key_algorithm` - (String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate. - * Constraints: The maximum length is `10` characters. The minimum length is `2` characters. The value must match regular expression `/(.*?)/`. + * Constraints: The maximum length is `10` characters. The minimum length is `2` characters. The value must match regular expression `/(.*?)/`. * `labels` - (List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created. - * Constraints: The list items must match regular expression `/(.*?)/`. The maximum length is `30` items. The minimum length is `0` items. + * Constraints: The list items must match regular expression `/(.*?)/`. The maximum length is `30` items. The minimum length is `0` items. * `locks_total` - (Integer) The number of locks of the secret. - * Constraints: The maximum value is `1000`. The minimum value is `0`. + * Constraints: The maximum value is `1000`. The minimum value is `0`. * `name` - (String) The human-readable name of your secret. - * Constraints: The maximum length is `256` characters. The minimum length is `2` characters. + * Constraints: The maximum length is `256` characters. The minimum length is `2` characters. * `next_rotation_date` - (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy. * `private_key` - (String) (Optional) The PEM-encoded private key to associate with the certificate. - * Constraints: The maximum length is `100000` characters. The minimum length is `50` characters. The value must match regular expression `/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/`. + * Constraints: The maximum length is `100000` characters. The minimum length is `50` characters. The value must match regular expression `/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/`. * `revocation_time_rfc3339` - (String) The date and time that the certificate was revoked. The date format follows RFC 3339. * `revocation_time_seconds` - (Integer) The timestamp of the certificate revocation. * `rotation` - (List) Determines whether Secrets Manager rotates your secrets automatically. -Nested scheme for **rotation**: - * `auto_rotate` - (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is `false`. If `auto_rotate` is set to `true` the service rotates your secret based on the defined interval. - * `interval` - (Integer) The length of the secret rotation time interval. - * Constraints: The minimum value is `1`. - * `rotate_keys` - (Boolean) Determines whether Secrets Manager rotates the private key for your public certificate automatically.Default is `false`. If it is set to `true`, the service generates and stores a new private key for your rotated certificate. - * `unit` - (String) The units for the secret rotation time interval. - * Constraints: Allowable values are: `day`, `month`. + Nested scheme for **rotation**: + * `auto_rotate` - (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is `false`. If `auto_rotate` is set to `true` the service rotates your secret based on the defined interval. + * `interval` - (Integer) The length of the secret rotation time interval. + * Constraints: The minimum value is `1`. + * `rotate_keys` - (Boolean) Determines whether Secrets Manager rotates the private key for your public certificate automatically.Default is `false`. If it is set to `true`, the service generates and stores a new private key for your rotated certificate. + * `unit` - (String) The units for the secret rotation time interval. + * Constraints: Allowable values are: `day`, `month`. * `secret_group_id` - (String) A v4 UUID identifier, or `default` secret group. - * Constraints: The maximum length is `36` characters. The minimum length is `7` characters. The value must match regular expression `/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/`. + * Constraints: The maximum length is `36` characters. The minimum length is `7` characters. The value must match regular expression `/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/`. * `secret_type` - (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials. - * Constraints: Allowable values are: `arbitrary`, `imported_cert`, `public_cert`, `iam_credentials`, `kv`, `username_password`, `private_cert`. + * Constraints: Allowable values are: `arbitrary`, `imported_cert`, `public_cert`, `iam_credentials`, `kv`, `username_password`, `private_cert`. * `serial_number` - (String) The unique serial number that was assigned to a certificate by the issuing certificate authority. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[^a-fA-F0-9]/`. + * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[^a-fA-F0-9]/`. * `signing_algorithm` - (String) The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate. - * Constraints: The maximum length is `64` characters. The minimum length is `4` characters. + * Constraints: The maximum length is `64` characters. The minimum length is `4` characters. * `state` - (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values. - * Constraints: Allowable values are: `0`, `1`, `2`, `3`, `5`. + * Constraints: Allowable values are: `0`, `1`, `2`, `3`, `5`. * `state_description` - (String) A text representation of the secret state. - * Constraints: Allowable values are: `pre_activation`, `active`, `suspended`, `deactivated`, `destroyed`. + * Constraints: Allowable values are: `pre_activation`, `active`, `suspended`, `deactivated`, `destroyed`. * `updated_at` - (String) The date when a resource was recently modified. The date format follows RFC 3339. * `validity` - (List) The date and time that the certificate validity period begins and ends. -Nested scheme for **validity**: - * `not_after` - (String) The date-time format follows RFC 3339. - * `not_before` - (String) The date-time format follows RFC 3339. + Nested scheme for **validity**: + * `not_after` - (String) The date-time format follows RFC 3339. + * `not_before` - (String) The date-time format follows RFC 3339. * `versions_total` - (Integer) The number of versions of the secret. - * Constraints: The maximum value is `50`. The minimum value is `0`. + * Constraints: The maximum value is `50`. The minimum value is `0`. diff --git a/website/docs/d/sm_public_certificate.html.markdown b/website/docs/d/sm_public_certificate.html.markdown index c9e43b159f..c997a1775c 100644 --- a/website/docs/d/sm_public_certificate.html.markdown +++ b/website/docs/d/sm_public_certificate.html.markdown @@ -9,9 +9,11 @@ subcategory: "Secrets Manager" # ibm_sm_public_certificate Provides a read-only data source for a public certificate. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax. +The data source can be defined by providing the secret ID or the secret and secret group names. ## Example Usage +By secret id ```hcl data "ibm_sm_public_certificate" "public_certificate" { instance_id = ibm_resource_instance.sm_instance.guid @@ -20,6 +22,16 @@ data "ibm_sm_public_certificate" "public_certificate" { } ``` +By secret name and group name +```hcl +data "ibm_sm_public_certificate" "public_certificate" { + instance_id = ibm_resource_instance.sm_instance.guid + region = "us-south" + name = "secret-name" + secret_group_name = "group-name" +} +``` + ## Argument Reference Review the argument reference that you can specify for your data source. @@ -28,8 +40,12 @@ Review the argument reference that you can specify for your data source. * `region` - (Optional, Forces new resource, String) The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration. * `endpoint_type` - (Optional, String) - The endpoint type. If not provided the endpoint type is determined by the `visibility` argument provided in the provider configuration. * Constraints: Allowable values are: `private`, `public`. -* `secret_id` - (Required, String) The ID of the secret. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/`. +* `secret_id` - (Optional, String) The ID of the secret. + * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/`. +* `name` - (Optional, String) The human-readable name of your secret. To be used in combination with `secret_group_name`. + * Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `^[A-Za-z0-9][A-Za-z0-9]*(?:_*-*\\.*[A-Za-z0-9]+)*$`. +* `secret_group_name` - (Optional, String) The name of your existing secret group. To be used in combination with `name`. + * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/(.*?)/`. ## Attribute Reference diff --git a/website/docs/d/sm_username_password_secret.html.markdown b/website/docs/d/sm_username_password_secret.html.markdown index 8d60873762..c18a55df9c 100644 --- a/website/docs/d/sm_username_password_secret.html.markdown +++ b/website/docs/d/sm_username_password_secret.html.markdown @@ -9,9 +9,11 @@ subcategory: "Secrets Manager" # ibm_sm_username_password_secret Provides a read-only data source for UsernamePasswordSecret. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax. +The data source can be defined by providing the secret ID or the secret and secret group names. ## Example Usage +By secret id ```hcl data "ibm_sm_username_password_secret" "username_password_secret" { instance_id = ibm_resource_instance.sm_instance.guid @@ -20,6 +22,16 @@ data "ibm_sm_username_password_secret" "username_password_secret" { } ``` +By secret name and group name +```hcl +data "ibm_sm_username_password_secret" "username_password_secret" { + instance_id = ibm_resource_instance.sm_instance.guid + region = "us-south" + name = "secret-name" + secret_group_name = "group-name" +} +``` + ## Argument Reference Review the argument reference that you can specify for your data source. @@ -28,8 +40,12 @@ Review the argument reference that you can specify for your data source. * `region` - (Optional, Forces new resource, String) The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration. * `endpoint_type` - (Optional, String) - The endpoint type. If not provided the endpoint type is determined by the `visibility` argument provided in the provider configuration. * Constraints: Allowable values are: `private`, `public`. -* `secret_id` - (Required, String) The ID of the secret. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/`. +* `secret_id` - (Optional, String) The ID of the secret. + * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/`. +* `name` - (Optional, String) The human-readable name of your secret. To be used in combination with `secret_group_name`. + * Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `^[A-Za-z0-9][A-Za-z0-9]*(?:_*-*\\.*[A-Za-z0-9]+)*$`. +* `secret_group_name` - (Optional, String) The name of your existing secret group. To be used in combination with `name`. + * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/(.*?)/`. ## Attribute Reference diff --git a/website/docs/r/billing_report_snapshot.html.markdown b/website/docs/r/billing_report_snapshot.html.markdown new file mode 100644 index 0000000000..4151c7748d --- /dev/null +++ b/website/docs/r/billing_report_snapshot.html.markdown @@ -0,0 +1,113 @@ +--- +layout: "ibm" +page_title: "IBM : ibm_billing_report_snapshot" +description: |- + Manages billing_report_snapshot. +subcategory: "Usage Reports" +--- + +# ibm_billing_report_snapshot + +Create, update, and delete billing_report_snapshots with this resource. + +## Example Usage + +```hcl +resource "ibm_billing_report_snapshot" "billing_report_snapshot_instance" { + cos_bucket = "bucket_name" + cos_location = "us-south" + cos_reports_folder = "IBMCloud-Billing-Reports" + interval = "daily" + versioning = "new" +} +``` + +## Example usage with service-to-service authorization + +```hcl +resource "ibm_iam_authorization_policy" "policy" { + source_service_name = "billing" + target_service_name = "cloud-object-storage" + target_resource_instance_id = "cos_instance_id" + roles = ["Object Writer", "Content Reader"] +} + +resource "ibm_billing_report_snapshot" "billing_report_snapshot_instance" { + cos_bucket = "bucket_name" + cos_location = "us-south" + cos_reports_folder = "IBMCloud-Billing-Reports" + interval = "daily" + versioning = "new" + report_types = ["account_summary", "account_resource_instance_usage"] + depends_on = [ ibm_iam_authorization_policy.policy ] +} +``` +If service-to-service authorization already exists in the specific COS bucket, the resource `policy` can be omitted and the `depends_on` flag can also be removed from resource `billing_report_snapshot_instance`. For more information, about IAM service authorizations, see [using authorizations to grant access between services](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/iam_authorization_policy). + +## Argument Reference + +You can specify the following arguments for this resource. + +* `cos_bucket` - (Required, String) The name of the COS bucket to store the snapshot of the billing reports. +* `cos_location` - (Required, String) Region of the COS instance. +* `cos_reports_folder` - (Optional, String) The billing reports root folder to store the billing reports snapshots. Defaults to "IBMCloud-Billing-Reports". + * Constraints: The default value is `IBMCloud-Billing-Reports`. +* `interval` - (Required, String) Frequency of taking the snapshot of the billing reports. + * Constraints: Allowable values are: `daily`. +* `report_types` - (Optional, List) The type of billing reports to take snapshot of. Possible values are [account_summary, enterprise_summary, account_resource_instance_usage]. + * Constraints: Allowable list items are: `account_summary`, `enterprise_summary`, `account_resource_instance_usage`. +* `versioning` - (Optional, String) A new version of report is created or the existing report version is overwritten with every update. + * Constraints: The default value is `new`. Allowable values are: `new`, `overwrite`. + +## Attribute Reference + +After your resource is created, you can read values from the listed arguments and the following attributes. + +* `id` - The unique identifier of the billing_report_snapshot. +* `account_type` - (String) Type of account. Possible values are [enterprise, account]. + * Constraints: Allowable values are: `account`, `enterprise`. +* `compression` - (String) Compression format of the snapshot report. +* `content_type` - (String) Type of content stored in snapshot report. +* `cos_endpoint` - (String) The endpoint of the COS instance. +* `created_at` - (Integer) Timestamp in milliseconds when the snapshot configuration was created. +* `history` - (List) List of previous versions of the snapshot configurations. +Nested schema for **history**: + * `account_id` - (String) Account ID for which billing report snapshot is configured. + * `account_type` - (String) Type of account. Possible values [enterprise, account]. + * Constraints: Allowable values are: `account`, `enterprise`. + * `compression` - (String) Compression format of the snapshot report. + * `content_type` - (String) Type of content stored in snapshot report. + * `cos_bucket` - (String) The name of the COS bucket to store the snapshot of the billing reports. + * `cos_endpoint` - (String) The endpoint of the COS instance. + * `cos_location` - (String) Region of the COS instance. + * `cos_reports_folder` - (String) The billing reports root folder to store the billing reports snapshots. Defaults to "IBMCloud-Billing-Reports". + * Constraints: The default value is `IBMCloud-Billing-Reports`. + * `end_time` - (Integer) Timestamp in milliseconds when the snapshot configuration ends. + * `interval` - (String) Frequency of taking the snapshot of the billing reports. + * Constraints: Allowable values are: `daily`. + * `report_types` - (List) The type of billing reports to take snapshot of. Possible values are [account_summary, enterprise_summary, account_resource_instance_usage]. + * Constraints: Allowable list items are: `account_summary`, `enterprise_summary`, `account_resource_instance_usage`. + * `start_time` - (Integer) Timestamp in milliseconds when the snapshot configuration was created. + * `state` - (String) Status of the billing snapshot configuration. Possible values are [enabled, disabled]. + * Constraints: Allowable values are: `enabled`, `disabled`. + * `updated_by` - (String) Account that updated the billing snapshot configuration. + * `versioning` - (String) A new version of report is created or the existing report version is overwritten with every update. + * Constraints: The default value is `new`. Allowable values are: `new`, `overwrite`. +* `last_updated_at` - (Integer) Timestamp in milliseconds when the snapshot configuration was last updated. +* `state` - (String) Status of the billing snapshot configuration. Possible values are [enabled, disabled]. + * Constraints: Allowable values are: `enabled`, `disabled`. + + +## Import + +You can import the `ibm_billing_report_snapshot` resource by using `account_id`. Account ID for which billing report snapshot is configured. + +# Syntax +``` +$ terraform import ibm_billing_report_snapshot.billing_report_snapshot +``` + +# Example +``` +$ terraform import ibm_billing_report_snapshot.billing_report_snapshot abc +``` diff --git a/website/docs/r/cos_bucket_website_configuration.html.markdown b/website/docs/r/cos_bucket_website_configuration.html.markdown index 64c6071a18..7fb031f5da 100644 --- a/website/docs/r/cos_bucket_website_configuration.html.markdown +++ b/website/docs/r/cos_bucket_website_configuration.html.markdown @@ -40,6 +40,11 @@ resource "ibm_cos_bucket" "cos_bucket_website_configuration" { storage_class = var.standard_storage_class } + +data "ibm_iam_access_group" "public_access_group" { + access_group_name = "Public Access" +} + # Give public access to above mentioned bucket resource "ibm_iam_access_group_policy" "policy" { @@ -50,8 +55,8 @@ resource "ibm_iam_access_group_policy" "policy" { resources { service = "cloud-object-storage" resource_type = "bucket" - resource_instance_id = "COS instance guid" - resource = data.ibm_cos_bucket.cos_bucket_website_configuration.bucket_name + resource_instance_id = "COS instance guid" # eg : 94xxxxxx-3xxx-4xxx-8xxx-7xxxxxxxxx7 + resource = ibm_cos_bucket.cos_bucket_website_configuration.bucket_name } } diff --git a/website/docs/r/iam_authorization_policy.html.markdown b/website/docs/r/iam_authorization_policy.html.markdown index 16009a6486..2758bb8b9d 100644 --- a/website/docs/r/iam_authorization_policy.html.markdown +++ b/website/docs/r/iam_authorization_policy.html.markdown @@ -95,6 +95,93 @@ resource "ibm_iam_authorization_policy" "policy" { ``` +### Authorization policy between resource group and a target service + +```terraform +resource "ibm_resource_group" "source_resource_group" { + name = "123123" +} + + +resource "ibm_iam_authorization_policy" "policy" { + source_resource_group_id = ibm_resource_group.source_resource_group.id + target_service_name = "cloud-object-storage" + roles = ["Reader"] +} + +``` + +### Authorization policy between resource group and a target service using resource attributes + +```terraform + +resource "ibm_resource_group" "source_resource_group" { + name = "123123" +} + +resource "ibm_iam_authorization_policy" "policy" { + roles = [ + "Reader", + ] + + resource_attributes { + name = "accountId" + operator = "stringEquals" + value = "12345" + } + resource_attributes { + name = "serviceName" + operator = "stringEquals" + value = "cloud-object-storage" + } + + subject_attributes { + name = "accountId" + value = "12345" + } + subject_attributes { + name = "resourceGroupId" + value = ibm_resource_group.source_resource_group.id + } +} +``` + +### Authorization policy between source service and target resource type "resource-group" + +```terraform +resource "ibm_iam_authorization_policy" "policy" { + source_service_name = "project" + target_resource_type = "resource-group" + roles = ["Viewer"] + } +``` + + +### Authorization policy between source service and target resource type "resource-group" using resource attributes + +```terraform +resource "ibm_iam_authorization_policy" "policy" { + roles = ["Viewer"] + subject_attributes { + name = "accountId" + value = "12345" + } + subject_attributes { + name = "serviceName" + value = "project" + } + + resource_attributes { + name = "resourceType" + value = "resource-group" + } + resource_attributes { + name = "accountId" + value = "12345" + } + } +``` + ### Authorization policy between two specific services. ```terraform @@ -137,27 +224,30 @@ specific to a service `internet-svcs` use above `resource_attributes` format.
**NOTE** - Changing a `profile` without disk to a `profile` with disk or vise versa will result in recreating(forcenew) the resource. + - `resource_group` - (Optional, Forces new resource, String) The ID of the resource group where you want to create the instance. - `instance_template` - (Optional, String) ID of the instance template to create the instance from. To create an instance template, use `ibm_is_instance_template` resource. diff --git a/website/docs/r/is_share.html.markdown b/website/docs/r/is_share.html.markdown index 4993f522de..ffaa72f235 100644 --- a/website/docs/r/is_share.html.markdown +++ b/website/docs/r/is_share.html.markdown @@ -63,7 +63,7 @@ The following arguments are supported: Nested scheme for `initial_owner`: - `gid` - (Optional, Integer) The initial group identifier for the file share. - `uid` - (Optional, Integer) The initial user identifier for the file share. -- `iops` - (Optional, Integer) The maximum input/output operation performance bandwidth per second for the file share. +- `iops` - (Optional, Integer) The maximum input/output operation performance bandwidth per second for the file share. For more information about the iops range for the given size, refer [File Storage for VPC profiles](https://cloud.ibm.com/docs/vpc?topic=vpc-file-storage-profiles&interface=ui) - `mount_targets` - (Optional, List) Share targets for the file share. - `name` - (Required, string) The user-defined name for this share target. Names must be unique within the share the share target resides in. - `virtual_network_interface` (Optional, List) The virtual network interface for this share mount target. Required if the share's `access_control_mode` is `security_group`. diff --git a/website/docs/r/is_virtual_endpoint_gateway.html.markdown b/website/docs/r/is_virtual_endpoint_gateway.html.markdown index 002a9da4c9..936a6fcd00 100644 --- a/website/docs/r/is_virtual_endpoint_gateway.html.markdown +++ b/website/docs/r/is_virtual_endpoint_gateway.html.markdown @@ -88,6 +88,9 @@ Review the argument references that you can specify for your resource. **•** For more information, about creating access tags, see [working with tags](https://cloud.ibm.com/docs/account?topic=account-tag&interface=ui#create-access-console).
**•** You must have the access listed in the [Granting users access to tag resources](https://cloud.ibm.com/docs/account?topic=account-access) for `access_tags`
**•** `access_tags` must be in the format `key:value`. + + -> **NOTE:** `allow_dns_resolution_binding` is a select location availability, invitation only feature. If used in other regions may lead to inconsistencies in state management. +- `allow_dns_resolution_binding` - (Optional, bool) Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true. - `name` - (Required, Forces new resource, String) The endpoint gateway name. - `ips` (Optional, List) The endpoint gateway resource group. diff --git a/website/docs/r/is_vpc.html.markdown b/website/docs/r/is_vpc.html.markdown index 0d0b442e2a..0249e5778b 100644 --- a/website/docs/r/is_vpc.html.markdown +++ b/website/docs/r/is_vpc.html.markdown @@ -31,6 +31,60 @@ resource "ibm_is_vpc" "example" { ``` +## Example usage +The following example to create a VPC with dns: + +```terraform +// manual type resolver +resource "ibm_is_vpc" "example" { + name = "example-vpc" + dns { + enable_hub = true + resolver { + manual_servers { + address = "192.168.3.4" + } + } + } +} + +resource "ibm_is_vpc" "example_vpc_manual" { + name = "example-vpc-manual" + dns { + enable_hub = true + resolver { + manual_servers { + address ="192.168.0.4" + zone_affinity= "au-syd-1" + } + manual_servers { + address = "192.168.64.4" + zone_affinity = "au-syd-2" + } + manual_servers { + address= "192.168.128.4" + zone_affinity ="au-syd-3" + } + } + } +} + +// system type resolver +resource "ibm_is_vpc" "example-system" { + name = "example-system-vpc" + dns { + enable_hub = false + + // uncommenting/patching vpc with below code would make the resolver type delegated + # resolver { + # type = "delegated" + # vpc_id = ibm_is_vpc.example.id + # } + } +} + +``` + ## Timeouts The `ibm_is_vpc` resource provides the following [[Timeouts](https://www.terraform.io/docs/language/resources/syntax.html) configuration options: @@ -53,6 +107,51 @@ Review the argument references that you can specify for your resource. - `default_network_acl_name` - (Optional, String) Enter the name of the default network access control list (ACL). - `default_security_group_name` - (Optional, String) Enter the name of the default security group. - `default_routing_table_name` - (Optional, String) Enter the name of the default routing table. + +-> **NOTE:** `dns` attribute is a select location availability, invitation only feature. If used in other regions may lead to inconsistencies in state management. +- `dns` - (Optional, List) The DNS configuration for this VPC. + + Nested scheme for `dns`: + - `enable_hub` - (Optional, Boolean) Indicates whether this VPC is enabled as a DNS name resolution hub. + - `resolver` - (Optional, List) The zone list this backup policy plan will create snapshot clones in. + Nested scheme for `resolver`: + + ~> **Note:** + `manual_servers` must be set if and only if `dns.resolver.type` is manual. + - `manual_servers` - (Optional, List) The DNS servers to use for this VPC, replacing any existing servers. All the DNS servers must either: **have a unique zone_affinity**, or **not have a zone_affinity**. + + Nested schema for **manual_servers**: + + - `address` - (Required, String) The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered. + - `zone_affinity` - (Optional, List) If present, DHCP configuration for this zone will have this DNS server listed first. + + ~> **Note:** + While using `zone_affinity`, if fewer DNS servers are specified than the number of zones, then default servers will be created and terraform would show change. Its advised to provide `address` for all `zone_affinity`. + + + - `type` - (Optional, String) The type of the DNS resolver to use. To update the resolver type, specify the `type` explicitly. + + ~> **Note:** + `delegated`: DNS server addresses will be provided by the resolver for the VPC specified in dns.resolver.vpc. Requires dns.enable_hub to be false.
+ `manual`: DNS server addresses are specified in `manual_servers`.
+ `system`: DNS server addresses will be provided by the system and depend on the configuration. + + ~> **Note:** + Updating from `manual` requires dns resolver `manual_servers` to be specified as null.
+ Updating to `manual` requires dns resolver `manual_servers` to be specified and not empty.
+ Updating from `delegated` requires `dns.resolver.vpc` to be specified as null. + - `vpc_id` - (Optional, List) (update only) The VPC ID to provide DNS server addresses for this VPC. The specified VPC must be configured with a DNS Services custom resolver and must be in one of this VPC's DNS resolution bindings. Mutually exclusive with `vpc_crn` + + ~> **Note:** + Specify "null" string to remove an existing VPC.
+ This property must be set if and only if dns resolver type is `delegated`. + - `vpc_crn` - (Optional, List) (update only) The VPC CRN to provide DNS server addresses for this VPC. The specified VPC must be configured with a DNS Services custom resolver and must be in one of this VPC's DNS resolution bindings. Mutually exclusive with `vpc_id` + + ~> **Note:** + Specify "null" string to remove an existing VPC.
+ This property must be set if and only if dns resolver type is `delegated`. + + - `name` - (Required, String) Enter a name for your VPC. No. - `no_sg_acl_rules` - (Optional, Bool) If set to true, delete all rules attached to default security group and default network ACL for a new VPC. This attribute has no impact on update. default false. - `resource_group` - (Optional, Forces new resource, String) Enter the ID of the resource group where you want to create the VPC. To list available resource groups, run `ibmcloud resource groups`. If you do not specify a resource group, the VPC is created in the `default` resource group. @@ -71,6 +170,13 @@ In addition to all argument reference list, you can access the following attribu - `default_network_acl_crn`- (String) CRN of the default network ACL ID created and attached to the VPC. - `default_network_acl`- (String) The default network ACL ID created and attached to the VPC. - `default_routing_table`- (String) The unique identifier of the VPC default routing table. +- `health_reasons` - (List) The reasons for the current `health_state` (if any).The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered. + Nested schema for **health_reasons**: + - `code` - (String) A snake case string succinctly identifying the reason for this health state. + - `message` - (String) An explanation of the reason for this health state. + - `more_info` - (String) Link to documentation about the reason for this health state. + +- `health_state` - (String) The health of this resource.- `ok`: No abnormal behavior detected- `degraded`: Experiencing compromised performance, capacity, or connectivity- `faulted`: Completely unreachable, inoperative, or otherwise entirely incapacitated- `inapplicable`: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of `failed` or `deleting` will have a health state of `inapplicable`. A `pending` resource may also have this state.[`degraded`, `faulted`, `inapplicable`, `ok`] - `id` - (String) The unique identifier of the VPC that you created. - `subnets`- (List of Strings) A list of subnets that are attached to a VPC. diff --git a/website/docs/r/is_vpc_dns_resolution_binding.html.markdown b/website/docs/r/is_vpc_dns_resolution_binding.html.markdown new file mode 100644 index 0000000000..9510b1f654 --- /dev/null +++ b/website/docs/r/is_vpc_dns_resolution_binding.html.markdown @@ -0,0 +1,126 @@ +--- +layout: "ibm" +page_title: "IBM : ibm_is_vpc_dns_resolution_binding" +description: |- + create VPCDNSResolutionBinding +subcategory: "Virtual Private Cloud API" +--- + +-> **NOTE:** `ibm_is_vpc_dns_resolution_binding` resource is a select location availability, invitation only feature. If used in other regions may lead to inconsistencies in state management. + +# ibm_is_vpc_dns_resolution_binding + +Provides a resource for VPCDNSResolutionBinding. You can then reference the fields of the resource in other resources within the same configuration using interpolation syntax. + +## Example Usage + +```terraform +resource "ibm_is_vpc_dns_resolution_binding" "is_vpc_dns_resolution_binding_by_id" { + name = "example-dns" + vpc_id = "vpc_id" + vpc { + id = " + } +} +resource "ibm_is_vpc_dns_resolution_binding" "is_vpc_dns_resolution_binding_by_crn" { + name = "example-dns" + vpc_id = "vpc_id" + vpc { + crn = " + } +} +resource "ibm_is_vpc_dns_resolution_binding" "is_vpc_dns_resolution_binding_href" { + name = "example-dns" + vpc_id = "vpc_id" + vpc { + href = " + } +} +``` + +## Argument Reference + +Review the argument reference that you can specify for your data source. + +- `name` - (Optional, String) The DNS resolution binding name. +- `vpc_id` - (Required, Forces new resource, String) The VPC identifier of the source vpc. +- `vpc` - (Required, Forces new resource, String) The VPC identifier/href/crn of the target. + Nested scheme for **vpc**: + - `crn` - (Optional, String) The CRN for this target vpc. + - `href` - (Optional, String) The href for this target vpc. + - `id` - (Optional, String) The unique identifier for this target vpc. + +## Attribute Reference + +In addition to all argument references listed, you can access the following attribute references after your data source is created. + +- `id` - The unique identifier of the VPCDNSResolutionBinding. +- `created_at` - (String) The date and time that the DNS resolution binding was created. + +- `endpoint_gateways` - (List) The endpoint gateways in the bound to VPC that are allowed to participate in this DNS resolution binding.The endpoint gateways may be remote and therefore may not be directly retrievable. + - Constraints: The minimum length is `0` items. + Nested scheme for **endpoint_gateways**: + - `crn` - (String) The CRN for this endpoint gateway. + - Constraints: The maximum length is `512` characters. The minimum length is `9` characters. + - `href` - (String) The URL for this endpoint gateway. + - Constraints: The maximum length is `8000` characters. The minimum length is `10` characters. The value must match regular expression `/^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/`. + - `id` - (String) The unique identifier for this endpoint gateway. + - Constraints: The maximum length is `64` characters. The minimum length is `1` character. The value must match regular expression `/^[-0-9a-z_]+$/`. + - `name` - (String) The name for this endpoint gateway. The name is unique across all endpoint gateways in the VPC. + - Constraints: The maximum length is `63` characters. The minimum length is `1` character. The value must match regular expression `/^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$/`. + - `remote` - (List) If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable. + Nested scheme for **remote**: + - `account` - (List) If present, this property indicates that the referenced resource is remote to thisaccount, and identifies the owning account. + Nested scheme for **account**: + - `id` - (String) The unique identifier for this account. + - Constraints: The value must match regular expression `/^[0-9a-f]{32}$/`. + - `resource_type` - (String) The resource type. + - Constraints: Allowable values are: `account`. The maximum length is `128` characters. The minimum length is `1` character. The value must match regular expression `/^[a-z][a-z0-9]*(_[a-z0-9]+)*$/`. + - `region` - (List) If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region. + Nested scheme for **region**: + - `href` - (String) The URL for this region. + - Constraints: The maximum length is `8000` characters. The minimum length is `10` characters. The value must match regular expression `/^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/`. + - `name` - (String) The globally unique name for this region. + - Constraints: The maximum length is `63` characters. The minimum length is `1` character. The value must match regular expression `/^([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$/`. + - `resource_type` - (String) The resource type. + - Constraints: Allowable values are: `endpoint_gateway`. The maximum length is `128` characters. The minimum length is `1` character. The value must match regular expression `/^[a-z][a-z0-9]*(_[a-z0-9]+)*$/`. + +- `href` - (String) The URL for this DNS resolution binding. + - Constraints: The maximum length is `8000` characters. The minimum length is `10` characters. The value must match regular expression `/^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/`. + +- `lifecycle_state` - (String) The lifecycle state of the DNS resolution binding. + - Constraints: Allowable values are: `deleting`, `failed`, `pending`, `stable`, `suspended`, `updating`, `waiting`. + +- `name` - (String) The name for this DNS resolution binding. The name is unique across all DNS resolution bindings for the VPC. + - Constraints: The maximum length is `63` characters. The minimum length is `1` character. The value must match regular expression `/^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$/`. + +- `resource_type` - (String) The resource type. + - Constraints: Allowable values are: `vpc_dns_resolution_binding`. The maximum length is `128` characters. The minimum length is `1` character. The value must match regular expression `/^[a-z][a-z0-9]*(_[a-z0-9]+)*$/`. + +- `vpc` - (List) The VPC bound to for DNS resolution.The VPC may be remote and therefore may not be directly retrievable. + Nested scheme for **vpc**: + - `crn` - (String) The CRN for this VPC. + - Constraints: The maximum length is `512` characters. The minimum length is `9` characters. + - `href` - (String) The URL for this VPC. + - Constraints: The maximum length is `8000` characters. The minimum length is `10` characters. The value must match regular expression `/^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/`. + - `id` - (String) The unique identifier for this VPC. + - Constraints: The maximum length is `64` characters. The minimum length is `1` character. The value must match regular expression `/^[-0-9a-z_]+$/`. + - `name` - (String) The name for this VPC. The name is unique across all VPCs in the region. + - Constraints: The maximum length is `63` characters. The minimum length is `1` character. The value must match regular expression `/^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$/`. + - `remote` - (List) If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable. + Nested scheme for **remote**: + - `account` - (List) If present, this property indicates that the referenced resource is remote to thisaccount, and identifies the owning account. + Nested scheme for **account**: + - `id` - (String) The unique identifier for this account. + - Constraints: The value must match regular expression `/^[0-9a-f]{32}$/`. + - `resource_type` - (String) The resource type. + - Constraints: Allowable values are: `account`. The maximum length is `128` characters. The minimum length is `1` character. The value must match regular expression `/^[a-z][a-z0-9]*(_[a-z0-9]+)*$/`. + - `region` - (List) If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region. + Nested scheme for **region**: + - `href` - (String) The URL for this region. + - Constraints: The maximum length is `8000` characters. The minimum length is `10` characters. The value must match regular expression `/^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/`. + - `name` - (String) The globally unique name for this region. + - Constraints: The maximum length is `63` characters. The minimum length is `1` character. The value must match regular expression `/^([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$/`. + - `resource_type` - (String) The resource type. + - Constraints: Allowable values are: `vpc`. The maximum length is `128` characters. The minimum length is `1` character. The value must match regular expression `/^[a-z][a-z0-9]*(_[a-z0-9]+)*$/`. + diff --git a/website/docs/r/kms_key_rings.html.markdown b/website/docs/r/kms_key_rings.html.markdown index a7cb8ccb9a..c4e080bbf9 100644 --- a/website/docs/r/kms_key_rings.html.markdown +++ b/website/docs/r/kms_key_rings.html.markdown @@ -23,6 +23,7 @@ resource "ibm_resource_instance" "kms_instance" { resource "ibm_kms_key_rings" "key_ring" { instance_id = ibm_resource_instance.kms_instance.guid key_ring_id = "key-ring-id" + force_delete = true } resource "ibm_kms_key" "key" { instance_id = ibm_resource_instance.kp_instance.guid @@ -35,7 +36,7 @@ resource "ibm_kms_key" "key" { Sample example of deleting a key ring where all keys inside have key state equals to 5 (destroyed). Keys are moved to the default key ring. -``` +```terraform resource "ibm_kms_key_rings" "key_ring" { instance_id = ibm_resource_instance.kms_instance.guid key_ring_id = "key-ring-id" @@ -49,6 +50,7 @@ Review the argument references that you can specify for your resource. - `endpoint_type` - (Optional, Forces new resource, String) The type of the public endpoint, or private endpoint to be used for creating keys. - `instance_id` - (Required, Forces new resource, String) The hs-crypto or key protect instance GUID. - `key_ring_id` - (Required, Forces new resource, String) The ID that identifies the key ring. Each ID is unique within the given instance and is not reserved across the key protect service. **Constraints** `2 ≤ length ≤ 100`. Value must match regular expression of `^[a-zA-Z0-9-]*$`. +- `force_delete` - (Optional, Bool) If set to **true**, allows force deletion of a key ring. Terraform users are recommended to have this set to **true**. All keys in the key ring are required to be deleted (in state **5**) before this action can be performed. If the key ring to be deleted contains keys, they will be moved to the **default** key ring which requires the **kms.secrets.patch** IAM action. ## Attribute reference In addition to all argument reference list, you can access the following attribute reference after your resource is created. diff --git a/website/docs/r/scc_control_library.html.markdown b/website/docs/r/scc_control_library.html.markdown index 7761ae9f96..201b87552b 100644 --- a/website/docs/r/scc_control_library.html.markdown +++ b/website/docs/r/scc_control_library.html.markdown @@ -10,10 +10,13 @@ subcategory: "Security and Compliance Center" Create, update, and delete control libraries by using this resource. +~> NOTE: if you specify the `region` in the provider, that region will become the default URL. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will override any URL(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://us-south.compliance.ibm.com`). + ## Example Usage ```hcl resource "ibm_scc_control_library" "scc_control_library_instance" { + instance_id = "00000000-1111-2222-3333-444444444444" control_library_description = "control_library_description" control_library_name = "control_library_name" control_library_type = "predefined" @@ -60,6 +63,7 @@ resource "ibm_scc_control_library" "scc_control_library_instance" { You can specify the following arguments for this resource. +* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. * `control_library_description` - (Required, String) The control library description. * Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. * `control_library_name` - (Required, String) The control library name. @@ -140,6 +144,7 @@ After your resource is created, you can read values from the listed arguments an * `controls_count` - (Optional, Integer) The number of controls. * `id` - The unique identifier of the scc_control_library. +* `control_library_id` - (String) The ID that is associated with the created `control_library` * `account_id` - (String) The account ID. * Constraints: The maximum length is `32` characters. The minimum length is `0` characters. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. * `control_parents_count` - (Integer) The number of parent controls in the control library. @@ -154,14 +159,21 @@ After your resource is created, you can read values from the listed arguments an ## Import -You can import the `ibm_scc_control_library` resource by using `id`. The control library ID. +You can import the `ibm_scc_control_library` resource by using `id`. +The `id` property can be formed from `instance_id` and `control_library_id` in the following format: + +``` +/ +``` +* `instance_id`: A string. The instance ID. +* `control_library_id`: A string. The control library ID. # Syntax ``` -$ terraform import ibm_scc_control_library.scc_control_library +$ terraform import ibm_scc_control_library.scc_control_library / ``` # Example ``` -$ terraform import ibm_scc_control_library.scc_control_library f3517159-889e-4781-819a-89d89b747c85 +$ terraform import ibm_scc_control_library.scc_control_library 00000000-1111-2222-3333-444444444444/f3517159-889e-4781-819a-89d89b747c85 ``` diff --git a/website/docs/r/scc_profile.html.markdown b/website/docs/r/scc_profile.html.markdown index 8226fdf06d..b0360fe701 100644 --- a/website/docs/r/scc_profile.html.markdown +++ b/website/docs/r/scc_profile.html.markdown @@ -10,10 +10,13 @@ subcategory: "Security and Compliance Center" Create, update, and delete profiles with this resource. +~> NOTE: if you specify the `region` in the provider, that region will become the default URL. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will override any URL(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://us-south.compliance.ibm.com`). + ## Example Usage ```hcl resource "ibm_scc_profile" "scc_profile_instance" { + instance_id = "00000000-1111-2222-3333-444444444444" controls { control_library_id = "e98a56ff-dc24-41d4-9875-1e188e2da6cd" control_id = "5C453578-E9A1-421E-AD0F-C6AFCDD67CCF" @@ -68,6 +71,7 @@ resource "ibm_scc_profile" "scc_profile_instance" { You can specify the following arguments for this resource. +* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. * `controls` - (Required, List) The array of controls that are used to create the profile. * Constraints: The maximum length is `600` items. The minimum length is `0` items. Nested schema for **controls**: @@ -157,6 +161,7 @@ Nested schema for **default_parameters**: After your resource is created, you can read values from the listed arguments and the following attributes. * `id` - The unique identifier of the scc_profile. +* `profile_id` - (String) The ID that is associated with the created `profile` * `attachments_count` - (Integer) The number of attachments related to this profile. * `control_parents_count` - (Integer) The number of parent controls for the profile. * `controls_count` - (Integer) The number of controls for the profile. @@ -178,9 +183,16 @@ After your resource is created, you can read values from the listed arguments an ## Import -You can import the `ibm_scc_profile` resource by using `id`. The unique ID of the profile. +You can import the `ibm_scc_profile` resource by using `id`. +The `id` property can be formed from `instance_id` and `profiles_id` in the following format: + +``` +/ +``` +* `instance_id`: A string. The instance ID. +* `profile_id`: A string. The profile ID. # Syntax ``` -$ terraform import ibm_scc_profile.scc_profile +$ terraform import ibm_scc_profile.scc_profile / ``` diff --git a/website/docs/r/scc_profile_attachment.html.markdown b/website/docs/r/scc_profile_attachment.html.markdown index 9fb803f686..064429b657 100644 --- a/website/docs/r/scc_profile_attachment.html.markdown +++ b/website/docs/r/scc_profile_attachment.html.markdown @@ -10,11 +10,36 @@ subcategory: "Security and Compliance Center" Create, update, and delete profile attachments with this resource. +~> NOTE: if you specify the `region` in the provider, that region will become the default URL. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will override any URL(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://us-south.compliance.ibm.com`). + ## Example Usage ```hcl resource "ibm_scc_profile_attachment" "scc_profile_attachment_instance" { - profiles_id = ibm_scc_profile.scc_profile_instance.id + profile_id = "a0bd1ee2-1ed3-407e-a2f4-ce7a1a38f54d" + instance_id = "34324315-2edc-23dc-2389-34982389834d" + name = "profile_attachment_name" + description = "scc_profile_attachment_description" + scope { + environment = "ibm-cloud" + properties { + name = "scope_id" + value = resource.ibm_scc_control_library.scc_control_library_instance.account_id + } + properties { + name = "scope_type" + value = "account" + } + } + schedule = "every_30_days" + status = "enabled" + notifications { + enabled = false + controls { + failed_control_ids = [] + threshold_limit = 14 + } + } } ``` @@ -22,6 +47,7 @@ resource "ibm_scc_profile_attachment" "scc_profile_attachment_instance" { You can specify the following arguments for this resource. +* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. * `profile_id` - (Required, Forces new resource, String) The profile ID. * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/`. * `scope` - (List) The scope payload for the multi cloud feature. @@ -44,6 +70,13 @@ Nested schema for **notifications**: * Constraints: The list items must match regular expression `/^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$|^$/`. The maximum length is `512` items. The minimum length is `0` items. * `threshold_limit` - (Integer) The threshold limit. * `enabled` - (Boolean) enabled notifications. +* `attachment_parameters` - (List) The request payload of the attachment parameters. +Nested schema for **attachment_parameters**: + * `parameter_name` - (String) The name of the parameter to target. + * `parameter_display_name` - (String) The display name of the parameter shown in the UI. + * `parameter_type` - (String) The type of the parameter value. + * `parameter_value` - (String) The value of the parameter. + * `assessment_type` - (String) The type of assessment the parameter uses. * `schedule` - (String) The schedule of an attachment evaluation. * Constraints: Allowable values are: `daily`, `every_7_days`, `every_30_days`. * `name` - (String) The name of the attachment. @@ -54,6 +87,7 @@ Nested schema for **notifications**: After your resource is created, you can read values from the listed arguments and the following attributes. * `id` - The unique identifier of the scc_profile_attachment. +* `profile_attachment_id` - (String) The ID that is associated with the created `profile_attachment` * `account_id` - (String) The account ID that is associated to the attachment. * Constraints: The maximum length is `32` characters. The minimum length is `32` characters. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. * `attachment_id` - (String) The ID of the attachment. @@ -98,15 +132,16 @@ Nested schema for **last_scan**: ## Import You can import the `ibm_scc_profile_attachment` resource by using `id`. -The `id` property can be formed from `profiles_id`, and `attachment_id` in the following format: +The `id` property can be formed from `instance_id`, `profiles_id`, and `attachment_id` in the following format: ``` -/ +// ``` -* `profiles_id`: A string. The profile ID. +* `instance_id`: A string. The instance ID. +* `profile_id`: A string. The profile ID. * `attachment_id`: A string. The attachment ID. # Syntax ``` -$ terraform import ibm_scc_profile_attachment.scc_profile_attachment / +$ terraform import ibm_scc_profile_attachment.scc_profile_attachment // ``` diff --git a/website/docs/r/scc_provider_type_instance.html.markdown b/website/docs/r/scc_provider_type_instance.html.markdown index 06eaf1f337..2a75e888d7 100644 --- a/website/docs/r/scc_provider_type_instance.html.markdown +++ b/website/docs/r/scc_provider_type_instance.html.markdown @@ -10,10 +10,13 @@ subcategory: "Security and Compliance Center" Create, update, and delete provider type instances with this resource. +~> NOTE: if you specify the `region` in the provider, that region will become the default URL. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will override any URL(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://us-south.compliance.ibm.com`). + ## Example Usage ```hcl resource "ibm_scc_provider_type_instance" "scc_provider_type_instance_instance" { + instance_id = "00000000-1111-2222-3333-444444444444" attributes = {"wp_crn":"crn:v1:staging:public:sysdig-secure:eu-gb:a/14q5SEnVIbwxzvP4AWPCjr2dJg5BAvPb:d1461d1ae-df1eee12fa81812e0-12-aa259::"} name = "workload-protection-instance-1" provider_type_id = "provider_type_id" @@ -24,6 +27,7 @@ resource "ibm_scc_provider_type_instance" "scc_provider_type_instance_instance" You can specify the following arguments for this resource. +* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. * `attributes` - (Required, Map) The attributes for connecting to the provider type instance. * `name` - (Required, String) The name for the provider_type instance * `provider_type_id` - (Required, String) The unique identifier of the provider type instance. @@ -33,6 +37,7 @@ You can specify the following arguments for this resource. After your resource is created, you can read values from the listed arguments and the following attributes. * `id` - The unique identifier of the scc_provider_type_instance. +* `provider_type_instance_id` - (String) The ID that is associated with the created `provider_type_instance` * `created_at` - (String) The time when resource was created. * `type` - (String) The type of the provider type. * `updated_at` - (String) The time when resource was updated. @@ -41,15 +46,16 @@ After your resource is created, you can read values from the listed arguments an ## Import You can import the `ibm_scc_provider_type_instance` resource by using `id`. -The `id` property can be formed from `provider_type_id`, and `provider_type_instance_id` in the following format: +The `id` property can be formed from `instance_id`, `provider_type_id`, and `provider_type_instance_id` in the following format: ``` / ``` +* `instance_id`: A string. The instance ID. * `provider_type_id`: A string. The provider type ID. * `provider_type_instance_id`: A string. The provider type instance ID. # Syntax ``` -$ terraform import ibm_scc_provider_type_instance.scc_provider_type_instance / +$ terraform import ibm_scc_provider_type_instance.scc_provider_type_instance // ``` diff --git a/website/docs/r/scc_rule.html.markdown b/website/docs/r/scc_rule.html.markdown index 41b37572a5..322fa63013 100644 --- a/website/docs/r/scc_rule.html.markdown +++ b/website/docs/r/scc_rule.html.markdown @@ -10,10 +10,13 @@ subcategory: "Security and Compliance Center" Create, update, and delete rules with this resource. +~> NOTE: if you specify the `region` in the provider, that region will become the default URL. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will override any URL(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://us-south.compliance.ibm.com`). + ## Example Usage ```hcl resource "ibm_scc_rule" "scc_rule_instance" { + instance_id = "00000000-1111-2222-3333-444444444444" description = "Example rule" import { parameters { @@ -60,6 +63,7 @@ scc_rule provides the following [Timeouts](https://www.terraform.io/docs/configu You can specify the following arguments for this resource. +* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. * `description` - (Required, String) The details of a rule's response. * Constraints: The maximum length is `512` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. * `import` - (Optional, List) The collection of import parameters. @@ -171,6 +175,7 @@ Nested schema for **target**: After your resource is created, you can read values from the listed arguments and the following attributes. * `id` - The unique identifier of the scc_rule. +* `rule_id` - (String) The ID that is associated with the created `rule` * `account_id` - (String) The account ID. * Constraints: The maximum length is `32` characters. The minimum length is `3` characters. The value must match regular expression `/[A-Za-z0-9]+/`. * `created_by` - (String) The user who created the rule. @@ -186,8 +191,15 @@ After your resource is created, you can read values from the listed arguments an ## Import You can import the `ibm_scc_rule` resource by using `id`. The rule ID. +The `id` property can be formed from `instance_id` and `rule_id` in the following format: + +``` +/ +``` +* `instance_id`: A string. The instance ID. +* `rule_id`: A string. The rule ID. # Syntax ``` -$ terraform import ibm_scc_rule.scc_rule +$ terraform import ibm_scc_rule.scc_rule / ```